Versions Compared
Version | Old Version 14 | New Version 15 |
---|---|---|
Changes made by | ||
Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Expand | ||||||
---|---|---|---|---|---|---|
| ||||||
|
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 |
Data Item Specifications
Data items are set using a Node|Key=Value format.
The syntax of Value varies based on the Delimiter item (i.e., whether 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
Expand | |||||
---|---|---|---|---|---|
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
Expand | |||||
---|---|---|---|---|---|
Password for the X Dispatch Internet User used for placing orders.
|
rsMaster|UserID: Required
Expand | |||||
---|---|---|---|---|---|
X Dispatch Internet User to use for placing the orders.
|
rsMaster|CustID: Required
Expand | |||||
---|---|---|---|---|---|
Customer ID used to place the order.
|
DelayImport: Optional
Expand | |||||
---|---|---|---|---|---|
DelayImport is a parameter to delay the processing of a file by a set number of seconds.
|
NameSpacePrefix: Optional
Expand | |||||
---|---|---|---|---|---|
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.
|
NameSpaceUri: Optional
Expand | |||||
---|---|---|---|---|---|
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 .
|
ReplaceContent: Optional
Expand | |||||
---|---|---|---|---|---|
ReplaceContent is a parameter to replace in the document with the matching value with an empty string.
|
ReImport: Optional
Expand | |||||
---|---|---|---|---|---|
ReImport is a parameter to reimport the processing of a file in the processed directory that does not have a .proc file.
|
ReportEmail: Optional
Expand | |||||
---|---|---|---|---|---|
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.
|
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
Expand | |||||
---|---|---|---|---|---|
The BOL (Bill of Lading) data to which route stops may be associated. Maximum length = 50.
|
rsMaster|City: Required
Expand |
---|
The city to use for the current route stop. |
rsMaster|CustRouteID: Optional Anchor CustRouteID CustRouteID
Expand |
---|
The primary reference for looking up route translations (See Configuration: X Import Translations.) |
rsMaster|CustSecondaryLookup: Optional Anchor CustSecondaryLookup CustSecondaryLookup
Expand |
---|
The secondary reference for looking up route translations (See Configuration: X Import Translations.) |
rsMaster|RouteSortRuleID: Optional
Expand | ||||
---|---|---|---|---|
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
Expand | ||
---|---|---|
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
Expand | ||
---|---|---|
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
Expand | ||||
---|---|---|---|---|
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
Expand | |||||
---|---|---|---|---|---|
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
Expand |
---|
The name to use for the imported route stop. |
rsMaster|NodeName: Required
Expand | |||||
---|---|---|---|---|---|
The master node name should always be set to “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
Expand | ||
---|---|---|
The time at which this stop should be scheduled.
|
rsMaster|StopTimeFallback: Optional
Expand | ||
---|---|---|
The time at which this stop should be scheduled if the StopTime set to “0,” which will set it to a blank value.
|
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
Expand | |||||||
---|---|---|---|---|---|---|---|
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.
|
rsMaster|Accessorial1Quantity: Optional in X Dispatch 20.0 or newer
Expand | |||||||
---|---|---|---|---|---|---|---|
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.
|
rsMaster|Accessorial2ID: Optional in X Dispatch 20.0 or newer
Expand | |||||||
---|---|---|---|---|---|---|---|
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.
|
rsMaster|Accessorial2Quantity: Optional in X Dispatch 20.0 or newer
Expand | |||||||
---|---|---|---|---|---|---|---|
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.
|
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
Expand | |||||
---|---|---|---|---|---|
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
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. |
rsMaster|ODSyncField[XINI field name]:Optional
Expand | ||
---|---|---|
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
Expand | |||||||
---|---|---|---|---|---|---|---|
When used, returns at the minimum the specified value information when the address does not validate as an exact match. Valid types are:
|
rsSecondary|FK: Required
Expand | |||||
---|---|---|---|---|---|
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
Expand | |||||
---|---|---|---|---|---|
The secondary node name should always be set to “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
Paste code macro | ||||
---|---|---|---|---|
| ||||
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 |
On This Page:
Table of Contents | ||
---|---|---|
|
Related Articles:
Child pages (Children Display) | ||
---|---|---|
|
Search related import documentation
Live Search | ||||
---|---|---|---|---|
|