FS 330147 NHSBT Stop Update at Start Job
NHSBT
Limit EPOD Updating
CALIDUS ePOD
23th September 2015 - 0.1
Reference: FS 330147
Contents
Functional Overview
Client Requirement
- Remove the 30 second delay from Start/Arrive/Continue Job when there is a limited data network on the device.
- Stop the Pending Timer when entering a job, and restart only when all jobs at that location are completed.
Solution Overview
A new flag should be added to Site to control whether online job updates are attempted.
If enabled, the EPOD Mobile Device should NOT attempt to online check for job updates at Start, Arrive and Continue Job, but instead place the message straight onto the pending queue, for sending at a later time.
A new flag should be added to Site to control whether pending data updates are attempted at all times, or just when not processing a job.
If enabled, the EPOD Mobile Device should turn off the pending data timer when starting a job, and re-enable it when the job is complete.
Scope
Note: These changes should be completed in version 2 and 3 of the CALIDUS ePOD system.
The implications of this change being enabled are that the device will not check for any update the jobs being started, and will be reliant on the job data that was sent to the device in the last background update, which may occur up to every 10 minutes. This could lead to containers being delivered when they should no longer be, or collections not being processed when they should.
Set-up
Pre-requisites
Menu Structure
Data
The new Site flags EPL_JOB_LOCK_ONLINE and EPL_PENDING_ALWAYS must be set to "N" for all NHSBT sites that require this functionality.
Functional Description
Database
Table EPOD_SITE requires the following modifications:
- EPL_JOB_LOCK_ONLINE [nvarchar](1) NOT NULL DEFAULT "Y"
- EPL_PENDING_ALWAYS [nvarchar](1) NOT NULL DEFAULT "Y"
Existing packages will be modified to allow the creating, editing and selecting of the new fields, including but not limited to:
- EPOD_SITE_INSERT
- EPOD_SITE_SELECT
- EPOD_SITE_SELECT_UPDATED_DATA
- EPOD_SITE_UPDATE
The existing EPOD_SITE DAL object will be changed to:
- Read the new fields. Note: It is not necessary to add the field as search-able items.
- Export the new fields as XML.
DAL
The EPOD_SITE DAL object will be modified to add these new flags when selecting, updating or adding new EPOD_SITE records.
Webservices
The adding of the new fields to the Site section of the login response will be handled by the changes being made to the DAL object shown above.
Admin
The EPOD Admin Site screen (site_header.aspx) will be modified to add these flags to the PDA tab, for maintenance.
Site Maintenance Screen
The new flags should be added as check-boxes in the area indicated, initialising to checked (based on the default value of "Y"). Unchecked will save a value of "N".
Mobile Android Application
Note: All changes to methods and functions below should have the JSDoc comments changed to reflect changes to functionality, if appropriate.
Database/DAL
The device should be modified to add the new Site flags to the database on creation.
The device should populate these flags (defaulting to Y) if the flag does not exist.
This should be achieved as follows:
- \Resources\Database\DBConnection.js
Change the definition of the EPOD_SITE table in function CreateDB to add new fields to the end of the table:
- EPL_JOB_LOCK_ONLINE nvarchar(1) NOT NULL DEFAULT \'Y\'
- EPL_PENDING_ALWAYS nvarchar(1) NOT NULL DEFAULT \'Y\'
Change the last version changed in function InstallDB to the build number of this change (set in \TiApp.xml).
- \Resources\Database\PDA_SITE.js
Add new fields to the DAL object in all places affected:
New fields:
- EPL_JOB_LOCK_ONLINE
- EPL_PENDING_ALWAYS
Functions/methods affected:
- function PDA_SITE(EPL_SITE_ID)
- Add properties for the new fields, defaulted to 'Y'.
- When selecting data from the database table EPOD_SITE, populate the values of the new fields. If the record does not exist, these should default to 'Y'.
- method Update
- Add the new fields to the database update SQL and parameters, and to the database insert SQL and parameters.
- function InsertPDASite
- Add the new fields as parameters to the function.
- Add the new fields to the database insert SQL and parameters.
- function UpdatePDASite
- Add the new fields as parameters to the function.
- Add the new fields to the database update SQL and parameters.
- function InsertAllPDASites
- Change the sample comment to show the new fields
- Add the new fields as parameters to the call to InsertPDASite (through a call to the GetXMLItem function).
- function InsertAllPDASitesJSON
- Change the sample comment to show the new fields
- Add the new fields as parameters to the call to InsertPDASite (through a call to the GetJSONItem function).
Job Detail
The device Job Lock and Job Arrival webservices should be modified to check this flag - if set to N, the device should add this message straight to the pending messages, rather than attempting to send them on-line.
This will be achieved as follows:
- \Resources\ui\common\JobDetail.js
Function funStartJob will be modified to check the value of the new flag EPL_JOB_LOCK_ONLINE from Ti.App.PDA_SITE, after determining that the device is on-line.
The call to JobLockRequest in this on-line section only will be modified to set the 4th parameter (p_blnUpdateRequired) to the evaluation of (Ti.App.PDA_SITE.EPL_JOB_LOCK_ONLINE=="Y").
This will ensure that, if the flag is set to "N", this will be false, and the function JobLockRequest will be instructed to place the message directly onto the pending queue, rather than attempting to send immediately.
Note: The message "Checking for Updates on this job..." in this function should become "Please Wait..." if the new Site flag Ti.App.PDA_SITE.EPL_JOB_LOCK_ONLINE is set to "N" or the device is offline.
This requires a new i18n translation for this message, which should be added to the following files:
- \i18n\xx\strings.xml
The Pending timer should be be stopped when the job is begun, at the following steps:
- If Start Job is clicked and the job does not require Arrival times.
- If Arriver Job is clicked
- If Continue Job is clicked.
This will only be done if the new flag EPL_PENDING_ALWAYS is set to "N"
This is all in function actionJobs, at the same time that the AutoUpdate timer is stopped with the following code:
- Ti.App.AutoUpdateTimer.StopTimer();
The Pending Data Timer should be restarted once the call-back procedure is called for the Job Details screen. This is in the definition of function funJDCallbackDet, defined in two places in function actionJobs. The Pending timer should be restarted when the Update timer is started, with the following code:
- Ti.App.AutoUpdateTimer.StartTimer();
WebServices
The current method of enqueuing messages to the pending queue from the JobLockRequest function is to immediately trigger a send in the background. This is undesirable. Furthermore, the previous temporary change to this function (under change 330146) must be removed, as it is replaced by the changes to JobDetail above.
- \Resources\System\WebServices.js
Function JobLockRequest will be modified as follows:
The setting of p_blnUpdateRequired will be reinstated to the previous code, as follows:
- p_blnUpdateRequired = p_blnUpdateRequired&&!IsWebServiceActive;
If the parameter p_blnUpdateRequired is set to false, the function currently sends the message through a call to WriteToQueue. This will be modified to add the existing parameter p_blnTriggerSend to this call as the value false, as follows:
- WriteToQueue(strXML, 0, false);
Note: All other WriteToQueue calls should be changed, ensuring that the timer is not triggered. In total this is as follows:
- LoginRequest - leave triggering the pending send
- LogoffRequest - leave triggering the pending send
- JobLockRequest - being changed to false at all times
- JobUpdateRequest - already false
- JobUpdateRequests - already false
- GPSStatusRequest - make false at all times
- PhotoUploadRequest - make false (twice in procedure) at all times
- LoadUpdateRequest - leave triggering the pending send
- VehicleCheckRequest - make false at all times.
Note: For JobUpdateRequest and JobUpdateRequest, the function triggers a send on the pending queue at the end, through a call to Ti.App.PendingDataTimer.TriggerSend(). This should be called only if the new Site flag EPL_PENDING_ALWAYS is set to "Y".
The PendingDataTimer should be modified to have a new Started property added to it, defaulting to false. This should checked that this is false when starting the timer in the StartTimer method, and set to true when the timer is started in this function. The Started property should be set to false in the StopTimer method, after clearing the interval. This is exactly how the existing AutoUpdateTimer works, and this code should be checked for details of how to implement this.
Appendix A: 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.00 | 0 | £0.00 |
| Technical Specification | 0.00 | 0 | £0.00 |
| Development | 0.00 | 0 | £0.00 |
| Testing and Release | 0.00 | 0 | £0.00 |
| Implementation | 0.00 | 0 | £0.00 |
| Project Management | 0.00 | 0 | £0.00 |
| TOTAL | 0.00 | £0.00 | |
| Estimate excludes training, release to live and go live support. |
A.1 References
| Ref No | Document Title & ID | Version | Date |
| 1 |
A.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. |
A.3 Authorised By
Murray Middleton | OBSL Product Development Manager | _____________________________ |
