Using the LogiNext Carrier Interface: Difference between revisions

From CTMS
(In progress)
 
(In progress)
Line 10: Line 10:
* Execution of trips.
* Execution of trips.
* Automatic debrief of trips from information entered into LogiNext systems.
* Automatic debrief of trips from information entered into LogiNext systems.
LogiNext is a 4PL system operated by K+N. They do not offer transport themselves, they offer transport services from other carriers on their behalf. As such, LogiNext is ALSO sending messages to and from those carriers' systems in order to offer orders, confirm acceptance, get debrief information, just like the interface between CTMS and LogiNext systems.


=== Configuration ===
=== Configuration ===
Line 42: Line 43:
* OR – Order Rejected
* OR – Order Rejected
* OC – Order Cancelled
* OC – Order Cancelled
Already existing
* SD - Successfully Delivered
* SC - Successfully Collected
Also, all reason codes expected to be used by the carrier must be set up here. This must be manually done, through comparison with LogiNext and the Carrier's expected reason codes.


==== EDI ====
==== EDI ====
Line 61: Line 69:
The planning screen will be amended to allow the update of the DEL_TYPE on the trip if the system parameter is currently active, for LogiNext carriers.  
The planning screen will be amended to allow the update of the DEL_TYPE on the trip if the system parameter is currently active, for LogiNext carriers.  


The Delivery type on Trip Detail Tab of the Planning screen will be changed to a drop down which will display the values from the new decoded data.
T
 
The user will only be allowed to select a value from the list – no manual entry will be allowed.
 
* Pre-created trips (fixed schedules) an be pre-assigned to the LogiNext carriers up to 14 days in advance.
** The Delivery Type is set in advance
** The structure is sent, without any real details except locations to be visited.
* Or manually create a trip and assign to the LogiNext carrier.
** Select the Delivery Type of the trip from the drop-down list. The list will display only those values that have been configured in the decode list for LogiNext use. No manual entry is allowed.
** Set the vehicle to the vehicle required - this will indicate the vehicle type, and will be replaced when the order is accepted and assigned.
** Set the driver to the default driver for that carrier
* Plan orders to the trip as normal
** Automatic or manual.
** As amendments are made (orders added or removed from the trip), these amendments are sent through to the carrier.
* TENDER the trip
** You will not be allowed to tender the trip without a set and correct delivery type.
** You will not be able to change to TENDERED status without a driver and vehicle.
** Check for acceptance - should be automatically accepted
* ACCEPT the trip - executed by the carrier.


=== Interface to LogiNext ===
When transport bookings are sent to LogiNext, they are combined at the delivery location (the stop number).


A change will also be made to the TRM package to allocate the decoded type when the first order is added to the trip, if no decode is found the delivery type of the order will be used.
So, in the case where there are multiple orders being delivered to the same location, and the items have been packed into multiple boxes mixing the items inside, there is only one transport booking sent to LogiNext, for that location, just stating the boxes that need to be delivered.


The user will only be allowed to select a value from the list – no manual entry will be allowed.
The transport booking sent to LogiNext will be a point to point order - that means that the pickup point (collection location) and drop-off point (delivery location) information will be sent to LogiNext.
 
The delivery type set against the trip determines how we send the transport booking:
 
* On a ROUND, the system will always sent a transport booking for each delivery point. We also create a return to base stop is now only sent if the trip is a ROUND and the last stop is at the depot with no orders to unload.
* On ADHOCs and SESSIONs, the system will send a transport booking for all delivery stops AND the final stop on the trip as the final stop will be at the last delivery location.
 
The transport bookings will be organised in the sequence they are organised on the trip in CTMS, through means of a route message through to LogiNext, which will tell LogiNext which transport bookings are to be done on this route, and in which order.
 
==== Acceptance by the Carrier ====
LogiNext will indicate successful acknowledgement of the transport bookings (the stops on the trip).
 
* Each item on the order will be marked with an item history that says that this item has been acknowledged (received) by the LogiNext.
* When all orders are acknowledged, the trip audit will show this.
 
