The Crimson Logic (Global eTrade) border crossing integration allows Extend to send all of the necessary border crossing information to the Global eTrade (GeTS) system. This data is then submitted to the US/CAN border authority for approval from which responses are returned to GeTS and Extend.

Reference Info

• API: CALISTA Developer Platform (globaletrade.services)

• UI: https://compliance.globaletrade.services/na-mig/login

• Test UI: https://tcompliance.globaletrade.services/na-mig/login

Setup

Integration Configuration

This integration requires multiple steps to set up. Most fields are configured before the integration is saved, but the fields marked in blue must be completed after saving the initial settings. You can find an explanation for each field below:

• Title*: This is the text that will appear under Admin → Integrations to easily identify the integration.

• Endpoint*: The endpoint to which the integration points. It will default to the testing endpoint, so you will need to update it to the production endpoint when setting up for a live customer.

  • Production: https://compliance.globaletrade.services

  • Test: https://tcompliance.globaletrade.services/

• User Name*: The user name for the API integration, it can also be used to log into the GeTS portal. It should be provided by Crimson Logic to the customer.

• Password*: The password for the API integration, it can also be used to log into the GeTS portal. It should be provided by Crimson Logic to the customer.

• API Key*: The key for the API integration. It should be provided by Crimson Logic to the customer.

• Identifier*: This tell the integration which value it should be sending to GeTS as the primary identifier for the load.

  • Order Number: The system will use carddata.OrderNumber.

  • Trip Id: The system will use carddata.TripId.

• US Draft Board: This is a multi-select that will display all Order and Segment boards. It determines which boards will be monitored to send to GeTS in the Draft (presubmission) format for border crossings into the US. Draft submissions require manual review and submission by the customer in the GeTS portal

• US Live Board: This is a multi-select that will display all Order and Segment boards. It determines which boards will be monitored to send to GeTS in the Live format for border crossings into the US. Live submissions require no additional review and are passed immediately through to the border authority.

• Ace Ramp: This single-select dropdown allows you to select a ramp that intercepts and alters GeTS submissions for border crossings into the US. Only ramps that have already been created with the Ace trigger are available, so this step has to be done after the initial integration setup is saved. It is important to note that a ramp set here will be used even if the ramp is disabled. See the GeTS Ramps section for more details.

• CAN Draft Board: This is a multi-select that will display all Order and Segment boards. It determines which boards will be monitored to send to GeTS in the Draft (presubmission) format for border crossings into Canada. Draft submissions require manual review and submission by the customer in the GeTS portal

• CAN Live Board: This is a multi-select that will display all Order and Segment boards. It determines which boards will be monitored to send to GeTS in the Live format for border crossings into Canada. Live submissions require no additional review and are passed immediately through to the border authority.

• Aci Ramp: This single-select dropdown allows you to select a ramp that intercepts and alters GeTS submissions for border crossings into Canada. Only ramps that have already been created with the Ace trigger are available, so this step has to be done after the initial integration setup is saved. It is important to note that a ramp set here will be used even if the ramp is disabled. See the GeTS Ramps section for more details.

• Seal Number*: This is a single-select dropdown that maps to the Reference Types Dropdown Options. This is used to tell the integration which reference number should be used as the seal number when sending to GeTs.

• MEDPID Crew Sync Board: This is a multi-select dropdown that lets you indicate which Driver boards we should be syncing to GeTS. See the MEDPID section for more details.

• MEDPID Conveyance Sync Board: This is a multi-select dropdown that lets you indicate which Truck boards we should be syncing to GeTS. See the MEDPID section for more details.

• MEDPID Equipment Sync Board: This is a multi-select dropdown that lets you indicate which Trailer boards we should be syncing to GeTS. See the MEDPID section for more details.

• HAZMAT Driver Attribute: This is a single-select dropdown that maps to the Driver Attributes Dropdown Options. It is used to mark which driver attribute to look for when determining whether to tell GeTS that the driver is allowed to haul hazmat.

