3.2 Oracle Banking Treasury Management Envelope
The OBTR Envelope topic explains the OBTR header and body components.
- FCUBS_HEADER – This is a node that forms the header of the OBTR Envelope. The tags under the header portion of a message identifies a partner system, a service, an operation, user, branch, etc. These tags are constant across all messages.
- FCUBS_BODY – This node contains the actual payload of a message. The contents of this node varies for each message.
Figure 3-1 HEADER and Types
FCUBS_HEADER
Table 3-1 FCUBS Header Tags
| Tags | Description |
|---|---|
| SOURCE | This indicates the name of the External system that is the source of the message. |
| UBSCOMP | This indicates the Oracle Banking Treasury Management component of the message - whether FCUBS or OBTR. |
| MSGID | This unique ID identifies each message – incoming or outgoing in Oracle Banking Treasury Management. Every message will have a distinct message ID. |
| CORRELID | This is the id using which any system which has sent a request to FC UBS can correlate to the response. In the External system maintenance, the Correlation Pattern can be configured for each external system. It can be maintained that either the ‘MSGID’ or the ‘CORRELID’ of the request message is returned back as the ‘CORRELID’ in the response message. Depending on this maintenance, Oracle Banking Treasury Management will set either the ‘MSGID’ or the ‘CORRELID’ of the request message in the response message. |
| USERID | For request messages, this ID is used to submit message requests. Oracle Banking Treasury Management will process this request using this id.
For response messages, the value of this will be ‘null’. |
| BRANCH | This indicates the Oracle Banking Treasury Management Branch Code where the request message needs to be processed. If the BRANCH is missing in the header, request message will be transmitted and processed in Head Office branch. |
| MODULEID | This indicates the module ID. |
| SERVICE | This provides details on the various services of Oracle Banking Treasury Management. For every incoming message in Oracle Banking Treasury Management, the service name is mandatory. |
| OPERATION | This indicates the functional operation. |
| SOURCE_OPERATION | This indicates the functional operation as registered in Oracle Banking Treasury Management. |
| SOURCE_USERID | This is the User ID with which the request message was invoked from the SOURCE. |
| DESTINATION | For incoming messages, the destination will be Oracle Banking Treasury Management. For response messages, system will populate the SOURCE of the request message as DESTINATION. |
| MULTITRIPID | This is a unique id which indicates overrides. |
| FUNCTIONID | This indicates the Oracle Banking Treasury Management Function ID. |
| MSGSTAT | This indicates whether the transaction is a SUCCESS or FAILURE. |
| ADDL | This is used to send additional parameters i.e. parameters not available in Oracle Banking Treasury Management. |
FCUBS_BODY
The FCUBS_BODY has the actual payload to perform the respective transaction. The contents of the payload vary for each operation.
The following image shows a sample FCUBS_BODY of QUERYCONTRACT operation.
Figure 3-2 FCUBS_BODY
FCUBS_BODY contain additional nodes for error response and warning response. A diagrammatic representation of the Error response is as shown below:
FCUBS_ERROR_RESPONSE
The error response message has been sent from Oracle Banking Treasury Management when errors are raised in a transaction. The error response have another tag ‘ERROR’ within it.
ERROR
The ‘ERROR’ node have tags for error code and error description. The ‘ERROR’ node is generated for each error raised by OBTR.
FCUBS_WARNING_RESP
The warning response message has been sent when overrides are raised in a transaction. The Warning response will have another tag ‘WARNING’ within it.
WARNING
This node have tags for warning code and warning description. The ‘WARNING’ node generated for each override raised by OBTR.
Parent topic: Message Formats