Audit (3.0)

allows you to output information to user-defined database tables. This means that several workflows may output information about the same batch to the same table, which makes it possible to trace batches/UDRs between workflows. To increase this traceability, it is highly recommended to add fields to the UDRs, to make it possible to identify their origin. Useful values may be:

You define the audit table column types in an Audit profile configuration.

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.

The Audit profile configuration contains the following settings:

Adding and Editing a Table Mapping

From the Add and Edit Audit Table Attributes dialogs, the existing table columns are mapped to valid types in .

Audit Profile

In the Audit profile configuration, the column types are configured. To create a new Audit profile configuration, click the Configuration button in the navigation panel to the left in the  Desktop window, and then select Audit Profile from the menu. Select the database in which the table(s) reside, then select Add.

Adding the Table Mapping

From the Add and Edit Audit Table Attributes dialogs, the existing table columns are mapped to  valid types.

The data to insert, will be put in the UDRs column. Setting it to type Counter, makes it possible to use the auditAdd function to increment the corresponding column value. If Value is used, the auditSet function can be used to assign a value.

 Workflow Properties - Audit Tab

The Audit tab in the Workflow Properties dialog defines the type of data entered in the table by the workflow. This is either MIM types or anything sent on with the APL audit functions.

The COMPLETE, INVALID and PARTIALS columns in the Audit table are populated by using the APL audit functions. COLLECTION_DATE and FILENAME are populated by the workflow MIM values.  The CANCELED column name might be mapped directly to an existing MIM value or populated by the APL audit functions using the Analysis Agent.

 Populating Audit Tables

There are two ways of populating audit tables; either by using the auditAdd function, which automatically increments the value of Counter columns, or by setting fixed values to columns of type Valuewith the auditSet function. Note that Counter columns are automatically set to 0 (zero) when a batch is canceled. This is not the case for Value columns.

Counter Increment

By using the auditAdd function, the user does not have to keep track of the number to increment a counter column with. At Cancel Batch, the value is set to 0 (zero).

Fixed Values

Using the auditSet function for the same example as discussed in the previous section, means the user has to keep track of the number of records in the APL code. Note that the profile must be updated; the Counter column must be redefined to Value.

Value columns are not reset when a batch is canceled. Hence there will be entries made in the table for the UDRs column for all batches.

// Define counters
int complete = 0;
int partials = 0;
int invalid = 0;

//Publish a new MIM
mimPublish(trailer, "My Trailer",string);

consume {
    // Check if the UDR is of type complete
    if(input.causeForOutput == 0){
        // Increment complete counter
        complete = complete + 1;
        // Increment value of column COMPLETE
        auditAdd( "Default.PRF_AUDIT","MZADMIN.MZ_AUDIT","COMPLETE",1 ); 
        // Route UDR on outgoing route "COMPLETE"
        udrRoute(input, "COMPLETE");
    }
    // Check if the UDR is of type partial
    else if(input.causeForOutput == 1 ||input.causeForOutput == 2){
        // Increment partial counter
        partials = partials + 1;  
        // Increment value of column PARTIAL
        auditAdd( "Default.PRF_AUDIT","MZADMIN.MZ_AUDIT","PARTIAL",1 ); 
        // Route UDR on outgoing route "PARTIALS"
        udrRoute(input, "PARTIALS");
    }
    else{
        // Increment invalid counter
        invalid = invalid + 1;
        // Set the value of column INVALID
        auditSet( "Default.PRF_AUDIT","MZADMIN.MZ_AUDIT","INVALID",invalid );
    }
    
}