Post Audit Event Activity

You can use this activity to post one or multiple audit events to the TIBCO AuditSafe server.

General

The General tab contains the following fields.

Field Module Property? Description
Name

NO

The name to be displayed as the label for the activity in the process.
AuditSafe Connection

YES

Connection details that must communicate with the TIBCO AuditSafe shared resource. Click the Search icon to select the AuditSafe Connection shared resource. If no matching shared resources are found under Matching items: in Select TasconnectionResource Resource Template window, click Create Shared Resource to create one.

See Creating a TIBCO AuditSafe Shared Resource Connection

Description

You can enter a short description for the Post Audit Event activity on this Description tab.

Input

On the Input tab, you can specify the fields that you require. The following table lists the input items for the activity:

Input Item Data Type Description
transaction_id String (Mandatory) Unique ID assigned to a business transaction. A common transaction ID assigned to an audit event can be linked to the next audit event. This results in a chronological chain of all audit events which can be viewed graphically on the "Audit Trail" page.

For a single transaction, only one transaction ID is required whereas a complex branched transaction requires the data from event_id and parent_id.

Note: Enclose the transaction number in double quotation marks.
biz_proc String (Mandatory) Name of the business process that must be tracked. For example: Order business process, Trade business process, Purchase Order business process, Claim, or Payment.

Each business process specifies an audit trail of events and their respective status.

audit_event String (Mandatory) State of the business process that must be recorded.

For example: Order Accepted, Payment Authorized, Payment Settled, Order Canceled, Order Filled, Claim Filed, Claim Adjusted, Order Routed, and Order Shipped.

Note: By default, the Needs validation property is disabled on the plug-in page. If you enable it, the value of the audit_event is verified against the user-defined values entered under List of audit events.
event_desc String (Mandatory) Short description for an audit event.
event_timestamp String (Mandatory) Digital record which denotes the time at which an event occurred during the lifecycle of a transaction.

Timestamps of the events are used to build a chronological audit trail of an entire transaction.

Note: Date time stamps are specified in YYYY-MM-DDThh:mm:ssZ format.

event_status String (Mandatory) Status of an audit event.

For example: The status of the placed order can be Pending, Failed, Processed, In Progress or Completed.

Note: By default, the Needs validation property is disabled on the plug-in page. If you enable it, the value of an event_status is verified against the user-defined values entered under List of Status.
event_id String (Optional) User-defined ID assigned to a particular audit event.
Note: If an event_id is not provided, TIBCO AuditSafe uses the event_timestamp to link the events having the same transaction number in chronological order.
event_source String (Optional) Source of an event trigger.

For example: It can be a nonphysical logical entity (Credit Checker program), an actual business department (Warehouse Department, Shipping Department), or an application/system (CRM, OMS, Purchasing System) through which the transaction processes.

event_destination String (Optional) Destination of an event.

For example: It can be an API being called by the source, or the system having the web service that receives a message from the message source.

parent_event_id String (Optional) event_id of a previous event that is used to identify the hierarchy of the chain of events.

In the absence of a user-generated event_id, the tas_event_id is used as the parent event ID for subsequent events in branched workflows (to form a tree structure).

You can view the parent-child relationship of the entire business transaction by using the parent event ID.

payload String (Optional) Additional information about an event.

It can be an XML file, a JSON file, or a PDF document that is uploaded to the system for further reference.

extra_props* String (Optional) User-defined additional properties describing an event other than the input fields provided. Lists the two additional fields for an event: prop_name and prop_value. For example: The prop_name can be Invoice number and prop_value can be any value which describes the property.
Note: You can add multiple properties for an event.

Output

On the Output tab, you can check the response information. The following table lists the output items for the activity:

Output Item Data Type Description
transaction_id String Unique ID of a business transaction.
tas_event_id String Unique ID generated by the system for every event sent to TIBCO AuditSafe.

This ID can be used as the parent ID in the subsequent events for branched transactions to form a tree structure.

Note: If an event_id is not generated by the customer, tas_event_id is used as the parent ID in subsequent events for branched transactions to form a tree structure.

event_id String Event ID which is populated only if an event_id is provided when data is sent to TIBCO AuditSafe.

This ID can be used as the parent ID in the subsequent events for branched transactions to form a tree structure.