Set Details Panel and Set Actions

This article explains the details panel, which displays key information about each set, and the actions you can take from the panel based on the set's status. The details panel includes fields like Set ID, Document Set, Run Type, and Analysis Status, as well as buttons for running and viewing settings. The available actions, such as editing the set name, deleting the set, re-queuing the run, and viewing settings, vary depending on whether the set is completed, running, canceled, or in an exception state.

WHO CAN PERFORM:

To perform the actions described in this article, users need the Create and manage sets permission. To toggle overlay settings, users need the Overlay results permission. Note that the overlay is turned on by default, and users without the overlay permission cannot edit this setting while creating a set, meaning they cannot turn it off.

Details Panel

The details panel provides the following information about each set:

Set Information:

Set ID: A unique identifier assigned to the set.
Modified By: The name of the user who last modified the set.
Document Set: The saved search or document set used for this analytics run.

Algorithms:

Run Type: Indicates whether the set was run as a full build or an incremental build.
Algorithms in Set: The number of algorithms that were run as part of this set. A carrot icon next to this number allows you to expand the list and view which specific algorithms were used.

Analysis:

Analysis Status: The current status of the set’s analysis (e.g., Completed, Running, Exception).
Started: The date and time when the analysis began.
Completed: The date and time when the analysis was completed.
Doc Count: The number of documents included in the set.

Overlay:

Overlay Auto On: Indicates whether the overlay was automatically turned on.
Overlay Status: The current status of the overlay process (e.g., Completed, Running, Exception).
Document Count: The number of documents that were overlaid into the workspace.
Size: The total size of the overlaid documents.

The details panel includes two buttons at the bottom:

Run Set, which opens options for Run Full Build or Run Incremental Build.
View Settings, which opens the algorithm settings page.

At the top, next to the title of the set, there are:

Refresh button: Refreshes the details panel to show the latest status and information.
Vertical Ellipsis icon: Provides options to Edit Set Name and Delete Set.
X Icon: Closes the details panel.

Actions Available from the Details Panel

For Completed Sets

When the Analysis Status of a set is "Completed" , the following actions are available:

Edit Set Name: Displays the Edit Set Name modal window where you can update the set name.
Delete Set: Removes the set from the Sets list and deletes all related content and results.
Run Set:
- Run Full Build: Reruns the set as a full build, re-analyzing all documents in the saved search.
- Run Incremental Build: Runs the set as an incremental build, focusing on new documents added since the last build.
View Settings: Takes you to the algorithm settings page to view a read-only version of the settings for each algorithm in the set.

For Running/Waiting/Queued Sets in the Analysis Phase

When the Analysis Status of a set is "Running," "Waiting for Queue," "Queued," or "Waiting for Split/Merge," the following actions are available:

View Settings: Takes you to the algorithm settings page to view a read-only version of the settings for each algorithm in the set.
Edit Set Name: Displays the Edit Set Name modal window for updating the set name.
Cancel: Cancels the run. Once canceled, the set can be requeued, rerun as a full build, or deleted. While a set is canceling, only the View Settings option is available.

For Cancelled/Exception Sets in the Analysis Phase

When the Analysis Status of a set is "Cancelled" or "Exception," the following actions are available:

View Settings: Takes you to the algorithm settings page to view a read-only version of the settings for each algorithm in the set.
Run Full Build: Reruns the set as a full build, re-analyzing all documents in the saved search.
Re-queue: Re-queues the run to pick up where it left off, resuming the analysis from the point where the set was canceled or where the exception occurred.
Re-queue Incremental: Displays if this canceled/exception set was an incremental build.
Re-queue Update Mentions: Displays if this canceled/exception set was an update Mentions run.
Edit Set Name: Displays the Edit Set Name modal window where you can update the set name.
Delete Set: Removes the set from the list of Sets and deletes all related content and results.

For Running/Waiting/Queued Sets in the Overlay Phase

When the Overlay Status of a set is "Running," "Waiting for Queue," "Queued," or "Waiting for Split/Merge," the following actions are available:

View Settings: Takes you to the algorithm settings page to view a read-only version of the settings for each algorithm in the set.
Edit Set Name: Displays the Edit Set Name modal window where you can update the set name.
Delete Set: Removes the set from the Sets list and deletes all related content and results. If the set results were partially overlaid into the workspace, those partial results are also deleted.

NOTE: You cannot cancel a set while it is being overlaid.

For Exception Sets in the Overlay Phase

When the Overlay Status of a set is "Exception," the following actions are available:

View Settings: Takes you to the algorithm settings page to view a read-only version of the settings for each algorithm in the set.
Re-queue Overlay: Re-queues the overlay to pick up where it left off, resuming from the point where the exception occurred.
Edit Set Name: Displays the Edit Set Name modal window where you can update the set name.
Delete Set: Removes the set from the Sets list and deletes all related content and results. If the set results were partially overlaid into the workspace, those partial results are also deleted.

NOTE: If you re-queue an overlay several times and it continues to end in an exception, you may need to contact an administrator for support.