292352
DHL C-TMS
ETA Details from Microlise into C-TMS
FUNCTIONAL SPECIFICATION - 10.7
20/10/11 - 1.0
Reference: 292352 -PM8LZMK3
Contents
Client Requirement
Change Request Summary:
Upload ETA from Microlise into C-TMS.
Change Request Details:
Upload ETA into C-TMS and make visible against stops in trip manipulation, execution, trip overview.
Benefits identified as a result of the change:
Solution design requirement.
Solution
The ‘ETA’ items will be uploaded from the XML file for the ETA updates received from Microlise.
The Microlise inbound procedure will be changed to include a new event type of ‘ETA’ to update specifically the ETA times and not the actual arrival and departure times for the trip stop (which will be performed by the existing tracking events).
The ‘ETA’ items will be validated and stored in C-TMS: the validation will ensure that the items are in the correct date/time format and, if not, set the status of the interface message to ‘FAILURE’ and prevent the update of the trip stops.
N.B. The ‘ETA’ items will not be visible in the ‘XML Trips’ tab page in the ‘Interface Errors’ screen.
See RIO 292350 PM-8LZMEM for information regarding the inclusion of the ‘ETA’ items in the XML file.
The ‘ETA’ items will be added as new columns on the trip stop database table.
The ‘Trip Overview’ (i.e. ‘Waterfall’) screen with transport orders displayed will be changed to include the estimated date and time of arrival of the order at its next stop, the derivation date and time and the next stop for the transport order on the trip. The ‘ETA’ columns will be configurable.
The ‘Trip Overview’ (i.e. ‘Waterfall’) screen with only trips displayed will be changed to include the estimated date and time of arrival at the next stop, the derivation date and time and the next stop of the trip. The ‘ETA’ columns will be configurable to be displayed or not as a users preference.
The next stop of the trip will be obtained from the highest stop number without any actual times recorded.
The existing system parameters to control the ‘RAG’ colour scheme will be used for the 3 new ‘ETA’ columns. How the ‘RAG’ colour scheme will be applied will be confirmed in the functional specification. If the actual times have been recorded for the trip stop then the ‘ETA’ information will no longer need to be displayed.
The ‘Trip Manipulation’ screen will be changed to include the estimated date and time of arrival at the stop as a configurable item in the ‘Stops’ tab page for display and entry.
The ‘Trip Execution’ screen will be changed to include the estimated date and time of arrival at the stop as a configurable item in the orders section for inclusion with the existing ‘Load Stop’ and ‘Unload Stop’ columns.
Scope
This change will be applied to system version 10.7.
Set-up
Pre-requisites
None
Menu Structure
Unchanged
Data
New ‘ETA’ items will be added as new columns on the trip stop database table and should be altered as needed on user’s configurable layouts.
Functional Description
Business Data
Two new xml tags have been added to the ‘Trip Order v2.23.xsd’ file below labelled as ‘Stop Eta Date’ and ‘Stop Eta At Date’. The details of this change are covered in the specification for RIO 292350 PM-8LZMEM.
Trip Overview Package
A new procedure will be added to obtain the ‘Stop Eta Date’ and ‘Stop Eta At Date’ values for each trip.
The process will firstly calculate the next stop for each trip by retrieving the highest stop number that does not have Actual times recorded against it. This stop record will then be retrieved and the value of the ‘Stop Eta Date’ and ‘Stop Eta At Date’ will be returned.
Trip Overview View
The v_trip_overview view will be altered to include the ‘Stop Eta Date’ and ‘Stop Eta At Date’ values for each trip by calling the procedure outlined in the previous section.
Trip Overview Order View
The v_trip_overview_ord view will be altered to include the ‘Stop Eta Date’ and ‘Stop Eta At Date’ values for each order on each trip. This will be achieved by accessing the trip stop records for ‘Unload’ activities instead of ‘Load’.
If the ‘Actual Time’ of the stop record is populated, then the ‘Stop Eta Date’ and ‘Stop Eta At Date’ fields will be returned as blank since the order has already been delivered. Otherwise the ‘Stop Eta Date’ and ‘Stop Eta At Date’ fields will be returned from the stop record obtained.
Trip Overview (Waterfall) Screen
The ‘Trip Overview’ screen will be altered to allow the option of the new ‘Stop ETA’ and ‘Stop Eta At’ columns to be displayed. The new columns will become available as part of the list of columns that can be added to the blocks for display.
For the blocks that do not list order level details, the current list is shown below:
For the order level blocks the current list is as follows:
The ‘Stop Eta’ and ‘Stop Eta At’ columns will be colour coded in similar fashion to the existing ‘Start Time’ field. The system parameters 'TRM_OVERVIEW_AMBER_TIME' and 'TRM_OVERVIEW_RED_TIME' will be used to determine at what point the field colour is changed to amber or red. The difference between the ‘Stop Eta’ time and the expected arrival time will compared with the two parameters in similar fashion to the existing CALCULATE_FINISH_TIME procedure. Note that the field colour will be left grey if the ‘Stop Eta’ time field is blank.
Trip Manipulation Screen
The ‘Trip Manipulation’ screen will also be altered to allow the option of the new ‘Stop ETA’ and ‘Stop Eta At’ columns within the ‘Stops’ canvas. If the user chooses the ‘Configure Layout’ option, the columns will be listed as options to be displayed. The user will be able to sort the records by the ‘Stop ETA’ value entered.
A new system parameter ‘ALLOW_ETA_UPDATES’ will be created. If this is defined against the user and set to ‘Yes’, then the user will be able to update the ‘Stop ETA’ value manually. This will cause the ‘Stop Eta At’ to be set to the current system date and time.
Trip Execution Screen
The ‘Trip Execution’ screen will be altered in a similar fashion to the ‘Trip Manipulation’ screen. The ‘Stop ETA’ and ‘Stop Eta At’ columns will be added to the list when the user chooses the ‘Configure Layout’ option in the right-hand cluster. The user will be able to sort the records by the ‘Stop ETA’ value entered. As with the Trip Manipulation screen, the user will be adjust the ‘Stop ETA’ column if the ‘ALLOW_ETA_UPDATES’ system parameter is set to ‘Y’.
Table Updates Required
--
-- Script History
-- Name: AT_SCH_TRIP_STOP_292352.sql
-- Author: Roger Egdell
-- Desc: Add to SCH_TRIP
-- Task: 292352
-- Date: 13th Oct 2011
--
-- START PVCS Stub - DO NOT CHANGE THE FOLLOWING LINES
--
-- $Revision: 5.1 $
-- $Date: 2011/10/10 10:01:30 $
-- $Author: rxe $
--
--
-- END PVCS Stub.
--
--
PROMPT AT_SCH_TRIP_STOP_292352.sql
-- SET FEEDBACK OFF
--
-- Alter table
ALTER TABLE SCH_TRIP_STOP ADD(STOP_ETA_DATE DATE, STOP_ETA_AT_DATE DATE);
-- -- SET FEEDBACK ON PROMPT 2 - END AT_SCH_TRIP_STOP_292352.sql PROMPT -- SET FEEDBACK OFF
Modules to Changes
| Module Name | Module Type | Notes |
| TRIP_OVERVIEW.sql | Package | Trip Overview |
| V_TRIP_OVERVIEW.sql | View | Trip Overview trip level View |
| V_TRIP_OVERVIEW_ORD.sql | View | Trip Overview order level View |
| TRIP_OVERVIEW.fmb | Form | Trip Overview screen |
| TRIPSUM.fmb | Trip Manipulation | Trip Manipulation screen |
| TRIP_PLAN.fmb | Trip Planning | Trip Planning |
| EXECUTION.fmb | Execution | Execution screen |
References
| EST-292352 PM-8LZMK3 Upload ETA from Microlise into C-TMS v1.0.doc | |||
Glossary
| C-TMS | Calidus TMS |
Document History
| Initial version | ||||
| Reviewed | ||||
| Changed in response to Internal review | ||||
| Reviewed and Issued |
AUTHORISED BY
| Matt Crisford | Development Manager | |
| Peter Greer | TMSCC MTS Product Manager |
