AWS Simple Workflow Connector 1.0.0.0

The AWS Simple Workflow Connector lets you list, import and run AWS Simple Workflows.

Prerequisites

Contents

Object Type Name Description
Folder GLOBAL.Redwood.REDWOOD.AWS.REDWOOD.SimpleWorkflow Integration connector with AWS Simple Workflow (1.0.0.0).
Constraint Definition REDWOOD.Redwood_AWS_Simple_Workflow_Domain_Constraint Constraint for AWS Simple Workflow domains in the specified region.
Constraint Definition REDWOOD.Redwood_AWS_Simple_Workflow_Registered_Domain_Constraint Constraint for AWS Simple Workflow registered domains in the specified region.
Job Definition REDWOOD.Redwood_AWS_SimpleWorkflow_RunWorkflow Runs an AWS Simple Workflow.
Job Definition REDWOOD.Redwood_AWS_Simple_Workflow_ImportWorkflows Imports AWS Simple Workflows.
Job Definition REDWOOD.Redwood_AWS_Simple_Workflow_ListWorkflows Lists all available workflows from AWS Simple Workflow.
Job Definition Type REDWOOD.Redwood_AWS_Simple_Workflow AWS Simple Workflow Connector.
Library REDWOOD.Redwood_AWS_Simple_Workflow Library for AWS Simple Workflow connector.

Setup

To install the AWS Simple Workflow Connector:

  1. Click its tile in the Catalog, select the version you want, and then click Install <version number>.

  2. Create an AWS Connection.

Job Definitions

Redwood_AWS_Simple_Workflow_ListWorkflows

This Job Definition returns the list of AWS Simple Workflows in an RTX format.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection The AWS connection that will be used to connect to AWS Simple Workflow. String In

Parameters regionName Region The name of the AWS region. String In

Parameters domain Domain The name of the domain that contains the workflows. String In

Parameters workflowName Workflow Name Filter Specifies which workflows should be included. By default (if no input is provided) the job will list all available flows. Wildcards * and ? are supported. String In

Parameters listing Workflow Listing Link to the generated RTX file containing the listing output. Table Out

Redwood_AWS_Simple_Workflow_ImportWorkflows

Lets you Import AWS Simple Workflows as Job Definitions.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection The AWS connection to use for importing Simple Workflows. String In

Parameters regionName Region The name of the region that the AWS Simple Workflows are located in. String In

Parameters domain Domain The name of the domain that contains the workflows. String In

Parameters workflowName Workflow Name Filter The filter that specifies which Workflows should be included. By default (if no input is provided), we will import all available workflows. Wildcards * and ? are supported. String In

Generation Settings overwrite Overwrite Existing Definition When set to Y, if a definition with the same business key already exists, it will be overwritten by the import. When set to N, the import will be skipped if the definition already exists. String In N Y=Yes, N=No
Generation Settings partition Partition The Partition to create the new Job Definitions in. String In

QueryFilter:User.Redwood System.Partition.Partition%2e;all
Generation Settings application Application The Application to create the new Job Definitions in. String In

Generation Settings defaultQueue Default Queue The Queue to assign to the imported Job Definitions. String In

Generation Settings prefix Prefix Prefix to prepend to the imported Job Definition names. String In CUS_AWSSWF_

Redwood_AWS_Simple_Workflow_RunWorkflow

Run workflow from AWS Simple Workflow.

Parameters

Tab Name Description Documentation Data Type Direction Default Expression Values
Parameters connection Connection The AWS connection that will be used to connect to AWS Simple Workflow. String In

Parameters regionName Region The name of the AWS Region. String In

Parameters domain Domain The name of the domain that contains the workflows. String In

Parameters workflowName Workflow Name Specifies which workflows should be started. The Workflow name should be described in this format: <name>:<version> String In    
Parameters workflowId Workflow Id The Workflow identifier associated with the workflow execution. String In

Parameters runId Run Id The runId of a workflow execution. String Out

Workflow Options childPolicy Child Policy Policy to determine how child workflows are treated. String In

