Imports Details

From CTMS
Revision as of 12:36, 3 June 2024 by Anw (talk | contribs) (Added DECODE and FIXED_ROUTE)

The following is a summary of the usage of some imports configurable in the system.


DECODE

This import type allows you to import decodes for imports and exports processing.

  • DECODE_NAME - required - must exist as a decode table already set up in the system.
  • SOURCE_VALUE - required. Will not be updated if the decode name and source already exists on the system.
  • TARGET_VALUE - required.
    • If DECODE_NAME is LOCATION, then the target value must be a location set up on the system.
    • If DECODE_NAME is CUSTOMER, then the target value must be a customer set up on the system.
    • If DECODE_NAME is CIST_CENTRE, then the target value must be a cost centre set up on the system.
  • CUSTOMER_ID - optional - if provided, then this must be a customer set up on the system.


FIXED_ROUTE

This import type allows you to import fixed route headers and details into the system.

Record types:

  • ROUTE - the route header, the main import type.
  • STOP - the stops on the route header
  • TRANSPORT_MODE - optional - transport modes for the route.


  • ROUTE
    • ACTION - only blank or D (default) values are allowed for this import. To delete a route, you must have administrative access to delete routes.
    • REC_TYPE - required - one of the record types above.
    • ROUTE_CODE - required. If no action has been specified, if the route exists, then the route will be modified. If the route does not exist, it will be added.
    • ROUTE_NAME - required
    • DEPOT - required - must exist as an active RDC location in the system. If the depot is inactive, and you have administrative access to activate locations, then the depot can be activated automatically.
    • MAX_TRIPS
    • ENGINE
    • PRIORITY - must be a positive number i.e. greater than 0
    • CARRIER_ID - required - must exist in the system.
    • TRAILER_TYPE - required - must exist in the system.
    • INACTIVE - optional - if provided must be 'Y', 'N'
    • RTE_DAYS - required - may be provided as a string on 'YN' or '10', where Y or 1 denote an active day.
    • START_TIME - optional - if provided, must be a time.
    • CUT_OFF_TIME - optional - if provided, must be a time.
    • OVERRIDE_HUB_TIME - optional - must be Y', 'N'
    • CALC_TIME_DISTANCE - optional - must be Y', 'N'
    • ROUTE_COST - optional - must be a positive number.
    • MAX_TRIPS_PER_DAY - optional
    • SEND_TO_PARAGON - optional - must be Y', 'N'
    • ROUTE_TYPE
    • ROUTE_END
    • SCHED_ENG_ROUTE - optional - must be Y', 'N'
    • PAR_RUN - optional - Inserts or updates the run number for Paragon for the route. Uses decodes "PAR_RUN"
    • TRANSPORT_MODES - optional - delimited transport mode - superseded by record type TRANSPORT_MODE below
  • STOP - optional section
    • ID - optional - if not provided of a stop of that ID does not exist, a new stop will be created, otherwise the stop will be updated.
    • SEQ - required - must be greater than 0 and must not already exist on the route.
    • STOP_TYPE - required - must be one of 'L', 'R', 'Z', 'C'
    • LOCATION_ID - required if stop type is 'L', 'C' - must exist as an active location in the system. If the location is inactive, and you have administrative access to activate locations, then the depot can be activated automatically
    • REGION - required is stop type is 'R', 'C', 'Z'
    • MANDATORY - required - must be one of 'Y', 'N'
    • TARGET_TIME - required
    • MAX_EARLY_MINS - required
    • MAX_LATE_MINS - required
    • COLLECTION - optional - must be one of 'M', 'O'. Either COLLECTION or DELIVERY must be populated.
    • DELIVERY - optional - must be one of 'M', 'O'. Either COLLECTION or DELIVERY must be populated.
    • STOP_PRIORITY - must be a positive number i.e. greater than 0. Required for an optional stop.
    • CROSSDOCK - optional - must be one of 'Y', 'N'
    • FIXED - optional - must be one of 'Y', 'N'
    • FILL_FACTOR - optional - must be between 0 and 1
    • STOP_CUT_OFF_TIME - optional - must be a time
    • STOP_CUT_OFF_TIME_DL - optional - must be a time
  • TRANSPORT_MODE - optional section
    • TRANSPORT_MODE_TYPE - required - must exist as a transport mode in the system.
    • INC_EXC - optional - must be one of 'I', 'E'


Further Configuration

Access Control Group Description Level
GEO_ACTIVATE_LOCATION Ability to update an Inactive Location to Active. Functions
RTE_DELETE_ROUTE Ability to Delete Routes Functions


LOCATION

This import type allows adding locations and location-based data.