{{Warning}}This interface is not currently in use.
 
 
LogiNext will pass this on to the carrier (the delivery associate). The carrier will indicate acceptance or non-acceptance of the transport bookings.
 
* The carrier is expected to accept all transport bookings on a trip.
** When the first transport booking is accepted, CTMS will mark the trip as ACCEPTED status.
** As long as there is one accepted transport booking on the trip, the trip is valid for execution.
** Each item on the order will be marked with an item history that says that this item has been accepted by the carrier.
** When all orders are accepted by the carrier, the trip audit will show this.
* The carrier may reject any transport booking on a trip.
** In this case, the order will be removed from the trip in CTMS (unplanned and the status set back to UNSCHEDULED or SCHED-COL).
** Each item on the order will be marked with an item history that says that this item has been rejected by the carrier.
 
{{Note}}
 
* ANY warnings or notes against the trip will be visible in the Trip Comments screens
* ANY rejections (or cancellations - see later) will be visible in the Trip list in the Planning screen - the truck icon will be RED.
* ALL success and failures of messages to and from LogiNext are shown in the the LogiNext Auditing tab of the EDI Interface Errors screen. This will also show the reasons why this has happened. See later for details on checking this audit screen.
 
 
LogiNext will inform the carrier of the stops on the trip and how they are to be executed. The carrier will resource the trip (identifying the driver and actual vehicle) and send this information to LogiNext, which will be forwarded on to CTMS. CTMS will update the information on the trip.
 
{{Warning}}This interface from LogiNext is currently not operating.
 
==== Planning Amendments by You ====
Planning manually can change what is passed to LogiNext carriers, adding or removing stops/orders, or even removing the trips completely. Each of these changes will send the details through to LogiNext for acceptance.
 
'''Note'''. Any changes made to a trip or its orders after the trip has been set to EN-ROUTE status will not be communicated to LogiNext this must be done by calling the control tower to inform them of the changes.
 
* You will not be able to add a stop to a trip while the trip is not at PLANNED status.
 
 
Events:
* If you decide that the trip is not to be completed by that carrier after all, you can change the from a LogiNext enabled carrier to a non-LogiNext enabled carrier, LogiNext will be informed to cancel all of the transport orders on the trip.
* If you decide that a trip that you were going to execute you want a LogiNext carrier to to, change the non LogiNext carrier to a LogiNext carrier. LogiNext will be informed of this new trip and the orders on it.
* If you decide that you want a DIFFERENT LogiNext carrier to do the trip other than the one originally assigned, you can change to a different LogiNext carrier. This will trigger an update to LogiNext telling them that the carrier assignment has changed.
* If you remove an order or stop from a trip, LogiNext will be told to remove the order
** If this is to a stop that has other orders against it, then this will instead amend the transport booking that has been sent to LogiNext, removing the order volume (and items) as required.
* If you add an order to a trip, LogiNext will be informed that the order is added to the trip.
** If this is to a stop that already exists and already has orders against it, then this will instead amend the transport booking that has been sent to LogiNext, adding to the order volume as required.
* If you remove ALL orders from a trip, LogiNext will be informed that all transport orders they have received on that trip must be cancelled.


==== Tag to Asset ====
The Tag to Asset process will be amended to allow T2A scanning at TENDERED status without raising errors.


==== Execution ====
When the status of a trip is changed, a trigger will fire. The trigger will be amended in the following way:


{{Warning}}When the status of a trip is changed, a trigger will fire. The trigger will be amended in the following way:
* Status move from PLANNED to TENDERED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a new control record will be created to record the status change, the event type of this record will be set to TRP. This will be the only trip message sent to LogiNext.
* Status move from PLANNED to TENDERED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a new control record will be created to record the status change, the event type of this record will be set to TRP. This will be the only trip message sent to LogiNext.
* Status move from TENDERED back to PLANNED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a new control record will be created to record the status change. The event type of this record will be set to TRPC.
* Status move from TENDERED back to PLANNED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a new control record will be created to record the status change. The event type of this record will be set to TRPC.
* Status move to DELETED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a series or ORDR control records will be created to record the status change and the order being removed from the trip
* Status move to DELETED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a series or ORDR control records will be created to record the status change and the order being removed from the trip


