FS 356080 Add Parameters for Additional Data

From Calidus HUB
Revision as of 15:41, 4 March 2019 by Anw (talk | contribs) (v0.1 - Initial Draft)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)





Aptean Logo.png







Rory J Holbrook

Add Parameters for Additional Data

Functional Specification

4th March 2019 - 0.1
Reference: FS 356080















FUNCTIONAL OVERVIEW

Client Requirement

It has been identified that the EPOD database requires the ability to add user-defined parameters against static data, such as customers.


Solution Overview

Parameter Master Configuration will be added to the CALIDUS ePOD Admin console. This will allow users to define customer parameters or any ID or type for the site.

The Admin Customer Maintenance screen will allow users to enter parameter values against the configured master parameters.


These will be available for the Configurable POD report to access and use.


Scope

The changes will be made in the latest versions of CALIDUS ePOD. The changes will be available to 4.0 (existing version) and 4.5 (next version) customers.

Specifically, this is required against customer records at this time, to fulfil associated customer demands. However, the functionality will be written in such a way that it may be used to extend other tables as demanded, for example:

  • Jobs
  • Vehicles

This initial development will create the basic requirements of parameters and master definitions for customers only - additional developments will be required if this is to be extended to other tables at a later time.

At this time, customer parameters may only be defined through the CALIDUS ePOD Admin customer screen - they may not be defined through the any interface (CSV, XML, web service or manual customer upload).


Impact

Most of these changes are required before POD reports requiring customer parameters can be created. Specifically, the following is dependent on these changes:

  • 355526 Rory Holbrook POD Notes


CONFIGURATION SET-UP

Pre-requisites

None.


Menu Structure

A new Administration menu option "Parameter Master" will be added to the Administration menu in CALIDUS ePOD Admin console.


Data

Warning Warning:

  • EPOD_DATA_LISTS
  • EPOD_DATA_LIST_ITEMS


Implementation Advice

None.


FUNCTIONAL DESCRIPTION

Admin Modifications

Customer Code Maintenance

The existing Customer Code Maintenance screen will be modified to allow the users to enter parameters against a customer when creating or editing them, or to edit existing parameters.


When the user creates a new customer or edits an existing customer, the screen shows the add/edit pop-up panel.

This will be modified to have a new Parameters tab added to it, to the right of any existing tabs.

This will work similarly to the Time, Expenses and Charges tab on the Job Details pop-up panel.


When the user clicks this tab, the screen will display all parameters associated to that customer.

The tab will display the parameters in a parameter results table, with the following columns:

  • Parameter - the master label.
  • Description - the master description.
  • Value - the parameter value, a text box capable of being edited.
  • Actions.

The Actions column will be displayed only if the system is displaying action buttons. This will include buttons for the following:

  • Delete - This button will have pop-up help "Delete this record".
  • Edit - This button will have pop-up help "Edit this record".


A row will be present below the table:

  • Parameter - A drop-down list of parameters capable of being added to customers. A default value of "Select a Parameter" will be at the top of the list. No other fields or buttons on this row may be entered until a value is selected in this drop-down list.
  • Description - the master description, populated when the parameter is selected from the drop-down list. The pop-up help text will be populated with the long description.
  • Value - the parameter value, a text box capable of being edited.
  • Actions - consisting of the following buttons:
    • Add - a button to add the new parameter. This button will have pop-up help "Add this record".

When the user selects a new parameter type from the drop-down list, the panel will enable the Value text box and Add button.

When the user clicks Add, the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be added.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table.


To edit an existing parameter, the user will press the Edit button against that parameter row in the parameter results table.

The panel will then refresh the row, showing a text box for the amendment of the value. The Action column for this row will have additional buttons:

  • Save - This button will have pop-up help "Save changes".
  • Discard - This button will have pop-up help "Discard changes".

The user may then edit the value in the row.

If the user clicks the Discard button, the parameter results table will refresh, with the row no longer being edited.

When the user clicks the Save button, the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be saved.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table with the row no longer being edited.

If the user clicks the Delete button against an exiting parameter, the screen will display a confirmation dialogue to ask the user if they are sure. If the user confirms, the screen will delete the record and refresh the parameter results table.


New Master Parameter Maintenance Screen

A new screen will be created for the users to enter master parameter definitions.

The screen will allow the users to find and edit parameter master definitions or create a new parameter master definition.

