Inbound routing file XML format
All routing information is contained in the overall XML document. The destinations XML tag is the root
element that contains all the inbound routing information. The following example shows the high-level
structure for the routing file XML.
<destinations>
<destRouting>
<icpcsRouting>
<incoming>
. . .
</incoming>
</icpcsRouting>
</destRouting>
</destinations>The following table describes the XML elements that can be in the inbound routing file.
| Node name | Parent elements | Node type | Description |
|---|---|---|---|
<destinations> |
None, this element is the root element | ELEMENT | Routing file XML root element |
<destRouting> |
<destinations> |
ELEMENT | Contains the incoming routing definitions. This element is only specified once. |
<icpcsRouting> |
<destRouting> |
ELEMENT | The Common Services routing definitions. This element is only specified once. |
<incoming> |
<icpcsRouting> |
ELEMENT | The routing used for incoming work. This element is only specified once. |
<customDescriptor> |
<incoming> |
TEXT | A code that is assigned by the owner of the electronic connection that is used by the sender. It has a maximum length of 20 characters. |
<customerUniqueId> |
<incoming> |
TEXT | A unique identifier for a work flow that is on the file system. It has a maximum length of 100 characters. |
<testIndicator> |
<incoming> |
TEXT | A single character that indicates whether the transmission is a test transmission or not. |
<transmissionReceiptTimeStamp> |
<incoming> |
TEXT | The time and date when the transmission was accepted for processing. The format is
xsd:dateTime (2016-10-31T08:35:09.459-05:00);. This element replaces
<payDirRecvTimeStamp>. |
The XML elements of an inbound routing file, or route file, are defined in the Gateway XML schema file routingfileschema.xsd. This XML schema file is in the FTM artifacts pod at /share/artifacts/development/common/gateway-server/xml.
The files that you need are provided in the FTM artifacts pod and must be downloaded from the pod. For more information about getting files from the artifacts container for your offering, see Getting the files from the artifacts container for your FTM offering.