==== Amendment ====
==== Tag to Asset ====
When the details of a trip are changed, a further trigger will fire The trigger will be amended in the following way:
Tag to Asset is the process of recording the picking of the product to be shipped on orders into transport units (e.g. temp-controlled boxes).


* If the carrier of a trip is changed from a LogiNext enabled carrier to a non-LogiNext enabled carrier, a control record will also be written to indicate the carrier change as all orders associated with the trip will need to be cancelled. The event type of this record will be set to TRPC.
The Tag to Asset process will be amended to allow T2A scanning at TENDERED status without raising errors.  
* If the carrier changed from a non LogiNext carrier to a LogiNext carrier a control record will be created indicating the trip should be processed and sent to LogiNext. The event type of this record will be set to TRP.
* If the carrier of the trip is changed to a different LogiNext carrier a control record will be created indicating the trip should be processed and sent to LogiNext. The event type of this record will be set to TRPX.  


'''Note'''. Any changes made to a trip or its orders after the trip has been set to EN-ROUTE status will not be communicated to LogiNext this must be done by calling the control tower to inform them of the changes.
This process is essentially adding and removing items from the orders, indicating the deliverable boxes and their IDs and contents..  


If an item is removed from an order, an item is added to an order or the quantities are changed on any item on an order, LogiNext will be informed of the items on the order, replacing all items and updating the information against them. 


When the orders are added to or removed from a trip a trigger will fire, the trigger will be amended in the following way:
==== Execution ====
 
{{Warning}}What comes from Carrier?
* If an order is added to a LogiNext trip before the status of the trip is changed to EN-ROUTE a control record will be created to send the order details to LogiNext. The event type of this record will be set to ORDA.
* If an order is removed from a LogiNext trip, a control record will be written to indicate the order is cancelled. An order record will be sent to LogiNext in this case. The event type of this record will be set to ORDR.
* If all orders are removed from a trip, a control record will also be written to indicate the status change, as all orders associated with the trip will need to be cancelled. The event type of this record will be set to TRPC.


* Cancelled - the carrier has cancelled the transport booking.
** Each item on the order will be marked with the quantity as delivered, with an item history that says that this item has been cancelled by the carrier.
** In this case, the order will be removed from the trip in CTMS (unplanned and the status set back to UNSCHEDULED or SCHED-COL).
** An audit record will be added showing the order has been cancelled by the external carrier
* Picked Up
**
* Not Picked Up
**
* Delivered
** Each item on the order will be marked with the quantity as delivered, with an item history that says that this item has been successfully delivered by the carrier.
** The order will be set as status DELIVERED.
** The actual delivery time will be noted.
* Partially Delivered
** Each item shown as not delivered in the message will be marked with a 0 quantity delivered, with an item history showing the reason code that was entered by the carrier.
** Each item on the order will be marked with the quantity as delivered, with an item history that says that this item has been successfully delivered by the carrier.
** The order will be set as status DELIVERED.
** The actual delivery time will be noted.
* Not Delivered
** Each item on the order will be marked with a 0 quantity delivered, with an item history showing the reason code that was entered by the carrier.
** The order will be set as status FAILED.
** The actual delivery time will be noted.


When planned orders are amended a trigger will fire, the trigger will be amended in the following way:
{{Warning}}Ad Hoc Orders


* If an item is removed from an order, an item is added to an order or the quantities are changed on any item on an order, a control record will be written to indicate the order has been amended and an order update record will be sent to LogiNext in this case. The event type of this record will be set to ORDC.
*


In all cases the trip will be checked to ascertain if a LogiNext message is required.




==== Planning Updates ====
{{Note}}


* ANY warnings or notes against the trip will be visible in the Trip Comments screens
* ANY rejections or cancellations will be visible in the Trip list in the Planning screen - the truck icon will be RED.
* ALL success and failures of messages to and from LogiNext are shown in the the LogiNext Auditing tab of the EDI Interface Errors screen. This will also show the reasons why this has happened. See later for details on checking this audit screen.