A header bar will be displayed with the following elements:

  • Find button. This button will have pop-up help "Find records matching the entered criteria".
  • New button. This button will have pop-up help "Create a new record".
  • Status text, for showing messages.

The New button will only be displayed if the logged-on user has full admin authorisation.

The Find button will show the search criteria panel, which will also be displayed automatically on start-up of the screen.

The parameters that can be used are:

  • Parameter Code - Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only. Default value "".
  • Association - A drop-down list of values populated from EPOD_LIST_ITEMS. At this time only "EPOD_CUSTOMER" is supported. The drop-down list will also have a value "Select an Option", which denotes that no criterion value has been entered and is the default value.
  • Label - Text box entry. Default value "".
  • Description - Text box entry. Default value "".

The panel will also show the following buttons:

  • Clear - reset the search parameters to default values.
  • Search - perform a search with the criteria.

When the user presses Search, the screen will call the appropriate EPOD_ADM_PARAMETER_MASTER search method, passing in the search criteria entered by the user.

The returned values will be loaded to a data results table and displayed in a grid showing the following fields:

  • Parameter Code.
  • Association.
  • Label.
  • Description.
  • Actions

The Actions column will be displayed only if the system is displaying action buttons. This will include buttons for the following:

  • Select - pop-up the details of the selected row in a pop-up edit panel.

When clicking the New button, the screen will display a pop-up entry panel.


The pop-up panel displayed for entering new parameter master definitions or editing existing ones will be the same panel.

When creating or editing a new parameter master, the following fields are displayed on the pop-up panel:

  • Parameter Code - the name of the parameter. Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only.
  • Association - the table to which this parameter is associated. A drop-down list of values . At this time only "Customer" is supported.
  • Label - the label of the parameter. Text box entry, limited to 30 characters
  • Description - the description for the parameter. Text box entry, limited to 100 characters
  • Pop-up Help - the description for the parameter. Text area entry, limited to 2000 characters
  • Required - Check-box entry, defaulted to checked.
  • Active - Check-box entry, defaulted to checked.
  • Type - Drop-down list of values. At this time, only "TEXT" is supported.

If editing an existing definition, all fields will be disabled. When creating a new definition, all fields will be enabled.

The panel will also have the following buttons:

  • Edit - This button will have pop-up help "Edit this record". This button is displayed if editing an existing definition and the logged-on user has full admin authorisation. On clicking this button, the fields are enabled for entry, this button will be hidden and the Save, Exit and Delete buttons will be enabled.
  • Save - This button will have pop-up help "Save and Exit". This button is displayed when the Edit button is clicked or when creating a new master parameter definition. When clicked, the panel will close and the screen will save the new record or update the existing record. The results table will be refreshed.
  • Exit - This button will have pop-up help "Exit without saving". This button is displayed when the Edit button is clicked or when creating a new master parameter definition. When clicked, the panel will close. The results table will not refresh.
  • Delete - This button will have pop-up help "Delete". This button is displayed when the Edit button is clicked. When clicked, the screen will display a confirmation dialogue to ask the user if they are sure. If confirmed, the panel will close and the screen will delete the record.


TECHNICAL NOTES

Modules Changed

Module Name Module Type Notes
1 2 3


Table Updates

Name Type Nullable Default Storage Comments
1 2 3 4 5 6


Developer Notes

Database/DAL changes

The existing table EPOD_ADM_PARAMETER_VALUE will be modified so that the existing column APV_ID is set as an identity column, auto-incrementing the value. This will be the primary index, with any existing primary index relegated to a unique key.


Note Note: A new static class EPOD_PARAMETER_ASSOCIATIONS will be created in EPOD_UTILS.cs. At this time this will consist solely of the following: 

   public static string Customer = "EPOD_CUSTOMER";

This will be used whenever APV_ASSOCIATION value EPOD_CUSTOMER is required.


Parameter Master Definitions

This DAL object (EPOD_ADM_PARAMETER_MASTER.cs) will be modified for this change.

Note Note: The existing EPOD_ADM_PARAMETER_MASTER DAL object is incomplete. This will be completed, adding in methods to:

  • Select an existing EPOD_ADM_PARAMETER_MASTER record by code and association.
  • Delete an existing EPOD_ADM_PARAMETER_MASTER record.
  • Update an existing EPOD_ADM_PARAMETER_MASTER record.

A new public method GetParamsByAssociation will be created that will retrieve parameters for a specific site and table.