• Conveyance Types: This is a field mapping tool that allows you to match the Equipment Types Dropdown Options in Extend with the different conveyance types in GeTs (trucks). Whichever option is mapped to “Default” is used when a match is not found.

• Equipment Types: This is a field mapping tool that allows you to match the Equipment Types Dropdown Options in Extend with the different equipment types in GeTs (trailers). Whichever option is mapped to “Default” is used when a match is not found.

• US Freight Count UoM: This is a field mapping tool that allows you to match the Count Units Dropdown Options in Extend with the different freight units of measurement in GeTS for border crossings into the US. Whichever option is mapped to “Default” is used when a match is not found.

• CAN Freight Count UoM: This is a field mapping tool that allows you to match the Count Units Dropdown Options in Extend with the different freight units of measurement in GeTS for border crossings into Canada. Whichever option is mapped to “Default” is used when a match is not found.

• Travel Documents: This is a field mapping tool that allows you to match the Travel Documents Dropdown Options in Extend with the different travel documents in GeTS. Whichever option is mapped to “Default” is used when a match is not found.

• Genders: This is a field mapping tool that allows you to match the Gender Dropdown Options in Extend with the different driver genders in GeTS. Whichever option is mapped to “Default” is used when a match is not found.

• MEDPID Travel Docs: This is a field mapping tool that allows you to match the Travel Documents Dropdown Options in Extend with the different travel documents in GeTS for MEDPID Crew. Whichever option is mapped to “Default” is used when a match is not found.

GeTS Ramps

When the Global eTrade integration is enabled, it also enables two new Ramp Triggers in the system. These ramp triggers allow a ramp to intercept GeTS transmissions and alter the data before it goes out. This is used to customize the data beyond our normal integration mapping. When the integration is turned on the following triggers become available for ramps:

Triggers

• Global eTrade ACE Highway Integration Event: This trigger allows the ramp to be selected in the integration settings on the Ace Ramp field. If set, the ramp will trigger whenever a GeTS submission for a border crossing into the US is sent. Setting the trigger isn’t enough, the ramp MUST be selecting in the integration settings as well. Once set there, it will run even if the ramp is disabled.

• Global eTrade ACI Highway Integration Event: This trigger allows the ramp to be selected in the integration settings on the Ace Ramp field. If set, the ramp will trigger whenever a GeTS submission for a border crossing into the US is sent. Setting the trigger isn’t enough, the ramp MUST be selecting in the integration settings as well. Once set there, it will run even if the ramp is disabled.

Block

Once an ACE or ACI trigger are set on the ramp a new default block will appear in the ramp. All data manipulation must be done within this block and the final result must be passed into the “return” section of the block. By default, it is the requestBody variable which should be passed but it can be any variable so long as it is structured correctly.

If you pass in an empty object to the return, then the submission process will be cancelled. This can be useful if you want to prevent certain border crossing events from being sent.

Open

Variables

Once an ACE or ACI trigger are set on the ramp a new set of variables become available. These a populated by the integration by default and can be very helpful to pull data from. Below is a small description of each variable:

• borderCrossingStopObj: This is the full border crossing stop object. If you need to pull any stop data, it should be available here.

• cardObj: This is the full Order/Segment card.

• driverObj: This contains the Driver card for the driver that is attached to the Order/Segment as the primary driver.

• locationObj: This contains the Location card associated with the border crossing stop.

• originalConsigneeObj: This contains the Location card set as the original consignee on the Order/Segment.

• originalShipperObj: This contains the Location card set as the original shipper on the Order/Segment.

• requestBody:

• trailerObj: This contains the Trailer card for the trailer that is attached to the Order/Segment.

• truckObj: This contains the Truck card for the truck that is attached to the Order/Segment.

Operating Codes

