FS 340549 PROD-73 Add Multiple Photos to EPOD Export

From Calidus HUB





Aptean Logo.png







OBS Logistics

Add Multiple Photos to EPOD Export

CALIDUS ePOD

6th February 2017 - 0.1
Reference: FS 340549 PROD-73











































Functional Overview

Client Requirement

Since the product development of multiple photo capture within the processing of a job, the export process does not include these any more. The export must be modified to include these in a new structure under EPOD_JOB.


Solution Overview

The device will indicate at all times when updating a job as complete whether there are photos to be provided for the job and for every level under the job.

The server will create blank keyed records off this information, and will then attach the photos to the blanks created as they arrive, marking them as complete when completed.

The standard job export will be modified to export this Photo information at the Job level when exporting, checking configuration of the site to determine whether it should export them at all, just with key values, incrementally when complete, or only when the all photos for the job are complete.

A new webservice export method will be created so that external systems can request photos on demand through a variety of requests, indicated by the key values passed in on the request.


Scope

This functionality will be created in the latest version of the CALIDUS ePOD/eServ server and mobile application.


Set-up

Pre-requisites

None

Menu Structure

None

Data

None

Functional Description

Photo Export XML and Usage

A new XML tag will be added to the export - EPOD_PHOTOS. This will contain a collection of EPOD_PHOTO tags. This tag will contain all photos related to the job of any type. 

   <EPOD_PHOTO>
       <EPL_PHOTO_ID></EPL_PHOTO_ID>
       <EPL_DESCRIPTION></EPL_DESCRIPTION>
       <EPL_PHOTO></EPL_PHOTO>
       <EPL_LAST_CHANGED_DATE></EPL_LAST_CHANGED_DATE>
       <EPL_LAST_CHANGED_TIME></EPL_LAST_CHANGED_TIME>
       <EPL_SITE_ID></EPL_SITE_ID>
       <EPL_IMAGE_TYPE></EPL_IMAGE_TYPE>
       <EPL_KEYVAL_1></EPL_KEYVAL_1>
       <EPL_KEYVAL_2></EPL_KEYVAL_2>
       <EPL_KEYVAL_3></EPL_KEYVAL_3>
       <EPL_KEYVAL_4></EPL_KEYVAL_4>
       <EPL_KEYVAL_5></EPL_KEYVAL_5>
   </EPOD_PHOTO>

The details are:

  • EPL_PHOTO_ID - a unique identifier of the photo.
  • EPL_DESCRIPTION - a comment entered against the photo when taken.
  • EPL_PHOTO - the photo, in BASE64-encoded JPEG format.
  • EPL_LAST_CHANGED_DATE - the date the photo was updated
  • EPL_LAST_CHANGED_TIME - the time the photo was updated
  • EPL_SITE_ID - the unique site ID.
  • EPL_IMAGE_TYPE - the type of image - see later
  • EPL_KEYVAL_1 - key values based on the type.
  • EPL_KEYVAL_2 - key values based on the type.
  • EPL_KEYVAL_3 - key values based on the type.
  • EPL_KEYVAL_4 - key values based on the type.
  • EPL_KEYVAL_5 - key values based on the type.


Image types and key values are as follows:

EPL_IMAGE_TYPE Description EPL_KEYVAL_1 EPL_KEYVAL_2 EPL_KEYVAL_3 EPL_KEYVAL_4 EPL_KEYVAL_5
J Job Photo. EPL_JOB_ID        
JU/JU1/JU2/JU3 Job UDF EPL_JOB_ID UDF Item ID      
C Container EPL_JOB_ID EPL_CONTAINER_ID      
CU Container UDF EPL_JOB_ID EPL_CONTAINER_ID      
P Product EPL_JOB_ID EPL_CONTAINER_ID EPL_PRODUCT_CODE EPL_SEQUENCE  
PU Product UDF EPL_JOB_ID EPL_CONTAINER_ID EPL_PRODUCT_CODE EPL_SEQUENCE UDF Item ID
S Service Item EPL_JOB_ID EPL_SERVICE_ID      
SIU Service Item Info UDF EPL_JOB_ID EPL_SERVICE_ID UDF Item ID    
SPR Service Item Prework UDF EPL_JOB_ID EPL_SERVICE_ID UDF Item ID    
SPO Service Item Postwork UDF EPL_JOB_ID EPL_SERVICE_ID UDF Item ID    
SDU Service Item Diagnosis UDF EPL_JOB_ID EPL_SERVICE_ID UDF Item ID    
LSU Load Start Metrics UDF EPL_LOAD_ID UDF Item ID      
LEU Load End Metrics UDF EPL_LOAD_ID UDF Item ID      
VC Vehicle Checks EPL_VEHICLE_ID EPL_VEHICLE_CHECK_DATE
EPL_VEHICLE_CHECK_TIME		 UDF Item ID    


