EPOD-TTM Interface - Revision history

Anw: Minor correction

2022-09-27T08:05:25Z

Minor correction

← Older revision		Revision as of 10:05, 27 September 2022
Line 538:		Line 538:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
			<ORDER_TRANSACTION_DATE>2012-12-24T10:00:00</ORDER_TRANSACTION_DATE>
	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>
Line 902:		Line 903:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
			<ORDER_TRANSACTION_DATE>2012-12-24T10:00:00</ORDER_TRANSACTION_DATE>

	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>
Line 1,154:		Line 1,157:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
			<ORDER_TRANSACTION_DATE>2012-12-24T10:00:00</ORDER_TRANSACTION_DATE>

	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>
Line 1,421:		Line 1,426:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
			<ORDER_TRANSACTION_DATE>2012-12-24T10:00:00</ORDER_TRANSACTION_DATE>

	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>

Anw: Added route code to TRP export.

2022-09-26T13:17:18Z

Added route code to TRP export.

← Older revision		Revision as of 15:17, 26 September 2022
Line 373:		Line 373:
	\|-		\|-
	\|TRIP_DISTANCE \|\|EPL_LOAD_DISTANCE_PLANNED		\|TRIP_DISTANCE \|\|EPL_LOAD_DISTANCE_PLANNED
			\|-
			\|ROUTE_CODE \|\|EPL_ROUTE_CODE
	\|}		\|}

Anw: Minor formatting change

2021-10-06T15:40:58Z

Minor formatting change

← Older revision		Revision as of 17:40, 6 October 2021
Line 536:		Line 536:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
	~~ORDER_TRANSACTION_DATE", Audit Date and Time),~~
	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>
Line 901:		Line 900:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
	~~ORDER_TRANSACTION_DATE", Audit Date and Time),~~
	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>
Line 1,154:		Line 1,152:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
	~~ORDER_TRANSACTION_DATE", Audit Date and Time),~~
	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>
Line 1,422:		Line 1,419:
	<BOOK_REF>EPL_EXT_REF</BOOK_REF>		<BOOK_REF>EPL_EXT_REF</BOOK_REF>
	<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>		<BOOK_DATE>2012-12-24T10:00:00</BOOK_DATE>
	~~ORDER_TRANSACTION_DATE", Audit Date and Time),~~
	<ORDER_HEADER>		<ORDER_HEADER>
	<ORDER_DETAILS>		<ORDER_DETAILS>

Anw: Updated based on version 4.5.00.02

2019-04-08T13:05:43Z

Updated based on version 4.5.00.02

← Older revision		Revision as of 15:05, 8 April 2019
Line 497:		Line 497:
	</TRIP_HEADER>		</TRIP_HEADER>
	<TRIP_DETAIL>		<TRIP_DETAIL>
			<HAULIER></HAULIER>
	<TRACTOR_LAT></TRACTOR_LAT>		<TRACTOR_LAT></TRACTOR_LAT>
	<TRACTOR_LON></TRACTOR_LON>		<TRACTOR_LON></TRACTOR_LON>
	~~<HAULIER></HAULIER>~~
	</TRIP_DETAIL>		</TRIP_DETAIL>
	<STOPS>		<STOPS>
Line 575:		Line 575:
	\|- bgcolor="silver"		\|- bgcolor="silver"
	!Tag !!Notes		!Tag !!Notes
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
	\|-		\|-
	\|TRACTOR_LAT \|\|The latitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD.		\|TRACTOR_LAT \|\|The latitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD.
	\|-		\|-
	\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD.		\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD.
	\|-
	~~\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID~~
	\|}		\|}

Line 858:		Line 858:
	</TRIP_HEADER>		</TRIP_HEADER>
	<TRIP_DETAIL>		<TRIP_DETAIL>
			<HAULIER></HAULIER>
	<TRACTOR_LAT></TRACTOR_LAT>		<TRACTOR_LAT></TRACTOR_LAT>
	<TRACTOR_LON></TRACTOR_LON>		<TRACTOR_LON></TRACTOR_LON>
	~~<HAULIER></HAULIER>~~
	</TRIP_DETAIL>		</TRIP_DETAIL>
	<STOPS>		<STOPS>
