Imports Details

From CTMS
Revision as of 14:34, 3 June 2024 by Anw (talk | contribs) (Added LOC_ZONES)

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


ACC_SERVICES

This import allows addition or modification of additional services in the system. If not present, this will also add a payment type ofr the service.

The following fields may be specified:

  • SERVICE_ID - required - if exists, this will modify the service, else add it.
  • SERVICE_NAME - required for adding
  • SERVICE_EVENT - required for adding - one of 'TRIP','ORDER','BOTH'
  • INITIATED_FROM_TASK
  • SIGNIFICANT_SERVICE


ACC_SRV_RTS

This import allows addition of additional service rates in the system.

The following fields may be specified:

  • SERVICE_ID - required - must exist as an additional service in the system.
  • DEBIT_ACC - required - the account may be set to ALL or must be a valid account within the system. the debit and credit accounts may not both be set to ALL. The account specified must be of type 'GROUP','CUSTOMER' when the specified service type if for an ORDER service event, or 'CENTRE' for a TRIP service event.
  • CREDIT_ACC - required - the account may be set to ALL or must be a valid account within the system. the debit and credit accounts may not both be set to ALL. The account specified must be of type 'GROUP','CUSTOMER' when the specified service type if for a TRIP service event, or 'CENTRE' for an ORDER service event.
  • EFFECTIVE_DATE - required - date format DD/MM/YY
  • CHARGE_TYPE - optional - if provided, 'FIXED','HOURS'. If not provided, will default to the charge type of the service specified.
  • AMOUNT - required.


CARRIER

This import may be used to create carriers in the system.

The following fields may be specified:

  • ACTION - required - one of 'A'dd (default), 'M'odify, 'D'elete. Note Note: If the carrier is in use (i.e. is used on trips, or referenced in system or user access control parameters), then the carrier may not be deleted.
  • CARRIER_ID - required - must not exist if adding, must existing if modifying or deleting
  • CARRIER_NAME
  • GROUP_NAME - optional - if provided, must exist as a carrier group in the system
  • COST_CENTRE_NAME - optional - if provided, must exist as a cost centre in the system
  • CARRIER_TYPE_ID - required when adding - if provided, must exist as a carrier type in the system
  • CURRENT_HAULAGE_UNIT
  • FIXED_COST_WEEKDAY
  • FIXED_COST_SAT
  • FIXED_COST_SUN
  • HUB_LOCATION - optional - if provided, must exist as a location in the system
  • ENFORCE_START_AT_HUB - 'Y','N'
  • ENFORCE_END_AT_HUB - 'Y','N'
  • BARCODE_TYPE
  • TMS_REF
  • HQ_LOCATION - optional - if provided, must exist as a location in the system
  • EXPORTFILE_TYPE
  • VAT_NUMBER
  • VAT_COUNTRY - optional - if provided, must exist as a country in the system
  • STD_SHIFT_HOURS
  • STD_FACTOR
  • ALTERNATE_CARRIER - 'Y','N'
  • OVERTIME_FACTOR
  • MAX_SHIFT_HOURS
  • TRIP_THRESHOLD_HOURS
  • MAX_DRIVING_HOURS
  • ADDRESS_LINE1
  • ADDRESS_LINE2
  • ADDRESS_LINE3
  • TOWN
  • COUNTY
  • COUNTRY_CODE - optional - if provided, must exist as a country in the system
  • POSTCODE
  • REGION
  • PHONE
  • FAX
  • DRIVER_BREAK_THRES
  • DRIVER_BREAK_MINS
  • WORK_BREAK_THRES
  • WORK_BREAK_MINS
  • DISPLAY_TYPE - required - one of 'POPLIST','FREETEXT'
  • CONTACT
  • PERMIT_DEBRIEF - 'Y','N'
  • WORK_STOPOVER_THRES
  • STOPOVER_MINS
  • DRIVE_STOPOVER_THRES
  • MULTIPLE_TARIFFS - 'Y','N'
  • INACTIVE - 'Y','N'
  • EXTERNAL_DRIVER - 'Y','N'
  • SMARTPHONE_ENABLED - one of 'SMARTPHONE','MICROLISE','TOMTOM'
  • EMAIL
  • LABEL_FORMAT - optional - if provided, must be a valid label format in the system.
  • MANIFEST_FORMAT - optional - if provided, must be a valid manifest format in the system.
  • PRINT_MANIFEST - 'Y','N'
  • VOLUMETRIC_FACTOR
  • AUTO_SCHEDULING - 'Y','N'
  • MAX_DU_PER_SHIP
  • PRINT_SHIPMENT_LABEL - 'Y','N'
  • PAYMENT_DEADLINE
  • MPG
  • EPOD_ENABLED - 'Y','N'
  • TRANSPORT_MODE - 'AIR','ROAD'
  • ALLOW_PALLETS - 'Y','N'
  • AWB_CONS_CAPTURE - 'Y','N'
  • THIRD_PARTY_LABEL - 'Y','N'
  • AUTO_DEBRIEF_COL - 'Y','N'
  • AUTO_DEBRIEF_DEL - 'Y','N'
  • SEND_TO_EPOD_COL - 'Y','N'
  • SEND_TO_EPOD_DEL - 'Y','N'
  • ALTERNATE_CARR_NAME
  • REPORTING_CARRIER
  • DEFAULT_RESOURCE - 'Y','N'
  • ENFORCE_START_AT_DEL - 'Y','N'


