Standard Interface Configuration - Revision history

Anw: Categorisation

2025-06-20T10:01:26Z

Categorisation

← Older revision		Revision as of 12:01, 20 June 2025
Line 1,220:		Line 1,220:
	[[Category:UG 291097 EPOD Advanced Guide\|200]]		[[Category:UG 291097 EPOD Advanced Guide\|200]]
	</noinclude>		</noinclude>
			[[Category:FAQ]]

Anw: Split OBS standard Job and Load exports, to provide better descriptions of functionality.

2021-10-06T08:55:28Z

Split OBS standard Job and Load exports, to provide better descriptions of functionality.

← Older revision		Revision as of 10:55, 6 October 2021
Line 189:		Line 189:
	<!-- MEDIA LANDSCAPE YES -->		<!-- MEDIA LANDSCAPE YES -->
	== Core ''CALIDUS'' Exports ==		== Core ''CALIDUS'' Exports ==
	=== Job ~~and Load~~ ===		=== Job ===
	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 through an XF Config ID.		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.

	~~These types export~~ and ~~import~~ 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.		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.		{{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").


Line 206:		Line 208:
	\|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_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_XF_ID \|\|The export type, JOB.
	\|-		\|-
	\|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_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.		\|EPL_EXPORT_JOB_TYPES \|\|CD. Defining the job types that are exported. For example, C are collections, D are deliveries.
	\|}		\|}


	Example File Job Export:		Example File Job Export:
Line 262:		Line 265:
	\|-		\|-
	\|EPL_CONTRACT_OPERATION \|\|CXMLTYPE-EPOD_INInput		\|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:
			{\| class="wikitable" border="1"
			\|- bgcolor="silver"
			!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.
	\|}		\|}

Anw: Minor correction

2019-04-25T13:30:44Z

Minor correction

← Older revision		Revision as of 15:30, 25 April 2019
Line 1,180:		Line 1,180:
	\|}		\|}

			<noinclude>
	[[Category:UG 291097 EPOD Advanced Guide\|200]]		[[Category:UG 291097 EPOD Advanced Guide\|200]]
			</noinclude>

Anw: Updated based on version 4.5.00.02: Added Invoices interface and HERE geocoder

2019-04-08T13:59:59Z

Updated based on version 4.5.00.02: Added Invoices interface and HERE geocoder

Show changes

Anw: Updated based on version 4.5.00.02: Added Invoices interface and HERE geocoder

2019-04-08T13:46:57Z

Updated based on version 4.5.00.02: Added Invoices interface and HERE geocoder

@@ Line 501: / Line 501: @@
 * EPOD_LOTS_(EPL_SITE_ID)_POD_(DATE)_(TIME)_(UID)
 Filename can be specified in the EPL_FILENAME parameter as described generically above.
@@ Line 642: / Line 660: @@
 |EPL_CONTRACT_OPERATION	|| geocodeAddress
 |}
@@ Line 873: / Line 953: @@
 <!-- MEDIA LANDSCAPE NO -->
 ==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.

Anw: Updated to show configuration of the WEBFLEET geocoder.

2018-12-18T11:10:01Z

Updated to show configuration of the WEBFLEET geocoder.

@@ Line 508: / Line 508: @@
 {{Note}} A WEBFLEET fleet, user and password will be required to use these services.
@@ Line 540: / Line 542: @@
 |-
 |EPL_XF_MSG_TYPE	|| WEBFLEET API Key - for CALIDUS ePOD this is 000fcb2a-6631-477a-b00e-de0505e7c7e3
 |-
 |EPL_CONTRACT_OPERATION	|| geocodeAddress
 |}
@@ Line 918: / Line 977: @@
 {{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.

Anw: Added TomTom WEBFLEET Device settings configuration

2018-09-24T09:18:56Z

Added TomTom WEBFLEET Device settings configuration

@@ Line 999: / Line 999: @@
 |-
 |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.
 |}
 [[Category:UG 291097 EPOD Advanced Guide|200]]

Anw: Reworded the initial section to show how critical it is to set up the Site or Job Groups (BAP)

2018-09-21T14:39:13Z

Reworded the initial section to show how critical it is to set up the Site or Job Groups (BAP)

← Older revision		Revision as of 16:39, 21 September 2018
Line 15:		Line 15:
	All interfaces, import and export, are configured through the ''CALIDUS'' ePOD Admin system, using the [[Auto-Export\|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.		All interfaces, import and export, are configured through the ''CALIDUS'' ePOD Admin system, using the [[Auto-Export\|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 Job Group. 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.		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.


			{{Warning}} '''Without attaching a configuration to a site or job group, the interfaces will never be run. Any jobs that may have been triggered prior to the assignment of the Interface Configuration ID will not be generated.'''


			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.		Exceptions to these general rules are noted below.

Anw: Minor correction

2018-09-21T14:31:13Z

Minor correction

← Older revision		Revision as of 16:31, 21 September 2018
Line 15:		Line 15:
	All interfaces, import and export, are configured through the ''CALIDUS'' ePOD Admin system, using the [[Auto-Export\|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.		All interfaces, import and export, are configured through the ''CALIDUS'' ePOD Admin system, using the [[Auto-Export\|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.		Import and Export configurations are grouped under Configuration ID, which can then be attached to a Site or Job Group. 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.		Exceptions to these general rules are noted below.

Anw: Basic formatting

2018-07-30T14:41:05Z

Basic formatting

Show changes