# Usage

The Definitions of System Fields table defines the system fields, which do not include the default prefix tibss-.

Field Name | Substation Message Direction | Definition and Usage
--- | --- | ---
envelope | Output | Substation ES adds this field to the users message. If the user's application issues a reply, this field and its contents must be returned unchanged in the application’s reply message. No configuration definition is necessary.
Input | If a user application receives this field and a reply is required by the originating application, the contents must be returned unchanged in the reply message of the application. Define the input message with the Opaque data type. In the field conversion rule panel, specify S in the Trunc field and Y in the Reqd field.
correlationid | Output | For EMS ESB: Substation ES adds this field to the EMS message as an user property field or a message field when writing an EMS outbound message. For RV ESB: The CICS RED recipe service copies the tibss-CorrelationId field automatically as a message field into the outbound message, if tibss-CorrelationId has been defined as a system field in conversion rule. For the CICS RED trigger services the tibss-CorrelationId will always be generated and sent out with the outbound message. It does not require tibss-CorrelationId defined as a system field in conversion rule. Define the output message with the String data type. In the field conversion rule panel, specify S in the Trunc field and Y in the Reqd field. If you define this field as property field, see System Fields Used as Property Fields. Note: Ensure that the conversion rules applied to this field are same as rules applied to the JMS correlationid.
Input | If a user application receives this field and a reply is required by the originating application, the contents must be returned unchanged in the reply message of the application. For EMS ESB: Define the input message with the String data type. In the field conversion rule panel, specify Y in the Reqd field. For RV ESB: Define the output message with the String data type. In the field conversion rule panel, specify S in the Trunc field and Y in the Reqd field. If you define this field as property field, see System Fields Used as Property Fields. Note: Ensure that the conversion rules applied to this field are same as rules applied to the JMS correlationid. Note: If both tibss-CorrelationId and JMS correlationid appear in the same message, the value of JMS correlationid takes the first priority.
userid | Input | The user's application sends this field. Define the input message with the data type String. In the field conversion rule panel, specify S in the Trunc field and Y or N in the Reqd field.
password | Input | The user's application sends this field. Define the input message with the data type String. In the field conversion rule panel, specify S in the Trunc field and Y or N in the Reqd field.
resource | Input | The user's application sends this field. Define the input message with the data type String. In the field conversion rule panel, specify S in the Trunc field and Y or N in the Reqd field.
tran-code | Input | The user's application sends this field. This field is used to replace the Mirror Transaction defined in the recipe. Define the input message with the String data type. In the field conversion rule panel, specify S in the Trunc field and Y or N in the Reqd field.
BES | Input | The user's application sends this field. Define the input message with the data type String. In the field conversion rule panel, specify S in the Trunc field and Y or N in the Reqd field. This field is used for both the primary or secondary BES. This can be specified on the Service Recipe or dynamically as input. Valid input values are listed as follows: BES: override the BES value and skip the Alt-BES value defined on the Service. BES;: override the BES value and keep the Alt-BES value defined on the Service. BES;Alt-BES: override both BES values defined on the Service. ;Alt-BES: keep the BES value and override the Alt-BES value defined on the Service.
MFS-Name | Input | The dynamically supplied MFS Map Name to be used in IMS BES. The user application sends this field, which overrides the MFS Map Name value defined on the service. Define the input message with the data type String. In the field conversion rule panel, specify S in the Trunc field and Y or N in the Reqd field.
ReplyTo | Output | The destination name to which Substation ES could not successfully write. Substation ES adds this field to the TIBCO Enterprise Message Service message as a user property when writing a TIBCO Enterprise Message Service dead message.
ReplyTo-Type | Output | The destination type of ReplyTo-Name. Substation ES adds this field to the EMS message as a user property when writing an EMS dead message.
service-id | Output | Substation ES adds this field to the user’s message. The content is the service identifier.
ss-id | Output | Substation ES adds this field to the user’s message. The content is the Substation identifier.

Copyright © TIBCO Software Inc. All rights reserved.