The Outbound Mappings screen is used to configure how platform data is serialised and sent back to a client's ERP. Open Outbound Mappings from the navigation menu.
Outbound mappings list
Control | Description |
Name | This search field filters the list by mapping name. |
Rows per page | This selector controls list pagination. |
Create | This action opens a new outbound mapping record. |
Column | Description |
Name | This column identifies the outbound mapping. |
Source Model | This column identifies the platform model whose data the mapping reads from. |
Outbound mapping detail
Select a mapping name to open its detail record. The detail record contains the General Info and Relation tabs.
Control | Description |
General Info | This tab holds the mapping's identifying and schema fields. |
Name | This field contains the name of the outbound mapping. |
Api Schema | This field contains the source model that the mapping reads from. |
Paylaod Schema | This field links to the payload schema that defines the expected output structure. |
Save | This action is unavailable in the displayed detail state. |
Relation tab
The Relation tab defines and manages individual field mappings called Outbound Mapping Lines. It contains two paged tables: the first lists top-level mapping lines, and the second lists child mappings nested under a selected parent line. Use a selected parent line before adding a nested child mapping to the second table. Each table has its own Rows per page selector, so the tables paginate independently.
Control | Description |
Create Outbound Mapping Line | This action adds a new top-level mapping line to the first table. |
edit | Each mapping-line row has this action for opening and modifying the line. |
Relation tab columns
Column | Description |
Source model | This column identifies the platform model that provides the source value for the line. |
Payload field | This column identifies the field name in the outbound payload that the line writes to. |
Source name | This column identifies the field name on the source model whose value is read. |
Types match | This column indicates whether the source field type and payload field type are compatible. |
Required | This column indicates whether the payload schema requires the field. |
Allow Null | This column indicates whether a null value is permitted for the field. |
Notes
Field-level details for Types match, Required, and Allow Null are read from the referenced payload schema. The individual row values are not exposed as labelled controls.
Edit a mapping line to inspect or change these details.
Related