FS 373929 47194 CTL OTIF Report - Revision history

Anw: v1.1 - Added Measured Against parameter, and made the comparison more predictable.

2020-06-16T15:58:20Z

v1.1 - Added Measured Against parameter, and made the comparison more predictable.

← Older revision		Revision as of 17:58, 16 June 2020
Line 5:		Line 5:
	{{#vardefine:SystemCode\|CTLTMS}}		{{#vardefine:SystemCode\|CTLTMS}}
	{{#vardefine:Doc_Title\|CTL OTIF Report}}		{{#vardefine:Doc_Title\|CTL OTIF Report}}
	{{#vardefine:Version\|1.0}}		{{#vardefine:Version\|1.1}}
	{{#vardefine:Date\|16th June 2020}}		{{#vardefine:Date\|16th June 2020}}
	{{#vardefine:Reference\|373929 47194}}		{{#vardefine:Reference\|373929 47194}}
Line 63:		Line 63:

	== Data ==		== Data ==
	"OT Early Tolerance" and "OT Late Tolerance" parameters will be defined at the following levels:		"OT Measured Against", "OT Early Tolerance" and "OT Late Tolerance" parameters will be defined at the following levels:
	* Organisation.		* Organisation.
	* Carrier.		* Carrier.
	* Customer.		* Customer.

	~~This will~~ define the number of minutes that group tolerates early or late collection/delivery.		"OT Early Tolerance" and "OT Late Tolerance" parameters are signed numeric values that define the number of minutes that group tolerates early or late collection/delivery.

			Values of -1 indicate can assume On Time for that parameter regardless.

			"OT Measured Against" is a drop-dwon list of values:
			* "Order Col/Del Windows"
			* "Planned Stop Arrival Time"

	~~If undefined at Customer level, this will default to Organisation level.~~

	If undefined at ~~Carrier~~ level, this will default to Organisation level.		If these parameters are undefined at Customer level, this will default to Organisation level.

	If undefined at Organisation level~~, assume 0~~.		If these parameters are undefined at Carrier level, this will default to Organisation level.

	~~Values of -1 indicate can~~ assume ~~On Time~~ for ~~that parameter regardless~~.		If these parameters are undefined at Organisation level, assume 0 for the Early and Late tolerance, and Order Col/Del Windows for measuring against.


Line 103:		Line 108:
	Set to "OTIF REPORT".		Set to "OTIF REPORT".

	A sub-title will show the parameters selected.		A sub-title will show the parameters selected in the format.
	~~e.g.~~ Customer Group [CG], Customer [C], Carrier Group [CAG], Carrier [CA] Between [DF] and [DT]		"Customer Group [CG], Customer [C], Carrier Group [CAG], Carrier [CA] Between [DF] and [DT]"
	~~Only entered~~ parameters ~~will generate text~~:
			A sub-title will show the OTIF parameters selected in the format:
			"OTIF Parameters: Early: [OT_EARLY], Late: [OT_LATE], compared to [OT_MEASURED_AGAINST]."

			e.g. "OTIF Parameters: Early: On Time, Late: 15 Minutes, compared to Order Col/Del Windows."


Line 196:		Line 205:

	{{Note}} For tolerance levels for the on-time calculation:		{{Note}} For tolerance levels for the on-time calculation:
	* ~~the~~ customer-specified time is to be used if the user selects a specific customer.		* The customer-specified time is to be used if the user selects a specific customer. If the customer does not have any settings, the process will use the Organisation values.
	* ~~the~~ carrier-specified time is to be used if the user selects a specific carrier.		* The carrier-specified time is to be used if the user selects a specific carrier. If the carrier does not have any settings, the process will use the Organisation values.
	* If neither are selected, the report will use the defined ~~times~~ against ~~either the customer or the carrier. If the customer times are specified, there take precedence over the carrier times. If neither are specified, use~~ the organisation ~~levels~~. If not defined, use 0 as the tolerance.		* If neither are selected, the report will use the defined parameters against the organisation. If not defined, use 0 as the tolerance and compare to Order Col/Del windows.
			* The Order Collection Early and Late dates should be used if the order is a collection and the OT_MEASURED_AGAINST parameter being used indicates using Order Col/Del Windows, or is undefined.
			* The Order Delivery Early and Late dates should be used if the order is a collection and the OT_MEASURED_AGAINST parameter being used indicates using Order Col/Del Windows, or is undefined.
			* The Stop Planned Arrival time should be used if the OT_MEASURED_AGAINST parameter being used indicates using Planned Stop Arrival Time.


Line 238:		Line 250:
	\|Test={{ #vardefineecho: SubCycle \| {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}		\|Test={{ #vardefineecho: SubCycle \| {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
	\|Action=Run the OTIF report without a specific customer or carrier selected.		\|Action=Run the OTIF report without a specific customer or carrier selected.
	\|Result=All orders within that date range matching any entered criteria are selected. They are correctly identified as collections or deliveries. All order lines and products are shown. In Full is calculated correctly. On Time is calculated using ~~the Customer tolerances if specified, else the Carrier tolerances is specified, otherwise~~ the Organisation tolerances. The reason codes and At Fault codes are displayed correctly where present. Percentage OTIF summaries are calculated correctly.		\|Result=All orders within that date range matching any entered criteria are selected. They are correctly identified as collections or deliveries. All order lines and products are shown. In Full is calculated correctly. On Time is calculated using the Organisation tolerances. The reason codes and At Fault codes are displayed correctly where present. Percentage OTIF summaries are calculated correctly.
	\|Remarks=		\|Remarks=
	\|PassFail=		\|PassFail=

Anw: v1.0 - Issued.

2020-06-16T14:20:13Z

v1.0 - Issued.

New page

<div class="noprint">
{{#vardefine:Client|PROD}}
{{#vardefine:ClientName|OBS Logistics Ltd}}
{{#vardefine:System|''CALIDUS'' Total Logistics TMS}}
{{#vardefine:SystemCode|CTLTMS}}
{{#vardefine:Doc_Title|CTL OTIF Report}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|16th June 2020}}
{{#vardefine:Reference|373929 47194}}
{{#vardefine:Year|2020}}
{{#vardefine:Type|FS}}
{{ #vardefine: Figure | 0 }}{{ #vardefine: Example | 0 }}

</div>
{{Doc_TitleNew
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference={{#var:Type|FS}} {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
|Type={{#var:Type}}
}}


<div class="noprint">
= FUNCTIONAL OVERVIEW =
== Client Requirement ==
OTIF – The On Time In Full reporting must provide a detailed listing of the all the orders collected and delivered on time, collected and delivered late, collected and delivered with no discrepancies on quantity of media units and product items, and collected and delivered with discrepancies. The output must show the reason code and description for discrepancies and using the 'at fault' categorisation produce a summary statistic of percentage OTIF, percentage issues at fault, percentage issues not at fault.

== Solution Overview ==
1 report will be written.

This will be run by the user and will be generated as a PDF report.

== Scope ==
This change will be applied to system version 1.X on CTLDEV and once approved CTLTST and customer QA systems.

== Impact ==
None


= CONFIGURATION SET-UP =
== Pre-requisites ==
DevOps item 47341 - Operational Reports (base).

== Menu Structure ==
N/A

== Data ==
"OT Early Tolerance" and "OT Late Tolerance" parameters will be defined at the following levels:
* Organisation.
* Carrier.
* Customer.

This will define the number of minutes that group tolerates early or late collection/delivery.

If undefined at Customer level, this will default to Organisation level.

If undefined at Carrier level, this will default to Organisation level.

If undefined at Organisation level, assume 0.

Values of -1 indicate can assume On Time for that parameter regardless.

== Implementation Advice ==
None


= FUNCTIONAL DESCRIPTION =
This is a statistical operational report (not extract) and will be generated to a PDF report, strongly formatted.

The reports shall be named:
* Orders OTIF report.

== Selection Criteria ==
* Customer Group - lookup. Optional.
* Customer - lookup. Optional.
* Order Group - lookup. Optional.
* Carrier Group - lookup. Optional.
* Carrier - lookup on carrier. Optional. Limited to accessible carriers for that users group, or limited to the Carrier Group if selected. Defaulted to the carrier from that user.
* Date Range or Schedule. Required. Defaulted from the existing selected or default schedule.

== Report Format ==
=== Title ===
Set to "OTIF REPORT".

A sub-title will show the parameters selected.
e.g. Customer Group [CG], Customer [C], Carrier Group [CAG], Carrier [CA] Between [DF] and [DT]
Only entered parameters will generate text:

=== Data Selection ===
The report will select all order header, line and product information for the orders.

The orders selected will only be those that have been completed i.e. EXECUTED or FAILED status.

The data should be filtered by the accessible organisation of the group of the user running the report.

If Carrier is provided, select ONLY those resources that have been assigned to that carrier.

If no carrier has been provided, the data should be filtered by accessible carriers of the group of the user running the report, or those with no carrier applied.

If a carrier group has been selected, the carriers should be limited to those carriers of that group in the accessible carriers list.

Select only the legs of trips for the orders that start or end at a non-RDC location i.e. the first leg of a collection, or the last leg of a delivery.

=== Row Data ===
Column titles:

Order Information, per order:
# "C/D"
# "TMS Ref"
# "Customer Ref"
# "<Collection/Delivery> Ref" - based on whether this is a collection or delivery order.
# "Scheduled [Collection/Delivery] From/To" - based on whether this is a collection or delivery order.
# "Actual [Collection/Delivery] From/To" - based on whether this is a collection or delivery order.
# "On Time"
# "Reason"
# "At Fault"
# "Total Qty Planned"
# "Total Qty Delivered"
# "In Full"
# "OTIF"

Line Information, within each order:
# "Line #"
# "Description"
# "Total Qty Planned"
# "Total Qty Delivered"
# "In Full"
# "Reason"
# "At Fault"

Product Information, within each line:
# "Description"
# "Total Qty Planned"
# "Total Qty Delivered"
# "In Full"
# "Reason"
# "At Fault"

Columns:

Order Information, per order:
# C/D - whether this is a collection order (i.e. starting at the start location for the order) or a delivery order.
# TMS Ref
# Customer Ref
# Delivery Ref - based on whether this is a collection or delivery order, the collection or delivery reference.
# Scheduled [Collection/Delivery] From/To - based on whether this is a collection or delivery order, the scheduled Collection window or scheduled Delivery window.
# Actual [Collection/Delivery] From/To - based on whether this is a collection or delivery order, the scheduled Collection window or scheduled Delivery window.
# On Time - Scheduled dates/times plus or minus the customer, carrier or organisation tolerance level in minutes, unless that value is -1, when the 'early' date/time can be set to 1 year ago, and the 'late' date/time can be set to 1 year hence. If the tolerance level is negative, the process can assume on-time is Y. If the actual time for this leg of the order is outside of the calculated window, then N else Y.
# Reason - the order-level reason code plus description.
# At Fault - the 'At Fault' value of the order-level reason code.
# Total Qty Planned - the total quantity planned on all lines on the order.
# Total Qty Delivered - the total quantity delivered on all lines on the order.
# In Full - Y if the Total Qty Planned less than or equal to Total Qty Delivered, else N.
# OTIF - If On Time is Y and In Full is Y, then Y else N.

Line Information, within each order:
# Line #
# Description
# Total Qty Planned - the total quantity planned on this order line.
# Total Qty Delivered - the total quantity delivered on this order line
# In Full - Y if the Total Qty Planned less than or equal to Total Qty Delivered, else N.
# Reason - the line-level reason code plus description.
# At Fault - the 'At Fault' value of the line-level reason code.

Product Information, within each line:
# Description
# Total Qty Planned - the total quantity planned on this product line.
# Total Qty Delivered - the total quantity delivered on this product line
# In Full - Y if the Total Qty Planned less than or equal to Total Qty Delivered, else N.
# Reason - the product-level reason code plus description.
# At Fault - the 'At Fault' value of the product-level reason code.

{{Note}} For tolerance levels for the on-time calculation:
* the customer-specified time is to be used if the user selects a specific customer.
* the carrier-specified time is to be used if the user selects a specific carrier.
* If neither are selected, the report will use the defined times against either the customer or the carrier. If the customer times are specified, there take precedence over the carrier times. If neither are specified, use the organisation levels. If not defined, use 0 as the tolerance.

== Final Section ==
A summary section, showing:
* Total Orders
* % OTIF
* % At Fault
* % Not At Fault


= TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=OTIF Reports
|MenuAccess=Reports
|Prerequisites=Multiple trips and orders, resourced, planned and executed.
|Objective=To test that the OTIF reports work.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Reports
|Notes= 
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Run the OTIF report with a specific customer selected.
|Result=All orders within that date range for that customer are selected. They are correctly identified as collections or deliveries. All order lines and products are shown. In Full is calculated correctly. On Time is calculated using the Customer tolerances if specified, otherwise the Organisation tolerances. The reason codes and At Fault codes are displayed correctly where present. Percentage OTIF summaries are calculated correctly.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Run the OTIF report with a specific carrier selected.
|Result=All orders within that date range executed by that carrier are selected. They are correctly identified as collections or deliveries. All order lines and products are shown. In Full is calculated correctly. On Time is calculated using the Carrier tolerances if specified, otherwise the Organisation tolerances. The reason codes and At Fault codes are displayed correctly where present. Percentage OTIF summaries are calculated correctly.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Run the OTIF report without a specific customer or carrier selected.
|Result=All orders within that date range matching any entered criteria are selected. They are correctly identified as collections or deliveries. All order lines and products are shown. In Full is calculated correctly. On Time is calculated using the Customer tolerances if specified, else the Carrier tolerances is specified, otherwise the Organisation tolerances. The reason codes and At Fault codes are displayed correctly where present. Percentage OTIF summaries are calculated correctly.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_AppendixNew
|Appendix=A
|Estimate=N
|Glossary=CTLTMS
|Ref1= 
|RefV1= 
|RefDate1= 
|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=Neil Appadu
|Rev1Title=OBS Development Manager
|Rev2=Dave Meir
|Rev2Title=Product Manager
}}</div>
[[Category:{{#var:Client}} {{#var:Type|FS}}]]
[[Category:{{#var:SystemCode}}]]