CALIDUS Portal TTM Interface: Difference between revisions

From Calidus HUB
m (Categorisation)
m (Minor correction)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
The setup of the interface has been documented for customers here: [[ctms:CALIDUS PORTAL TTM Interface]] and is included below by reference.


The setup of the interface has been documented for customers here: [[ctms:CALIDUS Portal TTM Interface]].
This provides a more technical guide


__TOC__


= Portal TTM Interface Functional Guide =
{{:ctms:CALIDUS PORTAL TTM Interface}}
= Technical Information =


The Job must be enabled
The Job must be enabled

Latest revision as of 10:57, 9 May 2025

The setup of the interface has been documented for customers here: ctms:CALIDUS PORTAL TTM Interface and is included below by reference.

This provides a more technical guide

Portal TTM Interface Functional Guide

Customer - must have LOTS Enabled set to TTM Customer, plus tick boxes for at least the ORD message.

System Parameters must be configured

PARAM_NAME DESCRIPTION CONFIG_BY
LOTS_ADD_DEBRIEF LOTS Additional Debrief Details COST_CENTRE
LOTS_ALWAYS_SEND_HDR_CONTACTS Always send header contacts to LOTS in addition to order contacts COST_CENTRE
LOTS_DEL_CUST_SIGNATORY Controls if DEL messages for LOTS require an actual signatory - Y to hold messages. COST_CENTRE
LOTS_DEL_MSG_TRIP_STATUS_COMPLETE Send LOTS DEL Message if trip status set to COMPLETE (Y/N) COST_CENTRE
LOTS_EXPORT_TYRE LOTS export tyre COST_CENTRE
*LOTS_FTP_DESTINATION_DIRECTORY Final Destination directory for FTP of LOTS Files SYSTEM
*LOTS_FTP_DESTINATION_IP_ADDRESS IP for FTP of LOTS Files SYSTEM
*LOTS_FTP_DESTINATION_PASSWORD Password for FTP of LOTS Files SYSTEM
*LOTS_FTP_DESTINATION_PORT Port for FTP of LOTS Files SYSTEM
*LOTS_FTP_DESTINATION_USERNAME Username for FTP of LOTS Files SYSTEM
LOTS_FTP_PUT_DIRECTORY Mid-Send directory for FTP of LOTS Files SYSTEM
LOTS_INBOUND_ARCH LOTS inbound failures directory SYSTEM
LOTS_INBOUND_FAIL Pattern for LOTS Trip Inbound XML SYSTEM
LOTS_INBOUND_IDENTIFIER Filename for list of files in directory for LOTS XML OB1 Inbound SYSTEM
LOTS_INBOUND_LISTING_NAME LOTS inbound directory SYSTEM
LOTS_INBOUND_PATH Script name foe LOTS XML OB1 Inbound SYSTEM
LOTS_INC_ORDER_HEADER_CONFIRM Includes the ORDER_HEADER_CONFIRM section in the DEL file for LOTS. SYSTEM
LOTS_INC_STOP_SIGNATURE Indicates if the STOP_SIGNATURE section will be displayed in the DEL outbound files to LOTS. SYSTEM
LOTS_INC_STOP_TYPE_DESC Include STOP-TYPE_DESC tag in XML SYSTEM
LOTS_LISTING_SCRIPT_NAME LOTS outbound archive directory SYSTEM
*LOTS_OUTBOUND_ARCH LOTS inbound failures directory SYSTEM
*LOTS_OUTBOUND_FAIL LOTS outbound directory SYSTEM
*LOTS_OUTBOUND_PATH Maximum number of days a location can remain inactive before being set to inactive automatically. SYSTEM
LOTS_PREVENT_MULTI_VLI_VUI Prevent multiple VLI and VUI files being sent to LOTS (Y/N). SYSTEM
LOTS_SEND_PLANNED Allow TRP update message to be sent to LOTS when trip is still at status Planned SYSTEM
LOTS_SEND_WHEN_VEHICLE_SCANNED List of LOTS message types that will be held until a vehicle scan is received for the order. COST_CENTRE
LOTS_VERSION_NUMBER LOTS Poller Version SYSTEM
*LOTS_XFER_EXTENSION Sets the LOTS transfer file extension COST_CENTRE
ORD_XDOCK_LOTS_DEL_MSG Lots DEL msg is only sent on last trip for xdock orders (Y/N) SYSTEM
PAR_USE_SLOTS Use slots when exporting to Paragon (DUN format) SYSTEM
*SEND_LINE_ITEM_TO_LOTS Send Line Item To LOTS (Y/N) SYSTEM
SET_MICROLISE_SLOTS Determines if the delivery slot times are sent to Microlise instead of the planned delivery times. SYSTEM

Any issues should be forwarded to your Aptean support team.

Technical Information

The Job must be enabled

Select * from DBA_JOBS
where UPPER(what) like '%LOTS%'
	BEGIN
	INT_XML_OUT2.PROCESS_XML_OUTBOUND_LOTS_ORD;

	INT_XML_OUT2.PROCESS_XML_OUTBOUND_LOTS;
	END;


Possible issues

-- Jobs not running? Check the following:
select logins from v$instance; -- if not allowed, won't run jobs
select value from dba_scheduler_global_attribute where attribute_name='SCHEDULER_DISABLED' -- if TRUE won't run jobs
select value from v$parameter where name='job_queue_processes'; -- if 0 won't run jobs (most common
alter system set job_queue_processes=20; -- Fix to above issue

Messages are written to INT_XML_CONTROL, type LOTS, processed "N" or "P".

Any issues with FTP to the box will be logged to ADM_LOG

select * from adm_log
where prog_name like '%INT_XML%'
and err_type = 'ERROR'
-- ORI_USER = 'MTS_OWNER'
order by stmt desc