FS 306418 Partnerlink Clause Jobs
Partnerlink
FS 306418 Partnerlink Clause Jobs
CALIDUS ePOD
4th April 2013 - 0.2
Reference: FS 306418
Functional Overview
Client Requirement
SCR-305796-11: Allow Customer to Clause delivery items from REQ 305796 Partnerlink EPOD Solution, referenced as item 1 in Appendix A.
Solution Overview
The Signature screen contains a tab showing the Containers that were scanned as delivered or collected on the job. The customer may wish to accept the containers, but note that the pallets have some issue that may later be claimed against (i.e. a Clause delivery). This tab will be modified (for deliveries only) to:
- Display against the container whether it has been claused.
- add a button to allow the user to identify claused pallets.
When the button is pressed, the device will display a pop-up screen displaying the details of the pallet selected, a text box to enter the clause text, and an OK and Cancel buttons. If Cancel is pressed, the user will be returned to the Signature screen. If OK is pressed and clause text has been entered, a pop-up message will be displayed that the container has been claused and the signature screen will be refreshed, displaying the claused containers and clearing the signature.
Scope
- This work will be undertaken for the Android client ONLY at this time.
- There is work related to the visibility of jobs within the CALIDUS TTM product, specified under SCR 306420
Set-up
Pre-requisites
Menu Structure
Data
Functional Description
Database
New flag on EPOD_SITE: EPL_CLAUSE_DELIVERY, 1 character, allowing 2 values:
- N - Disabled (default value)
- Y - Enabled
New field on EPOD_CONTAINER, EPL_CUST_COMMENTS, 200 characters, allowing text entry
Server
The EPOD_SITE DAL will be changed to allow the setting and retrieval of the new flag. It will not be necessary to search on the value of the flag.
The EPOD_CONTAINER DAL will be changed to allow the setting and retrieval of EPL_CUST_COMMENTS. It will not be necessary to search on the value.
The Logon Response message to the PDA Client will be modified to include the new flag setting.
Note: The Load Response and AutoUpdate Response messages will not be modified to include the new comments field.
The Job Update message processing will be modified to update EPL_CUST_COMMENTS if passed back by the ePOD PDA Client.
Admin changes
(Low priority)
Change the Site admin screen to allow the maintenance of the new flag on the PDA tab.
Change the Job Containers screen to identify Claused containers on the grid, and to display claused text on the Select popup.
Android Client changes
The database will be changed to add the new flag to EPOD_SITE.
The DAL PDA_SITE will be changed to retrieve this flag.
The Signature screen contains a tab showing the Containers that were scanned as delivered or collected on the job. The customer may wish to accept the containers, but note that the pallets have some issue that may later be claimed against (i.e. a Clause delivery). If the new site flag is set, this tab will be modified (for deliveries only) to:
- Display against the container whether it has been claused (as a label to the right of the pallet ID, highlighting the text in red). A claused pallet is defined as the EPOD_CONTAINER record having a non-blank text value in new field EPL_CUST_COMMENTS.
- add an ability to allow the user to identify claused pallets by pressing the pallet's row.
Note: The formatting of the container (pallet) id and the new button should be controlled through the standard styling functionality in the Android client.
When the button is pressed, the device will display a pop-up screen displaying the following:
- the details of the pallet selected:
- ID
- Package Code and Description
- Weight
- Any additional codes
- a text box to enter the clause text, pre-populated with any text already entered against the pallet
- Save and Back buttons.
If Back is pressed, the user will be returned to the Signature screen. The claused section need not be refreshed. If Save is pressed, the container will be saved and the signature screen will be refreshed, displaying the claused containers and clearing the signature.
The Claused text will be held in the new field EPL_CUST_COMMENTS on EPOD_CONTAINER.
The Job Update message back to ePOD Server will be modified to include the EPOD_CONTAINER EPL_CUST_COMMENTS field.
Export Changes
Standard Export XML Format Changes
The standard EPOD_CONTAINER element of any Job or Load export will be modified to include the EPOD_CONTAINER EPL_CUST_COMMENTS field. This includes the Partnerlink-specific interface formats.
The XSDs will be modified to reflect this, as will the internal documentation.
TTM Interface changes
The DEL message will be modified to include Claused information against the pallets.
The ORDER_DETAIL tag will be modified to include this comment information, if present:
<ORDER>
<ORDER_HEADER>
<ORDER_TRANSACTION_DATE>2012-12-20T00:00:00</ORDER_TRANSACTION_DATE> - Date job created
<WMS_WAREHOUSE>EPL_SITE_REF</WMS_WAREHOUSE>
<WMS_OWNER>EPL_JOB_GROUP_REF</WMS_OWNER>
<SO_REF>EPL_SO_NUMBER</SO_REF>
<TMS_REF>EPL_JOB_ID</TMS_REF>
<PO_REF>EPL_CUST_REF</PO_REF>
<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE> - Planned Start Date/Time
<ORDER_HEADER_ADDRESSES>
<ORDER_HEADER_ADDRESS>
<ADDRESS_TYPE>DEL</ADDRESS_TYPE>
<ADDRESS_ID>EPL_CUSTOMER_CODE</ADDRESS_ID>
<ADDRESS_NAME>EPL_NAME</ADDRESS_NAME>
<ADDRESS_LINE1>EPL_ADDR_LINE_1</ADDRESS_LINE1>
<ADDRESS_LINE2>EPL_ADDR_LINE_2</ADDRESS_LINE2>
<ADDRESS_TOWN>EPL_ADDR_LINE_3</ADDRESS_TOWN>
<ADDRESS_POSTCODE>EPL_POSTCODE</ADDRESS_POSTCODE>
</ORDER_HEADER_ADDRESS>
</ORDER_HEADER_ADDRESSES>
</ORDER_HEADER>
<ORDER_DETAILS>
<ORDER_DETAIL>
<DETAIL_TYPE>D</DETAIL_TYPE> - D for Container, S for Stock
<ITEM_IDENTIFIER>EPL_CONTAINER_ID</ITEM_IDENTIFIER>
<ITEM_DESCRIPTION>EPL_DESCRIPTION</ITEM_DESCRIPTION>
<ORDERED>1</ORDERED>
<TO_DELIVER>1</TO_DELIVER>
<DELIVERED>1</DELIVERED>
</ORDER_DETAIL>
<ORDER_DETAIL>
<DETAIL_TYPE>S</DETAIL_TYPE>
<ITEM_IDENTIFIER>EPL_PRODUCT_ID</ITEM_IDENTIFIER>
<ITEM_DESCRIPTION>EPL_DESCRIPTION</ITEM_DESCRIPTION>
<ORDERED>1</ORDERED> - ORDERED_QTY
<TO_DELIVER>1</TO_DELIVER> - PLANNED_QTY
<DELIVERED>1</DELIVERED>
<REASON_CODES>
<REASON_CODE>
<RC_CODE>_CLAUSED_</RC_CODE>
<RC_DESCRIPTION>Claused Delivery</RC_DESCRIPTION>
<RC_COMMENT>EPL_CUST_COMMENTS</RC_COMMENT>
<RC_TYPE>DEL</RC_TYPE>
</REASON_CODE>
</REASON_CODES>
</ORDER_DETAIL>
</ORDER_DETAILS>
</ORDER>
Note: The existing ORD record should be modified to add in the REASON_CODES section for deliveries where a reason code has been set against the EPOD_CONTAINER or EPOD_PRODUCT records. In this case, the section should be populated as follows:
<REASON_CODES>
<REASON_CODE>
<RC_CODE>EPL_REASON_CODE</RC_CODE>
<RC_DESCRIPTION>EPL_REASON_DESCRIPTION</RC_DESCRIPTION>
<RC_TYPE>DEL</RC_TYPE>
</REASON_CODE>
</REASON_CODES>
So the full modifications will be to modify the ORD creation routine to create a REASON_CODES node if:
- Type is DEL
- EPL_REASON_CODE on EPOD_PRODUCT or EPOD_CONTAINER is non-blank or EPL_CUST_COMMENTS on EPOD_CONTAINER is non-blank.
Appendix A: Document References
A.1 References
| Ref No | Document Title & ID | Version | Date |
| 1 | REQ 305796 Partnerlink EPOD Solution | 0.2 | 31/01/2013 |
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
Phil Harding | OBS Project Manager | _____________________________ |
Matt Turner | OBS Product Manager | _____________________________ |
