Versions Compared

Version Old Version 3 New Version Current
Changes made by

Philip Yeo

Kevin Wu

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Audit profile is loaded when you start a workflow that depends on it. Changes to the profile become effective when you restart the workflow.

Info

Info!

The Audit profile is used by the Audit tab in the workflow properties, Analysis, and Aggregation agents for Batch workflows. Audit profile is not used in Real-Time workflows do not use the Audit profile.

Configuration

To create a new Audit profile configuration, click the New Configuration button in the Build View, and then select Audit Profile from the selection screen.

...

The Audit profile configuration contains the following settings:

Setting

Description

Database

This is the database that the agent will connect and send data to.

Click

the Browse

the Browse... button to get a list of all the database profiles that are available. For further information see Database Profile.

Note

Note!

For performance reasons, Audit information is logged directly from an EC to the database. If an external EC is unable to connect to the database, a "Workflow performance warning" is logged in System Log. If this warning appears, the firewall might need to be reconfigured to allow the EC to communicate directly with the database.

The Audit functionality is supported for use with the following databases:

  • Oracle

  • TimesTen

  • Derby

  • SQL Server

  • PostgreSQL

  • SAP HANA

Refresh

Image Removed
Image Added


Select Refresh to reload the metadata for the tables residing in the selected database.

Use Default Database Schema

Check this to use the default database schema that was added in

the Usernamefield

the Usernamefield of the Default Connection Setup in the Database profile configuration. When using the default database schema the names of the audit tables listed in Table will appear without schema prefix. For more details on how to add a default database schema, see Database Profile.

Note

Note!

This is not applicable for all database types.

 Use

 Use Default Database Schema is only available for selection when accessing Oracle or TimesTen databases.


Table

A list of selected audit tables. For further information about adding and editing tables, see the section below, Adding and Editing a Table Mapping.

Adding and Editing a Table Mapping

...

Add Audit Table Attributes

Setting

Description

Table

A list from which the audit table is selected.

Note

Note!

Tables in the

System

Sysem schema will not be available for selection when accessing the Oracle database


Column Name

The name of the columns in the selected table.

Type

Clicking the cell, displays a list of valid types. Each column must be mapped against a type. Valid types are:

  • Counter - A built-in sequence which is incremented with the value passed on with the auditAdd APL function.

  • Key - Used to differ between several audit inserts. It is possible to use several keys, where a unique combination of keys will result in one new row in the database.

    If the same key combination is used several times within a batch, the existing row will be overwritten with new audit data. However, if a later batch uses the same key combination, a new row will be created.

    If using more than one key, the Key Sequence must be entered in the same order when calling the auditAdd or auditSet APL functions. The Audit functions are further described in the APL Reference Guide.

    Note that this is not a database key and it must be kept as small as possible. A value that is static during the whole batch must never be used as a key value.

  • Value - A column holding any type of value to be set, except for Counter values. This is used in combination with the auditSet APL function. Another use is mapping against existing MIM values in the Workflow Propertiesdialog.

  • Transaction Id - To make sure entries are transaction safe, each table must contain a column of type NUMBER and at least have the length twelve (or have no size declared at all). Do not enter or alter any values in this column, it is handled automatically by the system. The value -1 indicates that the entry is committed and safe.

    Note
    titleNote!

    The Transaction Id column should be indexed for best performance. The contents will be of low cardinality and could therefore be compressed if supported.

    Unused - Used in case a column must not be populated, that is, set to null.

Key Sequence

A key sequence is a defined way to assign a Key value, to identify in which order you need to send along key values when you use the auditAdd or auditSet APL functions.

Each key in a table must have a sequence number in order to be identified when passed on as parameters to the APL audit functions. The first key is identified as 1, the second as 2, and so on.

The key sequence will uniquely identify all audit log entries to be inserted per batch.

Audit Profile Example

To illustrate how Audit may be used, consider a workflow with an Analysis agent, validating and routing UDRs. Most of the UDRs will be sent on the "COMPLETE" route. The rest of the incomplete UDRs will be sent on the "PARTIALS" route. If there are a considerable amount UDRs that are routed to the latter, the batch is cancelled.

...