=== Auditing ===
=== Auditing ===
Line 111: Line 211:


[[File:LogiNext-Audit-Trip.png|800x800px]]
[[File:LogiNext-Audit-Trip.png|800x800px]]
Trip Audit
Order Audit


==== System Auditing ====
==== System Auditing ====

Revision as of 10:31, 8 July 2025

Warning Warning: This is an incomplete guide.


This guide is intended to show the features, configuration and operation of the LogiNext carrier interface within CTMS.

Overview

The process automates the interface to and from LogiNext enabled carriers, providing an interface for:

  • Tendering Trips.
  • Acceptance of orders on trips.
  • Execution of trips.
  • Automatic debrief of trips from information entered into LogiNext systems.

LogiNext is a 4PL system operated by K+N. They do not offer transport themselves, they offer transport services from other carriers on their behalf. As such, LogiNext is ALSO sending messages to and from those carriers' systems in order to offer orders, confirm acceptance, get debrief information, just like the interface between CTMS and LogiNext systems.

Configuration

System Parameters

A system level system parameter “LOGINEXT_ENDPOINT” which will contain the endpoint address for LogiNext.

A new system level system parameter “LOGINEXT_API_TOKEN” which will contain the API token for LogiNext.

The above 2 parameters will be able to be viewed but not modified in the System parameters screen.


A new carrier level system parameter ALLOW_TRP_DEL_TYPE_UPDATE which will control the updating of the Delivery Type in the Planning screen.

The above  parameter will be available for modification in the System parameters screen.

Decodes

A new decode will be created for the delivery types and will be available to be maintained in the imports screen decodes tab.

Resources

The LogiNext enabled carriers can be indicated through the flag agaist the carrier, which is enabled through the Resources screen, Carriers tab.

Reason Codes

Reason codes will need to be created to record activity against orders. These will be at item level for the following.

  • SI - INSCANNED
  • SO - OUTSCANNED
  • HO - HANDEDOVER
  • OC – CLOSED
  • OACK – Order Acknowledged
  • OA – Order Accepted
  • OR – Order Rejected
  • OC – Order Cancelled

Already existing

  • SD - Successfully Delivered
  • SC - Successfully Collected


Also, all reason codes expected to be used by the carrier must be set up here. This must be manually done, through comparison with LogiNext and the Carrier's expected reason codes.

EDI

A new EDI process will be created to process outbound messages to LogiNext.

LogiNext-EDI-Maintenance.png

The flow will have a flow type of “PROCESS” and will run at regular intervals – in the above example the flow is set to run every 2 minutes.

The flow will have report values which specify the process being called.

LogiNext-EDI-Maintenance2.png

Operation

Planning

When creating a trip, the carrier is identified. This may be a LogiNext carrier.

The planning screen will be amended to allow the update of the DEL_TYPE on the trip if the system parameter is currently active, for LogiNext carriers.

T

The user will only be allowed to select a value from the list – no manual entry will be allowed.

  • Pre-created trips (fixed schedules) an be pre-assigned to the LogiNext carriers up to 14 days in advance.
    • The Delivery Type is set in advance
    • The structure is sent, without any real details except locations to be visited.
  • Or manually create a trip and assign to the LogiNext carrier.
    • Select the Delivery Type of the trip from the drop-down list. The list will display only those values that have been configured in the decode list for LogiNext use. No manual entry is allowed.
    • Set the vehicle to the vehicle required - this will indicate the vehicle type, and will be replaced when the order is accepted and assigned.
    • Set the driver to the default driver for that carrier
  • Plan orders to the trip as normal
    • Automatic or manual.
    • As amendments are made (orders added or removed from the trip), these amendments are sent through to the carrier.
  • TENDER the trip
    • You will not be allowed to tender the trip without a set and correct delivery type.
    • You will not be able to change to TENDERED status without a driver and vehicle.
    • Check for acceptance - should be automatically accepted
  • ACCEPT the trip - executed by the carrier.