Line 957:		Line 957:
	\|- bgcolor="silver"		\|- bgcolor="silver"
	!Tag !!Notes		!Tag !!Notes
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
	\|-		\|-
	\|TRACTOR_LAT \|\|The latitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.		\|TRACTOR_LAT \|\|The latitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.
	\|-		\|-
	\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.		\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.
	\|-
	~~\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID~~
	\|}		\|}

Line 1,379:		Line 1,379:
	</TRIP_HEADER>		</TRIP_HEADER>
	<TRIP_DETAIL>		<TRIP_DETAIL>
			<HAULIER></HAULIER>
	<TRACTOR_LAT></TRACTOR_LAT>		<TRACTOR_LAT></TRACTOR_LAT>
	<TRACTOR_LON></TRACTOR_LON>		<TRACTOR_LON></TRACTOR_LON>
	~~<HAULIER></HAULIER>~~
	</TRIP_DETAIL>		</TRIP_DETAIL>
	<STOPS>		<STOPS>
Line 1,478:		Line 1,478:
	\|- bgcolor="silver"		\|- bgcolor="silver"
	!Tag !!Notes		!Tag !!Notes
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
	\|-		\|-
	\|TRACTOR_LAT \|\|The latitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.		\|TRACTOR_LAT \|\|The latitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.
	\|-		\|-
	\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.		\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.
	\|-
	~~\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID~~
	\|}		\|}

Anw: Updated based on version 4.0.02.48

2019-03-26T08:51:42Z

Updated based on version 4.0.02.48

← Older revision		Revision as of 10:51, 26 March 2019
Line 499:		Line 499:
	<TRACTOR_LAT></TRACTOR_LAT>		<TRACTOR_LAT></TRACTOR_LAT>
	<TRACTOR_LON></TRACTOR_LON>		<TRACTOR_LON></TRACTOR_LON>
			<HAULIER></HAULIER>
	</TRIP_DETAIL>		</TRIP_DETAIL>
	<STOPS>		<STOPS>
Line 578:		Line 579:
	\|-		\|-
	\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD.		\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD.
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
	\|}		\|}

Line 719:		Line 722:
	<TRIP_ID>EPL_LOAD_ID</TRIP_ID>		<TRIP_ID>EPL_LOAD_ID</TRIP_ID>
	</TRIP_HEADER>		</TRIP_HEADER>
			<TRIP_DETAIL>
			<HAULIER></HAULIER>
			</TRIP_DETAIL>
	<STOPS>		<STOPS>
	<STOP>		<STOP>
Line 757:		Line 763:
	\|}		\|}


			Variable data for TRIP_DETAIL:
			{\| class="wikitable" border="1"
			\|- bgcolor="silver"
			!Tag !!Notes
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
			\|}

	Variable data for STOP_HEADER:		Variable data for STOP_HEADER:
Line 846:		Line 860:
	<TRACTOR_LAT></TRACTOR_LAT>		<TRACTOR_LAT></TRACTOR_LAT>
	<TRACTOR_LON></TRACTOR_LON>		<TRACTOR_LON></TRACTOR_LON>
			<HAULIER></HAULIER>
	</TRIP_DETAIL>		</TRIP_DETAIL>
	<STOPS>		<STOPS>
Line 946:		Line 961:
	\|-		\|-
	\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.		\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
	\|}		\|}

Line 1,364:		Line 1,381:
	<TRACTOR_LAT></TRACTOR_LAT>		<TRACTOR_LAT></TRACTOR_LAT>
	<TRACTOR_LON></TRACTOR_LON>		<TRACTOR_LON></TRACTOR_LON>
			<HAULIER></HAULIER>
	</TRIP_DETAIL>		</TRIP_DETAIL>
	<STOPS>		<STOPS>
