View source for FS 315750 PROD Load Start Metrics

<div class="noprint">
{{#vardefine:Client|PROD}}
{{#vardefine:ClientName|PROD}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Load Start Metrics}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|25th February 2014}}
{{#vardefine:Reference|315750}}
{{#vardefine:Year|2014}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=FS {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}} 

<!-- TOC --> 
<div class="noprint">
= Functional Overview  =
== Client Requirement  ==
Currently, 'stop' debrief from {{#var:System}} is not possible for C-TMS where a trip has stops with no orders (e.g. start-up (SU) stop or closedown (CL) stop where no order activity occurs).  Trips are therefore not set to COMPLETED status.

== Solution Overview ==
A message needs to be triggered from {{#var:System}} to cover the debrief of the stop times for start-up (SU) and/or closedown (CL) stops.  C-TMS needs to handle these new messages and update the stop times on the appropriate trip stops.

A new trigger point is required in {{#var:System}} to generate the {{#var:System}}_EXPORT_LOAD message exactly as above but as soon as possible after the the start ODO is captured:

This will be utilised to send the stop level debrief actual times for the SU stop and also the start ODO value.  

Analysis is required to find a logical point where this can be triggered, ensuring that it is only sent once at the start.

When the load is downloaded to the device for the first time the device date and time are stored in the following fields:
*	EPL_LOAD_START_ACTUAL_DATE
*	EPL_LOAD_START_ACTUAL_TIME

The ODO reading is also stored in the following field:
*	EPL_MILEAGE_START


== Scope ==
* This functionality will be developed in the latest version of {{#var:System}} only.
* This functionality will be developed in the Android application only and will not be available in the Windows Mobile application.
* ''CALIDUS'' TMS functionality is mentioned only by reference in this solution - see [[#Appendix_A:_Quote_.26_Document_References|Appendix A]] for a link to the specification of the changes.
* Note that the changes to ensure that Load is updated on {{#var:System}} after the Load Metrics entry at the start of the load have already been completed in the latest version of the Android application, so no further modifications are required to that system.


<!-- NEW PAGE --> 
= Set-up  =

== Pre-requisites  ==
* A working {{#var:System}} system.


== Menu Structure  ==
None


== Data  ==
Modify or create an EPOD_XF_CONFIG record for EPL_XF_ID "LOAD" and ensure this has an EPL_XF_MSG_TYPE set to "BOTH". Assign this to a Site.


<!-- NEW PAGE --> 
= Functional Description  =
== Admin Changes ==
Add the following new fields to the XF Config Maintenance screen XF_Config.aspx:
*     EPL_XF_MSG_TYPE - A text field with allowed text values as follows:
**    "START"  - When Load Started
**    "END" - When Load Completed - default value
**    "BOTH" - When Load Started and Completed
This should be enabled for entry for export ID "LOAD" only. Note that the existing blank field value should default to "END".


== Import/Export Changes ==
The current functionality to send LOAD_UPDATE messages (EPL_XF_ID = "LOAD") will be extended. The existing field EPL_XF_MSG_TYPE (referred to as EPL_XF_MSG_TYPES in other specifications) will be extended to define whether the process is sending messages at the start of a load (value "START"), end of a load (values "END" or blank) or both (value "BOTH").

This will be achieved by changing the existing database procedure EPOD_XFER_SELECT_LOAD to:
* Optionally link to the EPOD_XF_CONFIG of the Load's EPL_SITE_ID.
* Select records based on the value of EPOD_XF_CONFIG.EPL_XF_MSG_TYPE, as follows:
** "START" - EPL_STATUS = "I" AND EPL_XFER_FLAG = "" AND (EPL_MILEAGE_START <> 0 OR EPL_UDF_LOAD_START <> "")
** "END" or "" (blank) - (EPL_STATUS = "X" OR EPL_STATUS = "C") AND (EPL_XFER_FLAG = "" OR EPL_XFER_FLAG = "P")
** "BOTH" - The two above combined i.e. (EPL_STATUS = "I" AND EPL_XFER_FLAG = "" AND (EPL_MILEAGE_START <> 0 OR EPL_UDF_LOAD_START <> "") ) OR ( (EPL_STATUS = "X" OR EPL_STATUS = "C") AND (EPL_XFER_FLAG = "" OR EPL_XFER_FLAG = "P") )

{{Note}} The existing load creation DAL and database definition or EPOD_LOAD and the database procedure EPOD_LOAD_INSERT must be checked to ensure that new loads are created with a blank value in EPL_XFER_FLAG.


The existing .NET procedure EPOD_SYS_EXPORT.ExportAllOutstandingLoads will take the returned records and interface them as per the settings. Note that any without a valid EPOD_XF_CONFIG against the site will be set as transferred (value "Y"). This procedure will be modified to check the value of EPL_XFER_FLAG before it is changed, as follows:
* "" (Blank) - Set to "N".
* "N" or "P" - Set to "Y".


The actual export XML sent for load updates need not be changed, as it already contains all the details required by external systems to update correctly.

<!--
 MEDIA LANDSCAPE YES
= Appendix A: TEST PLAN  =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Test the ...
|MenuAccess=None
|Prerequisites=None
|Objective=To test that: ...
}} 
{{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Test Title
|Notes=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Do something
|Result=Some expected results
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 

MEDIA LANDSCAPE NO
--> 
<!-- NEW PAGE --> 
{{Doc_Appendix
|Appendix=A
|Estimate=Y
|Glossary={{#var:System}}
|Ref1=FS-311976 CTMS-ePOD Start End Stop Debrief
|RefV1=1.0
|RefDate1=
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=1.5
|ST=0.25
|IMP=0.25
|EREQ=0
|EEST=0
|EFS=0
|ETS=0
|EDEV=0
|ESTT=0
|EIMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=Y
|Rev1=Matt Tipping
|Rev1Title=Project Manager
|Rev2Title=Client Representative
}}</div> 
[[Category:{{#var:Client}} FS]]