OV 287575 C-ePOD Standard Interface Configuration

Aptean Proof of Delivery - Calidus Edition

C-ePOD Standard Interface Configuration

CALIDUS ePOD

9th April 2019 - 4.5.00.02
Reference: OV 287575

The data within CALIDUS ePOD can be created from many sources:

• Import of jobs, loads and standing data through standard web services.
• Import of jobs and loads through flat-file imports.
• Manual import of Jobs, Loads and Standing Data through the Admin system.
• Manual entry in the Admin system.

That data can be exported from CALIDUS ePOD in many ways:

• Requested Export through standard C-ePOD web services.
• Configured export through interfaces.
• XLS export through the Admin system.

This section covers import and export of data through configured interfaces.

All interfaces, import and export, are configured through the CALIDUS ePOD Admin system, using the Import/Export Interface screen, with the exception of the hosted web services for import and export of jobs and loads, which are always available to processes that request from these web services.

Import and Export configurations are grouped under Configuration ID, which must then be attached to a Site or Job Groups, through the appropriate maintenance screens. Each interface configured for that ID will then be run for that site or job group.

You can add multiples of each export type to each configuration, allowing for (for example) multiple exports of the same data when a single job or load is completed.

See Auto-Export for details of how this screen is operated.

Warning: It is not enough to create an interface - you must attach a configuration to a site or job group, or the interfaces will never be run. The system will not generate exports for any jobs prior to the assignment of the Interface Configuration ID.

The processes below note any exceptions to these general rules.

The general parameters are as follows:

Field	Value
EPL_XF_CONFIG_ID	As required. This may be set to the Site ID for Job and Load exports.
EPL_DESCRIPTION	As required
EPL_XF_TYPE	Transfer type - one of: SOAP, FTP, EMAIL, FILE, POST
EPL_XF_DESTINATION	The external URL for SOAP and POST exports, or the email for EMAIL export, or the folder for FILE imports and exports, or the FTP Server for FTP imports and exports.
EPL_XF_ID	The export type - see the individual sections below.
EPL_EXPORT_FULLHEADERS	Applies to LOAD export types only.
EPL_WEB_PARAMETER	Applies to SOAP-type exports only.
EPL_WEB_USER	Applies to SOAP, FILE and FTP exports only.
EPL_WEB_PASSWORD	Applies to SOAP, FILE and FTP exports only.
EPL_SOAP_ACTION	Applies to SOAP-type exports only.
EPL_SOAP_NS	Applies to SOAP-type exports only.
EPL_SOAP_NS_PREFIX	Applies to SOAP-type exports only.
EPL_XF_DIRECTION	O - Export, I - Import
EPL_XF_RECIPIENT	Multi-use. For EMAIL, the email address. For TomTom WEBFLEET interfaces, the provided WEBFLEET fleet.
EPL_EXPORT_JOB_TYPES	Defines the types of jobs that are exported through this format, of C (Collections), D (Deliveries) and S (Services).
EPL_XF_MSG_TYPE	Multi-use. For TomTom WEBFLEET interfaces, the provided WEBFLEET API Key. For TTM, the message types. For Job Imports, the file format type.
EPL_EXPORT_FORMAT	Multi-use. For TTM, the mode. For POD, the format of the file exported.
EPL_IMAGE_TYPE	Applies to POD exports only
EPL_TIFF_COMPRESSION	Applies to POD exports only
EPL_FILENAME	The export or import filename, plus insertions.
EPL_EMAIL_ERRORS	Supports emailing of failed files to the defined email address here. Only applies to some imports and exports.
EPL_INCLUDE_CSV_HEADER	Applies to OBS CSV Imports only - defines whether the import contains a line determining the fields being imported.
EPL_CONTRACT_OPERATION	Applies to SOAP-type exports only.
EPL_SOAP_VERSION	Applies to SOAP-type exports only. Defaults to text/xml;

Transfer Types

Standard Transfer types set in EPL_XF_TYPE are:

• SOAP - a SOAP web service.
• FTP - an FTP address.
• EMAIL - an Email address.
• FILE - a local or network file transfer.
• POST - a POST web service i.e. URL to a web page.

Typically, the destination set in EPL_XF_DESTINATION defines all transfer types.

FTP

Normally, the destination would be through a URL e.g. ftp://172.190.90.1, which would be configured on the destination to point to a default directory.

Anything after the base above e.g. ftp://172.190.90.1/ARC/IN/ would point to folders underneath that default directory.

The User and Password for the FTP site is defined in EPL_XF_WEB_USER and EPL_XF_WEB_PASSWORD.

EMAIL

The destination is set to be an email address or addresses. The delimiter is typically a comma (,) or semi-colon (;), depending on the email server the system is linked to.

Examples:

• [email protected]
• [email protected]; [email protected]
• [email protected], [email protected]

FILE

The local, network or share name full file path is defined in the destination.

Example:

• Local file: C:\FILES\ABC\
• Network mapped: X:\FILES\ABC\
• Network file: \\1.2.3.4\FILES\ABC\
• Domain file: \\myserver\FILES\ABC\

POST

The destination is defined by the full URL of the page.

Example:

• http://my.url.com/mypage.asp

Typically this would not require a username and password, but could be defined in EPL_XF_WEB_USER and EPL_XF_WEB_PASSWORD.

SOAP

SOAP web services typically require a number of parameters in addition to POST parameters.

The destination is defined as the web service and method.

Example:

• http://my.url.com/mywebservice/method

Other parameters that may be required:

• EPL_WEB_PARAMETER - parameter for the web service e.g. EPOD_ACTUALS-XMLTYPE-IN
• EPL_WEB_USER - username for authenticated web services
• EPL_WEB_PASSWORD - password for authenticated web services
• EPL_SOAP_ACTION -
• EPL_SOAP_NS - namespace URL e.g. http://xmlns.oracle.com/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
• EPL_SOAP_NS_PREFIX the namespace ID for the namespace above.
• EPL_CONTRACT_OPERATION - additional level for the web service XML e.g. CXMLTYPE-EPOD_INInput

