Workflows - Execute task

Announcement: Application Integration is now available for your Google Cloud project. You can now use both Apigee Integration and Application Integration within the same Google Cloud project. Learn more

The Workflows - Execute task lets you execute a workflow in Cloud Workflows. Executing a workflow runs the current workflow definition associated with the workflow.

Cloud Workflows is a Google Cloud service that allows you to fully-manage and orchestrate runtime services in the order you define.

Before you begin

Ensure that you perform the following tasks in your Google Cloud project before configuring the Workflows - Execute task:

1. Enable the Workflow Executions API (workflowexecutions.googleapis.com).

   Enable the Workflow Executions API

2. Create an authentication profile. Apigee Integration uses an authentication profile to connect to an authentication endpoint for the Workflows - Execute task.
   Note: If you're creating an authentication profile of Service account type, then ensure that the service account is assigned with the IAM role that contains the following IAM permission(s):

   • workflows.executions.create

   To know about IAM permissions and the predefined IAM roles that grant them, see IAM permissions reference.

   For information about granting additional roles or permissions to a service account, see Granting, changing, and revoking access.

Configure the Workflows - Execute task

1. In the Apigee UI, select your Apigee Organization.
2. Click Develop > Integrations.
3. Select an existing integration or create a new integration by clicking Create Integration.

   If you are creating a new integration:

   1. Enter a name and description in the Create Integration dialog.
   2. Select a Region for the integration from the list of supported regions.
   3. Click Create.

   This opens the integration in the integration designer.

4. In the integration designer navigation bar, click +Add a task/trigger > Tasks to view the list of available tasks.
5. Click and place the Workflows - Execute element in the integration designer.
6. Click the Workflows - Execute element on the designer to view the Workflows - Execute task configuration pane.
7. Go to Authentication, and select an existing authentication profile that you want to use.

   Optional. If you have not created an authentication profile prior to configuring the task, Click + New authentication profile and follow the steps as mentioned in Create a new authentication profile.

8. Go to Task Input, and configure the displayed inputs fields using the following Task input parameters table.

   Changes to the inputs fields are saved automatically.

Task input parameters

The following table describes the input parameters of the Workflows - Execute task:

Property	Data type	Description
Region	String	Region where you want to create a new Workflow execution. For example, us-central1.
ProjectsId	String	Your Google Cloud project ID.
WorkflowsId	String	Name of your Workflow.
Request	JSON	See request JSON structure.

Task output

The Workflows - Execute task returns the newly created instance of the Workflow execution.

Error handling strategy

An error handling strategy for a task specifies the action to take if the task fails due to a temporary error. For information about how to use an error handling strategy, and to know about the different types of error handling strategies, see Error handling strategies.

What's next

1. Add edges and edge conditions.
2. Test and publish your integration.
3. Configure a trigger.
4. Add a Data Mapping task.
5. See all tasks for Google Cloud services.