Use the Outbound Mappings screen to configure how platform data is serialised and sent back to a client's ERP. Each outbound mapping references a payload schema and defines the field-level mappings that translate internal model fields to ERP payload fields. Open the screen by selecting Outbound Mappings in the ERP Manager navigation menu.
Outbound mappings list
The list shows each mapping's Name and Source Model in a table with a selection checkbox on every row. Selecting a mapping name opens its detail record.
Control | What it does |
Name search box | Text box with the placeholder text Search. Filters the list by mapping name. |
Create | Opens a new outbound mapping record. |
Delete | Deletes the selected outbound mappings. Select one or more rows first. The toolbar also has an Unselect button and an items-selected counter. |
Name column | The name that identifies this outbound mapping. |
Source Model column | The platform model whose data this mapping reads from. |
Rows per page | Controls pagination of the list. |
Mapping detail
The detail screen has two tabs, General Info and Relation. The General Info tab toolbar has Back, Delete, Cancel and Save.
Control | What it does |
Save | Unavailable when the record opens. Persists changes made on the open tab. |
Delete | Deletes the current outbound mapping record. |
General Info tab
The tab holds the identifying and schema fields for the mapping. All three fields are read-only.
Field | What it holds |
Name | The name of this outbound mapping. |
Api Schema | The source model this mapping reads from. |
Paylaod Schema | Points to the schema that defines the expected output structure. Appears as a link. Selecting the link opens the record of the referenced schema. |
Relation tab
Selecting the Relation tab opens the Outbound Mapping Lines view. The tab is where you define and manage individual field mappings. These are called Outbound Mapping Lines and translate source model fields to payload fields. A mapping line can have child field mappings nested under it.
Control or column | What it holds |
Create Outbound Mapping Line | Adds a new top-level mapping line. |
Delete | Deletes the selected mapping lines. Select one or more rows first. |
Source model | The platform model that provides the source value for this line. |
Payload field | The field name in the outbound payload that this line writes to. |
Source name | The field name on the source model whose value is read. |
Types match | Indicates whether the source field type and payload field type are compatible. |
Required | Indicates whether this field is required by the payload schema. |
Allow Null | Indicates whether a null value is permitted for this field. |
edit | Button at the end of each row. Opens the mapping line so you can modify it. |
Rows per page | Controls how many lines appear per page. |
Notes
The Types match, Required and Allow Null values for a line come from the referenced schema. To inspect or change these values, edit the mapping line.
Related