Database/DAL

A new Site parameter will control how Job photos are exported. This parameter will be called EPL_EXPORT_JOB_PHOTO_FLAG, will be a single character value and will have the following values:

  • N - Not exported
  • Y - Job exported when all photos received.
  • P - Job exported when ready and when any photos are received
  • K - Job exported with Photo Key values only.

A new Site parameter will control how Load photos are exported. This parameter will be called EPL_EXPORT_LOAD_PHOTO_FLAG, will be a single character value and will have the following values:

  • N - Not exported
  • Y - Load exported when all photos received.
  • P - Load exported when ready and when any photos are received
  • K - Load exported with Photo Key values only.

The EPOD_SITE DAL object and all database procedures will be modified to retrieve, modify or create these flags. It is not required that these flags be used as part of the selection criteria when selecting Site records.


The EPOD_LOAD DAL object requires changing to check the new Site flag EPL_EXPORT_LOAD_PHOTO_FLAG passed into the creation of Load XML for export (through GetLoadsXML and ToXElement) to include photos if required. The photos at Load Start and End Metrics would need to be included here in a new EPOD_PHOTOS tag.


The EPOD_JOB DAL object requires changing to check the new Site flag EPL_EXPORT_JOB_PHOTO_FLAG passed into the creation of Load XML for export (through GetJobsXML and ToXElement) to include photos if required. All photos pertaining to the Job and child elements would be included here.


Admin

The Site Admin screen will be modified to add these new flags to the screen.

These flags will be added to the Admin tab on the Site maintenance form site_header.aspx. The "Import" label will be modified to "Import/Export" and the 2 new flags added under that section.

  • EPL_EXPORT_JOB_PHOTO_FLAG - added with the label "Export Job Photos" as a drop-down list of the values above.
  • EPL_EXPORT_LOAD_PHOTO_FLAG - added with the label "Export Load Photos" as a drop-down list of the values above.

The values in the drop-down lists will be set from the EPOD_LISTS and EPOD_LIST_ITEMS tables, as standard.

The form will be modified to save, create and amend data in these flags.


Mobile Device Application

The device application will be modified to send back the key values of the photos for the job within the Job Update Request, as well as sending the photos separately. 

   <EPOD_PHOTOS>
       <EPOD_PHOTO>
           <EPL_DEVICE_PHOTO_ID></EPL_PHOTO_ID>
           <EPL_DESCRIPTION></EPL_DESCRIPTION>
           <EPL_SITE_ID></EPL_SITE_ID>
           <EPL_IMAGE_TYPE></EPL_IMAGE_TYPE>
           <EPL_KEYVAL_1></EPL_KEYVAL_1>
           <EPL_KEYVAL_2></EPL_KEYVAL_2>
           <EPL_KEYVAL_3></EPL_KEYVAL_3>
           <EPL_KEYVAL_4></EPL_KEYVAL_4>
           <EPL_KEYVAL_5></EPL_KEYVAL_5>
       </EPOD_PHOTO>
       <EPOD_PHOTO>
           ...
       </EPOD_PHOTO>
   </EPOD_PHOTOS>

An EPOD_PHOTO tag will be sent back per EPOD_PHOTO for the EPL_JOB_ID, regardless of type. If no photos have been taken for the job, the EPOD_PHOTOS tag need not be included.