TERMINATE, REQUEST_ CANCEL, ABANDON
Workflow Options executionStartToCloseTimeout Execution Start To Close Timeout Timeout duration (in seconds) for the execution from start to close. Number In

Workflow Options input Input Input data to be passed to the workflow. String In

Workflow Options lambdaRole Lambda Role IAM role for Lambda function execution. String In

Workflow Options tagList Tag List List of tags to associate with the workflow execution. String In

Workflow Options taskList Task List Name of the task list for decision tasks. String In

Workflow Options taskPriority Task Priority Priority level for the tasks in the workflow. Number In

Workflow Options taskStartToCloseTimeout Task Start To Close Timeout Timeout duration (in seconds) for each task from start to close. To specify unlimited duration, set it to -1. Number In

Procedures

Listing AWS Simple Workflows

You can use the Redwood_AWS_Simple_Workflows_ListWorkflows Job Definition to query for AWS Simple Workflows. This Job Definition returns the list of AWS Simple Workflow jobs in RTX format, so that you can use it to run a Simple Workflow using the Redwood_AWS_SimpleWorkflow_RunWorkflow definition.

We need to be more specific regarding where it can be used, i.e. `you can use it to run a SimpleWorkflow flow using Redwood_AWS_SimpleWorkflow_RunWorkflow definition.

To list AWS Simple Workflows:

  1. In the Redwood > AWS > SimpleWorkflow Folder, run the Redwood_AWS_Simple_Workflow_ListWorkflows Job Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Simple Workflows are located in.

  4. Choose the Domain that contains the AWS Simple Workflows.

  5. Optionally, to limit the results, enter a Workflow Name Filter. You can use the wildcard characters ? and *.

  6. Run the Job Definition.

  7. In the Monitor screen, select the Job, then look at the Detail View. Under Files, the listing.rtx file contains the response (if any).

Importing AWS Simple Workflows

To import AWS Simple Workflows as Job Definitions:

  1. In the Redwood > AWS > SimpleWorkflow Folder, run the Redwood_AWS_Simple_Workflow_ImportWorkflows Job Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Simple Workflows are located in.

  4. Choose the Domain that contains the AWS Simple Workflows.

  5. Optionally, to limit the results, enter a Workflow Name Filter. You can use the wildcard characters ? and *.

  6. Switch to the Generation Settings tab.

  7. To indicate whether to overwrite any matching AWS Simple Workflow Job Definitions you've already imported, choose an option from the Overwrite Existing Definition dropdown list.
  8. Optionally specify a Partition, Application, and Default Queue.
  9. To specify a prefix to be applied to the names of the imported AWS Simple Workflow Job Definitions, enter a value in the Prefix field.

  10. Run the Job Definition.

Running an AWS Simple Workflow Flow

To Run an AWS Simple Workflow:

  1. In the Redwood > AWS > SimpleWorkflow Folder, run the Redwood_AWS_SimpleWorkflow_RunWorkflow Job Definition.

  2. Choose the Connection.

  3. Choose the Region the AWS Simple Workflow is located in.

  4. Choose the Domain where the Workflow is stored.

  5. Enter the Workflow Name.using the <name>:<version> format (e.g., testworkflow:1.0.0).

  6. Enter the Workflow Id, a user-defined identifier associated with the workflow execution (e.g., Run_testworkflow_1).

  7. Switch to the Workflow Options tab (all the fields listed on this tab are optional).

  8. Choose a Child Policy. Options include Abandon, Request_Cancel, and Terminate. This determines how child workflows are treated.

  9. Enter the Execution Start to Close Timeout that identifies a timeout duration in seconds, for the execution from start to close.

  10. Enter the Input data to pass to the workflow.

  11. Enter the Lambda Role that identifies the IAM role for Lambda function execution.

  12. Enter the Tag List to associate with the workflow execution.

  13. Enter the Task List for decision tasks.

  14. Enter the Task Priority that identifies the priority level for the tasks in the workflow.

  15. Enter the Task Start To Close Timeout that identifies a timeout duration in seconds, for each task from start to close. A value of -1 means the duration is unlimited.

  16. Run the Job Definition.