Versions Compared
Version | Old Version 15 | New Version 16 |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
title | File Format (General) |
---|
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:
paste-code-macro | ||
---|---|---|
| ||
Nodes=rsMaster,rsSecondary |
General
Data Item SpecificationsInsert excerpt | ||||
---|---|---|---|---|
|
Data Items
Data items are set using a Node|Key=Value format.
expandThe syntax of Value varies based on the Delimiter item (i.e., whether the input file is XML, delimited, or fixed-width.) Specific examples for each type of input file are provided in the following sections.
Note |
---|
Datetime fields must use the format “yyyyMMdd HHmm". |
For Routed file types, Node|Key must be one of the following:
rsMaster|EncryptedPassword: Required
.
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. |
|
| |||||
rsMaster|Password |
Required |
Password for the X Dispatch Internet User used for placing orders. |
|
| |||||
rsMaster|UserID |
Required |
X Dispatch Internet User to use for placing the orders. |
|
| |||||
rsMaster|CustID |
Required |
Customer ID used to place the order. |
|
|
DelayImport: Optional
DelayImport is a parameter to delay the processing of a file by a set number of seconds.
Paste code macro | ||
---|---|---|
| ||
DelayImport=180 # This is for 3 minutes 60*3 = 180 |
NameSpacePrefix: Optional
NameSpacePrefix is a parameter that can be required in some xml inbound documents. If this is being used you will also need to use NameSpaceUri.
Paste code macro | ||
---|---|---|
| ||
NameSpacePrefix =ns2 # This data would be found at the root element in the xml doc |
NameSpaceUri: Optional
NameSpaceUri is a parameter that can be required in some xml inbound documents. If this is being used you will also need to use NameSpacePrefix .
Paste code macro | ||
---|---|---|
| ||
NameSpaceUri =http://internal.amazon.com/TrailerInfo # This data would be found at the root element in the xml doc |
ReplaceContent: Optional
ReplaceContent is a parameter to replace in the document with the matching value with an empty string.
Paste code macro | ||
---|---|---|
| ||
ReplaceContent =:TrailerInfo xmlns:“http://www.schema.com” # This will remove any match for this string to be set to the empty string “”
|
ReImport: Optional
ReImport is a parameter to reimport the processing of a file in the processed directory that does not have a .proc file.
Paste code macro | ||
---|---|---|
| ||
ReImport=1 # Default is 0 ( no reimport ).
|
ReportEmail: Optional
The e-mail address to which X Import will send a report about the import process for the current input file. Multiple email addresses should be comma separated. This works for both On Demand and Routed.
Paste code macro | ||
---|---|---|
| ||
ReportEmail=text@cxtsoftware.com
|
rsMaster|Address: Required
Expand |
---|
The address to use for the current route stop. |
rsMaster|Address2: Required
Expand |
---|
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.
Paste code macro | ||
---|---|---|
| ||
rsMaster|BOL=0,ABC123geo
|
rsMaster|City: Required
Expand |
---|
The city to use for the current route stop. |
Expand |
---|
The primary reference for looking up route translations (See Configuration: X Import Translations.) |
Expand |
---|
The secondary reference for looking up route translations (See Configuration: X Import Translations.) |
rsMaster|RouteSortRuleID: Optional
Info |
---|
Requires X Dispatch 11.1 or newer. |
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.
rsMaster|OverrideGLAccountID: Optional
Info |
---|
Requires X Dispatch 11.1 or newer. |
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
Info |
---|
Requires X Dispatch 11.3.4 or newer. |
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
Info |
---|
Requires X Dispatch 15.2.0 or newer. |
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 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.
Paste code macro | ||
---|---|---|
| ||
rsMaster|GeoCode=0,1 |
rsMaster|Name: Required
Expand |
---|
The name to use for the imported route stop. |
rsMaster|NodeName: Required
The master node name should always be set to “ProcessRouteASN”
Paste code macro | ||
---|---|---|
| ||
rsMaster|NodeName=0,ProcessRouteASN |
rsMaster|Pieces: Optional
Expand |
---|
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
Expand |
---|
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
Expand |
---|
The 4-digit postal code extension for the stop. |
rsMaster|PostDate: Required
Expand |
---|
The date on which this route stop should be posted. |
rsMaster|Reference1: Optional
Expand |
---|
User-defined reference field 1. |
rsMaster|Reference2: Optional
Expand |
---|
User-defined reference field 2. |
rsMaster|RouteID: Optional
Expand |
---|
The route ID onto which the route stops should be placed (See Configuration: X Import Translations, 486342739, 486342739.) |
rsMaster|Sequence: Optional
Expand |
---|
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
Expand |
---|
The state to use for the imported route stop. |
rsMaster|StopNotes: Optional
Expand |
---|
Stop-specific notes (e.g., “Dock 12”) |
rsMaster|StopTime: Optional
The time at which this stop should be scheduled.
Note |
---|
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.
Note |
---|
If this field is not set, then the system will use the current system time (at time of import). |
rsMaster|StopType: Optional
Expand |
---|
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
Expand |
---|
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|Zip: Required
Expand |
---|
The postal code of the route stop.Secondary |
rsMaster|Accessorial1ID: Optional in X Dispatch 20.0 or newer
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. |
Paste code macro | ||
---|---|---|
| ||
rsMaster|Accessorial1ID = 8 |
rsMaster|Accessorial1Quantity: Optional in X Dispatch 20.0 or newer
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 ItemID for the item in rsMaster|Accessorial1ID. |
Paste code macro | ||
---|---|---|
| ||
rsMaster|Accessorial1Quantity = 1 |
rsMaster|Accessorial2ID: Optional in X Dispatch 20.0 or newer
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. |
Paste code macro | ||
---|---|---|
| ||
rsMaster|Accessorial2ID=0,10 |
rsMaster|Accessorial2Quantity: Optional in X Dispatch 20.0 or newer
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 ItemID for the item in rsMaster|Accessorial2ID. |
Paste code macro | ||
---|---|---|
| ||
rsMaster|Accessorial2Quantity = 0,4 |
rsMaster|UserField1: Optional
Expand |
---|
User data field 1. |
rsMaster|UserField2: Optional
Expand |
---|
User data field 2. |
rsMaster|UserField3: Optional
Expand |
---|
User data field 3. |
rsMaster|UserField4: Optional
Expand |
---|
User data field 4. |
rsMaster|UserField5: Optional
Expand |
---|
User data field 5. |
rsMaster|UserField6: Optional
Expand |
---|
User data field 6. |
rsMaster|StopTimeMin: Optional
Expand |
---|
Min stop time. |
rsMaster|StopTimeMax: Optional
Expand |
---|
Max stop time. |
rsMaster|ShortRemarks: Optional
Expand |
---|
Short remarks. |
rsMaster|LongRemarks: Optional
Expand |
---|
Long remarks. |
rsMaster|EmailPod: Optional
Expand |
---|
Email pod. |
rsMaster|XMobileSecondaryLookup: Optional
Expand |
---|
Secondary lookup for X Mobile. |
rsMaster|ForceLocationScan: Optional
Expand | |||||
---|---|---|---|---|---|
Force Location Barcode (Mobile Secondary Lookup) checkbox, for Nextstop Mobile workflow.
When configured as true, this feature sets the driver requirement to perform a location scan for the route stop. |
rsMaster|CustomerRouteID: Optional
Expand |
---|
Customer route ID. |
rsMaster|CustomerStopID: Optional
Expand |
---|
Customer stop ID. |
rsMaster|CustomerAccountID: Optional
Expand |
---|
Customer account ID. |
rsMaster|RouteOverride: Optional
Expand | |||||
---|---|---|---|---|---|
Route pay override.
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
Expand |
---|
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
Expand |
---|
Data: AdvancedFallbackLookup1 is stored in tblOrderRouteStops in the AdvancedFallbackLookup1 column. It is the ALF1 field under the miscellaneous tab in X Dispatch. |
rsMaster|AdvancedFallbackLookup2: Optional
Expand |
---|
Data: AdvancedFallbackLookup2 is stored in tblOrderRouteStops in the AdvancedFallbackLookup2 column. It is the ALF2 field under the miscellaneous tab in X Dispatch. |
rsMaster|RateChartOverrideLookup: Optional
Expand |
---|
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. |
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.
Paste code macro | ||
---|---|---|
| ||
rsMaster|ConsolidateStops=0,1 |
rsMaster|ConsolidationText: Optional
Expand | |||||
---|---|---|---|---|---|
Intended to consolidate stops between ASN files. Use any string to set consolidation value - can be at any level.
ConsolidationText creates record in database in cxtData.dbo.tblOrderRouteStops_Consolidated. ConsolidationText should include the date since the consolidation text will try to look up anything that matches within the last 30 days. |
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.
Expand |
---|
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.)
- AddressMin - return the new address only. (keeps old lat/long data.)
Paste code macro | ||
---|---|---|
| ||
rsMaster|ValidationFailOver=0,LatLonMin |
Note |
---|
The goecode bit needs to be turned on for the LatLonMin ValidationFailOver process to return lat/lon coordinates. rsMaster|GeoCode=0,1 |
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 | ||
---|---|---|
| ||
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”
Paste code macro | ||
---|---|---|
| ||
rsSecondary|NodeName=0,Parcel |
rsSecondary|ParcelPieces: Optional
Expand |
---|
The number of pieces or items contained within this parcel. |
rsSecondary|ParcelReference: Optional
Expand |
---|
Parcel-level barcode. |
rsSecondary|ParcelType: Optional
Expand |
---|
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
Expand |
---|
The weight associated with this parcel. |
rsSecondary|PK: Required
Expand |
---|
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
Expand |
---|
Description of the parcel. |
rsSecondary|ParcelReference2: Optional
Expand |
---|
Secondary reference field for the parcel. |
rsSecondary|ParcelMasterBarcode: Optional
Expand |
---|
Secondary reference field for the parcel. This sets the Parcel Consolidation Barcode. |
rsSecondary|ParcelConsolidationBarcode: Optional (X Dispatch 13.1.2 or newer)
Expand |
---|
This sets the Parcel Consolidation Barcode 2 |
rsMaster|MiscData|[...]: Optional (X Dispatch 14.2.1 or newer)
rsSecondary|MiscData|[...]: Optional (X Dispatch 14.2.1 or newer)
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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.
ExampleUsing the following in a XASN will store data as a property in a JSON object.
Execute
Returns ExampleUsing the following in a XASN will store data as a property in a JSON object.
Execute
Returns |
Example
language | xml |
---|---|
theme | Default |
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.
| |||||||
rsMaster|City | Required The city to use for the current route stop. | |||||||
| Optional The primary reference for looking up route translations (See Configuration: X Import Translations.) | |||||||
| 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.
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. | |||||||
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.
| |||||||
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.
| |||||||
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”
| |||||||
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, 486342739.) | |||||||
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|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.
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.
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. | |||||||
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. | |||||||
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. | |||||||
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.
| |||||||
rsMaster|ConsolidationText | Optional Intended to consolidate stops between ASN files. Use any string to set consolidation value - can be at any level.
ConsolidationText creates record in database in cxtData.dbo.tblOrderRouteStops_Consolidated. 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.
| |||||||
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:
| |||||||
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.
|
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.
Possible version compatibility issue. See Changelog below. | |||||||
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.
Possible version compatibility issue. See Changelog below. | |||||||
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.
Possible version compatibility issue. See Changelog below. | |||||||
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.
Possible version compatibility issue. See Changelog below. |
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.
| |||||||
rsSecondary|NodeName | Required The secondary node name should always be set to “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 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.
|
Example
Code Block | ||
---|---|---|
| ||
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
|
Anchor | ||||
---|---|---|---|---|
|
Expand |
---|
X Dispatch 21.0
X Dispatch 20.0
X Dispatch 19.2
X Dispatch 18.1
X Dispatch 14.2.4
X Dispatch 14.2.1
X Dispatch 13.1.2
X Dispatch 12.1.4
X Dispatch 12.1.3
X Dispatch 12.0.0
X Dispatch 11.2.6
Version 1.4.5
Version 1.4.3
Version 1.3.0
Version 1.2.0
|
On This Page:
Table of Contents | ||
---|---|---|
|
Related Articles:
Child pages (Children Display) | ||
---|---|---|
|
Search related import documentation
Live Search | ||||
---|---|---|---|---|
|