285961

From CTMS
Revision as of 16:13, 17 February 2012 by DuttonT (talk | contribs) (New page: {{Doc_Title|System=FUNCTIONAL SPECIFICATION|Title=Action Late Reason Codes Received from LOTS|Reference=FS 285961 JB-8DWU9B |Version=1.0|Date=13/04/2012|Sysver=10.6|Client=DHL C-TMS}} ...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Aptean Logo.png







DHL C-TMS

Action Late Reason Codes Received from LOTS


FUNCTIONAL SPECIFICATION - 10.6

13/04/2012 - 1.0
Reference: FS 285961 JB-8DWU9B















































Client Requirement

Change Request Summary:


Action late reason codes received in message from LOTS.


Change Request Details:


1. Late reason codes will only be sent upon delivery confirmation and will be parameterised (on/off) on LOTS.2. Please provide relevant functionality to make the necessary debrief screen updates using the message provided.3. ESI will be required to map the LOTS (maximum 3 digit code) to the longer C-TMS code.


Benefits identified as a result of the change:


Users can manage late reason codes in one system and provide visibility to customers.


Solution

A change will be made to allow the stop reason codes to be extracted from the XML flow from LOTS. This will require the appropriate new XML tags to be assessed for the late reason codes provided for the trip stops.

The late reason codes in C-TMS may be up to 12 characters in length and any new codes required by LOTS will need to be setup.

The valid late reason codes at the trip stop will be applied only to the late orders at the stop. The late orders will be obtained using the same logic present in the ‘Trip Debrief’ screen when the ‘Add Time Reason(s)’ button is pressed.


Scope

This change will be applied to system version 10.6

Set-up

Pre-requisites

As mentioned in the CLIENT REQUEST, ESI will be required to map the LOTS reason codes to the C-TMS reason codes


Menu Structure

‘Unchanged’


Data

An new reason codes required for LOTS will be loaded into the SCH_LATE_REASON table. The data will be provided by the Business users.


Functional Description

The existing procedure for processing LOTS inbound data will be amended to accept and process Stop Reason Codes. To allow the data to be processed, a new interface table will be created to store the stop reason records INT_XML_STOP_REASONS


INT_XML_SEQ

FILE_NAME

EXTERNAL_SYSTEM

EVENT_DATE

RECORD_STATUS

TRIP_ID

STOP_SEQ

RC_TYPE

RC_CODE

RC_DESCRIPTION

RC_COMMENT

VALIDATION_ERROR

CREATED_BY

CREATED_DATE


Within the existing stop processing, further code will be added to process any stop reason records at each stop.

Validation of the stop reason data will be carried out , firstly to check that the reason code exists on C-TMS and secondly to check for null values and duplicate records. The reason code will be compared with the data in the C-TMS table SCH_LATE_REASONS. If the reason code does not exist in this table, an error will be written and stored. If the reason code already exists against the stop, an error will written and stored.

Any null reason codes will create and store an error. After validation, the reason record will be inserted into the interface table. If there are no errors, the record will be inserted with a record_status ‘NEW’.

If there are errors, the record will be created with a status FAIL and the error will be written to the validation_error field. In addition, the stop interface record in INT_XML_TRIP_STOP will be updated. The VALIDATION_ERROR field will be populated with the message ‘There was a problem with a reason code at this stop’ This will be available to view in the Interface Errors screen on the XML_TRIPS tab.


[[Image:]]

The XML_TRIPS screen will be amended to display the records from the INT_XML_STOP_REASON table. The screen will be amended to display the information as header and details records, following the format of the XML_ORDER tab, which displays order and line information.


[[Image:]]


The block outlined above, will store the stop reason records on the XML_TRIPS tab.

In the STOP_REASON data-block, the validation error field will record if the reason code did not exist on C-TMS.

After the data processing has completed, the ‘NEW’ records in INT_XML_STOP_REASON will be processed. To process the records, all orders on the stop will be identified. If the order is identified as late (using the code currently run in the debrief screen when the ‘ADD TIME REASON ‘BUTTON is pressed.


[[Image:]]


If an order is identified as being late, the stop reason record will be added to the SCH_ORD_LATE_REASON table.


Field Name Value
SCHED_NAME Derived from the stop
OMS_REF Derived from the stop
TRIP_ID INT_XML_STOP_REASONS.TRIP_ID
LATE_CODE INT_XML_STOP_REASONS.RC_CODE
COMMENTS INT_XML_STOP_REASONS.RC_COMMENT


A check will be run against the TRIP_ID, OMS_REF and LATE_CODE. If a record already exists on the table, the record_status in the INTERFACE table (INT_XML_STOP_REASON) will be set to ‘FAIL’ and ‘Duplicate reason record’ will be written to the validation_error field.


If the record is successfully inserted in SCH_ORD_LATE_REASON, the record status will be updated to ‘SUCESS’.


Table Updates Required


CREATE NEW TABLE INT_XML_STOP_REASON


INT_XML_SEQ

FILE_NAME

EXTERNAL_SYSTEM

EVENT_DATE

RECORD_STATUS

TRIP_ID

STOP_SEQ

RC_TYPE

RC_CODE

RC_DESCRIPTION

RC_COMMENT

VALIDATION_ERROR

CREATED_BY

CREATED_DATE


|}


References


Ref No
Document Title & ID
Version
Date
EST-285961 JB-8DWU9B Action Late Reason Codes Received from LOTS v1.0
1.0
18/02/11


Glossary


Term or Acronym
Meaning


Document History {Update date and Initial on completion – then delete this line of info}


Version
Date
Status
Reason
Initials
0.1
29/03/11
Draft
Initial version
SW
1.0
13/04/11
Issue
Reviewed and Issued
MJC


AUTHORISED BY

Matt Crisford Development Manager
Peter Greer TMSCC MTS Product Manager