Integration Locations - fields

  • Integration Location ID: The unique identifier of the integration location. Not editable in update mode.
  • Location Name: The name of the integration location based on the Location Type. Not editable in update mode if the integration location is system provided. It specifies:
    • The path of the integration location if the Location Type is Directory or System Location. For example, <TM_INSTALL>/RunTime/IntgLoc, where <TM_INSTALL> is the directory in which Transportation Manager is installed. Relative path notation can also be used for paths defined under <TM_INSTALL>. For example, ./Runime/IntgLoc.
    • The name of the staging table if the Location Type is Table.
  • Format: The format of the files used for staging and handling of various requests in the integration location. Not editable in update mode if the integration location is system provided. The following formats are supported:
    • CIS API XML
    • Database table
    • Excel file as XML
    • Flat File
  • Description: The description of the specific integration location. Editable in update mode.
  • Type: The type of the integration location: Directory or Table. Directory is the default value. Not editable in update mode if the integration location is system provided.
  • Division: The division for the integration location. In create mode, the value defaults to a user specific division if the user is restricted. It is optional for users that are not restricted to a specific division. Not editable in update mode if the integration location is system provided.
  • Input File Extension: The extension of the input files that are to be processed from the integration location. Required if the integration location type is Directory. This field must be blank if the integration location type is Table. Not editable in update mode if the integration location is system provided.
  • Processing File Extension: The extension of the processed files. By default, prc is auto populated in this field when the integration location type is Directory. This field must be blank if the integration location is of type, Table. Not editable in update mode if the integration location is system provided.
  • Completed File Extension: The extension of the completed files. By default, cmp is auto populated in this field when the integration location type is Directory. This field must be blank if the integration location is of type, Table. Not editable in update mode if the integration location is system provided.
  • Results File Extension: The extension of the results file. By default, rslt is auto populated in this field when the integration location type is Directory. This field must be blank if the integration location is of type, Table. Editable in update mode.
  • Failed File Extension: The extension of the failed file. By default, fail is auto populated in this field when the integration location type is Directory. This field must be blank if the integration location is of type, Table. Not editable in update mode if the integration location is system provided.
  • Results: The type of results that are published back to the integration location for individual integration requests. Editable in update mode. The following types are supported:
    • All records written: The results file is a copy of the original input file with each record marked as succeeded or failed.
    • No records written: No results file is written.
    • Only errors written: The results only contain the failed records from the original input file.

      • Note: This field is applicable only for the integration location type, Directory.

  • Mapping Code: The mapping code. Required only for integration location of type, Table. Not editable in update mode if the integration location is system provided.
  • System Provided: Indicates whether the integration location is system provided.

    • Note: If system provided, the integration location cannot be deleted or duplicated.

See Also

List of Integration Locations (Employee)