Imports Details

From CTMS
Revision as of 11:09, 3 June 2024 by Anw (talk | contribs) (Initial Creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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


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=7228’