287838
DHL CTMS
Mapping, Implementation & UAT Support of Paragon Flow
FUNCTIONAL SPECIFICATION - 10.6
- 0.1
Reference: 287838 TH-8FVJN2
Client Requirement
Change Request Summary:
Mapping, implementation and UAT support of the Paragon flow. Define standard format of data exchange in both flows out and in.
Change Request Details:
Mapping, implementation and UAT support of the Paragon flow. Define standard format of data exchange in both flows out and in. Based on SDD issued 8th April 2011.
Benefits identified as a result of the change:
Migration component.
Solution
OBS will configure the C-TMS Paragon Interface (Inbound and Outbound) to conform to the BAT format.
The standard Paragon CSV interface will be used as available in the Paragon Interface screen (PAR_INT v10.12 or later). This standard functionality will allow the creation of a CSV formatted files outbound and action the upload of a specifically formatted CSV file inbound. These files can be transferred to or from an individual PC and will be contain or upload data into the CTMS database.
C-TMS development changes have been identified for the ‘Reset New’ functionality. This occurs in two places:
- ‘Reset New’ button
- Active prompt after completion of a Paragon Trip inbound file upload
N.B. The system currently will reset ALL orders at status new and does not take account of segregation of multiple customers. This RIO will not cover this development and a new RIO will be raised separately. This will be required before the deployment of the second customer that requires use of the Paragon Interface.
Outbound Parameters:
The Paragon Interface screen allows, via manual control, the creation of a CSV file containing C-TMS Order data ready for upload in to the Paragon application. There are a series of parameters that will be available to constrain the Order selections that are included in the output.
This file has a fixed format, controlled by the system parameter ‘PARAGON_INSTALLED’. OBS will set this to use the ‘BAT’ format.
Inbound Parameters:
The Paragon Interface screen allows, via manual control, the upload of a CSV file containing Paragon Trip data.
This file can have a dynamic format but must match that configured in the Imports Maintenance screen (IMPORTS_MAINT v1.13 or higher) with a format name of ‘Paragon Trip Detail’. OBS will configure this format to match the BAT Paragon Trip format.
Workshop:
In addition to the setup detailed above, an OBS analyst will attend workshops (Webex) as required to analyse the data required by Paragon and the layout/format to be provided by C-TMS with indication of the appropriate fields within the C-TMS Paragon Order CSV file that will be provided. The information required by C-TMS for the upload of the Paragon Trip CSV file will also be covered. Advice will be provided on standard C-TMS configuration options for the Paragon interface to enable the setup of the Paragon application by Paragon.
Considerations/Assumptions:
This will be applied to both the C-TMS Industrial test application INPF (INDTST) and the live application INLV (INDPRD).
An element of implementation and testing time is included in this estimate to provide assistance, on request, during the initial testing phases as new Paragon Order files are sent and new Paragon Trip files are received.
N.B. It is understood from the requirements that no C-TMS development changes are required under this RIO. As such it is suggested that a Functional Specification will not be required.
As this work entails setup/configuration only, an ‘Implementation Specification’ document will be provided in place of a ‘Functional Specification’. This will document the setup changes applied and basic instruction on operation of the Paragon interface.
In order for OBS to correctly resource the test and production server capacity for the inbound files to be received, an indication of average daily (weekday & weekend) file volumes to be sent to C-TMS are required.
N.B. This estimate does not cover further application development. In the event of scope change identified as a result of the Paragon Interface testing additional development RIOs will be required.
In the event of further implementation advice/assistance required as a result of Paragon interface testing, beyond the time covered in this estimate, a further RIO would be required to cover this additional work. OBS will advise once the time estimated on this RIO has been fully utilised.
Scope
This change will be applied to system version 10.6.0 on INDTST and once approved INDPRD.
Set-up
Pre-requisites
None
Menu Structure
‘Unchanged’
Data
The system parameters will be setup as described in section 3.1.
IMPLEMENTATION Description
Outbound Parameters
System parameters will control which version of the Paragon order export flow will be operational:
| System Parameter | Expected Value |
| PARAGON_RUNNING | Y |
| PAR_SLOT_CUTOFF_TIME | 60 |
| PAR_TRIP_STATUS | PLANNED |
| PARAGON_INSTALLED | BAT |
- ‘PARAGON_RUNNING’ should be set to ‘Y’ to indicate that the Paragon interface is operational.
- ‘PAR_SLOT_CUTOFF_TIME’ indicates the number of minutes before the slot window start time that it closes to new orders.
- ‘PAR_TRIP_STATUS’ indicates the status of any trips that are created via the ‘Paragon Interface’.
- ‘PARAGON_INSTALLED’ should be set to ‘BAT’ to indicate that the ‘BAT’ file format will be operational for the export of orders.
N.B. ‘PARAGON_INSTALLED’ is currently set to ‘DUN’ in the ‘INDPRD’ database so a change will be required to store the system parameter as ‘BAT’ with configuration at the cost-centre level (i.e. ‘STL’) so that a specific file format may be used per customer.
‘Config By’ will be ‘COST_CENTRE’ and ‘Config By Value’ will be ‘STL’.
The existing configuration in ‘INDPRD’ may be retained as a default (i.e. ‘Config By’ as ‘SYSTEM’, ‘Config By Value’ as ‘NONE’ and ‘Value’ as ‘DUN’).
The ‘Reset New’ button updates the status of orders for the schedule from ‘NEW’ to ‘UNSCHEDULED’ if the system parameter ‘PARAGON_INSTALLED’ is ‘BAT’.
The ‘Export’ button produces the ‘Orders to Paragon’ report if the system parameter ‘PARAGON_INSTALLED’ is not ‘HCR’ or ‘XML’.
The process then runs ‘CSV.ORDERS_TO_PARAGON’ for the 6 parameters set in the ‘Order Export’ tab page of the screen. The function ‘CSV.WRITE_ORDERS_TO_PARAGON’ then
The output path is taken from the system parameter ‘MTS_CSV_EXPORT_PATH’ or ‘MTS_EXPORT_PATH’.
Decoded values for ‘PARAGON_LOCATIONS’ and ‘PARAGON_TRAILERS’ may also be setup as required:
The ‘BAT’ file format is described below:
| Field | Field Name | Size and Format | Paragon Keyword |
| 1 | Location ID | Alphanumeric (Max 16) | CUST.ID |
| 2 | Name | Alphanumeric | CUST.NAME |
| 3 | Street Address | Alphanumeric (lines of the address separated by commas) | CUST.LONGADDR |
| 4 | Town | Alphanumeric | CUST.SHORTADDR |
| 5 | Post Code | Alphanumeric | CUST.POSTCODE |
| 6 | Latitude | Numeric, positive or negative relating to north/south | CUST.LAT |
| 7 | Longitude | Numeric, positive or negative relating to east/west | CUST.LONG |
| 8 | Vehicle Acceptability | Alphanumeric in a binary format, where 1 is acceptable, and 0 is unacceptable (e.g. ‘10011’). Alternatively you can use Y/N.
{Each of the vehicle types needs to be mapped to a byte position on this string} |
CUST.TEXT01 |
| 9 | Run Key | Alphanumeric | CALL.TEXT01 |
| 10 | Location ID | Alphanumeric (16), same as the customer ID above | CALL.ID |
| 11 | Weight in Kg | Integer | CALL.MEASURE1 |
| 12 | Volume in cm3 | Integer | CALL.MEASURE2 |
| 13 | Depot ID | Alphanumeric (Max 16)
{Means the depot to delivery from or collect into} |
CALL.DEPOTID |
| 14 | Earliest Delivery Date and Time | YYYYMMDD HH24:MI | CALL.TEXT02 |
| 15 | Latest Delivery Date and Time | YYYYMMDD HH24:MI | CALL.TEXT03 |
| 16 | Variable Unloading Time | Integer (minutes) | CALL.USER01 |
| 17 | Fixed Unloading Time | Integer (minutes) | CALL.USER02 |
| 18 | Order Type (Delivery or Collection) | Alphanumeric (1), D=delivery, C=Collection | CALL.TYPE |
| 19 | C-TMS Order Reference | Numeric | CALL.USER03 |
| 20 | Customer Order Reference Number | Alphanumeric | CALL.TEXT04 |
| 21 | Product Type (Chilled or Ambient) | Alphanumeric | CALL.TEXT05 |
| 22 | Delivery Type, Carrier Type | Alphanumeric | CALL.TEXT06 |
| 23 | Special Instruction | Alphanumeric | CALL.TEXT08 |
| 24 | Phone Number | Alphanumeric | CALL.TEXT09 |
| 25 | Alphanumeric | CALL.TEXT10 | |
| 26 | Delivery Unit Type | Alphanumeric | CALL.TEXT12 |
| 27 | Quantity | Numeric | CALL.USER12 |
| 28 | Delivery Unit Type | Alphanumeric | CALL.TEXT13 |
| 29 | Quantity | Numeric | CALL.USER13 |
| 30 | Delivery Unit Type | Alphanumeric | CALL.TEXT14 |
| 31 | Quantity | Numeric | CALL.USER14 |
| 32 | Delivery Unit Type | Alphanumeric | CALL.TEXT15 |
| 33 | Quantity | Numeric | CALL.USER15 |
| 34 | Delivery Unit Type | Alphanumeric | CALL.TEXT16 |
| 35 | Quantity | Numeric | CALL.USER16 |
Inbound Parameters
System parameters will control from where the Paragon trip import files may be uploaded:
| System Parameter | Expected Value |
| MTS_FILE_UPLOAD_URL | ./launcher.html |
| MTS_IMPORT_PATH | TBC |
| MTS_LOG_DIR | TBC |
| PARAGON_INSTALLED | BAT |
- ‘MTS_FILE_UPLOAD_URL’ indicates the URL for launching the MTS file upload process.
- ‘MTS_IMPORT_PATH’ indicates where the import files will be located.
- ‘MTS_LOG_DIR’ indicates where the log files for the import files will be located.
- ‘PARAGON_INSTALLED’ should be set to ‘BAT’ to indicate that the ‘BAT’ file format will be operational for the trip import.
A file to upload may be found using the ‘Browse’ button and uploaded using the ‘Import’ button.
For example:
run-tmstst: # cat /webint/indtst/import/processed/STLOBSEUpload0028.CSV.20110616_15:17:59
305,1,1,1,7682,"271528","STL VAN 3M","17311","STLWAKE","STL WAKE","20110617 09:02","20110617 09:13","20110617 07:30","20110617 07:30","20110617 08:00","20110617 17:51","20110617 19:31","20110617 19:31","00:00","00:00","00:00"
The existing ‘Paragon Trip Detail’ format in ‘INDPRD’ is displayed below:
The expected field sequence is displayed below:
| Field | Field Name | Size and Format |
| 1 | Paragon Route Number | Numeric |
| 2 | Paragon Trip Number | Numeric |
| 3 | Paragon Drop Number | Numeric |
| 4 | Paragon Trip Position | Numeric |
| 5 | C-TMS Order Reference | Numeric |
| 6 | Customer Order Reference | Alphanumeric |
| 7 | Vehicle Type | Alphanumeric |
| 8 | Location ID | Alphanumeric |
| 9 | Depot Code (Call.DepotName) | Alphanumeric |
| 10 | Vehicle Group Name (Carrier) | Alphanumeric |
| 11 | Arrival at Call | YYYYMMDD HH24:MI |
| 12 | Departure from Call | YYYYMMDD HH24:MI |
| 13 | Route Start Time | HH24:MI |
| 14 | Trip Start Time | HH24:MI |
| 15 | Departure from Depot | HH24:MI |
| 16 | Return time to Depot | HH24:MI |
| 17 | Trip End Time | HH24:MI |
| 18 | Route End Time | HH24:MI |
| 19 | Total Break Duration from Previous Call | minutes |
| 20 | Total Break Duration at this Call | minutes |
| 21 | Total Break Duration until next Call | minutes |
Each field type will be extracted from the file and validated and stored on the ‘PAR_TRIP_DTL’ table to later update the orders and trips planned.
Once a file has been uploaded the status of the order will be updated from ‘NEW’ to ‘UNSCHEDULED’.
References
| EST-287838 TH-8FVJN2 Map, Impl & UAT Support of Paragon Flow v1.0.doc | |||
| FS-285937 PL-8DWKXF BAT C-TMS Paragon Integration v1.0.doc | |||
Glossary
| C-TMS | Calidus TMS |
| CSV | Comma Separated Values |
Document History
| Initial version | ||||
AUTHORISED BY
| Matt Crisford | Development Manager | |
| Peter Greer | TMSCC MTS Product Manager |
