Instance usage

The Instance usage widgetComponent of the Nintex Analytics Dashboard interface, which displays information for specified data on your Nintex plaform. displays a bar chart with the status of all workflow instancesAn occurrence of a workflow. initiated for a date range you select, for the Nintex capabilities for which you have created data connectionsMethod of connecting with Nintex platform capabilities e.g. a Nintex Workflow Cloud tenant that Nintex Analytics displays data for in your dashboard..

The widget also displays the following data for the selected date range:

  • Total instances

  • Successful instance runs

  • Instances in progress

  • Average instances

You can view percentage comparisons between data for the selected period and a previous period of the same duration. For example, if you select a date range of 30 days for December, you will see a percentage increase or decrease between data for that period and the previous 30 days (November).

Note: Percentage comparisons do not apply to average instances.

View the Instance usage widget

The Instance usage widget is displayed in the Dashboard page.

  • To view the Dashboard, click Analytics on the upper-right of your Nintex Analytics workspace.

Set the date range for instances data

You can select a preset date range or set a custom date range for which you want to display data on the instances page and the Instance usage widget.

  1. Click the date picker .

  2. Click Preset or Custom.

    • Preset: click 30 days, 90 days, 180 days or 1 year.

    • Custom: click a beginning date and an end date in the calendar.

The date range you select will be reflected on both the Instances page and the Instance usage widget. The Instance usage widget displays percentage comparisons based on the date range you select. The comparison is between data for the selected period and a previous period of the same duration.


Export the Instance usage widget data as a CSV file

You can export the data shown in widgets as a CSV file.

  1. Click in top-right corner of the widget.
  2. Click Export CSV.

Interpret instance usage data

Let's understand the data the Instance usage widget displays and how you can action and utilize it. An example of the Instance usage widget is useful is when you want to look at how many instances have failed during the selected date ranges and identify which Nintex capability has the most number of failed instances. The Instance usage widget shows the number of instances with the following statuses:

  • Running: Instances of workflows that have started and are currently in progress.
  • Completed: Instances of workflows that have started and finished.
  • Failed: Instances of workflows that have started and ended because of an error.
  • Terminated: Instances of workflows that have started and are ended by a user.

Take a look at the data displayed in this Instance usage widget:

Instance Usage widget

Looking at this widget we can see that there are 150 Running workflow instances, 375 Completed workflow instances, 150 Failed, and 50 Terminated workflows. The majority of the failed instances are from SharePoint Online workflows which is represented by the purple segment of the bar in the chart.

The next step is to view more details of the failed instances and identify the associated workflows in order to resolve the workflow issues.

View details of failed instances to analyze and resolve workflow issues

  1. In the Instance status widget, click the Instance status trends link. The Instances page is displayed.
  2. In the Instances section sort the data by Data connection type and look at all the SharePoint Online workflows. The Total instances and Unsuccessful instances columns can be used to identify which workflows have failed instances. For more information about the information displayed in the Instances list, see Instances page columns, buttons and settings.
  3. Note: You can click and select Export CSV to export the Instances list to a .csv file for futher analysis.

  1. After you identify the workflows that have unsuccessful instances, click on the Workflow name to view more details of a specific workflow.
  2. The Workflow details section displays more information about the workflow such as, the Workflow ID, the location of the workflow and who published the workflow. Contact the user who published the workflow to resolve issues. For more information, see Workflows.

    Tip: If you have workflows designed using Beacon actions you can open the workflow and click the OData button to view the OData API URLs for endpoints. For more information , see Nintex Analytics OData API Overview.