Instances
When you run a botflow, an instance is created to execute the botflow steps. The Instances page lists instance details for the botflows Automated steps that you can design for each bot that will run. that are running. Users with the Administrator A user who can use all functionality in both Nintex RPA Central and Nintex Bot. role can see instances for all botflows across the domain.
- View botflow instance details
- Drill down to botflow instance details
- Pause a botflow instance
- Resume a botflow instance
View botflow instance details
- On the top navigation bar, click Dashboard.
- Click Instances in the side navigation menu.
The page loads a subset of the latest instances and includes automatic paging. As you scroll, more instances are returned. You can control the page size (the default is 50) by editing the SharedServiceSettings file located at /Program Files (x86)\Nintex\RPACentral\RPACentral.
-
Click the name of an instance to view details.
Instance details fields by sectionSelection Field, button, link, or column Description (Top section) Back to instances Returns the user to the Instances page. Instance details Initiated Date and time when the instance began running. Finished Date and time when the instance completed. Status Indicates the current status for the selected instance (for example, In progress, Completed, Failed). Instance ID Identifier for this botflow instance. Bots assigned (#)
n/a Bots that are assigned to process the botflow instance. Botflow details Name Name of the botflow for the selected instance. Published Date and time when the botflow was published. Dataset Download Input File Downloads the instance input file. Download Output File Downloads the instance output file.
This button will only be enabled after the instance is completed. It will be disabled if the botflow fails.
Instance activities Refresh Refreshes a running instance. Record Order of records in the instance. Click to sort the sequence in ascending or descending order. Start time Date and time when the record began processing. Bot The name of the bot that is processing the records. Status Current status for the record in the instance.
-
Queued: Indicates that the record is waiting for an available bot. The instance will have a status of queued until at least one assigned bot is able to execute the botflow steps in that record.
-
Running: The record is being executed by a bot.
-
Failed: The bot has failed to complete the record. The message will include standard error strings from the bot.
Note: The BOT_ERRORMSG field contains an error string (for example, target not found). Any error at any record will cause the overall instance status to change to Needs Attention.
-
Completed: The record was successfully completed by a bot.
-
Paused: All records that had a status of Queued will change to Paused when a botflow is paused by a user.
-
Terminated: All records that had a status of Queued, Running, or Paused will change to a status of Terminated when a record is skipped by a user in Nintex Bot or when a botflow is terminated.
Message Displays details for a record with a Failed status and tells you what happened. End time Date and time when the record processing completed. Originator The source that started the botflow instance.
-
Username
-
Nintex Automation Cloud
-
Scheduler
-
Unknown (if it is an old instance or cannot be determined)
-
Drill down to botflow instance details
Access the Instance details page from the Instances page to view detailed information about your instance. If you have a Dataset for the botflow, you can also view instance details for that dataset.
-
On the Instances page, click an Instance name link.
Pause a botflow instance
If you want to temporarily stop a botflow execution, you can pause the botflow instance. Pausing the botflow instance pauses all bots running that instance. The bots stop at the last step executed when the botflow instance is paused and await further instructions. When you resume the botflow instance, the bots will continue from the step where the botflow instance was paused.
- On the top navigation bar, click Dashboard.
- Click Instances in the side navigation menu.
- For the botflow instance you want to pause, click > Pause.
The botflow instance stops running and remains paused until you resume or terminate the instance.
Resume a botflow instance
If you have temporarily paused a botflow instance, you can start it again using the Resume option.
- On the top navigation bar, click Dashboard.
- Click Instances in the side navigation menu.
- For the paused botflow instance you want to resume, click > Resume.
The botflow instance resumes and starts running.
Terminate a botflow instance
If you have a queued or running botflow instance that is no longer required, you can terminate the botflow instance.
Note: If an instance is queued and can't be terminated, ensure that the bot is closed and that the Nintex RPA Central service is running. If you can run another botflow on the same bot after the one that could not be terminated, you can ignore the issue.
- On the top navigation bar, click Dashboard.
- Click Instances in the side navigation menu.
- For the botflow instance you want to terminate, click > Terminate.
- Click Terminate to confirm.
The botflow instance is terminated and you cannot resume it.