Test Helper

The Test helper is a tool designed to test whether a flow's output is as expected. In other words, you can set the values of the flow's input parameters and check the output.

How To Use the Test Helper?

The Test helper becomes available only after all compilation errors are fixed and your project is deployed. To start testing, click the Test helper pop-up call button.

The Test helper pop-up window will open, and all the flows of a deployed project will be displayed on the left.

Select the required flow, fill in the request data structure in the “Requests” section, then click the RUN button. After execution you will see the response body in the "Response" section and will be able to decide whether the flow has run as expected.

You can use the Download sample button to generate an example of a request that can be used to format or structure a request correctly. Adjust values if necessary.

For REST flows, the Download sample icon is available only for complex data structures containing elements of different types. For SOAP flows and for subflows the button is always available.

When testing requests for all REST flow methods, the Headers are additionally specified. They contain information about the request, such as data format, language, content type, and other settings. The Headers that were generated automatically cannot be modified, for example:

• Content-Type: application/json. The application sends the request content as data in JSON format.

• Accept: application/json. The application is waiting for a response in JSON format.

You can add a new header to the existing ones by clicking the Add icon. An additional line will appear in the headers where you specify its name and value.

You can edit and delete headers you have created using the context menu options.

To save the test for future reuse, click the SAVE button. In the opened pop-up, enter a name and a description of the test, and click the CREATE button. A saved test will be displayed on the left side of the pop-up in the “Save tests” tab.

The last 10 unsaved tests are displayed on the left side of the pop up in the “Last 10 not saved tests” tab.

As a part of test helper, there is an available option in the flow settings Initialize variables. If initialized variables are activated then output and local variables are initialized with default values according to the data types. Otherwise, the default value is NULL.

In case of any issues, use the debugging mode to check values in the specific nodes in the flow.

How To Prepare an XML (SOAP) Request?

If your flow uses the SOAP channel type, you can use a test helper to test XML requests.

1. Go to the Test helper pop-up, select the required flow, and click the "Download request" to view the request structure.

2. Wrap your XML data in tags and click the RUN button. If the request is correct, you will receive a response

For example, if the input data consists of your custom data structure.