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.

Note: Instances are terminated when they reach a 1-year running time. All terminated workflows can be resubmitted from the beginning with the same start data as the original workflow. Resubmitting the workflow will create a new instance of the workflows. For more information, see Resubmit a workflow.

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.

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 options 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.

Error handling and resolving paused instances

When a workflow instance encounters a resolvable error, it's either failed or paused, depending on the workflow settings. Opting for the fail option will fail the instance when any error is encountered. Choosing the pause option will pause the workflow when a resolvable error occurs, allowing the workflow designer to either investigate and resolve the error before resuming the workflow instance from where it paused or fail the instance.

For information about the list of possible errors, resolutions and supported actions and connectors, see the Error codes and recommended resolutions and Supported actions and connectors and error messages that will pause instances sections below.

  1. Open the paused instance from the Instances page. The instance details page is displayed.

  2. In the Instance activities section, click Resolve instance.

    The Resolve paused instance panel is displayed.

    Note: 
    • Resolve instance is not available for Failed instances.

  3. Select the Action you want to take for the instance.

    • Resume instance: The workflow resumes from the point it was paused.

    • Fail instance: The instance is failed and the workflow instance status is updated to Failed.

  4. Add a Comment to describe the action you took. You can provide details about how you resolved the error or why you want to fail the instance.

  5. Click Apply.

    If you selected to Resume the instance, the workflow resumes from the point it was paused.

    If you selected to Fail the instance, the instance is failed and the workflow instance status is updated to Failed.

Supported actions and connectors and error messages that will pause instances

Important: 

Note the following exceptions:

  • Localization is applied to the Error handling settings screen. If a third-party action triggers an error and returns an error message containing the word "found," the instance will be paused. However, if the error message is another language and the term "found" is in a different language, the instance will not be paused.

  • Connectors still on the old workflow engine (v1) will not be supported for error handling. Failing actions, even after auto-retries, will still fail immediately and they will need to be resubmitted. For more information about the workflow engine, see Workflow engine.

Supported Actions Errors codes or error messages that will pause instances
  • Document Generation

  • Pause for duration

  • Pause until date

  • Send an email

  • 401 – Unauthorized

  • 403 – Forbidden

  • 404 – Not found

  • 408 – Request timeout

  • 409 – Conflict

  • 429 – Too many requests

  • 502 – Bad gateway

  • 503 – Service unavailable

  • 504 – Gateway timeout

  • Call a web service

  • 408 – Request timeout

  • 429 – Too many requests

  • 504 – Gateway timeout

  • InvalidHostException – Service is missing

  • SocketException – Network error

  • AuthenticationException – Unauthorized

  • Query XML

  • Update XML

  • Nintex Insights

    • Beacon

    • Beginning beacon

    • Ending beacon

  • 408 – Request timeout

  • 429 – Too many requests

  • 502 – Bad gateway

  • 503 – Service unavailable

  • 504 – Gateway timeout

  • SocketException – Network error

Supported Connectors Errors codes or error messages that will pause instances

Most connectors are supported. To view the list of supported connecters, see Connectors that support error handling.

  • 401 – Unauthorized

  • 403 – Forbidden

  • 404 – Not found

  • 408 – Request timeout

  • 409 – Conflict

  • 429 – Too many requests

  • 502 – Bad gateway

  • 503 – Service unavailable

  • 504 – Gateway timeout

  • Errors that contains keywords:

    • Found

    • Exist

    • Locked

    • Checked out

  • Adobe Sign

  • DocuSign

  • 401 – Unauthorized

  • 403 – Forbidden

  • 408 – Request timeout

  • 409 – Conflict

  • 429 – Too many requests

  • 503 – Service unavailable

  • Custom Xtensions

  • 401 – Unauthorized

  • 403 – Forbidden

  • 404 – Not found

  • 408 – Request timeout

  • 409 – Conflict

  • 429 – Too many requests

  • 502 – Bad gateway

  • 503 – Service unavailable

  • 504 – Gateway timeout

  • Errors that contain text:

    • Found

    • Exist

    • Locked

    • Checked out

Gateway connectors*:

  • Microsoft SQL Server on-premises

  • SharePoint on-premises

  • 401 – Unauthorized

  • 403 – Forbidden

  • 404 – Not found

  • 408 – Request timeout

  • 409 – Conflict

  • 429 – Too many requests

  • 502 – Bad gateway

  • 503 – Service unavailable

  • 504 – Gateway timeout

  • Errors that contain text:

    • Found

    • Exist

    • Locked

    • Checked out

Important:  *Gateway connectors require Nintex Gateway v.3.5.11. Click the Download Nintex Gateway button to download the latest Nintex Gateway installer. For more information, see Nintex Gateway.

Error codes and recommended resolutions

Important: While these errors will pause an instance, not all errors are resolvable or recoverable. The option to Fail the instance can be used in these situations.

Error codes or messages that will pause instances Recommended resolution
  • 401 – Unauthorized

  • 403 – Forbidden

  • XAPI.ProviderTokenRenewalErrorCode

  • DBX.InsufficientPermissionException

  • Check the correct credentials are used in the connection.

  • Check the permissions of the credentials used in the connection.

  • 404 – Not found

  • Add the missing item

  • 408 – Request timeout

  • 502 – Bad gateway

  • 503 – Service unavailable

  • 504 – Gateway timeout

  • SocketException – Network error

  • HTTP Error 500.31

  • Check for (Nintex or 3rd party) service outages

  • Wait for services to restore

  • 409 – Conflict

  • Remove or change the existing item

  • 429 – Too many requests

  • Wait for rate limited block to lapse

  • InvalidHostException – Service is missing

  • Ensure the service is running

  • AuthenticationException – Unauthorized

  • Check the correct credentials are used in the connection

  • Check the permissions of the credentials used in the connection

  • Check the Authorization token

  • Errors that contains keyword: “Found”

  • Add the missing item

  • Remove or change the existing item

  • Errors that contains keyword: Exist

  • Remove or change the existing item

  • Errors that contains keyword: Locked

  • Wait for item to be unlocked

  • Unlock item

  • Errors that contains keyword: Checked out

  • WIF.VLD.FileIsZeroByte

  • Wait for item to be checked in

  • Check item back in

  • Ensure the file is valid

Connectors that support error handling

AccuWeather Cloudmersive - Currency Microsoft Exchange Online SendGrid
Adobe Sign Cloudmersive - PDF Microsoft Office Groups ServiceNow
Asana Cloudmersive - Virus Scan Microsoft OneDrive for Business SharePoint Online
Api2Pdf Dropbox Business Microsoft SQL server SharePoint on-premises
Azure Active Directory DocuSign Microsoft SQL Server on-premises Smartsheet
Azure Active Directory Administration Generate document Microsoft Teams Stripe
Azure Compute Google Calendar Microsoft To Do Tables actions
Azure Computer Vision Google Directory MySQL TinyJPG
Azure DevOps Google Docs Nintex Automation Cloud Trello
Azure Key Vault Data Google Drive Nintex DocGen for Salesforce UK Companies House
Azure Key Vault Management Google Mail Nintex eSign VATLayer
Azure PostgreSQL Database Management Google Sheets Nintex RPA Vonage Communication
Azure SQL Google Tasks Nintex RPA LE Webex
Bing Maps Jira OANDA WinSMS
Bitly K2 SmartObject OpenWeather Workingdays
Box K2 Workflow and Task Postmark Xero
ClickSend LinkedIn QR Code Generator Yammer
ClickUp Microsoft Dynamics CRM Randommer  
Cloudmersive - Convert Documents Microsoft Excel Salesforce