Test: Difference between revisions

From Calidus HUB
m (Testing...)
No edit summary
Line 1: Line 1:
<div class="noprint">
= FS 317761 SCR15 NHSBT C-EPOD Collection Changes =
{{#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|XXXXXX}}
{{#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 -->
The interface of jobs through to C-EPOD will include the following details and changes:
<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 ==
*    EPL_UDF_JOBDETS to be populated with PACKAGING, GEL and DRY ICE counts, in UDF format, on collections. Format example:
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:
<FORM NAME="Job Details" REQUIRED="Y">
  <FIELD ID="DU1_COUNT">
    <TEXT>No. of DU1: X</TEXT>
    <FORMAT>L</FORMAT>
  </FIELD>
  <FIELD ID="DU2_COUNT">
    <TEXT>No. of DU2: X</TEXT>
    <FORMAT>L</FORMAT>
  </FIELD>
</FORM>


This will be utilised to send the stop level debrief actual times for the SU stop and also the start ODO value.
*    EPL_LINKED_ID will be passed through against each EPOD_JOB record to identify consolidated collections and deliveries
*    New fields EPL_VALID_DATE and EPL_VALID_TIME will be passed through for box-level validation, against each EPOD_CONTAINER record.
*    New field EPL_LOADING_TYPE will be passed through against each EPOD_JOB record to indicate whether this is the loading or unloading job.
*    New Asset Type information will be passed though on the EPOD_REASON_CODES stream, with EPL_REASON_TYPE = "DU".
*    It is expected that customer contact numbers will not be passed through to C-EPOD.
*    It is expected that any additional information regarding Items (containers) to be delivered not covered above will be sent through in item EPL_CODE_1.  


Analysis is required to find a logical point where this can be triggered, ensuring that it is only sent once at the start.
The interface of jobs back into C-TMS from C-EPOD will include the following changes:


When the load is downloaded to the device for the first time the device date and time are stored in the following fields:
*    Create jobs for unplanned Ad Hoc Collections and their return to depot.
* EPL_LOAD_START_ACTUAL_DATE
*   Ignore any other additional depot return jobs that are included
* EPL_LOAD_START_ACTUAL_TIME
*   Create empty assets on orders for Ad Hoc collect items against planned collections.


The ODO reading is also stored in the following field:
All changes regarding the EPOD interface will be completed under reference 317907/SCR01.
* EPL_MILEAGE_START




== Scope ==
= FS 318050 SCR20 NHSBT C-EPOD Vehicle Defect - Prevent Use =
* 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.


The interface of jobs through to C-EPOD will include the following details and changes:


<!-- NEW PAGE -->
*    The interface will include details of the availability of vehicles, through the existing C-EPOD EPOD_IMPORT tag EPOD_VEHICLES. It is assumed that the availability of vehicles will be based on the Status field against the vehicle record in CTMS, expected to be values:
= Set-up  =
**        Y/A - Available
**        N/U - Unavailable
**        X - Deleted/Invalid for this depot.


== Pre-requisites  ==
All changes regarding the EPOD interface will be completed under reference 317907/SCR01.  
* A working {{#var:System}} system.




== Menu Structure  ==
= FS 318084 SCR17 NHSBT C-EPOD Swap Van =
None


The interface of jobs through to C-EPOD will include the following details and changes:


== Data  ==
*    The interface will include details of the availability of vehicles, through the existing C-EPOD EPOD_IMPORT tag EPOD_VEHICLES. These changes regarding the EPOD interface will be completed under reference 317907/SCR01.
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 DDL field with allowed text values as follows:
**    "START"  - description "When Load Started"
**    "END" - description "When Load Completed" (default value)
**    "BOTH" - description "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 <> "") ) AND ( (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]]

Revision as of 10:30, 27 June 2014

FS 317761 SCR15 NHSBT C-EPOD Collection Changes

The interface of jobs through to C-EPOD will include the following details and changes:

  • EPL_UDF_JOBDETS to be populated with PACKAGING, GEL and DRY ICE counts, in UDF format, on collections. Format example:
<FORM NAME="Job Details" REQUIRED="Y">
 <FIELD ID="DU1_COUNT">
    <TEXT>No. of DU1: X</TEXT>
    <FORMAT>L</FORMAT>
 </FIELD>
 <FIELD ID="DU2_COUNT">
    <TEXT>No. of DU2: X</TEXT>
    <FORMAT>L</FORMAT>
 </FIELD>
</FORM>
  • EPL_LINKED_ID will be passed through against each EPOD_JOB record to identify consolidated collections and deliveries
  • New fields EPL_VALID_DATE and EPL_VALID_TIME will be passed through for box-level validation, against each EPOD_CONTAINER record.
  • New field EPL_LOADING_TYPE will be passed through against each EPOD_JOB record to indicate whether this is the loading or unloading job.
  • New Asset Type information will be passed though on the EPOD_REASON_CODES stream, with EPL_REASON_TYPE = "DU".
  • It is expected that customer contact numbers will not be passed through to C-EPOD.
  • It is expected that any additional information regarding Items (containers) to be delivered not covered above will be sent through in item EPL_CODE_1.

The interface of jobs back into C-TMS from C-EPOD will include the following changes:

  • Create jobs for unplanned Ad Hoc Collections and their return to depot.
  • Ignore any other additional depot return jobs that are included
  • Create empty assets on orders for Ad Hoc collect items against planned collections.

All changes regarding the EPOD interface will be completed under reference 317907/SCR01.


FS 318050 SCR20 NHSBT C-EPOD Vehicle Defect - Prevent Use

The interface of jobs through to C-EPOD will include the following details and changes:

  • The interface will include details of the availability of vehicles, through the existing C-EPOD EPOD_IMPORT tag EPOD_VEHICLES. It is assumed that the availability of vehicles will be based on the Status field against the vehicle record in CTMS, expected to be values:
    • Y/A - Available
    • N/U - Unavailable
    • X - Deleted/Invalid for this depot.

All changes regarding the EPOD interface will be completed under reference 317907/SCR01.


FS 318084 SCR17 NHSBT C-EPOD Swap Van

The interface of jobs through to C-EPOD will include the following details and changes:

  • The interface will include details of the availability of vehicles, through the existing C-EPOD EPOD_IMPORT tag EPOD_VEHICLES. These changes regarding the EPOD interface will be completed under reference 317907/SCR01.