Standard Interface Configuration

Data may be created within CALIDUS ePOD from many sources:

• Import of jobs, loads and standing data through standard webservices
• 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.

Data may be exported from CALIDUS ePOD in many ways:

• Requested Export through standard C-ePOD webservices
• 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 Webservices for import and export of jobs and loads, which are always available to processes that request from these webservices.

Import and Export configurations are grouped under Configuration ID, which can then be attached to a Site or Load. Without attaching a configuration to a site or job group, the interfaces will never be run. Multiples of each export type can be added to each configuration, allowing for (for example) multiple exports of the same data when a single job or load is completed.

Exceptions to these general rules are noted below.

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

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 webservice
• FTP - an FTP address
• EMAIL - an Email address
• FILE - a local or network file transfer
• POST - a POST webservice i.e. URL to a web page.

Typically, all transfer types are defined by the destination set in EPL_XF_DESTINATION

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 webservices typically require a number of parameters in addition to POST parameters.

The destination is defined as the webservice and method.

Example:

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

Other parameters that may be required:

• EPL_WEB_PARAMETER - parameter for the webservice e.g. EPOD_ACTUALS-XMLTYPE-IN
• EPL_WEB_USER - username for authenticated webservices
• EPL_WEB_PASSWORD - password for authenticated webservices
• 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 webservice XML e.g. CXMLTYPE-EPOD_INInput

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

Core CALIDUS Exports

Job and Load

For Export, if these configurations have the same name as the Site that they apply to, these need not be attached to a Site or Job Group.

These types export and import data through the EPOD standard XML format, through webservices, file copy or FTP. Exports may also be emailed, where the XML is attached to an email and sent.

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, one of JOB or LOAD
EPL_EXPORT_FULLHEADERS	Normally "N" or unchecked. If "Y", this affects Load exports, and 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. 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

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

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 webservice, 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.

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

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.

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

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)

TomTom Export Interfaces

TomTom interfaces utilise the TomTom WEBFLEET webservices to perform the following tasks.

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

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_CONTRACT_OPERATION	geocodeAddress

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 webservice 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

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 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.

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 webservice 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	Webservice 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 webservice only to the TPN Connect system.

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

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.

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 webservices.

In all ways, this operates as the standard webservices, 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.

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.