The device application will be modified to send back the key values of the photos for the Load within the Load Update Request, as well as sending the photos separately, in the same way as the above Job Update is modified.


Server Webservices from Device

The server Job Update request processor in the Calidus_ePOD.asmx webservice will recognise this content and create EPOD_PHOTO records for each EPOD_PHOTO tag, recording the details and marking the photos as not yet received. If the EPOD_PHOTOS tag does not exist, no records will be created.

When received and complete, the processor will mark the job as not exported (EPL_XFER_FLAG) if the new Site EPL_EXPORT_JOB_PHOTO_FLAG parameter is set to "P".


The server Load Update request processor in the Calidus_ePOD.asmx webservice will recognise this content and create EPOD_PHOTO records for each EPOD_PHOTO tag, recording the details and marking the photos as not yet received. If the EPOD_PHOTOS tag does not exist, no records will be created.

When received and complete, the processor will mark the load as not exported (EPL_XFER_FLAG) if the new Site EPL_EXPORT_LOAD_PHOTO_FLAG parameter is set to "P".

Note Note: The changes to the EPOD_LOAD and EPOD_JOB DAL objects for creation of Load and Job XML should take care of this requirement.


The server Photo Request processor in the Calidus_ePOD.asmx webservice will update these records when received from the device. If no Photo record exists for the device Photo ID, one will be created for it.


Auto-Export

The Job export process will check the new Site flag EPL_EXPORT_JOB_PHOTO_FLAG when building XML for a job to export:

  • N - Do not include the EPOD_PHOTOS tag at all.
  • Y - Only process the job if all photos for the job have EPL_COMPLETE set to "Y".
  • P - Export with all photos with EPL_COMPLETE set to "Y" only.
  • K - Job exported with Photo Key values only.

The existing tags at Job, Product and Container level for photos (EPL_PHOTO_ID, EPL_PHOTO and EPL_PHOTO_DESCRIPTION) will be removed from the export.


The Load export process will check the new Site flag EPL_EXPORT_LOAD_PHOTO_FLAG when building XML for a job to export:

  • N - Do not include the EPOD_PHOTOS tag at all.
  • Y - Only process the Load if all photos for the job have EPL_COMPLETE set to "Y".
  • P - Export with all photos with EPL_COMPLETE set to "Y" only.
  • K - Load exported with Photo Key values only.


The Export XML XSD files will be modified to reflect the changes above. The documentation for this version will be updated when built.


Server Export Webservices

The existing Job and Load export webservice methods within ePOD_dataservice.asmx and ePOD_dataservice2.asmx will be modified to include this EPOD_PHOTOS export in the same way as the auto-export. This affects the following webservice methods:

  • EPOD_XML_EXPORT_JOB
  • EPOD_XML_EXPORT_JOB_DATE
  • EPOD_XML_EXPORT_JOB_DATE_RANGE
  • EPOD_XML_EXPORT_LOAD
  • EPOD_XML_EXPORT_LOAD_DATE
  • EPOD_XML_EXPORT_LOAD_DATE_RANGE

Note Note: The changes to the EPOD_LOAD and EPOD_JOB DAL objects for creation of Load and Job XML should take care of this requirement.


The Export XML XSD files will be modified to reflect the changes above. The documentation for this version will be updated when built.


A new webservice export request will be created on ePOD_dataservice.asmx and ePOD_dataservice2.asmx. This method will be called EPOD_XML_EXPORT_PHOTO.

