Nintex - Component workflow

Use the Nintex - Component workflow start event The connector and event for triggering the workflow to run, including required configuration. An example is Box - New file, which triggers the workflow to run when a new file is uploaded to the specified folder.  to start your workflow from another workflow or from an HTTP-capable service or application.

You can start a Component workflow using:

  • Another workflow in your Nintex Automation Cloud tenancy, by using the Call a web service action.
  • A workflow in another Nintex Workflow product, by using the Call a workflow action in Nintex Automation Cloud (sends an HTTP Post request).
  • Any HTTP-capable application, by sending an HTTP Post request.

The workflow or external application that starts the Component workflow A workflow that can be started from outside the tenancy; the workflow uses the "Component workflow" start event. must provide the start variables A variable associated with the start event. Often referenced by actions in the workflow. For example, a start event variable might capture input in a form field. defined by the Component workflow start event, including any required files.

Configure the start event

By selecting Nintex Component workflow, you are defining that this individual workflow can be started by authorized applications or workflows. Credentials used to obtain authorization are made available after you publish the component workflow.

  1. At the top of the designer canvas, open the Start event configuration panel and click Start event.
  2. For Start from, select Component workflow.
  3. Create variables that can be passed as parameters in the HTTP call that will start the component workflow.
  4. Tip: Click Reorder to reorder the list of variables.

Design and publish your workflow

Tip: If you want to refer to the workflow identifier within the workflow itself, (for example, adding it to an email to identify which workflow sent that email), use the "Workflow ID" variable.

  1. In the designer canvas, design your component workflow. For guidance on how to use the canvas, see Workflow designer.
  2. Select the data that your component workflow should return when complete.
  3. After designing your workflow, publish your component workflow.
  4. A window is displayed with details when a component workflow is successfully published.

Regenerate component workflow tokens

Component workflow tokens expire after one (1) year. The tokens of component workflows that are close to expiring or have already expired must be regenerated. Component workflows that are close to expiring will have a warning icon and workflows that have already expired will have a red error icon appearing against the workflow name to make them easily identifiable.

If your component workflows have either of these icons, you can refresh the token on the Settings > Component workflow tokens page if you are a user with an administrator role or via the Workflows list in the Automate > Workflows page if you are the workflow owner.

For information about refreshing and revoking component workflow tokens, see View, revoke, refresh, and regenerate component workflow tokens.

Start your Component workflow

A component workflow can be triggered to start by calling it via Nintex Automation Cloud or from another Nintex platform such as Nintex for Office 365 or Nintex for SharePoint. Another method is calling it from an external service or application.

Note: The workflow that calls the component workflow is referred to as the parent workflow.