Functional Overview
Client Requirement
Palletforce Interface changes. Add Delivery Status Code and POD Notes.
Solution Overview
The Palletforce export format will be altered in line with their recent format changes.
The export format will be altered to include two extra fields: Delivery Status Code and POD Notes used to indicate that the delivery has been successful but with exceptions or minor damages.
In order to achieve this, a reason code may be prompted for when making a successful delivery.
Scope
- These changes will be made in the latest version of the CALIDUS ePOD system.
- These changes will only be made to the Android version of the PDA client.
Set-up
Pre-requisites
None
Data
New "Clause" type reason codes will be expected to be setup for the Palletforce Job Group.
Initially reason codes of 'PODC' and 'PODD' will be expected to be defined with descriptions of 'Delivered with Exception' and 'Delivered with Damage' respectively.
Functional Description
Database Changes
Table EPOD_JOB_GROUPS requires the following modifications:
- EPL_CLAUSE_DELIVERY (New field) - nvarchar(1)
The existing EPOD_JOB_GROUP DAL object will be changed to include:
- EPL_CLAUSE_DELIVERY of EPOD_JOB_GROUP
Existing packages will be modified to allow the creating, editing and selecting of the new fields, including but not limited to:
- EPOD_JOB_GROUPS_INSERT
- EPOD_JOB_GROUPS_SEARCH
- EPOD_JOB_GROUPS_SELECT
- EPOD_JOB_GROUPS_SELECT_UPDATED_DATA
- EPOD_JOB_GROUPS_UPDATE
Admin Changes
The Reason Code Maintenance screen (Reason_code.aspx) will be altered to include a new 'Type' of 'Claused' in the 'Type' drop-down list.
Note that the Text will be displayed as 'Claused' but the value on the database will be stored as 'CLA'.
Reason codes of this type will be used to indicate a complete delivery with exceptions, e.g. 'PODD' or 'PODC'.
The Job Group Maintenance screen (job_group.aspx) will be altered to include a 'Claused Delivery' flag. This will appear as a drop-down list in the 'PDA' tab.
The list will have three possible values:
- '0' - don't prompt for a claused delivery description or claused reason code
- '1' - prompt for a claused delivery description without a claused reason code
- '2' - prompt for both a claused delivery description and a claused reason code
Note that if the current Site level 'Claused Delivery' tickbox is set, then this will mean that the 'Claused Delivery' text box will appear
regardless of the value of the Job Group setting.
The Container Maintenance screen (product_containers.aspx) will be altered to allow the user to choose a reason code when entering a Claused Delivery.
In the Container Details popup box, the user is currently able to enter free text within the Claused Delivery field.
The program will be changed to check the 'Claused Delivery' flags mentioned above. If the flag is set to the appropriate value and if there are any 'Claused' type reason codes defined for the Job Group in question,
then a drop-down list will appear labelled as 'Claused Reason'. The user will be able to choose a reason code from the list. The list will not be made a required field.
Palletforce File Export Changes
The file extension for the current process is set as .epod. This will be altered to be .epd.
In addition, two extra fields will be added to the current layout for the outbound Palletforce file:
- Delivery Status Code - to be set as EPL_REASON_CODE of EPOD_CONTAINER if populated and the status of the container record is 'C'. If not then set as 'POD'.
- POD Notes - to be set as EPL_CUST_COMMENTS of EPOD_CONTAINER if populated. If not and EPL_REASON_CODE of EPOD_CONTAINER is populated, then set as EPL_DESCRIPTION of EPOD_REASON_CODE for that reason code record.
The EPL_CUST_COMMENTS field will be checked for comma characters. If any are found, they will be replaced with space characters in the outbound file to ensure the integrity of the csv produced.
Otherwise, this field should be left blank.
Note that the layout is to remain as a comma-separated file so the new fields will need to be separated with extra commas.
Message Process Changes
The message process class (messageprocess.cs) that sends data to the PDA will need to verified to ensure that the EPL_CLAUSE_DELIVERY flag is sent as part of the Job Group message.
PDA Changes
Table PDA_JOB_GROUPS requires the following modifications:
- EPL_CLAUSE_DELIVERY (New field) - nvarchar(1)
The existing PDA_JOB_GROUPS DAL object will be changed to include:
- EPL_CLAUSE_DELIVERY of PDA_JOB_GROUPS
The login request process will be altered to allow the EPL_CLAUSE_DELIVERY flag to be populated when Job Group level data is passed in.
The Claused Container pop-up screen will be altered to check for the EPL_CLAUSE_DELIVERY of PDA_JOB_GROUPS flag.
If this is set to '2', then the program will check for the existence of PDA_REASON_CODES for the Job Group in question
of Reason Type 'CLA'.
If records exist then a new drop-down list will be displayed Labelled as 'Claused Reason' to allow the user to choose the reason for marking the delivery as claused. The list will not be made a required field.
Appendix A: TEST PLAN
| Test Script / Scenario Reference | Palletforce Interface Changes | Call Number(s): 314964 |
| Test Script / Scenario Description | To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in CALIDUS ePOD | PASS / ISSUES / FAIL |
| Menu Access | Job Group Maintenance, Reason Code Maintenance | |
| Pre-requisites | Ensure that Palletforce job groups are defined against the required sites | Tested By:
|
| Test Objective | To test the additional fields required for the Palletforce export process are populated. Check that the claused reason code field is prompted for on the device. | Date:
|
| Step |
Action |
Result |
Remarks |
P/F |
| 1 |
Admin |
|
|
|
| |
Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance. |
|
|
|
| 1.01 |
Log into Job Group Maintenance. Check that a 'Claused Reason' drop-down list option is available in the PDA tab. Check the default value is set to 'Don't prompt' |
Each Job Group can be configured to use 'Claused Reasons' or not. |
|
|
| 1.02 |
Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined. |
Reason Codes of type 'Claused' can be created. |
|
|
| 1.03 |
Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records. |
The Option to enter a 'Claused Reason' should now be available. |
|
|
| 1.04 |
Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test. |
The user should no longer be able to enter a 'Claused Reason'. |
|
|
| 1.05 |
Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes. |
The user should no longer be able to enter a 'Claused Reason'. |
|
|
| Step |
Action |
Result |
Remarks |
P/F |
| 2 |
PDA - Process |
|
|
|
| |
Check the user is prompted for a Claused Reason Code when appropriate. |
|
|
|
| 2.01 |
Process a job for the Job Group in question. Enter the Claused Reasons canvas. |
The user should be prompted for a Claused reason code as well as the current Claused free text box. |
|
|
| 2.02 |
Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test. |
The user should no longer be able to enter a 'Claused Reason'. |
|
|
| 2.03 |
Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes. |
The user should no longer be able to enter a 'Claused Reason'. |
|
|
| Step |
Action |
Result |
Remarks |
P/F |
| 3 |
Export process - Palletforce |
|
|
|
| |
Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd. |
|
|
|
| 3.01 |
Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text. |
Check the Claused Reason Code and Claused text are included in the output file produced. |
|
|
| 3.02 |
Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text. |
Check the Claused Reason Code and Reason Code description are included in the output file produced. |
|
|
Appendix B: Document References
B.1 References
| Ref No | Document Title & ID | Version | Date |
| 1 | | | |
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
Phil Harding |
OBS Project Manager | _____________________________ |
Andrew Allison |
Client Representative | _____________________________ |
