Skip to main content

Create an outbound mapping

An outbound mapping defines how platform data is shaped and sent to a client's ERP.

N
Written by Niyaz

An outbound mapping defines how platform data is shaped and sent to a client's ERP. It binds a source model to a payload schema. You can then map individual fields, including nested child fields, through a set of outbound mapping lines. Use the Create Outbound Mapping form to enter the mapping's Name, Basic api schema and Payload schema.

Empty Create Outbound Mapping form with Name, Basic api schema and Payload schema fields and Save unavailable

Before you begin

  • You need a payload schema that targets the ERP endpoint. Create the payload schema first if it does not exist.

  • At least one basic API schema must be available for the source model you intend to map.

Steps

  1. In the sidebar, select Outbound Mappings. The screen lists each mapping by Name and Source Model.

  2. On the Outbound Mappings screen, select Create. The Create Outbound Mapping form opens.

  3. In Name, enter a name for the mapping.

  4. In Basic api schema, select a value. This value is the source model that supplies the data.

  5. In Payload schema, select a value. This value is the payload schema that defines the ERP's expected structure.

  6. Select Save. On the empty form, Save is unavailable. After you change the field values, Save becomes available. The mapping is saved and the record opens on its General Info tab.

  7. On the saved mapping, select the Relation tab. The record has the tabs General Info and Relation. Use the Relation tab to configure field mappings.

  8. On the Relation tab, select Create Outbound Mapping Line. The Create Property Mapping Line dialog opens.

  9. In the dialog, select a value in Payload field and in Source name. Payload field is a required field. The dialog is where you specify the source model field and the corresponding payload field.

  10. Optional: Select a Simple logic rule, enter a Default value, or turn on Required or Allow Null.

  11. In the dialog, select Save. On the empty dialog, Save is unavailable. After you change the field values, Save becomes available.

  12. Optional: Repeat steps 8 to 11 to add a mapping line for each field you need to map.

Result

The outbound mapping appears in the Outbound Mappings list. Its Relation tab holds the field mappings you add, including nested child fields. ERP Manager uses these mappings when sending platform data to the client's ERP.

If something goes wrong

  • If Save is unavailable on the mapping form, select a value in both Basic api schema and Payload schema.

  • If the source model you need is not listed in Basic api schema, create a basic query for that model first.

  • If the payload schema you need is not listed in Payload schema, create it first.

Related

Did this answer your question?