Calidus HUB - User contributions [en-gb]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T13:15:50Z

Rxe: v1.0 Ready for Issue.

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new Tracking System value. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version (v3.x.x.x) of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be constructed as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Murray Middleton
|Rev1Title=OBS Product Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T13:14:05Z

Rxe: Undo revision 2937 by Rxe (talk)

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new Tracking System value. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version (v3.x.x.x) of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Murray Middleton
|Rev1Title=OBS Product Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T13:13:06Z

Rxe: v1.0 Status:Reviewed Reason:Ready for Issue.

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new Tracking System value. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version (v3.x.x.x) of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will retrieve each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Murray Middleton
|Rev1Title=OBS Product Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T13:07:31Z

Rxe: v0.3 After Internal Review

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new Tracking System value. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version (v3.x.x.x) of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Murray Middleton
|Rev1Title=OBS Product Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T11:51:12Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.4}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T11:39:32Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. The pallets should show as being delivered. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T11:31:06Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to false. Set the ClauseNotes to the clause reason descriptions. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-09T11:15:12Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

These messages will be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job.

{{ Note }} Cancelled pallets will be marked within the AddPOD message as being not Delivered. A message will NOT be sent to delete the pallet from the Connect system via the UpdateConsignmentPalletDelete message. Since Calidus Epod is not receiving information regarding individual pallet numbers, there is no way of identifying multiple delivery attempts for the same pallet. Therefore the system cannot determine whether a re-delivery attempt of pallet has occurred.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If some pallets have been cancelled, set the PODType to Delivered. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T16:24:03Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the UpdateConsignmentPalletDelete and AddPOD methods of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will have an UpdateConsignmentPalletDelete message sent. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet has been deleted ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.5
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T15:43:14Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the UpdateConsignmentPalletDelete and AddPOD methods of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will have an UpdateConsignmentPalletDelete message sent. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet has been deleted ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T15:09:20Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the UpdateConsignmentPalletDelete and AddPOD methods of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will have an UpdateConsignmentPalletDelete message sent. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet has been deleted ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T15:08:09Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the UpdateConsignmentPalletDelete and AddPOD methods of their existing ThirdPartyServices webservice. One message will be sent per consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will have a pdateConsignmentPalletDelete message sent. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet has been deleted ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T14:50:16Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number. ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet has been deleted ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T14:38:52Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|8th March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T14:38:08Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

These messages will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

For the UpdateConsignmentPalletDelete message, this should be placed within an UpdateConsignmentPalletDelete tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|consignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|palletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. For any that have been cancelled, an UpdateConsignmentPalletDelete message should be sent.

{{ Note }} Cancelled pallets will not be included in the AddPOD message. If a job has pallets that were cancelled, they will be deleted from the Connect system via the UpdateConsignmentPalletDelete first. The AddPOD message will then have status Delivered or DeliveredClaused on the Connect system.

Then a list of the other Pallet Numbers to send should be built.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. The Pallet repeating object should contain one record per container. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. The Pallet repeating object should contain one record per container. Set the Delivered against each pallet to true.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. The Pallet repeating object should be empty. The ClauseNotes should be blank or omitted. The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list for returning to the calling function and sending to the CONNECT webservice. For each job the UpdateConsignmentPalletDelete messages should be sent before the AddPOD messages.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T13:46:22Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. Set the Delivered against each pallet to true.
* If some pallets were cancelled, set the PODType to DeliveredClaused. Set Delivered to false for the cancelled pallets, and the ClauseNotes to the reason code description. The signature should not be set.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. Set the Delivered flag against each pallet to false. The ClauseNotes should be blank or omitted, The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T13:43:26Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. Set the Delivered against each pallet to true.
* If some pallets were cancelled, set the PODType to DeliveredClaused. Set Delivered to false for the cancelled pallets, and the ClauseNotes to the reason code description. The signature should not be set.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. Set the Delivered flag against each pallet to false. The ClauseNotes should be blank or omitted, The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T13:41:24Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. Set the Delivered against each pallet to true.
* If some pallets were cancelled, set the PODType to DeliveredClaused. Set Delivered to false for the cancelled pallets, and the ClauseNotes to the reason code description. The signature should not be set.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. Set the Delivered flag against each pallet to false. The ClauseNotes should be blank or omitted, The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T13:40:14Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting messages will use the AddPOD and UpdateConsignmentPalletDelete formats:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/">
<soapenv:Header/>
<soapenv:Body>
<tem:UpdateConsignmentPalletDelete>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:consignmentNumber>?</tem:consignmentNumber>
<tem:palletNumber>?</tem:palletNumber>
</tem:UpdateConsignmentPalletDelete>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. Set the Delivered against each pallet to true.
* If some pallets were cancelled, set the PODType to DeliveredClaused. Set Delivered to false for the cancelled pallets, and the ClauseNotes to the reason code description. The signature should not be set.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. Set the Delivered flag against each pallet to false. The ClauseNotes should be blank or omitted, The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T11:59:36Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting message should be in this format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. Set the Delivered against each pallet to true.
* If some pallets were cancelled, set the PODType to DeliveredClaused. Set Delivered to false for the cancelled pallets, and the ClauseNotes to the reason code description. The signature should not be set.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. Set the Delivered flag against each pallet to false. The ClauseNotes should be blank or omitted, The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-08T11:55:35Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting message should be in this format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* If all pallets that have been successfully delivered, set the PODType to Delivered. Set the Delivered flag against each pallet to true.
* If some pallets have been delivered claused, set the PODType to DeliveredClaused. Set the ClauseNotes to the notes against the Claused pallets or the clause reason descriptions. Set the Delivered against each pallet to true.
* If some pallets were cancelled, set the PODType to DeliveredClaused. Set Delivered to false for the cancelled pallets, and the ClauseNotes to the reason code description. The signature should not be set.
* If all pallets were cancelled, set the PODType to RefusedByConsignee. Set the Delivered flag against each pallet to false. The ClauseNotes should be blank or omitted, The signature should not be set.

A single AddPOD message should be sent for the whole consignment. The Pallet repeating object should contain one record per container.

{{Note}} If a consignment contains deliveries that have been claused for different reasons, the ClauseNotes will be set to the notes against the Claused pallets or the reason code descriptions for all of claused pallets on the consignment.The trailing spaces should be removed from each field and then appended together into a single string.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. A single message should have been sent. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. A single message should have been sent. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent on both pallets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent on both pallets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

FS 333427 PART TPN - Pallet Network Interface