The request will be sent in the following format: 

   <EPOD_EXPORT_PHOTO EPL_SITE_ID="" EPL_USER_ID="" EPL_USER_PASSWORD="">
       <EPL_SITE_ID></EPL_SITE_ID>
       <EPL_JOB_ID></EPL_JOB_ID>
       <EPL_LOAD_ID></EPL_LOAD_ID>
       <EPL_JOB_CODE></EPL_JOB_CODE>
       <EPL_JOB_TYPE></EPL_JOB_TYPE>
       <EPL_CONTAINER_ID></EPL_CONTAINER_ID>
       <EPL_PRODUCT_CODE></EPL_PRODUCT_CODE>
       <EPL_SEQUENCE></EPL_SEQUENCE>
       <EPL_SERVICE_ID></EPL_SERVICE_ID>
       <EPL_PHOTO_TYPE></EPL_PHOTO_TYPE>
       <EPL_PHOTO_ID></EPL_PHOTO_ID>
       <EPL_UDF_ID></EPL_UDF_ID>
   </EPOD_EXPORT_PHOTO>

The request can be used in the following ways:

To export a single photo determined by the Photo ID, provide Site and Photo ID.

To export photos taken at a Load level (during Load Metrics), provide the site and the load ID. 

   <EPOD_EXPORT_PHOTO EPL_SITE_ID="" EPL_USER_ID="" EPL_USER_PASSWORD="">
       <EPL_SITE_ID></EPL_SITE_ID>
       <EPL_LOAD_ID></EPL_LOAD_ID>
   </EPOD_EXPORT_PHOTO>

Only photos at load-level will be exported i.e. LSU and LEU types. To export just one of the types, identify the photo type in the request: 

   <EPOD_EXPORT_PHOTO EPL_SITE_ID="" EPL_USER_ID="" EPL_USER_PASSWORD="">
       <EPL_SITE_ID></EPL_SITE_ID>
       <EPL_LOAD_ID></EPL_LOAD_ID>
       <EPL_PHOTO_TYPE></EPL_PHOTO_TYPE>
   </EPOD_EXPORT_PHOTO>

Photos may be exported from a job-level down in a group, by identifying the key values and omitting the type.

To export all photos of any type for a Job and all levels below, provide the site and either the job ID or the Job Code, Load ID and job type. 

   <EPOD_EXPORT_PHOTO EPL_SITE_ID="" EPL_USER_ID="" EPL_USER_PASSWORD="">
       <EPL_SITE_ID></EPL_SITE_ID>
       <EPL_JOB_ID></EPL_JOB_ID>
   </EPOD_EXPORT_PHOTO> 

   <EPOD_EXPORT_PHOTO EPL_SITE_ID="" EPL_USER_ID="" EPL_USER_PASSWORD="">
       <EPL_SITE_ID></EPL_SITE_ID>
       <EPL_LOAD_ID></EPL_LOAD_ID>
       <EPL_JOB_CODE></EPL_JOB_CODE>
       <EPL_JOB_TYPE></EPL_JOB_TYPE>
   </EPOD_EXPORT_PHOTO>

These will export all photos for any type, including all photos for the Job, Container and Product, of all types, including UDF photos.

To export all photos for a container and below, provide Site, identify the job as above through the Job ID or Load, Job Code and Job Type, and provide the container ID.

To export all photos for a product within a container, provide Site, identify the job as above through the Job ID or Load, Job Code and Job Type, and provide the container ID, Product Code and Sequence.

To export all photos for a loose product, provide Site, identify the job as above through the Job ID or Load, Job Code and Job Type, and provide the Product Code and Sequence.


To export photos of a particular type, the Photo type can be provided. For example:

To export only job type photos, provide the site, identify the job through the Job ID or Load, Job Code and Job Type, and set the Photo Type.

  • "J" provides photos taken against the job, either when cancelling the job, or taking Job Photos at the end of the process.
  • "JU" will provide photos taken as part of Job UDF.

The same process can be used when requesting photos of specific types against any level:

  • Container - identify the job and container, and set the type to "C" (when cancelling containers) or CU (for container UDF).
  • Product within container - identify the job, container, product and sequence, and set the type to "P" (when cancelling or changing the quantity of products) or PU (for product UDF).
  • Loose Product - identify the job, product and sequence, and set the type to "P" (when cancelling or changing the quantity of products) or PU (for product UDF).


To export a photo taken as part of UDF, provide the UDF Field ID, for example:

To export a photo taken with field WEIGHBRIDGE_NO in Job UDF, specify the Site, identify the job through the Job ID or Load, Job Code and Job Type, identify the photo type as "JU", and specify the UDF ID as "WEIGHBRIDGE_NO".

