Action on page load

The Run recipe (Beta) action enables you to retrieve or modify data in a third-party application and return it to your Workflow app dynamically when a page loads in the Workflow apps portal. This allows you to sync data between external system and your Workflow app in real-time.

LIMITED ACCESS

The Run recipe (Beta) action is a limited access release. Limited access features are those that have passed the development phase and are now ready for customer use. Our goal is to gather your input to ensure their reliable release in upcoming enhancements.

During the limited access release, Workato may update its functionality or change its availability to customers without prior notice.

Configure a Run recipe action on page load

Configuring a Run recipe action on page load involves the following steps:

1. Enable action on page load
2. Configure a recipe to retrieve or modify data in an external app
3. Surface recipe data in page components

Enable action on page load

Complete the following steps to enable a Recipe run action on page load:

1

Create a new Workflow app or select an existing one.

2

Select the page and go to the Action panel. The action's Trigger event is pre-selected as Page is loaded.

3

Use the Action drop-down menu to select Run recipe (Beta).

4

Use the Recipe drop-down menu to click Create recipe. This opens the Set up your recipe page in a new tab.

Action on page load setup

Configure a recipe to retrieve or modify data in an external app

1

Enter a unique Name for this recipe.

2

Use the Location drop-down menu to ensure the recipe is in the same folder as your app page.

3

Click Start building.

Workato generates a recipe pre-configured with the New component event (real-time) trigger and the Return data to component action:

Recipe outline

4

Modify the New component event trigger

Complete the following steps to modify the trigger:

1

Select the New component event trigger.

2

Go to the Setup tab.

The setup tab displays recipe input parameters and an output schema which can be used to receive data from and return data to your page.

Because this recipe runs when the page loads, there isn't user input available for use in the recipe and there is no need to define input parameters.

3

Go to the Output schema section and click + Add field.

4

Define the recipe output you plan to return to your page. You must provide the Name, Label, Data type, and Optional status for each output parameter.

Configure the output schema

5

Configure an action in an app

Complete the following steps to configure one or more action in an app steps to retrieve or modify data from an external system:

1

Click Step 2.

2

Search for and select an app and action.

3

Configure the action based on your requirements.

4

Add additional steps as required.

6

Modify the Return data to component action

Complete the following steps to return recipe data to your app:

1

Select the Return data to component action.

2

Use the Consider this action as successful? drop-down to define whether the action completed successfully.

3

Go to the output section and map in recipe data to the provided output fields. This output matches the output fields defined in the New component event trigger.

4

Click Save and Exit.

Surface recipe data in page components

Complete the following steps to surface recipe data in page components:

1

Return to the page editor and select the page.

2

Create and map a variable

1

Go to the Design panel and select + Add variable.

2

Enter the variable Name, Data type, and Default value as required. Variable data types must match the data type specified in the trigger output parameters. Refer to Create a variable for more information.

Add a variable

3

Create additional variables as required.

4

Select a component where you plan to display the variable, such as a text block, and go to the Content panel

5

Use the Page data modal to map in a variable.

Map a variable

3

Use recipe output to set variable values

1

Select the page.

2

Go to the Action panel.

3

Go to the Recipe output to set value section and click + Add item.

4

Use the Recipe output drop-down menu to select recipe output.

5

Use the Set value for drop-down menu to select a page component or variable to set the value for. Refer to Populate a variable using recipe output to for more information.

Populate variable values with recipe output

4

Click Save.