Typically, web service methods require bespoke content, so usually these settings must be completed in conjunction with a known web service type, as shown below.

File Naming

Generally, for FILE and FTP exports, the file naming default is based on the configuration.

If no filename is specified, the default is:

• EPOD_(EPL_RECIPIENT)_(EPL_XF_CONFIG_ID)_(DATE)_(TIME)_(UID).<ext>

where

• EPL_RECIPIENT - from the configuration
• EPL_XF_CONFIG_ID - from the configuration
• DATE - the current date in yyyyMMdd format
• TIME - the current time in HHmmss format
• UID - a unique identifier per record generated in that run
• ext - the defined extension of the file, based on the ID.

For example:

• EPOD_EUROPA_L02_20180201_104956_1.XML

Filename can be specified in the EPL_FILENAME parameter as any plain text plus the following job-level items:

• EPL_EXT_REF
• EPL_OWNER_NAME
• EPL_SO_NUMBER
• EPL_SITE_ID
• EPL_JOB_ID - a C-ePOD-generated unique identifier for the job for that site.
• EPL_LOAD_ID
• EPL_JOB_CODE
• EPL_CUST_REF
• EPL_CUSTOMER_CODE
• EPL_PF_DEPOT - the pallet network depot code
• DATE
• TIME
• UID

Note: The format is the field in parenthesis, so for example:

• EPOD_(EPL_RECIPIENT)_(EPL_SITE_ID)_(DATE)_(TIME)_(UID)

All JOB and Pallet Network exports using FTP or FILE will follow this Filename naming convention.

Where applicable to other types, this is shown below.

Core CALIDUS Exports

Job

For Export, if this configuration has the same name as the Site that it applies to, it need not be attached to a Site or Job Group through an XF Config ID.

This type exports and imports data through the C-ePOD standard XML format, through web services, file copy or FTP. Exports may also be emailed, where the XML is attached to an email and sent.

Note: This interface is used by CALIDUS TMS and CALIDUS Total Logistics.

This interface is triggered when a job is completed or cancelled (where the status has been set to "C" or "X").

Standard configuration is as follows:

Field	Value
EPL_XF_TYPE	Any type may be configured for Export. For Import, FILE and FTP are valid.
EPL_XF_DESTINATION	The external URL for SOAP and POST exports, or the email for EMAIL export, or the folder for FILE imports and exports, or the FTP Server for FTP imports and exports.
EPL_XF_ID	The export type, JOB.
EPL_EXPORT_FULLHEADERS	Normally "N" or unchecked.
EPL_EXPORT_JOB_TYPES	CD. Defining the job types that are exported. For example, C are collections, D are deliveries.

Example File Job Export:

Field	Value
EPL_XF_TYPE	FILE
EPL_XF_DESTINATION	C:\Test\Stirling\
EPL_XF_ID	JOB
EPL_EXPORT_FULLHEADERS	N
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	CD

Example CALIDUS TMS Job Export:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	http://10.43.0.71:8011/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
EPL_XF_ID	JOB
EPL_EXPORT_FULLHEADERS	Y
EPL_WEB_PARAMETER	EPOD_ACTUALS-XMLTYPE-IN
EPL_WEB_USER	epod
EPL_WEB_PASSWORD	as provided
EPL_SOAP_ACTION
EPL_SOAP_NS	http://xmlns.oracle.com/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
EPL_SOAP_NS_PREFIX	epod
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	CD
EPL_CONTRACT_OPERATION	CXMLTYPE-EPOD_INInput

If no filename is specified for FTP or FILE export types for LOAD exports, the default is:

• EPOD_LOTS_(EPL_SITE_ID)_(DATE)_(TIME)_1

If EPL_FILENAME is provided, this will be translated as described generically.

Load

For Export, if this configuration has the same name as the Site that it applies to, it need not be attached to a Site or Job Group through an XF Config ID.

This type exports data through the C-ePOD standard XML format, through web services, file copy or FTP. Exports may also be emailed, where the XML is attached to an email and sent.

Note: This interface is used by CALIDUS TMS and CALIDUS Total Logistics.

This interface is triggered based on the when a load is started (where the status is "I"), completed or cancelled (where the status has been set to "C" or "X"), based on the configuration of the message (see below).

Standard configuration is as follows:

