View source for FS 331694 Deliver All function

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Deliver All function}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|26th November 2015}}
{{#vardefine:Reference|331694}}
{{#vardefine:Year|2015}}
</div>
{{Doc_Title
|Client={{#var:ClientName}}
|System={{#var:System}}
|Title={{#var:Doc_Title}}
|Reference=FS {{#var:Reference}}
|Version={{#var:Version}}
|Date={{#var:Date}}
|Year={{#var:Year}}
}} 

<!-- TOC --> 
<div class="noprint">
= Functional Overview  =

== Client Requirement  ==
For bulk deliveries (i.e. 26 pallets) change the ePOD application to allow management of exception items then click a “Deliver All” for the remaining pallets.


== Solution Overview  ==
A new ‘Deliver All’ flag will be added to the site maintenance in the ePOD Admin system, this flag will be set as a checkbox and the value (i.e. checked or unchecked) will be included in the site data sent to the devices.

The device will be changed so that if the new ‘Deliver All’ flag is checked when processing a delivery job (or consolidated group of delivery jobs) for which there are outstanding containers (pallets) or products the Job Details tab will include a ‘Deliver All’ button.

If the user clicks this button a confirmation box will be shown with the message “All remaining items will be marked as delivered - please confirm” and tow buttons, an ‘OK’ button and a ‘Cancel’ button.

If the user clicks the ‘Cancel’ button the confirmation box will be removed and no action will be taken (i.e. nothing will be marked as completed).

If the user clicks the ‘OK’ button then any containers (pallets) or products that have not previously been marked as complete or cancelled for the job(s) being processed will be marked as complete. The device will then run the standard job completion processing based on the setup as if all of the items had been manually completed (e.g. prompt for driver signature, customer signature and/or job photos based on setup).

If the ‘Deliver All’ site option is not checked then the ‘Deliver All’ button will not be shown.
If the job(s) being processed are not delivery jobs then the ‘Deliver All’ button will not be shown.
If the job(s) being processed do not have any outstanding items, i.e. all containers (pallets) and products have already been marked as complete or cancelled then the ‘deliver All’ button will not be shown (as with existing functionality the ‘Complete’ button will still be shown).


== Scope  ==
Changes will be made in the latest device and server versions only (i.e. versions 3.x.x.x).

The new ‘Deliver All’ flag will affect ALL delivery jobs for the partner’s site.

The deliver all functionality will override any required user entry for containers and/or products (for example any container level user defined fields or setting of non-zero quantities for products with a zero planned quantity).

The deliver all functionality is at the discretion of the driver and will process the outstanding items in the same way as the manual processing (i.e. it will not be possible to determine if a container (pallet) has been manually marked as being delivered via the deliver option or if it has been marked as being delivered via the new deliver all functionality). 

<!-- NEW PAGE --> 

= 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  ==
In order to make the ‘Deliver All’ option available to the drivers for all delivery jobs for a partner’s site the new ‘Deliver All’ checkbox on the site maintenance page must be checked.

<!-- NEW PAGE --> 

= Functional Description  =
== Database / Server ==
A new numeric flag (called EPL_DELIVER_ALL_IND) will be added to the database on the site record (EPOD_SITE) to allow the new “Deliver All” option to be stored for a site.

All data access functions for creating, updating or selecting a site will be updated to include this new flag as will the XML request (used for sending the site data to the PDA’s). This will store (and in the XML report) this value as 1 if the option has been checked or 0 otherwise.

The default value for this new flag should be 0.

Note: It is not necessary to add this field as a search-able item.


== Admin ==
=== Site Maintenance ===
The admin web application includes a Site Maintenance page (within the Administration menu) to allow setting for a partner’s site to be maintained. This page includes a ‘PDA’ tab to allow the site level settings for options that will affect the PDA to be maintained.

A new field will be added to this ‘PDA’ tab of the Site Maintenance page. This field will be shown with the label ‘Deliver All’ and will use a check-box to allow the user to set or un-set this option. 

The check-box will include a hint text (shown when hovering over the checkbox) showing the message ‘Using deliver all will override any container or product level data entry’.

Note: The default for new sites or when this option is first added to an existing site will be for this check-box to be un-checked.


== Android Application ==
=== Database / DAL ===
The device’s database will be changed to add the new numeric flag (called EPL_DELIVER_ALL_IND) to the site record (EPOD_SITE) to allow the new “Deliver All” option to be stored for a site.

All data access functions (including those that set the site data based on the data passed from the server) will be updated to include this new flag. The default value for this flag (if one has not been passed from the site) should be 0.


=== Collection / Delivery Screen ===
The collection / delivery screen is used for processing all collections or deliveries. This screen includes a ‘Job Details’ tab which shows the job details for the job (or selected job if processing a consolidated group of jobs).

When processing a job or group of jobs that have not been complete/cancelled if all of the items for the job(s) have been completed or cancelled the ‘Job Details’ tab currently includes a ‘Complete’ button which will complete the job(s) being processed.

The collection / delivery screen will be changed so that when it is opened the device will check the new ‘Deliver All’ option for the current site and the type of job(s) being processed. 

If the ‘Deliver All’ option was checked and the job(s) being processed are delivery jobs it will go on to check if there are any containers (pallets) or products for the job(s) that have not been completed or cancelled.

If this check finds there are outstanding containers (pallets) or products for the job(s) being processed then a new ‘Deliver All’ button will be added to the bottom of the Job Details tab, in the same position as the ‘Complete’ button is shown.

If the ‘Deliver All’ option was not checked for the current site or if the job(s) being processed were not delivery jobs or if the job(s) did not have any outstanding items the ‘Deliver All’ button will not be shown.

When the ‘Deliver All’ button is shown clicking it will present the user with a confirmation pop-up. This confirmation pop-up will show the message ‘All remaining items will be marked as delivered - please confirm’ along with an ‘OK’ button and a ‘Cancel’ button.

If the user clicks the ‘Cancel’ button (or uses the devices back button) then the deliver all processing will be cancelled. The confirmation pop-up will be removed and none of the outstanding containers (pallets) or products will be completed at this time.

If the user clicks the ‘OK’ button then the device will validate that the job(s) are ready to be completed. This validation will ignore any outstanding items (as these will be completed) but will include the other job level validation (e.g. check whether any job level user defined fields have been entered or whether the user should confirm no ad-hoc items are required). 

If this validation generates any warnings or errors these will be issued before any outstanding items are marked as complete. Warnings would allow the user to abort or continue with the deliver all process, errors would abort the deliver all process (i.e. the user would have to correct the error before clicking the ‘Deliver All’ button again).

If the validation shows the job(s) are ready to be completed then any outstanding containers (pallets) will be marked as complete and any outstanding products will have the actual quantity set to the planned quantity and will be marked as complete.

Once all of the outstanding items have been completed the device will run the standard job completion processing. This will replace the ‘Deliver All’ button with the ‘Complete’ button and perform any job end processing that is required by the data setup (for example capture any signatures that are required, conditionally allow a job photo ti be taken and mark the job as complete before returning to the job list).

Notes:
•	Using the deliver all functionality will override any container or product data entry. For example if there are container level user defined fields the user will not be prompted to enter these when using the deliver all functionality. Similarly if there are products with a zero planned quantity the user will not be prompted to enter a quantity for these products when using the deliver all functionality.
•	Using the deliver all will not override any job level data entry. For example if there are job level user defined fields which are required entry fields the user will need to enter these fields before the deliver all process can be used.


<!-- MEDIA LANDSCAPE YES --> 
= Appendix A: TEST PLAN  =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=ePOD Deliver All functionality
|MenuAccess=
|Prerequisites=An ePOD Admin system and ePOD android application.
|Objective=Ensure the deliver all functionality works as described.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=ePOD Admin
|Notes=
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure the ‘Deliver All’ checkbox is present in the site maintenance page and can be set/unset. 
|Result=The checkbox is present and can be checked or unchecked.
|Remarks=
|PassFail=
}}<!-- {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Check the value of the ‘Deliver All’ checkbox is saved when changes are saved.
|Result=The setting is saved.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure the hint text is visible when hovering over the ‘Deliver All’ checkbox.
|Result=The hint text is displayed.
|Remarks=
|PassFail=
}} -->{{TestPlan_CycleFooter}} 

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=ePOD Android Application
|Notes=
}} <!--INSERT TESTS HERE --> {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that with the ‘Deliver All’ option unchecked the ‘Deliver All’ button is not shown for single collection jobs, single delivery jobs, consolidated collection jobs or consolidated delivery jobs. 
|Result=The ‘Deliver All’ button is not shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that with the ‘Deliver All’ option checked the ‘Deliver All’ button is not shown for single collection jobs or consolidated collection jobs.
|Result=The ‘Deliver All’ button is not shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that with the ‘Deliver All’ option checked the ‘Deliver All’ button is shown for single delivery jobs or consolidated delivery jobs where there are outstanding containers/products.
|Result=The ‘Deliver All’ button is shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that clicking the ‘Deliver All’ button presents the user with a confirmation pop-up and that clicking the ‘Cancel’ button does not complete any containers/items.
|Result=Cancelling the deliver all does not mark any containers/products as complete.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=For a single delivery job with outstanding containers/products (but with no job details UDF) click the ‘Deliver All’ button followed by the ‘OK’ button.
|Result=All containers/products are marked as complete and the job completion is processed (i.e. any signatures that are required are prompted for, any photo allowed is prompted for and the job is completed).
|Remarks=Signature and photo capture are controlled by the data setup against the job group.
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=For a single delivery job with outstanding containers/products which has incomplete required job details UDF click the ‘Deliver All’ button followed by the ‘OK’ button.
|Result=An error is issued for the missing job details UDF, no containers/products are marked as complete.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Repeat the last three tests for a group of consolidated delivery jobs.
|Result=Results are the same as for a single job.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}} 

<!-- MEDIA LANDSCAPE NO --> 
{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=
|Ref1=
|RefV1=
|RefDate1=
|Ref2=
|RefV2=
|RefDate2=
|Ref3=
|RefV3=
|RefDate3=
|Ref4=
|RefV4=
|RefDate4=
|EREQ=0
|EEST=0
|EFS=0
|ETS=0
|EDEV=0
|ESTT=0
|EIMP=0
|EPM=0
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|PM=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=Y
|FIXEDCOST=0
|Rev1=Murray Middleton
|Rev1Title=Development Manager
|Rev2=
|Rev2Title=
}}</div> 
[[Category:{{#var:Client}} FS]]