Instance details

View the detailed status of a workflow instance, including any logged information, on the Instance details page. You can also resubmit a workflow, terminate an instance, and create a support ticket.

Jump to: 

Access the Instance details page

  1. On the top navigation bar, click Automate.

  2. On the left, click Instances.
  3. Click the name of the instance that you want to view.

    The Instance details page is displayed.

View the workflow

You can open and view the associated workflow directly from the Instance details page. The workflow is displayed in the workflow designer.

In the Workflow details section on the Instance details page, click the Name.

View other instances of the workflow

In the Workflow details section on the Instance details page, click View other instances of the workflow.

Resubmit a workflow

You can resubmit a Failed, Completed, or Terminated workflow instance. The workflow is resubmitted with the same start data as the original, and a new instance of the workflow is created. You can resubmit a single instance from the Instance details page. Go to the Instances page to resubmit multiple instances. For more information about resubmitting workflows, see Resubmit workflows.

  1. Open the Instance you want to resubmit from the Instances page. The instance details page is displayed.

  1. In the Instance details section or in the Instance history section, click Resubmit.

    Note: 

    • The Instance history section is displayed only if the instance has been previously resubmitted.

    • Only the latest instance can be resubmitted.

    A confirmation message is displayed.

  2. Click Resubmit.

    The instance is resubmitted with the same start data and a new instance is created.

    Tip: Click Terminate if you want to terminate a running instance.

View instance activities and logged information

Important: Beginning in June 2022, instance activity data will be available only for completed workflows that started after December 1, 2021. Running workflows that started before this date and workflows that are still running will still be accessible on the Instances page. Instance activity data for completed workflows that started before December 1, 2021, can be accessed in Nintex Insights using the Instance activity for workflow report. For more information, see the Nintex Insights help.

On the Instance details page, under Instance activities, look for the action Log to instance details and expand it as needed to view logged information. You can also access the data via the Nintex Platform API tool until November 1, 2022. Follow the steps below to access the data using the API tool:

  1. Navigate to the Nintex Platform API tool.

  2. In the Auth body template on the right side of the page, replace the value next to Token with your Personal access token.

    1. In your Nintex Automation Cloud tenant, click Settings and then click Apps and token.

    2. In the Personal access tokens section, click and then select View for the required token.

      The selected personal access token identifier is displayed.

    3. Copy the token.

  3. In the Auth body template on the right side of the page, replace the value next to instance_id* with the Instance ID of the required instance.

    The Instance ID can be copied from the Instance Details page.

    1. In your Nintex Automation Cloud tenant, click Automate and then click Instances.

    2. Click the name of the instance that you want to view.

      The Instance details page is displayed and the Instance ID is displayed in the Instance details section.

  4. Click Send API Request.

    The response is returned in JSON format.

Terminate running instances

You can terminate instances from the Instances page.

  1. On the Instance details page, to the right of the Instance details heading, click next to an instance that is in progress.
  2. Click Terminate from the context menu.

Create a support ticket

  1. On the Instance details page, to the right of the Instance details heading, click Create support ticket.

  2. Follow the prompts to submit instance details to Nintex Support.

The following fields or columns are displayed when you click an instance name.

Section Field or column Description

 

Back to Instances

Click to go back to the Instances page with the most recent search parameters.

  (instance name)

The name of the instance that is displayed on the top of the page and derived from the following information:

  • The workflow name that is specified when the workflow was published

  • The date and time when the instance began running

  • The custom instance name that is specified in the Set instance name action
Instance details Create support ticket Sends the details of this workflow instance to Nintex Support.

 

(Options)

Lists the following options for the indicated instance.

  • Terminate: Stops running the indicated instance.

The Options icon is displayed for instances with an "In progress" status only.
  Initiated Date and time when the instance began running.
  Finished Date and time when the instance reached completion.
  Status Indicates current status for this instance. Examples: In progress, Completed, Failed.

 

Instance ID

Identifier for this workflow instance.

Note: In your workflow design, use the context variable "Workflow instance ID" to reference the identifier of the workflow instance. For example, you can insert this variable into an email message that is sent when the workflow runs, to pinpoint which instance of the workflow sent the message. The workflow instance ID appears as "Instance ID" on the Instance details page.

Workflow details Name

Name of workflow for this instance.

Note: In your workflow design, use the context variable "Workflow name" to reference the workflow name. For example, you can insert this variable into an email message that is sent when the workflow runs, to pinpoint the workflow that sent the message.

  Published Date and time when the workflow was published.

Instance start data

Instance start data

Click to display data for the start event of the workflow.

Note: When Nintex - Form is the start event, user input collected from all form fields in the start form are displayed as Instance start data.

Instance activities

Refresh

Click to refresh a running instance.

 

Sequence

Order of activity.

Click to sort the sequence in ascending or descending order.

 

Action name

Identifier of activity (action) as displayed on the design canvas; may be a user-defined value. For example, if you change the name for Send an email to "Email workflow started notification," then this custom name appears here.

 

expand/ collapse arrows

An action's activities are grouped in one sequence.

Click to expand the row and view information about the sequence.

 

Default action name

Nintex-provided name for the activity (action); includes third party identifier if relevant. Example: Send an email.

 

Start time

Date and time when the activity began.

 

Status

Current status for the indicated activity.

 

End time

Date and time when the activity completed.