This method will:

  • Create an empty list of parameter masters.
  • Retrieve all parameter masters from the database where APM_SITE_ID is set to the passed in Site parameter and APV_ASSOCIATION is set to "EPOD_CUSTOMER".
  • If any records are found, create an EPOD_ADM_PARAMETER_MASTER object from the data row and add to the list.
  • Return the list.


Parameter Values

This DAL object (EPOD_ADM_PARAMETER_VALUE.cs) will be modified for this change.

Note Note: The existing EPOD_ADM_PARAMETER_VALUE DAL object is incomplete. This will be completed, adding in methods to:

  • Select an existing EPOD_ADM_PARAMETER_VALUE record by code, association and key.
  • Select an existing EPOD_ADM_PARAMETER_VALUE record by id.
  • Delete an existing EPOD_ADM_PARAMETER_VALUE record.
  • Update an existing EPOD_ADM_PARAMETER_VALUE record.

The constructor for the object (EPOD_ADM_PARAMETER_VALUE) will be modified to populate the ID of the parameter value found. This constructor will also retrieve the parameter master (EPOD_ADM_PARAMETER_MASTER) record into an EPOD_ADM_PARAMETER_MASTER DAL object read-only property for this object. This will be read into the object when creating a new parameter value or selecting an existing parameter value.

A new public method GetParamsForCustomer will be added to retrieve parameters for a specific site and customer.

This method will:

  • Create an empty list of parameters.
  • Retrieve all parameters from the database where APV_SITE_ID is set to the passed in Site parameter, APV_KEY is set to the passed in Customer parameter and APV_ASSOCIATION is set to "EPOD_CUSTOMER".
  • If any records are found, create an EPOD_ADM_PARAMETER_VALUE object from the data row and add to the list.
  • Return the list.

A new public method DeleteParamsForCustomer will be added to delete parameters for a specified site and customer. This method will:

  • delete all parameters from the database where APV_SITE_ID is set to the passed in Site parameter, APV_KEY is set to the passed in Customer parameter and APV_ASSOCIATION is set to "EPOD_CUSTOMER".


Customer

This DAL object (EPOD_CUSTOMER.cs) will be modified to add a list of parameters associated to this record.

A new property EPOD_ADM_PARAMETER_VALUES will be added as a list of DAL object EPOD_ADM_PARAMETER_VALUE.

This will be set to an empty list when creating a new instance of this object (in method SetEmptyDefault), or will be populated with the values retrieved for this customer (in method GetCustomer).

Method GetCustomer will set the new property to an empty list if this customer does not exist. If the customer does exist, it will call the method EPOD_ADM_PARAMETER_VALUE.GetParamsForCustomer, passing a connection, the site id and customer code.

The Delete method will be modified to delete any associated EPOD_ADM_PARAMETER_VALUE records associated to this customer, using the EPOD_ADM_PARAMETER_VALUE DAL object method DeleteParamsForCustomer.


Admin Modifications

Customer Code Maintenance

The existing Customer Code Maintenance screen (customer_maint.aspx) will be modified to allow the users to enter parameters against a customer when creating or editing them, or to edit existing parameters.


When the user creates a new customer or edits an existing customer, the screen shows the add/edit pop-up panel.

This will be modified to have a new Parameters tab added to it, to the right of any existing tabs.

This will work similarly to the Time, Expenses and Charges tab on the Job Details pop-up panel.


When the user clicks this tab, the screen will display all parameters associated to that customer, using the EPOD_CUSTOMER property EPOD_ADM_PARAMETER_VALUES as the data source. The tab will display the parameters in a parameter results table, with the following columns:

  • Parameter - the master label.
  • Description - the master description.
  • Value - the parameter value, a text box capable of being edited.
  • Actions.

The Actions column will be displayed only if the system is displaying action buttons. This will include buttons for the following:

  • Delete - This button will have pop-up help "Delete this record".
  • Edit - This button will have pop-up help "Edit this record".

Note Note: the property EPOD_ADM_PARAMETER_VALUES is a list of EPOD_ADM_PARAMETER_VALUE DAL objects. The EPOD_ADM_PARAMETER_VALUE DAL object itself contains a property EPOD_ADM_PARAMETER_MASTER, set from the associated EPOD_ADM_PARAMETER_MASTER DAL object. This property can be used to retrieve the parameter master properties required for the display on this table.

