Routing file XML format

The basic overall structure of the routing file XML document is represented by the destinations XML tag. All routing information is contained in the overall tag. The following XML shows the high-level structure for this XML section:

<destinations>
   <destRouting>
      <icpcsRouting>
         <outgoing>
            <channelDefName>SVPCo Channel</channelDefName>
            <reader>PRES_NOTIF_NOPARSE_READER</reader>
         </outgoing>
      </icpcsRouting>
      .
      . Custom attributes as required by configuration
      .
   </destRouting>
</destinations>

If handshaking is enabled, an example high-level structure for the XML is:

<destinations>
   <destRouting>
      <icpcsRouting>
         <outgoing>
            <channelDefName>SVPCoChannel</channelDefName>
            <outPresGrpId>222</outPresGrpId>
            <handshake>
               <unitOfWork>730</unitOfWork>
               <responseCommunication type='MQ'>
                  <routingQueueName>FILE_QUEUE</routingQueueName>
               </responseCommunication>
               <fileDetails>
                  <fileDetail type='data' byteCount='154374' recordCount='1'
                              itemAmount='9960633' itemCount='7'>
                              ICL.T.R2019.N9217.D100511.T105255.dat
                  </fileDetail>
                  <fileDetail type='eof'>
                              ICL.T.R2019.N9217.D100511.T105255.eof
                  </fileDetail>
                  <fileDetail type='trigger'>
                              ICL.T.R2019.N9217.D100511.T105255.rte
                  </fileDetail>
               </fileDetails>
            </handshake>
         </outgoing>
      </icpcsRouting>
   </destRouting>
</destinations>

The following table describes the elements in the routing file XML.

Table 1. Routing file XML format
Node name	Node type	Description
`destinations`	ELEMENT	Routing file XML root element.
`destRouting`	ELEMENT	Contains the receiver routing definitions. This element is only specified once.
`icpcsRouting`	ELEMENT	The Common Services routing definitions. This element is only specified once.
`outgoing`	ELEMENT	The routing used for outgoing work. This element is only specified once.
`channelDefName`	TEXT	Channel definition name for the routing XML.
`reader`	TEXT	Defines which Gateway reader is used to interpret the information in the transmission. For outbound acknowledgment messages, this value is always PRES_NOTIF_NOPARSE_READER so Gateway does not read the file contents.
`handShake`	ELEMENT	Contains all handshake information from the channel definition. It is added to the XML file only if handshaking is enabled.
`unitOfWork`	TEXT	Unique work ID assigned by the sending application and used to correlate handshake responses to handshake requests. It is a tracking ID for the routing file. This node is a subelement of the handshake node.
`responseCommunication`	TEXT	Indicates the communication information to use when a handshake response is sent. This node is a subelement of the handshake node with an attribute of type. Type indicates the type of communication.
`routingQueueName`	TEXT	Name of the message queue to be used for a handshake response. This node is a subelement of the response communication node.
`fileDetails`	ELEMENT	Contains the transmission details that can be included in the route file. This node is a subelement of the handshake node.
`fileDetail`	TEXT	Each file supplied as part of the file set can be included in the route file. A list of data files must be included. This node is a subelement of the file details node and has the following attributes: type Indicates the type of communication. byteCount Total byte count for the data file. recordCount Total number of records in the data file. itemCount Total number of transactions in the transmission. It is only applicable to transmissions that contain transactions. itemAmount Total dollar amount of the transactions in the transmission. It is only applicable to transmissions that contain transactions.

Notes:

The routing file can also have any number of custom attribute XML text nodes if needed by the user configuration. The user configuration is used to create XML tags from the custom attribute names and their respective values. If the custom attributes have the same name, the value that is used in the XML is determined by the following order:
1. Participant attributes
2. Transmission definition attributes
3. Global attributes
When attribute names conflict, the value for the participant attribute is always used before the value for the transmission definition or global attribute. For more information about custom attributes and how to configure them, see Custom Attributes Management.
For more parameters that must be set to allow the Distribution engine to receive messages, see Gateway Server User's Guide.