View source for FS 371933 6287 EBB CTL Operational Documents

<div class="noprint">
{{#vardefine:Client|EBB}}
{{#vardefine:ClientName|EBB Paper}}
{{#vardefine:System|''CALIDUS'' TL TMS}}
{{#vardefine:SystemCode|CTLTMS}}
{{#vardefine:Doc_Title|Operational Documents}}
{{#vardefine:Version|3.0}}
{{#vardefine:Date|21st May 2020}}
{{#vardefine:Reference|371933 6287}}
{{#vardefine:Year|2020}}
{{ #vardefine: Figure | 0 }}{{ #vardefine: Example | 0 }}
<!--
Sample Xref:
{{Xref
||Type=Figure
||Num={{ #vardefineecho: Figure| {{ #expr: {{ #var: Figure}} + 1 }} }}
||Text=Data Upload - Import screen.}}
-->
</div>
{{Doc_TitleNew
|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  ==
This change refers to SCR 3 in the Solution Design document.

The customer requires their existing reports to be produced out of CTL, consisting of:
* Driver Manifest.
* Delivery Notes.

This specification includes the definition of TFS work item 6288 - Driver manifest to include run sequence (SDD v1.0 SCR 4).


This change also refers to SCR 4 in the Solution Design document.

When the driver manifest report is run, stamp a run sequence against the trip/stop/order (used to be called SCH_HAULAGE_ACTIVITY). This can be related/generated from the date/time. Only stamp records when it has not already been stamped before.

This will be displayed on the Driver Manifest operational report. 


== Solution Overview  ==

The two operational reports will be created in CTL-TMS.
* EBB Delivery Note.
* EBB Driver Manifest.
* EBB Driver Manifest + Delivery Notes.


Further to the basic requirements of the formatting, data and layout of the existing report, the driver manifest will be modified to include a Run Sequence and date/time. Every time the reports are run, any orders that have already been included on the print will have been stamped with the run sequence, date and time - this will be displayed against the orders. Any new orders will not have a run sequence, date and time against them, so that the users can clearly see that these are newly-planned orders.


These reports will be set to be the default reports run by the system whenever the Driver Manifest or Delivery Note reports are run from the planning screen.


The Planning screen will be modified to allow the reports to be run from the More menu against a trip. When selected, these reports will be run to the screen as a PDF, ready for printing.


The reports will also be available to run from the standard reports screen when created.


== Scope  ==
This change will be applied to system version 1.00 on test database EBBCTST) and once approved EPPCPRD.


== Impact ==
This development is dependent on the following TFS work items being completed first:
* 6222 - Operational Reports (base).
* 6178 - Schedule Proposal.
* 6281 - Bespoke Import Interface.


<!-- NEW PAGE --> 
= CONFIGURATION SET-UP  =
== Pre-requisites  ==
<!-- Think about dependent functionality or configuration that is required to support this deliverable and describe here. -->


== Menu Structure  ==
<!-- Describe how the menu system will change to accommodate this requirement if relevant. -->


== Data  ==
Own Fleet Depot (RDC) Locations must be configured with an Alternate Name.


System parameters should be created and configured to set the variant of the following reports:
* Delivery Note - drop-down list of report names, defaulting to the standard Delivery Note format. Ensure that EBB Delivery Note is added to this list.
* Driver Manifest - drop-down list of report names, defaulting to the standard Driver Manifest format. Ensure that EBB Driver Manifest is added to this list.
* Loading sheet - drop-down list of report names, defaulting to the standard Delivery Note format.

This will identify which report to run from the Planning screen when the report option is selected.


== Implementation Advice ==
<!-- Include any relevant notes that will help OBSL or Client implementer to successfully enable the solution on delivery. -->


<!-- NEW PAGE --> 
= FUNCTIONAL DESCRIPTION =

The two operational reports will be created in CTL-TMS.
* EBB Delivery Note.
* EBB Driver Manifest.
* EBB Driver Manifest + Delivery Notes.


The customer has chosen to match the existing formats. These use pro-forma paper stock, as follows:

[[File:FS_371933_ProForma.png|border|600px]]

<!-- NEW PAGE --> 

The driver manifest format is as follows:

[[File:FS_371933_Driver_Manifest.png|border|600px]]

<!-- NEW PAGE --> 

The delivery note format is as follows:

[[File: FS_371933_Delivery_Note.png|border|600px]]


Further to the basic requirements of the formatting, data and layout of the existing report, the driver manifest will be modified to include a Run Sequence and date/time. Every time the reports are run, any orders that have already been included on the print will have been stamped with the run sequence, date and time - this will be displayed against the orders. Any new orders will not have a run sequence, date and time against them, so that the users can clearly see that these are newly-planned orders.

These reports will be set to be the default reports run by the system whenever the Driver Manifest or Delivery Note reports are run from the planning screen.


The Planning screen will be modified to allow the reports to be run from the More menu against a trip. When selected, these reports will be run to the screen as a PDF, ready for printing.


The reports will also be available to run from the standard reports screen when created.

The reports will request the following parameters:
* Owning Depot - defaulting value to the user's owning depot parameter. This will be a drop-down list of all own-fleet depot locations (RDCs) within the system. This is required entry.
* Schedule - This will allow text entry of a schedule or allow a lookup of any schedules that are created in the system. The schedule will default to the closest automatically created schedule to today's date. This schedule lookup will be the same as the standard schedule lookup being developed as part of TSF work item 6178 - Schedule Proposal. This is optional entry.
* Date/Time range - this will default to the dates and times calculated from the schedule selected above. This will allow date and time lookups. This is required entry and the total range should never exceed 7 days.
* Carrier Group - This will allow text entry of a carrier group, or allow a lookup of carrier groups. This is optional entry.
* Carrier - This will allow text entry of a carrier ID, or allow a lookup of carriers. Only carriers within the group selected (if any) may be entered. The lookup will provide a list of carriers limited to this group, if provided. This is an optional parameter.
* Trip - This will allow text entry of a trip ID, or allow a lookup of trips. This is optional entry. Only trips in the date/time range above will be shown on the lookup.


<!-- NEW PAGE --> 
= TECHNICAL NOTES =
== Database Changes ==
Table TRP_TRIP_HEADER:

A new field TTH_MANIFEST_PRINT_SEQ should be added. This should be an integer and defaulted to 0.


Table TRP_STOP_ACTIVITY

A new field TSA_MANIFEST_PRINT_CODE should be added. This should be a string, defaulting to blank.


== General Reports ==
Re: TFS stream 6337 - Reporting.

There are a number of standard operational reports that will available in the system, such as:
* Traffic Sheet
* Outstanding Debrief Report
* Exceptions Failures and Reasons Report
* Summary by Depot Report
* Operational Reports (base) 

The last one (TFS item 6222) specifies the following:

Specifically a process by which they can be:
* run with parameters
* exported to PDF
* emailed
* downloaded
* created with configurable formats

Specific reports required:
* Delivery Note
* Driver Manifest
* Driver Manifest plus Delivery notes
* Loading sheet

Therefore there must be a mechanism whereby these reports can be selected and run, entering parameters.

This new report will be added to the same report selection screen, labelled as "EBB Driver Manifest + Delivery notes".

The Driver Manifest and Delivery Note reports should be developed as two separate reports. 

Each report should be added as an option to the Reports menu:
* EBB Delivery Note
* EBB Driver Manifest
* EBB Driver Manifest + Delivery Notes


All reports will prompt for the following parameters:
* Owning Depot - defaulting value to the user's owning depot parameter. This should be a drop-down list of all own-fleet depot locations (RDCs) within the system. This is required entry.
* Schedule - This should allow text entry of a schedule or allow a lookup of any schedules that are created in the system. The schedule should default to the closest automatically created schedule to today's date. This schedule lookup should be the same as the standard schedule lookup being developed as part of TSF work item 6178 - Schedule Proposal. This is optional.
* Date/Time range - this should default to the dates and times calculated from the schedule selected above. This should allow date and time lookups. This is required and the total range should never exceed 7 days.
* Carrier Group - This should allow text entry of a carrier group, or allow a lookup of carrier groups. This is optional.
* Carrier - This should allow text entry of a carrier ID, or allow a lookup of carriers. Validation of this field is necessary - only carriers within the group selected (if any) may be entered. The lookup should provide a list of carriers limited to this group, if provided. This is an optional parameter.
* Trip - This should allow text entry of a trip ID, or allow a lookup of trips. This is as optional parameter. Only trips in the date/time range above should be shown on the lookup.

When run, the report should be produced as PDF and downloaded. 

{{Note}} For the "EBB Driver Manifest + Delivery Note" option, the two reports should be concatenated into a single PDF output.


This PDF should then be actioned as per the standard processing (i.e. PDF download, email, print, etc).


==  Planning Screen ==
A Reports should be added to the central More button against a trip selected in the Planning screen.

When selected, a list of the trip based reports should be shown. Initially, this should consist of:
* Driver Manifest.
* Delivery Note.
* Driver Manifest + Delivery Note.
* Loading/Unloading Sheet.

When the report is selected, the system should check the system parameters to see which report format to run.

The reports will be passed the parameters required, all sourced from the trip selected - importantly:
* Owning Depot.
* Trip ID.


No other information should be required to run the report selected and the report should be generated out as PDF to the browser in a separate tab.

{{Note}} When the process is run to print the report *but before it has been generated*, the print sequence against the trip and all trip stop activity must be set. 
* The trip run sequence (TRP_TRIP_HEADER.TSA_MANIFEST_PRINT_SEQ) should be incremented by 1. For example, on the first print of this trip, the trip sequence should be incremented from 0 to 1, on the second print, from 1 to 2, etc.
* Any orders on this trip stop without a defined run sequence should be stamped with the trip run sequence and the print time e.g. "3-1648". Any that already have a value in this field should *not* be updated. This is on table TRP_STOP_ACTIVITY, field TSA_MANIFEST_PRINT_CODE.


== Driver Manifest Report ==

Per trip in the selection criteria. Page numbering should reset per trip.

Criteria provided will be from the following:
* Owning Depot - required. Select only trips for this owning depot.
* Date/Time range - required. Select only trips that pass through this date/time range, based on planned date/time of the stops.
* Carrier Group - optional. If provided, select only trips assigned to carriers in this carrier group.
* Carrier - optional. If provided, select only trips assigned to this carrier. The previous selection may then be ignored.
* Trip ID - optional. If provided, select the trip by the trip ID - no other criteria is necessary.


=== Header ===

{{Note}} Includes printing the labels in the correct positions as well.

* "MANIFEST" - fixed text
* Printed At - Time of printing
* Printed By - CTMS user
* "**Reprint**" - only if the trip has been printed before. Can be derived from TTH_MANIFEST_PRINT_SEQ being blank. 
* '''Run Sequence''' - new field below "Printed By" - displaying the trip run sequence TTH_MANIFEST_PRINT_SEQ
* Additional Instructions - Trip instructions TTH_COMMENT.
* Vehicle - Assigned vehicle of Trip - TRP_TRIP_HEADER.TTH_VEHICLE_CODE.
* Driver - Assigned Driver of trip - RES_PERSON.RSP_CODE + " - " + RES_PERSON.RSP_FORENAME concatenated with RSP_SURNAME, delimited with " ".
* Trailer - Assigned Trailer of the trip stop TRP_LOAD_STOP.TLS_TRAILER_CODE. Note: this is subject to change of trailer swap planing, under change 371746 6616 - Plan Trailer Swaps (SDD v1.0 SCR 2).
* Collated By/Time - label only - for driver to fill in
* Checked By Driver - label only - for driver to fill in
* Checked By W/H - label only - for driver to fill in
* Loaded By - label only - for driver to fill in
* No. Pallets/Jobs - label only - for driver to fill in
* Date - Planned manifest date - TRP_TRIP_HEADER.TTH_COLLECT_DATETIME_FROM
* Branch - Starting Depot - the SU location of the trip on the first trip stop, TRP_STOP.TRS_LOCATION_CODE
* Delivery Date - Start Date - TRP_STOP.TRS_PLANNED_ARRIVE_DATETIME
* Start Time - Start time of trip - TRP_STOP.TRS_PLANNED_ARRIVE_DATETIME of the first stop.
* Load Number - Trip ID TRP_TRIP_HEADER.TTH_TRIP_REF


=== Details ===

One line per Stop/Order/Product (order line). Not that the order lines should be retrieved and displayed in sequence.

* First line: Cust Reference of order + from location alternate name + from location name plus COMMENT_ID
**   ORD_ORDER_HEADER.OOH_CUSTOMER_REF
**   GEO_LOCATION.GLO_ALTERNATE_NAME
**   GEO_LOCATION.GLO_NAME
**   order parameter "ORD_COMMID"
* Second line: Order parameter "Route"
* Third line: Quantity + TU + description + fixed text "Signed:___"
**   ORD_ORDER_LINE.OOL_QUANTITY
**   ORD_ORDER_LINE.OOL_DESCRIPTION
* Fourth line: Run Sequence + description 2 (BinBay + NS Flag) + fixed text "Print:___"
**   TRP_STOP_ACTIVITY.TSA_MANIFEST_PRINT_CODE
**   ORD_ORDER_LINE.OOL_DESCRIPTION2

Note: 
* '''Run Sequence''' This displays the trip run sequence code from the trip stop activity record for that order, for example "2-1648" from TSA_MANIFEST_PRINT_CODE.


=== Footer ===

Note: Including labels.

* T&Cs - fixed text.
* Total Wgt: calculated from ORD_ORDER_HEADER.OOH_WEIGHT.
* Page X of Y - calculated by the report.


== Delivery Note ==

Per delivered order on the selected trips. All orders on the trip should be produced in a single document, with page numbering as expected. Page numbering should reset per trip.

Criteria provided will be from the following:
* Owning Depot - required. Select only trips for this owning depot.
* Date/Time range - required. Select only trips that pass through this date/time range, based on planned date/time of the stops.
* Carrier Group - optional. If provided, select only trips assigned to carriers in this carrier group.
* Carrier - optional. If provided, select only trips assigned to this carrier. The previous selection may then be ignored.
* Trip ID - optional. If provided, select the trip by the trip ID - no other criteria is necessary.


=== Header === 

Note: Includes printing the labels in the correct positions as well.

* "Delivery Note"
* Invoice To - Customer address, from the customer of the order, from GEO_LOCATION.
* Delivery To - Location to address, from GEO_LOCATION.
* Delivery Instructions - order special instructions ORD_ORDER_HEADER.OOH_SPECIAL_INSTRUCTIONS
* DATE - Order creation date ORD_ORDER_HEADER.OOH_ORDER_PLACED_DATE.
* BRANCH - From location of the order, ORD_ORDER_HEADER.OOH_COLLECT_LOCATION_CODE
* DEL DATE - Planned delivery date. TRP_STOP.TRS_PLANNED_ARRIVE_DATETIME of the stop for that order.
* DELIVERY TIME - ORD_ORDER_HEADER.OOH_COLLECT_DATETIME_FROM
* S TIME - TRP_STOP.TRS_PLANNED_ARRIVE_DATETIME of the stop for that order.
* E TIME - TRP_STOP.TRS_PLANNED_DEPART_DATETIME of the stop for that order.
* DEL NOTE NO - ORD_ORDER_HEADER.OOH_CUSTOMER_REF


=== Details=== 

Sourced from order lines. Note that the order lines should be retrieved in sequence.

Note: Including labels.

* ORDER NO - new field against order line OOL_CUST_ORD_REF.
* QTY - ORD_ORDER_LINE.OOL_QUANTITY
* UNITS - RES_TRANSPORT_UNIT.RTU_DESCRIPTION linked from ORD_ORDER_LINE.OOL_TRANSPORT_UNIT_CODE
* QUALITY & DESCRIPTION - Order line description plus product type description 2 on the line following, and order line description 3 on the line following that.
**   ORD_ORDER_LINE.OOL_DESCRIPTION
**   PRD_PRODUCT_TYPE.PPT_DESCRIPTION2
**   ORD_ORDER_LINE.OOL_DESCRIPTION3
* PACKS - quantity divided by new field "quantity pack" ORD_ORDER_LINE.OOL_PACK_QUANTITY
* KGS - ORD_ORDER_LINE.OOL_WEIGHT.


=== Footer === 

Note: Including labels.

* "04" - Order parameter "Route"
* T&Cs - fixed text.
* Total Wgt - ORD_ORDER_HEADER.OOH_WEIGH
* Page X of Y - calculated by the report.
* Barcode - CODE_39 barcode, containing the Cust Ref ORD_ORDER_HEADER.OOH_CUSTOMER_REF.


<!-- NEW PAGE --> 
{{Doc_AppendixNew
||Appendix=A
||Estimate=N
||Glossary=CTLTMS
||Ref1=[[SDD 366558 EBB Paper CTL Solution Design]]
||RefV1=3.0
||RefDate1=29/04/2020
||REQ=0
||EST=0
||FS=0
||TS=0
||DEV=0
||ST=0
||IMP=0
||PM=0
||Client={{#var:Client}}
||Year={{#var:Year}}
||FSEST=Y
||Rev1=Matt Tipping
||Rev1Title=OBS Project Manager
||Rev2=Paul Griffiths
||Rev2Title=Customer Representative
}}</div> 
[[Category:{{#var:Client}} FS]]
[[Category:{{#var:SystemCode}}]]