Flow API

The following APIs can be used in any Execute Expression Actions or Form Schema functions.

execute(string, data)

Executes a short-running Flow in the current Solution and returns data if the Flow is configured to do so.

API Definition

this.app.services.flow.execute(flowName: string, {
    solutionId?: string,
    environment?: string,
    data: {}
}) : Promise<any>

Property	Description
flowName	The name of the Flow in the Solution to execute.
solutionId	Optional. Specify this property if you want to run a named Flow that belongs to a differnet Solution than the open Workbook.
environment	Optional. Specify this option of you want to override the FLOW_ENVIRONMENT Solution Variable.
data	Optional. Specifies the arguments to send to the Flow.

Returns

The API returns a response object with the following properties.

Property	Description
data	The data returned from the executed Flow (if any). This may be null, a simple value, or a complex object.
status	The HTTP status code.

Example

This example shows how to run a Flow that returns a value (price) and displays the result in a message box. You can run this code in an Execute Expression Actions or Form Schema functions.

const response = await this.app.services.flow.execute('Calculate Price', {
    data: {
        productId: this.app.variables._state.selectedProductId,
        qty: 30
    }
});

this.app.ui.dialogs.showMessage(`The calculated price is ${response.data}`);

download(string, data)

Executes a short-running Flow that returns a file, and downloads the file. Use this API if you have a Flow that returns a file that you want to download in the browser.

API Definition

this.app.services.flow.download(flowName: string, {
    solutionId?: string,
    environment?: string,
    data: {}
}) : Promise<void>

Example

The following example shows how run a Flow named Export to Excel creates an Excel file for the selected department, and then download the file to user.

await this.app.services.flow.download("Export to Excel", {
    data: {
        departmentId: this.app.filters.get("Filters", "Department").selectedValue.Id
    }
});