Configure TIBCO Cloud™ AuditSafe PostAuditEvent
The following table lists the settings available when posting (uploading) data, and and describes how they relate to the Columns within the TIBCO Cloud™ AuditSafe application.
For example, map your business processes to biz_proc to display them in the Business Process column.
Activity Input
Use the following to map your input.
| Parameter | Column Name | Description |
|---|---|---|
| biz_proc | Business Process | Mandatory: The type of business process that needs to be tracked, such as: an Order process, a Trade process, a Purchase Order process, a Claim, or a Payment, and so on. Each business process contains an audit trail of events, and event statuses. |
| audit_event | Audit Event | Mandatory: An audit event is an event in a business process that must be recorded, e.g.: Order Accepted, Payment Authorized, Payment Settled, Order Cancelled, Order Filled, Claim Filed, Claim Adjusted, Order Routed, Order Shipped, and so on. Each stage of the workflow uses an audit_event. |
| event_desc | Description | Mandatory: A user-defined description for the audit event |
| event_status | Status | Mandatory: Provides a status for an audit event, such as whether the order placement is: Pending, Failed, Processed, In Progress or Completed. Each audit event uses at least one event_status. |
| transaction_id | Transaction ID | Mandatory: A transaction is an instance of a business process. For example, an Order business process can have many order transactions. The ID is a unique identifier assigned to a business transaction. Having a common Transaction ID allows an audit event tied to this ID to be linked to the next audit event, resulting in a chronological chain of all audit events. This eventually forms a linked model of events which can be viewed graphically on the details page. For a single chain of events, only a Transaction ID is required, since TIBCO Cloud™ AuditSafe will chain the events based on timestamps. Chaining complex or branched transactions requires event_id and parent_id data. |
| event_id | N/A | 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). For branched workflows, if an event_id is available, it is assigned as a parent ID for the following audit event. |
| parent_event_id | N/A | 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. Using this relationship allows a user to view the parent-child relationships for the audit trail of the entire business transaction. In the absence of a Parent ID, timestamps are used to chain the audit events into a chronological audit trail. |
| event_source | Source | Identifies the originating point of an event trigger. It could be a non-physical logical entity (such as, a Credit Checker program), an actual business department (Warehouse Department, Shipping Department), or an application/system (CRM, OMS, Purchasing System) through which the transaction flows. Example for an Order: 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). Or it could be the API being called by the source (i.e., a system originating the API call), or the system having the web service that receives a message from the message source. This is useful when you need to sech for a transaction that has been processed by a specific department, system or logical entity. |
| event_timestamp | Time | Mandatory: You can use the date function datetime.current.Datetime() provided by the flogo app, to dynamically generate a GMT timestamp. Or you can explicitly provide a timestamp value. However, any value you provide must use the GMT format: YYYY-MM-DDThh:mm:ssZ. |
| payload | N/A | Additional information regarding an event. Could be an XML or JSON file, a PDF document that is uploaded to the system for later reference. |
| extra_props | string | (Optional) 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. For example: 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.Note: You can add multiple properties for an event. Sample entry: [{“prop_name”:”Invoice Number”,”prop_value”:”I12345”},{“prop_name”:”PO Number”,”prop_value”:”P12345”}] |
Activity Output
Use the following parameters to map your output.
| Output Setting | Description |
|---|---|
| tas_event_id | A system-generated ID, for each event sent to TIBCO Cloud™ AuditSafe. In the absence of a user-generated event_id, the tas_event_id is used as a Parent ID for subsequent events in branched workflows (to form a tree structure). |
| event_id | An event_id is used (if one was provided) when data is pushed to TIBCO Cloud™ AuditSafe. This ID can be used as the Parent ID for subsequent events in branched workflows. |
| transaction_id | The transaction_id is used when data is pushed to TIBCO Cloud™ AuditSafe. A Transaction ID allows an audit event tied to this ID to be linked to the next audit event, resulting in a chronological chain of all audit events. |