DEBRIEF

This import may be used to capture external debrief information. The process can add or update signature information. The process will set the quantity delivered against the items and set the order to POD confirmed. The delivery trip stop will be debrief with the arrival time. A reason of CD will be added to the order.

The following fields may be specified:

  • OMS_REF - optional - either EXTERNAL_REF or OMS_REF must be specified. This reference is used in preference to EXTERNAL_REF to find the order. The specified order must exist in the system. The order must be planned for delivery in the system.
  • EXTERNAL_REF - optional - either EXTERNAL_REF or OMS_REF must be specified.
  • SIGNATORY_DATE - required
  • SIGNATORY_TIME
  • SIGNATORY - required
  • SUBURB
  • POSTCODE
  • STATE
  • CONSIGNMENT_NOTE
  • CARRIER - required - must exist as a carrier in the system.


DECODE

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

The following fields may be specified:

  • 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.


DRIVER_SHIFT

This import can be used to define shift pattern assignment to drivers.

The following fields may be specified:

  • ACTION - required - one of 'A'dd (default), 'M'odify, 'D'elete
  • SHIFT_CODE - required - must exist as a shift pattern in the system.
  • DAYS_OF_WEEK - required - must indicate the days of week active in 'YN' format e.g. 'YYYYYNN', Monday to Sunday
  • DRIVER - required - must exist as a driver in the system.
  • CARRIER - required - must exist as a carrier in the system.
  • START_DATE - required - date format DDMMYYYY, must be within 3 years of the current date, must identify a Monday.


FIXED_ROUTE

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

The following record types may be specified:

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


The following fields may be specified per record type:

  • 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 mored - 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.


The following fields may be specified per record type:

  • 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.

The following fields may be used:

  • 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


LOC_ZONES

This import allows addition or modification of location zones in the system.

The following fields may be specified:

  • ZONE - required
  • CUSTOMER - optional - if provided, must exist as a customer in the system.
  • LOCATION_TYPE - required - one of 'COUNTRY', 'PLANNING_REGION', 'POSTAL_REGION', 'POSTAL_STRING', 'POSTCODE', 'LOCATION_ID', 'ZONE'
  • COUNTRY_CODE - required if LOCATION_TYPE is one of 'PLANNING_REGION', 'POSTAL_REGION', 'POSTAL_STRING', 'POSTCODE' - must be a valid country in the system.
  • FROM_RANGE - required - will be ignored if a record exists for the location type and from range specified. Must be valid data in the system matching the selection of location type.
  • TO_RANGE - required - Must be valid data in the system matching the selection of location type.
  • INCLUDE_EXCLUDE - required - one of 'I', 'E'
  • INACTIVE - optional - 'Y', 'N'
  • TOWN_SUBURB
  • ROUTING_CODE
  • COST_CENTRE_NAME - optional - if provided, must be a valid cost centre in the system.


Further configuration:

Parameter Description Level
ZONE_POSTCODE_CHECK Does Zone import check the postcode SYSTEM

PERSON

This import type allows adding, modifying or deleting drivers and driver attributes in the system.

The following record types may be used:

  • PERSON – Person details
  • CARRIER – Carrier assignment
  • VEHICLE – The vehicle types that person is qualified to drive.