2016-03-07T18:16:29Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|Partnerlink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|TPN - Pallet Network Interface}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|2nd March 2016}}
{{#vardefine:Reference|333427}}
{{#vardefine:Year|2016}}
</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 ==
Partnerlink Partners David Hathaway and R Swain & Sons require an interface to update the POD Delivery details from CALIDUS ePOD into The Pallet Network (TPN).

== Solution Overview ==
Process:
* Any new partners will be set up with a new partner code within ''CALIDUS'' ePOD, will be configured for their use following the standard configuration. These will be configured for export to the TMS system in use.
* An export configuration for TPN will be created and linked to the TPN job code.
* New Jobs will be sent to Partnerlink through the existing JobShare format, or directly to the back-end TMSs.
* When planned, these jobs will be sent to ''CALIDUS'' ePOD through the existing interface in use for the existing partners, and will be identified with a new Job Group e.g. TPN. {{Note}} This will require change to the sending process from the TMS system to accommodate this new job group. The Consignment number will also be provided.
* The Partnerlink Pallet IDs will be generated as now.
* The TPN pallet IDs will be generated as an ascending numeric sequence from 1.
* The jobs will be completed like any other normal delivery.
* When jobs are completed, the existing AutoExport functionality will update the Partners (identified through their Partner Codes) using a flat-file export of the job details in OBS Logistics' XML format, as it does with each existing partner.
* The AutoExport process will also export the files to TPN Connect application, identified through the Job's Group and the configuration attached to it.
* The AutoExport functionality will store the success or failure of the export, along with any of the returned reasons from the export.

The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

The new TPN Export process will work as follows:

A message will be sent to the TPN Connect application, by connecting through the AddPOD method of their existing ThirdPartyServices webservice. One message sent per pallet on the consignment, to update a pallet and consignment with delivery, signatory and signature information. Pallets that are not marked as delivered will still have a message sent, but with the Delivered flag set to false. The pallet ID used for this update will be the TPN pallet ID generated on receipt of the order (the numeric sequence) and the consignment will be set from that provided on the order.

The response will be captured by the process and handled for success or failure.

== Scope ==
Assumptions:
* Jobs will be sent to Partnerlink and through to ''CALIDUS'' ePOD using the existing JobShare interfaces.
* It is expected that pallets for TPN will be labelled with their own network's pallet labels. It is expected that pallets will be created by ''CALIDUS'' ePOD in the normal way, identifying the individual pallets by assigning each pallet a unique ID, counting from the 1 to the total number of pallets.
* Partners completing jobs for TPN will accept updates into their Transport systems from ''CALIDUS'' EPOD in the standard OBS format - the TPN Connect system will be updated separately. This will require a modification to identify consignments as being completed for TPN when jobs are interfaced from the external Transport systems.
* The Consignment will already exist within the TPN Connect application, ready for updating with POD information from ''CALIDUS'' ePOD.
* Any new partners will be assigned a Partner Code by Partnerlink, which will be provided to OBS Logistics prior to implementation of this change.

{{Note}} There are no reason codes required on the interface to TPN Connect for failed deliveries.

{{Note}} Consignment number for TPN jobs may be up to 50 characters. At this time, the maximum job reference length of any type in ''CALIDUS'' ePOD is 20 characters. This SCR does '''''not''''' account for any changes in this length in the database, as it is assumed that this will not be required. If this is required, this will increase the development cost.

Changes will be made to latest version of {{#var:System}} only, and will require an update to all application components and full system and user acceptance testing.

This process is dependent on jobs being received into {{#var:System}} through the standard Partnerlink interface, changes to which have been specified in [[FS 326965 Partnerlink EPOD Interface]], referenced in [[#Appendix B: Quote & Document References|Appendix B]]. This change to the inbound interface may require changes to the Partner TMS systems to allow the new fields to be specified. The changes for this have been specified here for completeness. Note that no changes will be necessary to Partner TMS systems if those systems are used solely by partners that do not complete TPN jobs or have no requirement to specify linked (consolidated) jobs.

Additionally, jobs will be exported through the standard interface (also specified in the same document). As the latest version of the system is being used for the basis of this change, this may require changes to the partner TMS systems to extract the information in the new format. Note that only new fields have been added - fields have not been changed for purpose or function.

{{Note}} This change requires integration with another system, so up to 1 day has been added to the specification and testing time to allow for this. If the specification time increases beyond this time allowed due to additional work required during this stage, the estimate will be increased to cover the actual time taken.



= Set-up =

== Pre-requisites ==

== Menu Structure ==

== Data ==
* New Sites will be set up and configured for all new Partner Codes. This will be as Partnerlink standard.
* A new Job Group "TPN" will be set up for TPN jobs. This will initially be a copy of the Pall-Ex job group "PALLEX".
* A new Auto-Export configuration will be created, linked to the job group TPN:
** EPL_XF_ID - "TPN"
** EPL_XF_TYPE - "SOAP"
** EPL_XF_DIRECTION - "O"
** EPL_WEB_USER - "203obs" (test)
** EPL_WEB_PASSWORD - "obs" (test)
** EPL_XF_DESTINATION - "http://dev.tpnconnect.com/" (test) or "http://pilot.tpnconnect.com/" (live)
** EPL_SOAP_NS - "http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration"
** EPL_SOAP_NS_PREFIX - "con"
** EPL_EXPORT_JOB_TYPES - "D"

The interface of job data from the host TMS systems will be modified to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This will also pass in the Consignment Number. For TPN jobs, this will be:
* PF Tracking Number - Consignment Number
* Tracking System - "TPN"



= Functional Description =
== Database ==
The database package used to retrieve the job transfer configurations must be modified.

The package EPOD_JOB_GROUP_CONFIGS retrieves the transfer configurations for each job, for each possible transfer, namely:
* OWNER - the owning site.
* OPERATOR - the operating site.
* PALLET - any pallet network configuration

Each of these configurations if present are retrieved sequentially and grouped together and returned to the calling process.

The additional selection will be added to this and returned with the others, looking for transfer configurations for TPN.

{{Note}} Suggested amendment to SQL:
union all
SELECT c.*, 'PALLET' PARTNER_TYPE FROM
EPOD_JOB j
INNER JOIN EPOD_SITE s
ON s.EPL_SITE_ID = j.EPL_SITE_ID
INNER JOIN EPOD_JOB_GROUPS jg
ON jg.EPL_SITE_ID = j.EPL_SITE_ID
AND jg.EPL_JOB_GROUP = j.EPL_JOB_GROUP
LEFT JOIN EPOD_XF_CONFIG cjg
ON cjg.EPL_XF_CONFIG_ID = jg.EPL_XF_CONFIG
AND cjg.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cjg.EPL_EXPORT_JOB_TYPES)>0
LEFT JOIN EPOD_XF_CONFIG cs
ON cs.EPL_XF_CONFIG_ID = s.EPL_XF_CONFIG
AND cs.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,cs.EPL_EXPORT_JOB_TYPES)>0
INNER JOIN EPOD_XF_CONFIG c
ON c.EPL_XF_CONFIG_ID = CASE
WHEN (cjg.EPL_XF_CONFIG_ID IS NOT NULL) THEN cjg.EPL_XF_CONFIG_ID
ELSE cs.EPL_XF_CONFIG_ID
END
AND c.EPL_XF_ID IN ('PALLEX','FORTRACK', 'TPN')
AND CHARINDEX(J.EPL_JOB_TYPE ,c.EPL_EXPORT_JOB_TYPES)>0
WHERE J.EPL_JOB_ID=@EPL_JOB_ID and J.EPL_SITE_ID=@EPL_SITE_ID

== Admin ==
=== Export Configuration Screen ===
The Admin Export Configuration screen will be changed to allow the parameters for the new TPN extract to be specified against it.

[[File:FS_324096_ExportConfig1.PNG|border|600px]]
<br />''Export Configuration Maintenance''<br />

The ID drop-down list will be modified to allow the new values below when entering a new configuration:
* TPN

== Auto-Import ==
The Partnerlink Import process will be modified to add a field to the import process to identify the Pallet System in use (for example, Palletforce, Pall-Ex, Fortec, TPN). This has been specified in full in FS 326965 Partnerlink EPOD Interface, referenced in [[#Appendix B: Quote & Document References|Appendix B]]. The changes are as follows:

{| border="1"
|- bgcolor="silver"
!# !!Field Name !!Type !!Max Length !!width="50%"|Notes
|-
|bgcolor="red"|63 ||PF Depot ||C ||10 ||Pallet Tracking System depot code, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|64 ||PF Tracking Number ||C ||30 ||Pallet Tracking System tracking number, used when generating Pallet IDs for this pallet network.
|-
|bgcolor="red"|* ||Tracking System ||C ||29 ||This identifies any external pallet tracking system in use for this job. Currently values of "PALLET", "PALLEX", "FORTRACK", "TPN". If this is not set, and Pallet Tracking System Depot Code and Tracking number are set, defaults to "PALLET" (for the Palletforce network).
|-
|bgcolor="red"|* ||Linked ID ||C ||40 ||If this is set, any jobs with the same linked ID on the same load will be consolidated into a single delivery or collection. {{Note}} Only link jobs of the same type and partner or pallet network.
|-
|bgcolor="red"|* ||Load Information ||C ||500 ||If this is set, shown on the ePOD Device Load Information pop-up.
|}

{{Note}} Those items marked with * above have been added since the last implementation of this interface. The other items above already existed but have had their length changed.

If the new fields Linked ID and Load Information are not passed, the system will not populate the data within {{#var:System}}.

If the new field Tracking System is not passed, the system will operate as it does now (assuming PalletForce). If passed in, this will be used to set the Job Group against the incoming job.

If the Tracking System has been set to "TPN", the procedure should generate the pallet IDs at the same time as generating the Container IDs, by generating a 2-digit counter, incremented per pallet to be created, non-zero-filled. This should be saved onto the container in the field EPL_CODE_1.

== Auto-Export ==
The auto-export process retrieves all completed jobs that have not yet been transferred out of the system, and checks whether they require transfer.

Any that do not require transfer will be marked as transferred.

Any that have an applicable export configuration (see the database package modification above) will be passed to a procedure to transfer out according to the type (XF_ID) and parameters set against the configuration.

This function (EPOD_SYS_EXPORT.ExportJob) will be modified when checking EPOD_PARTNER_XF_CONFIG.EPL_XF_ID, to convert to a switch statement rather than a compound if statement. The cases are:
* PF - PalletForce (existing code) - calls EPOD_SYS_EXPORT.GeneratePalletForceContent
* PALLEX - for Pall-Ex exports (existing code) - calls EPOD_SYS_EXPORT.GeneratePallExContent.
* FORTRACK - for ForTec exports - This is added to support future development, and should drop through to the default processing with an appropriate comment.
* TPN - for TPN exports (see next section) - calls new function EPOD_SYS_EXPORT.GenerateTPNContent, defined below. The call to this function will be similar to that of the PALLEX export above.
* Default - default processing - calls EPOD_SYS_EXPORT.GenerateJobExportContent
All code will be placed in a switch statement rather than a compound if statement.

Once all the data is created, the function then sends the message in the format specified on the transfer configuration record. For TPN messages, this will require a change to the standard SOAP message processing. The function will be changed to add a section specific to Export ID "TPN", with all existing codes enclosed as the default processing. Essentially, the SOAP message should be built as normal for the POD section, then the username and password added afterwards manually.

For Export ID TPN, the function will loop through each item in the list and send this through a specific SendExportAsSoap function. {{Note}} This procedure may need a slight modification to ensure that the messages are sent in the correct format - if this is the case, existing code function should be maintained for all other messages.

The resulting message should be in this format:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:tem="http://tempuri.org/"
xmlns:con="http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration">
<soapenv:Header/>
<soapenv:Body>
<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:Pallets>
<con:POD_Pallet>
<con:Delivered>1</con:Delivered>
<con:PalletNumber>?</con:PalletNumber>
</con:POD_Pallet>
</con:Pallets>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>
</soapenv:Body>
</soapenv:Envelope>

This will then be sent to the webservice through the standard mechanism in the system, and the resulting response returned to this function.

This function will check the response and, if this is a failure, will mark the job as having failed export (exactly as it does in the existing SOAP code). The responses, if successful will follow the format of:
:Tag "whatevermethodResponse" containing tag "whatevermethodResult"
containing at least the text "Success", as below for example:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<AddPODResponse xmlns="http://tempuri.org/">
<AddPODResult>Error: Unable to authenticate with provided credentials</AddPODResult>
</AddPODResponse>
</s:Body>
</s:Envelope>

As long as the result tag exists, and the text within contains "Success", this will be seen as a successful send. Anything else (i.e. no Result tag or "Success" not contained within) will be seen as a failure.

{{Note}} This is functionally identical to the method of acknowledging Pall-Ex results and should be combined with this type.

Once this is complete, the job will be marked as having been exported for each successful export type (OPERATOR, OWNER and PALLET), based on the success of the send above. The new TPN export is seen as a PALLET export type.

When all exports have been successful, the job is marked as completely exported and will not be exported again.

The result (success or fail) and the response will be logged to the Audit table.

=== New TPN Auto-Export Process ===

{{Note}} This function will be heavily based on the existing function EPOD_SYS_EXPORT.GeneratePallExContent and will be called EPOD_SYS_EXPORT.GenerateTPNContent.

The process will then make a call to the CONNECT webservice for the method AddPOD, the root of which will be defined in the transfer configuration:
* One message will be sent for the whole consignment with each pallet number contained within the message. The consignment will be updated with the appropriate status, time, image and signatory. Each pallet will be marked as either Delivered or not.

{{Note}} Note that there will be no facility to indicate to the CONNECT webservice the reason code for each claused pallet delivery. A pallet that has been delivered with a Claused Reason code will be sent as being delivered.

For the AddPOD message, this should be placed within an AddPOD tag with the following tags:
{| border="1"
|- bgcolor="silver"
!Parameter !!Description !!Details !! Notes
|-
|userName ||Username provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_USER.
|-
|password ||Password provided by TPN ||Required ||EPOD_XF_CONFIG.EPL_WEB_PASSWORD
|-
|pod ||The POD information, containing the following tags || ||
|-
|ConsignmentNumber ||The Consignment Number ||String (50) ||EPOD_JOB.EPL_PF_TRACKING_NO.
|-
|DeliveryDateTime ||The time of Delivery ||XML Date Time format ||EPOD_JOB.EPL_ACTUAL_END_DATE/TIME
|-
|Notes ||Free text relating to the proof of delivery ||String ||EPOD_JOB.EPL_USER_NOTES
|-
|PODImage ||The Signature image in PNG format ||Bytes ||EPOD_JOB.EPL_JOB_SIGNATURE
|-
|SigneeName ||Name of person who signed the proof of delivery ||String (50) ||EPOD_JOB.EPL_CUST_SIGNATORY
|-
|SignatureOnly ||Boolean. If true, then the image only contains a signature and not a TPN POD form || Boolean || set to true at all times.
|-
|ClauseNotes ||String. Notes for a claused delivery || String || Set to the clause text or a clause reason code description, if a pallet on the consignment has been claused.
|-
|PODType ||Enum. One of Delivered, DeliveredClaused or RefusedByConsignee || Enum || Set based on Status or clause code.
|-
|Pallets Repeating Object ||
|-
|PalletNumber ||The TPN Pallet Number, if a pallet, but not the whole consignment, has been delivered ||Integer ||EPOD_CONTAINER.EPL_CODE_1.
|-
|Delivered ||Whether the pallet was delivered (true) or not (false) ||boolean ||(EPOD_JOB.EPL_STATUS=="C")
|-
|End of Pallets Repeating Object ||
|}

The process should first convert the Signature for the job to a PNG format.

The process should loop through all containers for the job. Build a list of Pallet Numbers to send.

All fields other than those following should be set as described above.
* For pallets that have been successfully delivered, set the PODType to Delivered.
* For pallets that have been delivered claused, set the ClauseNotes to the notes against the pallet or the clause reason description, and the PODType to DeliveredClaused.
* For pallets that were cancelled, set Delivered to false, the ClauseNotes to the reason code description and the PODType to RefusedByConsignee. The signature should not be set.

For complete consignment deliveries with no cancelled or claused pallets, a single AddPOD message should be sent for the whole consignment. The PalletNumber and ClauseNotes tags should be blank or omitted, Delivered set to true and PODType set to Delivered. The pallet messages need not be created.

For cancelled consignments, as single AddPOD message should be sent for the whole consignment. The PalletNumber and ClauseNotes tags should be blank or omitted, Delivered set to false and PODType set to RefusedByConsignee. The signature should not be set. The pallet messages need not be created.

The resulting XML (per message to be sent) should be placed in a list, for returning to the calling function and sending to the CONNECT webservice. The format should be as follows:

<tem:AddPOD>
<tem:userName>?</tem:userName>
<tem:password>?</tem:password>
<tem:pod>
<con:ConsignmentNumber>?</con:ConsignmentNumber>
<con:Delivered>?</con:Delivered>
<con:DeliveryDateTime>?</con:DeliveryDateTime>
<con:Notes>?</con:Notes>
<con:PODImage>?</con:PODImage>
<con:PalletNumber>?</con:PalletNumber>
<con:SigneeName>?</con:SigneeName>
<con:SignatureOnly>?</con:SignatureOnly>
<con:ClauseNotes>?</con:ClauseNotes>
<con:PODType>?</con:PODType>
</tem:pod>
</tem:AddPOD>


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Testing Exports out to the TPN CONNECT system from {{#var:System}}.
|MenuAccess=Administration/Auto-Export
|Prerequisites=A system configured as Partnerlink Test.
|Objective=To test: Auto-Export may be configured for TPN exports and; Auto-Export exports the jobs correctly to the TPN Connect system.
}} {{ #vardefine: Cycle | 0 }}{{ #vardefine: SubCycle | 0 }}
{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin System
|Notes=
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Ensure that TPN exports may be configured through the Auto-Export screen.
|Result=New Export Configurations may be created of ID TPN, allowing selection of this through the drop-down grid and displayed on the table on the screen.
|Remarks=
|PassFail=
}}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Auto-Export
|Notes=Ensure that the job groups and sites are configured to export to the TPN Connect test system.

Set up 5 orders in TPN Connect, each with 2 pallets.

Set up 7 jobs that are for a TPN export. Ensure that 2 of these jobs have a value in EPL_PF_TRACKING_NO that does not match a pre-created consignment in TPN Connect.

Start the Auto-Export process.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with a correct consignment number and all pallets delivered.
|Result=The export should show as exported successfully. A single message should have been sent. The consignment should be updated to Epod Confirmed with a signature in TPN Connect, showing the signature.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with a correct consignment number.
|Result=The export should show as exported successfully. A single message should have been sent. The consignment should show in TPN Connect as Refused. No signature should be sent.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Successfully complete a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel a job with an incorrect consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with a reason code.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent on both pallets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but clause a pallet with text.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Claused. One pallet should show as delivered, and one shown as delivered claused. A signature should be sent on both pallets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Complete a job with a correct consignment number, but cancel a pallet.
|Result=The export should show as exported successfully. 2 messages should have been sent, one per pallet. The consignment should show in TPN Connect as Delivered. One pallet should show as delivered, and one shown as refused. A signature should be sent on the delivered pallet.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Change the export configuration to point to an incorrect URL for the TPN Connect webservice. Successfully complete a job with a correct consignment number.
|Result=The export should show as an error when exported. The consignment should not be updated in TPN Connect.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=[[EST 333427 PART TPN - Pallet Network Interface]]
|RefV1=1.0
|RefDate1=18/02/2015
|Ref2=[[FS 318572 PART Job Group Level Clausing]]
|RefV2=1.0
|RefDate2=08/04/2015
|Ref3=[[FS 326965 Partnerlink EPOD Interface]]
|RefV3=1.0
|RefDate3=22/05/2015
|Ref4=ThirdPartyServices.docx
|RefV4=N/A
|RefDate4=2015
|EREQ=0
|EEST=0.25
|EFS=1.0
|ETS=1.0
|EDEV=4.5
|ESTT=0.75
|EIMP=0.25
|EPM=0.25
|REQ=0
|EST=0.25
|FS=1.0
|TS=1.0
|DEV=4.5
|ST=0.75
|IMP=0.25
|PM=0.25
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Matt Turner
|Rev1Title=OBSL Account Manager
|Rev2=John Davidson
|Rev2Title=Partnerlink Director
}}</div>
[[Category:{{#var:Client}} FS]]

EST 318572 PART Job Group Level Clausing

2015-01-29T16:55:34Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference= 
|Supimix_Number=318572
|The_version_of_the_document=2.0
|Your_Name=A N Walker
|Supimix_PO_Reference= 
|Supimix_Priority=3
|Date_(DD/MM/YY)=16/01/15
|Clients_Customer= 
|System_Version_being_changed=1.4
|Client_Request=New Clausing Requirement:
1. Clausing Reason Codes to be used on all job groups (applicable only to Palletforce currently as per log 314964)

2. Separate Reason codes will apply for 3 different Job Groups
:a Palletforce (Palletforce or other Pallet Network codes only)
:b Partnerlink (Delivery for a different Partner - Partnerlink agreed codes to be used only)
:c Partner (Owned and executed jobs to use own set of codes that link back to the Partner TMS).
3. Import change, need to split Partnerlink and Owned&executed jobs.

4. Can the TAB on the signature capture screen be changed from "Pallets" to "Clause".
|OBS_Solution=The ''CALIDUS'' ePOD system will be modified as follows:

The Reason Codes Maintenance screen will be modified to allow the users to maintain the Group for which the code entered is valid - this may be left blank to indicate codes that may be used for all jobs.
A new flag against each reason code will indicate whether this reason code is partner-specific or generic.

{{Note|Reason codes themselves must still be unique to the system - a reason code must not exist for the Palletforce job group and also for the Partners job group or Partnerlink reason codes.}}

The Site maintenance screen will be modified to add a new configuration flag to control whether the system should check if there are different reason codes for owners and operators. This will be set up enabled for Partnerlink's system.

The Job Group maintenance screen will be modified to add a new configuration flag to control whether reason codes for this Job Group are exclusive i.e. no generic Partnerlink codes may be used for jobs of this Job Group, only ones that have been specifically assigned to the Job Group. It is expected that the Pallet Network (for example Palletforce) job group will have this set. It is also possible that other Partner job groups will have this enabled, in case it is decided that the generic Partnerlink codes may not be used for jobs that are owned and operated by the same partner. In the examples contained in this estimate, I have assumed that the Partner Job Codes will allow the use of the generic codes as well as specific codes, although this configuration may be changed at any time.

These new flags and Reason codes fields will be sent to the Android PDA application.

When prompting for Clause Reason Codes at job confirmation, the device will check the settings to decide which clause reason codes to display:
* If this is a Palletforce job (i.e. in the Palletforce Job Group), the device will show only Palletforce clause reason codes.
* If this is a job owned and operated by the same partner, the device will show all generic Partnerlink clause reason codes, and also all clause reason codes specific to that partner.
* If this job is being operated on behalf of a different partner, the device will show only the generic Partnerlink clause reason codes.

{{Note|All other reason codes (e.g. cancellation reason codes) will be unaffected by this change.}}

The signature screen will be modified so that the title of the current Pallets tab will be displayed as "Clause" instead, only for the Partnerlink style.

|Requirements_Days=0
|Estimation_Days=1
|Functional_Specification_Days=1.25
|Technical_Specification_Days=1
|Development_Days=4.25
|Testing_and_Release_Days=1.25
|Implementation_Days=.25
|Project_Management_Days=1
|Year=2015
|Free_Of_Charge=N
|Supimix_Client_Code=PART}}

EST 318572 PART Job Group Level Clausing

2015-01-29T16:50:27Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference= 
|Supimix_Number=318572
|The_version_of_the_document=2.0
|Your_Name=A N Walker
|Supimix_PO_Reference= 
|Supimix_Priority=3
|Date_(DD/MM/YY)=16/01/15
|Clients_Customer= 
|System_Version_being_changed=1.4
|Client_Request=New Clausing Requirement:
1. Clausing Reason Codes to be used on all job groups (applicable only to Palletforce currently as per log 314964)

2. Separate Reason codes will apply for 3 different Job Groups
:a Palletforce (Palletforce or other Pallet Network codes only)
:b Partnerlink (Delivery for a different Partner - Partnerlink agreed codes to be used only)
:c Partner (Owned and executed jobs to use own set of codes that link back to the Partner TMS).
3. Import change, need to split Partnerlink and Owned&executed jobs.

4. Can the TAB on the signature capture screen be changed from "Pallets" to "Clause".
|OBS_Solution=The ''CALIDUS'' ePOD system will be modified as follows:

The Reason Codes Maintenance screen will be modified to allow the users to maintain the Group for which the code entered is valid - this may be left blank to indicate codes that may be used for all jobs.
A new flag against each reason code will indicate whether this reason code is partner-specific or generic.

{{Note|Reason codes themselves must still be unique to the system - a reason code must not exist for the Palletforce job group and also for the Partners job group or Partnerlink reason codes.}}

The Site maintenance screen will be modified to add a new configuration flag to control whether the system should check if there are different reason codes for owners and operators. This will be set up enabled for Partnerlink's system.

The Job Group maintenance screen will be modified to add a new configuration flag to control whether reason codes for this Job Group are exclusive i.e. no generic Partnerlink codes may be used for jobs of this Job Group, only ones that have been specifically assigned to the Job Group. It is expected that the Palletforce job group will have this set. It is also possible that other Partner job groups will have this enabled, in case it is decided that the generic Partnerlink codes may not be used for jobs that are owned and operated by the same partner. In the examples contained in this estimate, I have assumed that the Partner Job Codes will allow the use of the generic codes as well as specific codes, although this configuration may be changed at any time.

These new flags and Reason codes fields will be sent to the Android PDA application.

When prompting for Clause Reason Codes at job confirmation, the device will check the settings to decide which clause reason codes to display:
* If this is a Palletforce job (i.e. in the Palletforce Job Group), the device will show only Palletforce clause reason codes.
* If this is a job owned and operated by the same partner, the device will show all generic Partnerlink clause reason codes, and also all clause reason codes specific to that partner.
* If this job is being operated on behalf of a different partner, the device will show only the generic Partnerlink clause reason codes.

{{Note|All other reason codes (e.g. cancellation reason codes) will be unaffected by this change.}}

The signature screen will be modified so that the title of the current Pallets tab will be displayed as "Clause" instead, only for the Partnerlink style.

|Requirements_Days=0
|Estimation_Days=1
|Functional_Specification_Days=1.25
|Technical_Specification_Days=1
|Development_Days=4.25
|Testing_and_Release_Days=1.25
|Implementation_Days=.25
|Project_Management_Days=1
|Year=2015
|Free_Of_Charge=N
|Supimix_Client_Code=PART}}

EST 318572 PART Job Group Level Clausing

2015-01-29T16:50:05Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference= 
|Supimix_Number=318572
|The_version_of_the_document=0.1
|Your_Name=A N Walker
|Supimix_PO_Reference= 
|Supimix_Priority=3
|Date_(DD/MM/YY)=16/01/15
|Clients_Customer= 
|System_Version_being_changed=1.4
|Client_Request=New Clausing Requirement:
1. Clausing Reason Codes to be used on all job groups (applicable only to Palletforce currently as per log 314964)

2. Separate Reason codes will apply for 3 different Job Groups
:a Palletforce (Palletforce or other Pallet Network codes only)
:b Partnerlink (Delivery for a different Partner - Partnerlink agreed codes to be used only)
:c Partner (Owned and executed jobs to use own set of codes that link back to the Partner TMS).
3. Import change, need to split Partnerlink and Owned&executed jobs.

4. Can the TAB on the signature capture screen be changed from "Pallets" to "Clause".
|OBS_Solution=The ''CALIDUS'' ePOD system will be modified as follows:

The Reason Codes Maintenance screen will be modified to allow the users to maintain the Group for which the code entered is valid - this may be left blank to indicate codes that may be used for all jobs.
A new flag against each reason code will indicate whether this reason code is partner-specific or generic.

{{Note|Reason codes themselves must still be unique to the system - a reason code must not exist for the Palletforce job group and also for the Partners job group or Partnerlink reason codes.}}

The Site maintenance screen will be modified to add a new configuration flag to control whether the system should check if there are different reason codes for owners and operators. This will be set up enabled for Partnerlink's system.

The Job Group maintenance screen will be modified to add a new configuration flag to control whether reason codes for this Job Group are exclusive i.e. no generic Partnerlink codes may be used for jobs of this Job Group, only ones that have been specifically assigned to the Job Group. It is expected that the Palletforce job group will have this set. It is also possible that other Partner job groups will have this enabled, in case it is decided that the generic Partnerlink codes may not be used for jobs that are owned and operated by the same partner. In the examples contained in this estimate, I have assumed that the Partner Job Codes will allow the use of the generic codes as well as specific codes, although this configuration may be changed at any time.

These new flags and Reason codes fields will be sent to the Android PDA application.

When prompting for Clause Reason Codes at job confirmation, the device will check the settings to decide which clause reason codes to display:
* If this is a Palletforce job (i.e. in the Palletforce Job Group), the device will show only Palletforce clause reason codes.
* If this is a job owned and operated by the same partner, the device will show all generic Partnerlink clause reason codes, and also all clause reason codes specific to that partner.
* If this job is being operated on behalf of a different partner, the device will show only the generic Partnerlink clause reason codes.

{{Note|All other reason codes (e.g. cancellation reason codes) will be unaffected by this change.}}

The signature screen will be modified so that the title of the current Pallets tab will be displayed as "Clause" instead, only for the Partnerlink style.

|Requirements_Days=0
|Estimation_Days=1
|Functional_Specification_Days=1.25
|Technical_Specification_Days=1
|Development_Days=4.25
|Testing_and_Release_Days=1.25
|Implementation_Days=.25
|Project_Management_Days=1
|Year=2015
|Free_Of_Charge=N
|Supimix_Client_Code=PART}}

EST 318572 PART Job Group Level Clausing

2015-01-27T17:42:40Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference= 
|Supimix_Number=318572
|The_version_of_the_document=1.0
|Your_Name=A N Walker
|Supimix_PO_Reference= 
|Supimix_Priority=3
|Date_(DD/MM/YY)=16/01/15
|Clients_Customer= 
|System_Version_being_changed=1.4
|Client_Request=New Clausing Requirement:
1. Clausing Reason Codes to be used on all job groups (applicable only to Palletforce currently as per log 314964)

2. Separate Reason codes will apply for 3 different Job Groups
:a Palletforce (Palletforce or other Pallet Network codes only)
:b Partnerlink (Delivery for a different Partner - Partnerlink agreed codes to be used only)
:c Partner (Owned and executed jobs to use own set of codes that link back to the Partner TMS).
3. Import change, need to split Partnerlink and Owned&executed jobs.

4. Can the TAB on the signature capture screen be changed from "Pallets" to "Clause".
|OBS_Solution=The ''CALIDUS'' ePOD system will be modified as follows:

The Reason Codes Maintenance screen will be modified to allow the users to maintain the Group for which the code entered is valid - this may be left blank to indicate codes that may be used for all jobs.

A new flag against each reason code will indicate whether this reason code is partner-specific or generic.

A new optional text item will also be added to allow the users to maintain an Export Reason Code, used when exporting completed jobs back to external systems.

{{Note|Reason codes themselves must still be unique to the system - a reason code must not exist for one job group (for example a pallet network partner) and also for the Partners job group or Partnerlink global reason codes. If the same reason code is required across multiple job groups, the Export Reason code can be used to achieve this in the export file.}}

The Site maintenance screen will be modified to add a new configuration flag to control whether the system should check if there are different reason codes for owners and operators. This will be configured to be enabled for Partnerlink's system.

The Job Group maintenance screen will be modified to add a new configuration flag to control whether reason codes for this Job Group are exclusive i.e. no generic Partnerlink codes may be used for jobs of this Job Group, only ones that have been specifically assigned to the Job Group. It is expected that the Pallet Network (for example Palletforce) job group will have this set. It is also possible that other Partner job groups will have this enabled, in case it is decided that the generic Partnerlink codes may not be used for jobs that are owned and operated by the same partner. In the examples contained in this estimate, I have assumed that the Partner Job Codes will allow the use of the generic codes as well as specific codes, although this configuration may be changed at any time.

These new flags and Reason codes fields will be sent to the Android PDA application.

When prompting for Clause Reason Codes at job confirmation, the device will check the settings to decide which clause reason codes to display:
* If this is a Pallet Network job (e.g. in the Palletforce Job Group), the device will show only clause reason codes for this pallet network.
* If this is a job owned and operated by the same partner, the device will show all generic Partnerlink clause reason codes, and also all clause reason codes specific to that partner.
* If this job is being operated on behalf of a different partner, the device will show only the generic Partnerlink clause reason codes.

All Export processes will be modified to check reason codes when exporting completed or cancelled jobs to the external systems - the processes will look up the reason code used on the job and substitute it for the Export Reason Code is one exists.

{{Note|All other reason codes (e.g. cancellation reason codes) are expected to be unaffected by this change, as the data for these reason codes will not be modified. However, if it is decided that this functionality is applicable across all reason codes, these may be configured to act in the same way as the clause reason codes.}}
{{Note|Although this modification will support multiple pallet network job codes, currently only Palletforce is in use within Partnerlink. If other pallet networks are added into this implementation, there may be more work required when importing jobs from JobShare, and exporting completed jobs out to the external pallet network systems.}}

The signature screen will be modified so that the title of the current Pallets tab will be displayed as "Clause" instead, only for the Partnerlink style.

|Requirements_Days=0
|Estimation_Days=1.25
|Functional_Specification_Days=1.75
|Technical_Specification_Days=1.25
|Development_Days=5.75
|Testing_and_Release_Days=1.75
|Implementation_Days=.25
|Project_Management_Days=1.25
|Year=2015
|Free_Of_Charge=N
|Supimix_Client_Code=PART}}

FS 318679 SCR04 NHSBT CTMS.NET Tag to Asset Scanning

2014-10-13T11:59:43Z

Rxe: Changes to test plan in response to 321252.

<div class="noprint">
{{#vardefine:Client|NHS}}
{{#vardefine:ClientName|NHSBT}}
{{#vardefine:System|''CALIDUS'' TMS.NET}}
{{#vardefine:Doc_Title|Tag to Asset Scanning}}
{{#vardefine:Version|1.0}}
{{#vardefine:Date|2nd July 2014}}
{{#vardefine:Reference|318679 SCR04}}
{{#vardefine:Year|2014}}
</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 ==
The following changes from the Solution Design document are included in this specification:
* '''SCR-316403-107''' - Tag To Asset Scanning
: Tag to Asset Scanning system

== Solution Overview ==
The operation requires the ability to place picked order items, uniquely labelled by PULSE with Buff Tags, into polar boxes. These polar boxes come in many different sizes and shapes, but will all be identified with a uniquely identified, traceable Asset ID. The scanning of Buff Tags to Assets (Boxes) will be completed by Hospital Services. As there is no process in place within PULSE to achieve this, OBS Logistics will supply a separate scanning application. This is an addition to the original scope of the project ('''SCR-316403-107''').

This process is essential to the operation and how it wishes to operate, both for process needs (ensuring that all items are correctly boxed), but also for asset tracking, to help reduces losses of valuable assets within the network. As such, other processes within C-TMS and C-EPOD will validate that this has been completed before the orders can be advanced.

The application will be:
* accessible through a browser.
* designed in such a way to allow fast scanning of barcodes.
* be capable of being run from both a mobile device or through a PC with a browser.
Scanning will be a function of attached external scanning wedges.

The user will log on to the system and start the Tag to Asset process. This is expected to be through a browser with a keyboard wedge scanner.

The process flow is as follows:
* Scan Tag 1
* Scan Tag 2
* Scan Tag 3
* Scan Asset 1 - marks tags 1-3 as in Asset 1
* Scan Tag 4
* Scan Tag 5
* Scan Asset 2 - marks tags 4-5 in Asset 2
The user of the system will not be allowed to continue until all scanned tags are marked as in an Asset.

The screen will display all Tags and assets scanned by the user, requiring the user to confirm at the end, at which point any additional validation will be displayed and errors resolved. When an Asset is scanned and confirmed, the system will instruct C-TMS to create all Assets and assign the Buff Tags to these Assets ('''SCR-316403-25''').

If an asset is not logged within the asset register as being in this depot at this point of scanning, the asset will be marked as in this depot, and an audit history maintained.

There will be validation when scanning buff tags and asset labels, as follows:
* There may be multiple buff tags to an Asset.
* There may be multiple hospital requests (orders) in an Asset for the same hospital.
* Whether the items are allowed to be scanned together and placed into the same asset (box) - the differences will be noted by the process and the user will be forced to confirm that these items may be packed together.
* The barcodes themselves will be validated to ensure they are of the correct type. For example, Buff tags will be recognised by the AI "&x", whereas permanent Assets will be recognised by the AI "8004". No other barcodes will be allowed, and the system will automatically recognise these types and these types alone.
* An Asset must always be scanned after scanning Buff Tags.
* The Buff Tags will be validated with C-TMS to ensure that the Order exists. This will be achieved by extracting the Order Reference from the Buff Tag data (removing the AI and the last 5 digits). This will be matched to C-TMS' External Reference data to find the OMS Reference. Note: The rules governing the extraction of this data will be bespoke to this operation, rather than configurable.
* If a Buff tag is scanned multiple times, this is ignored by the application - a facility will exist using screen interaction (using buttons) to reverse any mistakes made when scanning tags.
* The status of the Asset (i.e. Active, Inactive, and Retired) will be used to check whether the Asset is available for use. If the status is not Active, the asset must not be allowed to be used, with an audible blocking error displayed on the screen (i.e. a pop-up dialogue).
The application will perform all of this this validation off-line, and will display any issues on the screen after scanning in an obvious manner.

== Scope ==
* The system is designed to make use of the existing barcode wedge scanners and equipment in already in the operation. OBS will need samples of the equipment in use, or details of how the scanner returns data, as this will be key to the validation provided by the application.
* Any changes to the format of the barcodes as described in this document will result in further changes being required to this system.
* The scanner will be configured to auto-return the data. If this is not the case, then the user will be forced to manually enter the data.


= Set-up =

== Pre-requisites ==
* A working {{#var:System}} system.

=== Core C-TMS Changes ===
* Interface routines created for:
** Order Query - identify the order from the Order Reference and return some details about the order.
** Permanent Asset Query - identify the details of the permanent asset.
** Asset Update - update the order items with the asset identified (as a parameter array). Update the assets' status and location.
** Login Query - identify and validate the user, password and access, and return the user name, depot and access control information.
* The text of the solution below provides more details on each of the procedures below, including parameters and return details required.
* Changes pertaining to original SDD SCR-316403-81: Validation is required within EPOD to show when all buff tags have not been properly scanned to Assets:
** The C-TMS - C-EPOD interface will be modified to change the Job Instructions for any loading collection jobs at the depot that have no asset information when they should have them. This will be based on the standard checks that have been specified for the C-TMS Trip Management screen under original SDD SCR-316403-61. The instructions field will be populated with "WARNING: Some items on this order have not been scanned into assets - please check.". It will then be up to the driver and Hospital Services to check whether all items that should be available are. This may require refreshing the C-EPOD device to obtain the latest information on the orders.

== Menu Structure ==
None

== Data ==
* C-TMS users must be created with access control, to allow access only to this system.


= Functional Description =
== Login ==
[[File:FS_318517_Login.PNG|border|600px]]

The login screen will be re-purposed from the existing C-CMS.NET application.

{{Note| The whole system will be styled to NHSBT standards - the OBS styling of EPOD Admin will be used as a base, with the NHSBT logo in place of the OBS logo.}}

The screen will prompt the user to enter their username and password.

This controls the depot under which the user is logged on and the access control.

Only if a user is set up for this application and if the user name and password are correct will the user be allowed to continue.

The application will submit the username and password to the server.

The server will validate this data with the database, using a new procedure created for this purpose (or reusing the existing login procedure if one exists, but validating that this is the scanning application):
* The user exists
* The password is correct
* The user has access to the scanning system
The package will return a status (Success or failure, plus reason), with some other details about the user:
* Full Name
* Depot

The application will on successful logon, display the menu/home screen.

== Menu/Home ==
This is the screen displayed when a user first logs on.

[[File:FS_318517_Main.PNG|border|600px]]

All screens in the system conform to this standard, as follows:
* A Logo and Header. The logo will be the NHSBT logo and will be fixed as part of the system. The logo will also display the logged on full user name and depot in the top right. An option to log off will be present here.
* A menu bar - see later
* A footer, floating below the main screen content. The footer will contain a link to a credits text file.

There should be a timed (session-based) log-off process built into this screen (and indeed the entire system), to ensure that the user is taken tack to the login screen if the session has not been active for longer than a proscribed time (for example 30 minutes).

The menu will be displayed as part of every screen, located on the left. The menu items that may be allowed, based on access control, are:
* Home - this link redisplays this screen.
* Tag to Asset
* Intake
* Asset Returns
Clicking on the option from the menu will display the appropriate screen.

== Tag to Asset ==

The process will be written in such a way as to ensure hands-free operation if possible (where there are no issues with either the orders for the items or the assets being scanned.

The screen will display with several sections and buttons:

[[File:FS_318679_TagToAsset.PNG|border|600px]]
* An entry prompt for Asset entry and an '''Enter''' button. The asset entry text box will be focussed for entry.
* An Error display section, below the text entry.
* A Buff Tags section, containing a table, initially empty.
* An Assets Scanned section, containing a table with a single row, initially empty.
* A '''Clear All''' button.

The Buff Tags table will be in a section that allows the contents to scroll vertically. Although the screen is designed to allow for up to 6 tags per asset on a normal sized screen, if there are more the screen will create a vertical scrolling bar for this section so the user can manually scroll to see all assets.

The Assets Scanned table will be a single header and row.

The '''Clear All''' button can be used to clear any already-entered details (Asset and Buff Tag table rows) - pressing the button will request confirmation before clearing the tables.

The entry of the buff tag data must include the barcode AI, as follows:
* &x - buff tags.
* 8004 - permanent assets

The scanner will be configured to auto-return the data, which means a carriage return will be appended to the returned barcode. The application will recognise this and automatically trigger the actions associated with the '''Enter''' button. This will also be the case if the user is keying in the barcode text and presses the Return/Enter key on the keyboard.

The Enter process will validate that the barcode begins with the AIs identified above - any other data will be ignored. This will display a warning (in large, red text format) under the barcode entry line, displaying "Barcode Type Invalid". The system will also sound an audible warning tone. The alert will quickly fade after 2 seconds. (For clarity, this type of message will be referred to as a Toast pop-up message.)

If the validation above is passed, the process will check the AI. If this is a buff tag, the details of the barcode should be extracted, as follows:
* &x: AI (Application Identifier)
* X0000000: Request, where X is the originating centre (e.g. H - Birmingham, T - Filton)
* 00000: Box ID (tag ID)
If the entered barcode does not conform to the fixed format above, a temporary warning will be displayed as before.

If the validation is passed, the application will check to see if the item has already been scanned - if so, no action will be taken or error displayed, the scan will simply be ignored.

If the item was added to the table, the data extracted will be displayed on the Buff Tag table as follows:
* ID - the Box ID extracted from the barcode.
* Order - the Request extracted from the barcode.
* Details - the fixed text "Checking..."
* Action - nothing.

This will also instigate a background (AJAX) check to the server, to procure the details of the tag. While this is occurring, the user will be able to scan more barcodes.

The server process will call the new Order Check procedure created for this purpose. The details found will include:
* Status (Success or Failure and reason)
* ID
* Order
* OMS Ref
* Destination Location
* Planned Order Date and Time Window
* Asset ID, if already planned into an asset
* Planned Trip details (if present), as follows:
** Planned Trip ID
** Planned Trip Delivery Drop ID
** Planned Trip Delivery Drop Date and Time
These will be passed back to the application (through a JSON-formatted message).

If any server error is encountered during the processing of this message (time-out, server not found, other error), the application will update the row on the Buff Tag table pertaining to this tag as follows:
* The row background colour will be set to red.
* Details - "Error encountered whilst checking with server"
* Action - A '''Remove''' button which, when clicked, will remove the row and a '''Recheck''' button which, when clicked, will instigate the background message as before.

Errors will be returned in the status if:
* The order doesn't exist
* The collection stop for the planned trip for this order has an actual depart time (i.e. the item has already been loaded).

If an error is returned, the application will update the row on the Buff Tag table pertaining to this tag as follows:
* The row background colour will be set to red.
* Details - "Error:" plus the reason for the error
* Action - A '''Remove''' button which, when clicked, will remove the row.
Examples are:
* "Order X does not exist"
* "Order X already confirmed"

If no error is encountered, the system will check the returned message for the details shown above.

If the destination location of this order is different to the destination location of any other buff tags already scanned, the application will update the row on the Buff Tag table pertaining to this tag as follows:
* The row background colour will be set to red.
* Details - "Error: Location Different" plus the Destination Location of this order.
* Action - A '''Remove''' button which, when clicked, will remove the row.

If the validation is passed, the Details line on this row in the Buff Tag table will be updated with these details. The format of this will depend on the returned data. Examples follow:

If the order is planned:
* Trip {TRIP_ID}, {TRIP_DELIVERY_DATE/ if not today}{TRIP_DELIVERY_TIME} Delivery (Drop {TRIP_DROP_ID} to {DELIVERY_LOCATION}
If the order is unplanned:
* Unplanned, {ORDER_DELIVERY_DATE/ if not today}{ORDER_DELIVERY_TIME_FROM}-{ORDER_DELIVERY_TIME_TO} Delivery at {TO_LOCATION_NAME}

The Action buttons added to this row will also depend on the returned details and further validation.

If the scanned item is planned, the application will check the trip and stop information of this item against any previous items scanned. If they are different, the line with the later delivery will be require confirmation that the item may be moved onto the earlier delivery. To reflect this:
* The row background colour will be set to amber.
* A '''Remove''' action button will be added which will, when clicked, remove the row.
* The Details cell will have some text appended below it, to show that this item will be planned with these other items.
* Pop-up help (tooltip) will be set against the row, to display more detailed information on the error, to be displayed when the user hovers over the row.

If the scanned item is not planned, the application will check the planned order times against those of tags already scanned. If the planned times do not exist within the same range, this line will be changed to show this:
* The row background colour will be set to amber.
* A '''Remove''' action button will be added which will, when clicked, remove the row.
* The Details cell will have some text appended below it, to show that this item will be planned with these other items.
* The Pop-up help (tooltip) will be set against the row, to display more detailed information on the error, to be displayed when the user hovers over the row.

The application will check whether the item has already been scanned into an asset (by checking the returned asset ID from the message). If set, the line will be changed to show this:
* The row background colour will be set to amber.
* A '''Remove''' action button will be added which will, when clicked, remove the row.
* The Details cell will have some text appended below it, to show that this item will has already been scanned, as the Asset ID.
* Pop-up help (tooltip) will be set against the row, to display more detailed information on the error, to be displayed when the user hovers over the row.

If the scanned item passes the validation, the line will be added with a simple '''Remove''' button which, when clicked, will remove the row.

The user can continue to scan items, which will follow the process and validation above. To associate all of the items together and update C-TMS with the details, a valid permanent asset must be scanned.

If the barcode scanned is an asset (AI '8004'), the asset ID will be extracted (removing the AI from the start) and a row added to the Asset table, as follows:
* ID - The extracted asset ID.
* Type - blank.
* Status - Checking...
* Action - blank.
The application will also instigate a message back to the server to check the asset. The system will show a waiting message while this is processing.

The server process will call the new Asset Check procedure created for this purpose. The details found will include:
* Status (Success or Failure and reason)
* ID
* Asset Status
* Type and description (if found).
* Details of all active orders' buff tags that have already been scanned into this asset (if any):
** Order Reference
** OMS Ref
** Buff Tag Id already associated to the asset_id
** Destination Location
** Order Early Collect Date and Time
** Order Late Collect Date and Time
** Order Early Deliver Date and Time
** Order Late Deliver date and Time
** Planned Trip details (if present), as follows:
*** Planned Trip ID
*** Planned Trip Delivery Drop ID
*** Planned Trip Delivery Drop Date and Time

Returned failure reasons may be:
* The asset is marked as inactive.
* The asset is not found.

These will be passed back to the application (through a JSON-formatted message).

If any server error is encountered during the processing of this message (timeout, server not found, other error), the application will update the row on the Buff Tag table pertaining to this tag as follows:
* The row background colour will be set to red.
* Details - "Error encountered whilst checking with server"
* Action - A '''Remove''' button which, when clicked, will remove the row and a '''Recheck''' button which, when clicked, will instigate the background message as before.
* Pop-up help (tooltip) will be set against the row, to display more detailed information on the error, to be displayed when the user hovers over the row.

{{Note}} A new asset or the same asset may be scanned again, which will remove the asset in the table and add the new one and instigate the check again.

When the message returns, the application will check the returned status. If the asset is marked as inactive, an error should be displayed (in the error section and as a toast pop-up), showing "Asset X is inactive and cannot be used".

If the response message includes details of active orders already in the asset, these buff tags will be added to the grid as new rows. Each will be validated as if they were new rows added through the scan procedure above. {{Note}} If the asset has tags associated to it, the screen will ''not'' attempt to automatically update any tags already scanned with the asset, but will require the user to press the '''Confirm''' button. Furthermore, an error will be displayed (in the error section and as a toast pop-up), showing "Asset already has tags - please confirm".

If there are no issues with the asset scanned, the row should be updated as follows:
* Type - Type and description
* Status - "Confirmed"
* Action - '''Remove''' button which, if clicked, remove the row (and the '''Confirm''' button at the bottom of the screen).
* Additionally, a '''Confirm''' button will be added to the bottom of the screen with the '''Clear All''' button.

If the asset does not exist or has no defined asset type, the Asset row will be updated:
* Type - a drop-down list of the asset types allowed by the system (the DU types from C-TMS).
* Status - "Unknown Asset"
* Action - '''Remove''' and '''Save and Confirm''' buttons
* The background colour should be red.
* Pop-up help (tooltip) will be set against the row, to display more detailed information on the error, to be displayed when the user hovers over the row.
* Additionally, a '''Confirm''' button will be added to the bottom of the screen with the '''Clear All''' button.

The '''Remove''' button should remove the row (and the '''Confirm''' button at the bottom of the screen), whereas the '''Save and Confirm''' button should validate that an asset type has been entered. If not, a pop-up alert can be displayed ("You must enter an asset type or remove the asset").

If the Asset Type is selected, the row should be changed as follows:
* Type - Type and description
* Status - "Confirmed"
* Action - '''Remove''' button which, if clicked, remove the row (and the '''Confirm''' button at the bottom of the screen).
* The row background colour should return to the normal white.
* Additionally, a '''Confirm''' button will be added to the bottom of the screen with the '''Clear All''' button.

If the Asset Type has been entered and the '''Save and Confirm''' button pressed, or the asset had no issues, or the '''Confirm''' button at the bottom of the screen is pressed, the application will validate:
* No buff tags are in error (i.e. red background).
* The asset must be entered and valid, with asset type details.
* There must be buff tags entered.

If this validation is not passed, an appropriate pop-up toast error can be displayed, showing all the issues, for example:
* "Invalid buff tags must be removed"
* "You must enter an asset type or remove the asset"
* "Buff tags must be entered for the asset."
These should also be displayed in the error section. The application should not be allowed to continue unless these problems are resolved.

If the validation is passed, the application will check if there are any warning elements on the table (i.e. buff tags that are planned for a different time or trip than others in the asset). If this is a case, a confirmation dialogue will be shown, showing all the details:
* The asset
* The buff tags with warnings and their details
* the trip and stop (or planned time window) into which these items will be moved.
* A '''Confirm''' and a '''Cancel''' button.

If the '''Cancel''' button is clicked, the user will be returned to the main screen, with all data preserved, allowing them to make modification is desired, then confirm again.

If the '''Confirm''' button is pressed, this will proceed with confirmation.

If all the validation is passed (or the confirmation dialogue is displayed and confirmed by the user), the server will be sent a message to update the asset. The application will wait while this is in progress.

The server process will call the new Asset Update procedure created for this purpose, passing in the asset and an array of all the buff tags to be associated to it. The process will:
* Create the asset if it does not exist, with the asset type as defined by the user.
* Update the asset scanned as being at this depot location if it was not already.
* Update the tags with the selected asset, or create the tags if they do not exist.
* Unplan and replan any orders that have already been planned onto other trips.
* Update the collection and delivery windows for any orders that have not yet been planned.
* Plan unplanned orders onto the earliest trip stop.
* Trigger a refresh of this order (jobs) through to C-EPOD.
The details returned will simply be the Status (Success or Failure and reason).

These will be passed back to the application (through a JSON-formatted message).

If no error is received, an update toast pop-up will be displayed, showing that the asset has been updated, with a list of the details. The Asset and Buff tags tables should be cleared, ready for the next job.


= Appendix A: TEST PLAN =
{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=Test the C-TMS.NET Scanning Solution for NHSBT.
|MenuAccess=None
|Prerequisites=Data set up as per Data Setup section.
|Objective=To test that: The system logs users in correctly and securely; the options are available to the users from a menu; the Tag to Asset process works as expected.
}} {{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Login Tests
|Notes=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log in with a user that does not exist
|Result=An appropriate error should be displayed
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log is with a valid user but the wrong password
|Result=An appropriate error should be displayed
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log in with a valid C-TMS user and password, that doesn't have access to this system.
|Result=An appropriate error should be displayed
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log in with a valid use and password
|Result=The main screen should be displayed, showing the logged in user name and depot. The menu should be displayed with all required items on it.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click the Logout button
|Result=The system should return to the login screen.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Tag to Asset Tests
|Notes=Assets should be noted for completed orders as well as available and unavailable assets at a number of locations. {{Note}} This series of tests is dependent on the completion of the CTMS packages required by this application.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Login and click the ''Tag to Asset'' menu item.
|Result=The Tag to Asset screen should be displayed, showing a Scan text box and an '''Enter''' button only.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter an "XXXXX" and click the '''Enter''' button
|Result=An appropriate error is displayed in the error section and a pop-up with the same message should appear, fading after 2 seconds. A beep should be played. Note that all errors are this type in this process and should be checked as such.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan a single trip barcode (i.e. beginning with '00' and a total of 18 digits in length).
|Result=An appropriate error is displayed.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter an invalid buff tag (e.g. &xS897HJH7H9) and press enter.
|Result=An appropriate error is displayed.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that does not exist.
|Result=A row should be added to the top of the table, showing the extracted ID and order, and a Details of "Checking..." with an amber background colour. The Scan text box should be focused.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Wait for the server response.
|Result=The row should change to show the details "Error: Order X does not exist". A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan or enter the same item again.
|Result=Nothing should happen.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Remove''' against the row.
|Result=The row should be removed.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists and is not planned.
|Result=A row should be added to the top of the table, showing the extracted ID and order, and a Details of "Checking" with an amber background colour. The Scan text box should be focused.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Wait for the server response.
|Result=The row should change to show the details "Unplanned,", with the order delivery window and destination location. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists and is planned onto a trip, with a planned time in the same window. Wait for the server response.
|Result=A row should be added to the top of the table, showing the extracted ID and order with an amber background colour. The Scan text box should be focused. The Details should show the planned Trip, Time, Stop and Destination Location. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists and is planned onto a different trip, with a planned time in the same window. Wait for the server response.
|Result=A row should be added to the top of the table, showing the extracted ID and order with an amber background colour. The Scan text box should be focused. The Details should show the planned Trip, Time, Stop and Destination Location. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists (planned or unplanned) with a different location. Wait for the server response.
|Result=A row should be added to the top of the table, showing the extracted ID and order with an amber background colour. The Scan text box should be focused. The Details should show an error that the order is to a different Destination Location. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists (planned or unplanned) with a time later than the window. Wait for the server response.
|Result=A row should be added to the top of the table, showing the extracted ID and order with an amber background colour. The Scan text box should be focused. The Details should show the planned Trip, Time, Stop and Destination Location. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists (planned or unplanned) already scanned into an Asset. Wait for the server response.
|Result=A row should be added to the top of the table, showing the extracted ID and order with an amber background colour. The Scan text box should be focused. The Details should show the planned Trip, Time, Stop and Destination Location, and the planned asset ID. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter a valid format buff tag for an order that exists (planned or unplanned) with a time earlier than the window. Wait for the server response.
|Result=This row should be added showing the planned or unplanned time, as above. A '''Remove''' button should be shown and the background should be normal white or grey.
The Scan text box should be focused.
All rows with later times should be updated with an amber background colour. The Details for each of these rows should show the planned Trip, Time, Stop and Destination Location. A '''Remove''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan a permanent Asset that does not exist.
|Result=A row should be added to the Asset Scanned table. The row should be amber and the status "Checking..."
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Wait for the server response.
|Result=The row background should change to red. A list of Asset types should be shown under Type, the status should be "Unknown Asset Type", and there should be '''Remove''' and '''Save and Confirm''' buttons. A '''Confirm''' button should be shown at the bottom of the screen.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Save and Confirm'''.
|Result=A pop-up error should be shown, describing that the asset type must be entered.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Clear the pop-up, select the asset type and click '''Save and Confirm'''.
|Result=A pop-up dialogue should be shown, describing that there are warnings and that further confirmation is required. A '''Clear All''' and a '''Confirm''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Confirm''' at the bottom of the screen.
|Result=A pop-up dialogue should be shown, describing that there are warnings and that further confirmation is required. A '''Clear All''' and a '''Confirm''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Remove''' against the Asset.
|Result=The row should be removed, as should the '''Confirm''' button on the bottom of the screen.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan an existing asset that is inactive status. Wait for the server response.
|Result=A fading pop-up and error message should be displayed "Asset X is inactive and cannot be used". The Asset row should not be changed.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan an existing asset that is active. Wait for the server response.
|Result=The asset should replace the row in the Asset Scanned table. The row background should be white. The type should be displayed. The status should be "Confirmed". A '''Remove''' button should be shown.
A pop-up dialogue should be shown, describing that there are warnings, what the items are, when they will be moved to and that further confirmation is required. A '''Clear All''' and a '''Confirm''' button should be shown.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Confirm all buff tags that require it. Click the '''Confirm''' button at the bottom of the screen.
|Result=C-TMS should be updated. All buff tags against the orders should be updated with the asset ID. All buff tags that did not exist before will have been created. All unplanned orders should be planned onto the earliest trip and stop. All orders planned onto other trips and stops should be moved onto the earliest trip and stop. A pop-up will display that the asset has been updated with a list of the details. The screen should be cleared of buff tags and assets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan or enter more than 6 buff tags from the same new order.
|Result=Each tag should be added to the Buff Tags table as above. A scroll-bar should appear on the table.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan or enter an asset that does not exist. Wait for the server response.
|Result=The row background should change to red. A list of Asset types should be shown under Type, the status should be "Unknown Asset Type", and there should be '''Remove''' and '''Save and Confirm''' buttons. A '''Confirm''' button should be shown at the bottom of the screen.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Clear All'''.
|Result=Confirmation should be requested through a pop-up alert.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Cancel this.
|Result=The screen should not clear anything, just redisplay the screen with all details as before.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Clear All'''. Confirm the action.
|Result=The Buff Tags and Asset Scanned tables will be wiped of all rows.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan multiple valid buff tags on a new unplanned order. Scan a valid new asset.
|Result=C-TMS should be updated. The buff tags should be updated with the asset ID. If the buff tags did not exist before, they will have been created. A fading pop-up will display that the asset has been updated with a list of the details. The screen should be cleared of buff tags and assets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan another buff tag for the same order. Scan the same asset.
|Result=The buff tags table should be populated will all tags from before and the new one. A fading pop-up (and the error section) will display that the asset already has tags and must be manually confirmed.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Confirm''' at the bottom of the screen.
|Result=C-TMS should be updated. The buff tags should be updated with the asset ID. If the buff tags did not exist before, they will have been created. A fading pop-up will display that the asset has been updated with a list of the details. The screen should be cleared of buff tags and assets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan another buff tag for a different order, but on for a different location. Scan the same asset.
|Result=The buff tags table should be populated will all tags from before and the new one. A fading pop-up (and the error section) will display that the asset already has tags and must be manually confirmed. All tags against the asset will be marked as in error.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Click '''Clear All''' and confirm. Scan another buff tag for a different order, but on a different trip. Scan the same asset.
|Result=The buff tags table should be populated will all tags from before and the new one. A fading pop-up (and the error section) will display that the asset already has tags and must be manually confirmed. All tags against the asset will be marked as in requiring confirmation that they will be moved to the new trip.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Confirm all buff tags that require it. Click the '''Confirm''' button at the bottom of the screen.
|Result=C-TMS should be updated. All buff tags against the orders should be updated with the asset ID. All buff tags that did not exist before will have been created. All unplanned orders should be planned onto the earliest trip and stop. All orders planned onto other trips and stops should be moved onto the earliest trip and stop. A fading pop-up will display that the asset has been updated with a list of the details. The screen should be cleared of buff tags and assets.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan a valid new asset. Click the '''Confirm''' button at the bottom of the screen.
|Result=A fading pop-up will display that buff tags must be entered.
|Remarks=
|PassFail=
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Scan multiple valid buff tags on a new unplanned order. Click the '''Confirm''' button at the bottom of the screen.
|Result=C-TMS should be updated. The buff tags should be updated with the asset ID. If the buff tags did not exist before, they will have been created. A fading pop-up will display that the asset has been updated with a list of the details. The screen should be cleared of buff tags and assets.
|Remarks=
|PassFail=
}} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=NHSBT High Level Solution Design v2.0.doc
|RefV1=2.0
|RefDate1=21/05/2014
|Ref2=FS 317907 SCR01 EPOD-TMS Interface
|RefV2= 
|RefDate2= 
|Ref3=FS-317756-NHSBT Tag to Asset Scanning
|RefV3=0.6
|RefDate3=25/06/2014
|REQ=0
|EST=0
|FS=2.5
|TS=0
|DEV=13
|ST=3.0
|IMP=0
|EREQ=0
|EEST=0
|EFS=3
|ETS=0
|EDEV=15
|ESTT=3
|EIMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=N
|Rev1=Julie Scott
|Rev1Title=Project Manager
|Rev2=Ed Bond
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 313761 AUNZ-026 LFS AUNZ POD POC Format

2014-04-10T16:40:59Z

Rxe:

<div class="noprint">
{{#vardefine:Client|LFS}}
{{#vardefine:ClientName|LFS}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|LFS AUNZ POD/POC Format}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|24th February 2014}}
{{#vardefine:Reference|313761 AUNZ-026}}
{{#vardefine:Year|2014}}
</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 ==
Proof of Delivery and Proof of Collection documents are required for Delivery and customer collection Jobs only.

There are two ways the Proof of delivery document can be issued to the customer:
:1) If a customer email is available on the contact section of the Location stored in the CTMS system, an automatic POD document can be sent to the customer at the completion of the job. It is understood that PDF format is required. There is also the option to send the EPOD document to a central email address for LFS.
:2) The Proof of Delivery / Proof of Collection documents will be available for the customer to view on-line through the web portal.

LFS have provides OBS with the format of the POD document, seen in [[#Appendix A: Report Format Examples|Appendix A]]

Further comments provided by the customer:
* The shipping Temp and the Commodity are as per the fields that are on the CTMS for Order Temp and Commodity. These are in specs AUNZ-001,AUNZ-002 and AUNZ-003.
* The delivery comments should be any notes that have been keyed in by the driver
* The POC is the same format, just changing delivery to collection.
* The watermark they want on the Signature is seen in [[#Appendix A: Report Format Examples|Appendix A]]. This is related to the PDA changes in AUNZ-013. The text is slightly different than what has been provided previously. This must show on the POD and POC note too.

== Solution Overview ==
The report will be produced in {{#var:System}} to the specifications provided - several further items of data not currently stored by the system will be passed in from ''CALIDUS'' TMS and will be used to populate the report.

The report may be viewed through direct access through the '''Report''' button in the Jobs screens in {{#var:System}} or through remote access from ''CALIDUS'' Portal.

The format has been prototyped and is as follows:

[[File:FS_313761_POD.PNG|border|600px]]

== Scope ==
* This functionality will be developed in the latest version of {{#var:System}} only.
* ''CALIDUS'' TMS requirements are mentioned only by reference in this solution - see elsewhere for specification of the changes to that system.
* {{Note}} Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =

== Pre-requisites ==
* A working {{#var:System}} system.
* A working ''CALIDUS'' TMS system, accessible to the {{#var:System}} system.

=== ''CALIDUS'' TMS Interface Changes ===
{{Note}} No change are required to the existing {{#var:System}} interface formats, as the new data will be passed in using existing fields in the interface. For clarity, this information is as follows:
* Order Date - EPL_ORDER_DATE
* Shipping Temp - EPL_CONTAINER_PACKAGE_CODE
* Commodity - EPL_DESCRIPTION_LONG

== Menu Structure ==
None

== Data ==
A Job Group record should be created for the business. The settings should include:
* Driver Signature requirements
* POD and POC format set to "LFS (AU/NZ)"


= Functional Description =
== Admin Changes ==
The Job Group and Site screens (job_group.aspx and site_header.aspx respectively) will be modified to allow the system to be configured for the new LFS report, by adding this as an option to the DDLs in the editing pop-up forms, for both POD and POC format. Additionally, the grid will be modified to display this correctly if selected. The name on the list will be 'LFS (AU/NZ)', pointing to the new report below, LFS_AUNZ.aspx.

== POD/POC Format ==
{{Note}} This format has been prototyped and is available on request for the developer to base the final formats.

The format created here should follow the standardised pagination code used in other formats.

The format will be created as LFS_AUNZ.aspx.

The fields will be mapped as follows when this is a delivery job. Note that all fields come from EPOD_JOB unless specified differently:
* Customer - EPL_CUSTOMER_NAME of EPL_CUSTOMER.
* Customer Reference - EPL_CUST_REF
* Order Date - EPL_ORDER_DATE, formatted as a long date format, plus day name.
* Origin - EPL_NAME/EPL_ADDRESS_LINE_1/2/3/4/5/EPL_POST_CODE of EPL_JOB_ADDRESS for job type "C".
* Destination - EPL_NAME/EPL_ADDRESS_LINE_1/2/3/4/5/EPL_POSTCODE of EPL_JOB_ADDRESS for job type "D".
* Delivery Instructions - EPL_JOB_INSTRUCTION
* Details - This information will come from the Containers sent to {{#var:System}}. Regardless of whether this is a collection or delivery, the information is taken from the EPOD_CONTAINERS table. The information will be concatenated on EPL_CONTAINER_PACKAGE_CODE and EPL_DESCRIPTION_LONG (the shipping temp and commodity code respectively) - this will be referred to as the group from this point onwards. There will be a maximum of 6 detail lines in this format, not including the title.
** Items - The number of containers of this matching EPL_CONTAINER_PACKAGE_CODE ND and EPL_DESCRIPTION_LONG.
** Shipping Temp - EPL_CONTAINER_PACKAGE_CODE of the group
** Commodity - EPL_DESCRIPTION_LONG of the group
** Weight - The sum of all EPL_WEIGHT fields on all records in this group
** Dimensions - EPL_CODE_1 of any of the records of this group
* Delivery Date - EPL_END_ACTUAL_DATE
* Delivery Time - EPL_END_ACTUAL_TIME
* Received By - EPL_SIGNATORY
* Delivery Comments
* Signature - the image of the customer signature from EPL_JOB_SIGNATURE. This will overlay a background containing the fixed text "ORDER RECEIVED IN FULL AND GOOD CONDITION".
All other elements on the report shall be fixed text and formatting.

For collection jobs, the following modifications will be made:
* Replace the word "Delivery" with the word "Collection" in all labels.

{{Note}} When producing this format as PDF through WkHtmlToPDF, this format should have no borders.



= Appendix A: Report Format Examples =
== Sample POD Note ==
[[File:FS_313761_POD_Sample.PNG|border|600px]]

== Sample Watermark ==
[[File:FS_313761_Watermark.PNG|border|300px]]


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0.75
|TS=0
|DEV=1.75
|ST=0.25
|IMP=0.25
|EREQ=0
|EEST=0
|EFS=0
|ETS=0
|EDEV=0
|ESTT=0
|EIMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=Y
|Rev1=Matt Tipping
|Rev1Title=Project Manager
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 313761 AUNZ-026 LFS AUNZ POD POC Format

2014-04-07T13:21:51Z

Rxe:

<div class="noprint">
{{#vardefine:Client|LFS}}
{{#vardefine:ClientName|LFS}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|LFS AUNZ POD/POC Format}}
{{#vardefine:Version|0.2}}
{{#vardefine:Date|24th February 2014}}
{{#vardefine:Reference|313761 AUNZ-026}}
{{#vardefine:Year|2014}}
</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 ==
Proof of Delivery and Proof of Collection documents are required for Delivery and customer collection Jobs only.

There are two ways the Proof of delivery document can be issued to the customer:
:1) If a customer email is available on the contact section of the Location stored in the CTMS system, an automatic POD document can be sent to the customer at the completion of the job. It is understood that PDF format is required. There is also the option to send the EPOD document to a central email address for LFS.
:2) The Proof of Delivery / Proof of Collection documents will be available for the customer to view on-line through the web portal.

LFS have provides OBS with the format of the POD document, seen in [[#Appendix A: Report Format Examples|Appendix A]]

Further comments provided by the customer:
* The shipping Temp and the Commodity are as per the fields that are on the CTMS for Order Temp and Commodity. These are in specs AUNZ-001,AUNZ-002 and AUNZ-003.
* The delivery comments should be any notes that have been keyed in by the driver
* The POC is the same format, just changing delivery to collection.
* The watermark they want on the Signature is seen in [[#Appendix A: Report Format Examples|Appendix A]]. This is related to the PDA changes in AUNZ-013. The text is slightly different than what has been provided previously. This must show on the POD and POC note too.

== Solution Overview ==
The report will be produced in {{#var:System}} to the specifications provided - several further items of data not currently stored by the system will be passed in from ''CALIDUS'' TMS and will be used to populate the report.

The report may be viewed through direct access through the '''Report''' button in the Jobs screens in {{#var:System}} or through remote access from ''CALIDUS'' Portal.

The format has been prototyped and is as follows:

[[File:FS_313761_POD.PNG|border|600px]]

== Scope ==
* This functionality will be developed in the latest version of {{#var:System}} only.
* ''CALIDUS'' TMS requirements are mentioned only by reference in this solution - see elsewhere for specification of the changes to that system.
* {{Note}} Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =

== Pre-requisites ==
* A working {{#var:System}} system.
* A working ''CALIDUS'' TMS system, accessible to the {{#var:System}} system.

=== ''CALIDUS'' TMS Interface Changes ===
{{Note}} No change are required to the existing {{#var:System}} interface formats, as the new data will be passed in using existing fields in the interface. For clarity, this information is as follows:
* Order Date - EPL_ORDER_DATE
* Shipping Temp - EPL_CONTAINER_PACKAGE_CODE
* Commodity - EPL_DESCRIPTION_LONG

== Menu Structure ==
None

== Data ==
A Job Group record should be created for the business. The settings should include:
* Driver Signature requirements
* POD and POC format set to "LFS (AU/NZ)"


= Functional Description =
== Admin Changes ==
The Job Group and Site screens (job_group.aspx and site_header.aspx respectively) will be modified to allow the system to be configured for the new LFS report, by adding this as an option to the DDLs in the editing pop-up forms, for both POD and POC format. Additionally, the grid will be modified to display this correctly if selected. The name on the list will be 'LFS (AU/NZ)', pointing to the new report below, LFS_AUNZ.aspx.

== POD/POC Format ==
{{Note}} This format has been prototyped and is available on request for the developer to base the final formats.

The format created here should follow the standardised pagination code used in other formats.

The format will be created as LFS_AUNZ.aspx.

The fields will be mapped as follows when this is a delivery job. Note that all fields come from EPOD_JOB unless specified differently:
* Customer - EPL_CUSTOMER_NAME of EPL_CUSTOMER.
* Customer Reference - EPL_CUST_REF
* Order Date - EPL_ORDER_DATE, formatted as a long date format, plus day name.
* Origin - EPL_NAME/EPL_ADDRESS_LINE_1/2/3/4/5/EPL_POST_CODE of EPL_JOB_ADDRESS for job type "C".
* Destination - EPL_CUSTOMER_NAME/EPL_ADDRESS_LINE_1/2/3/4/5/EPL_POSTCODE of EPL_JOB_ADDRESS for job type "D".
* Delivery Instructions - EPL_JOB_INSTRUCTION
* Details - This information will come from the Containers sent to {{#var:System}}. Regardless of whether this is a collection or delivery, the information is taken from the EPOD_CONTAINERS table. The information will be concatenated on EPL_CONTAINER_PACKAGE_CODE and EPL_DESCRIPTION_LONG (the shipping temp and commodity code respectively) - this will be referred to as the group from this point onwards. There will be a maximum of 6 detail lines in this format, not including the title.
** Items - The number of containers of this matching EPL_CONTAINER_PACKAGE_CODE ND and EPL_DESCRIPTION_LONG.
** Shipping Temp - EPL_CONTAINER_PACKAGE_CODE of the group
** Commodity - EPL_DESCRIPTION_LONG of the group
** Weight - The sum of all EPL_WEIGHT fields on all records in this group
** Dimensions - EPL_CODE_1 of any of the records of this group
* Delivery Date - EPL_END_ACTUAL_DATE
* Delivery Time - EPL_END_ACTUAL_TIME
* Received By - EPL_SIGNATORY
* Delivery Comments
* Signature - the image of the customer signature from EPL_JOB_SIGNATURE. This will overlay a background containing the fixed text "ORDER RECEIVED IN FULL AND GOOD CONDITION".
All other elements on the report shall be fixed text and formatting.

For collection jobs, the following modifications will be made:
* Replace the word "Delivery" with the word "Collection" in all labels.

{{Note}} When producing this format as PDF through WkHtmlToPDF, this format should have no borders.



= Appendix A: Report Format Examples =
== Sample POD Note ==
[[File:FS_313761_POD_Sample.PNG|border|600px]]

== Sample Watermark ==
[[File:FS_313761_Watermark.PNG|border|300px]]


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0.75
|TS=0
|DEV=1.75
|ST=0.25
|IMP=0.25
|EREQ=0
|EEST=0
|EFS=0
|ETS=0
|EDEV=0
|ESTT=0
|EIMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|FOC=Y
|Rev1=Matt Tipping
|Rev1Title=Project Manager
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

EST 315767 K-5 Load Complete (Amended) Status

2014-03-21T13:06:02Z

Rxe:

EST 315767 K-5 Load Complete (Amended) Status

2014-03-21T12:57:55Z

Rxe:

EST 315767 K-5 Load Complete (Amended) Status

2014-03-21T12:37:13Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference=K-5
|Supimix_Number=315767
|The_version_of_the_document=0.1
|Your_Name=A Walker
|Supimix_PO_Reference=Unknown
|Supimix_Priority=3
|Date_(DD/MM/YY)=27/02/2014
|Clients_Customer=N/A
|System_Version_being_changed=Latest
|Client_Request=Admin Portal - Load Summary Screen - Loads stay green even with a clause on a pallet
|OBS_Solution={{#vardefine:System|''CALIDUS'' ePOD}}
{{Note}} There is a known bug reported by Partnerlink regarding "Complete (Amended)" Status with {{#var:System}}, logged under Supimix reference 314743.

The existing functionality (developed under reference 305796) is as follows:
:When a product is cancelled or had their quantity changed, the PDA client will mark the parent Container and Job records with a status showing that the job was completed with amendments.
:When a container is cancelled, the PDA client mark the job record with a status showing that the job was completed with amendments.
:These details are sent back to the Server and saved on the database there.
:The {{#var:System}} Admin ''Job'', ''Job Product'' and ''Containers'' screens will display items marked as amended with "Complete (Amended)" status.

This functionality will be modified as follows:
* A Load that holds modified Jobs will be updated to show that amendments have occurred.
* Whenever a Job is marked as Amended or Cancelled, the Load containing the Job will be tagged as "Complete (Amended)" status within the {{#var:System}} Admin Load screen.
* The functionality that highlights Jobs as amended will be made available:
:Whenever a product is cancelled claused or the quantity changed, the PDA client will mark the parent Container and Job records with a status showing that the job was completed with amendments.
:The {{#var:System}} Admin Job, Job Product and Containers screens display items marked as amended with "Complete (Amended)" status.

|Requirements_Days=0
|Estimation_Days=0.25
|Functional_Specification_Days=0.5
|Technical_Specification_Days=0
|Development_Days=1.5
|Testing_and_Release_Days=0.25
|Implementation_Days=0.25
|Project_Management_Days=0.25
|Year=2014}}

EST 315767 K-5 Load Complete (Amended) Status

2014-03-21T12:36:05Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference=K-5
|Supimix_Number=315767
|The_version_of_the_document=0.1
|Your_Name=A Walker
|Supimix_PO_Reference=Unknown
|Supimix_Priority=3
|Date_(DD/MM/YY)=27/02/2014
|Clients_Customer=N/A
|System_Version_being_changed=Latest
|Client_Request=Admin Portal - Load Summary Screen - Loads stay green even with a clause on a pallet
|OBS_Solution={{#vardefine:System|''CALIDUS'' ePOD}}
{{Note}} There is a known bug reported by Partnerlink regarding "Complete (Amended)" Status with {{#var:System}}, logged under Supimix reference 314743.

The existing functionality (developed under reference 305796) is as follows:
:When a product is cancelled or had their quantity changed, the PDA client will mark the parent Container and Job records with a status showing that the job was completed with amendments.
:When a container is cancelled, the PDA client mark the job record with a status showing that the job was completed with amendments.
:These details are sent back to the Server and saved on the database there.
:The {{#var:System}} Admin ''Job'', ''Job Product'' and ''Containers'' screens will display items marked as amended with "Complete (Amended)" status.

This functionality will be modified as follows:
* A Load that holds modified Jobs will be updated to show that amendments have occurred.
* Whenever a Job is marked as Amended or Cancelled, the Load containing the Job will be tagged as "Complete (Amended)" status within the {{#var:System}} Admin Load screen.
* The {{#var:System}} Admin ''Load'' screen will display Loads marked as amended with "Complete (Amended)" status.
|Requirements_Days=0
|Estimation_Days=0.25
|Functional_Specification_Days=0.5
|Technical_Specification_Days=0
|Development_Days=1.5
|Testing_and_Release_Days=0.25
|Implementation_Days=0.25
|Project_Management_Days=0.25
|Year=2014}}

EST 315767 K-5 Load Complete (Amended) Status

2014-03-21T12:35:21Z

Rxe:

{{Template:Estimate
|Supimix_Client_Code=PART
|Supimix_Project_Code=DEV
|Supimix_Site_Code=PART
|Supimix_Client_Reference=K-5
|Supimix_Number=315767
|The_version_of_the_document=0.1
|Your_Name=A Walker
|Supimix_PO_Reference=Unknown
|Supimix_Priority=3
|Date_(DD/MM/YY)=27/02/2014
|Clients_Customer=N/A
|System_Version_being_changed=Latest
|Client_Request=Admin Portal - Load Summary Screen - Loads stay green even with a clause on a pallet
|OBS_Solution={{#vardefine:System|''CALIDUS'' ePOD}}
{{Note}} There is a known bug reported by Partnerlink regarding "Complete (Amended)" Status with {{#var:System}}, logged under Supimix reference 314743.

The existing functionality (developed under reference 305796) is as follows:
:When a product is cancelled or had their quantity changed, the PDA client will mark the parent Container and Job records with a status showing that the job was completed with amendments.
:When a container is cancelled, the PDA client mark the job record with a status showing that the job was completed with amendments.
:These details are sent back to the Server and saved on the database there.
:The {{#var:System}} Admin ''Job'', ''Job Product'' and ''Containers'' screens will display items marked as amended with "Complete (Amended)" status.

This functionality will be modified as follows:
* A Load that holds modified Jobs will be updated to show that amendments have occurred.
* Whenever a Job is marked as Amended or Cancelled, the Load will be tagged as amended.
* The {{#var:System}} Admin ''Load'' screen will display Loads marked as amended with "Complete (Amended)" status.
|Requirements_Days=0
|Estimation_Days=0.25
|Functional_Specification_Days=0.5
|Technical_Specification_Days=0
|Development_Days=1.5
|Testing_and_Release_Days=0.25
|Implementation_Days=0.25
|Project_Management_Days=0.25
|Year=2014}}

FS 314964 Palletforce Interface changes

2014-03-19T13:03:42Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 the text in the list will be displayed as 'Claused' but the value stored in the database will be '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 expected to choose a reason code from the list. The list will 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. 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. 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. All fields will be checked for the existence of commas entered as part of the text. If they exist, they will be replaced with space characters before the message is sent.

Note that cancelled containers will not be sent as part of the process. This may be expected to change in future. In this scenario further changes may be required.

== 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 following is added for clarification purposes following testing:
The Claused Container pop-up screen will only become visible if the site level flag is set to 'Y'.
The decision to prompt for the Reason Code will then be dependant on the Job Group level flag.

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'. The user will be expected to choose the reason for marking the delivery as claused. The list will be a required field.



= Appendix A: TEST PLAN =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=5.0
|ST=1.0
|IMP=0.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T16:18:14Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_NUMBER
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_JOB_SIGNATURE
* Printed Name - EPL_CUST_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Claused" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T15:48:18Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_NUMBER
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_ENG_SIGNATURE
* Printed Name - EPL_CUST_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Claused" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T15:30:00Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_NUMBER
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_ENG_SIGNATURE
* Printed Name - EPL_CUST_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Delivered" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T15:28:57Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_NUMBER
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_SIGNATURE
* Printed Name - EPL_CUST_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Delivered" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T15:14:49Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_NUMBER
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_SIGNATURE
* Printed Name - EPL_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Delivered" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T15:10:21Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_NUMBER
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_SIGNATURE
* Printed Name - EPL_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Delivered" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 315770 K-13 PART POD Format Rework

2014-03-14T14:56:24Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|POD Format (Rework)}}
{{#vardefine:Version|0.3}}
{{#vardefine:Date|7th March 2014}}
{{#vardefine:Reference|315770/K-13}}
{{#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 ==
Fix the POD format created for Partnerlink, referenced in [[#Appendix_A:_Quote_.26_Document_References|Appendix A]].

== Solution Overview ==
A POD report format will be produced.

This format will be configurable against the Partners.

== Scope ==
* These changes will be made in the latest version of the {{#var:System}} system.
* Best efforts will be made to match the produced format to the sample provided, but differences in production and presentation (i.e. Browser, Email, etc) may result in some small differences.


= Set-up =
== Pre-requisites ==

== Menu Structure ==
None

== Data ==
Ensure Job Groups must be configured to use the Partnerlink format, where required.

Ensure an EPOD_CUSTOMER record is created for the EP_SITE_ID, populated as follows:
* EPL_CUSTOMER_NAME, EPL_ADDRESS_1/2/3/4, EPL_POST_CODE, EPL_TELEPHONE - As required
* EPL_ADDRESS_LINE_5 - URL e.g. http://www.knightsofold.ltd.uk for site L03 (KOO).

Ensure Logos are uploaded for the Sites (on EPOD_SITE).


= Functional Description =
== Database/DAL Changes ==
Table EPOD_JOB_ADDRESS requires the following modification:
* EPL_NAME - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_ADDRESS_INSERT
* EPOD_JOB_ADDRESS_DELETE
* EPOD_JOB_ADDRESS_SELECT
* EPOD_JOB_ADDRESS_UPDATE

The existing EPOD_JOB_ADDRESS DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

Table EPOD_JOB requires the following modification:
* EPL_ACCOUNT - nvarchar(40)

Existing packages will be modified to allow the creating, editing and selecting of the new field, including but not limited to:
* EPOD_JOB_INSERT
* EPOD_JOB_DELETE
* EPOD_JOB_SELECT
* EPOD_JOB_UPDATE

The existing EPOD_JOB DAL object will be changed to:
* Export the new field in XML requests
* Read the new field

{{Note}} It is not necessary to add this field as a searchable item. However, if allowing this keeps the packages and DAL objects standard in design, then this can also be done, within the DAL and the packages.

== Import/Export Changes ==
The Partnerlink Import process will be modified to populate the following fields from the incoming file:
* EPL_ACCOUNT of EPOD_JOB - populated from column 58 (Account Code).
* EPL_NAME of EPOD_JOB_ADDRESS - populated from column 7 (Col Name) for Collection Addresses, from column 18 (Del Name) for Delivery Addresses. Both job addresses should be written at all times, as both are present on the incoming file.

== POD Report Format ==
The final format will look like this prototype:

[[File:FS_315770_POD.PNG|600px|border]]

Mapped fields on the POD report have not changed from the original specification. However, these are re-stated here for clarity.
* Partner Logo - taken from EPL_LOGO of EPOD_SITE for this EPL_SITE_ID
* Partner URL - taken from EPL_ADDRESS_5 of the EPOD_CUSTOMER record for this EPL_SITE_ID
* Partnerlink Logo - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Partnerlink URL - fixed text as "http://www.partnerlink.ltd.uk" - removed if this is a Palletforce job (i.e. EPL_JOB_GROUP = "PALLET")
* Customer - EPL_ACCOUNT
* Consignment Details - EPL_JOB_CODE
* Consignor - the address of the consignor (collection address). This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "C". If this does not exist and this is a collection job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this is a delivery job, this should be populated from the Partner address, by retrieving the EPOD_CUSTOMER record for this EPL_SITE_ID. If this does not exist, use the Site information (EPOD_SITE.EPL_SITE_NAME) with no address (blank).
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER), EPL_SITE_NAME (if EPOD_SITE)
** Address - EPL_ADDRESS_1/2/3/4 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Deliver To - the delivery address. This will come from EPOD_JOB_ADDRESS for this EPL_JOB_ID, where EPL_JOB_TYPE = "D". If this does not exist and this is a delivery job, this should be populated from the the EPOD_CUSTOMER record for this EPL_CUSTOMER_CODE. If this does not exist, this should be blank.
** Company - EPL_NAME (if EPOD_JOB_ADDRESS), EPL_CUSTOMER_NAME (if EPOD_CUSTOMER)
** Address - EPL_ADDRESS_1/2/3/4/5 of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Postcode - EPL_POST_CODE of EPL_CUSTOMER or EPOD_JOB_ADDRESS
** Phone - EPL_PHONE_NO of EPL_CUSTOMER or EPOD_JOB_ADDRESS
* Driver - EPL_USER_ID of EPOD_DRIVER
* Vehicle - EPL_VEHICLE_REG of EPOD_VEHICLE
* Track Num - EPL_EXT_REF
* Trailer Number - EPL_TRAILER_ID
* Col Date - EPL_COL_DATE
* Manifest Number - EPL_LOAD_ID
* Del Date - EPL_START_PLANNED_DATE
* Service - EPL_SERVICE_LEVEL
* Del Time - EPL_START_PLANNED_TIME. {{Note}} The display of this time should be suppressed (i.e. not displayed on the report) if the value of this field is "2359".
* Conditions - Hard-coded as "CONDITIONS: ALL GOODS HANDLED IN ACCORDANCE WITH THE COMPANY'S OWN CONDITIONS, COPIES OF WHICH ARE AVAILABLE ON APPLICATION."
* Customer Ref - EPL_CUST_REF
* Customer Ref2 - EPL_SO_REF
* Consignment Instructions - EPL_JOB_INSTRUCTION
* Total Packs - Calculated from number of the job's container records (not including loose products)
* Total Weight - sub-totalled from EPL_GROSS_WEIGHT of the job's container records (not including loose products)
* Consignee Signature - EPL_SIGNATURE
* Printed Name - EPL_SIGNATORY
* Date - EPL_END_ACTUAL_DATE
* Arrival Time - EPL_ARRIVAL_TIME
* Departure Time - EPL_END_ACTUAL_TIME
{{Note}} All fields are from EPOD_JOB unless otherwise specified.

The details section is mapped as follows:
* Consignment Packs - EPL_CONTAINER_ID
* Status - the translated status, as follows:
** "Delivered" - EPL_STATUS = "C"
** "Cancelled" - EPL_STATUS = "X"
** "Delivered" - EPL_STATUS = "C" and EPL_REASON_CODE not blank, or EPL_CUST_COMMENTS not blank
* Notes - EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "DET" (if present and EPL_STATUS = "X"), else EPL_REASON_CODE and EPL_DESCRIPTION of EPOD_REASON_CODE of type "CLA" (if present and EPL_STATUS = "C"), else EPL_CUST_COMMENTS.
{{Note}} All fields are from EPOD_CONTAINER unless otherwise specified.

Differences from original designed report:
* "DRIVER COPY" is now "PROOF OF [EPL_JOB_TYPE.translated]" e.g for a Delivery job, this would be "PROOF OF DELIVERY".
* Customer is now set from the account code on the incoming file.
* The "Del Time" value is suppressed if this is "2359"
* The "Item" title on the details section is now "Consignment Packs"
* The following labels and data are all vertically aligned: Track Num, Manifest Number, Service, Driver, Vehicle, Trailer, Col Date, Del Date, Del Time.
* Labels are now bold

Additional differences from coded report:
* Correct Partnerlink Logo
* URLs for the respective businesses in the header
* General formatting of the POD (border lines, heading positions, spacing, size of text, etc)
* Correct formatting and positioning of Signature box
* Correction of Arrival title (colons)
* General correction of spacing between labels and data
* Correct number of lines in details section (30 lines)
* Data mapped correctly for the following fields (see above for details):
** Consignment Details
** Track Num
** Customer Ref2
** Departure Time

As there is a possibility that the number of containers will exceed that allowable on a page, the format should be written as a paginated document. The style of this should be copied from previous examples (e.g. ALS.aspx/ALS.aspx.cs).

The specific requirements of this format are:
* 30 lines should be allowed per page.
* The Container list should be recognised as the Detail portion of the document, the rest seen as the header.
* The header should be shown on each page, ensuring that the signature is shown at all times.
* There is no footer section

== Notes on how to develop POD formats for {{#var:System}} ==
* All new reports should be created by using existing pagination code - this should be centralised and reusable where possible.
* To simplify development, existing reports ''that already use the pagination code'' should be copied.
* Pagination allows for a string definition of just the following 3 sections: Header, Details and Footer. {{Note}} This may be extended in time to Initial and Final headers, plus Page Header and Footers.
* The call of the Pagination object (ReportPager) allows for the configuration of each section (for example, whether a particular section should be displayed, whether to reserve space for it, etc) - see this code and extensive examples for details of how this works and how to extend this for your report, if necessary.
* A prototype is always created in plain text - use this to copy in the header, detail and footer sections, escaping special characters as required. Also use this to source the correct CSS.
* Each section is defined in the C#.NET file (i.e. the "aspx.cs" file) rather than defined as objects in the asp.NET file (i.e. the ".aspx" file), modifying the copied populateReport method and any called methods, such as generateContent, generateHeader, generateFooter. These will be built by copying the provided prototype HTML code replacing data from the records found, escaping special characters as required. Note that data may be retrieved from globally- or locally-declared DAL objects within the report, if this is required.
* All other methods in the C#.NET file should be common to all POD reports, as follows:
** private int ValidateUser()
** public void Page_Error(object sender, EventArgs e)
** protected void Page_Load(object sender, EventArgs e)
** protected override void Render(HtmlTextWriter writer)
** protected override void OnUnload(EventArgs e)
** protected void emailBT_clicked(object sender, EventArgs e)
** private string convertJobType(String EPL_JOB_TYPE)
** public static int roundup(int i)
* The asp.NET file contains only:
** The required CSS code for this format, sourced mainly from the prototype rather than the copied source code.
** The "Email" div
** A general "POD" div.
* When complete:
** Check against the prototype - pay particular attention to line breaks (both forced by the HTML BR tag and those automatically placed into data and labels by size restrictions.
** Check the final PDF result by converting the produced page to PDF using the conversion tool.
** It should not then be necessary to check on multiple browsers, as the prototype has already been tested against all major browsers and likely versions, such as:
*** Firefox (latest)
*** Chrome (latest)
*** Internet Explorer 11
*** Internet Explorer 6-10 (through emulation)
*** Safari (through PDF conversion)

When creating a report following these instructions, the produced report should match the prototype completely, and therefore there is less chance of a customer being unhappy upon delivery, having received a report that does not match the specification and prototype that they agreed before development commenced.


{{Doc_Appendix
|Appendix=A
|Estimate=Y
|FOC=Y
|Glossary=EPOD
|Ref1=[[FS_304709_Partnerlink_POD_Format|FS 304709 Partnerlink POD Format]]
|RefV1=0.2
|RefDate1=27/08/2013
|REQ=0
|EST=0
|FS=0.5
|TS=0
|DEV=3.0
|ST=0.25
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-13T14:36:56Z

Rxe: /* Palletforce File Export Changes */

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 the text in the list will be displayed as 'Claused' but the value stored in the database will be '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 expected to choose a reason code from the list. The list will 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. 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. 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. All fields will be checked for the existence of commas entered as part of the text. If they exist, they will be replaced with space characters before the message is sent.

Note that cancelled containers will not be sent as part of the process. This may be expected to change in future. In this scenario further changes may be required.

== 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'. The user will be expected to choose the reason for marking the delivery as claused. The list will be a required field.



= Appendix A: TEST PLAN =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=5.0
|ST=1.0
|IMP=0.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T13:55:43Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 the text in the list will be displayed as 'Claused' but the value stored in the database will be '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 expected to choose a reason code from the list. The list will 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. 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. 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'. The user will be expected to choose the reason for marking the delivery as claused. The list will be a required field.



= Appendix A: TEST PLAN =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=5.0
|ST=1.0
|IMP=0.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T13:53:21Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 the text in the list will be displayed as 'Claused' but the value stored in the database will be '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 expected to choose a reason code from the list. The list will 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. 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. 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'. The user will be expected to choose the reason for marking the delivery as claused. The list will be a required field.



= Appendix A: TEST PLAN =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=N
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T13:50:40Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 the text in the list will be displayed as 'Claused' but the value stored in the database will be '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. 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. Otherwise, this field should be left blank. Note that only completed jobs

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 =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=N
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T13:31:42Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 expected to choose a reason code from the list. The list will 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'. The user will be expected to choose the reason for marking the delivery as claused. The list will be made a required field.



= Appendix A: TEST PLAN =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=5
|ST=1.0
|IMP=0.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T13:20:10Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=Y
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=5
|ST=1.0
|IMP=0.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T13:17:53Z

Rxe:

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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 =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=N
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=1.5
|TS=0
|DEV=5
|ST=1.0
|IMP=0.5
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]

FS 314964 Palletforce Interface changes

2014-02-12T09:46:26Z

Rxe: /* Scope */

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' ePOD}}
{{#vardefine:Doc_Title|Palletforce Interface Changes}}
{{#vardefine:Version|0.1}}
{{#vardefine:Date|7th February 2014}}
{{#vardefine:Reference|314964}}
{{#vardefine:Year|2014}}
</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 ==
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 {{#var:System}} system.
* These changes will only be made to the Android version of the PDA client.



= Set-up =

== Pre-requisites ==

== Menu Structure ==
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.
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. 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. 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 =

{{TestPlan_Header
|Title={{#var:Doc_Title}}
|Log={{#var:Reference}}
|Description=To test the production of the outbound Palletforce export process to ensure the new Claused delivery fields are included in {{#var:System}}
|MenuAccess=Job Group Maintenance, Reason Code Maintenance
|Prerequisites=Ensure that Palletforce job groups are defined against the required sites
|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.
}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Admin
|Notes=Setup Job Groups to allow Claused Reasons to be sent. Setup Claused Reason Codes in Reason Code Maintenance.
}} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=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'
|Result=Each Job Group can be configured to use 'Claused Reasons' or not.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Log into Reason Code Maintenance. Check that new 'Claused' reason codes can be defined.
|Result=Reason Codes of type 'Claused' can be created.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Enter/Find a job that is 'In Progress'. Enter the Details screen and then click 'Select' on one of the Container records.
|Result=The Option to enter a 'Claused Reason' should now be available.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}
{{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }}{{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=PDA - Process
|Notes=Check the user is prompted for a Claused Reason Code when appropriate.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Process a job for the Job Group in question. Enter the Claused Reasons canvas.
|Result=The user should be prompted for a Claused reason code as well as the current Claused free text box.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Delete the Claused Reason Code definitions from Reason Code Maintenance and repeat the last test.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Add the Claused Reason Code definitions back but set the job group not to prompt for Claused Reason codes.
|Result=The user should no longer be able to enter a 'Claused Reason'.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}

{{TestPlan_CycleHeader
|Cycle={{ #vardefineecho: Cycle | {{ #expr: {{ #var: Cycle }} + 1 }} }}{{ #vardefine: SubCycle | {{ #var: Cycle }} }}
|Title=Export process - Palletforce
|Notes=Check that two new fields are included at the end of each line. Check that the file extension of the file produced is .epd.
}}  {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason and Claused Reason text.
|Result=Check the Claused Reason Code and Claused text are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_Test
|Test={{ #vardefineecho: SubCycle | {{ #expr: {{ #var: SubCycle }} + 0.01 }} }}
|Action=Create an outbound Palletforce Export file for a job that has a Claused Reason but no Claused Reason text.
|Result=Check the Claused Reason Code and Reason Code description are included in the output file produced.
|Remarks= |PassFail= }} {{TestPlan_CycleFooter}}


{{Doc_Appendix
|Appendix=B
|Estimate=N
|Glossary=EPOD
|Ref1=
|RefV1=
|RefDate1=
|REQ=0
|EST=0
|FS=0
|TS=0
|DEV=0
|ST=0
|IMP=0
|Client={{#var:Client}}
|Year={{#var:Year}}
|FSEST=Y
|Rev1=Phil Harding
|Rev1Title=OBS Project Manager
|Rev2=Andrew Allison
|Rev2Title=Client Representative
}}</div>
[[Category:{{#var:Client}} FS]]