Interface to LogiNext

When transport bookings are sent to LogiNext, they are combined at the delivery location (the stop number).

So, in the case where there are multiple orders being delivered to the same location, and the items have been packed into multiple boxes mixing the items inside, there is only one transport booking sent to LogiNext, for that location, just stating the boxes that need to be delivered.

The transport booking sent to LogiNext will be a point to point order - that means that the pickup point (collection location) and drop-off point (delivery location) information will be sent to LogiNext.

The delivery type set against the trip determines how we send the transport booking:

  • On a ROUND, the system will always sent a transport booking for each delivery point. We also create a return to base stop is now only sent if the trip is a ROUND and the last stop is at the depot with no orders to unload.
  • On ADHOCs and SESSIONs, the system will send a transport booking for all delivery stops AND the final stop on the trip as the final stop will be at the last delivery location.

The transport bookings will be organised in the sequence they are organised on the trip in CTMS, through means of a route message through to LogiNext, which will tell LogiNext which transport bookings are to be done on this route, and in which order.

Acceptance by the Carrier

LogiNext will indicate successful acknowledgement of the transport bookings (the stops on the trip).

  • Each item on the order will be marked with an item history that says that this item has been acknowledged (received) by the LogiNext.
  • When all orders are acknowledged, the trip audit will show this.

Warning Warning: This interface is not currently in use.


LogiNext will pass this on to the carrier (the delivery associate). The carrier will indicate acceptance or non-acceptance of the transport bookings.

  • The carrier is expected to accept all transport bookings on a trip.
    • When the first transport booking is accepted, CTMS will mark the trip as ACCEPTED status.
    • As long as there is one accepted transport booking on the trip, the trip is valid for execution.
    • Each item on the order will be marked with an item history that says that this item has been accepted by the carrier.
    • When all orders are accepted by the carrier, the trip audit will show this.
  • The carrier may reject any transport booking on a trip.
    • In this case, the order will be removed from the trip in CTMS (unplanned and the status set back to UNSCHEDULED or SCHED-COL).
    • Each item on the order will be marked with an item history that says that this item has been rejected by the carrier.

Note Note:

  • ANY warnings or notes against the trip will be visible in the Trip Comments screens
  • ANY rejections (or cancellations - see later) will be visible in the Trip list in the Planning screen - the truck icon will be RED.
  • ALL success and failures of messages to and from LogiNext are shown in the the LogiNext Auditing tab of the EDI Interface Errors screen. This will also show the reasons why this has happened. See later for details on checking this audit screen.


LogiNext will inform the carrier of the stops on the trip and how they are to be executed. The carrier will resource the trip (identifying the driver and actual vehicle) and send this information to LogiNext, which will be forwarded on to CTMS. CTMS will update the information on the trip.

Warning Warning: This interface from LogiNext is currently not operating.

Planning Amendments by You

Planning manually can change what is passed to LogiNext carriers, adding or removing stops/orders, or even removing the trips completely. Each of these changes will send the details through to LogiNext for acceptance.

Note. Any changes made to a trip or its orders after the trip has been set to EN-ROUTE status will not be communicated to LogiNext this must be done by calling the control tower to inform them of the changes.

  • You will not be able to add a stop to a trip while the trip is not at PLANNED status.


Events:

  • If you decide that the trip is not to be completed by that carrier after all, you can change the from a LogiNext enabled carrier to a non-LogiNext enabled carrier, LogiNext will be informed to cancel all of the transport orders on the trip.
  • If you decide that a trip that you were going to execute you want a LogiNext carrier to to, change the non LogiNext carrier to a LogiNext carrier. LogiNext will be informed of this new trip and the orders on it.
  • If you decide that you want a DIFFERENT LogiNext carrier to do the trip other than the one originally assigned, you can change to a different LogiNext carrier. This will trigger an update to LogiNext telling them that the carrier assignment has changed.
  • If you remove an order or stop from a trip, LogiNext will be told to remove the order
    • If this is to a stop that has other orders against it, then this will instead amend the transport booking that has been sent to LogiNext, removing the order volume (and items) as required.
  • If you add an order to a trip, LogiNext will be informed that the order is added to the trip.
    • If this is to a stop that already exists and already has orders against it, then this will instead amend the transport booking that has been sent to LogiNext, adding to the order volume as required.
  • If you remove ALL orders from a trip, LogiNext will be informed that all transport orders they have received on that trip must be cancelled.


