Anw: v0.1 - Initial Creation

2013-08-30T14:48:28Z

v0.1 - Initial Creation

New page

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Pallet Generation}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|30th August 2013}}
{{#vardefine:Reference|311049}}
{{#vardefine:Year|2013}}
</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}}
}}


<div class="noprint">
= Functional Overview =

== Client Requirement ==
Andrew Allison having a problem with Barcode data not validating against the Container_ID code.
Kyle Smith @ Palletforce identifies how he expects it to be set up and the barcode generated.
As follows:

Format AAABBBCDDDEEEEEEEEEEFF where:
* AAA is always 506 - 506
* BBB is the three digit delivery depot number padded with zeros
* C is a single character to reflect the service
* DDD is always the requesting depot; please contact Palletforce if you are unsure of your requesting depot number.
* EEEEEEEEEE is the last ten digits of the Tracking Number from field 4
* FF is a two digit number identifying an individual pallet in a consignment, 01 for the first pallet, 02 for the second pallet and so on.

== Solution Overview ==
The Partnerlink Import functionality will change to generate the Pallet ID (Container ID) in {{#var:System}} from the data passed in from the various TMS providers.

The resulting Container ID length will be 22 characters, which will be too big for the field within the application, so this will be modified in all parts of the system to allow a larger Container ID

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} product only.
* The changes will not affect ''CALIDUS'' Portal - no changes are required here.
* This change requires that the incoming data from the various TMS providers in the Palletforce Tracking ID and Depot Code is correct. For Palletforce Depot Code specifically, for Collection jobs this should be Collecting Depot, for Delivery jobs this should be Delivering Depot.
* All partners that operate Palletforce jobs will be affected by this change, and so this change must be agreed by all partners before work can proceed.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==



= Functional Description =
== Database and DAL ==
The database table EPOD_CONTAINER should be modified as follows:
* Change EPL_CONTAINER_ID to nvarchar(30).

The database should have procedures that use an EPL_CONTAINER parameter changed to reflect the new length. This includes but may not be limited to:
* EPOD_CONTAINER_CANCEL
* EPOD_CONTAINER_DELETE
* EPOD_CONTAINER_GET_MAXID
* EPOD_CONTAINER_INSERT
* EPOD_CONTAINER_SELECT
* EPOD_CONTAINER_UPDATE
* EPOD_PRODUCT_CANCEL
* EPOD_PRODUCT_DELETE
* EPOD_PRODUCT_GET_MAXSEQ
* EPOD_PRODUCT_INSERT
* EPOD_PRODUCT_SELECT
* EPOD_PRODUCT_UPDATE

{{Note}} The EPOD_CONTAINER_GET_MAXID should continue to generate container IDs at the length that it currently does, but the field parameter should change to 30.

The EPOD_CONTAINER DAL object should have each parameter function (identified as functions that begin "GetParameters") checked for the new length of the EPL_CONTAINER_ID parameter.

The database table EPOD_PRODUCT should be modified as follows:
* Change EPL_CONTAINER_ID to nvarchar(30).

The EPOD_PRODUCT DAL object should have each parameter function (identified as functions that begin "GetParameters") checked for the new length of the EPL_CONTAINER_ID parameter.

== Server ==
The length of the EPL_CONTAINER_ID field needs to be modified throughout all the .NET projects, to ensure that the length is changed to 30.
* Length parameters must removed or modified, for example:
** EPOD_UTILS.cs(41): public static int EPL_CONTAINER_ID = 20;
** Utilites.cs(625): public static int EPL_CONTAINER_ID = 15;

All XSDs used in export and import should be modified to identify the restriction to 30 characters on the EPL_CONTAINER_ID field. These include but are not limited to:
* EPOD_EXPORT_JOB.XSD
* EPOD_EXPORT_JOB_RESPONSE.XSD
* EPOD_EXPORT_LOAD.XSD
* EPOD_EXPORT_LOAD_RESPONSE.XSD
* XMLUpload.XSD

The PDA Web service (calidus_epod.asmx) must be checked that responses to the following requests give the full container ID (up to 30 characters):
* JOB_REQUEST
* AUTO_UPDATE_REQUEST
* JOB_LOCK_REQUEST
Additionally, the processing of a JOB_UPDATE message must be checked that it will write the full 30-character Container ID.

== Admin ==
The ''Containers and Products'' screen (product_containers.aspx) will be modified to ensure that entry of new containers or editing existing containers allow for entry of up to 30 characters.

== Import ==
The Partnerlink Import functionality will change to generate the Pallet ID (Container ID) in {{#var:System}} from the data passed in from the various TMS providers.

The pallet ID generation routine in place for non-Palletforce jobs (i.e. EPL_JOB_GROUP = "PALLET") will not change.

The pallet ID generation routine in place for Palletforce jobs will be changed as follows:
Format AAABBBCDDDEEEEEEEEEEFF where:
* AAA - "506"
* BBB - EPL_PF_DEPOT
* C - EPL_SERVICE_LEVEL - never more than one character
* DDDEEEEEEEEEE - EPL_PF_TRACKING_NO
* FF - as now, a two digit number incrementing per pallet.

== Android Client ==
The database tables EPOD_CONTAINER and EPOD_PRODUCT will be modified when created in ''Database.js'' as follows:
* EPL_CONTAINER_ID nchar(30)
{{Note}} As this change requires the database to be modified, this must be reflected as the latest database version that changed to database, to force the re-creation when this version of the application is installed by the users. As such, change the lngLastVersionDB variable to reflect the latest version.

The restriction when scanning or keying container IDs (to only check 15 characters) should be removed, as this will no longer be required.

{{Note}} Scanning or entering containers, and the sending back of container IDs should be checked in the programs, to ensure that they have no restriction against them, specifically in files:
* ColDel.js
* Barcode.js
* WebServices.js


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|Glossary=EPOD
|Ref1=UG 291094 EPOD Admin User Guide
|RefV1=2.0
|RefDate1=4/4/2012
|Ref2=UG 291097 EPOD Client User Guide
|RefV2=3.0
|RefDate2=23/4/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=2.0
|ST=0.5
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=N
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
|FOC=Y
}}</div>
[[Category:{{#var:Client}} FS]]

FS 311049 Palletforce Pallet Generation - Revision history

Anw: v0.1 - Initial Creation