Anw: Initial Creation

2026-03-06T09:20:29Z

Initial Creation

New page

There are inbound and outbound processes that may be used – both must be created through the EDI Maintenance screen.

=== Inbound - API ===
<center>
[[File:EDI-Inbound API.png]]
</center>
{| class="wikitable"
!'''Field'''
!'''Description'''
!'''Value'''
|-
|''Process Name''
|This should indicate the nature of the job so it may be identified in the screen. Required.
|API
|-
|''Filename Format''
|This indicates how any files created or required by the process are names, for outbound files, the system will add the system date and time to ensure a unique filename is always generated. Required.
|''*.*''
|-
|''Customer''
|Enter the Customer required using the Drop Down List. Optional.
|N/A
|-
|''Cost Centre Code''
|The cost centre code may be used when the process is checking parameter values and may be matched to orders or trips to identify if the process should be running. Required.
|N/A
|-
|''Direction''
|The direction is defined as outbound or inbound. This will indicate if the process in bringing data into C-TMS or sending data out of C-TMS. Required.
|Inbound
|-
|''Flow Type''
|This indicates the type of process, there are several different options discussed later. Required.
|''ORD_XML''
|-
|''Frequency Type''
|Frequency type indicates how often the process is run, are regular interval or specific time. Required.
|''Regular Interval''
|-
|''Process Time''
|Only available if selecting ''Frequency Type'' of ''Specific Time''. The time at which the process is to run.
|N/A
|-
|''(Day Selection)''
|Only available if selecting ''Frequency Type'' of ''Specific Time''. Check ''All Days'', or check the days on which you want the process to run.
|N/A
|-
|''Interval Length''
|Only available if selecting ''Frequency Type'' of ''Regular Interval''. Interval length indicates the regular interval. Enter the number , and then the unit (''Seconds, Minutes, Hours, Days, Monthly''). Required.
|1 Days
|-
|''Send DEL Message''
|If this box is checked then this can create an ARR message when the actual arrive times are fully entered
|Unchecked
|-
|''Send ARR Message''
|If this box is checked then this can create a DEL message when the order to deliver quantities are fully entered
|Unchecked
|-
|''Delivery Folder''
|When the file has been created this is the directory that the file will sit in until it has been picked up
|N/A
|-
|''Archive Folder''
|When the file has been picked up by the relevant source successfully the file gets moved to this directory
|N/A
|-
|''Failures folder''
|The directory of any files that failed to upload
|N/A
|-
|''Acknowledgment Folder''
|The directory for an acknowledgment message to sent to
|N/A
|-
|''Send ACK?''
|The box is checked if the Acknowledgment of an inbound flow is requested. The Acknowledgment will then been sent to folder to be picked up by the relevant source
|Unchecked
|}

Parameters must then be entered for the process through the '''Params''' button:
{| class="wikitable"
!Parameter Name
!Description
!Values
|-
|ALLOW_INVALID_ORDER
|
|
|-
|AMEND_SCHEDULED
|
|
|-
|API_CARRIER_PACKED
|
|
|-
|AUDIT_STATUS
|
|
|-
|AUDIT_WS
|
|
|-
|AUTO_GENERATE_LINES
|
|
|-
|CREATE_UNKNOWN_CUST
|
|
|-
|CREATE_UNKNOWN_LOCS
|
|
|-
|CREATE_UNKNOWN_ORDER
|
|
|-
|CUST_CURRENCY
|
|
|-
|CUST_EPOD_ENABLED
|
|
|-
|CUST_GROUP_CUSTOMER
|
|
|-
|CUST_LOTS_ID
|
|
|-
|CUST_LOTS_SEND_ORD
|
|
|-
|CUST_REV_CHARGE_TYPE
|
|
|-
|CUST_TYPE
|
|
|-
|DEFAULT_COLLECTION
|
|
|-
|DEFAULT_COST_CENTRE
|
|
|-
|DELETE_LINES
|
|
|-
|DFLT_CUST_CURRENCY
|
|
|-
|LOCATION_EXT_REF
|
|
|-
|LOC_DEPOT
|
|
|-
|LOC_FLEXIPOD
|
|
|-
|LOC_LOADING_RATE
|
|
|-
|LOC_UNLOADING_RATE
|
|
|-
|MAIN_ADDRESS_TYPE
|
|
|-
|MATCH_FULL_LOC
|
|
|-
|MOD_ORD_ACTION_VALUE
|
|
|-
|NO_UPDATE_DEPOT_ADDR
|
|
|-
|ORDER_VEHICLE
|
|
|-
|ORD_ADD_REFS
|
|
|-
|ORD_INVOICED
|
|
|-
|PARAGON_API
|
|
|-
|ROUTE_DELIVERY
|
|
|-
|RUN_NUMBER_VALID
|
|
|-
|UNSCHED_NEW_DATA
|
|
|-
|UPDATE_CANCELLED
|
|
|-
|UPDATE_EXISTING_LOCS
|
|
|-
|UPDATE_PARAGON_ID
|
|
|-
|USE_RUN_DEPOT
|
|
|-
|USE_VARIANT_ADDRESS
|
|
|}

