View source for FS 374034 49195 CTL KPI Summary by Depot

<div class="noprint">
{{#vardefine:Client|PROD}}
{{#vardefine:ClientName|OBS Logistics Ltd}}
{{#vardefine:System|''CALIDUS'' Total Logistics TMS}}
{{#vardefine:SystemCode|CTLTMS}}
{{#vardefine:Doc_Title|CTL KPI Summary by Depot Report}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|17th June 2020}}
{{#vardefine:Reference|374034 49195}}
{{#vardefine:Year|2020}}
{{#vardefine:Type|FS}}
{{ #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={{#var:Type|FS}} {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
|Type={{#var:Type}}
}} 

<!-- TOC --> 
<div class="noprint">
= FUNCTIONAL OVERVIEW  =
== Client Requirement  ==
KPI Summary by Depot - drivers, vehicles, miles, revenue, cost, vehicle utilisation fill, empty running, weighted average, total units, total weight, total volume, total PEF, driver hours, deliveries/ collections /returns. This summary must provide an overview of the business performance for a day, week and month.


== 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


<!-- NEW PAGE --> 
= CONFIGURATION SET-UP  =
== Pre-requisites  ==
DevOps item 47341 - Operational Reports (base).



== Menu Structure  ==
N/A


== Data  ==
N/A


== Implementation Advice ==
None

<!-- NEW PAGE --> 
= FUNCTIONAL DESCRIPTION =
This is an operational report (not extract) and will be generated to a PDF report, strongly formatted.

The reports shall be named:
* KPI Summary by Depot report.


== Selection Criteria ==
* Depot - Required. Default to accessible depot. Lookup of accessible depots.
* Date Range or Schedule. Required. Defaulted from the existing selected or default schedule.
* Period - a drop-down list of values:
** Day
** Week
** Month


== Report Format ==
=== Title ===
Set to "KPI SUMMARY BY DEPOT REPORT".

A sub-title will show the depot and period being reported on this page:
 Depot X - NAME. Period: [PERIOD]

The period is formatted by the following criteria:
* Day - system date format e.g. "DD/MM/YYYY"
* Week - week format "YYYY, week WW"
* Month - month format "YYYY-Mmm"


=== Data Selection ===
Compared to a traditional report (which reports details in "header/detail/footer" style, this report is summarising several queries into one page per depot. Each section will select its own data from different data sources.

However, basic selection criteria will be required based on the parameters entered.
* If no depot is selected, all depots will be reported on.
* Trips will be selected based on the owning depot and the date range selected.
* Orders will be selected based on the owning depot and the date range selected.
* Trip data range selection should be based on the actual start date, or the planned date if not started.
* Order data range selection should be based on the actual collection and delivery dates, or the planned dates if not completed.
* Deleted trips should be excluded.
* Cancelled orders should be excluded.
* Drivers should be selected based on the carriers associated to that depot.
* Vehicles should be selected based on the carriers associated to that depot.


=== Reporting Sections ===
Each page of data contains the following sections:
* Drivers
* Vehicles
* Orders
* Trips


1 page per depot per period reported.
So:
* if by date and a week range is selected, 7 pages will be produced, one for each day.
* if by week and a 10 day range is selected, 2 pages will be produced, one for each week, with all data applicable to the weeks defined by the date range selected.
* if by month and a single day is selected, 1 page will be produced, one for the month, with all data applicable to the month defined by the date range selected.


==== Drivers ====
One row per driver type, summed.

Columns:
* "Type"
* "Qty"
* "Hours Available"
* "Hours Worked"
* "%Util"

Data: 
* "Type" - the person type
* "Qty" - the count of people of this type.
* "Hours Available" - the total hours available, taking into account system, organisation and carrier non-working days, the driver's assigned shift hours, calendar exceptions and country non-working days, summed.
* "Hours Worked" - the total hours worked i.e. spent on trips. {{Note}} If there are trips without debrief information (i.e. actuals), use the planned timea instead.
* "%Util" - a percentage utilisation of resources of this type, based on the above two calculations.


==== Vehicles ====
Vehicles (based at carrier associated to this depot) by type.

Columns:
* "Type"
* "Qty"
* "Trips" 
* "Distance (UOM)" - the distance unit of measure should be displayed here as an abbreviation i.e. "M" or "KM".
* "Empty Running (UOM)" - the distance unit of measure should be displayed here as an abbreviation i.e. "M" or "KM".
* "Hours Available"
* "Hours Worked"
* "%Util"


Data:
* "Type" - the vehicle type.
* "Qty" - the count of people of this type.
* "Distance" - the number of trips assigned to vehicles of this type. If a trip is only assigned to a vehicle type, not an actual vehicle, do not count it.
* "Distance (UOM)" - the summed actual miles of all of these trips for vehicles of this type. If actual information is not available for the trip, use the planned distance instead.
* "Empty Running (UOM)" - where a vehicle has no BUE carried between stops, this distance between stops should be summed here for the trips selected above.
* "Hours Available" - the total hours available, taking into account system, organisation and carrier non-working days, calendar exceptions and country non-working days, summed.
* "Hours Worked" - the total hours worked i.e. spent on trips. {{Note}} If there are trips without debrief information (i.e. actuals), use the planned timea instead.
* "%Util" - a percentage utilisation of resources of this type, based on the above two calculations.


==== Orders ====
Orders Owned by this depot by Service Level

Columns:
* "Service Level"
* "Qty"
* "Total units"
* "Total weight (UOM)" - the weight unit of measure should be displayed here as an abbreviation e.g. "Kg" or "T".
* "Total volume (UOM)" - the volume unit of measure should be displayed here as an abbreviation i.e. "m3" or "cu.f".
* "Total BUE"
* "Total Revenue (CURRENCY)" - the short currency code of the organisation should be displayed here e.g. "GBP".
* "Total cost (CURRENCY)" - the short currency code of the organisation should be displayed here e.g. "GBP".


Data:
* "Service Level" - service level name.
* "Qty" - the count of orders of this service level.
* "Total units" - the total quantity of all of the orders of this type, summed.
* "Total weight (UOM)" - the total weight of all of the orders of this type, summed.
* "Total volume (UOM)" - the total volume of all of the orders of this type, summed.
* "Total BUE" - the total quantity of all of the orders of this type, summed.
* "Total Revenue (CURRENCY)" - the total revenue of the orders selected, summed.
* "Total cost (CURRENCY)" - the total apportioned transport costs of the orders selected, summed.


==== Trips ====
Trips by Type (Trunk/Radial) owned by this depot

Columns:
* "Type"
* "Qty"
* "Avg Departure vehicle fill (BUE)"
* "Avg Weighted average fill (BUE)"
* "Empty Running (UOM)" - the distance unit of measure should be displayed here as an abbreviation i.e. "M" or "KM".
* "Total units"
* "Total weight (UOM)" - the weight unit of measure should be displayed here as an abbreviation e.g. "Kg" or "T".
* "Total volume (UOM)" - the volume unit of measure should be displayed here as an abbreviation i.e. "m3" or "cu.f".
* "Total BUE"
* "Total cost (CURRENCY)" - the short currency code of the organisation should be displayed here e.g. "GBP".


Data:
* "Type" - "Trunk" if a trunk trip else "Radial"
* "Qty" - the count of trips of this type.
* "Avg Departure vehicle fill (BUE)" - the first loading stop BUE for all trips of this type, summed.
* "Avg Weighted average fill (BUE)" - the average BUE at departure of each stop for all trips of this type, summed. 
* "Empty Running (UOM)" - where a trip has no BUE carried between stops, this distance between stops should be summed here for the trips selected above. 
* "Total units" - the total quantity collected or loaded onto trips of this trip, summed.
* "Total weight (UOM)" - the total weight collected or loaded onto trips of this type, summed.
* "Total volume (UOM)" - the total volume collected or loaded onto trips of this type, summed.
* "Total BUE" - the total quantity collected or loaded onto trips of this type, summed.
* "Total cost (CURRENCY)" - the total transport costs of the trips selected, summed.


<!-- MEDIA LANDSCAPE YES --> 
= TEST PLAN  =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Outstanding Debrief Report
|MenuAccess=Reports
|Prerequisites=Multiple trips and orders, resourced, planned, some accepted, some en-route, some debriefed (completed), some trip debriefed (confirmed), some partially debriefed, some with no debrief information.
|Objective=To test that the Outstanding debrief report works.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Reports
|Notes=&nbsp;
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Run the Oustanding Debrief report with a date range or schedule.
|Result=Only trips within the date range calculated are displayed. Only trips from the depot selected are displayed.
Only trips, stops, orders, lines and products missing debrief information are displayed.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 

<!-- MEDIA LANDSCAPE NO --> 
{{Doc_AppendixNew
|Appendix=A
|Estimate=N
|Glossary=CTLTMS
|Ref1=&nbsp;
|RefV1=&nbsp;
|RefDate1=&nbsp;
|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}}]]