Instances

For Documents in Nintex Workflow, an instance is an occurrence of a document package run initiated in:

  • Nintex Apps - using the documents connection and associated document actions

  • Nintex Workflow - using the Run document package action

When a document package run occurs, an 'instance' of that run is created, capturing information such as when the run occurred, the document(s) that were generated, any errors generated, and more. A document package can have multiple instances. The Instances page for Documents in Nintex Workflow displays a list of all document package run instances, including test instances. The instance table lists instance details such as the name of the document package, status of the run, and the user who initiated it.

Based on these details, the page contains search filters you can use to narrow down your search for particular instances.

The Instances page can be used to:

  • Search for particular instances

  • Drill down to instance details

  • Find failed instances that require troubleshooting

  • Delete instances for document packages that you don't want to run any longer

  • Delete instance data for failed workflows

For more information on document packages, see Create a document package.

Access the Instances page

To access the Instances page in Nintex Workflow:

  1. Go to Documents.

  2. Click Instances.

The Instances page displays a list of instances, starting with the most recently run instance.

Find an instance

Use filters on the Instances page to search for individual instances:

  1. Go to Documents.

  2. Click Instances.

  3. Enter or select search parameters to display related instances.

Section

 Selection or column

Description
Filters Status

Runs a search for instances based on their status:

  • Completed

  • Failed

  • Running
  Start date range Runs a search for instances with start dates within a preset or custom date range
  Clear All Clears all selected filters
  More filters Displays the additional filters listed below
  Package name Runs a search for instances based on the document package name. This allows for the selection of multiple package names.
  Started by Runs a search for instances based on the name of the user that initiated the document package run in Nintex Apps
  Instance ID Runs a search for an instance based on the instance ID
Table Instance ID Displays the unique ID of an instance
  Package name Displays the name of the document package for an instance
  Status Displays the instance status
  Started by Displays the name of the user that initiated the document package run from Nintex Apps. If an instance is initiated in a workflow, this column displays 'Workflow'.
  Started Displays when the instance was initiated

View instance details

To view instance details:

On the Instances page, click on the Instance ID of an individual instance within the table.

The Instance detail panel is displayed.

For more information on instance details, see Instance details.

Delete an instance

You can use the instances detail panel to delete instances that have already run, to clear the history of complete instances, or to delete instances for compliance reasons.

To delete an instance:

  1. On the Instances page, click on the Instance ID of an individual instance within the table.

    The Instance detail panel is displayed.

  2. Click Delete instance.

Detail / Button

Description
Status Displays the status of the selected instance
Download Click to download the generated file for that instance if you've run the document package from Nintex Apps using the Documents connection. Admin users can download files for all instances initiated from Nintex Apps. The file is available to download for 24 hours after the instance run.
Instance details

Displays the following information about the instance:

  • Started: When the instance was initiated

  • Completed: When the instance was completed

  • Duration: The duration of the instance run

  • Instance ID: Unique ID of the instance

  • Started by: Name of the user who initiated the instance
Errors Displays any errors that occurred during the instance run
Create Support ticket Allows you to create a Support ticket for issues with the instance
Package details

Displays details of the document package run for the instance, including a link to the document package.
Delete instance Click to delete the selected instance