Orchestration instances

Note: Orchestrations is currently in beta. For more information, see the Nintex Beta terms document.

An instance is an occurrence of an orchestration. An orchestration instance is created when an orchestration is executed. A single orchestration can have multiple orchestration instances. The Orchestration instances page shows a list of all orchestration instances. By default, this page shows running orchestration instances initiated during the last five days. For each orchestration instance, the list indicates the name of the associated orchestration, and the initiated and completed dates. Your orchestrations and those shared with you are listed. Users with the Administrator role can see instances for all orchestrations across the tenancy.

Note: Instances are terminated when they reach a 1-year running time.

Use the Instances page to:

  • Find orchestration instances.
  • Terminate instances that you don't want to run any longer.
  • Delete instance data from completed, terminated, or failed orchestrations.
  • Drill down to instance details to determine which activities remain.

Jump to:

Access the Orchestration instances page

  • Go to Orchestrations > Orchestration instances.

Filter instances

  1. Go to Orchestrations > Orchestration instances.

  2. In the Filters section, click Custom filter, complete the search parameters that you want, and then click Apply filter.

    You can also click any of the default search links:

  • Started last 5 days
  • Failed last 5 days
  • Running last 5 days

For more information on Custom filter, see Custom filter fields and selections.

Orchestration instance details

The Orchestration instance details page shows the status and key information about a specific orchestration instance.

  1. Go to Orchestrations > Orchestration instances.

  1. Click the name of the instance that you want to view (instance names are listed in the first column).

    2. The Instance details page appears. To go back to your search results, click Back to instances at the top of the page.

    For information about the sections available in the Orchestration instance details page, see Instances details columns and selections.

The following columns or selections are displayed when you view the Ochestration instances page.

Section

 Column or selection Description

Filters

Started last 5 days

This is the default filter applied when the page loads.

Shows all orchestration instances that were started within the last five days, regardless of the current status.

 

Failed last 5 days

Shows all orchestration instances that completed within the last five days and have a current status of Failed.

 

Running last 5 days

Shows all orchestration instances that were started within the last five days and are currently running.

 

Custom filter

Click to run a search of instances based on selected search criteria.

For information, see Custom filter fields and selections.

 

Refresh

Click to refresh the page.

(table)

 Instance name

The name of the instance, which is derived from the following information:

  • The orchestration name that is specified when it was published

  • The date and time when the instance began running

  • The custom instance name that is specified in the Set instance name action

Click the name of the instance to display the Instance details page.
  Orchestration name The name of the orchestration associated to the instance.

 

Status

Current state of the instance.

 

 Date initiated Date and time when the instance began running.

 

Date completed

Date and time when the instance reached completion.

The following fields or selections are displayed when you click Custom filter.

Field or selection Description
Orchestration name Type the name of the orchestration from which you want to search instances.
Status

Choose the status of the instance.

Start date range

Click the Date picker to select a date range.

Select Preset or Custom.

  • Preset: Quickly filter by past 1, 5, 30, 60, or 90 days.

  • Custom: Select a custom start and end date using the calendar.

Default value: Six days that includes the previous five days and today. For example, if the date today is September 30, then the default Start date range is from September 25 to 30.
Apply filter

Click to start the search.

The following columns or selections are displayed when you view the Instances details page.

Section

 Column or selection Description
Orchestration instance details Intiated/Finished The date and time when the instance started and finished.
  Status Current state of the instance.
  Orchestration instance ID Unique identifier for this instance.
Orchestration details Name Name of the orchestration. Click to view the orchestration.
  Version Version of the orchestration associated with this instance.
  View other instances of this orchestration Link to see other instances of the same orchestration.
Orchestration Context Data   Expand this section to view the context data associated with the orchestration instance.
Phase progression  

Shows the status of each phase in the orchestration, including start and end times.