Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

If the Integrations team can provide it - this top section might be a good place to add information about LoadChief. What type of business is it? What’s it used for (operationally speaking, no config info here)? Do we have any contact info?

LoadChief outsources work for driver purposes. Find drivers like Uber. Since hard to get and keep drivers can use LoadChief to find drivers.

Should there be a “Note” or something here that indicates the customer will require involvement of CXT Software to get this integration fully operational? Since this is in our public KB, any customer can stumble on it - so I’m wondering if we need to add that disclaimer at the top, just in case.

Integration Workflow Overview

The LoadChief integration assigns an order to a LoadChief driver who

Loadchief is a platform that connects courier companies with credentialed, independent delivery drivers to provide on-demand delivery through their digital marketplace. The platform leverages the scalability and flexibility of crowdsourcing to help courier companies increase their delivery reach and open new markets with an on-demand pool of carefully vetted and professional contractors. See Loadchief’s website, Loadchief.com, for more information.

Connection Workflow Overview

The Loadchief connection enables courier companies to dispatch orders to Loadchief (by creating and using a driver record for Loadchief). Loadchief will confirm, pick up, and deliver the order and transmit order status updates back to your system in real-time. When the order is completed, LoadChief Loadchief will update the final driver pay amount. This will lock the order rate and pay. Order information is sent by API and additional compensation can be sent using status codes. To set up the integration you

Note

You will need to work with CXT Software to complete this connection’s setup, before it will be fully operational. Below are information and steps needed to set up the

integration

connection.

note

Make sure to request and provide information to LoadChief Loadchief, and set up XD the operations app, before reaching out to CXT Software for the final deployment.

Table of Contents
3
minLevel1
maxLevel7
excludeIntegration Workflow Overview

Information to Provide

LoadChiefYou will need to create an API user and provide the username and password along with URLs for the API to LoadChief

Loadchief

Loadchief needs two main pieces of information to set up the connection on their end: a Loadchief API user (which needs to be created in your operations app) and specific URLs for your system.

Create a

LoadChief

Loadchief User

Create a user for LoadChief Loadchief from the Users section of the Operations App in order . This user needs to be created to enabled Loadchief to send information to and from LoadCheif and CXT Software through the API . Update steps belowto your system.

Info

API users are created in the Users section whicle while users for the Operations App are created in the Cloud Client.

  1. Go to Maintenance > Users.

  2. Click New or the + button to create a new user.

  3. Enter a username and password. This is the information you will need to give LoadChiefto Loadchief.

  4. Enable the following permissions:

    • Orders

      • Edit Orders

      • Edit Dispatched Orders

      • Edit Rates

      • Edit Item Quantities

      • Edit Order Distance

      • Edit Parcel Items

      • Edit Customer Notes

      • Cancel Orders

      • Unlock Rates

      • Unlock Driver Pay

      • View Charges

      • View Driver Pay Amounts

      • View Driver Pay Percents

      • View Order Parcels

      • Edit Order Parcels

      • Allow Spell Check of Orders

      • Allow Surcharge Override

      • View XS Data

      • View XS Order Parcel Data

  5. Click the save or OK button.

URLs to Provide

LoadChiefThe following are URLs you need to provide LoadChief

Loadchief

You will also need to provide the following two URLs to Loadchief. These URLs are used by Loadchief to send order status and driver pay details from LoadChief to your system.

Info

Replace XXXX with your CXT Software customer number

  • https://XXXX0.cxtsoftware.net/CxtWebService/CXTWCF.svc

  • https://XXXX.cxtsoftware.new/CxtWebService/CxtWebServiceRest.svc/rest/process/LoadChiefWebLoadchiefWeb

Operations App Setup

Create a

LoadChief

Loadchief Driver

Create a driver that is going to be used to assign orders to LoadChief. Same question here (as asked above) - what context can we add so the customers understand how they’ll be dispatching and/or any operational nuggets they’ll need for things work properly. Maybe a link to a below section with more info on the workflow might fit here? The assumption here was that the reader is familiar with XD and this was just a how to set up the integration. Can there be more than 1 driver? How do we connect this driver to the integration? Tied with message format and customer tells CXT driver ID. Would need to set pay chart to designate what to pay driver and it’s sent to LoadChief with order info but LoadChief updates the driver at the end. You can have more than 1 driverLoadchief. Loadchief will complete the work and order status updates will be sent back to your system.

  1. Go to Maintenance > Human Resources.

  2. Create a new human resource record for the LoadChief Loadchief driver. See Human Resources for more information. Is there a specific driver pay configuration? Does it need to be set to 0. Is driver pay overwritten by LoadChief? Think it overrides order

    1. Set up driver pay with preferred configurations. Additional compensation considerations can/will be made by Loadchief (see below for more information).

  3. Go to Maintenance > Drivers.

  4. Create a new driver and make sure to select the human resource record you created in step 2. See Drivers for more information.