Line 1,464:		Line 1,482:
	\|-		\|-
	\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.		\|TRACTOR_LON \|\|The longitude of where the job was started, extracted from EPOD_AUDIT.EPL_GPS_COORD, if populated, else 0.
			\|-
			\|HAULIER \|\| EPODSITE.EPL_TTM_XREF if present, else EPODSITE.EPL_SITE_ID
	\|}		\|}

Anw: Updated based on version 4.0.02.16

2018-11-29T09:08:50Z

Updated based on version 4.0.02.16

← Older revision		Revision as of 11:08, 29 November 2018
Line 261:		Line 261:
	A TRP message informs ''CALIDUS'' Portal that a Trip is created, showing all the stops on the trip and the basic information on the orders on the stops.		A TRP message informs ''CALIDUS'' Portal that a Trip is created, showing all the stops on the trip and the basic information on the orders on the stops.

	A TRP message is sent when an order is created.		A TRP message is sent when:
	It is ~~also sent when~~ an order is updated through the Flat-file Auto-Import process.		* an order is created.
	~~It is also sent when~~ an order is updated through the Job and Load Import Webservices		* an order is assigned to a load.
			* an order is updated through the Flat-file Auto-Import process.
			* an order is updated through the Job and Load Import Webservices.
			* the load is deleted.

	The data in the message sections is predominantly based on the following tables:		The data in the message sections is predominantly based on the following tables:

Anw: Updated based on version 4.0.02.02 - updated TripOrder XSD version

2018-01-08T16:18:34Z

Updated based on version 4.0.02.02 - updated TripOrder XSD version

← Older revision		Revision as of 18:18, 8 January 2018
Line 3:		Line 3:

	== Scope ==		== Scope ==
	This document and all message formats conform to the ''CALIDUS'' Portal LOTS-tripOrder XSD version 1.~~17, as seen in the references of this document~~. If this is changed, or if ''CALIDUS'' Portal functionality changes based on tags that already exist, both this document and the ''CALIDUS'' ePOD export processes will require modification.		This document and all message formats conform to the ''CALIDUS'' Portal LOTS-tripOrder XSD version 1.34. If this is changed, or if ''CALIDUS'' Portal functionality changes based on tags that already exist, both this document and the ''CALIDUS'' ePOD export processes will require modification.

	All functionality described here is gathered from version 4.0.02.02 of the ''CALIDUS'' ePOD Server module.		All functionality described here is gathered from version 4.0.02.02 of the ''CALIDUS'' ePOD Server module.
Line 1,673:		Line 1,673:
	The process is as follows:		The process is as follows:
	* Builds all messages to be sent		* Builds all messages to be sent
	* Send all messages to ~~TTM~~.		* Send all messages to ''CALIDUS'' Portal.

	Messages are built in this order, with these details:		Messages are built in this order, with these details:

Anw: Changed STOP_ACTUAL_ARRIVAL_DATE to default to END_ACTUAL times rather than START_ACTUAL if ARRIVAL date/time does not exist

2018-01-08T16:14:14Z

Changed STOP_ACTUAL_ARRIVAL_DATE to default to END_ACTUAL times rather than START_ACTUAL if ARRIVAL date/time does not exist

← Older revision		Revision as of 18:14, 8 January 2018
Line 602:		Line 602:
	\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job		\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job
	\|-		\|-
	\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else ~~EPL_START_ACTUAL_DATE~~/~~EPL_START_ACTUAL_TIME~~, in XML date format		\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else EPL_END_ACTUAL_DATE/EPL_END_ACTUAL_TIME, in XML date format
	\|-		\|-
	\|LOC_TIMEZONE \|\|EPL_TIMEZONE		\|LOC_TIMEZONE \|\|EPL_TIMEZONE
Line 779:		Line 779:
	\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job		\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job
	\|-		\|-
	\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else ~~EPL_START_ACTUAL_DATE~~/~~EPL_START_ACTUAL_TIME~~, in XML date format		\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else EPL_END_ACTUAL_DATE/EPL_END_ACTUAL_TIME, in XML date format
	\|-		\|-
	\|LOC_TIMEZONE \|\|EPL_TIMEZONE		\|LOC_TIMEZONE \|\|EPL_TIMEZONE
