Mapping
Note
If you are not familiar with the concepts of form model and model properties, we recommend that you read this section before you proceed.
We send data to the ISV service and receive data from the ISV service through callbacks. Data is sent in the callback request payload and received in a callback response payload.
In order for a CyberApp to exchange data with an ISV service, we must map the payload structure to the form model or vice versa. UI builder uses JSON schema as the callback payload/form model mapping mechanism.
Note
For more information about CyberApp callback payload JSON schemas, see the mapping technical reference section.
UI builder mapping involves two JSON schemas:
the left side (which sends data)
the right side (which receives data)
One side will be the model form schema (which the UI builder creates) and the other will be a callback payload schema (which the UI builder reads from the specified callback). With these two schemas, the UI builder provides a visual representation of the possible values in our objects (the form model and the callback payload).
Which side each schema is on depends on the mapping type:
- Request mappings map elements in the model form on the left side to a callback request payload on the right side.
- Response mappings map a callback response payload on the left side to elements in the model form on the right side.
Note
Callbacks can have both a request payload and one or more response payloads. Therefore, when a callback is in UI builder, both types mapping types can be required.