A row will be present below the table:

  • Parameter - A drop-down list of parameters capable of being added to customers. This will be populated from the EPOD_ADM_PARAMETER_MASTER table for records associated to the table EPOD_CUSTOMER for this site, only for active parameters (APM_ACTIVE_IND = 1). The drop-down list will have the APM_CODE as the value and APM_LABEL as the label. A default value of "Select a Parameter" will be at the top of the list. No other fields or buttons on this row may be entered until a value is selected in this drop-down list.
  • Description - the master description (APM_DESCRIPTION), populated when the parameter is selected from the drop-down list. The pop-up help text will be populated with the long description (APM_LONG_DESCRIPTION).
  • Value - the parameter value, a text box capable of being edited.
  • Actions - consisting of the following buttons:
    • Add - a button to add the new parameter. This button will have pop-up help "Add this record".

When the user selects a new parameter type from the drop-down list, the panel will enable the Value text box and Add button.

When the user clicks Add, the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be added.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table.


To edit an existing parameter, the user will press the Edit button against that parameter row in the parameter results table.

The panel will then refresh the row, showing a text box for the amendment of the value. The Action column for this row will have additional buttons:

  • Save - This button will have pop-up help "Save changes".
  • Discard - This button will have pop-up help "Discard changes".

The user may then edit the value in the row.

If the user clicks the Discard button, the parameter results table will refresh, with the row no longer being edited.

When the user clicks the Save button, the panel will check that the parameter value is populated if the parameter is required. If not, a pop-out validator will display that it is required and the parameter will not be saved.

If the parameter is optional or the user has entered a value, the panel will save the entry and refresh the parameter results table with the row no longer being edited.

If the user clicks the Delete button against an exiting parameter, the screen will display a confirmation dialogue to ask the user if they are sure. If the user confirms, the screen will delete the record and refresh the parameter results table.


New Master Parameter Maintenance Screen

A new screen will be created for the users to enter master parameter definitions.

The screen will allow the users to find and edit parameter master definitions or create a new parameter master definition.

A header bar will be displayed with the following elements:

  • Find button. This button will have pop-up help "Find records matching the entered criteria".
  • New button. This button will have pop-up help "Create a new record".
  • Status text, for showing messages.

The New button will only be displayed if the logged-on user has full admin authorisation.

The Find button will show the search criteria panel, which will also be displayed automatically on start-up of the screen.

The parameters that can be used are:

  • Parameter Code - Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only. Default value "".
  • Association - A drop-down list of values populated from EPOD_LIST_ITEMS. At this time only "EPOD_CUSTOMER" is supported. The drop-down list will also have a null value "Select an Option", which denotes that no criterion value has been entered and is the default value.
  • Label - Text box entry. Default value "".
  • Description - Text box entry. Default value "".

The panel will also show the following buttons:

  • Clear - reset the search parameters to default values.
  • Search - perform a search with the criteria.

When the user presses Search, the screen will call the appropriate EPOD_ADM_PARAMETER_MASTER search method, passing in the search criteria entered by the user.

The returned values will be loaded to a data results table and displayed in a grid showing the following fields:

  • Parameter Code.
  • Association.
  • Label.
  • Description.
  • Actions

The Actions column will be displayed only if the system is displaying action buttons. This will include buttons for the following:

  • Select - pop-up the details of the selected row in a pop-up edit panel.

When clicking the New button, the screen will display a pop-up entry panel.


The pop-up panel displayed for entering new parameter master definitions or editing existing ones will be the same panel.

When creating or editing a new parameter master, the following fields are displayed on the pop-up panel:

  • Parameter Code - APM_CODE - the name of the parameter. Text box entry, limited to 20 characters of type alpha, numeric, underscore and dash only.
  • Association - APM_ASSOCIATION - the table to which this parameter is associated. A drop-down list of values populated from EPOD_LIST_ITEMS. At this time only "EPOD_CUSTOMER" is supported.
  • Label - APM_LABEL - the label of the parameter. Text box entry, limited to 30 characters
  • Description - APM_DESCRIPTION - the description for the parameter. Text box entry, limited to 100 characters
  • Pop-up Help - APM_LONG_DESCRIPTION - the description for the parameter. Text area entry, limited to 2000 characters
  • Required - APM_REQUIRED_IND - 0 - not required, 1 - required. Default to 1. Check-box entry (1 is checked).
  • Active - APM_ACTIVE_IND - 1 - Active, 0 - Inactive. Default to 1. Check-box entry (1 is checked).
  • Type - APM_DATA_TYPE - Drop-down list of values populated from EPOD_LIST_ITEMS. At this time, only "TEXT" is supported.

