Get Audit Event Activity

You can use this activity to get one or multiple audit events from the TIBCO Cloud 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 required to communicate with the TIBCO Cloud AuditSafe shared resource. Click the search icon to select the AuditSafe Connection shared resource. If no matching shared resources are found under Matching items: on Select TasconnectionResource Resource Template window, click Create Shared Resource to create one.

See Creating a TIBCO Cloud AuditSafe Shared Resource Connection

Only Get Total Count

NO

Select the checkbox to view only the total number of the records returned by the event in the search criteria.
Sort by Column

YES

The name of the column for which data is to be sorted.
Note: If you do not specify the name of the column, data is not sorted.
Descending Order

NO

Select the checkbox in order to sort the data in descending order.
Note: The data to be sorted depends on the name of the column specified in the Sort by Column field.
Exact Match

NO

Select the checkbox in order to get the exact match of the data.
Note: The data returned depends on the inputs provided in an Input tab.
Include Event Payload

NO

Select the checbox if you wish to view the payload of the event in the output.
Set Return Limit

NO

Enter the number of records you wish to view in the output.

Default setting is 1000.

Description

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

Input

In 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
biz_proc String Name of the business process that needs to 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 State of the business process.

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

event_status String Status of an audit event.

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

transaction_id String Unique ID of the business transaction.
event_source String Source of an event trigger.
event_destination String Destination of an event.
event_start_timestamp String Date and time which represent the starting point to search for results.
Note: If an event_start_timestamp is not specified, the system will use the default start time of 01/01/1970. Date time stamps are expressed in YYYY-MM-DDThh:mm:ssZ format.
event_stop_timestamp String Date and time which represents the ending point to search for results .
Note: If you do not specify the event_stop_timestamp, all the records matching the search criteria are returned in the output along with the records that have a date later than current date. Date time stamps are expressed in YYYY-MM-DDThh:mm:ssZ format.
Note: If end timestamp is not specified, all the records following the time specified in an event_start_timestamp are displayed.
extra_props* String (Optional) User-defined additional properties describing an event other than the input fields provided. List of extra_prop which has two additional fields: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.

You can add or search multiple properties for an event.

You can search for multiple extra properties as follows:

For the different prop_name: Enter separate search conditions. This search displays all the transactions, which includes all the property names.

For the same prop_name: Define separate searches, each with a different prop_value. This search displays all the transactions, which include either of the property values.

Output

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

Output Item Data Type Description
totalResults Integer Number of records returned.
errorMessage String Message displayed in case of error.
Note: For one cycle of GetAuditEvent activity, the maximum number of rows returned is same as the value specified in the Set Return Limit field. If the number exceeds the set value, the following error message is displayed:

WARNING: Total Count of events for this query is <n>, which exceeds the <limit> limit. Only first <limit> events are fetched.

data transaction_id String Data related to the specified transaction ID of a business transaction.
tas_event_id String Unique ID which is returned by the system for every event searched.
event_desc String Information about the specified audit events.
event_source String Source of the specified event.
event_destination String Destination of the specified event.
biz_proc String Type of the business process.
event_timestamp String Date and time of the specified event.
audit_event String Data about the events specified in a particular state.
event_status String Status of the specified event.
event_id String Event ID which is populated only if an event_id is provided when data is sent to TIBCO Cloud AuditSafe.

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

parent_event_id String 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 Returns the payload value of the event as follows:
  • If you select the Include Event Payload checkbox in the General tab for the event that consists payload, it returns the payload value of that event , else it returns a null value.
  • If you select the Include Event Payload checkbox in the General tab for the event that does not consist the payload information, it returns the null value.
create_timestamp String Digital record which denotes the time at which an event is created.
extra_props String User-defined additional properties describing an event other than the input fields provided.

Returns the list of of extra_prop which has 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.