Configure TIBCO Cloud™ AuditSafe GetAuditEvent
The following table lists and describes the settings available for GetAuditSafe.
Activity Input
Use the following to map your input for GetAuditEvent.
| Input settings | Function or type | Description |
|---|---|---|
| audit_event | Audit Event | An event within a business process such: Order Accepted, Payment Authorized, Payment Settled, and so on. |
| biz_proc | Business Process | The business process such as: a Claim, or a Payment, etc. |
| tas_event_id | Event ID | Returns information about the specified range of user-assigned IDs (if configured) or by the timestamp. |
| event_status | Status | The status of an audit event, such as whether it is: Pending, Failed, Processed, etc. |
| event_source | 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 | 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 | Transaction ID | The unique identifier assigned to a business transaction |
| event_start_timestamp | N/A | Enter a timestamp for the point in time when you want to begin the search. The timestamp can be in one of the following formats: YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DD. The default start value is 01/01/1970 (1970-01-01). Use with event_stop_timestamp to filter query results by using the timestamp of the transaction. |
| event_stop_timestamp | N/A | Enter a timestamp for the point in time that you want to end the search. The timestamp can be in one of the following formats:YYYY-MM-DDThh:mm:ssZ or YYYY-MM-DD. The default stop value is the current timestamp. Use with event_start_timestamp to filter query results by using the timestamp of the transaction. |
| Exact Match | Boolean | Enter true to return an exact match. For example: Entering TIBCO will only return TIBCO and not Tibco or tibco. The default setting is false. |
| extra_props | User-defined | Use when specifying extra properties. Two conditions, prop_name and prop_value can be defined. |
| Include Event Payload | Boolean | Enter true to include payload in the response. Default setting is false. |
| Only Get Total Count | Boolean | Enter true to return only the total count of the response events. Default setting is false. If you set this parameter you do not need to set the Sort by Column parameter. |
| Set Return Limit | Number | Use to specify a limit for the total number of events returned. Default setting is 1000. If the number of results requested is smaller than the actual number of results, you will receive a message about the actual number. However, the system only displays the number of events requested. |
| Sort by Column | String | Use to sort the data by Column name. |
| Descending Order | Boolean | Enter true to display results in descending order. The default setting is false. |
Activity Output
Following is a list of output for GetAuditEvent.
| Parameter | 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 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). |