Warning Warning: When the status of a trip is changed, a trigger will fire. The trigger will be amended in the following way:

  • Status move from PLANNED to TENDERED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a new control record will be created to record the status change, the event type of this record will be set to TRP. This will be the only trip message sent to LogiNext.
  • Status move from TENDERED back to PLANNED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a new control record will be created to record the status change. The event type of this record will be set to TRPC.
  • Status move to DELETED, if the carrier of the trip is found to be a LogiNext enabled carrier and there is not a currently unprocessed message to the same type for the same trip a series or ORDR control records will be created to record the status change and the order being removed from the trip

Tag to Asset

Tag to Asset is the process of recording the picking of the product to be shipped on orders into transport units (e.g. temp-controlled boxes).

The Tag to Asset process will be amended to allow T2A scanning at TENDERED status without raising errors.

This process is essentially adding and removing items from the orders, indicating the deliverable boxes and their IDs and contents..

If an item is removed from an order, an item is added to an order or the quantities are changed on any item on an order, LogiNext will be informed of the items on the order, replacing all items and updating the information against them.

Execution

Warning Warning: What comes from Carrier?

  • Cancelled - the carrier has cancelled the transport booking.
    • Each item on the order will be marked with the quantity as delivered, with an item history that says that this item has been cancelled by the carrier.
    • In this case, the order will be removed from the trip in CTMS (unplanned and the status set back to UNSCHEDULED or SCHED-COL).
    • An audit record will be added showing the order has been cancelled by the external carrier
  • Picked Up
  • Not Picked Up
  • Delivered
    • Each item on the order will be marked with the quantity as delivered, with an item history that says that this item has been successfully delivered by the carrier.
    • The order will be set as status DELIVERED.
    • The actual delivery time will be noted.
  • Partially Delivered
    • Each item shown as not delivered in the message will be marked with a 0 quantity delivered, with an item history showing the reason code that was entered by the carrier.
    • Each item on the order will be marked with the quantity as delivered, with an item history that says that this item has been successfully delivered by the carrier.
    • The order will be set as status DELIVERED.
    • The actual delivery time will be noted.
  • Not Delivered
    • Each item on the order will be marked with a 0 quantity delivered, with an item history showing the reason code that was entered by the carrier.
    • The order will be set as status FAILED.
    • The actual delivery time will be noted.

Warning Warning: Ad Hoc Orders


Note Note:

  • ANY warnings or notes against the trip will be visible in the Trip Comments screens
  • ANY rejections or cancellations will be visible in the Trip list in the Planning screen - the truck icon will be RED.
  • ALL success and failures of messages to and from LogiNext are shown in the the LogiNext Auditing tab of the EDI Interface Errors screen. This will also show the reasons why this has happened. See later for details on checking this audit screen.

Auditing

User Auditing

Any errors are recorded in the processing of the LogiNext trips, these will be displayed in the Comments/Errors tab and the truck icon in the trip tree will be underlined in red. This is as per the current trip screen processes and requires no amendment.

LogiNext-Audit-Trip.png

Trip Audit

Order Audit

System Auditing

The detailed system auditing can be seen in the Interface Errors screen, on the LogiNext tab.

LogiNext-Audit-Interface-Errors.png

The screen will display the details of all records from the new LogiNext audit detail described above.

The user can filter the search using the search criteria in the top of the tab page and clicking Search.

The user can reprocess the currently highlighted record by pressing the Reprocess button, this will then invoke the reprocessing function

Only failed outbound messages will be available to be reprocessed and an error will be shown if any other type of record is selected for reprocessing.

The user will not be able to edit data in this screen any errors with trips should be rectified in the planning screen.