FS 317954 PROD NHSBT C-EPOD Changes
PROD
Required C-EPOD Product Changes
CALIDUS ePOD
11th July 2014 - 1.0
Reference: FS 317954
Contents
Functional Overview
Client Requirement
- Preferences
- Ensure all preferences can be set from the barcode scan, including boolean values.
- Ensure alert defaults are set (especially vibration, hopefully sound as well).
- Ensure defaults are checked at login, to ensure all preferences are defaulted properly.
- Ensure QR Code for configuration is created.
- GPS-tag messages
- The requirement for Location Check Digit has been superseded by a GPS Location Point.
- Must enable GPS signals and keep refreshed within the application.
Solution Overview
The barcode preferences setting has been created to allow the application preferences to be set without having to key them all in. In the case of true/false (boolean) values, this was unable to set the value correctly. This has been added in the latest version of the software. This change must be available for the NHSBT contract.
The settings required for the operation will be created in a QR barcode. In the event that some of these parameters are not specified in a barcode, default values will be set against them. Currently, the system does not correctly default these values unless the preferences screen is shown - this will be amended so that the preferences are defaulted correctly at all times i.e. after entry by barcode and at initial login.
It should be noted that the alert sound may be set by this method. However, if the chosen setting does not exist on the device being set up, the application will crash when attempting to use the sound, so this will also need to be corrected.
The default preference for vibration will be set to intermittent.
There is already a (default) preference to GPS-tag all messages that are sent from the device application to the server, which is captured and audited in the existing User Tracking screen. However, the device does not accurately refresh the location. This has been corrected in the latest version of the generic software and should be ported to the NHSBT version of the software.
Scope
Note: This functionality will be developed in the Android application only and will not be available in the Windows Mobile application. Note: To obtain an accurate location for the tagging of messages, it is necessary to enable the GPS radio receivers on the device. This has an adverse effect on the battery life of the device. This varies from device to device and is not measured or controlled by OBS Logistics Ltd. Note: GPS tags are only stamped if they are fresh (within 5 minutes) and accurate (within 100m). If no accurate location has been found, the GPS messages are not tagged with a location.
Set-up
Pre-requisites
- A working CALIDUS ePOD system.
Menu Structure
None
Data
None
Functional Description
Preferences
The barcode preferences setting has been created to allow the application preferences to be set without having to key them all in. In the case of true/false (boolean) values, this was unable to set the value correctly. This has been added in the latest version of the software. This change must be available for the NHSBT contract.
This change affects the code in the following modules:
- SystemProperties - SetSystemProperty
The settings required for the operation will be created in a QR barcode. In the event that some of these parameters are not specified in a barcode, default values will be set against them. Currently, the system does not correctly default these values unless the preferences screen is shown - this will be amended so that the preferences are defaulted correctly at all times i.e. after entry by barcode and at initial login.
This results in a settings file expected to contain the following properties:
"SITEID":"DEPOT", "WEBSERVICE":"http://nhsbt.calidus-epod.com:9091/test/", "STYLE":"NHSBT", "WSINTERVAL":"60", "UPINTERVAL":"300", "GEOMSGINTERVAL":"0", "OBSALERT":"content://media/internal/audio/media/34", "GEOTAG":true, "DEBUGMODE":true
Note: The settings shown above are not expected to be the final values, but are indicative of the kind of values expected.
QR Barcodes should be produced through the standard mechanism, one for each depot and system (Test or Live). These should be produced with the NHSBT logo and descriptive test as to which site and system the QR Code pertains. To achieve this, a site- and system-specific logo will be created for each site and system, and embedded in the QR code. An example follows:
The logo showing the site and system
The resulting QR Code
It should be noted that the alert sound may be set by this method. However, if the chosen setting does not exist on the device being set up, the application will crash when attempting to use the sound. Additionally, if a barcode is scanned for a style that does not exist on that version for the device, this will also crash the application. Therefore a validation routine must be written, validating both of these items. Additionally, it should validate that the boolean properties (DEBUGMODE, DEBUG, GEOTAG) contain boolean values in the provided settings. If not (or if the alert tone does not exist, or the style does not exist), these settings should be ignored. All validation errors should be collated into a single confirmation message "Configuration"/"Settings Saved. The following settings in the barcode are invalid and have been ignored:", followed by the property setting name.
If any preferences are unset by the barcode scan mechanism, these should be left as the preference value already set. If the preference value is not set (undefined or null), this property should be set to the correct default value.
- Site - 'TEST'
- Vehicle - 'ADM'
- PendingInterval - 60
- AutoUpdateInterval - 300
- GeoStatusInterval - 300
- LastUpdate - '2010-04-18T13:08:46'
- Alert, ' '
- Vibrate - '3'
- ImageSize - '0'
- ImageCompression - '99'
This same functionality should be applied when the application starts (app.js), checking each value in turn for validity, rather than the current mechanism of checking only the "FirstLogIn" property.
Note: The text in this source file (config.js) should be converted to multilingual tags.
GPS Tags
There is already a (default) preference to GPS-tag all messages that are sent from the device application to the server, which is captured and audited in the existing User Tracking screen. However, the device does not accurately refresh the location. This has been corrected in the latest version of the generic software and should be ported to the NHSBT version of the software.
The modules changed that require importing are:
- GeoLocations.js
- SystemUtilities.js
- Config.js
Appendix A: TEST PLAN
| Test Script / Scenario Reference | Required C-EPOD Product Changes | Call Number(s): 317954 |
| Test Script / Scenario Description | Test the C-EPOD product changes for NHSBT. | PASS / ISSUES / FAIL |
| Menu Access | None | |
| Pre-requisites | Data set up as per Data Setup section. | Tested By: |
| Test Objective | To test that: Settings may be set and defaulted correctly on the device and; GPS tags are accurate and set against messages where appropriate. | Date: |
| Step | Action | Result | Remarks | P/F |
| 1 | Device Preference Tests | |||
| The tester will only be able to check if the preferences have been set or changed by entering the preference settings on the device, which also defaults and sets preferences. This reduces the value of the direct tests below. Indirect tests may be entered into, to check whether the functionality controlled by each individual preference has been set as expected - these tests are not covered here. Instead, it is expected that debug statements may be embedded into the code to allow the programmer to produce proof of testing from the log files on the device. | ||||
| 1.01 | Log in to a clean install of the application. | All preferences are created with the default values expected. | ||
| 1.02 | Click the settings button and choose to enter preferences by barcode. Scan a barcode with an invalid boolean value (i.e. a string instead of the values true or false). | All other settings should be saved. A message dialogue should appear as specified, showing the boolean setting that has been ignored. | ||
| 1.03 | Click the settings button and choose to enter preferences by barcode. Scan a barcode with an invalid alert value (i.e. a string showing a ring tone that does not exist on that device). | All other settings should be saved. A message dialogue should appear as specified, showing the alert setting has been ignored. | ||
| 1.04 | Click the settings button and choose to enter preferences by barcode. Scan a barcode with an invalid style value. | All other settings should be saved. A message dialogue should appear as specified, showing the style setting has been ignored. | ||
| 1.05 | Click the settings button and choose to enter preferences by barcode. Scan a valid barcode that omits a boolean value. | All other settings should be saved. The omitted value should be unchanged. | ||
| 1.06 | Click the settings button and choose to enter preferences by barcode. Scan a valid barcode that omits an alert value. | All other settings should be saved. The omitted value should be unchanged. | ||
| 1.07 | Click the settings button and choose to enter preferences by barcode. Scan a valid barcode that omits any other value. | All other settings should be saved. The omitted value should be unchanged. |
| Step | Action | Result | Remarks | P/F |
| 2 | GPS Tag Tests | |||
| Ensure auto-updates are set to very frequent (30 or 60 seconds) to ensure frequent messages from the device back to the server. Ensure the user/vehicle has a load. When checking results, use the Admin User Tracking screen to see any applied tags. Note: In order to change the GPS tag value on a message, movement is required (around 500m). |
||||
| 2.01 | Ensure GPS Tags are disabled. Start the app and log in. | The login message will have no GPS tag. | ||
| 2.02 | Log out. Start the app again. Change the settings (through barcode or preferences) to ensure that GOS tags are enabled. | The GPS aerial will start up (on the device's status bar). | ||
| 2.03 | Log out. Start the app and log in. | The GPS aerial will start up (on the device's status bar) at app start. The Login message will have GPS tags. | ||
| 2.04 | Physically move to a new location to ensure the location is updated on the device (500m). | The Auto-update messages should show the changes GPS tags. | ||
| 2.05 | Repeat these tests on a device with no GPS. | When enabled, tags should still appear, although no GPS aerial will be turned on, as the device will obtain tags from network settings, if they are accurate enough. |
Appendix B: Quote & Document References
| Cost Details | ||||
| Activity | Estimate No. of Days |
No. of Days | Rate per Day (£) | Cost (£ Exc. VAT) |
| Requirements | 0.00 | 0.00 | 0 | £0.00 |
| Change Request Evaluation | 0.00 | 0.00 | 0 | £0.00 |
| Functional Specification | 0.00 | 0.75 | 0 | £0.00 |
| Technical Specification | 0.00 | 0.00 | 0 | £0.00 |
| Development | 0.00 | 2.00 | 0 | £0.00 |
| Testing and Release | 0.00 | 0.50 | 0 | £0.00 |
| Implementation | 0.00 | 0.00 | 0 | £0.00 |
| Project Management | First argument to "number_format" must be a number. | 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. | £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 | NHSBT High Level Solution Design v2.0.doc | 2.0 | 21/05/2014 |
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
Julie Scott | Project Manager | _____________________________ |
Murray Middleton | Product Manager | _____________________________ |
