FS 355160 MLP Device Changes: Difference between revisions
From Calidus HUB
(v0.1 - Initial Draft) |
(v1.0 - Release after review) |
||
| Line 4: | Line 4: | ||
{{#vardefine:System|''CALIDUS'' ePOD}} | {{#vardefine:System|''CALIDUS'' ePOD}} | ||
{{#vardefine:Doc_Title|MLP Delvice Changes}} | {{#vardefine:Doc_Title|MLP Delvice Changes}} | ||
{{#vardefine:Version|0 | {{#vardefine:Version|1.0}} | ||
{{#vardefine:Date|18th January 2019}} | {{#vardefine:Date|18th January 2019}} | ||
{{#vardefine:Reference|355160}} | {{#vardefine:Reference|355160}} | ||
Latest revision as of 15:39, 31 January 2019
Marshalls Stone
MLP Delvice Changes
CALIDUS ePOD
18th January 2019 - 1.0
Reference: FS 355160
Contents
Functional Overview
Client Requirement
Changes are to the MLP device styling only.
- No pagination on styling of products list.
- Switch Long Description and Description on products list
- Product Quantity entry to split Packs and Loose to separate lines for actual quantity, plus UOM on second line. Planned quantity to remain the same layout.
Solution Overview
The product list defaults to 10 items per page. The style for MLP devices ('MAR-LAND') will be modified so that this has no pages. There will be no pagination buttons and all products will be shown on the list.
Note: This may result in a slight delay when first showing the products tab on a collection or delivery, where that job has many products.
The product list has been styled to show the product description. As this is switching places with the data coming in to CALIDUS ePOD, the product list itself must be changed to display the log description rather than description of the product.
Note: The mobile device user will still be able to view both descriptions, by long-pressing against the product line and choosing Info.
The Product Quantity entry screen (called when changing product quantity or entering comments) will be modified to split Packs and Loose Items to separate lines for actual quantity, plus UOM on second line.
For example:
Original Quantity: CCCCC /
UUUUU UOM
New Quantity: CCCCC / UUUUU
Note: Planned quantity will not be affected by this change.
To achieve this, the UOM field will be added to the display, hidden by default. The MLP style will be modified to show this field, and also to explicitly move the loose quantity to a new line, pushing all other fields down.
Scope
This change will be made to the latest version of CALIDUS ePOD.
Set-up
Pre-requisites
N/A
Menu Structure
N/A
Data
N/A
Functional Description
PDA Style
The style for MLP devices ('MAR-LAND') will be modified to achieve the changes required.
Pagination will be removed from the products list.
Developer Notes: This will be achieved by adding the following to the 'MAR-LAND' PDA Style:
"ColDel_lvProductList": {
"intPageSize": 0
},
Long Description will be used instead of Description on the Products list.
Developer Notes: This will be achieved by changing the 'MAR-LAND' PDA Style for the product list from:
"ProdList_Items": [ "lblProductID", "lblPackSize", "lblProductUnitType", "lblProductPlannedQty", "lblProductDesc" ],
to this:
"ProdList_Items": [
"lblProductID",
"lblPackSize",
"lblProductUnitType",
"lblProductPlannedQty",
"lblLongDesc"
],
"ProdList_lblLongDesc": {
"width": "98%",
"left": "1%",
"color": "#000000",
"font": {
"fontSize": "16 * Ti.App.resMod"
}
},
The Product Quantity entry screen (called when changing product quantity or entering comments) will be modified to split Packs and Loose Items to separate lines for actual quantity, plus UOM on second line.
The original layout in the quantity change section is as follows:
Original Quantity CCCCC / UUUUU
New Quantity CCCCC /
UUUUU UOM
Note: Planned quantity fields layout will not be affected by this change.
The new layout for MLP will be as follows:
Original Quantity CCCCC / UUUUU Packs CCCCC Loose Items UUUUU UOM
Note: For Change Quantity exceptions, the screen will display following this layout. For Product Comment/Clausing, the layout will move the "Original Quantity" values to the view on the left.
Developer Notes: To achieve this, the UOM field will be added to the display, hidden by default.
The MLP style will be modified to show this field, and also to explicitly move the loose quantity to a new line, pushing all other fields down.
The separator used ("/") will be changed to be a stylable item, with the slash as a default value.
The MLP style will override this label with the value "Loose". The width of the item will be such that it is moved to the line below.
The "New Quantity" label ("newQty") will be translated to "Packs" for the MLP PDA style.
Exception Process
The Product exception processes above must also be modified to show the product long description rather than the product description, as it does now. This requires the elements of the view to be configurable through the style.
Developer Notes: The style for the cancellation info view ("Cancellation_vwInfoScroll") will be modified to have an "options" or "layout" property.
This will be set to an object, with properties of each type of exception. Each exception type will have an array of items that will be displayed on the view panel.
The following shows all the allowed elements in this configuration item:
vwInfoScroll_items {
"JOBS" : ["CancelText", "JobId", "CustName"],
"SERVICE_JOB" : ["CancelText", "JobId", "CustName"],
"SERVICE_ITEM" : ["CancelText"],
"CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"CLAUSE_CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"PRODUCT" : ["CancelText", "JobId", "CustName", "ProdContID", "ProdDesc", "ProdDescLong", "PlanQty", "ProdUOM"],
"CLAUSE_PRODUCT" : ["CancelText", "JobId", "CustName", "ProdContID", "ProdDesc", "ProdDescLong", "PlanQty", "ProdUOM"],
"CHANGE_QTY" : ["CancelText", "JobId", "CustName", "ProdContID", "ProdDesc", "ProdDescLong", "PlanQty", "ProdUOM"]
}
The default values for this object will be stored in the application's system style as follows:
vwInfoScroll_items {
"JOBS" : ["CancelText", "JobId", "CustName"],
"SERVICE_JOB" : ["CancelText", "JobId", "CustName"],
"SERVICE_ITEM" : ["CancelText"],
"CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"CLAUSE_CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDesc"],
"CLAUSE_PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDesc"],
"CHANGE_QTY" : ["CancelText", "JobId", "CustName", "ProdDesc"]
}
The MLP PDA style will style this as follows:
vwInfoScroll_items {
"JOBS" : ["CancelText", "JobId", "CustName"],
"SERVICE_JOB" : ["CancelText", "JobId", "CustName"],
"SERVICE_ITEM" : ["CancelText"],
"CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"CLAUSE_CONTAINER" : ["CancelText", "JobId", "CustName", "LinkedJobs", "ContID", "PackageCode", "ContPackDesc", "ContDescLong", "ContWt", "ContC1", "ContC2", "ContC3"],
"PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDescLong", "PlanQty", "ProdUOM"],
"CLAUSE_PRODUCT" : ["CancelText", "JobId", "CustName", "ProdDescLong", "PlanQty"],
"CHANGE_QTY" : ["CancelText", "JobId", "CustName", "ProdDescLong"]
}
The process building the view panel will check for this configuration element before building it. If it doesn't exist in the custom style, the default system style will be checked and this will be used.
The process will loop through the configuration array elements and only add those listed.
| Config Element | Field to Add | Notes |
|---|---|---|
| "CancelText" | "jobCancelLB" | |
| "JobId" | "lblJobId" | Only added if the Job DAL object is present. |
| "CustName" | "lblCustName" | Only added if the Job DAL object is present. |
| "LinkedJobs" | "lblLinkedJobId", "lblLinkedCustName" | Add only if the data object type is "PDA_CONTAINER". Add only for linked containers i.e. consolidated across jobs. Add for each linked job's container. The labels have been renamed here to include the text "Linked". |
| "ContID" | "lblContID" | Add only if the data object type is "PDA_CONTAINER". |
| "PackageCode" | "lblPackageCode" | Add only if the data object type is "PDA_CONTAINER". |
| "ContPackDesc" | "lblContPackageDesc" | Add only if the data object type is "PDA_CONTAINER". |
| "ContDescLong" | "lblContDescLong" | This is a new field. Add only if the data object type is "PDA_CONTAINER". |
| "ContWt" | "lblContWt" | Add only if the data object type is "PDA_CONTAINER". |
| "ContC1" | "lblContC1" | Add only if the data object type is "PDA_CONTAINER". |
| "ContC2" | "lblContC2" | Add only if the data object type is "PDA_CONTAINER". |
| "ContC3" | "lblContC3" | Add only if the data object type is "PDA_CONTAINER". |
| "ProdDesc" | "lblProdDesc" | This is a new field. Add only if the data object type is "PDA_PRODUCT". |
| "ProdDescLong" | "lblProdDescLong" | This is a new field. Add only if the data object type is "PDA_PRODUCT". |
| "PlanQty" | See below for details. | These are new fields. Add only if the data object type is "PDA_PRODUCT". |
| "ProdUOM" | "lblProdUOM" | This is a new field. Add only if the data object type is "PDA_PRODUCT". |
Developer Notes: All fields are ID'd with the screen name on the front, for example, where this document specifies field "jobCancelLB", this is added to the screen as "Cancellation_jobCancelLB".
When adding "PlanQty" to the view panel, the field should be generated in exactly the same way as they are added to the quantity entry view as now, with the same IDs. Further, a variable should be set to show that the planned fields have been added to the Info view. This will be checked when building the quantity entry view and, if set to true, the planned quantity fields will not be added to the quantity entry view.
Change the function CancellationText for types "PRODUCT", "CLAUSE_PRODUCT" and "CHANGE_QTY" to not include the description in the cancellation text.
Appendix A: Quote & Document References
| Cost Details | ||||
| Activity | Estimate No. of Days |
No. of Days | Rate per Day (£) | Cost (£ Exc. VAT) |
| Requirements | 0.00 | 0.00 | 750 | £0.00 |
| Change Request Evaluation | 0.00 | 0.00 | 750 | £0.00 |
| Functional Specification | 0.75 | 0.75 | 750 | £562.50 |
| Technical Specification | 0.00 | 0.00 | 750 | £0.00 |
| Development | 3.00 | 3.00 | 750 | £2,250.00 |
| Testing and Release | 0.50 | 0.50 | 750 | £375.00 |
| Implementation | 0.25 | 0.25 | 750 | £187.50 |
| Project Management | 0.25 | 0.25 | 750 | £187.50 |
| TOTAL | 4.75 | 4.75 | £3,562.50 | |
| Estimate excludes training, release to live and go live support. |
A.1 References
| Ref No | Document Title & ID | Version | Date |
| 1 |
A.2 Glossary
| Term or Acronym | Meaning |
|---|---|
| General Definitions | |
| EPOD | Electronic Proof of Delivery. The OBSL EPOD system is CALIDUS ePOD. This also comprises the basis of the Service Completion system CALIDUS eServ. |
| Server | The portion of the CALIDUS ePOD/eServ systems that controls all the data and sends information to and receives updates from the mobile device. |
| Mobile Device; PDA | The device used by the driver to perform the jobs. Typically an Android mobile device or tablet. |
| Site | The site usually defines the depot, business or the transport group (carrier). It can be set to any value required by the customer. All transactions data (for example, loads and jobs) and standing data (for example, vehicles and uses) belong to a site. An EPOD user, on a device or in the Admin screen, can only see data for one site at a time. |
| Load | A single journey for the driver with a set of work attached. A load is identified by a unique load ID. This may also be referred to as a worklist or workload. |
| Job | Also Consignment. A single task for the driver as a specific location. This could be the collection of goods or the delivery of goods. Jobs may also be Services (for example, servicing, installing or de-installing a boiler). A job is identified by a unique job ID but can also have other references held against the job (e.g. job code, SO number, customer reference and external reference). |
| Job Group | Jobs must be tagged with a Job Group. All jobs tagged with a single job group are processed in the same way. The job group has configuration associated to it to control such items as: POD/POC Report settings; Pre-Job actions (such as signing at a gatehouse); Post-Job actions (such as who signs for the item, are photos required); configurable fields required for entry for the jobs; Terms and Conditions displayed and; driver/user process (such as photos required for cancellation, comments/notes allowed). The job group can be used for any or all Sites, and the configuration against the job group can be different in each site. Job Groups can also be restricted from Admin and Remote users, so that certain users only see jobs for certain groups. |
| Container | A generic term for any object that contains the items being collected or delivered. Examples of containers are: Pallet; Package; Carton; Item; Cage. A special container "Loose Products" - see Product below. A container is identified by a container ID which is unique to this physical container. |
| Product | A product is any goods that are being collected or delivered where the product has a 'Product Code' which identifies what the product is but which does not uniquely identify each individual item. A product will also have a quantity associated with it to indicate how many items of this 'Product Code' are being collected or delivered. Products can either be processed within a 'Container' or as 'Loose Products' without a 'Container'. |
| Owner | The owner of the order that created the job. Typically this is the sales team that took the order and will be responsible for dealing with queries from the customer regarding the status. |
| Operator; Executor | The Site (depot or carrier) that is executing the load or loads that are involved in the delivery of the items. |
| Item Related Definitions | |
| Job Code | A reference associated with a job or job(s). This reference is common to connected jobs, for example this would be the same on both the collection of goods and the associated delivery of the same goods. Typically this would be the transport unique reference. |
| SO Number | A reference associated with a job which indicates the "Sales Order Number" this job is associated with. |
| Customer Reference | A reference associated with a job which has been provided by and will be recognised by the customer. |
| External Reference | A reference associated with a job which does not match any of the existing references, usually because it has been provided by an external system. |
| Pallet | An alternative for 'Container'. The term pallet is used when the operation only uses portable platforms as the container for goods. |
| Package | An alternative for 'Container'. The term package is used when the operation only uses boxes or wrapping as containers for goods. |
| Package Code | A code representing the type of 'Container'. |
| Package Desc | A description of the type of 'Container'. |
| Product Code | A code which identifies what a product is. |
| Item | A generic term for any individual item that can be collected or delivered. An item can represent a 'Container' or a 'Product'. This can also be used as an alternative for 'Container' when the operation only treats the goods as individual items, i.e. not as identifiable products. |
| Service Item | An item which will be serviced by a service job. See action 'Service'. |
| Issue Life | The time after which an item is no longer fit for purpose. |
| Pack Size; Case Quantity | A product may consist of a full quantity of items, inside a pack. The Pack Size (or Case Quantity) defines the amount of this product contained in a single pack. For example, if there are 85 items to deliver, with a pack size of 24, the number of full packs is determined to be 3 (24 * 3, or 72), with the remaining (13) being 'loose' quantity. This is displayed as "3/13" on the mobile application. |
| UOM; Item Type | Unit of Measure; The major (case) UOM. This can optionally be displayed on the mobile device when changing product quantities. |
| Product Type | A classification of the product being delivered. For example, a company may deliver 7 different mortar products and 80 different concrete slab products. The Product Types may be set to "MORTAR" and "SLABS". This may be used to attach additional configuration, changing the data required when collecting or delivering these product types. |
| Status Definitions | |
| Status | An indicator of how far through the processing a 'Job', 'Container' or 'Product' has progressed. |
| Pending | A status indicating that the processing has not yet started, but is required to be completed. |
| In Progress | A status indicating that processing has started but not yet finished. |
| Complete | A status indicating that the 'Job', 'Container' or 'Product' has been collected or delivered. |
| Complete (Amended) | A status indicating that the 'Job', 'Container' or 'Product' has been collected or delivered but that some changes or amendments have been made. This means that not everything that was planned to be collected or delivered was collected or delivered, some items may have been cancelled or some products may only have had some of the planned quantities collected or delivered. |
| Complete (Claused) | A status indicating that the processing has been finished but that a 'Clause' condition has been recorded for this item. |
| Claused | See 'Complete (Claused)' and action 'Clause'. |
| Cancelled | A status indicating that the processing of this item or job is no longer required. |
| Cancelled at Collection | A status indicating that the delivery of a container or product is no longer required because the associated collection of this container or product was cancelled. |
| Submitted | An optional status that applies only to a 'Job' and which occurs after the 'Job' has been completed. This indicates that any time and expenses information recorded for the 'Job' has been submitted back to the server and can no longer be altered. |
| Action Definitions | |
| Start | An action associated with a 'Job' meaning the driver is about to start the processing of this job or jobs. This action will mark the job(s) with a status of 'In Progress'. |
| Arrive | A conditional action associated with a 'Job' meaning the driver has arrived at the location the goods should be collected from or delivered to. |
| Continue | An action associated with a 'Job' meaning the driver has previously performed the 'Start' and/or 'Arrive' action and has exited the processing screen but is now going to continue the processing. |
| Collect | An action associated with a specific 'Container' or a 'Product' meaning the driver has collected the 'Container' or 'Product'. This action will mark the 'Container' or 'Product' with a status of 'Complete' or 'Complete (Amended)'. |
| Collect Claused | An action associated with a specific 'Container' or a 'Product' meaning the driver has collected the 'Container' or 'Product' but with a condition under which the collection was accepted. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'. |
| Deliver | An action associated with a specific 'Container' or a 'Product' meaning the driver has delivered the 'Container' or 'Product'. This action will mark the 'Container' or 'Product' with a status of 'Complete' or 'Complete (Amended)'. |
| Deliver Claused | An action associated with a specific 'Container' or a 'Product' meaning the driver has delivered the 'Container' or 'Product' but with a condition under which the delivery was accepted. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'. |
| Clause | An action associated with a specific 'Container' or a 'Product' that has already been collected or delivered meaning the collection or delivery has been accepted with a condition. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'. |
| Cancel | An action associated with a 'Job', 'Container' or 'Product' meaning the collection or delivery will not be performed for this 'Job', 'Container' or 'Product'. |
| Submit | An optional action which can conditionally be carried out after a 'Job' has been collection or delivered meaning that any/all required expense or time recording for this 'Job' has been completed and can be submitted back to the server. |
| Service | A service of a service item or items. Typically, Installation, Deinstallation or Service. The process of a service usually encompasses Pre- and Port-work checks, information gathering and diagnosis and resolution notes. Additional references (MC Refs) may also be captured. |
| Actioned | A general term describing completing a job. So, 'Actioned' may be used instead of 'Collected', 'Serviced', 'Delivered'. |
| Consolidate | The action of taking several jobs and linking them together, so they are actioned at the same time with one start, arrive and signature. |
| Deconsolidate | The action of taking a consolidation of jobs and breaking them down into the component jobs again. |
| Job Swap | The action of selecting an existing load not assigned to the user, and picking jobs to transfer onto the user's load. |
| Signature Capture | Usually the final action of a job, where the customer's name and signature are entered. |
| Other Definitions | |
| Reason Code | A code which represents the reason that a job was cancelled or an item was cancelled or claused. |
| Vehicle | The vehicle used for transporting the goods. |
| Vehicle Checks | Also Defect Checks. A series of questions representing the results of checks intended to ensure the vehicle is in an acceptable condition. |
| Metrics Entry | A series of questions to capture information either at the start or end of a 'Load'. |
| Driver | The person performing the collections or deliveries; the user of the device/application. |
| Engineer | The person performing the services; the user of the device/application. |
| Customer | The person/company the goods are being collected from or delivered to. |
| Signatory | The name of the person providing a signature. |
| T&Cs | Terms and Conditions. The T&Cs are shown when signatures are prompted for. The text of the T&Cs are defined in the system itself. |
| Transfer Load | A load select from which to swap jobs to the user's load. |
| Base | E.g. 'Return to Base'. Typically the depot from which the driver departed. |
| Unplanned Ad Hoc Collection | A collection job that is created by the driver, usually after delivering to a customer. |
| Ad Hoc Container Entry/Scanning | The process of adding containers (items) to a job that have not been pre-advised on the job. |
| Completion Report | POD, POC, Service/Work Report. |
| Load Assignment | The action of assigning a vehicle and/or a driver to a load. |
| Job Assignment | The action of putting jobs onto a load. |
| Collection/Delivery Windows; Access Windows | Periods of time between which it is acceptable to deliver or collect from that customer. This has limited use in the system, mostly for reporting purposes. |
| Location/Map Terms | |
| Lat-Longs; GPS Co-ordinates, GPS Position | Latitude and Longitude co-ordinates, specified together as a single entity, identifying the exact position of a location. There are multiple formats - CALIDUS ePOD uses decimal notation, for example "53.3490818,-2.8521498" identifies the OBS Logistics office building in Liverpool. |
| GPS | Global Positioning System; the satellite system used to obtain a GPS position, for use with navigation and location positioning. |
| Geocode; Reverse Geocode | Geocoding is the process of obtaining lat-longs from an address. Reverse Geocoding is the process obtaining an address from lat-longs. |
| Geofence; Geofence Break | A Geofence is a perimeter around a location. A Geofence Break occurs when a device passes through this perimeter on entry or exit from the location. |
A.3 Authorised By
Murray Middleton | OBS Project Manager | _____________________________ |
Debbie Kitchen | Customer Representative | _____________________________ |
