FS 372843 7215 CTL - Debrief Saving Data
OBS Logistics Ltd
CTL - Debrief Saving Data
Functional Specification
14th May 2020 - 0.1
Reference: FS 372843 7215
Contents
FUNCTIONAL OVERVIEW
Client Requirement
There are also several buttons, to confirm fulfilment:
- Trip Header
- SET COMPLETED - requires a lot of checked data - didn't want to click it, because of the problems below.
- SUMMARY
- Complete Summary Review - validates that Arrived and Departed have been entered.
- ROUTE STOPS
- Confirm Fulfilled - doesn't check anything.
- Complete Stop Review - validates that Arrived and Departed have been entered. If they have, assumes that stop is unfulfilled if the Confirm Fulfilled button hasn't already been checked.
- TMS Order
- Confirm Fulfilled - doesn't check anything
- Complete Order Review - without entering anything, assumes that the order, units (and I presume products and assets) are unfulfilled where they haven't been marked as fulfilled previously.
- Transport Units
- Confirm Fulfilled - doesn't check anything.
There are a few bugs in that process.
It seems that the process saves when you click the "Complete X review" buttons and confirm them as complete. Although you can click them to unconfirm, it doesn't save anything, so everything stays as confirmed.
Given that you can enter data, you can't then save it WITHOUT clicking this button, so you can't enter any notes without actually confirming it has been reviewed.
So, we need a Save facility - there's nothing wrong with entering data and wanting to save it without confirming the debrief.
Furthermore, there's nothing that says you can't make a mistake and want to undo a confirmation after you have entered the data.
Solution Overview
The Debrief screen will be modified to fulfil this requirement.
A Save button will be added to save changes without having to change status with the sliders.
The existing Confirm/Complete slider buttons will be allowed to be unchecked, which will reverse the locking of the data underneath them.
They will continue to save data as now, when they are clicked to an 'on' position.
When navigating away from a trip being debriefed, an alert will be offered saying that changed data will not be saved, allowing the user to cancel and save the changes.
Scope
This change will be applied to system version 1.X on CTLDEV and once approved CTLTST and customer QA systems.
Note: There is another TFS work item (6104) that controls the reversal of Completed trip status - that in not covered in this specification.
Impact
This change will allow the users to enter data and save it without having to confirm debrief across the whole trip, stop, order, line, etc.
CONFIGURATION SET-UP
Pre-requisites
None
Menu Structure
N/A
Data
N/A
Implementation Advice
The existing debrief documentation within CALIDUS Assist must be updated to reflect the new way to use the screen.
FUNCTIONAL DESCRIPTION
Planning Screen
The Debrief screen will be modified to fulfil this requirement.
A Save button will be added to save changes without having to change status with the sliders.
If possible, the Save button should be highlighted when there are changes that have not been saved, and greyed out when there is nothing to save.
The button will be added to the central portion of the top header of the trip detail panel, next to the existing Refresh button.
The top header of the trip detail panel will always be visible, even when scrolling. This is so that the user can save the changes no matter what part of the order they are saving.
The existing Confirm/Complete slider buttons will be allowed to be unchecked, which will reverse the locking of the data underneath them.
That is including (but not limited to) the following buttons:
- SUMMARY
- Complete Summary Review
- ROUTE STOPS
- Confirm Fulfilled
- Complete Stop Review
- TMS Order
- Confirm Fulfilled
- Complete Order Review
- Transport Units
- Confirm Fulfilled
They will continue to save data as now, when they are clicked to an 'on' position.
When clicking to an 'off' position, the section (and all sub-sections that are not marked as completed) should be made editable again, removing any greying out from the sections.
When navigating away from a trip being debriefed, when data is not saved, an alert will be offered saying that changed data will not be saved, allowing the user to cancel and save the changes.
This "unsaved changes" check will apply in all situations that move away from the trip being debriefed, such as (not limited to):
- Clicking the Refresh button.
- Clicking another trip on the trips results table.
- Clicking the Close button (on the left of the trip detail panel) or X button (on the right of the trip detail panel).
- Navigating away from the page.
TEST PLAN
Test Script / Scenario Reference | CTL - Debrief Saving Data | Call Number(s): 372843 7215 |
Test Script / Scenario Description | Saving and re-entering data | PASS / ISSUES / FAIL |
Menu Access | Trip Debrief | |
Pre-requisites | Trips to be debriefed. | Tested By: |
Test Objective | To test that: trips can be saved without confirming all changes; trips can be reopened; unsaved data changes are warned. | Date: |
Step | Action | Result | Remarks | P/F |
1 | Trip Debrief | |||
1.01 | On an incomplete trip, add details to the trip header, summary, stops, orders, lines, products and click Save | The data is saved and is re-found when searching for the trip again or refreshing. | ||
1.02 | On a debriefed trip (not complete) with sections that have been confirmed, click the Confirm button in those sections. | The unconfirmed sections below are editable again. Child sections below that are confirmed should stay confirmed. | ||
1.03 | Change data in those unconfirmed sections. Attempt to leave/refresh/close without saving data. | An alert is provided. Cancelling stays where you were, whilst confirming continues. When continuing, changed data is lost. | ||
1.04 | Click the Confirm buttons in the sections. | The data is saved and is re-found when searching for the trip again or refreshing. |
APPENDIX A: DOCUMENT HISTORY
References
Ref No | Document Title & ID | Version | Date |
1 |
Glossary
Term | Definition |
---|---|
Transport Terms | |
Audit Log | A log of events that have happened in the C-TL system. It could include information, error, debug or audit messages. Users are able to search for messages of a certain type, on a certain day and from a certain area of the system. |
Activity | The activity at a stop. Usually loading or unloading. |
Asset | A traceable DU; the item that is tracked during delivery and collection. This Asset has a type (e.g. Cage, Tet, etc). |
Backloads | Orders that are placed on a pre-existing trip at the end of the trip before returning to the depot. They may be for customers other than the customer that is paying for the full trip and may result in a rebate to the customer, and a charge to the backload order’s customer. |
Booking | A quantity of a single Product Type on a single DU Type to be delivered from one location to another on particular date but not at a particular time. These records are usually created by the Auto Summary process. These records are displayed in the main view on the Bookings form. |
BUE | Base Unit Equivalent. Also RPE (Regular Pallet Equivalent). A means of comparing transport unit type size. For example, a Standard Pallet may equate to 1 BUE, a Large Board may equate to 2 BUEs, a carton may equate to 0.02 BUE. This is used to estimate volume and therefore capacity of vehicles within CTL-TMS. Typically this is based on a standard 1 cubic metre pallet. |
C-ePOD | CALIDUS EPOD, OBS Logistics' app-enabled trip execution system. |
C-Portal | CALIDUS Portal, OBS Logistics' web-enabled external access system. Also, any electronic internet-based system designed to access functionality for a particular purpose (for example, customer enquiries, supplier activity, track and trace, etc.). |
Carrier | The carrier completing the trip. Can comprise any carrier configured in the system, but normally Home Fleet (usually a carrier per depot), 3rd-party carriers, supplier-/customer-own transport, own collection, etc. |
Case | A Case of individual packets of a product e.g. a case of Cornflake packets. |
Consolidating Centre | A depot that takes delivery of goods from several origins and consolidates them for trunking to out-bases (q.v.) or final delivery to destinations. See also Consolidation. |
Consolidation | In execution terms, this is the act of taking several jobs and combining them into a single execution job. This can be by several criteria but is broadly defined as: Same Location consolidation, where the delivery/collection points are identical; Linked Location, where the deliver/collection points have been configured to be seen as the same point within CTL-TMS and; Manual (Ad Hoc) Consolidation, where the driver decides that two jobs should be delivered/collected at the same time. |
Containerisation | The action of taking items and placing them inside another item for tracking purposes. See also Asset. |
Cost | The cost to the operation of running the trip. The cost is generated from the carrier's rate card. Cost is generated from the trip. |
Cross-Dock | Also a specific location at which product is exchanged. |
CTL-TMS | CALIDUS Total Logistics TMS, OBS Logistics' Transport Management System. |
CTM | This refers to the Carrier Trip Management module within C-TL. |
Customer | In 3PL terms, the customer on behalf of which the transport is being operated. |
Debrief | Comprises multiple parts: Stop debrief, where actual arrival and departure times against a trip are entered; Order debrief, where actual product and item quantities are entered; Driver/Trip debrief, where additional information is captured from the driver relating to the trip. |
Demurrage; Detention | Any time spent loading, unloading or waiting that is outside contractual obligation in execution of a trip. This usually incurs additional charges. |
Depot | Any location that schedules and controls transport. |
Despatch | In transport terms, the process of loading and despatching items out of a depot. The process of loading and despatching may be controlled by C-MCS (q.v.). See also Loading. |
DMS | Document Management Systems: Systems than manage the storage and viewing of (predominantly) scanned documents. Usually these systems also include some automation and indexing routines. |
DOT | Delivery On Time - see OTIF. |
Driver | Comprising drivers and crew assigned to a trip. |
DU | Despatch Unit type e.g. Standard Roll Pallet. |
Drivers Day | A schedule of work that a driver would undertake in a day including any rest periods and breaks. |
EDI | Electronic Data Interchange - a mechanism by which 2 systems can communicate normally without user intervention. |
ERP | Enterprise Resource Planning. |
Fixed Route Template | A template in CTL-TMS that provides a series of timed slots into which orders will fit. This can be used to create fixed routes (q.v.) and also as a template for cross-docking and grouping similar orders together. |
Fixed Route | In transport terms, a fixed route is a trip comprised of a series of fixed stops that are typically always visited. A CTL-TMS fixed route template (q.v.) can be used to create these. |
Fuel Surcharge | An additional charge that may be applied to a Transport charge to reflect the increasing price of fuel. |
Item | A single (usually unique) item for delivery/collection. A general terms, distinct from the TU of the deliverable item e.g. Pallet, Package, etc. |
Load | CTL-TMS: A trip that encompasses just a vehicle-full of items, or one journey out and back to a depot. |
Loading | In transport terms, the process of loading and despatching items out of a depot. The process of loading and despatching may be controlled by C-MCS (q.v.). See also Despatch. |
Location | In CTL-TMS terms, a trip comprises visits or drops to many locations. A location can be of many different types. |
Location Types | Usually one of: Depot, Customer, Delivery/Collection Location, Store, etc. |
Location Zone | Also Zone; A grouping of included or excluded postal regions, zones or post codes. These are used in fixed route templates to determine whether orders from or to locations should be included in any trips created from them. |
MCS | Mobile Control System |
MSMQ | Microsoft Message Queue – a method of interfacing with another system using Microsoft based technology. |
OBD | On-Board Diagnostics - an automotive term referring to a vehicle's self-diagnostic and reporting capabilities. Also CANbus. |
ODBC | Open Database Connectivity – A method of communicating with an external database from a program outside of the database environment. |
Optimisation | Route Building and Optimisation. |
Order | An instruction to deliver specific quantities of one or more Product Types on particular DU types from one location to another at a particular time; a transport movement. |
Order Item | An individual, usually unique item for collection or deliver. |
Order Line | An order can be made up of different order lines (i.e. an order from one location to another can contain many lines such as 20 ambient pallets and 20 chilled pallets). |
Order Status | The lifecycle of an order. Typically: Unscheduled; Scheduled (or Sheduled for Collection for cross-docked orders); Completed; Cancelled. |
Order Type | This defines the category of the order, and is intrinsically linked to revenue and cost tariffs. |
Organization | A part of an organization to which costs may be charged for accounting purposes. For CTL-TMS, this is used for accounting purposes, and also to generally configure the system. |
OTIF | On Time In Full - Success metrics to measure successful completion of an order. |
Out-base | A regional depot for collection and delivery in this local area. See also: RDC; ROC. |
Payment | Monies paid by a cost centre to a third party such as a carrier. |
Plan | A term used to describe the result from scheduling Orders onto Trips. The first set of Trips may be referred to as 'Plan A', with a subsequent, more accurate plan later in the day being referred to as 'Plan B'. |
Post Schedule | The period after Orders have been scheduled in the Scheduling Program and then returned to C-TL. Any subsequent manipulation of these Orders would be Post Schedule manipulation. |
Pre Schedule | The period before Orders have been scheduled in the Scheduling Program and then returned to C-TL. Any manipulation of these Orders would be Pre Schedule manipulation. |
Product Item | Another term for a case or SKU. |
Product Quantity | A quantity of a single Product Item or SKU to be delivered from one location to another on particular date but not at a particular time. These records are created by the inbound Bookings interface process. These records are displayed in the View Detail screen on the Bookings form. |
Product Summary | Another term for Booking. |
Product Type | The category that a Product Item, Case or SKU falls in to, usually associated with temperature e.g. FROZEN, PERISHABLE, AMBIENT. |
Rate Card | See Tariffs. |
Reason Codes | Of many types, defining exceptions: Adjustment, Non-conformance, Order. |
Recalculate Distance and Times | A C-TL function that is applied to a trip. The function checks the properties of the trip to ensure that it meets the defined rules for a trip in respect of drive times and driver’s breaks. |
RDC; ROC | Regional Distributions Centre and Regional Operating Centre. For transport operations with multiple depots, these depots are used for the final delivery. |
Region | Geographical Region. Also, Postal Region. |
Receipt | In transport terms, the process of receiving and uploading items into a depot. The process of receipt and unloading may be controlled by C-MCS (q.v.). See also Unloading. |
Resource | General term grouping the executors of a trip. Carriers, Drivers, Crew, Tractors, Vehicles, Trailers. |
Revenue | Monies received by an organisation from a third party such as a customer. Revenue is generated from an order, based on the customer's rate card. |
Route | A route is a fixed route that is repeated. A Trip is a unique trip, which may be created from a route. |
Schedule | The period to which a set of Orders and Trips will be assigned and scheduled. Usually, but not necessarily, a single day of the week so referred to as a Schedule Date that runs from 22:00 – 22:00 e.g. Schedule Date 11th July 2002 runs from 22:00 10-July-16 to 22:00 11-July-16. |
Scheduled Order | An Order that has been scheduled onto a Trip by the scheduling process. |
Service Levels; Service Types | Typically used to determine additional services for an order, or a quicker transport service. |
Shunt | A trunk (q.v.) movement between depots using the trunk network, typically of a much shorter length than a trunk movement. |
SKU | Stock Keeping Unit – another term for a Case. |
Stop | See Trip Stop. |
Stop Type | Along with the activity (q.v.), defines the stop use. Usually: SU - Start-up; PK - Pick-up; DL - Delivery; CL - Close-down. |
Supplier | A supplier brings goods to your transport operation for delivery through the transport network. This is used when transport customers have relationships with suppliers for delivery, but the transport operation has a relationship with the customer. |
Surcharges | Any changes applied to an invoice at invoice stage, rather than generated from the order or trip itself. Examples are: Fuel Surcharge/Rebate, Demurrage. |
Tariffs | Rate Cards, forming the basis of generating trip/carrier costs and order revenue. |
TI | Transport Instruction – another term for an Order. |
TLM | Transport Logistics Manager. |
TMS Ref | A unique transport movement ID, referring to a single transport movement request. |
Tractor | The driver cab, pulling the trailer. |
Trailer | The trailer carrying the goods. Can be several types. |
Trans-Ship | The process of receiving, cross-docking and despatching items within a depot, usually within a single transaction. In this implementation, this is the process at the RDC (q.v.). |
Transport | Any portion of an operation that deals with the execution of trips; the transport management office. |
Trip | A routed Truck Load of goods. For example, a trip that begins at Depot 1 where an Order is loaded, then travels to Store 1 where the Order is unloaded. Typically the trip would then return to Depot 1 to terminate the trip. |
Trip Manipulation | The manipulation of Scheduled Trips, whether it be to add a Carrier or to completely recalculate times on the Trip. |
Trip Status | The lifecycle of a trip. Typically: Planned; Tendered; Accepted; En-Route; Completed. |
Trip Stop | Stops within a trip at which specific activities would take place such as the loading or unloading of goods. |
Trunk | A route between depots, transporting goods usually to be delivered from the destination depot, but any transfer of goods from the original receiving or originating depot in the network to the final delivery depot (the out-base). |
TU | Transport Unit - box, tray, cage, tet, etc.; Also Asset, Asset Type. |
TTM | CALIDUS Portal TTM; Track and Trace Module; OBS Logistics' application dedicated to tracking and tracing order events with inputs from several external systems. |
Unloading | The process of receiving and uploading items into a depot. The process of receipt and unloading may be controlled by C-MCS (q.v.). See also Receiving. |
Unscheduled Order | An Order that is yet to be scheduled onto a Trip by the scheduling process. |
Vehicle | A generic term for a tractor (q.v.). This term may also be used to specifically identify a fixed tractor/trailer combination, for example a van, luton, etc. |
Warehouse | This is a depot in CTL-TMS that is seen to be a warehouse, or origin and storage point for product for delivery. |
Application Usage Terms | |
Check box | A box that when checked indicates that the item to the left is enabled. If unchecked, this is disabled or not in use. |
DDL; Drop-down List | A series of pre-designated answers to a particular question on a device, rather than requiring the user to key the answer in in full. |
Field | A single point of data entry on a screen, for example, a text box, drop-down list, check box, etc. |
Look-up | A pop-up window specifically designed to allow searching for and selected pre-configured data. |
Pop-up | A window (q.v.) that appears over the top of the open window. |
Screen | The functional area, for example, "the Debrief screen". All functionality for this functional area is contained within this screen. |
Window | The area of the browser used to display the screen and all contained entities. |
Authorised By
Neil Appadu | OBS Development Manager | _____________________________ |
Dave Meir | Product Manager | _____________________________ |