The syntax for the routed ASN configuration is slightly different than on demand, however many similarities exist.

The primary difference is that routed ASN configuration files introduce the concept of using two nodes, one to represent the order information and the other for the parcel information (usually rsMaster and rsSecondary, set with the Nodes configuration item.) In the following examples, the node names of rsMaster and rsSecondary are assumed:

Example

Code Block

title	Example

Nodes=rsMaster,rsSecondary

General

Insert excerpt

	File Format (General)
	File Format (General)

Data Items

Data items are set using a Node|Key=Value format.

The syntax of Value varies based on the Delimiter item (i.e., whether the input file is XML, delimited, or fixed-width).

Data Item

Description

rsMaster|EncryptedPassword

Required

Specifies whether the

X Dispatch

Internet User's password has been encrypted. Most of the time, this should be set to true.

Example

Code Block

titleExample


rsMaster\|EncryptedPassword=0,1

rsMaster|Password

Required

Password for the

X Dispatch

Internet User used for placing orders.

Example

Code Block

title	Example

rsMaster|Password=0,testpassword

rsMaster|UserID

Required

X Dispatch

Internet User to use for placing the orders.

Example

Code Block

title	Example

rsMaster|UserID=0,ximport-mckesso

rsMaster|CustID

Required

Customer ID used to place the order.

Example

Code Block

title

Example

rsMaster|CustID=0,1218

Route Stop Details

Data Item

Description

rsMaster|Address

Required

The address to use for the current route stop.

rsMaster|Address2

Required

The address line 2 to use for the current route stop.

rsMaster|BOL

Optional

The BOL (Bill of Lading) data to which route stops may be associated.

Maximum length = 50.

Example

Code Block

title	Example

rsMaster|BOL=0,ABC123geo

rsMaster|City

Required

The city to use for the current route stop.

Anchor

	CustRouteID
	CustRouteID

rsMaster|CustRouteID

Optional

The primary reference for looking up route translations (See Configuration: X Import Translations.)

Anchor

	CustSecondaryLookup
	CustSecondaryLookup

rsMaster|CustSecondaryLookup

Optional

The secondary reference for looking up route translations (See Configuration: X Import Translations.)

rsMaster|RouteSortRuleID

Optional

If a fixed RouteID is not set, and CustRouteID/CustSecondary lookup is not utilized or fails to find a match, the database tries to find the lowest OrderTypeID that contains a destination sort rule and uses that sort rule to try and determine the route.

Info
This functionality makes use of the “Auto assign pickup to route by rule” and “Auto assign delivery to route by rule” options on the Order Type edit form

in X Dispatch

.

RouteSortRuleID allows you to explicitly set the route sort rule used to set the route in that case. This means you can use an existing route sort rule instead of setting up translations or can set a specific sort rule to use as a fallback should the route translations fail. This uses the RouteStop Prefered time when using the sort rule to get the stop of a route.

rsMaster|OverrideGLAccountID

Optional

On a dynamic route stop, it is possible to set a specific GL account to assign to that stop. In order to override the GL account for an imported route stop, set this optional field to the ID of the GL Account you wish to use as the override.

rsMaster|RateChartOverrideLookup

Optional

This value sets the rate chart override lookup value, to be checked against values in the X Stream Route Mappings section. If the values match, the Translation field of the route mappings will be used as the stamp rate chart ID for rating all items on that route stop, rather than the customer’s default stamp rate chart ID.

rsMaster|RateChartSecondaryLookup

Optional

This value sets the rate chart secondary override lookup value, to be checked against values in the X Stream Route Mappings section’s Reference2 field, and if the values match, the Translation field of the route mappings will be used as the stamp rate chart ID for rating all items on that route stop, rather than the customer’s default stamp rate chart ID. If specified, this will be required in order to match.

Note

This

This does not work with a hardcoded value in the .XASN configuration.

rsMaster|RateChartSecondaryLookup

Optional

Whether address should be geocoded to retrieve latitude and longitude, as well as validate the postal code up to 9 digits. This should generally be set to true.

Example

Code Block

