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 will confirm, pick up, and deliver the order. When the order is completed, 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 will need to work with CXT Software to be fully operational. Below are information and steps needed to set up the integration.
Make sure to request and provide information to LoadChief and set up XD before reaching out.
Information to Provide LoadChief
You will need to create an API user and provide the username and password along with URLs for the API to LoadChief.
Create a LoadChief User
Create a user for LoadChief from the Users section of the Operations App in order to send information to and from LoadCheif and CXT Software through the API. Update steps below.
API users are created in the Users section whicle users for the Operations App are created in the Cloud Client.
Go to Maintenance > Users.
Click New or the + button to create a new user.
Enter a username and password. This is the information you will need to give LoadChief.
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
Click the save or OK button.
URLs to Provide LoadChief
The following are URLs you need to provide LoadChief. These URLs are used to send order status and driver pay details from LoadChief to your system.
Replace XXXX with your CXT Software customer number
https://XXXX0.cxtsoftware.net/CxtWebService/CXTWCF.svc
https://XXXX.cxtsoftware.new/CxtWebService/CxtWebServiceRest.svc/rest/process/LoadChiefWeb
Operations App Setup
Create a 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 driver
Go to Maintenance > Human Resources.
Create a new human resource record for the 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.
Go to Maintenance > Drivers.
Create a new driver and make sure to select the human resource record you created in step 2. See Drivers for more information.
Verify Required Service Types
When importing orders to LoadChief, only service types in their system must be selected. The following are service types required by LoadChief and must be in the Service Types section.
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 LoadChief, 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 ND.
Go to Maintenance > Status Codes.
Create a new status code for the additional compensation. See Status Codes for more information.
ID: 5StringPU Description
Description: AdditionalCompensation
Exception Type: Order
Enable the status code for all customers or for specific customers on their /wiki/spaces/CSS/pages/1668022343.
Quick Tip: Enabling the Internet Display option will display the status code to your 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 username and password, the driver ID(s) for the LoadChief driver(s) you created, and customer ID(s) for customers 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 Workflow
Orders can be dispatched to the LoadChief driver after CXT Software has deployed the components.
Additional Compensation
If additional compensation is needed, it can be applied in the Operations App by adding the “5StringPU Description-AddtionalCompenstation” status code to the order and entering the additional compensation dollar amount in the status code comment.
Confirmed Order
Once the order is confirmed by the driver, LoadChief will send a confirmation notification back to your system and will update the order.
What about Pickup? Gets updated
Delivered Order
When the order is delivered, LoadChief will send a delivery update and 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 signature.