=== Outbound – API_EVENTS ===
<center>[[File:EDI-Outbound-API EVENTS.png]]</center>
{| class="wikitable"
!'''Field'''
!'''Description'''
!'''Value'''
|-
|''Process Name''
|This should indicate the nature of the job so it may be identified in the screen. Required.
|API_EVENTS
|-
|''Filename Format''
|This indicates how any files created or required by the process are names, for outbound files, the system will add the system date and time to ensure a unique filename is always generated. Required.
|''*.XML''
|-
|''Customer''
|Enter the Customer required using the Drop Down List. Optional.
|N/A
|-
|''Cost Centre Code''
|The cost centre code may be used when the process is checking parameter values and may be matched to orders or trips to identify if the process should be running. Required.
|N/A
|-
|''Direction''
|The direction is defined as outbound or inbound. This will indicate if the process in bringing data into C-TMS or sending data out of C-TMS. Required.
|Outbound
|-
|''Flow Type''
|This indicates the type of process, there are several different options discussed later. Required.
|''PROCESS''
|-
|''Frequency Type''
|Frequency type indicates how often the process is run, are regular interval or specific time. Required.
|Regular Interval
|-
|''Process Time''
|Only available if selecting ''Frequency Type'' of ''Specific Time''. The time at which the process is to run.
|N/A
|-
|''(Day Selection)''
|Only available if selecting ''Frequency Type'' of ''Specific Time''. Check ''All Days'', or check the days on which you want the process to run.
|N/A
|-
|''Interval Length''
|Only available if selecting ''Frequency Type'' of ''Regular Interval''. Interval length indicates the regular interval. Enter the number , and then the unit (''Seconds, Minutes, Hours, Days, Monthly''). Required.
|1 Minutes
|-
|''Send DEL Message''
|If this box is checked then this can create an ARR message when the actual arrive times are fully entered
|Unchecked
|-
|''Send ARR Message''
|If this box is checked then this can create a DEL message when the order to deliver quantities are fully entered
|Unchecked
|-
|''Delivery Folder''
|When the file has been created this is the directory that the file will sit in until it has been picked up
|N/A
|-
|''Archive Folder''
|When the file has been picked up by the relevant source successfully the file gets moved to this directory
|N/A
|-
|''Failures folder''
|The directory of any files that failed to upload
|N/A
|-
|''Acknowledgment Folder''
|The directory for an acknowledgment message to sent to
|N/A
|-
|''Send ACK?''
|The box is checked if the Acknowledgment of an inbound flow is requested. The Acknowledgment will then been sent to folder to be picked up by the relevant source
|Unchecked
|}

Report Values must then be entered for the process through the '''Params''' button:

{| class="wikitable"
!'''Title'''
!'''Name'''
!'''Value'''
|-
|Package
|PROCESS
|DP_EXPORT_EVENTS.PROCESS_XML_OUTBOUND_API
|-
|Process
|p_process_name
|API_EVENTS
|}

Parameters must also be entered:
{| class="wikitable"
!'''Parameter Name'''
!'''Description'''
!'''Values'''
|-
|API_ARR
|
|
|-
|API_CAN
|
|
|-
|API_COL
|
|
|-
|API_DEL
|
|
|-
|API_DEP
|
|
|-
|API_INC_CANCELLED
|
|
|-
|API_ORD
|
|
|-
|API_TRP
|
|
|-
|API_USE_WS_ELUCID
|
|
|-
|AUDIT_METHOD
|
|
|-
|AUDIT_STATUS
|
|
|-
|DEL_ALL_ACT_QTY
|
|
|-
|EXPORT_SERVICES
|
|
|-
|EXPORT_TYRE
|
|
|-
|INCLUDE_CDATA_TAG
|
|
|-
|INCLUDE_ORDER_STATUS
|
|
|-
|INC_ORD_ITEM_EVENTS
|
|
|-
|PRINT_ROUTE_CODE
|
|
|-
|SEND_AND_FORGET
|
|
|}

EDI Trip Order XML Webservices Configuration - Revision history

Anw: Initial Creation