title	Example

rsMaster|GeoCode=0,1

rsMaster|Name

Required

The name to use for the imported route stop.

rsMaster|NodeName

Required

The master node name should always be set to “ProcessRouteASN”

Example

Code Block

titleExample


rsMaster\|NodeName=0,ProcessRouteASN

rsMaster|Pieces

Optional

The number of pieces on the order. If this is not specified or is less than the number of parcels sent in for the route stop, the piece count will be set by the number of parcels specified in the request

rsMaster|PK

Required

The PK field sets the primary key for linking the rsMaster and rsSecondary data sets. rsMaster|PK should match rsSecondary|FK. The best fields to use for the primary key will generally be the original tracking or order number from the ASN.

rsMaster|Plus4

Optional

The 4-digit postal code extension for the stop.

rsMaster|PostDate

Required

The date on which this route stop should be posted.

rsMaster|Reference1

Optional

User-defined reference field 1.

rsMaster|Reference2

Optional

User-defined reference field 2.

rsMaster|RouteID

Optional

The route ID onto which the route stops should be placed (See Configuration: X Import Translations,

486342739

CustRouteID,

486342739rsMaster|

CustSecondaryLookup.)
rsMaster\|Sequence	Optional The sequence number for the route stops. Generally, it is better to leave this item out of your configuration file and let the stops be auto sequenced on import. As such, if you wish for stops to sequence on your specified value here, then you must disable auto sequencing.
rsMaster\|State	Required The state to use for the imported route stop.
rsMaster\|StopNotes	Optional Stop-specific notes (e.g., “Dock 12”)
rsMaster\|StopTime	Optional The time at which this stop should be scheduled. This field can be set to “0,” which will set it to blank value and utilize the stop time preferred mappings or the current system time (at time of import).
rsMaster\|StopTimeFallback	Optional The time at which this stop should be scheduled if the StopTime set to “0,” which will set it to a blank value. If this field is not set, then the system will use the current system time (at time of import).
rsMaster\|StopType	Optional The stop type. Defaults to 1 (Delivery) if not specified or if an invalid stop type (anything other than 0-6) is specified.
rsMaster\|Weight	Optional The net weight of all parcels on this route stop. If this field is not specified, the cumulative weight of all parcels sent in will be used instead.
rsMaster\|Length	Length used in dimensional weight calculator. Data: ParcelLength stored in tblOrderRouteStop. It is displayed on the dimensional weight calculator on the route stop form as Length.

_{Possible version compatibility issue. See Changelog below.}

rsMaster|Width

Width used in dimensional weight calculator.

Data: ParcelWidth stored in tblOrderRouteStop. It is displayed on the dimensional weight calculator on the route stop form as Width

.Possible version compatibility issue. SeeChangelog below

.

rsMaster|Height

Height used in dimensional weight calculator.

Data: ParcelHeight stored in tblOrderRouteStop. It is displayed on the dimensional weight calculator on the route stop form as Height.

_{Possible version compatibility issue. See Changelog below.}

rsMaster|DimWtDenominator

Dimensional weight denominator.

Data: DimWtDenominator is stored in

tblOrderRouteStop as DimWtDenominator

tblOrderRouteStop as DimWtDenominator. It is displayed on the dimensional weight calculator on the route stop form as Denominator.

_{Possible version compatibility issue. SeeChangelog below.}

rsMaster|UseCalculatedDimensionalWeight

A flag if the Length, Width, and Height values are set to tell the import to calculate the Dimensional Weight.

_{Possible version compatibility issue. See Changelog below.}

rsMaster|Zip

Required

The postal code of the route stop.Secondary

rsMaster|StopTimeMin

Optional

Min stop time.

rsMaster|StopTimeMax

Optional

Max stop time.

rsMaster|ShortRemarks

Optional

Short remarks.

rsMaster|LongRemarks

Optional

Long remarks.

rsMaster|EmailPod

Optional

Email pod.

rsMaster|XMobileSecondaryLookup

Optional

Secondary lookup for X Mobile.

rsMaster|ForceLocationScan

