View source for FS 305796 EPOD Vigo Interface

<div class="noprint">
{{#vardefine:Client|PART}}
{{#vardefine:ClientName|PartnerLink}}
{{#vardefine:System|''CALIDUS'' EPOD}}
{{#vardefine:Doc_Title|EPOD Vigo Interface}}
{{#vardefine:Version|0.4}}
{{#vardefine:Date|20th February 2013}}
{{#vardefine:Reference|305796}}
{{#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}}
}} 

<!-- TOC --> 
<div class="noprint">
= Functional Overview  =
The document is intended to describe the exact requirements for the Vigo TMS system interfacing to and from the ''CALIDUS'' EPOD system.

== Client Requirement  ==
The requirements were captured from the Partnerlink staff on 18/01/2013, at the Kettering operation.

* The Vigo system will send messages to the ''CALIDUS'' EPOD system to define Loads and Trips to be completed.
* The ''CALIDUS'' EPOD system will inform the Vigo system that the jobs are completed or cancelled.

{{Note}} There is also a requirement to interface an image of the generated POD document to all TMS systems being used by the PartnerLink partners. This will be covered in a separate document, as this will make use of the existing image upload processing available in the TMS systems.

== Solution Overview  ==
A new interface to and from ''CALIDUS'' EPOD will be created. This will be heavily based around the existing JobShare interface.

The summary of the solution requirements are:
* Standing Data (Vehicles, Users, Reason Codes, Job Groups, Sites) will be manually set up within ''CALIDUS'' ePOD - no automated drip-feed of this data will be entered into.
* Sending of data to ''CALIDUS'' ePOD will be through a new Partnerlink CSV format.
* Receiving data from ''CALIDUS'' ePOD will be through the OBS XML format.
* The mechanism of sending and receiving data will be through Flat File transfer via a shared folder on the Vigo system
* The sending of data to ''CALIDUS'' ePOD will be through a manual option within the Vigo system ("Send to ePOD").
* The Vigo system must merge of Delivery and Collection manifests into a single Consolidated Manifest when sending data.
* The Vigo system must sort the data by Type (Deliveries first, then Collections), the planned start time, if available, or sequence to be completed, as required by the customer (Partnerlink).
* Amendments to the manifests sent will not be automatically re-exported to ''CALIDUS'' ePOD - all amendments will be manually resent on demand by the user through the mechanism above.
* ''CALIDUS'' ePOD exporting of completed or cancelled jobs will be through a timed process, expected to be every 5 minutes.
Out of scope of this document:
* ''CALIDUS'' ePOD will be modified to export the POD/POC documents through the standard JobShare Image Upload system.

This will require the Vigo system to be modified as follows:
* Consolidate manifests that are assigned to the same user and vehicle onto a new Consolidated Manifest ID.
* Convert the information into an agreed CSV format (described here).
* FTP or copy the file containing the CSV-formatted payload to an agreed folder.
* Create a process for importing data back into the Vigo TMS from an XML flat file in the OBS XML format.

== Scope  ==

{{Note}} There are modifications being made to the ''CALIDUS'' EPOD system, both for product enhancement and specifically for the Partnerlink customer that are driving changes into both the import and export functionality described here. Some have not yet been finalised. All known modifications to the schemas have been added to this document. Should any further requirements be known after this document is issued, this document will be revised and reissued at that time.

{{Note}} Future modifications may be made to the exporting of data from ''CALIDUS'' EPOD to the Vigo system. When modifications of this nature are made, a new validation schema (XSD) for the XML payload will be issued. The modifications to the Vigo system to import this data should be made in such a way that this new XSD can be replaced into the system without program modifications in the future.

{{Note}} It is not deemed necessary at this time to map interfaces from Vigo for Standing Data, as it was agreed that this would be maintained separately and manually within ''CALIDUS'' EPOD. Those flows are:
* Vehicles
* Reason Codes (used when cancelling jobs or pallets)
* Users (Drivers)
* Customers

{{Note}} A number of actions are outstanding from this meeting regarding the production of this interface specification, as follows:
* Partnerlink to provide a list of existing Partner Codes in use.
* Partnerlink to provide a document of the standard Reason Codes in use.
* Partnerlink to update the spreadsheets (provided to map the import to and Export from ePOD) to indicate Vigo Table and Field Names, for inclusion in this document.
Until these actions are completed, the document will remain in draft form, unless authorised by the customer.

<!-- NEW PAGE --> 
= Set-up  =

== Pre-requisites  ==
* A working Vigo TMS and ''CALIDUS'' EPOD system must be in place.
* The two systems must be able to connect via a shared folder, either through an internet or LAN connection. This must be accessible directly, without user and password information, through a shared user-name on the two servers or domain. This will be co-ordinated and configured by the Partnerlink IT team.

== Menu Structure  ==
None

== Data  ==
As described below.

<!-- NEW PAGE --> 

= Functional Description  =

== Vigo Export ==
The export to the ''CALIDUS'' EPOD system will be made at the request of the Vigo user - the user will select an option from the screen which will send all selected manifests through to the ''CALIDUS'' EPOD system.

The following is a screen-shot of where this functionality is expected to be added.

[[File:FS-305796-Vigo-01.PNG|border]]

== Creating the Messages ==
Should any manifests be available for sending at any time, and there are manifests for the same date that are allocated to the same driver, vehicle and trailer, Vigo will generate a Consolidated Manifest ID and assign this to the manifests that are linked. This will be a unique manifest number in itself, although does not have to be generated in the same format.

The purpose of this is so that some operations will link two manifests together, a set of deliveries, and a set of collections. As the customer requires these tasks to be executed by the same driver and interleave the collections among the deliveries if possible, they must be collected onto the same manifest.

This Consolidated Manifest number should be used to identify the Load for ''CALIDUS'' EPOD.

When manifests are consolidated in this way, the sorting of the data should be preserved, but the Delivery manifest jobs placed first on the consolidated manifest.

This functionality should be enabled through configuration within the Vigo system.

== Message Content ==

A basic list of all the fields in the interface for Load (Manifest) and Job follows. A full spreadsheet of all the import flows and fields containing all the limitations on length and defaulted values is provided separately.

<table border="1" width="100%"><tr>
<td bgcolor="silver" width="5%">#</td><td bgcolor="silver" width="15%">Field Name</td><td bgcolor="silver" width="5%">Type</td><td bgcolor="silver" width="10%">Max Length</td><td bgcolor="silver" width="15%">Mapped Field</td><td bgcolor="silver" width="50%">Notes</td></tr>
<tr><td>1</td><td>Requestor</td><td>C</td><td>3</td><td>(owning) partner code</td><td>Owning Partner - the partner that owns the JobShare job (if present), else the Delivery or Collection Partner, depending on Job Type</td></tr>
<tr><td>2</td><td>Reference 1</td><td>C</td><td>7</td><td>Ref1</td><td>&nbsp;</td></tr>
<tr><td>3</td><td>Reference 2</td><td>C</td><td>16</td><td>Ref2</td><td>&nbsp;</td></tr>
<tr><td>4</td><td>Reference 3</td><td>C</td><td>16</td><td>Ref3</td><td>&nbsp;</td></tr>
<tr><td>5</td><td>PartnerJobID</td><td>C</td><td>14</td><td>tracking_code</td><td>Is used to form the pallet ID of the pallets to be delivered (this field plus 2-digit count from 01 to Total Pallets). Stored in new reference field.</td></tr>
<tr><td>6</td><td>Job Date</td><td>C</td><td>8</td><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td>7</td><td>Collection Name</td><td>C</td><td>30</td><td>col_name</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>8</td><td>Collection Address 1</td><td>C</td><td>30</td><td>col_addr1</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>9</td><td>Collection Address 2</td><td>C</td><td>30</td><td>col_addr2</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>10</td><td>Collection Address 3</td><td>C</td><td>30</td><td>col_addr3</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>11</td><td>Collection Address 4</td><td>C</td><td>30</td><td>col_addr4</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>12</td><td>Collection Postcode</td><td>C</td><td>10</td><td>col_post</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>13</td><td>Collection Contact</td><td>C</td><td>30</td><td>""</td><td>This field is always to be sent blank, to force the users to enter a contact on the PDA client.</td></tr>
<tr><td>14</td><td>Collection Phone Number</td><td>C</td><td>16</td><td>&nbsp;</td><td>Collection details - required for POD note (Consignor address)</td></tr>
<tr><td>15</td><td>Collecting Partner</td><td>C</td><td>3</td><td>partner code</td><td>Partner code of the partner executing the job (if it's a collection job type)</td></tr>
<tr><td>16</td><td>Collection Date</td><td>C</td><td>8</td><td>col_date</td><td>Planned Start Date</td></tr>
<tr><td>17</td><td>Collection Time</td><td>C</td><td>5</td><td>time</td><td>Planned Start Time</td></tr>
<tr><td>18</td><td>Delivery Name</td><td>C</td><td>30</td><td>del_name</td><td>Customer or Job Address</td></tr>
<tr><td>19</td><td>Delivery Address 1</td><td>C</td><td>30</td><td>del_addr1</td><td>Customer or Job Address</td></tr>
<tr><td>20</td><td>Delivery Address 2</td><td>C</td><td>30</td><td>del_addr2</td><td>Customer or Job Address</td></tr>
<tr><td>21</td><td>Delivery Address 3</td><td>C</td><td>30</td><td>del_addr3</td><td>Customer or Job Address</td></tr>
<tr><td>22</td><td>Delivery Address 4</td><td>C</td><td>30</td><td>del_addr4</td><td>Customer or Job Address</td></tr>
<tr><td>23</td><td>Delivery Postcode</td><td>C</td><td>10</td><td>del_post</td><td>Customer or Job Address</td></tr>
<tr><td>24</td><td>Delivery Contact</td><td>C</td><td>30</td><td>""</td><td>This field is always to be sent blank, to force the users to enter a contact on the PDA client.</td></tr>
<tr><td>25</td><td>Delivery Phone Number</td><td>C</td><td>16</td><td>phone</td><td>&nbsp;</td></tr>
<tr><td>26</td><td>Delivery Partner</td><td>C</td><td>3</td><td>Partner Code</td><td>Partner code of the partner executing the job (if it's a delivery job type)</td></tr>
<tr><td>27</td><td>Delivery Date</td><td>C</td><td>8</td><td>del date</td><td>Planned Start Date</td></tr>
<tr><td>28</td><td>Delivery Time</td><td>C</td><td>5</td><td>time</td><td>Planned Start Time</td></tr>
<tr><td>29</td><td>Number of Full Pallets</td><td>N</td><td>&nbsp;</td><td>full</td><td>Added to form Total Pallets</td></tr>
<tr><td>30</td><td>Number of Half Pallets</td><td>N</td><td>&nbsp;</td><td>half</td><td>Added to form Total Pallets</td></tr>
<tr><td>31</td><td>Number of Quarter Pallets</td><td>N</td><td>&nbsp;</td><td>qtr</td><td>Added to form Total Pallets</td></tr>
<tr><td>32</td><td>Number of OverSize Pallets</td><td>N</td><td>&nbsp;</td><td>osize</td><td>Added to form Total Pallets</td></tr>
<tr><td>33</td><td>Weight in Kilos</td><td>N</td><td>&nbsp;</td><td>kilos</td><td>Divided by Total Pallets to create a Weight per pallet</td></tr>
<tr><td>34</td><td>Manifest Notes 1</td><td>C</td><td>48</td><td>notes1</td><td>Job Instructions</td></tr>
<tr><td>35</td><td>Manifest Notes 1</td><td>C</td><td>48</td><td>notes2</td><td>Job Instructions</td></tr>
<tr><td>36</td><td>Manifest Notes 1</td><td>C</td><td>48</td><td>notes3</td><td>Office Instructions</td></tr>
<tr><td>37</td><td>Manifest Notes 1</td><td>C</td><td>48</td><td>notes4</td><td>Office Instructions</td></tr>
<tr><td>38</td><td>Service</td><td>C</td><td>2</td><td>service</td><td>Service Level</td></tr>
<tr><td>39</td><td>Surcharges</td><td>C</td><td>16</td><td>surcharges</td><td>&nbsp;</td></tr>
<tr><td>40</td><td>Pallet Spaces</td><td>N</td><td>&nbsp;</td><td>spaces</td><td>&nbsp;</td></tr>
<tr><td>41</td><td>Number of Chep pallets</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>42</td><td>Hazardous</td><td>C</td><td>1</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>43</td><td>ADR Number</td><td>N</td><td>5.2</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>44</td><td>Packing Group</td><td>C</td><td>10</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>45</td><td>Category</td><td>C</td><td>10</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>46</td><td>Product name</td><td>C</td><td>10</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>47</td><td>UN Number</td><td>C</td><td>10</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>48</td><td>24 Hour Phone Number</td><td>C</td><td>10</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>49</td><td>Number of Packs</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>50</td><td>Number of Litres</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>51</td><td>Weight in Kilos</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>52</td><td>Value 1</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>53</td><td>Value 2</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>54</td><td>Value 3</td><td>N</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>55</td><td>Spare Text 1</td><td>C</td><td>6</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>56</td><td>Job Bar Code</td><td>C</td><td>16</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>57</td><td>Manifest Number</td><td>C</td><td>20</td><td>manifest_no</td><td>Load ID</td></tr>
<tr><td>58</td><td>Account Code</td><td>C</td><td>12</td><td>&nbsp;</td><td>required - unknown what this is.</td></tr>
<tr><td>59</td><td>Trailer Number</td><td>C</td><td>10</td><td>trailer</td><td>Trailer ID</td></tr>
<tr><td>*</td><td>Driver ID</td><td>C</td><td>10</td><td>&nbsp;</td><td>Driver to whom the job has been assigned</td></tr>
<tr><td>*</td><td>Vehicle ID</td><td>C</td><td>10</td><td>vehicle</td><td>&nbsp;</td></tr>
<tr><td>*</td><td>Job Type</td><td>C</td><td>2</td><td>&nbsp;</td><td>Identifying Collection "C" or Delivery "D"</td></tr>
<tr><td>*</td><td>PF Depot</td><td>C</td><td>3</td><td>&nbsp;</td><td>Palletforce depot code</td></tr>
<tr><td>*</td><td>PF Tracking Number</td><td>C</td><td>13</td><td>&nbsp;</td><td>Palletforce tracking number</td></tr>
</table>

Notes:
* The Vigo Table and Field names have been provided by the Partnerlink team.
* Jobs with planned start dates and times should be sent through on the message.
* Jobs without planned start dates and times, but with a service level agreement against them i.e. AM or PM deliveries, should have the time defaulted appropriately. For example:
** AM - set to 11:59
** PM - set to 16:59
* Jobs without any planned start times or service level agreements should leave the time unset (i.e. blank).
* The jobs should be sent through in the order in which they should be completed on the manifest. 

== Sending Mechanism ==
The files can be :
* Sent by the Vigo TMS via FTP to an FTP service hosted by OBS.
* Pulled by ''CALIDUS'' ePOD via FTP from an FTP service hosted by Vigo.
* Copied by ''CALIDUS'' ePOD from a shared folder on the Vigo TMS.
* Copied by Vigo to a shared folder on ''CALIDUS'' ePOD.
{{note}} It is expected that this transfer will be via file transfer though a shared folder on the Vigo TMS.

Regardless of the mechanism chosen above, the final destination folder should contain only completed files in the agreed naming convention, not files being built. The files should be built and copied under a temporary naming convention, before renaming to csv file (i.e. .tmp files).

The files to be picked up will be named as follows:
* <SENDER>_<RECEIVER>_<OPERATING_PARTNER>_<DATE>_<TIME>_<SEQ>.csv
where
* <SENDER> is the system sending the file - expected to be "vigo"
* <RECEIVER> is the system receiving the file - expected to be "epod"
* <OPERATING_PARTNER> is the operating partner code, i.e. L02, L03, etc.
* <DATE> is the date in YYYYMMDD format
* <TIME> is the time in HHMMSSNN format
* <SEQ> is a unique counting sequence for each file created in a run.

No responses to the files shall be given - the receiving system (''CALIDUS'' ePOD in this case) will maintain an audit trail to be examined by the user on event of failure.

Each manifest should be sent in a separate file, to minimise disruption if a single file fails.

The entire content of the file will fail if there is a problem with any content.

== Importing into ''CALIDUS'' EPOD ==
{{note}} This information is specified in detail in another document, but the bulleted information is listed here for completeness.

The import into ''CALIDUS'' EPOD will be modified as follows:
* Vehicle ID will be created in advance
* If the vehicle does not exist, one will be created with basic information
* The Vehicle data will be modified to hold whether this vehicle is a tractor.
* If vehicles are created through the import and a trailer ID is identified against the vehicle, the vehicle will be marked as a tractor, requiring Trailer entry.
* The Load and Jobs data will be modified to hold the trailer ID against them.

== ''CALIDUS'' EPOD Export Process ==
A process runs on a timed schedule within the ''CALIDUS'' EPOD application, to pick up any jobs that have been completed and export them to external systems.

The system be configured to ensure that updates are sent.

The exporting of this data will be modified to include:
* Entered Trailer ID (at Job level).
* Clause information (per pallet)
* External Reference ID (at Job level, containing the PartnerJobID.
{{Note}} Trailer ID and Clause modifications are out of scope of the existing solution being provided, but have been added here so that the systems can be prepared to handle this functionality when it becomes available.

== ''CALIDUS'' EPOD Export Message Content ==
A basic list if all the fields in the interface for Job follows. A full spreadsheet of all the export flows and fields containing all the limitations on length and defaulted values is provided separately. 

'''EPOD_JOB'''
<table border="1" width="100%"><tr>
<td bgcolor="silver" width="15%">Name</td><td bgcolor="silver" width="35%">Description</td><td bgcolor="silver" width="15%">External Field</td><td bgcolor="silver" width="35%">Notes</td></tr>
<tr><tr><td>EPL_SITE_ID</td><td>Unique Reference for the Site that the Job belongs to</td><td>partner code</td><td>This will be the Partner ID</td></tr>
<tr><td>EPL_JOB_ID</td><td>Unique reference for the job. If not provided on Import, this will be generated by EPOD</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_LOAD_ID</td><td>Unique Reference for the Load that the Job belongs to. If not provided, defaulted from the enclosing EPOD_LOAD</td><td>Manifest_No</td><td>As Sent</td></tr>
<tr><td>EPL_JOB_TYPE</td><td>D=Delivery, C=Collection, S=Service</td><td>"D" or "C"</td><td>As Sent</td></tr>
<tr><td>EPL_JOB_GROUP</td><td>&nbsp;</td><td>partner code</td><td>This will be the Partner ID</td></tr>
<tr><td>EPL_JOB_INSTRUCTION</td><td>Instructions for the Driver</td><td>Notes1+Notes2</td><td>As Sent</td></tr>
<tr><td>EPL_JOB_SIGNATURE</td><td>The signature taken from the customer when the job was completed. This is in the form of a Base64-encrypted Jpeg file</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_REASON_CODE</td><td>If a job has been cancelled, the reason code entered by the user is held here.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_LINKED_REASON</td><td>If the job is a delivery, and a collection of the same load with the same EPL_JOB_CODE is cancelled, this delivery will be cancelled, and this field will be set to "Y"</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_STATUS</td><td>C- complete, X cancelled</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_CUSTOMER_CODE</td><td>Customer Code from external system. If not provided, one will be generated from EPL_CUSTOMER_NAME</td><td>Account_Code</td><td>As Sent</td></tr>
<tr><td>EPL_PHOTO_ID</td><td>If cancelled, a photo may have been taken by the user. If so, this field is populated with a unique ID.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_PHOTO</td><td>The photo taken for the exception. This is in the form of a Base64-encrypted Jpeg file</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_ENG_SIGNATURE</td><td>The signature taken from the driver/engineer when the job was completed, if required. This is in the form of a Base64-encrypted Jpeg file</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_SEQUENCE</td><td>The sequence of the job. This could be the sequence sent on Import, a pre-defined sequence (if one was not provided) or a user-changed value (if enabled)</td><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td>EPL_START_PLANNED_DATE</td><td>&nbsp;</td><td>Del_Date</td><td>As Sent</td></tr>
<tr><td>EPL_START_PLANNED_TIME</td><td>&nbsp;</td><td>Time</td><td>As Sent</td></tr>
<tr><td>EPL_END_PLANNED_DATE</td><td>&nbsp;</td><td>Del_Date</td><td>As Sent</td></tr>
<tr><td>EPL_END_PLANNED_TIME</td><td>&nbsp;</td><td>Time</td><td>As Sent</td></tr>
<tr><td>EPL_START_ACTUAL_DATE</td><td>The date the user actually chose to start the job. Format: YYYYMMDD</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_START_ACTUAL_TIME</td><td>The time the user actually chose to start the job. Format HHMMSSNN</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_ARRIVED_DATE_TIME</td><td>The date the user indicated they arrived at the destination. Format: YYYYMMDD</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_ARRIVED_DATE_TIME</td><td>The time the user indicated they arrived at the destination. Format HHMMSSNN</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_END_ACTUAL_DATE</td><td>The date the user completed or cancelled the job. Format: YYYYMMDD</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_END_ACTUAL_TIME</td><td>The time the user completed or cancelled the job. Format HHMMSSNN</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_DISTANCE_PLANNED</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_DISTANCE_ACTUAL</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_DRIVING_TIME</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_CUSTOMER_NAME</td><td>The Name of the customer</td><td>Del_Name</td><td>As Sent</td></tr>
<tr><td>EPL_JOB_ADDRESS</td><td>A flag indicating whether this is a default Customer Address or a specific address for this job alone.</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_ADDRESS_1</td><td>&nbsp;</td><td>Del_addr1</td><td>As Sent</td></tr>
<tr><td>EPL_ADDRESS_2</td><td>&nbsp;</td><td>Del_addr2</td><td>As Sent</td></tr>
<tr><td>EPL_ADDRESS_3</td><td>&nbsp;</td><td>Del_addr3</td><td>As Sent</td></tr>
<tr><td>EPL_ADDRESS_4</td><td>&nbsp;</td><td>Del_addr4</td><td>As Sent</td></tr>
<tr><td>EPL_ADDRESS_5</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_POSTCODE</td><td>&nbsp;</td><td>Del_post</td><td>As Sent</td></tr>
<tr><td>EPL_CONTACT</td><td>&nbsp;</td><td>Del_post</td><td>As Sent</td></tr>
<tr><td>EPL_TELEPHONE</td><td>&nbsp;</td><td>&nbsp;</td><td>As Sent</td></tr>
<tr><td>EPL_EMAIL</td><td>&nbsp;</td><td>&nbsp;</td><td>As Sent</td></tr>
<tr><td>EPL_INVOICED</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_CUST_SIGNATORY</td><td>The name of the customer signatory on the job.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_JOB_CODE</td><td>External reference for the Job. This element can be used to link a collection and delivery together under the same reference. So, if an order is being collected at A and delivered at B, there are 2 jobs, each with a unique Job ID, but with the same Job Code. Optionally, EPOD will keep the Delivery leg of a linked job updated with the information captured from the collection.</td><td>Ref1</td><td>As Sent</td></tr>
<tr><td>EPL_CUST_REF</td><td>Customer's Order Reference</td><td>Ref2</td><td>As Sent</td></tr>
<tr><td>EPL_OFFICE_INSTRUCTION</td><td>Instructions for Admin staff</td><td>Notes3+Notes4</td><td>As Sent</td></tr>
<tr><td>EPL_SIGNED_UNCHECKED</td><td>An indication whether the customer signed for the goods without checking them first. Note that this field can be used for any check-box entry, as this is configurable.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_SO_NUMBER</td><td>Sales Order Reference.</td><td>Ref3</td><td>As Sent</td></tr>
<tr><td>EPL_TNCS</td><td>An XML fragment, displaying the Terms and Conditions agreed to by the customer when signing for the goods. This can also include up to 3 configurable check-boxes that the user may check.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_ORDER_DATE</td><td>Date Order created - defaulted to the date the order was received if not provided</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_SALES_CONTACT</td><td>The operative who took the order. Can be used as a display field for documentation</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_USER_NOTES</td><td>Optional Notes entered by the driver while completing the job.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_OWNER_NAME</td><td>&nbsp;</td><td>(owning) partner code</td><td>Need to set this as partner owning job.</td></tr>
<tr><td>EPL_SERVICE_LEVEL</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_TRAILER_ID</td><td>To be used if the vehicle being used to fulfil the job is a Tractor unit, and a trailer ID has been entered by the user.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_EXT_REF</td><td>An external reference for the host system if required. For Partnerlink, this will be the PartnerJobID.</td><td>PartnerJobID</td><td>As Sent</td></tr>
<tr><td>EPL_LAST_CHANGED_DATE</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_LAST_CHANGED_TIME</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPOD_CONTAINERS</td><td>Contains a series of EPOD_CONTAINER objects, detailing all the deliverable items on this load. If there are loose products, there will also be a container with ID '000000000' holding these products.</td><td>&nbsp;</td><td>A collection of pallets that were part of the job, plus the status.</td></tr>
<tr><td>EPOD_SERVICE</td><td>If the job is a Service, this object holds all the service-related information. In that case, no containers or products will be specified against the job.</td><td>&nbsp;</td><td>N/A</td></tr>
</table>

'''EPOD_CONTAINER'''
<table border="1" width="100%"><tr>
<td bgcolor="silver" width="15%">Name</td><td bgcolor="silver" width="35%">Description</td><td bgcolor="silver" width="15%">External Field</td><td bgcolor="silver" width="35%">Notes</td></tr>
<tr><td>EPL_JOB_ID</td><td>Unique reference for the job. If not provided on Import, this will be generated by EPOD</td><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td>EPL_CONTAINER_ID</td><td>EPL_CONTAINER_ID: The unique identifier for a cotainer.</td><td>Label_ID</td><td>Actually from the tracking id (an id for each pallet to be delivered).</td></tr>
<tr><td>EPL_SEQUENCE</td><td>A sequence for the containers to be shown on the user's device.</td><td>&nbsp;</td><td>As Sent</td></tr>
<tr><td>EPL_CONTAINER_PACKAGE_CODE</td><td>&nbsp;</td><td>EF/EH/EQ/SF/SH/SQ</td><td>As Sent</td></tr>
<tr><td>EPL_CONTAINER_PACKAGE_DESC</td><td>&nbsp;</td><td>EURO FULL, etc</td><td>As Sent</td></tr>
<tr><td>EPL_REASON_CODE</td><td>If a job has been cancelled, the reason code entered by the user is held here.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_LINKED_REASON</td><td>If the job is a delivery, and a collection of this container on the same load with the same EPL_JOB_CODE is cancelled, this container will be cancelled, and this field will be set to "Y"</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_STATUS</td><td>EPL_STATUS: Status of the current Container. C-Completed, X-Cancelled.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_PHOTO_ID</td><td>If cancelled, or received with a clause, a photo may have been taken by the user. If so, this field is populated with a unique ID.</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_PHOTO</td><td>The photo taken for the exception. This is in the form of a Base64-encrypted Jpeg file</td><td>&nbsp;</td><td>x</td></tr>
<tr><td>EPL_CUST_COMMENTS</td><td>Optional entry by the user, indicating whether the customer has identified an issue with the received item (a claused receipt). If present, the customer may have requested an image, which would be contained in EPL_PHOTO.</td><td>&nbsp;</td><td>&nbsp;</td></tr>
<tr><td>EPL_DESCRIPTION_LONG</td><td>&nbsp;</td><td>&nbsp;</td><td>As Sent</td></tr>
<tr><td>EPL_CODE_1</td><td>Multi-purpose field</td><td>Spaces</td><td>As Sent</td></tr>
<tr><td>EPL_CODE_2</td><td>Multi-purpose field</td><td>&nbsp;</td><td>As Sent</td></tr>
<tr><td>EPL_CODE_3</td><td>Multi-purpose field</td><td>&nbsp;</td><td>As Sent</td></tr>
<tr><td>EPL_LAST_CHANGED_DATE</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPL_LAST_CHANGED_TIME</td><td>&nbsp;</td><td>&nbsp;</td><td>N/A</td></tr>
<tr><td>EPOD_PRODUCTS</td><td>Contains a series of EPOD_PRODUCTS objects, detailing the products within the container, or loose products</td><td>&nbsp;</td><td>N/A</td></tr>
</table>

{{Note}} Fields identified with an 'x' are expected to be stored within the Vigo system. Neither the Partnerlink nor OBS teams know which fields are in use within Vigo to store this data, but this must be stored by the application.

{{Note}} Regarding Signature and Photo data formats in this message:
This data is stored and transmitted as a text string, Base64-encrypted. This data can be decoded and saved as binary data once received if required. 

A sample of a single job with a single pallet is shown below:
<pre>
<EPOD_EXPORT_JOB>
  <EPOD_JOBS>
    <EPOD_JOB>
      <EPL_SITE_ID>L03</EPL_SITE_ID>
      <EPL_JOB_ID>0000000001</EPL_JOB_ID>
      <EPL_LOAD_ID>000000000002</EPL_LOAD_ID>
      <EPL_JOB_TYPE>D</EPL_JOB_TYPE>
      <EPL_JOB_GROUP>L03</EPL_JOB_GROUP>
      <EPL_JOB_INSTRUCTION>Very Fragile Parcel..Please handle with Care</EPL_JOB_INSTRUCTION>
      <EPL_JOB_SIGNATURE>R0lGODlh4AB4APcA...NKdJTY4EBAA7</EPL_JOB_SIGNATURE>
      <EPL_REASON_CODE></EPL_REASON_CODE>
      <EPL_LINKED_REASON>N</EPL_LINKED_REASON>
      <EPL_STATUS>C</EPL_STATUS>
      <EPL_CUSTOMER_CODE>OBS</EPL_CUSTOMER_CODE>
      <EPL_PHOTO_ID></EPL_PHOTO_ID>
      <EPL_ENG_SIGNATURE></EPL_ENG_SIGNATURE>
      <EPL_SEQUENCE>1</EPL_SEQUENCE>
      <EPL_START_PLANNED_DATE>20111108</EPL_START_PLANNED_DATE>
      <EPL_START_PLANNED_TIME>12000000</EPL_START_PLANNED_TIME>
      <EPL_END_PLANNED_DATE>0</EPL_END_PLANNED_DATE>
      <EPL_END_PLANNED_TIME>0</EPL_END_PLANNED_TIME>
      <EPL_START_ACTUAL_DATE>20111108</EPL_START_ACTUAL_DATE>
      <EPL_START_ACTUAL_TIME>10490000</EPL_START_ACTUAL_TIME>
      <EPL_END_ACTUAL_DATE>20111108</EPL_END_ACTUAL_DATE>
      <EPL_END_ACTUAL_TIME>10520000</EPL_END_ACTUAL_TIME>
      <EPL_DISTANCE_PLANNED>0</EPL_DISTANCE_PLANNED>
      <EPL_DISTANCE_ACTUAL>0</EPL_DISTANCE_ACTUAL>
      <EPL_DRIVING_TIME>0</EPL_DRIVING_TIME>
      <EPL_CUSTOMER_NAME>OBS Logistics</EPL_CUSTOMER_NAME>
      <EPL_JOB_ADDRESS>N</EPL_JOB_ADDRESS>
      <EPL_ADDRESS_1>Southern Gateway</EPL_ADDRESS_1>
      <EPL_ADDRESS_2>Speke Boulevard</EPL_ADDRESS_2>
      <EPL_ADDRESS_3>Liverpool</EPL_ADDRESS_3>
      <EPL_ADDRESS_4>Merseyside</EPL_ADDRESS_4>
      <EPL_ADDRESS_5></EPL_ADDRESS_5>
      <EPL_POSTCODE>L24 9HZ</EPL_POSTCODE>
      <EPL_CONTACT>Xavier Wai</EPL_CONTACT>
      <EPL_TELEPHONE>01514480331</EPL_TELEPHONE>
      <EPL_EMAIL>x.y@obs-logistics.co.uk</EPL_EMAIL>
      <EPL_INVOICED></EPL_INVOICED>
      <EPL_CUST_SIGNATORY></EPL_CUST_SIGNATORY>
      <EPL_JOB_CODE>L03</EPL_JOB_CODE>
      <EPL_CUST_REF></EPL_CUST_REF>
      <EPL_OFFICE_INSTRUCTION></EPL_OFFICE_INSTRUCTION>
      <EPL_SIGNED_UNCHECKED></EPL_SIGNED_UNCHECKED>
      <EPL_SO_NUMBER></EPL_SO_NUMBER>
      <EPL_TNCS></EPL_TNCS>
      <EPL_ORDER_DATE>0</EPL_ORDER_DATE>
      <EPL_SALES_CONTACT></EPL_SALES_CONTACT>
      <EPL_USER_NOTES></EPL_USER_NOTES>
      <EPL_OWNER_NAME></EPL_OWNER_NAME>
      <EPL_SERVICE_LEVEL></EPL_SERVICE_LEVEL>
      <EPL_TRAILER_ID></EPL_TRAILER_ID>
      <EPL_EXT_REF></EPL_EXT_REF>
      <EPL_LAST_CHANGED_DATE>20120314</EPL_LAST_CHANGED_DATE>
      <EPL_LAST_CHANGED_TIME>9420098</EPL_LAST_CHANGED_TIME>
      <EPOD_CONTAINERS>
        <EPOD_CONTAINER>
          <EPL_SITE_ID>L03</EPL_SITE_ID>
          <EPL_JOB_ID>0000000001</EPL_JOB_ID>
          <EPL_CONTAINER_ID>000000000000001</EPL_CONTAINER_ID>
          <EPL_SEQUENCE>0</EPL_SEQUENCE>
          <EPL_CONTAINER_PACKAGE_CODE>XX</EPL_CONTAINER_PACKAGE_CODE>
          <EPL_CONTAINER_PACKAGE_DESC>Pallet</EPL_CONTAINER_PACKAGE_DESC>
          <EPL_REASON_CODE></EPL_REASON_CODE>
          <EPL_LINKED_REASON></EPL_LINKED_REASON>
          <EPL_STATUS>C</EPL_STATUS>
          <EPL_PHOTO_ID></EPL_PHOTO_ID>
          <EPL_CUST_COMMENTS></EPL_CUST_COMMENTS>
          <EPL_GROSS_WEIGHT>120</EPL_GROSS_WEIGHT>
          <EPL_DESCRIPTION_LONG></EPL_DESCRIPTION_LONG>
          <EPL_CODE_1>1</EPL_CODE_1>
          <EPL_CODE_2></EPL_CODE_2>
          <EPL_CODE_3></EPL_CODE_3>
          <EPL_LAST_CHANGED_DATE>20120614</EPL_LAST_CHANGED_DATE>
          <EPL_LAST_CHANGED_TIME>16362322</EPL_LAST_CHANGED_TIME>
        </EPOD_CONTAINER>
      </EPOD_CONTAINERS>
      <EPOD_SERVICES></EPOD_SERVICES>
    </EPOD_JOB>
  </EPOD_JOBS>
</EPOD_EXPORT_JOB>
</pre>
{{Note}} The signature has been shortened for the purposes of this document.

== ''CALIDUS'' EPOD Export Mechanism ==
The files can be:
*    Pulled by the Vigo TMS via FTP from an FTP service hosted by OBS.
*    Sent by ''CALIDUS'' ePOD via FTP to an FTP service hosted by Vigo.
*    Copied by ''CALIDUS'' ePOD to a shared folder on the Vigo TMS.
*    Copied by the Vigo TMS from a shared folder on the ''CALIDUS'' ePOD system. 
{{note}} It is expected that this transfer will be via file transfer though a shared folder on the Vigo TMS.

Regardless of the mechanism chosen above, the final destination folder should contain only completed files in the agreed naming convention, not files being built. The files should be built and copied under a temporary naming convention, before renaming to csv file (i.e. .tmp files).

The files to be picked up will be named as follows:
*    <SENDER>_<RECEIVER>_<OPERATING_PARTNER>_<DATE>_<TIME>_<SEQ>.xml 
where
*    <SENDER> is the system sending the file - expected to be "epod"
*    <RECEIVER> is the system receiving the file - expected to be "vigo"
*    <OPERATING_PARTNER> is the operating partner code, i.e. L02, L03, etc.
*    <DATE> is the date in YYYYMMDD format
*    <TIME> is the time in HHMMSSNN format
*    <SEQ> is a unique counting sequence for each file created in a run. 

No responses to the files shall be given - the receiving system (Vigo TMS in this case) will maintain an audit trail to be examined by the user on event of failure.

Each job will be sent in a separate file, to minimise disruption if a single file fails.
<!-- MEDIA LANDSCAPE NO --> 
{{Doc_Appendix
|Appendix=A
|Estimate=N
|Glossary=EPOD
|Ref1=JobShare Mapping v0.2.xlsx
|RefV1=0.2
|RefDate1=18/02/2013
|Ref2=EPOD Export Mapping v0.5.xlsx
|RefV2=0.5
|RefDate2=20/02/2013
|Ref3=EPOD XSD.zip
|RefV3=N/A
|RefDate3=25/01/2013
|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
|Rev1=Andrew Allison
|Rev1Title=Client Representative
}}</div> 
[[Category:{{#var:Client}} FS]]