If editing an existing definition, all fields will be disabled. When creating a new definition, all fields will be enabled.

The panel will also have the following buttons:

  • Edit - This button will have pop-up help "Edit this record". This button is displayed if editing an existing definition and the logged-on user has full admin authorisation. On clicking this button, the fields are enabled for entry, this button will be hidden and the Save, Exit and Delete buttons will be enabled.
  • Save - This button will have pop-up help "Save and Exit". This button is displayed when the Edit button is clicked or when creating a new master parameter definition. When clicked, the panel will close and the screen will save the new record or update the existing record. The results table will be refreshed.
  • Exit - This button will have pop-up help "Exit without saving". This button is displayed when the Edit button is clicked or when creating a new master parameter definition. When clicked, the panel will close. The results table will not refresh.
  • Delete - This button will have pop-up help "Delete". This button is displayed when the Edit button is clicked. When clicked, the screen will display a confirmation dialogue to ask the user if they are sure. If confirmed, the panel will close and the screen will delete the record.


When creating or editing a parameter master record, the following fields will be updated based on the selections of the user:

  • APM_CODE - the name of the parameter.
  • APM_ASSOCIATION - the table to which this parameter is associated.
  • APM_LABEL - the label of the parameter.
  • APM_DESCRIPTION - the description for the parameter.
  • APM_LONG_DESCRIPTION - the pop-up help for the parameter.
  • APM_REQUIRED_IND - 0 - not required, 1 - required.
  • APM_ACTIVE_IND - 1 - Active, 0 - Inactive.
  • APM_DATA_TYPE - "TEXT"

The following are automatically set when creating a new record or updating an existing record:

  • APM_CREATED_BY - Automatically set to user that created the parameter.
  • APM_CREATED_DATE - Automatically set when the parameter is created.
  • APM_LAST_UPDATED_BY - Automatically set to user that updated the parameter.
  • APM_LAST_UPDATED_DATE - Automatically set when the parameter is updated.
  • APM_UPDATE_COUNTER - automatically incremented when updated.
  • APM_SITE_ID - Set to the site ID of the user when creating the parameter.

All other elements are not to be added at this time - they will be used for future development.

  • APM_ICON
  • APM_LONG_DESCRIPTION
  • APM_CATEGORY_CODE
  • APM_SEQUENCE
  • APM_MULTIPLE_IND
  • APM_DISPLAY_IND
  • APM_DISPLAY_TYPE
  • APM_VALUE_TYPE
  • APM_VALUES
  • APM_VALUE_SOURCE
  • APM_LAST_ACTIVE_CHANGE_BY
  • APM_LAST_ACTIVE_CHANGE_DATE
  • APM_LAST_PROCESS_ID
  • APM_GROUP_CODE
  • APM_VALUES_DESC


TEST PLAN

Test Script / Scenario ReferenceAdd Parameters for Additional DataCall Number(s): 356080
Test Script / Scenario Descriptiondescription of what is to be achievedPASS / ISSUES / FAIL
Menu AccessWhere on the menus the item can be found 
Pre-requisitesThe prerequisites of the testTested By:
 
Test ObjectiveThe details of what each group of tests is to achieveDate:
 



Step Action Result Remarks P/F
1 Area being tested in this cycle      
  Any notes or prerequisites for the tests following.      
1.01 The actions to follow The expected result    
1.02 The actions to follow The expected result    
1.03 The actions to follow The expected result    


APPENDIX A: QUOTE & DOCUMENT HISTORY

Cost Details
Activity Estimate
No. of Days		 No. of Days Rate per Day (£) Cost (£ Exc. VAT)
Requirements 0.00 0.00 850 £0.00
Change Request Evaluation 0.50 0.50 850 £425.00
Functional Specification 1.50 1.50 850 £1,275.00
Technical Specification 0.00 0.00 850 £0.00
Development 6.00 6.00 850 £5,100.00
Testing and Release 1.25 1.25 850 £1,062.50
Implementation 0.50 0.50 850 £425.00
Project Management 0.50 0.50 850 £425.00
 
TOTAL 10.25 10.25   £8,712.50
Estimate excludes training, release to live and go live support.

References

Ref NoDocument Title & IDVersionDate
1Reference10.126/02/2019


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.


Authorised By


Murray Middleton
OBS Project Manager
_____________________________

Rev2
Customer Representative
_____________________________
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=FS_356080_Add_Parameters_for_Additional_Data&oldid=7017’