Line 970:		Line 970:
	\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job		\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job
	\|-		\|-
	\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else ~~EPL_START_ACTUAL_DATE~~/~~EPL_START_ACTUAL_TIME~~, in XML date format		\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else EPL_END_ACTUAL_DATE/EPL_END_ACTUAL_TIME, in XML date format
	\|-		\|-
	\|LOC_TIMEZONE \|\|EPL_TIMEZONE		\|LOC_TIMEZONE \|\|EPL_TIMEZONE
Line 1,488:		Line 1,488:
	\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job		\|STOP_PLANNED_DEPARTURE_DATE \|\|EPL_END_PLANNED_DATE/EPL_END_PLANNED_TIME in XML date format. Only populated if there is an End Planned Date for the job
	\|-		\|-
	\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else ~~EPL_START_ACTUAL_DATE~~/~~EPL_START_ACTUAL_TIME~~, in XML date format		\|STOP_ACTUAL_ARRIVAL_DATE \|\|EPL_ARRIVAL_DATE/EPL_ARRIVAL_TIME if populated, else EPL_END_ACTUAL_DATE/EPL_END_ACTUAL_TIME, in XML date format
	\|-		\|-
	\|LOC_TIMEZONE \|\|EPL_TIMEZONE		\|LOC_TIMEZONE \|\|EPL_TIMEZONE

Anw: Added details of TTM_STOP_NUMBER

2018-01-08T16:09:25Z

Added details of TTM_STOP_NUMBER

← Older revision		Revision as of 18:09, 8 January 2018
Line 760:		Line 760:
	!Tag !!Notes		!Tag !!Notes
	\|-		\|-
	\|STOP_SEQUENCE \|\|~~Calculated from the~~ EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.		\|STOP_SEQUENCE \|\|EPL_TTM_STOP_NUMBER if configured, else EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.
	\|}		\|}

Line 951:		Line 951:
	!Tag !!Notes		!Tag !!Notes
	\|-		\|-
	\|STOP_SEQUENCE \|\|~~Calculated from the~~ EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.		\|STOP_SEQUENCE \|\|EPL_TTM_STOP_NUMBER if configured, else EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.
	\|}		\|}

Line 1,198:		Line 1,198:
	!Tag !!Notes		!Tag !!Notes
	\|-		\|-
	\|STOP_SEQUENCE \|\|~~Calculated from the~~ EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.		\|STOP_SEQUENCE \|\|EPL_TTM_STOP_NUMBER if configured, else EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.
	\|}		\|}

Line 1,469:		Line 1,469:
	!Tag !!Notes		!Tag !!Notes
	\|-		\|-
	\|STOP_SEQUENCE \|\|~~Calculated from the~~ EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.		\|STOP_SEQUENCE \|\|EPL_TTM_STOP_NUMBER if configured, else EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.
	\|}		\|}

Anw: Added details of TTM_STOP_NUMBER

2018-01-08T16:08:17Z

Added details of TTM_STOP_NUMBER

← Older revision		Revision as of 18:08, 8 January 2018
Line 583:		Line 583:
	!Tag !!Notes		!Tag !!Notes
	\|-		\|-
	\|STOP_SEQUENCE \|\|~~Calculated from the~~ EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.		\|STOP_SEQUENCE \|\|EPL_TTM_STOP_NUMBER if configured, else EPL_SEQUENCE if populated, otherwise a counter incremented for each job on the trip.
	\|}		\|}

Line 683:		Line 683:


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

	== ARR messages ==		== ARR messages ==
	ARR messages signify that the driver has arrived at the destination and is starting processing the job i.e. has been marked arrived on the mobile device.		ARR messages signify that the driver has arrived at the destination and is starting processing the job i.e. has been marked arrived on the mobile device.