Optional

Force Location Barcode (Mobile Secondary Lookup) checkbox, for Nextstop workflow.

Example

Code Block

title	Example

rsMaster|ForceLocationScan=0,true

When configured as true, this feature sets the driver requirement to perform a location scan for the route stop.

rsMaster|CustomerRouteID

Optional

Customer route ID.

rsMaster|CustomerStopID

Optional

Customer stop ID.

rsMaster|CustomerAccountID

Optional

Customer account ID.

rsMaster|RouteOverride

Optional

Route pay override.

Example

Code Block

title	Example

rsMaster|RouteOverride=0,5.00

The following will add an Override Settlement of $0.00 if LD is present in the S502 element but if not, will not function at all. Replace the 0 with a dollar amount if you want to include an Else scenario: rsMaster|RouteOverride=IIF(S502;"LD";"0.00";0)The following will add an Override Settlement of $0.00 if LD is present in the S502 element but if not, will not function at all. Replace the 0 with a dollar amount if you want to include an Else scenario: rsMaster|RouteOverride=IIF(S502;"LD";"0.00";0)

rsMaster|AutoSequence

Optional

Flag that determines if the route stops should be auto sequenced. True value is '1', False value is '0'. Defaults to '1' if the value is omitted from the file.

rsMaster|AdvancedFallbackLookup1

Optional

Data: AdvancedFallbackLookup1 is stored in tblOrderRouteStops in the AdvancedFallbackLookup1 column. It is the ALF1 field under the miscellaneous tab in

X Dispatch

the Operations App.

rsMaster|AdvancedFallbackLookup2

Optional

Data: AdvancedFallbackLookup2 is stored in tblOrderRouteStops in the AdvancedFallbackLookup2 column. It is the ALF2 field under the miscellaneous tab in

X Dispatch

the Operations App.

rsMaster|RateChartOverrideLookup

Optional

Data: RateChartOverrideLookup is stored in tblOrderRouteStops in the RateChartOverrideLookup column. It is the Rate Chart Lookup under field under the miscellaneous tab in

X Dispatch

the Operations App.

rsMaster|ConsolidateStops

Optional

Flag determines if stops Consolidate. Set to '1' to turn on consolidation. Intended to consolidate stops from separate ASN files that would have consolidated if they were contained in the same ASN file. RouteID, PostDate, CustID, Address, City, State, Zip are used to identify stop to consolidate with. This searches any route for consolidation keys newer than 30 days from current date. The behavior will allow stops to be created and NOT consolidate.Mapping

Please note that this feature only works if the RouteID is being passed in from the ASN directly. If Route Mappings and/or Route Sort Rules are utilized, the Consolidation will fail.

Example

Code Block

title	Example

rsMaster|ConsolidateStops=0,1

rsMaster|ConsolidationText

Optional

Intended to consolidate stops between ASN files. Use any string to set consolidation value - can be at any level.

Code Blocktitleshould

Example

Code Block

rsMaster|ConsolidationText=230,6;236,6 # fixed width file: column 230, length=6 and column 236, length = 6. rsMaster|ConsolidationText=1 # eg: 1 = column in csv file
rsMaster|ConsolidationText=APPEND(18,NOW&amp;08:00|DAYFLOOR);APPEND(5,&quot; | &quot;);APPEND(6,230,12) # date and values (12 characters starting at position 230) separated by a pipe</p>

ConsolidationText creates record in database in cxtData.dbo.tblOrderRouteStops_Consolidated.

ConsolidationText

ConsolidationText should include the date since the consolidation text will try to look up anything that matches within the last 30 days.

rsMaster|ODSyncField[XINI field name]

Optional

The following 'ODSyncField' fields are available to match for synchronization with on demand orders. Each field is optional. If a match is found the stop is not imported. The field name is 'rsMaster|ODSyncField' prepended to the XINI field name found in the on demand section of this document.

Example

Code Block

title	Example

