Callback mapping

Important

If you are not familiar with the concepts of form model and model properties, please read The form model before you proceed.

CyberApps exchange data with the ISV service using callbacks.

Callbacks send data to or request data from the ISV service in a callback request. They receive data from the ISV service in a callback response.

For a CyberApp to display data received from the ISV service in a form, you must map the callback response payload structure to the form model.

To send data entered, edited or selected in a form by the CyberApp user to the ISV service, you must you must map the form model to the callback request payload structure.

UI builder uses JSON schema as the mechanism for callback payload and form model mapping.

For more information about CyberApp callback payload JSON schemas, see the Payload JSON schema technical reference.

Callback mapping in the UI builder depends on JSON schemas:

• The form model schema (which you specify in the UI builder, and includes the UI elements and input parameters).

• The callback payload schemas (which you specify when you create a callback).

The UI builder uses these schemas to provide a visual representation of the form model and the callback payload, which you use to map values.

Callback mapping types

There are two types of callback mapping.

Request mapping

Request mapping maps data from elements in the form model to a callback request payload, so that this data can be sent to the ISV service.

Response mapping

Response mapping maps a callback response payload to elements in the form model, so that data received from the ISV service can be displayed in UI elements and/or stored in input paramters.

Note

Callbacks can have both a request payload and one or more response payloads. Therefore, when you map callbacks in UI builder, both mapping types might be available.

In this section

• Defining request mapping
• Defining response mapping