Operating codes are not part of the integration settings but configuring them is required for GeTS submissions to work. Operating codes are a Dropdown Option that represents the company identifier/SCAC. You can configure these under Admin → Dropdown Options → Operating Codes.

When you create a new option here it will appear as an operating code option on Orders, Segments, Drivers, Trucks, and Trailers. Each option also supports the entry of multiple Code/Country pairs. This allows us to set different codes for each company depending on the direction of the border crossing.

You will need at least one Operating Code Dropdown Option. That option should have and entry for US with the company SCAC and an entry for CA with the carrier number.

Open

Operation

Once the integration settings, ramps (if needed), and operating codes have been set up the integration can be used. The integration transmits Orders/Segments to GeTS for submission to the border authority. It also submits crew, conveyance, and equipment information called MEDPID for the US border crossings. These are detailed below.

Orders/Segments

The GeTS integration is capable of sending Orders and/or Segments to GeTS for border crossing purposes. Typically, a company should be using one or the other, but technically the integration supports both. In order for a submission to trigger several requirements must be met on the Order/Segment:

• Stop with the Border Crossing stop type

• Attached Driver

• Attached Truck

• Attached Trailer

• Original Shipper

• Original Consignee

• Freight

• Operating Code

  • This one will not prevent the send from triggering, but an error will be logged for a missing operating code in the integration logs.

Once all of the above data requirements are met, the load will be transmitted to GeTS. These transmissions are logged in the Integration Logs and any submission errors can be found there. If you are using GeTS ramps those logs will of course be found in the Ramp Logs.

Which endpoint we send the trip to is determined by the location of the stop that follows the border crossing stop. If the stop is in the US, then we send it to the US ACE endpoint. If the stop is in Canada, then we send it to the CA ACI endpoint. We ignore stops with the stop type of Fuel for this determination.

MEDPID

Along with the Orders/Segments we also send over crew (driver), conveyance (truck), and equipment (trailer) information to the US endpoints. These endpoints are referred to as MEDPID and allow those records to be maintained in the GeTS UI. Most importantly, it allows for drivers to be issued an Id that can be used for crossing known as an ACE Id. See below for more details on each type.

Crew

the MEDPID crew endpoint allows us to sync over drivers from Extend. These can be viewed in the GeTS portal and can be issued ACE IDs from the system if they do not yet have one. A driver card must meet the following data requirements after which is it sent to GeTS:

• Driver ID

• First Name

• Last Name

• Operating Code

• Date of Birth

• Country of Citizenship

• Gender

• CDL Number

• License State

• Travel Document

  • Must have a Passport, Ace ID, or FAST ID

Conveyance

The MEDPID conveyance endpoint allows us to pass in truck information. It is basically just used as a way to easily review tractor info in the GeTS portal.

• Tractor Number

• Operating Code

• License Plate

• License State

Equipment

The MEDPID equipment endpoint allows us to pass in trailer information. It is basically just used as a way to easily review trailer info in the GeTS portal.

• Trailer ID

• Operating Code

• License Plate

• License State

Troubleshooting

There are some common issues that come up and are easy to check for. These are accompanied by an error message in the Integration logs.

• Missing License Info: This issue arises if the tractor or trailer attached to the order is missing a license plate or license state value. Updating the card with the correct information should correct the issue, though you will have to retrigger a submission on the Order/Segment

• Weight/Pieces of 0: If any of the freight on the Order/Segment have a weight or pieces of 0 then the submission will error. Updating the freight to the correct value will resolve the issue and cause it to resend to GeTS immediately.

• Missing Travel Docs: If the driver does not have the required Travel Documents on their driver card then the submission to GeTS will error. Updating the card with the correct information should correct the issue, though you will have to retrigger a submission on the Order/Segment

• Retriggering to GeTS: If you need to manually trigger a resend to GeTS editing any field on the card related to GeTS or any custom field should trigger it. Editing a field on an attached card, even if it is used in GeTS, will not trigger a resubmission.