Generic Audit Trail
You can write generic Audit Trail messages corresponding to an order present in the Order Management Server. The request can be sent to TIBCO Order Management using JMS and RESTful service. When using JMS, one of the two interfaces in the format defined in the $OM_HOME/schemas/schema/oms/CustomAuditTrail.xsd
file is used. This feature is dependent on whether the audit trail is enabled or disabled.
You can now track an order if it's in south bound system or north bound system. On the Audit trail messages for selected orders window of OMS UI, a new column called Origin is added. This column shows whether the origin is internal or external.
The interfaces are as follows:
-
RequestReply: provide
requestReply=true
in the request header to use this mode. This sends the response to the destination specified by JMSReplyTo. -
Request: provide
requestReply=false
in the request header to use this mode. This sends the response to the response queue. -
Notification: provide
mode=notification
in the request to use this mode. This processes the request but does not send any response.
The following is a sample request:
<?xml version="1.0" encoding="UTF-8"?> <ns0:AuditTrailRequest xmlns:ns0="http://www.tibco.com/fom/customAuditTrail"> <ns0:AuditTrailMessage> <ns0:orderRef>innn</ns0:orderRef> <ns0:custom> <ns0:orderId>innn</ns0:orderId> <ns0:auditMessage>STATUS-OPD-EXECUTION-1685955799796</ns0:auditMessage> <ns0:messageType>custom1</ns0:messageType> <ns0:origin>BWSTUB</ns0:origin> </ns0:custom> </ns0:AuditTrailMessage> </ns0:AuditTrailRequest>
Example schema: /v1/order/audit
POST operation
{ "auditTrails": [ { "orderId": "string", "orderRef": "string", "order": { "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:42:45.437Z" }, "plan": { "planId": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:42:45.437Z" }, "planItem": { "planItemId": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:42:45.437Z" }, "orderLine": { "orderLineNumber": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:42:45.437Z" }, "generic": { "planId": "string", "planItemId": "string", "orderLineNumber": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:42:45.437Z" } } ] }
Example schema: /v2/order/audit
GET operation
{ "orderRef": "string", "orderId": "string", "order": [ { "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:44:07.090Z" } ], "plan": [ { "planId": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:44:07.090Z" } ], "orderLine": [ { "orderLineNumber": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:44:07.090Z" } ], "planitem": [ { "planItemId": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:44:07.090Z" } ], "generic": [ { "planId": "string", "planItemId": "string", "orderLineNumber": "string", "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:44:07.090Z" } ], "orderAmendment": [ { "auditMessage": "string", "messageType": "string", "origin": "string", "dateCreated": "2023-10-09T04:44:07.090Z" } ] }
The following ConfigValues_OrchService.xml properties are used for this feature:
<ConfValue description="Custom Audit Trail Request queue" isHotDeployable="true" name="Custom Audit Trail Request queue" propname="com.tibco.fom.oms.orch.customAudit.sender.queue" readonly="false" sinceVersion="3.0" visibility="Basic"> <ConfString default="tibco.aff.orchestrator.customAudit.request" value="tibco.aff.orchestrator.customAudit.request"/> </ConfValue> <ConfValue description="Custom Audit Trail Response queue" isHotDeployable="true" name="Custom Audit Trail Response queue" propname="com.tibco.fom.oms.orch.customAudit.response.queue" readonly="false" sinceVersion="3.0" visibility="Basic"> <ConfString default="tibco.aff.orchestrator.customAudit.response" value="tibco.aff.orchestrator.customAudit.response"/> </ConfValue> ConfValue description="Custom Audit Trail Response queue receiver count" isHotDeployable="true" name="Custom Audit Trail Response queue receiver count" propname="com.tibco.fom.oms.orch.customAudit.receiver.count" readonly="false" sinceVersion="2.1" visibility="Basic"> <ConfString default="2" value="2"/> </ConfValue>
To remove the messageType
restrictions (present up to Order Management 5.0.1), the following part of the schema definition has been removed from the $OM_HOME/schemas/schema/oms/CustomAuditTrail.xsd
file:
<xs:restriction base="xs:string"> <xs:enumeration value="INFO" /> <xs:enumeration value="ERROR" /> <xs:enumeration value="DEBUG" /> </xs:restriction>