Global Settings - List of External Mappings (Employee)
This page allows you to configure integration specific information for any system entity. The mappings can be utilized when processing both incoming and outgoing information. The mapping can define a fixed value for mapping, or specify a field from the entity that should be used.
If the mapping defines a fixed value, it is a string that is utilized in the integration. The string could represent a number or date. If the mapping defines an entity column, it indicates that the integration value will read from the field (column) on the entity.
For more information, see External Mapping fields, INTTRA External Mappings, TransVoyant External Mappings, project44 settings and External Mappings, and Pallet Rounding Rules using External Mappings.
Examples of a fixed value mapping:
|
External Source |
Entity Type |
Entity ID |
Field Name |
Fixed Value |
|---|---|---|---|---|
|
INTTRA |
Shipping Location |
HONG_KONG |
UNLOCODE |
HKHKG |
Meaning: When integrating with INTTRA, where the UN/LOCODE of the TM Shipping Location with ID "HONG_KONG" is needed, the value "HKHKG" should be used. This also indicates then when integrating with INTTRA, if the UN/LOCODE "HKHKG" is provided by INTTRA, then it corresponds to the TM Shipping Location with ID "HONG_KONG".
External Mapping supports an External Source of “Default”. A mapping with an External Source of “Default” applies to all integrations.
|
External Source |
Entity Type |
Entity ID |
Field Name |
Fixed Value |
|---|---|---|---|---|
|
Default |
Shipping Location |
HONG_KONG |
UNLOCODE |
HKHKG |
Meaning: For example, the UN/LOCODE of the shipping location HONG_KONG is always “HKHKG”, as the UN/LOCODE is an international standard. Rather than defining a mapping for INTTRA and defining the same mapping for TransVoyant, a single mapping can be defined.
Example of a fixed value mapping for a Global Default:
When a fixed value mapping is defined, it will usually have an Entity ID specified, as the fixed value applies to a specific entity. The exception is when defining a mapping with an Entity Type of “Global Defaults”. These system level mappings apply generally and are not entity specific.
|
External Source |
Entity Type |
Entity ID |
Field Name |
Fixed Value |
|---|---|---|---|---|
|
INTTRA |
Global Defaults |
|
InformationContact |
Jane Smith |
Meaning: When integrating with INTTRA, when the InformationContact is needed, the value "Jane Smith" should be used.
Example of a fixed value mapping for a domain value:
A Supplemental Entity ID is supported in the case of domain table mappings. For domain table mappings, the Entity ID specifies a specific domain table and the Supplemental Entity ID specifies a domain value from that table.
|
External Source |
Entity Type |
Entity ID |
Supplemental Entity ID |
Field Name |
Fixed Value |
|---|---|---|---|---|---|
|
INTTRA |
Domain Table |
Transit Mode |
MARINE |
TransportMode |
MaritimeTransport |
Meaning: When integrating with INTTRA, when the TransportMode of a booking using an itinerary with a transit mode of MARINE is needed, the value “MaritimeTransport” should be used.
Example of an entity column mapping:
When an entity column mapping is defined, the Entity ID will not be specified. An entity column mapping applies to all entities of that type.
If the mapping defines an entity column, it indicates that the integration value will read from the field (column) on the entity.
|
External Source |
Entity Type |
Entity ID |
Field Name |
Entity Column |
|---|---|---|---|---|
|
INTTRA |
Carrier |
|
INTTRACompanyID |
EXTL_CD1 |
Meaning: When integrating with INTTRA, where the INTTRACompanyID of a Carrier (any Carrier) is needed, use the value of the field EXTL_CD1 from the Carrier.
Lookup hierarchy
A lookup hierarchy supports mappings specified at multiple levels with a defined override behavior. The lookup order is:
- Fixed value mappings for a specific external source
- Entity column mappings for a specific external source
- Fixed value mappings for the default external source
- Entity column mappings for the default external source
For example, an entity column mapping of “EXTL_CD1” for shipping locations is less exact than a fixed value mapping of the shipping location “HONG_KONG”. When looking up the external mapping for the UN/LOCODE for Shipping Location “HONG_KONG”, the fixed value mapping would be used instead of looking at the EXTL_CD1 column.
See Also