To export a photo taken with field CHECK1 in Container UDF, specify the Site, identify the job through the Job ID or Load, Job Code and Job Type, identify the Container ID, supply the photo type as "CU", and specify the UDF ID as "CHECK1".


It is expected that this webservice request will be most commonly used to either retrieve a single photo through the provided photo ID, or through obtaining all photos of all photo types for a specific job.


The webservice will respond with the following format:

For failures to retrieve any photo for any reason: 

   <EPOD_EXPORT_PHOTO_RESPONSE RESULT="NAK">
       <ERRORS>
           <ERROR error="Description of the error"/>
       </ERRORS>
   </EPOD_EXPORT_PHOTO_RESPONSE>

All errors should be captured and included in the response. Specific errors captured should be:

  • Site not found - if the Site ID provided does not exist.
  • Load not found - if the Load ID provided does not exist.
  • Job not found - if the Job does not exist, found through either the site and job ID, or through the Site, Load, Job Code and Job Type.
  • Container not found - if the Container ID provided does not exist on the job found.
  • Product not found - if the Product Code and Sequence provided does not exist on the job found. If the container ID is provided, this should search the container. If one is not provided, the container should default to the loose products container.
  • Photo not found - if either a photo is not found matching the container
  • Photo not complete - only photos complete should be returned on the request. If a photo is requested that is not complete and this is the only photo, this error should be returned.

For returned photos, the following structure should be used: 

   <EPOD_EXPORT_PHOTO_RESPONSE RESULT="ACK">
       <EPOD_PHOTOS>
           <EPOD_PHOTO>
               <EPL_PHOTO_ID></EPL_PHOTO_ID>
               <EPL_DESCRIPTION></EPL_DESCRIPTION>
               <EPL_PHOTO></EPL_PHOTO>
               <EPL_LAST_CHANGED_DATE></EPL_LAST_CHANGED_DATE>
               <EPL_LAST_CHANGED_TIME></EPL_LAST_CHANGED_TIME>
               <EPL_SITE_ID></EPL_SITE_ID>
               <EPL_IMAGE_TYPE></EPL_IMAGE_TYPE>
               <EPL_KEYVAL_1></EPL_KEYVAL_1>
               <EPL_KEYVAL_2></EPL_KEYVAL_2>
               <EPL_KEYVAL_3></EPL_KEYVAL_3>
               <EPL_KEYVAL_4></EPL_KEYVAL_4>
               <EPL_KEYVAL_5></EPL_KEYVAL_5>
           </EPOD_PHOTO>
           <EPOD_PHOTO>
               ...
           </EPOD_PHOTO>
       </EPOD_PHOTOS>
   </EPOD_EXPORT_PHOTO_RESPONSE>

All complete photos found based on the provided criteria will be exported as an EPOD_PHOTO tag under the EPOD_PHOTOS tag. The EPL_PHOTO item will be set to be the Base64-encoded JPEG.


Appendix A: TEST PLAN

Test Script / Scenario ReferenceAdd Multiple Photos to EPOD ExportCall Number(s): 340549 PROD-73
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 B: Quote & Document References

Cost Details
Activity No. of Days Rate per Day (£) Cost (£ Exc. VAT)
Requirements 0.00 0 £0.00
Change Request Evaluation 0.00 0 £0.00
Functional Specification 1.75 0 £0.00
Technical Specification 0.00 0 £0.00
Development 7.50 0 £0.00
Testing and Release 1.50 0 £0.00
Implementation 0.25 0 £0.00
Project Management 0.50 0 £0.00
 
TOTAL 11.50   £0.00
Estimate excludes training, release to live and go live support.

B.1 References

Ref NoDocument Title & IDVersionDate
1   


B.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.


B.3 Authorised By


Neil Appadu
OBS Logistics Representative		_____________________________
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/OBS/index.php?title=FS_340549_PROD-73_Add_Multiple_Photos_to_EPOD_Export&oldid=4083’