The following fields may be specified per record type:

  • PERSON
    • REC_TYPE - one of the record types above
    • ACTION - required - one of 'A'dd (default), 'M'odify, 'D'elete
    • PERSON_ID - required. Must not exist as system data when adding, must exist when modifying or deleting.
    • FORENAME - required when adding.
    • SURNAME - required when adding.
    • JOB_TITLE - required when adding - if provided, must exist as a person type in the system.
    • LOCATION_ID - optional - if provided, must exist as a location in the system.
    • CONTACT_NO
    • INACTIVE - optional - 'N' (default),'Y'
    • AGENCY - optional - 'N' (default),'Y'
    • SMARTPHONE_ENABLED - optional - one of 'EPOD' (default),'SMARTPHONE','MICROLISE','TOMTOM'
    • EPOD_USERNAME
    • TOMTOM_ENABLED - optional - 'N' (default),'Y'
    • DOB - optional - must be a date
    • ADDRESS_1
    • ADDRESS_2
    • ADDRESS_3
    • ADDRESS_4
    • ADDRESS_5
    • START_DATE - optional - must be a date
  • CARRIER – optional

CARRIER_PERSON_ID - required - must exist (or have been created above) CARRIER_ID - required - must exist as a carrier in the system. CARRIER_INACTIVE - 'Y','N'

  • VEHICLE – optional

VEHICLE_PERSON_ID - required - must exist (or have been created above) VEHICLE_TYPE - required - must exist as a trailer type


SHIFT_PATT

This import can be used to define standard shift patterns per depot.

The following fields may be specified:

  • ACTION - required - one of 'A'dd (default), 'M'odify, 'D'elete
  • SHIFT_CODE - required - 20 characters or less - must not exist for adding, must exist for modifying or deleting.
  • DEPOT - required when not deleting - must exist as an RDC location in the system.
  • SHIFT_START - required - time format.
  • SHIFT_END - required - time format.
  • MON - required - 'Y','N'.
  • TUE - required - 'Y','N'.
  • WED - required - 'Y','N'.
  • THU - required - 'Y','N'.
  • FRI - required - 'Y','N'.
  • SAT - required - 'Y','N'.
  • SUN - required - 'Y','N'.


TRACTOR

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

The following record types may be specified:

  • TRACTOR - the main tractor information
  • TRACTOR_CARRIER - carriers to whom the tractor is available.

The following fields may be specified per record type:

  • TRACTOR - required
    • ACTION - optional - one of 'A'dd (default), 'M'odify, 'D'elete
    • TRACTOR_ID - required, 12 characters or less. Must not exist as system data when adding, must exist when deleting.
    • TRACTOR_TYPE
    • DESCRIPTION
    • INACTIVE - optional - one of 'Y', 'N'
    • TRACKING_ENABLED - one of 'ISOTRAK', 'TOMTOM', 'MICROLISE'
    • TRACK_REF
    • MPG
    • CONTACT_NO
    • CARRIER_ID - optional - if provided, must exist as a carrier in the system. Mainly superseded by TRACTOR_CARRIER record type.
  • TRACTOR_CARRIER - optional
    • ACTION - optional - one of 'A'dd (default), 'D'elete
    • TRACTOR_ID - required, 12 characters or less. Must not exist as system data when adding, must exist when deleting.
    • CARRIER_ID - required - if provided, must exist as a carrier in the system. Mainly superseded by TRACTOR_CARRIER record type.


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


VEHICLE

This import type allows adding, modifying or deleting fixed vehicles (e.g. vans) in the system, as opposed to spearate tractor and trailer records. These fixed vehicles are then linked.

The following record types may be specified:

  • VEHICLE
  • VEHICLE_CARRIER

The following fields may be specified per record type:

  • VEHICLE
    • ACTION - required - one of 'A'dd (default), 'M'odify, 'D'elete
    • REG_NO - Required, 12 characters or less
    • FLEET_ID
    • VEHICLE_TYPE - required if adding - if provided, must exist as a trailer type.
    • VIN_NO
    • TOMTOM_ENABLED - 'Y','N'
    • TOMTOM_REF
    • EPOD_ENABLED - 'Y','N'
    • TAIL_LIFT - 'Y','N'
    • BLUE_LIGHT - 'Y','N'
    • VOR - Vehicle Off Road (Inactive) - 'Y','N'
    • NARRATIVE
  • VEHICLE_CARRIER - optional
    • REG_NO - required - must exist as a vehicle added above
    • CARRIER_ID - required - must exist as a carrier in the system.
    • CARRIER_INACTIVE - 'Y','N'
Retrieved from ‘https://calidusassist.adcservices.apteancloud.com/calidus-assist/MTS/index.php?title=Imports_Details&oldid=7244’