rsMaster|ODSyncFieldCustID
rsMaster|ODSyncFieldBillingGroup
rsMaster|ODSyncFieldBillOfLading
rsMaster|ODSyncFieldDeliverDate
rsMaster|ODSyncFieldDestAddress
rsMaster|ODSyncFieldDestCity
rsMaster|ODSyncFieldDestComments
rsMaster|ODSyncFieldDestContactPhone
rsMaster|ODSyncFieldDestName
rsMaster|ODSyncFieldDestPlus4
rsMaster|ODSyncFieldDestState
rsMaster|ODSyncFieldDestSuite
rsMaster|ODSyncFieldDestZip
rsMaster|ODSyncFieldEmailOrderConfirmationChecked
rsMaster|ODSyncFieldEmailPOD
rsMaster|ODSyncFieldEmailPODChecked
rsMaster|ODSyncFieldEmailPOPChecked
rsMaster|ODSyncFieldMasterBillOfLading
rsMaster|ODSyncFieldOrderType
rsMaster|ODSyncFieldOriginAddress
rsMaster|ODSyncFieldOriginCity
rsMaster|ODSyncFieldOriginComments
rsMaster|ODSyncFieldOriginName
rsMaster|ODSyncFieldOriginPlus4
rsMaster|ODSyncFieldOriginState
rsMaster|ODSyncFieldOriginSuite
rsMaster|ODSyncFieldOriginZip
rsMaster|ODSyncFieldOverrideDeliveryTimeFrom
rsMaster|ODSyncFieldOverrideDeliveryTimeTo
rsMaster|ODSyncFieldOverrideReadyTimeFrom
rsMaster|ODSyncFieldOverrideReadyTimeTo
rsMaster|ODSyncFieldParcelPieces
rsMaster|ODSyncFieldParcelWeight
rsMaster|ODSyncFieldPickupDate
rsMaster|ODSyncFieldReference1
rsMaster|ODSyncFieldReference2
rsMaster|ODSyncFieldReportEmail
rsMaster|ODSyncFieldServiceType
rsMaster|ODSyncFieldSpecialInst
rsMaster|ODSyncFieldUserField0
rsMaster|ODSyncFieldUserField1
rsMaster|ODSyncFieldUserField2
rsMaster|ODSyncFieldUserField3
rsMaster|ODSyncFieldUserField4
rsMaster|ODSyncFieldUserField5
rsMaster|ODSyncFieldUserField6
rsMaster|ODSyncFieldUserField7
rsMaster|ODSyncFieldUserField8
rsMaster|ODSyncFieldUserField9
rsMaster|ODSyncFieldUserField10
rsMaster|ODSyncFieldUserField11
rsMaster|ODSyncFieldUserField12

rsMaster|ValidationFailOver

Optional

When used, returns at the minimum the specified value information when the address does not validate as an exact match.

Valid types are:

LatLonMin - return the new lat/long coordinates only. (keeps old address.)
The geocode bit needs to be turned on for the LatLonMin ValidationFailOver process to return lat/lon coordinates.
rsMaster|GeoCode=0,1
AddressMin - return the new address only. (keeps old lat/long data.)

Example

Code Block

titleExample


rsMaster\|ValidationFailOver=0,LatLonMin

rsMaster|MiscData|[...]

Optional

This is a dynamic field, which will store any amount of data as properties in a JSON object in the database. The [...] above can be replaced with any string and used as many times as needed. Data can be queried using a function that engineering has created.

Warning
MiscData fields do not use the BaseNode, OrderNode, or ParcelNode when importing data from an XML ASN. The full XML path will need to be provided for each MiscData field.

Examples

Using the following in a XASN will store data as a property in a JSON object.

rsMaster|MiscData|testfield1=0,sampledata

Execute

SELECT dbo.ParseJSONField(MiscData, 'testfield1') AS testfield1 FROM tblAdditionalData

Returns

“sampledata”

Using the following in a XASN will store data as a property in a JSON object.

Execute

