FS 313304 BIU Bank Defect
BIU Group
BIU Bank Defect
CALIDUS ePOD
2nd December 2013 - 0.2
Reference: FS 313304 312018-5
Contents
Functional Overview
Client Requirement
For Job Type 1 - Standard Planned Collection of Recycled clothing from Supermarket banks
- Choose collection job
- Review job as normal and confirm arrival. Co-Pilot has not been purchased yet but is on the table.
- Containers will represent banks. Client will click on or scan each container to confirm how many bags have been collected. If container is so damaged that no bags will be collected,the container can be cancelled using the existing cancellation process. If the bank is damaged but bags can still be collected then the container should be claused. A claused container will still need a picture.
- Default qty for product in container is 0. User must choose change qty to indicate how many bags have been collected. No reason code should be entered at this stage.
- No signature is required
- At the end of a load that contains these collections, the user must enter weighbridge ticket no (up to five numeric digits) and weight (up to five numeric digits)
Solution Overview
In the Collection process:
- If the bank is damaged but bags can still be collected, then the user can reflect this before entering the quantity by long-pressing and choosing the Comment option. This will pop open a similar screen to cancellation, but no reason code will be prompted for. The user will be able to enter some notes and take an image. The user will also be able to confirm the quantity at this time, or use the existing quantity entry process (clicking the line) after entering the description.
These comments and images will be visible in the CALIDUS ePOD system, and will be exported as part of the generic XML export process.
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
Menu Structure
Data
Functional Description
Database/DAL
The EPOD_PRODUCT table will be modified to add the following new field:
- EPL_CUST_COMMENTS, a 200 character text field.
Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
- EPOD_PRODUCT_INSERT
- EPOD_PRODUCT_SELECT
- EPOD_PRODUCT_UPDATE
The existing EPOD_PRODUCT DAL object will be changed to:
- Export the new field in XML requests
- Read the new field
Note: It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.
Note: The new field EPL_CUST_COMMENTS will be added to the EPOD_PRODUCT tag before EPL_LAST_CHANGED_DATE, as follows:
<EPOD_PRODUCT> <EPL_SITE_ID></EPL_SITE_ID> <EPL_JOB_ID></EPL_JOB_ID> <EPL_CONTAINER_ID></EPL_CONTAINER_ID> <EPL_PRODUCT_CODE></EPL_PRODUCT_CODE> <EPL_SEQUENCE></EPL_SEQUENCE> <EPL_DESCRIPTION></EPL_DESCRIPTION> <EPL_DESCRIPTION_LONG></EPL_DESCRIPTION_LONG> <EPL_PRODUCT_QTY_PLANNED>0</EPL_PRODUCT_QTY_PLANNED> <EPL_PRODUCT_QTY_ACTUAL>0</EPL_PRODUCT_QTY_ACTUAL> <EPL_PRODUCT_QTY_CASE>0</EPL_PRODUCT_QTY_CASE> <EPL_PRODUCT_QTY_ORDERED>0</EPL_PRODUCT_QTY_ORDERED> <EPL_REASON_CODE></EPL_REASON_CODE> <EPL_LINKED_REASON></EPL_LINKED_REASON> <EPL_STATUS></EPL_STATUS> <EPL_PHOTO_ID></EPL_PHOTO_ID> <EPL_PRODUCT_WEIGHT></EPL_PRODUCT_WEIGHT> <EPL_CUST_REF></EPL_CUST_REF> <EPL_ITEM_TYPE></EPL_ITEM_TYPE> <EPL_UNIT_TYPE></EPL_UNIT_TYPE> <EPL_CUST_COMMENTS></EPL_CUST_COMMENTS> <EPL_LAST_CHANGED_DATE>20120614</EPL_LAST_CHANGED_DATE> <EPL_LAST_CHANGED_TIME>16362322</EPL_LAST_CHANGED_TIME> </EPOD_PRODUCT>
Server
Both the dataservice and PDA web request servers (ePOD_DataService.asmx, ePOD_DataService2.asmx and Calidus_ePOD.asmx) ) and the AutoExport application will need to export the new field EPOD_PRODUCTS.EPL_CUST_COMMENTS in their XML requests. This should be handled by the DAL changes above. The responses affected are:
- AutoExport:
- EPOD_EXPORT_LOAD
- EPOD_EXPORT_JOB
- ePOD_DataService
- EPOD_EXPORT_LOAD_RESPONSE
- EPOD_EXPORT_JOB_RESPONSE
- Calidus_ePOD
- JOB_LOCK_RESPONSE
- LOAD_RESPONSE
- AUTO_UPDATE_RESPONSE
The processing of Job Update messages from the PDA (in Calidus_ePOD.asmx, JOB_UPDATE_REQUEST) must be modified to update this new field. The EPOD_PRODUCT tag of the XML payload of this message will be as follows:
<PRODUCT> <EPL_PRODUCT_CODE></EPL_PRODUCT_CODE> <EPL_SEQUENCE></EPL_SEQUENCE> <EPL_PRODUCT_QTY_PLANNED></EPL_PRODUCT_QTY_PLANNED> <EPL_PRODUCT_QTY_ACTUAL></EPL_PRODUCT_QTY_ACTUAL> <EPL_STATUS></EPL_STATUS> <EPL_REASON_CODE></EPL_REASON_CODE> <EPL_CUST_COMMENTS></EPL_CUST_COMMENTS> </PRODUCT>
Note: EPL_CUST_COMMENTS will only be returned if something has been entered in this field on the PDA.
Note: All XSDs should be modified to include the new field, along with standard documentation. This includes but is not limited to:
- EPOD_EXPORT_LOAD_RESPONSE.xsd
- XMLUpload.xsd
- EPOD_EXPORT_JOB.xsd
- EPOD_EXPORT_JOB_RESPONSE.xsd
- ePOD_ImportResponce.xsd
Note: It is not necessary to add this field to the import procedures, as this information is entered for the first time by the PDA user/customer. However, if adding this to the import makes the system easier to maintain, this may be done. The item should be added as optional (minOccurs=0, maxOccurs=1, nillable=true) in the XSD.
Admin
The Product Details pop-up in the Job Details screen (product_containers.aspx), obtained by clicking the Select button on an item in the products grid) will be modified to display any user-entered notes at the bottom of the screen, from EPL_CUST_COMMENTS.
Android Client
The existing EPOD_PRODUCT table will be modified to add the new field as follows:
- EPL_CUST_COMMENTS - nvarchar(200) default
This new field should be added to every procedure as part of the PDA_PRODUCT DAL object.
The method ToUpdateXML of the EPOD_PRODUCT DAL should be modified to add the new field to the message, as the last item, as follows:
<PRODUCT> <EPL_PRODUCT_CODE></EPL_PRODUCT_CODE> <EPL_SEQUENCE></EPL_SEQUENCE> <EPL_PRODUCT_QTY_PLANNED></EPL_PRODUCT_QTY_PLANNED> <EPL_PRODUCT_QTY_ACTUAL></EPL_PRODUCT_QTY_ACTUAL> <EPL_STATUS></EPL_STATUS> <EPL_REASON_CODE></EPL_REASON_CODE> <EPL_CUST_COMMENTS></EPL_CUST_COMMENTS> </PRODUCT>
Note: EPL_CUST_COMMENTS will only be returned if something has been entered in this field on the PDA.
A new ClauseProduct helper function will be added to the Cancellation procedures in Cancellation.js. This will call the Cancellation function, passing a parameter to allow this to be configured for the needs of Product Clausing.
The changes required are:
- Pass in the PDA_PRODUCT data object
- Populate the label, asking the user to enter comments against the Product (code and description displayed).
- No Reason Code displayed.
- The quantity should be displayed.
- Images are allowed as standard, with standard validation.
- A Text Area for Comments should be displayed, defaulted to the value in EPL_CUST_COMMENTS.
- Validation should ensure that a comment is entered - reason code should be ignored for validation and left blank on the field.
- When confirmed as claused, the quantity should be checked. If set to 0, only the comments should be saved in EPL_CUST_COMMENTS. If non-0, the item should be processed as if confirmed quantity (i.e. EPL_STATUS="C", removing from the products list), but also writing the comments.
The Products action pop-up in ColDel.js will be modified to add a new Comments action, which will call the new ClauseProduct function.
Additionally, the Cancellation function should be modified to allow the compression and re-sizing of images taken, to reduce bandwidth if required and reduce memory constraints on the mobile device.
In Config.js, a new Preference group should be set up for Image Quality. This will requires preferences for:
- Size - the size of the resulting image - select 'Native' to control image size through the Camera application:
- Native (default) = 0
- Large (~3MP) = 3
- Medium (~1.5MP) = 2
- Small (~0.5MP) = 1
- Compression - the compression applied to the resulting image - select 'Native' to control image compression through the Camera application:
- Native (default) = 99
- Max = 0.0
- Med = 0.3
- Light = 0.7
- None = 1.0
These preferences should be pre-set in app.js to their default values.
In Cancellation.js, when an image has been captured (in the callback function of ShowCamera):
If either of the new preferences are not set the the Native values, the new code to resize the image will be called.
If required, the image size will be recalculated. This will retain aspect ratio by:
- Calculate the orientation of the image, and the ratio by comparing an dividing the height and width of the image returned from the function.
- Check the Size preference and look up the width of the image
- Large - 2048
- Medium - 1600
- Small - 1024
- Calculate the new size of the image, using the static width, and calculating the height by using the ratio, parsed to an integer field.
- Set these values a properties 'height' and 'width' of the objOptions object
Set the property 'quality' of the objOptions from the value in the preferences, if that value is not the Native value.
Use ImageFactory to change the resulting image as follows:
// Set this up in function Cancellation var imageFactory = require('ti.imagefactory'); // when processing the image back from the camera, do this first, as shown below... blobImage=imageFactory.imageAsResized(blobImage, objOptions);
Appendix A: TEST PLAN
Test Script / Scenario Reference | BIU Bank Defect | Call Number(s): 313304 312018-5 |
Test Script / Scenario Description | To show that Comments and Images may be collected against Products during the Collection process. | PASS / ISSUES / FAIL |
Menu Access | Collection | |
Pre-requisites | No configuration required - this functionality is being required as standard. | Tested By: |
Test Objective | To test that: Collection processing allows Comment and Image entry and; these elements are saved, visible and exported by the CALIDUS ePOD system. | Date: |
Step | Action | Result | Remarks | P/F |
1 | PDA | |||
Create jobs with multiple banks/loose products (at least 4). Ensure configured for BIU, both in the style of the PDA and the Job contents. | ||||
1.01 | Start a job. Arrive and start processing. | All banks to be collected are displayed on the products screen. | ||
1.02 | Long-press on a Bank and choose Comments | a Comment Product screen is displayed, allowing entry of comments and images. | ||
1.03 | Back out of the screen | the Banks are displayed again. All are still displayed. | ||
1.04 | Long-press on a Bank and choose Comments. Click OK | a validation error should be displayed, showing that the comments must be entered. | ||
1.05 | Enter comments and click OK | the Banks screen should be re-displayed. The product should still be shown on the screen (as the quantity has not been confirmed). | ||
1.06 | Long-press on the same Bank and choose Comments | the Comment screen should be displayed, showing the comment already entered. | ||
1.07 | Click OK. Press on this bank line and enter a quantity. | The Bank should be removed from the Banks list. | ||
1.08 | Long-press on a Bank and choose Comments. Enter a comment and a quantity. Click OK. | the Banks screen should be displayed. The Bank should be removed from the Banks list. | ||
1.09 | Long-press on a Bank and choose Comments. Enter a comment but no quantity. Click the Image button and take a picture. Click OK. | the Banks screen should be displayed. The product should still be shown on the screen (as the quantity has not been confirmed). | ||
1.10 | Press on this bank line and enter a quantity. | The Bank should be removed from the Banks list. | ||
1.11 | Long-press on a Bank and choose Comments. Enter a comment and a quantity. Click the Image button and take a picture. Click OK. | the Banks screen should be displayed. The Bank should be removed from the Banks list. | ||
1.12 | Complete all other products. Complete the job with any required signatures and data entry. Check the Admin system for the job's banks. | Each Bank should be completed. Each bank with comments should display those comments in the Product Details pop-up. If an image was taken against the product, the image should be displayed when pressing the Image button. | ||
1.13 | Check the export of job. | EPL_CUST_COMMENTS should be included on each EPOD_PRODUCT tag where comments were entered. Those with images should have the image EPL_PHOTO tag included. |
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 | 0.50 | 0 | £0.00 |
Technical Specification | 0.00 | 0 | £0.00 |
Development | 4.00 | 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. |
B.1 References
Ref No | Document Title & ID | Version | Date |
1 | UG 291094 EPOD Admin User Guide | 2.0 | 4/4/2012 |
2 | [http://172.198.45.54/calidus-assist/OBS/index.php/UG_291097_EPOD_Client_User_Guide UG 291097 EPOD Client User Guide | 3.0 | 23/4/2013 |
3 | REQ 312018 Bag It Up EPOD Requirements | 0.3 | 01/10/2013 |
B.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. |
B.3 Authorised By
Barry Preece | OBS Project Manager | _____________________________ |
____________________(PRINT) | Client Representative | _____________________________ |