Return Module

• Definition

• Configuring the Returns module

  • Flow variables

    • Source data

  • Result

Definition

The "Return" tool module, standard module for use in any flow, was created to transform data using JSONATA and return a response to an HTTP request, thus facilitating the creation of complex operations.

JSONata is a lightweight language designed to query and transform JSON data structures.

The "Return" module consists of a single operation, which allows you to manipulate various data and transform this data into the format you want. This module always initializes the data parameter, which allows us, as we saw at Objects Handling in addition to obtaining a set of data, to filter it so that only a specific subset is evoked.

"Return" is ideal for more complex data manipulations that require a response to an HTTP request. To manipulate data with an internal response in the flow, we recommend the Data Transformation module. For less complex data manipulations, also without the need for an external response, we recommend using a SMOP.

Configuring the Returns module

The "Return" module appears in the Tools option when editing a flow. As soon as you click to add it, the modal opens for configuration:

Find out about the Module Header here.

Flow variables

This is the first part of the "Return" module configuration. Here, you need to provide a set of data for transformation in JSON format and click on Validate to check for any errors and have a preview of the data that will be transformed.

Source data

Add, drag and choose the necessary fields: Key, Value and Type (object, number, etc).

You can also use "JSON Source".

Once you have finished configuring the flow variables, click "Next".

Result

Under "Result", view the Input Data, JSON and JSONATA areas and manipulate them as you wish with JSONATA. The "Run" button allows you to test the newly configured variables.

To finish configuring the module, click on "Save".