SELECT
dbo.ParseJSONField(MiscData, 'IntegrationData1’) AS [Column1]
dbo.ParseJSONField(MiscData, 'IntegrationData2’) AS [Column2]
dbo.ParseJSONField(MiscData, 'IntegrationData3’) AS [Column3]
FROM tblAdditionalData

Accessorials

Data Item

Description

rsMaster|Accessorial1ID

Optional

Used to include accessorial items imported from an ASN via XASN. This will be checked against the assigned rate chart and the rate will populate on the route stop. Maps to MiscItem1 on tblOrderRouteStops.

Note
If you specify an ItemID here, you must specify a quantity for the item in rsMaster\|Accessorial1Quantity.

Example

Code Block

title	Example

rsMaster|Accessorial1ID = 8

rsMaster|Accessorial1Quantity

Optional

Used in conjunction with rsMaster|Accessorial1ID to specify the quantity for the items imported from an ASN via XASN. This will be checked against the assigned rate chart and the rate will populate on the route stop. Maps to MiscQty1 on tblorderRouteStops.

Note
If you specify a quantity here, you must

specify an

specify an ItemID for the item in

rsMaster

rsMaster|Accessorial1ID.

Example

Code Block

title

Example

rsMaster|Accessorial1Quantity = 1

rsMaster|Accessorial2ID

Optional

Used to include accessorial items imported from an ASN via XASN. This will be checked against the assigned rate chart and the rate will populate on the route stop. Maps to MiscItem2 on tblOrderRouteStops.

Note
If you specify an ItemID here, you must specify a quantity for the item in rsMaster\|Accessorial2Quantity.

Example

Code Block

title	Example

rsMaster|Accessorial2ID=0,10

rsMaster|Accessorial2Quantity

Optional

Used in conjunction with rsMaster|Accessorial2ID to specify the quantity for the items imported from an ASN via XASN. This will be checked against the assigned rate chart and the rate will populate on the route stop. Maps to MiscQty2 on tblorderRouteStops.

Note
If you specify a quantity here, you must

specify an

specify an ItemID for the item in

rsMaster

rsMaster|Accessorial2ID.

Example

Code Block

title	Example

rsMaster|Accessorial2Quantity = 0,4

User Field

Data Item	Description
rsMaster\|UserField1	Optional User data field 1.
rsMaster\|UserField2	Optional User data field 2.
rsMaster\|UserField3	Optional User data field 3.
rsMaster\|UserField4	Optional User data field 4.
rsMaster\|UserField5	Optional User data field 5.
rsMaster\|UserField6	Optional User data field 6.

Secondary

Data Item

Description

rsSecondary|FK

Required

The FK field sets the foreign key for linking the rsMaster and rsSecondary data sets. rsMaster|PK should match rsSecondary|FK. The best fields to use for the primary key will generally be the original tracking or order number from the ASN.

Tip

title


Quick Tip

: This value might exist above the location of the parcel node. If this is the case, you can use the “../” notation to pull data from a node that exists above the parcel node.

rsSecondary|NodeName

Required

The secondary node name should always be set to “Parcel”.

Example

Code Block

titleExample


rsSecondary\|NodeName=0,Parcel

rsSecondary|ParcelPieces

Optional

The number of pieces or items contained within this parcel.

rsSecondary|ParcelReference

Optional

Parcel-level barcode.

rsSecondary|ParcelType

Optional

The carrier-defined parcel type to use for the imported parcel. The ParcelType text can be the numeric ParcelTypeID from tblParcelTypes or the Description from tblParcelTypes - Description performs a wildcard search and used the first ParcelTypeID found where the Description contains the ParcelType text.

rsSecondary|ParcelWeight

Optional

The weight associated with this parcel.

rsSecondary|PK

Required

The PK field on the secondary node is used when aggregating parcels onto route stops. Generally, this item should be set to a unique parcel-level barcode, or a combination of route, stop, or any other uniquely identifying information.

rsSecondary|ParcelDescription

Optional

Description of the parcel.

rsSecondary|ParcelReference2

Optional

Secondary reference field for the parcel.

rsSecondary|ParcelMasterBarcode

Optional

Secondary reference field for the parcel.

This

This sets the Parcel Consolidation Barcode.

rsSecondary|ParcelConsolidationBarcode

Optional

This sets the Parcel Consolidation Barcode 2

rsSecondary|MiscData|[...]

Optional

This is a dynamic field, which will store any amount of data as properties in a JSON object in the database. The [...] can be replaced with any string and used as many times as needed. Data can be queried using a function that engineering has created.

Warning
MiscData fields do not use the BaseNode, OrderNode, or ParcelNode when importing data from an XML ASN. The full XML path will need to be provided for each MiscData field.

Examples

Using the following in a XASN will store data as a property in a JSON object.

rsSecondary|MiscData|testfield1=0,sampledata

Execute

SELECT dbo.ParseJSONField(MiscData, 'testfield1') AS testfield1 FROM tblAdditionalData

Returns

“sampledata”

Using the following in a XASN will store data as a property in a JSON object.

Execute

SELECT
dbo.ParseJSONField(MiscData, 'IntegrationData1’) AS [Column1]
dbo.ParseJSONField(MiscData, 'IntegrationData2’) AS [Column2]
dbo.ParseJSONField(MiscData, 'IntegrationData3’) AS [Column3]
FROM tblAdditionalData

Example

Code Block

language	xml

DataPath=E:\ximport\CardinalOD
DataMask=XML
ProcPath=e:\ximport\Processed
ErrPath=e:\ximport\Error
URL=http://127.0.0.1/XMLListener.asp
Delimiter=XML
NumLinesSkipped=0
 
Nodes=rsMaster,rsSecondary
 
rsMaster|UserID=0,test
rsMaster|Password=0,TESTTEST
rsMaster|EncryptedPassword=0,1
rsMaster|CustID=0,1218
rsMaster|CustRouteID=230,6
rsMaster|CustSecondaryLookup=0,x
rsMaster|ContractID=0,69290
rsMaster|NodeName=0,ProcessRouteASN
rsMaster|PK=Route$RouteNumber,Route/Stop$StopNumber,Route/Stop/Customer$CustomerNumber
rsMaster|BaseNode=/CardinalDistributionShipmentFile/Shipment
rsMaster|Address=Route/Stop/Customer$CustomerAddress
rsMaster|City=Route/Stop/Customer$CustomerCity
rsMaster|GeoCode=0,1
rsMaster|Name=Route/Stop/Customer$CustomerName1
rsMaster|PostDate=Route/Stop/Customer$InvoiceDate
rsMaster|Reference1=Route/Stop/Customer$CustomerNumber
rsMaster|State=Route/Stop/Customer$CustomerState
rsMaster|StopNotes=Route/Stop/Customer$CustomerName2
rsMaster|StopTime=0,12:00
rsMaster|Zip=Route/Stop/Customer$CustomerZip
 
rsSecondary|NodeName=0,Parcel
rsSecondary|PK=Route/Stop/Customer/ToteCase$ToteCaseID
rsSecondary|FK=Route$RouteNumber,Route/Stop$StopNumber,Route/Stop/Customer$CustomerNumber
rsSecondary|ParcelReference=Route/Stop/Customer/ToteCase$ToteCaseID
rsSecondary|ParcelPieces=1

Search related import documentation

Live Search

size	large
labels	x-import-doc

Version	Old Version 24	New Version 25
Changes made by	Michelle Cabaya (Unlicensed)	Michelle Cabaya (Unlicensed)
Saved on	Oct 07, 2022	Oct 07, 2022

Versions Compared

Key

Example

General

Data Items

Example

Example

Example

Example

Route Stop Details

Example

Example

Example

Example

Example

Example

Example

Example

Example

Examples

Accessorials

Example

Example

Example

Example

User Field

Secondary

Example

Examples

Example

On This Page:

Related Articles:

Search related import documentation

Page Comparison

Versions Compared

Key

Example

General

Data Items

Example

Example

Example

Example

Route Stop Details

Example

Example

Example

Example

Example

Example

Example

Example

Example

Examples

Accessorials

Example

Example

Example

Example

User Field

Secondary

Example

Examples

Example

On This Page:

Related Articles:

Search related import documentation