FS 291096 Interface with CALIDUS ePOD - Revision history

Anw: Minor correction of date

2019-01-07T15:32:52Z

Minor correction of date

← Older revision		Revision as of 17:32, 7 January 2019
Line 5:		Line 5:
	{{#vardefine:Doc_Title\|Interfacing with {{#var:System}}}}		{{#vardefine:Doc_Title\|Interfacing with {{#var:System}}}}
	{{#vardefine:Version\|2.0}}		{{#vardefine:Version\|2.0}}
	{{#vardefine:Date\|~~11th~~ January 2019}}		{{#vardefine:Date\|7th January 2019}}
	{{#vardefine:Reference\|291096}}		{{#vardefine:Reference\|291096}}
	{{#vardefine:Year\|2019}}		{{#vardefine:Year\|2019}}

Anw: v2.0 - Added greater details of web service pull methods.

2019-01-07T15:31:53Z

v2.0 - Added greater details of web service pull methods.

Show changes

Anw: v1.1 - Update in line with server version 3.4.1.4

2017-01-11T11:14:03Z

v1.1 - Update in line with server version 3.4.1.4

Show changes

Anw: v1.0 - Issue after review

2015-02-05T10:49:54Z

v1.0 - Issue after review

← Older revision		Revision as of 12:49, 5 February 2015
Line 4:		Line 4:
	{{#vardefine:System\|''CALIDUS'' ePOD/eSERV}}		{{#vardefine:System\|''CALIDUS'' ePOD/eSERV}}
	{{#vardefine:Doc_Title\|Interfacing with {{#var:System}}}}		{{#vardefine:Doc_Title\|Interfacing with {{#var:System}}}}
	{{#vardefine:Version\|0.3}}		{{#vardefine:Version\|1.0}}
	{{#vardefine:Date\|5th February 2015}}		{{#vardefine:Date\|5th February 2015}}
	{{#vardefine:Reference\|291096}}		{{#vardefine:Reference\|291096}}
Line 45:		Line 45:
	* Each container and product must be actioned by the user (i.e. enter/scan each container for delivery, or say why each container was not delivered).		* Each container and product must be actioned by the user (i.e. enter/scan each container for delivery, or say why each container was not delivered).
	* If a container has products, each of these must be actioned by the user. It is configurable whether products are required to be entered.		* If a container has products, each of these must be actioned by the user. It is configurable whether products are required to be entered.
	* If products are defined without a container (i.e. Loose Products), they must be entered. {{#var:System}} assumes a Loose Product container of '~~000000000000~~', so that the table data structure is preserved.		* If products are defined without a container (i.e. Loose Products), they must be entered. {{#var:System}} assumes a Loose Product container of '000000000000000', so that the table data structure is preserved.

	== Scope ==		== Scope ==
Line 244:		Line 244:
	<EPL_CUST_REF>CR-TEST001001</EPL_CUST_REF>		<EPL_CUST_REF>CR-TEST001001</EPL_CUST_REF>
	<EPL_JOB_INSTRUCTION>Free Text Instructions</EPL_JOB_INSTRUCTION>		<EPL_JOB_INSTRUCTION>Free Text Instructions</EPL_JOB_INSTRUCTION>
	<EPL_OFFICE_INSTRUCTION>Multiple container collection with multiple products.</EPL_OFFICE_INSTRUCTION>		<EPL_OFFICE_INSTRUCTION>Multiple container collection with multiple products.
			</EPL_OFFICE_INSTRUCTION>
	<EPL_START_PLANNED_DATE>20120320</EPL_START_PLANNED_DATE>		<EPL_START_PLANNED_DATE>20120320</EPL_START_PLANNED_DATE>
	<EPL_START_PLANNED_TIME>00000000</EPL_START_PLANNED_TIME>		<EPL_START_PLANNED_TIME>00000000</EPL_START_PLANNED_TIME>
Line 407:		Line 408:
	<EPL_CUST_REF>CR-LOAD 46</EPL_CUST_REF>		<EPL_CUST_REF>CR-LOAD 46</EPL_CUST_REF>
	<EPL_JOB_INSTRUCTION>Free Text Instructions</EPL_JOB_INSTRUCTION>		<EPL_JOB_INSTRUCTION>Free Text Instructions</EPL_JOB_INSTRUCTION>
	<EPL_OFFICE_INSTRUCTION>Containers and loose products. Linked to collection through Job Code</EPL_OFFICE_INSTRUCTION>		<EPL_OFFICE_INSTRUCTION>Containers and loose products. Linked to collection
			through Job Code</EPL_OFFICE_INSTRUCTION>
	<EPL_START_PLANNED_DATE>20120320</EPL_START_PLANNED_DATE>		<EPL_START_PLANNED_DATE>20120320</EPL_START_PLANNED_DATE>
	<EPL_START_PLANNED_TIME>00000000</EPL_START_PLANNED_TIME>		<EPL_START_PLANNED_TIME>00000000</EPL_START_PLANNED_TIME>
Line 560:		Line 562:
	<EPL_CUST_REF>CR-LOAD 46</EPL_CUST_REF>		<EPL_CUST_REF>CR-LOAD 46</EPL_CUST_REF>
	<EPL_JOB_INSTRUCTION>Free Text Instructions</EPL_JOB_INSTRUCTION>		<EPL_JOB_INSTRUCTION>Free Text Instructions</EPL_JOB_INSTRUCTION>
	<EPL_OFFICE_INSTRUCTION>Containers and loose products. Linked to collection through Job Code</EPL_OFFICE_INSTRUCTION>		<EPL_OFFICE_INSTRUCTION>Containers and loose products. Linked to collection
			through Job Code</EPL_OFFICE_INSTRUCTION>
	<EPL_START_PLANNED_DATE>20120320</EPL_START_PLANNED_DATE>		<EPL_START_PLANNED_DATE>20120320</EPL_START_PLANNED_DATE>
	<EPL_START_PLANNED_TIME>00000000</EPL_START_PLANNED_TIME>		<EPL_START_PLANNED_TIME>00000000</EPL_START_PLANNED_TIME>
Line 1,301:		Line 1,304:

	=== Terms & Conditions ===		=== Terms & Conditions ===
	Terms and Conditions displayed to customers are configurable within {{#var:System}}. The ~~are represented by mixed~~ HTML ~~format~~, as follows:		Terms and Conditions displayed to customers are configurable within {{#var:System}}. The format is similar to the above XML extracts, with a simple HTML-style INPUT tag, as follows:
	<TERMS_CONDITIONS>		<TERMS_CONDITIONS>
	<TEXT>I certify that the information in A, B and C is correct, and that the carrier is registered.<br />		<TEXT>I certify that the information in A, B and C is correct, and that the carrier
	I confirm that I have fulfilled my duty to apply the waste hierarchy as required by Regulation 12 of the		is registered.<br />
	Waste (England and Wales) Regulations 2011.</TEXT>		I confirm that I have fulfilled my duty to apply the waste hierarchy as required by
			Regulation 12 of the Waste (England and Wales) Regulations 2011.</TEXT>
	<CHECKS>		<CHECKS>
	<INPUT type="checkbox">CHECK1</INPUT>		<INPUT type="checkbox">CHECK1</INPUT>
Line 1,356:		Line 1,360:
	\|Glossary=EPOD		\|Glossary=EPOD
	\|Ref1=EPOD Import Mapping v0.10.xlsx		\|Ref1=EPOD Import Mapping v0.10.xlsx
	\|RefV1=0.5		\|RefV1=0.10
	\|RefDate1=05/02/2015		\|RefDate1=05/02/2015
	\|Ref2=EPOD Export Mapping v0.10.xlsx		\|Ref2=EPOD Export Mapping v0.10.xlsx

Anw: v0.3 - draft with latest modifications

2015-02-05T10:39:34Z

v0.3 - draft with latest modifications

Show changes

Anw: Updated references

2013-09-24T08:44:27Z

Updated references

← Older revision		Revision as of 10:44, 24 September 2013
Line 1,228:		Line 1,228:
	\|Estimate=N		\|Estimate=N
	\|Glossary=EPOD		\|Glossary=EPOD
	\|Ref1=~~[http://{{SERVERNAME}}/calidus-assist/~~EPOD~~/index~~.~~php/UG_291094_EPOD_Admin_User_Guide UG 291094 EPOD Admin User Guide]~~		\|Ref1=EPOD Import Mapping v0.7.xlsx
	\|RefV1=2.0		\|RefV1=0.5
	\|RefDate1=4/4/~~2012~~		\|RefDate1=24/09/2013
	\|Ref2=~~[http://{{SERVERNAME}}/calidus-assist/~~EPOD~~/index~~.~~php/UG_291097_EPOD_Client_User_Guide UG 291097 EPOD Client User Guide]~~		\|Ref2=EPOD Export Mapping v0.7.xlsx
	\|RefV2=3.0		\|RefV2=0.7
	\|RefDate2=23/4/2013		\|RefDate2=24/09/2013
			\|Ref3=XSD.zip
			\|RefV3=N/A
			\|RefDate3=23/09/2013
	\|REQ=0		\|REQ=0
	\|EST=0		\|EST=0

Anw: v0.2 - Extended export section

2013-09-24T08:36:22Z

v0.2 - Extended export section

← Older revision		Revision as of 10:36, 24 September 2013
Line 4:		Line 4:
	{{#vardefine:System\|''CALIDUS'' ePOD/eSERV}}		{{#vardefine:System\|''CALIDUS'' ePOD/eSERV}}
	{{#vardefine:Doc_Title\|Interfacing with ''CALIDUS'' ePOD/eSERV}}		{{#vardefine:Doc_Title\|Interfacing with ''CALIDUS'' ePOD/eSERV}}
	{{#vardefine:Version\|0.1}}		{{#vardefine:Version\|0.2}}
	{{#vardefine:Date\|24th September 2013}}		{{#vardefine:Date\|24th September 2013}}
	{{#vardefine:Reference\|291096}}		{{#vardefine:Reference\|291096}}
Line 48:		Line 48:

	== Scope ==		== Scope ==
	~~There are interfaces into~~ {{~~#var:System~~}} for ~~Standing Data~~.		{{Note}} All web service requests and XML formats are fully documented in the supporting documentation. XML files have associated XSDs, for appropriate validation.

	{{Note}} ~~It is not deemed necessary at this time to map~~ interfaces ~~from the TMS~~ for Standing Data, as this can be maintained separately and manually within {{#var:System}}. Those flows are:		{{Note}} There are interfaces into {{#var:System}} for Standing Data. This document does not yet show these interfaces, as this can be maintained separately and manually within {{#var:System}}. Those flows are:
	* Vehicles		* Vehicles
	* Reason Codes (used when cancelling jobs or pallets)		* Reason Codes (used when cancelling jobs or pallets)
	* Users (Drivers/Engineers)		* Users (Drivers/Engineers)
	* Customers		* Customers
			Interfaces do exist for this standing data upload through the Web Services, used in exactly the same way as described for the Load and Job interfaces below. The interface formats are described in detail in the supporting documentation, referenced in the appendices.

	The system can be configured to automatically create the Vehicles and Users with very basic information based off the received values in the Load and Job messages. Customers will be created as part of the information received through the Job messages.		The system can be configured to automatically create the Vehicles and Users with very basic information based off the received values in the Load and Job messages. Customers will be created as part of the information received through the Job messages.

	{{Note}} The document does not at this time define the interface required for Service-type jobs, as this is currently in significant development within the product. A basic interface does exist and is described in detail in the supporting documentation, referenced in the appendices.		{{Note}} The document does not at this time define the interface required for Service-type jobs, as this is currently in significant development within the product. A basic interface does exist and is described in detail in the supporting documentation, referenced in the appendices.


	<!-- NEW PAGE -->		<!-- NEW PAGE -->
Line 99:		Line 102:
	* Current Vehicle information		* Current Vehicle information

	Auto-export of data can be configured to push the XML data automatically to the client system, via 2 mechanisms:		Auto-export of data can be configured to push the XML data automatically to the client system, via several mechanisms:
	* Web Service		* Web Service
	* Email		* Email
Line 117:		Line 120:
	The Auto-Export process is run as a scheduled task on the main {{#var:System}} server.		The Auto-Export process is run as a scheduled task on the main {{#var:System}} server.

	== Message Content ==		== Import Message Content ==
	A basic list if 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.		A basic list if 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.

Line 722:		Line 725:
	</pre>		</pre>

	== Sending ~~Mechanism~~ ==		== Mechanism for Sending Import Files to Web Services ==
	The system provides web services for importing data.		The system provides web services for importing data.
	There are two mechanisms:		There are two mechanisms:
Line 909:		Line 912:
	</pre>		</pre>

	== Processing Responses ==		== Processing Responses through Web Services ==
	The response data is an XML file (either string data or an XML object), as shown in the calling methods above. The result is governed by a schema, in the same way that the import files are. All XSD schemas will be provided to you.		The response data is an XML file (either string data or an XML object), as shown in the calling methods above. The result is governed by a schema, in the same way that the import files are. All XSD schemas will be provided to you.

Line 983:		Line 986:
	</pre>		</pre>

	== ~~Importing into {{#var:System}} ==~~		== Export Process ==
	~~{{Warning}}~~

	~~== {{#var:System}}~~ Export Process ==
	A process runs on a timed schedule within the {{#var:System}} application, to pick up any jobs that have been completed and export them to external systems.		A process runs on a timed schedule within the {{#var:System}} 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.~~		== Export Message Content ==

	~~The exporting of this data will be modified to include:~~
	* Entered Trailer ID (at Job level).
	* Clause information (per pallet)

	== ~~{{#var:System}}~~ 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.		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.

Line 1,198:		Line 1,192:
	{{Note}} The signature has been shortened for the purposes of this document.		{{Note}} The signature has been shortened for the purposes of this document.

	== ~~{{#var:System}}~~ Export ~~Mechanism~~ ==		== Export Mechanisms ==
	~~The system will be configured to send to a web service, requiring a string~~ (~~rather than an XML object~~) ~~input.~~		=== Web Services (Push) ===
			The identity of the web service will be defined by the TMS team, requiring a string (rather than an XML object) input.
	The identity of the web service will be defined by the TMS team ~~as part of this development~~.

	Each job will be sent independently, resulting in a single call to the external web service to add this job.		Each job will be sent independently, resulting in a single call to the external web service to add this job.

	When the file is received and processed by the web service, the system expects the web service to respond in the format, as shown in previous sections. The exact same format and structure should be used as described here. The content may be as detailed as required by the TMS system.		When the file is received and processed by the web service, the system expects the web service to respond in the format, as shown in previous sections. The exact same format and structure should be used as described here. The content may be as detailed as required by the TMS system.

			=== Web Services (Pull) ===
			Web Services are supplied for external systems to request information on Loads and Jobs, by ID or Date Since. The Web Services are hosted as part of the main ''CALIDUS'' ePOD server and run as SOAP or HTML Web Services. Response Data is formatted in a strongly-typed XML file, validated by a full XSD.

			Standard requested data to export supports the following, through the indicated web services request:
			* Loads (including all Jobs underneath) by ID or Date
			** EPOD_XML_EXPORT_LOAD
			** EPOD_XML_EXPORT_LOAD_DATE
			** EPOD_XML_EXPORT_LOAD_DATE_RANGE
			* Jobs by ID or Date
			** EPOD_XML_EXPORT_JOB
			** EPOD_XML_EXPORT_JOB_DATE
			** EPOD_XML_EXPORT_JOB_DATE_RANGE
			* Current Vehicle information
			** EPOD_XML_EXPORT_VEHICLE_REQUEST

			=== Flat-file Processing ===
			The FTP server or File-system can be identified by the TMS team, or supplied by OBS Logistics.

			Each job will be sent independently, resulting in a single XML file created in the destination folder. The naming of the file is configurable.

			No confirmation of processing is required - this is expected to be handled by the host system. Files processed can be deleted or moved to an archive folder, as required by the host system.


	<!-- NEW PAGE -->		<!-- NEW PAGE -->

Anw at 08:12, 24 September 2013

2013-09-24T08:12:33Z

← Older revision		Revision as of 10:12, 24 September 2013
Line 1:		Line 1:
	<div class="noprint">		<div class="noprint">
	{{#vardefine:Client\|~~LANE~~}}		{{#vardefine:Client\|PROD}}
	{{#vardefine:ClientName\|~~Lanemark~~}}		{{#vardefine:ClientName\|OBS Logistics}}
	{{#vardefine:System\|''CALIDUS'' ePOD}}		{{#vardefine:System\|''CALIDUS'' ePOD/eSERV}}
	{{#vardefine:Doc_Title\|Interfacing with ~~{{#var:System}}~~}}		{{#vardefine:Doc_Title\|Interfacing with ''CALIDUS'' ePOD/eSERV}}
	{{#vardefine:Version\|0.1}}		{{#vardefine:Version\|0.1}}
	{{#vardefine:Date\|24th September 2013}}		{{#vardefine:Date\|24th September 2013}}
	{{#vardefine:Reference\|~~291086~~}}		{{#vardefine:Reference\|291096}}
	{{#vardefine:Year\|2013}}		{{#vardefine:Year\|2013}}
	</div>		</div>
Line 18:		Line 18:
	\|Year={{#var:Year}}		\|Year={{#var:Year}}
	}}		}}
	~~__NOTOC__~~
			<!-- TOC -->
	<div class="noprint">		<div class="noprint">
	=~~= Solution~~ Overview ==		= Functional Overview =
	{{#var:System}} provides an electronic proof of delivery execution layer to existing TMS systems or a stand-alone execution and basic Admin layer for stand-alone customers.		{{#var:System}} provides an electronic proof of delivery execution layer to existing TMS systems or a stand-alone execution and basic Admin layer for stand-alone customers.

Line 197:		Line 198:
	<tr><td>EPL_SITE_ID</td><td>Unique Reference for the Site that the Job belongs to</td><td> </td><td> </td></tr>		<tr><td>EPL_SITE_ID</td><td>Unique Reference for the Site that the Job belongs to</td><td> </td><td> </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> </td><td> </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> </td><td> </td></tr>
	<tr><td>EPL_CONTAINER_ID</td><td>EPL_CONTAINER_ID: The unique identifier for a ~~cotainer~~.</td><td> </td><td> </td></tr>		<tr><td>EPL_CONTAINER_ID</td><td>EPL_CONTAINER_ID: The unique identifier for a container.</td><td> </td><td> </td></tr>
	<tr><td>EPL_PRODUCT_CODE</td><td>The unique identifier for the product delivered/collected</td><td> </td><td> </td></tr>		<tr><td>EPL_PRODUCT_CODE</td><td>The unique identifier for the product delivered/collected</td><td> </td><td> </td></tr>
	<tr><td>EPL_SEQUENCE</td><td>A unique sequence for the product.</td><td> </td><td> </td></tr>		<tr><td>EPL_SEQUENCE</td><td>A unique sequence for the product.</td><td> </td><td> </td></tr>
Line 732:		Line 733:
	SOAP 1.1		SOAP 1.1

	The following is a sample SOAP 1.1 request and response. The ~~placeholders~~ shown need to be replaced with actual values.		The following is a sample SOAP 1.1 request and response. The place-holders shown need to be replaced with actual values.
	<pre>		<pre>
	POST /webservices/dataservice/EPOD_dataservice.asmx HTTP/1.1		POST /webservices/dataservice/EPOD_dataservice.asmx HTTP/1.1
Line 983:		Line 984:

	== Importing into {{#var:System}} ==		== Importing into {{#var:System}} ==
			{{Warning}}

	== {{#var:System}} Export Process ==		== {{#var:System}} Export Process ==
	A process runs on a timed schedule within the {{#var:System}} application, to pick up any jobs that have been completed and export them to external systems.		A process runs on a timed schedule within the {{#var:System}} application, to pick up any jobs that have been completed and export them to external systems.

Anw: v0.1 - Initial Creation

2013-09-24T08:01:41Z

v0.1 - Initial Creation

Show changes

← Older revision		Revision as of 17:32, 7 January 2019
Line 5:		Line 5:
	{{#vardefine:Doc_Title\|Interfacing with {{#var:System}}}}		{{#vardefine:Doc_Title\|Interfacing with {{#var:System}}}}
	{{#vardefine:Version\|2.0}}		{{#vardefine:Version\|2.0}}
	{{#vardefine:Date\|~~11th~~ January 2019}}		{{#vardefine:Date\|7th January 2019}}
	{{#vardefine:Reference\|291096}}		{{#vardefine:Reference\|291096}}
	{{#vardefine:Year\|2019}}		{{#vardefine:Year\|2019}}