Tip

Quick Tip: More than 1 driver can be created for Loadchief, if needed. All driver IDs must be given to CXT Software.

Verify Required Service Types

When importing orders to LoadChiefLoadchief, only service types in compatible with their system must can be selectedused. The following are service types required by LoadChief and Loadchief must be created in the Service Types section of the operations app.

Note

Service type Descriptions must match exactly.

  • Sedan

  • SUV

  • Pickup Truck

  • Van

  • Full Size Pickup

  • Cargo Van

  • Flat Bed

  • 24 Feet Truck

  • Dry Van

If needed, new service types can be created by going to Maintenance > Service Types and clicking the New or + button. See Service Types for more information.

Create an Additional Compensation Status Code (Optional)

If you need to add additional compensation from the Operations App to LoadChiefThe Additional Compensation functionality is included in this connection to offset your configured driver pay calculation with the rate Loadchief was able to secure to complete the work. Loadchief will contact you if additional compensation needs to be added to an order.

To set up additional compensation, you need to create a status code to send this information. The additional compensation amount will be entered as a comment on the order. Any amount entered in the LoadChief portal will override this amount. Same question here (as asked above) - what context can we add so the customers understand why this setup is required and how it will be used for the integration. Updated. Not sure if that last sentence should be modified. Pretty much you can enter it there or if there is something there it will take that amount instead. Tried to make the below general because it’s different in XD vs NDin the Operations App.

Info

If using the Loadchief portal, any additional compensation entered there will override driver pay amounts in the operations app.

  1. Go to Maintenance > Status Codes.

  2. Create a new status code for the additional compensation. See Status Codes for more information.

    • ID: 5StringPU Description

    • Description: AdditionalCompensation

    • Exception Type: Order

  3. Enable the status code for all customers or for specific customers on their /wiki/spaces/CSS/pages/1668022343.

Tip

Quick Tip: Enabling Disable the Internet Display option will display the to hide this status code to your , for clients tracking the order(s) in the Client Portal.

Submit CXT Software Integration Request

Create an integration request with CXT Software and include your LoadChief the following information:

  • Your Loadchief username and password

, the
  • (this is the information you use to login with Loadchief)

  • The driver ID(s) for the

LoadChief
  • Loadchief driver(s) you created

, and
  • in the operations app

  • A list of customer ID(s)

for customers
  • that you would like to

use LoadCheif to deliver their orders. Is there any context that can be added here to explain why the customer needs to contact us at this point in the setup? Is it to expedite deployment? Updated. Integrations
  • enable for Loadchief connection (to dispatch orders and send work to Loadchief)

Connection Workflow

Orders can be dispatched to the LoadChief Loadchief driver after CXT Software has deployed the components.

Sending Order Information to Loadchief

If an order (associated with a client that is set up to connect with Loadchief) is dispatched to the specific Loadchief driver for this connection, the order information (along with the initial estimated driver pay amount), is sent over to Loadchief.

Additional Compensation

If additional compensation is needed , it can be applied in the Operations App by adding the “5StringPU Descriptionfor an order, add the “5StringPU-AddtionalCompenstation” status code to the order and entering Status Codes tab on the order. Enter the additional compensation dollar amount in the status code comment.

Confirmed Order

Once the order is confirmed by the driver, LoadChief Loadchief will send a confirmation notification back to your system and will update the order. What about Pickup? Gets updated

Picked Up Order

When an order is picked up, information is sent back to your system and any message notifications set up on the customer record will be sent.

Delivered Order

When the order is delivered, LoadChief Loadchief will send a delivery update and to your system including a final pay update, that will update the driver pay and lock the rate and pay on the order. Any POD information sent back? Yes. Pay is usually added by LoadChief with their surcharge. Pay on order at time of creation. Not sure about signaturewill also be sent back to your system and message notifications set up on the customer record will be sent.