There are multiple record types:

  • LOCATION - the main import of the location. Required.
  • CONSTRAINT - any location constraints. Optional.
  • CONTACT - location contacts. Optional.
  • REFERENCES - location references. Optional.
  • TRAILER_TYPE - trailer types allowed or excluded at this location. Optional. If not provided, all location types are allowed.


  • LOCATION
    • REC_TYPE - required
    • LOCATION_ID - required - must not exist in the system.
    • LOCATION_TYPE - required - must exist in the system.
    • LOCATION_NAME - required - configurable as to whether this must not exist in the system via system parameters
    • PARENT_LOC_ID - optional - is supplied, must exist as a location in the system.
    • ADDRESS_LINE1
    • ADDRESS_LINE2
    • ADDRESS_LINE3
    • TOWN
    • COUNTY
    • COUNTRY_CODE - Required - must exist as a country code in the system.
    • POSTCODE
    • POSTAL_REGION - optional - the system can be configured to calculate this for you from the country code and postcode.
    • PLANNING_REGION - optional - the system can be configured to calculate this for you from the country code and postcode.
    • LATITUDE
    • LONGITUDE
    • LOADING_RATE - required - if provided, this must exist in the system data. Loading rate can be pre-populated from a default rate.
    • UNLOADING_RATE - required - if provided, this must exist in the system data. Loading rate can be pre-populated from a default rate.
    • PHONE
    • FAX
    • LINK_ID - optional. Used for C-ePOD consolidation.
    • TIMEZONE_NAME - optional - if provided, this must exist in the system data.
    • CUST_CLIENT_CODE - optional.
    • ALTERNATIVE_CODE - optional - must be 12 characters or less.
    • USAGE - creates the location usage as per the system parameter. If provided, the provided value must exist as system data on the table that the system is set up to generate location usage records, usually CUSTOMER or CUST_GROUP.
    • CONTACT_SURNAME - optional - if provided, creates a single contact against the location. Can be superseded with CONTACTS sections.
    • CONTACT_FORENAME - optional - if provided, creates a single contact against the location. Can be superseded with CONTACTS sections.
    • CONTACT_PHONE - optional - if provided, creates a single contact against the location. Can be superseded with CONTACTS sections.
    • CONTACT_EMAIL - optional - if provided, creates a single contact against the location. Can be superseded with CONTACTS sections.
    • CONTACT_JOB_TITLE - optional - if provided, creates a single contact against the location. Can be superseded with CONTACTS sections.
    • CONTACT_TITLE - optional - if provided, creates a single contact against the location. Can be superseded with CONTACTS sections.
  • CONSTRAINT - optional section
    • CONS_LOCATION_ID - required - must be the location ID and must exist in the system data (or reference the location just created in this import).
    • CONSTRAINT_TYPE - required - must exist in the system
    • DAY - required - must be one of '1', '2', '3', '4', '5', '6', '7', indicating the day of the week. only 1 constraint type may exist per day specified.
    • START_TIME - required - must be a valid time
    • END_TIME - required - must be a valid time
    • VALUE - required
  • CONTACT - optional section
    • CONTACT_LOCATION_ID - required - must be the location ID and must exist in the system data (or reference the location just created in this import).
    • SURNAME - required
    • FORENAME - required
    • JOB_TITLE
    • TITLE
    • PHONE
    • EMAIL
  • REFERENCES - optional section
    • REF_LOCATION_ID - required - must be the location ID and must exist in the system data (or reference the location just created in this import).
    • REFERENCE_NAME - required. Must be a valid location reference in the system, specified in import decodes, type "LOC_REF_NAMES". The location ID and reference name must not exist.
    • REFERENCE_VALUE - required - must be 200 characters or less.
  • TRAILER_TYPE - optional section
    • TRAILER_LOCATION_ID - required - must be the location ID and must exist in the system data (or reference the location just created in this import).
    • TRAILER_TYPE - required - must exist in the system data.
    • FILL_FACTOR - required - value supplied must be between 0 and 1.
    • INC_EXC - optional - if provided, must be values 'I' (default), 'E'. The values of TRAILER_LOCATION_ID, TRAILER_TYPE and INC_EXC must not already exist in the system.


The location will be added to the location usage following the system logic enabled by system parameters.


Further configuration:

Parameter Description Level
GEO_VALIDATE_LOCATION_NAME Indicates whether the system should check for duplicate location names (as well as IDs) when creating/updating locations SYSTEM
GEO_LOC_IMP_POST_PLAN Populate the postal and planning regions using rules in country and static data when doing location import SYSTEM
GEO_POP_PLANNING_REGION Controls whether the Planning Region is populated from the look up table - Y or N. SYSTEM
GEO_DEFAULT_LOAD_RATE Default Loading Rate for locations. SYSTEM
GEO_DEFAULT_UNLOAD_RATE Default Unloading Rate for locations. SYSTEM
MTS_LOCATION_USAGE Controls how Locations are grouped, either via CUST_GROUP, CUSTOMER, used in Customer form to display correct tab SYSTEM


LOC_UPDATE

This import allows you to update basic information of locations already in the system.


  • LOCATION_ID - optional. If not provided, the location ID will be derived from the name.
  • LOCATION_NAME - required
  • PARENT_LOC_ID - optional - if provided, must exist in the system.
  • LOCATION_TYPE - required - must exist in the system
  • ADDRESS_LINE1 - optional - if provided will be updated.
  • ADDRESS_LINE2 - optional - if provided will be updated.
  • ADDRESS_LINE3 - optional - if provided will be updated.
  • TOWN - optional - if provided will be updated.
  • COUNTY - optional - if provided will be updated.
  • COUNTRY_CODE - required - must exist in the system.
  • POSTCODE - optional - if provided will be updated.
  • MASTER_LOCATION - optional - if provided must be 'Y', 'N'.
  • EXT_LOCATION_NAME - optional - if provided will be updated.

Note Note: Planning region will be updated by system configuration


TRAILER

This import type allows adding, modifying or deleting trailers in the system.

The following fields may be specified.

  • ACTION - 'A'dd, 'M'odify and 'D'elete
  • TRAILER_ID - required. Must not exist for adding, must exist for other actions
  • TRAILER_TYPE - must exist in the system Resource data.
  • INACTIVE - one of 'N' (default), 'Y'
  • TRACKING_ENABLED - one of 'ISOTRAK', 'TOMTOM', 'MICROLISE'
  • COST_CENTRE_NAME
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/index.php?title=Imports_Details&oldid=7233’