Field	Value
EPL_XF_TYPE	Any type may be configured for Export. For Import, FILE and FTP are valid.
EPL_XF_DESTINATION	The external URL for SOAP and POST exports, or the email for EMAIL export, or the folder for FILE imports and exports, or the FTP Server for FTP imports and exports.
EPL_XF_ID	The export type, LOAD
EPL_EXPORT_FULLHEADERS	Normally "N" or unchecked. If "Y", this will include the full content of all of the jobs on the load, making a further Job interface redundant. When "N", only the Load is exported, not the jobs.
EPL_EXPORT_JOB_TYPES	CD. Defining the job types that are exported, if full headers are set. For example, C are collections, D are deliveries.
EPL_XF_MESSAGE_TYPE	Determines thr message trigger point: START (when the load is in progress, END (when the load is completed or cancelled) or BOTH.

Example CALIDUS TMS Load Export:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	http://10.43.0.71:8011/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
EPL_XF_ID	LOAD
EPL_EXPORT_FULLHEADERS	Y
EPL_WEB_PARAMETER	EPOD_ACTUALS-XMLTYPE-IN
EPL_WEB_USER	epod
EPL_WEB_PASSWORD	as provided
EPL_SOAP_ACTION
EPL_SOAP_NS	http://xmlns.oracle.com/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
EPL_SOAP_NS_PREFIX	epod
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	CD
EPL_XF_MESSAGE_TYPE	BOTH
EPL_CONTRACT_OPERATION	CXMLTYPE-EPOD_INInput

If no filename is specified for FTP or FILE export types for LOAD exports, the default is:

• EPOD_LOTS_(EPL_SITE_ID)_(DATE)_(TIME)_1

If EPL_FILENAME is provided, this will be translated as described generically.

NAV2016

For connection to NAV2016, the following interface must be configured.

This interface sends back details of completed or cancelled jobs (Collections, Deliveries and Services) in the C-ePOD XML format to the NAV2016 web service, which works in the standard way.

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	As confirmed, Example: https://nav16.in2grate.co.uk:7167/AELEPODUP/WS/A%26E%20Leisure%20Ltd./Codeunit/GetNAVData
EPL_XF_ID	NAV
EPL_EXPORT_FULLHEADERS	N
EPL_WEB_PARAMETER	xmlStrIn
EPL_WEB_USER	NAV-DEV\EPOD
EPL_WEB_PASSWORD	As confirmed
EPL_SOAP_ACTION	urn:microsoft-dynamics-schemas/codeunit/GetNAVData:ReturnNavDataAsXml
EPL_SOAP_NS	urn:microsoft-dynamics-schemas/codeunit/GetNAVData
EPL_SOAP_NS_PREFIX	nav
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	CD
EPL_CONTRACT_OPERATION	ReturnNavDataAsXml
EPL_SOAP_VERSION	text/xml; charset=utf-8

CALIDUS Portal TTM

This interface must be created when CALIDUS ePOD and CALIDUS Portal TTM are implemented together, usually without CALIDUS TMS.

Details on the interface can be found in the EPOD-TTM Interface guide.

The interface sends through tracking messages at all states of the order, as follows:

• ORD - Details of the order, down to individual items.
• TRP - the Workload, grouping all the orders together for transport.
• OIT - Order In Transit.
• ARR - Arrived at destination.
• DEL/COL - Collected/Delivered - completed job, including all items, quantities and discrepancies.
• CAN - Cancelled job.
• GPS - Vehicle GPS Tracking messages.

Field	Value
EPL_XF_TYPE	FILE or FTP
EPL_XF_DESTINATION	The file folder e.g. E:\Portal\TTM\EDI\DEV\INBOUND\
EPL_XF_ID	TTM
EPL_XF_DIRECTION	O
EPL_XF_RECIPIENT
EPL_EXPORT_JOB_TYPES	CD
EPL_XF_MSG_TYPE	TRP|CAN|DEL|OIT|ARR|GPS. If a message type is omitted, that message will not be sent. Typically, GPS is omitted.
EPL_EXPORT_FORMAT	Mode 1 or Mode 2 - see below for details.

For the different modes, the TTM fields are populated as follows:

Field	MODE 1	MODE 2
TMS Ref	Job Code	Job Code
SO Ref	Cust Ref if present, else Job Code	External Ref
Book Ref	External Ref	Cust Ref

If no filename is specified for FTP or FILE export types, the default is:

• EPOD_LOTS_(EPL_SITE_ID)_(TTM_TRACKING_STATUS)_(DATE)_(TIME)_(UID)

where TTM_TRACKING_STATUS is one of the TTM tracking statuses listed above. Note: Filenames should not be changed from this format.

Vehicle Checks

This interface is used when exporting Vehicle Checks to external systems.

Only those vehicle checks that have been marked as not yet exported will be included.

The format is the C-ePOD Vehicle Check XML Export format.

Field	Value
EPL_XF_TYPE	Any, but typically FILE or FTP or EMAIL
EPL_XF_DESTINATION	Depending on type
EPL_XF_ID	V

Note: All other parameters depend on the type selected.

If no filename is specified for FTP or FILE export types, the default is:

• EPOD_LOTS_(EPL_SITE_ID)_V_(DATE)_(TIME)_(UID)

Filename can be specified in the EPL_FILENAME parameter as described generically above.

Job Swap

This interface is used with CALIDUS TMS only, when Job Swaps are enabled. In this case, the interface must be enabled to reflect Job Swaps within C-TMS.

The interface format is C-ePOD XML.

Example configuration for C-TMS:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	http://10.43.0.71:8011/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
EPL_XF_ID	JOBSWAP
EPL_WEB_PARAMETER	EPOD_ACTUALS-XMLTYPE-IN
EPL_WEB_USER	epod
EPL_WEB_PASSWORD	as provided
EPL_SOAP_ACTION
EPL_SOAP_NS	http://xmlns.oracle.com/orawsv/MTS_OWNER/DP_EPOD_WEB_SERVICE/EPOD_IN
EPL_SOAP_NS_PREFIX	epod
EPL_XF_DIRECTION	O
EPL_CONTRACT_OPERATION	CXMLTYPE-EPOD_INInput

If no filename is specified for FTP or FILE export types, the default is:

• EPOD_LOTS_(EPL_SITE_ID)_JOBSWAP_(DATE)_(TIME)_(UID)

Filename can be specified in the EPL_FILENAME parameter as described generically above.

PODs

This interface is typically used to update Document Management Systems (DMS) with completed POD/POC reports.

Note: Emails of PODs to customers and site email addresses are dealt with through a different interface - see Completion Report Emails for details.

The export is normally an image or PDF file.

Note: POD and POD2 are functionally identical, but are used to configure multiple exports from C-ePOD. Recent changes mean that these can now all be defined as POD rather than POD2, making this format redundant.

Types of FILE, FTP and EMAIL are supported.

Example format of POD message.

Field	Value
EPL_XF_TYPE	FILE (Types of FILE, FTP and EMAIL are supported.)
EPL_XF_DESTINATION	Destination Folder for example: C:\OUTBOUND\POD\
EPL_XF_ID	POD
EPL_WEB_USER	User for filesystem, if required.
EPL_WEB_PASSWORD	Password for filesystem, if required.
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	D|S
EPL_EXPORT_FORMAT	Image (formats of HTML, Image, PDF)
EPL_IMAGE_TYPE	TIFF (image types of JPG, PNG, TIFF)
EPL_TIFF_COMPRESSION	FAX or Zip or None
EPL_FILENAME	Filename with insertions, for example: POD_(EPL_EXT_REF)_(DATE)_(TIME)_(UID)

If no filename is specified for FTP or FILE export types, the default is:

• EPOD_LOTS_(EPL_SITE_ID)_POD_(DATE)_(TIME)_(UID)

Filename can be specified in the EPL_FILENAME parameter as described generically above.

Invoices

To be able to email invoices you need to setup an appropriate Email Export Interface.

Example Invoice configuration:

Field	Value
EPL_XF_TYPE	EMAIL
EPL_XF_ID	Invoice
EPL_XF_DIRECTION	O
EPL_EXPORT_FORMAT	Html.

TomTom Export Interfaces

TomTom interfaces utilise the TomTom WEBFLEET web services to perform the following tasks.

Note: A WEBFLEET fleet, user and password will be required to use these services.

Warning: The TomTom WEBFLEET import and export processes will not process unless the automatic export and import processes have been set up and configured for TomTom WEBFLEET use - check with the system administrator.

Geocoder

The Geocoder service is used to generate Lat/Longs from addresses. As locations are created or updated, the LatLong will be requested to be updated.

Example format for TomTom Geocoder:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	https://soap.business.tomtom.com/v1.25/addressService
EPL_XF_ID	TG
EPL_WEB_PARAMETER
EPL_WEB_USER	Provided WEBFLEET user
EPL_WEB_PASSWORD	Provided WEBFLEET password
EPL_SOAP_NS	http://connect.webfleet.tomtomwork.com/services
EPL_SOAP_NS_PREFIX	ser
EPL_XF_DIRECTION	O
EPL_XF_RECIPIENT	Provided WEBFLEET fleet
EPL_XF_MSG_TYPE	WEBFLEET API Key - for CALIDUS ePOD this is 000fcb2a-6631-477a-b00e-de0505e7c7e3
EPL_EXPORT_FORMAT	An optional control of how to send address information to WEBFLEET.
EPL_CONTRACT_OPERATION	geocodeAddress

The process can be configured to send addresses to the TomTom WEBFLEET geocoder in 2 main formats:

• Fixed.
• Freetext.

In Fixed mode, the process will send the following data to the geocoder:

• Street, set as Address Line 1.
• Postcode.
• Country, set by default to 'GB'. The OBS Logistics implementation team can configure this to any other country by default.

This is the default mode, when EPL_EXPORT_FORMAT is left blank. This method is useful when the address data in C-ePOD has been fixed by the customer, so that address line 1 is always the street. However, it does not account for data where a company name is provided in address line 1, nor can it use any places of interest (POI) databases provided by WEBFLEET to make the returned location more specific.

In Freetext mode, the process builds a free-text address from portions of the address being geocoded. The configuration of EPL_EXPORT_FORMAT governs the data sent through, as follows:

• If the string includes "N", the name is included in the free-text address.
• If the string includes "1", the first line of the address is included in the free-text address.
• If the string includes "2", the second line of the address is included in the free-text address.
• If the string includes "3", the third line of the address is included in the free-text address.
• If the string includes "4", the fourth line of the address is included in the free-text address.
• If the string includes "5", the fifth line of the address is included in the free-text address.
• If the string includes "P", the postcode is included in the free-text address.

Although this process is looser for WEBFLEET, the ability to control any of the address fields the process sends to the geocoder means that the results, when configured correctly, can be much more accurate.

Examples:

For an address as follows:

• Name - "My Company"
• Address Line 1 - "123 Acacia Avenue"
• Address Line 2 - "Anywheretown"
• Address Line 3 - ""
• Address Line 4 - "Anywhereshire"
• Address Line 5 - ""
• Postcode - "NE14 10S"

Example 1 - Fixed:

The process sends through the following data:

• Street - "123 Acacia Avenue"
• Postcode - "NE14 10S"
• Country - "GB"

Example 2 - Freetext:

Where the configuration is "N124P", the process sends through the following data:

• Freetext- "My Company 123 Acacia Avenue Anywheretown Anywhereshire NE14 10S"

Example 3 - Freetext:

Where the configuration is "1P", the process sends through the following data:

• Freetext- "123 Acacia Avenue NE14 10S"

TomTom WEBFLEET Orders

This interface is used to export workloads of orders out to WEBFLEET to appear on WEBFLEET head units as a kind of Job List.

Note: In order for these messages to be interfaced, the workload must be assigned to a vehicle with a valid TomTom WEBFLEET external ID, and the workload must be in progress.

The interface will handle deleting orders from a head-unit and creating new orders.

The message uses a combination of WEBFLEET web service methods, and are fixed and bespoke for this interface.

Example format for TomTom WEBFLEET Orders:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	https://soap.business.tomtom.com/v1.25/ordersService
EPL_XF_ID	TO
EPL_WEB_PARAMETER
EPL_WEB_USER	Provided WEBFLEET user
EPL_WEB_PASSWORD	Provided WEBFLEET password
EPL_SOAP_NS	http://connect.webfleet.tomtomwork.com/services
EPL_SOAP_NS_PREFIX	ser
EPL_XF_DIRECTION	O
EPL_XF_RECIPIENT	Provided WEBFLEET fleet
EPL_XF_MSG_TYPE	WEBFLEET API Key - for CALIDUS ePOD this is 000fcb2a-6631-477a-b00e-de0505e7c7e3
EPL_CONTRACT_OPERATION	geocodeAddress

HERE Geocoder

Note: Valid HERE account details are required to use these services.

The Geocoder service is used to generate Lat/Longs from addresses. As locations are created or updated, the LatLong will be requested to be updated.

Example format for TomTom Geocoder:

Field	Value
EPL_XF_TYPE	POST
EPL_XF_DESTINATION	https://geocoder.api.here.com/6.2/geocode.xml
EPL_XF_ID	HG
EPL_XF_DIRECTION	O
EPL_XF_RECIPIENT	Provided HERE account
EPL_XF_MSG_TYPE	Provided HERE API Key
EPL_EXPORT_FORMAT	An optional control of how to send address information to WEBFLEET.

The process builds a free-text address from portions of the address being geocoded. The configuration of EPL_EXPORT_FORMAT governs the data sent through, as follows:

• If the string includes "N", the name is included in the free-text address.
• If the string includes "1", the first line of the address is included in the free-text address.
• If the string includes "2", the second line of the address is included in the free-text address.
• If the string includes "3", the third line of the address is included in the free-text address.
• If the string includes "4", the fourth line of the address is included in the free-text address.
• If the string includes "5", the fifth line of the address is included in the free-text address.
• If the string includes "P", the postcode is included in the free-text address.

Examples:

For an address as follows:

• Name - "My Company"
• Address Line 1 - "123 Acacia Avenue"
• Address Line 2 - "Anywheretown"
• Address Line 3 - ""
• Address Line 4 - "Anywhereshire"
• Address Line 5 - ""
• Postcode - "NE14 10S"

Example 1:

Where the configuration is "N124P", the process sends through the following data:

• Freetext- "My Company 123 Acacia Avenue Anywheretown Anywhereshire NE14 10S"

Example 2:

Where the configuration is "1P", the process sends through the following data:

• Freetext- "123 Acacia Avenue NE14 10S"

External Tracking System Exports

External tracking system updates are generally bespoke services required to be updated by specific carriers.

As such, they are typically attached to a specific Job Group, and will be exported along with the general Site configuration when the job is updated to comp[lete or cancelled.

Note: For most of these messages, additional information is required on receiving the job:

• PF Depot - Depot for external tracking
• PF Tracking Number - the external tracking reference

PalletForce

The Palletforce configuration is attached directly to the PALLET job group and site without setting an XF Config ID, and requires specific configuration of the name to the Site and PF Depot - please contact your OBSL representatives for details.

For example, for a PalletForce job, for site L02, with PalletForce depot code 177, this would be configured with an XF Config ID of "PALLETL02_177".

A flat-file interface of FILE or FTP is required.

The interface updates each pallet and consignment, and provides the signature.

Example Palletforce configuration:

Field	Value
EPL_XF_TYPE	FTP
EPL_XF_DESTINATION	ftp://10.43.0.73/testftp/
EPL_XF_ID	PF
EPL_EXPORT_FULLHEADERS
EPL_WEB_PARAMETER
EPL_WEB_USER	Provided FTP or filesystem username
EPL_WEB_PASSWORD	Provided FTP or filesystem password
EPL_EXPORT_JOB_TYPES	D

PALLEX

This is a SOAP web service only to the Pallex TWINE system.

The interface updates each pallet and consignment, and provides the signature.

Example Pallex configuration:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	Web service URL e.g. http://82.3.53.216/depotcustomer.asmx
EPL_XF_ID	PALLEX
EPL_WEB_USER	Provided Pallex TWINE username
EPL_WEB_PASSWORD	Provided Pallex TWINE password
EPL_SOAP_NS	http://tempuri.org/
EPL_SOAP_NS_PREFIX	tem
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	D

TPN

This is a SOAP web service only to the TPN Connect system.

The TPN configuration is attached directly to the TPN job group and site without setting an XF Config ID, and requires specific configuration of the name to the Site and PF Depot - please contact your OBSL representatives for details.

For example, for a TPN job, for site L02, with TPN depot code 177, this would be configured with an XF Config ID of "TPNL02_177".

The interface sends one message per consignment, to update a pallet and consignment with delivery, signatory and signature information.

Example TPN configuration:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	http://dev.tpnconnect.com:3268/ThirdPartyServices.svc
EPL_XF_ID	TPN
EPL_WEB_USER	Provided TPN Connect username
EPL_WEB_PASSWORD	Provided TPN Connect password
EPL_SOAP_NS	http://schemas.datacontract.org/2004/07/ConnectSystem.Models.Integration;http://tempuri.org/
EPL_SOAP_NS_PREFIX	con;tem
EPL_XF_DIRECTION	O
EPL_EXPORT_JOB_TYPES	D

EUROPA

The Eurpoa configuration is attached directly to the EUROPA job group and site without setting an XF Config ID, and requires specific configuration of the name to the Site and PF Depot - please contact your OBSL representatives for details.

A flat-file interface of FILE or FTP is required.

Europa systems match the OBS XML file format.

Example Europa configuration:

Field	Value
EPL_XF_TYPE	FTP
EPL_XF_DESTINATION	ftp://ftp.europa-worldwide.com
EPL_XF_ID	JOB
EPL_EXPORT_FULLHEADERS	N
EPL_WEB_USER	Provided FTP or filesystem username
EPL_WEB_PASSWORD	Provided FTP or filesystem password
EPL_XF_RECIPIENT	EUROPA
EPL_EXPORT_JOB_TYPES	D

GAP

This is a flat-file exort only of GAP 861 messages in ANSI X12 format.

A flat-file interface of FILE or FTP is required.

Note: This interface requires a secure middleware interface, as GAP only accepts files from trusted sources.

Example GAP 861 configuration:

Field	Value
EPL_XF_TYPE	FILE
EPL_XF_DESTINATION	C:\FILES\GAP
EPL_XF_ID	GAP861
EPL_WEB_USER	Provided FTP or filesystem username
EPL_WEB_PASSWORD	Provided FTP or filesystem password
EPL_XF_DIRECTION	O
EPL_XF_RECIPIENT	GAP
EPL_EXPORT_JOB_TYPES	CD
EPL_EMAIL_ERRORS	Supports emailing of failed files to the defined email address here.

For FILE and FTP exports, the file naming default is based on the configuration.

If no filename is specified for FTP or FILE export types, the default is:

• EPOD_(EPL_RECIPIENT)_(EPL_XF_ID)_(DATE)_(TIME)_(UID)

Filename can be specified in the EPL_FILENAME parameter as described generically above.

Palletline

This is a FTP flatfile update to the Palletline Contrado system.

The interface sends one message per consignment, to update a pallet and consignment with delivery, signatory and signature information.

If this is configured, the system will also send one Arrival message per consignment.

Example Palletline configuration:

Field	Value
EPL_XF_TYPE	FILE
EPL_XF_DESTINATION	E:\ftpserver\customer\out
EPL_XF_ID	PLINE
EPL_XF_DIRECTION	O

Hazchem

This is a FTP flatfile update to the Hazchem HazchemOnline system.

The interface sends one message per consignment, to update a pallet and consignment with delivery, signatory and signature information.

If this is configured, the system will also send one Arrival message per consignment.

Example Hazchem configuration:

Field	Value
EPL_XF_TYPE	FILE
EPL_XF_DESTINATION	E:\ftpserver\customer\out
EPL_XF_ID	HAZCHEM
EPL_XF_DIRECTION	O

Imports

For FILE-type job and load imports, the import file is archived in a configured archive directory, which can be Site-related. The same is true of files that error on import.

OBS XML

This interface defines imports of Jobs, Loads and standing data in the C-ePOD XML format, as used by the web services.

In all ways, this operates as the standard web services, except that this can process an XML flat file.

Example XML Import configuration:

Field	Value
EPL_XF_TYPE	FILE only
EPL_XF_DESTINATION	Import folder e.g. C:\INBOUND\MSG_TYPE\IN
EPL_XF_ID	JOB
EPL_WEB_PARAMETER
EPL_WEB_USER	Provided FTP or filesystem username
EPL_WEB_PASSWORD	Provided FTP or filesystem password
EPL_XF_DIRECTION	I
EPL_XF_MSG_TYPE	X
EPL_EMAIL_ERRORS	Supports emailing of failed files to the defined email address here.

OBS CSV

This is a feature-limited import in CSV format only. This is typically only used when external systems cannot match the XML format. This matches the import through the Admin Import screen for jobs.

This interface allows creation of Loads, Collection and Delivery jobs, with Containers and/or products.

Example OBS CSV Import configuration:

Field	Value
EPL_XF_TYPE	FTP or FILE
EPL_XF_DESTINATION	Import folder e.g. C:\INBOUND\MSG_TYPE\IN
EPL_XF_ID	JOB
EPL_WEB_PARAMETER
EPL_WEB_USER	Provided FTP or filesystem username
EPL_WEB_PASSWORD	Provided FTP or filesystem password
EPL_XF_DIRECTION	I
EPL_XF_MSG_TYPE	GEN or Blank
EPL_EMAIL_ERRORS	Supports emailing of failed files to the defined email address here.

Partnerlink JobShare Format

This is a feature-limited import in CSV format only. This is typically only used when external systems cannot match the XML format. This matches the import through the Admin Import screen for jobs.

This interface creates pallets for delivery based on the quantity against a single line, assigning IDs in a specified format, counting the pallets sequentially.

Example Partnerlink CSV Import configuration:

Field	Value
EPL_XF_TYPE	FTP or FILE
EPL_XF_DESTINATION	Import folder e.g. C:\INBOUND\MSG_TYPE\IN
EPL_XF_ID	JOB
EPL_WEB_PARAMETER
EPL_WEB_USER	Provided FTP or filesystem username
EPL_WEB_PASSWORD	Provided FTP or filesystem password
EPL_XF_DIRECTION	I
EPL_XF_RECIPIENT	For non-Vigo imports, replaces occurrences of AKW in the destination path with the value in this field.
EPL_XF_MSG_TYPE	P
EPL_EMAIL_ERRORS	Supports emailing of failed files to the defined email address here.

TomTom WEBFLEET Update

This interface is used to pull back updates from TomTom WEBFLEET, to use in Planned vs Actuals reporting at a detailed level.

Warning: This process needs setting up just once for the TomTom fleet, regardless of how many sites there are, as the returned data is per fleet not per site. This interface need not be attached to a Site or Job Group to be effective.

Warning: The TomTom WEBFLEET import and export processes will not process unless the automatic export and import processes have been set up and configured for TomTom WEBFLEET use - check with the system administrator.

The interface will capture distance and time from TomTom WEBFLEET. It can also capture breaks on the device.

Note: This interface requires a message queue configured on TomTom WEBFLEET to operate effectively. If one is not created, the process will create one the first time it is run, but no data prior to that point will be imported.

Example format for TomTom WEBFLEET Orders Inbound:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	https://soap.business.tomtom.com/v1.28/messagesService
EPL_XF_ID	TO
EPL_WEB_USER	Provided WEBFLEET user
EPL_WEB_PASSWORD	Provided WEBFLEET password
EPL_SOAP_NS	http://connect.webfleet.tomtomwork.com/services
EPL_SOAP_NS_PREFIX	ser
EPL_XF_DIRECTION	I
EPL_XF_RECIPIENT	Provided WEBFLEET fleet
EPL_XF_MSG_TYPE	WEBFLEET API Key - for CALIDUS ePOD this is 000fcb2a-6631-477a-b00e-de0505e7c7e3

DiPS Route Creation/Optimisation

This interface will import and create or update jobs and workload from the DiPS route optimiser.

The interface processes DiPS export files and supports the standard for DiPS - CSV files. All known fields are supported, although only a few of the fields are mapped to CALIDUS ePOD data - please contact your OBSL representatives for details of this mapping.

The file can be imported through FTP or FILE types.

Example format for the DiPS route optimiser:

Field	Value
EPL_XF_TYPE	FILE
EPL_XF_DESTINATION	C:\EPOD_DATA\EPOD_LOCALHOST\INBOUND\[SITE_ID]\IMPORT\IN
EPL_XF_ID	DIPS
EPL_XF_DIRECTION	I
EPL_XF_MSG_TYPE	GEN
EPL_FILENAME	DIPS2EPOD_[YYYYMMDD].xls
EPL_EMAIL_ERRORS	Supports emailing of failed files to the defined email address here.

EBB Import

This is a feature-limited bespoke import in multiple parts. This is used by a single client.

Note: As a bespoke interface, this is likely of limited re-use. However, this may be of use when utilising Great Plains / Microsoft Dynamics GP WMS/ERP software. This requires a manifest file produced from the pick list, and an MSA view onto the database to operate successfully

This interface allows creation of Loads, Collection and Delivery jobs, with products.

Example EBB Import configuration:

Field	Value
EPL_XF_TYPE	FTP or FILE
EPL_XF_DESTINATION	Import folder e.g. C:\INBOUND\MSG_TYPE\IN for the XML Manifest file
EPL_XF_ID	EBB
EPL_DB_CONNECTION	Data connection information to the MSA View: "Data Source=<ip>, <port>;Initial Catalog=<db>;User Id=<user>;Password=<pass>", replacing the '<*>' parameters with the required configuration.

CALIDUS Device Settings

Import/Export configurations can also be used on the mobile device. Specific configurations for the device can be configured in the same way. The acceptable interfaces are shown below.

TomTom WEBFLEET Device Settings

These settings are used on the device to connect to WEBFLEET and obtain the vehicle that the device is connected to, using the WEBFLEET user ID. The Odometer reading is also retrieved.

Example format for TomTom WEBFLEET Device Settings:

Field	Value
EPL_XF_TYPE	SOAP
EPL_XF_DESTINATION	https://soap.business.tomtom.com/v1.31/objectsAndPeopleReportingService
EPL_XF_ID	TD
EPL_WEB_USER	Provided WEBFLEET user
EPL_WEB_PASSWORD	Provided WEBFLEET password
EPL_SOAP_NS	http://connect.webfleet.tomtomwork.com/services
EPL_SOAP_NS_PREFIX	ser
EPL_XF_DIRECTION	D (Device)
EPL_XF_RECIPIENT	Provided WEBFLEET fleet
EPL_XF_MSG_TYPE	WEBFLEET API Key - for CALIDUS ePOD this is 000fcb2a-6631-477a-b00e-de0505e7c7e3

Appendix A: Document References

A.1 References

Ref No	Document Title & ID	Version	Date
1	UG 291094 EPOD Admin User Guide	4.5.00.02	08/04/2019
2	UG 291097 EPOD Client User Guide	4.0.2.21	02/04/2019

A.2 Glossary

Term or Acronym	Meaning
General Definitions
EPOD	Electronic Proof of Delivery. The OBSL EPOD system is CALIDUS ePOD. This also comprises the basis of the Service Completion system CALIDUS eServ.
Server	The portion of the CALIDUS ePOD/eServ systems that controls all the data and sends information to and receives updates from the mobile device.
Mobile Device; PDA	The device used by the driver to perform the jobs. Typically an Android mobile device or tablet.
Site	The site usually defines the depot, business or the transport group (carrier). It can be set to any value required by the customer. All transactions data (for example, loads and jobs) and standing data (for example, vehicles and uses) belong to a site. An EPOD user, on a device or in the Admin screen, can only see data for one site at a time.
Load	A single journey for the driver with a set of work attached. A load is identified by a unique load ID. This may also be referred to as a worklist or workload.
Job	Also Consignment. A single task for the driver as a specific location. This could be the collection of goods or the delivery of goods. Jobs may also be Services (for example, servicing, installing or de-installing a boiler). A job is identified by a unique job ID but can also have other references held against the job (e.g. job code, SO number, customer reference and external reference).
Job Group	Jobs must be tagged with a Job Group. All jobs tagged with a single job group are processed in the same way. The job group has configuration associated to it to control such items as: POD/POC Report settings; Pre-Job actions (such as signing at a gatehouse); Post-Job actions (such as who signs for the item, are photos required); configurable fields required for entry for the jobs; Terms and Conditions displayed and; driver/user process (such as photos required for cancellation, comments/notes allowed). The job group can be used for any or all Sites, and the configuration against the job group can be different in each site. Job Groups can also be restricted from Admin and Remote users, so that certain users only see jobs for certain groups.
Container	A generic term for any object that contains the items being collected or delivered. Examples of containers are: Pallet; Package; Carton; Item; Cage. A special container "Loose Products" - see Product below. A container is identified by a container ID which is unique to this physical container.
Product	A product is any goods that are being collected or delivered where the product has a 'Product Code' which identifies what the product is but which does not uniquely identify each individual item. A product will also have a quantity associated with it to indicate how many items of this 'Product Code' are being collected or delivered. Products can either be processed within a 'Container' or as 'Loose Products' without a 'Container'.
Owner	The owner of the order that created the job. Typically this is the sales team that took the order and will be responsible for dealing with queries from the customer regarding the status.
Operator; Executor	The Site (depot or carrier) that is executing the load or loads that are involved in the delivery of the items.
Item Related Definitions
Job Code	A reference associated with a job or job(s). This reference is common to connected jobs, for example this would be the same on both the collection of goods and the associated delivery of the same goods. Typically this would be the transport unique reference.
SO Number	A reference associated with a job which indicates the "Sales Order Number" this job is associated with.
Customer Reference	A reference associated with a job which has been provided by and will be recognised by the customer.
External Reference	A reference associated with a job which does not match any of the existing references, usually because it has been provided by an external system.
Pallet	An alternative for 'Container'. The term pallet is used when the operation only uses portable platforms as the container for goods.
Package	An alternative for 'Container'. The term package is used when the operation only uses boxes or wrapping as containers for goods.
Package Code	A code representing the type of 'Container'.
Package Desc	A description of the type of 'Container'.
Product Code	A code which identifies what a product is.
Item	A generic term for any individual item that can be collected or delivered. An item can represent a 'Container' or a 'Product'. This can also be used as an alternative for 'Container' when the operation only treats the goods as individual items, i.e. not as identifiable products.
Service Item	An item which will be serviced by a service job. See action 'Service'.
Issue Life	The time after which an item is no longer fit for purpose.
Pack Size; Case Quantity	A product may consist of a full quantity of items, inside a pack. The Pack Size (or Case Quantity) defines the amount of this product contained in a single pack. For example, if there are 85 items to deliver, with a pack size of 24, the number of full packs is determined to be 3 (24 * 3, or 72), with the remaining (13) being 'loose' quantity. This is displayed as "3/13" on the mobile application.
UOM; Item Type	Unit of Measure; The major (case) UOM. This can optionally be displayed on the mobile device when changing product quantities.
Product Type	A classification of the product being delivered. For example, a company may deliver 7 different mortar products and 80 different concrete slab products. The Product Types may be set to "MORTAR" and "SLABS". This may be used to attach additional configuration, changing the data required when collecting or delivering these product types.
Status Definitions
Status	An indicator of how far through the processing a 'Job', 'Container' or 'Product' has progressed.
Pending	A status indicating that the processing has not yet started, but is required to be completed.
In Progress	A status indicating that processing has started but not yet finished.
Complete	A status indicating that the 'Job', 'Container' or 'Product' has been collected or delivered.
Complete (Amended)	A status indicating that the 'Job', 'Container' or 'Product' has been collected or delivered but that some changes or amendments have been made. This means that not everything that was planned to be collected or delivered was collected or delivered, some items may have been cancelled or some products may only have had some of the planned quantities collected or delivered.
Complete (Claused)	A status indicating that the processing has been finished but that a 'Clause' condition has been recorded for this item.
Claused	See 'Complete (Claused)' and action 'Clause'.
Cancelled	A status indicating that the processing of this item or job is no longer required.
Cancelled at Collection	A status indicating that the delivery of a container or product is no longer required because the associated collection of this container or product was cancelled.
Submitted	An optional status that applies only to a 'Job' and which occurs after the 'Job' has been completed. This indicates that any time and expenses information recorded for the 'Job' has been submitted back to the server and can no longer be altered.
Action Definitions
Start	An action associated with a 'Job' meaning the driver is about to start the processing of this job or jobs. This action will mark the job(s) with a status of 'In Progress'.
Arrive	A conditional action associated with a 'Job' meaning the driver has arrived at the location the goods should be collected from or delivered to.
Continue	An action associated with a 'Job' meaning the driver has previously performed the 'Start' and/or 'Arrive' action and has exited the processing screen but is now going to continue the processing.
Collect	An action associated with a specific 'Container' or a 'Product' meaning the driver has collected the 'Container' or 'Product'. This action will mark the 'Container' or 'Product' with a status of 'Complete' or 'Complete (Amended)'.
Collect Claused	An action associated with a specific 'Container' or a 'Product' meaning the driver has collected the 'Container' or 'Product' but with a condition under which the collection was accepted. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'.
Deliver	An action associated with a specific 'Container' or a 'Product' meaning the driver has delivered the 'Container' or 'Product'. This action will mark the 'Container' or 'Product' with a status of 'Complete' or 'Complete (Amended)'.
Deliver Claused	An action associated with a specific 'Container' or a 'Product' meaning the driver has delivered the 'Container' or 'Product' but with a condition under which the delivery was accepted. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'.
Clause	An action associated with a specific 'Container' or a 'Product' that has already been collected or delivered meaning the collection or delivery has been accepted with a condition. This action will accept the clause condition and then mark the 'Container' or 'Product' with a status of 'Complete (Claused)'.
Cancel	An action associated with a 'Job', 'Container' or 'Product' meaning the collection or delivery will not be performed for this 'Job', 'Container' or 'Product'.
Submit	An optional action which can conditionally be carried out after a 'Job' has been collection or delivered meaning that any/all required expense or time recording for this 'Job' has been completed and can be submitted back to the server.
Service	A service of a service item or items. Typically, Installation, Deinstallation or Service. The process of a service usually encompasses Pre- and Port-work checks, information gathering and diagnosis and resolution notes. Additional references (MC Refs) may also be captured.
Actioned	A general term describing completing a job. So, 'Actioned' may be used instead of 'Collected', 'Serviced', 'Delivered'.
Consolidate	The action of taking several jobs and linking them together, so they are actioned at the same time with one start, arrive and signature.
Deconsolidate	The action of taking a consolidation of jobs and breaking them down into the component jobs again.
Job Swap	The action of selecting an existing load not assigned to the user, and picking jobs to transfer onto the user's load.
Signature Capture	Usually the final action of a job, where the customer's name and signature are entered.
Other Definitions
Reason Code	A code which represents the reason that a job was cancelled or an item was cancelled or claused.
Vehicle	The vehicle used for transporting the goods.
Vehicle Checks	Also Defect Checks. A series of questions representing the results of checks intended to ensure the vehicle is in an acceptable condition.
Metrics Entry	A series of questions to capture information either at the start or end of a 'Load'.
Driver	The person performing the collections or deliveries; the user of the device/application.
Engineer	The person performing the services; the user of the device/application.
Customer	The person/company the goods are being collected from or delivered to.
Signatory	The name of the person providing a signature.
T&Cs	Terms and Conditions. The T&Cs are shown when signatures are prompted for. The text of the T&Cs are defined in the system itself.
Transfer Load	A load select from which to swap jobs to the user's load.
Base	E.g. 'Return to Base'. Typically the depot from which the driver departed.
Unplanned Ad Hoc Collection	A collection job that is created by the driver, usually after delivering to a customer.
Ad Hoc Container Entry/Scanning	The process of adding containers (items) to a job that have not been pre-advised on the job.
Completion Report	POD, POC, Service/Work Report.
Load Assignment	The action of assigning a vehicle and/or a driver to a load.
Job Assignment	The action of putting jobs onto a load.
Collection/Delivery Windows; Access Windows	Periods of time between which it is acceptable to deliver or collect from that customer. This has limited use in the system, mostly for reporting purposes.
Location/Map Terms
Lat-Longs; GPS Co-ordinates, GPS Position	Latitude and Longitude co-ordinates, specified together as a single entity, identifying the exact position of a location. There are multiple formats - CALIDUS ePOD uses decimal notation, for example "53.3490818,-2.8521498" identifies the OBS Logistics office building in Liverpool.
GPS	Global Positioning System; the satellite system used to obtain a GPS position, for use with navigation and location positioning.
Geocode; Reverse Geocode	Geocoding is the process of obtaining lat-longs from an address. Reverse Geocoding is the process obtaining an address from lat-longs.
Geofence; Geofence Break	A Geofence is a perimeter around a location. A Geofence Break occurs when a device passes through this perimeter on entry or exit from the location.

A.3 Authorised By

Murray Middleton	OBS Project Manager	_____________________________
Tony Walker	OBS Consultant	_____________________________