Get Audit Event
Use this activity to get audit event information from TIBCO Cloud AuditSafe . Select a column name such as [] biz_proc from the list then use the Input options to define and narrow your results.
Input
| Field | Description |
|---|---|
| Only Get Total Count | Enter true to return only the total count of the response events. Default setting is false. |
| Sort by Column | Enter the name of the column from the choices listed. For example audit_event |
| Descending Order | Enter true to sort in descending order. Default setting is false |
| Exact Match | Enter true for an exact match. Default setting is false. |
| Include Event Payload | Enter true to include payload in the response. Default setting is false. |
| Set Return Limit | Use to specify a limit for the total number of events returned. Default setting is 1000. |
| extra_props |
Use when specifying extra properties in the search. Two conditions can be defined, prop_name and prop_value. To search for multiple extra properties, enter separate search conditions. Searching for two different prop_names is an AND operation. All events containing both the extra_props are returned in the output. For example: [{"prop_name":"PO Number","prop_value":"D1342153"},{"prop_name":"DO Number","prop_value":"D1342211"}] To search for two different conditions for the same prop_name, define two searches, each with a different prop_value. For example: [{"prop_name":"PO Number","prop_value":"D1342153"}, {"prop_name":"PO Number","prop_value":"D1342211"}] This search will display all transactions that include PO Number:D1342153 or PO Number:D1342211. |
| event_start_timestamp | Use to specify a start date/time to search for results. If an event_start_timestamp is not specified, the system uses the default start time of 01/01/1970. Date time stamps are expressed as: YYYY-MM-DDThh:mm:ssZ. |
| event_stop_timestamp | Use to specify a stop date/time to search for results . If an event_stop_timestamp is not specified, the system uses the current date and time as the default. Date time stamps are expressed as: YYYY-MM-DDThh:mm:ssZ. |
| audit_event | An event within a business process such: Order Accepted, Payment Authorized, Payment Settled, and so on. |
| biz_proc | The business process such as: a Claim, or a Payment, etc. |
| event_status | The status of an audit event, such as whether it is: Pending, Failed, Processed, etc. |
| event_source | Use to specify the originating point of an event trigger. For example: When an event moves from the OMS (Order Management System) to the WMS (Warehouse Management System) This is useful if or when you want to search for all (or any) transactions that have been processed by a particular department, system, or logical entity. |
| event_destination | Identifies the destination endpoint of an event. For example: When an event moves from the OMS (Order Management System) to the WMS (Warehouse Management System). This is useful when you need to search for a transaction that has been processed by a specific department, system or logical entity. |
| transaction_id | The unique identifier assigned to a business transaction |
Output
The properties that are displayed in the Output tab schema correspond to the output of this activity and can be used as input by subsequent activities in the flow. The output of an activity is displayed for informational purposes only and cannot be modified.
The Output tab has the following fields:
| Field | Description |
|---|---|
| totalResults | Returns the total count of events for the Get request. |
| errorMessage | Error or warning message details: WARNING MESSAGE: A Warning message explains the issue then allows you to continue. For example if the totalCount returned is larger than the limit set in the request, the warning message will explain the limit. ERROR MESSAGE: If there are exceptions when performing the query, you may receive an error message. In this case you are asked to resubmit the query. For example, if you set a very large limit (such as 2000000) and trigger the system timeout, you are requested to refine the query. |
| audit_event | Returns data about events that are in the specified state. |
| biz_proc | Returns the business process-type. |
| create _timestamp | Digital record that denotes the time at which an event created in TIBCO Cloud AuditSafe. |
| event_desc | Returns information about audit_events by the specified description string. |
| event_id | User-assigned ID for a specific audit event. If an event_id is not configured, TIBCO Cloud AuditSafe will use the timestamp to chronologically chain events that have the same Transaction ID (transaction_id). |
| event_destination | Returns the destination of the specified event. |
| event_source | Returns the source of an event. |
| event_status | Returns data about events that are in the specified status. |
| event_timestamp | Returns the date and time of an event. |
| extra_props | User-defined additional properties used to describe an event other than the input fields provided. Lists two additional fields for an event: prop_name and prop_value. The prop_name can be Invoice number and prop_value can be any value that describes the property, in this example it would be an Invoice number. |
| parent_event_id | The event_id, or if one was not configured then the tas_event_id of the previous event in a chain, is used as a parent_event_id to identify the hierarchy and succession. A parent_event_id is used when a set of events branch off the flow. |
| payload | Additional information regarding an event. Could be a TXT, XML, or JSON file, that is uploaded to the system for later reference. |
| tas_event_id | Returns information about the specified or specified range of user-assigned IDs (if configured) or by the timestamp. |
| transaction_id | Returns data about the specified transaction identifier (often by time, or numeric range, or both). |