Developer Interface Field Mapping

StarShip allows you to customize the way data is translated between Developer Interface documents and the StarShip shipment. Using the field mapping feature, you can control how the data in the source document is translated to StarShip, allowing you to define what information populates the shipment fields, and how the data is interpreted into accepted shipment values, when necessary.

How to Access Field Mapping

1. To access field mapping, go to Setup > Source Interfaces > Developer Interface, and click the Interfaces heading.
2. Select the Customize Interface button for the document.
   
3. Then, click the Select Mappings heading.

Overview

Fields from the Developer Interface may be mapped by default as part of the basic interface you were given. If you want more control over how data is translated from Developer Interface into StarShip shipment fields, you can add fields or customize field mapping to suit your company’s needs. For any information that you want imported with the source document, you can map those fields to StarShip shipment fields and when applicable, set up value translations.

If you want to import a field that doesn’t have a corresponding field in StarShip, you can use StarShip User Definable fields and map your Developer Interface field to one of them. Mapping User Definable fields to Developer Interface fields allows you to bring in values that may not normally be imported with the Shipment.

You can map any field in StarShip, but let’s look at a few common examples.

Ship Via

Ship Via is an example of a field that can be mapped by default, but which requires you to set up value translations for the most accurate results. Although the field is mapped, you now need to define what the Developer Interface Ship Via methods mean in StarShip terms. For example, the Developer Interface Ship Via field value “AM” can be set up to translate to “FedEx 2Day® A.M.” when the Shipment is imported into StarShip. When the source document Ship Via is “AM”, the Carrier/Service fields on the Ship screen will automatically populate with “FedEx 2Day® A.M.”.

Expand Shipment > Carrier Information > Carrier – Service.

For each of the Developer Interface Ship Via values In the Value Translations list, select the corresponding StarShip Carrier – Service value from the drop-down list.

Map a Field to a Fixed Value

You can set a fixed value for any mapped shipment field. You can either type in a value or choose one of the possible shipment values from a drop-down list. If the shipment field says (Select) next to it, then the fixed value will be either selected (True) or not (False).

Map a Field to Any Developer Interface Field

Select a field from the Developer Interface document as the mapped source for the corresponding StarShip field.

In the “Maps from” field, select Developer Interface Field and then choose the Developer Interface field to map to.

Map a Field to a Developer Interface field with Value Translations

This example illustrates an StarShip field that requires a set of possible values. Here is the StarShip “FOB” field that we map to the Developer Interface field “FOB”. You’ll see that an area for Value Translations becomes available.

Click Add Value Translation if there are no values present from your source interface and enter the values from Developer Interface; or if values are present, just select the StarShip value that they should translate to.

Map to a User Definable field

StarShip provides User Definable fields at the Item, Order, Packaging, Pallet and Shipment levels. Although it is possible to map StarShip User Definable fields to different level source fields, we recommend that you only map User Definable fields to the same level fields from Developer Interface.

1. Create the StarShip User Definable field(s).
2. In Select Field Mappings, locate the User Definable field. User Definable fields are noted by a (UDF) after the field name you created.
   
3. Select Maps from “Developer Interface Field” and then select the field to map to.