Agentflow Instance details

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

Jump to: 

Access the Instance details page

  1. Go to Agents > Instances.

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

    The Instance details page is displayed.

View the agentflow

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

  • In the Agentflow details section on the Instance details page, click the Name.

View other instances of the agentflow

  • In the Agentflow details section on the Instance details page, click View other instances of this agentflow.

Resubmit a agentflow

You can resubmit a Failed, Completed, or Terminated agentflow instance. The agentflow is resubmitted with the same start data as the original, and a new instance of the agentflow is created. You can resubmit a single instance from the Instance details page. Go to the Instances page to resubmit multiple instances.

  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

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

Parent and child agentflow instances

On the Instances page, parent and child agentflow instances are linked to each other, allowing you to easily navigate between related agentflows.

Parent agentflow: A parent agentflow is the primary agentflow that initiates another agentflow during its execution.

Child agentflow: A child agentflow is the secondary agentflow that is initiated by the parent agentflow.

For example, when a Nintex agentflow is called from a agentflow using the Call an agentflow action, the calling agentflow is the parent, and the agentflow being called is the child agentflow.

View the parent agentflow from a child agentflow

  1. Go to Agents > Instances.

  2. Find the instance you want from the list and open the Instance details page.

  3. In the Instance details section, click the link displayed in the Initiated from instance field.

    The instance details of the parent agentflow is displayed.

View the child agentflow from a parent agentflow

  1. Go to Agents > Instances.

  2. Find the instance you want from the list and open the Instance details page.

  3. In the Instance activities section, expand the Call an agentflow action that calls the child agentflow. A link to the child agentflow instance is displayed.

  4. Click the link to open the instance details of the child agentflow.

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.

Error handling and resolving paused instances

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

  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 agentflow resumes from the point it was paused.

    • Fail instance: The instance is failed and the agentflow 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 agentflow resumes from the point it was paused.

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

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 agentflow name that is specified when the agentflow 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

(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 agentflow instance.

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

Agentflow details Name

Name of agentflow for this instance.

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

  Published Date and time when the agentflow was published.

Instance start data

Instance start data

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

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.

  Resolve instance Resolve paused instances. For more information, see Error handling and resolving paused instances.

 

Sequence

Order of activity.

Click to sort the sequence in ascending or descending order.

 

Action name

Identifier of activity (action) as displayed on the designer canvas; may be a user-defined value. For example, if you change the name for Send an email to "Email agentflow 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.
  Open agentflow execution history Click to open the execution history for the agentflow action and view details about the agentflow run.

 

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.