FS 314696 Allow Zero Quantity Products
Brett Martin
Allow Zero Quantity Products
CALIDUS ePOD
11th February 2014 - 0.1
Reference: FS 314696
Contents
Functional Overview
Client Requirement
The application requires a customised style created for Brett Martin.
The current functionality for collection or delivery of DU’s (products) which have a zero planned quantity needs to allow the setting of a zero or non-zero quantity.
Solution Overview
A Brett Martin style (with green/white colour scheme and a Brett martin logo) will be created.
The existing collection/delivery functionality for DU’s (products) with a zero planned quantity will be changed to allow a zero quantity to be entered when confirming a product.
Scope
- These changes will be made in the latest version of the CALIDUS ePOD product only.
- The changes will be made to the Android CALIDUS ePOD client only.
Set-up
Pre-requisites
There are no set-up pre-requisites specific to this development.
Menu Structure
There is no menu structure set-up required for this development.
Data
Once the new ‘Force Non-zero Product Quantities’ flag has been added to the job groups maintenance page this will need to be unchecked to allow zero quantities to be used for products with a zero planned quantity.
Functional Description
Database / Server
A new flag (called EPL_FORCE_PROD_QTY) will be added to the database on the job group record (EPOD_JOB_GROUPS) to allow the new “Force Non-Zero Product Quantities” option to be stored for a job group.
All data access functions for creating, updating or selecting a job group will be updated to include this new flag as will the XML request (used for sending the job group data to the PDA’s). This will store (and in the XML report) this value as “Y” if the option has been checked or “N” otherwise.
ePOD Admin
The admin web application includes a job groups maintenance page. This page uses a details pop-up (with multiple tabs) to allow the user to set the options associated with a job group.
This details pop-up will be changed to include a new “Force Non-Zero Product Quantities” flag. This flag will appear in the PDA tab of the details pop-up and will be a check-box style option (i.e. can be checked or not checked). This will allow the flag to be set for new job groups or changed for existing job groups. There will not be any functionality to allow the user to search for job groups based on this flag.
Android Client
PDA Login and Style
A new Brett martin style will be created. This will use green colouring for the buttons and heading sections within the application and the login page will include the Brett Martin logo.
PDA Login and Style
A new Brett martin style will be created. This will use green colouring for the buttons and heading sections within the application and the login page will include the Brett Martin logo.
Job Details Product Tab
When processing a delivery or collection job which contains products (DU’s) the PDA will include a products tab which will list the products for this job. The user can select a product to collect / deliver by clicking or long-pressing on the product in the products list (and the selecting the deliver or collect option), entering the product code in the product text box or scanning the product code.
When clicking or long-pressing a product in the products list the user is either taken to the set product quantity screen or presented with a list of options.
If the product has a non-zero planned quantity (i.e. the PDA has already been informed of the quantity that should be delivered or collected) then clicking or long-pressing on a product will display list of the following options: Deliver or Collect – Depending on whether this is a delivery or a collection job. Selecting this option will mark this product as having the planned quantity delivered or collected. Change Quantity – Selecting this option allows the user to set the quantity to be delivered or collected, along with a reason for the discrepancy from the planned quantity and confirm the delivery/collection. Cancel – Selecting this option allows the user to specify a reason for the cancellation and cancel the delivery/collection of this product. Close – Selecting this option closes the options list with making any changes.
This list of options will not be changed.
If the product had a zero planned quantity then clicking the product would call the set product quantity screen to allow the user to set the quantity being delivered or collected and confirm the delivery/collection (see next section for details on the set product quantity screen).
If the product had a zero planned quantity then long-pressing on a product will display list of options. This list does not currently include a deliver/collect option and does include a comments option (not required for the Brett Martin functionality). This will be changed to add the deliver/collect option and remove the comments option for Brett Martin users. This will mean the list will show the following options:
Deliver or Collect – Depending on whether this is a delivery or a collection job. Selecting this option will call the set product quantity screen, i.e. the same clicking on the product (see next section for details on the set quantity screen). Cancel – Selecting this option allows the user to specify a reason for the cancellation and cancel the delivery/collection of this product. Close – Selecting this option closes the options list with making any changes.
Job Details Product Tab
When called this page allows the user to set the quantity for a product and confirm it as delivered or collected. This page is only called for products with a zero planned quantity (i.e. where the quantity is not known in advance).
The current functionality will only allow the product to be confirmed as delivered or collected once a non-zero quantity has been entered.
This will be changed so that the new ‘Force Non-Zero Product Quantities’ flag for the job group associated with this job will determine if zero is accepted as a valid value. If this flag has been set (i.e. checked in the maintenance page) then the system will continue to force the user to enter a non-zero quantity before allowing confirmation. If this flag is not set (i.e. is un-checked in the maintenance screen) then this screen will allow the user to confirm the delivery / collection of this product if they have entered a numeric value, including zero, for the quantity.
In order to confirm the delivery / collection the user will have to enter a quantity, i.e. this can not be left blank (regardless of the ‘Force Non-Zero Product Quantities’). The page will only allow the confirmation if the value is a numeric integer value, this can not contain characters or decimal places.
Appendix C: 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 | 0.75 | 0 | £0.00 |
| Technical Specification | 0.00 | 0 | £0.00 |
| Development | 2.75 | 0 | £0.00 |
| Testing and Release | 0.50 | 0 | £0.00 |
| Implementation | 0.00 | 0 | £0.00 |
| Project Management | First argument to "number_format" must be a number. | 0 | £First argument to "number_format" must be a number. |
| TOTAL | First argument to "number_format" must be a number. | £First argument to "number_format" must be a number. | |
| Estimate excludes training, release to live and go live support. |
C.1 References
| Ref No | Document Title & ID | Version | Date |
| 1 | UG 291094 EPOD Admin User Guide | 2.0 | 4/4/2012 |
| 2 | UG 291097 EPOD Client User Guide | 3.0 | 23/4/2013 |
| 3 | REQ 313776 Brett Martin ePOD Requirements | 0.2 | 12/12/2013 |
C.2 Glossary
| Term | Definition |
|---|---|
| EPOD | Electronic Proof of Delivery. The OBS EPOD system is CALIDUS ePOD. |
| CALIDUS eSERV | The OBS mobile system to complete Service functionality in the field. This is part of the CALIDUS ePOD system. |
| PDA | The mobile device on which the C-ePOD system will run in the field. This can be a Phone, EDA or industrial PDA, running Android. |
| DAL | Data Access Layer. A mechanism for accessing data by the system that is removed from the application, allowing for simplified access and providing protection to the data, as only approved DAL methods can be used to modify it. |
| GPS | Global Positioning System. A mechanism of retrieving accurate positioning information in the form of Latitude and Longitude (Lat-Long) co-ordinates from a device. |
| GPRS, 3G, HSDPA, Data Service | All terms referring to mobile device network connectivity, and the speed at which the device connects to the internet. |
C.3 Authorised By
Julie Scott | OBS Project Manager | _____________________________ |
