Bulk actions
Bulk actions allow users to perform actions on documents returned by the search queries of a Solr index. This allows for batches of documents to be processed from an index instead of needing to manually apply actions to them and affects those present through both HCP and S3 Compatible connectors.
The query will include any query settings or additional refinements and facet selections applied from within the Search App.
Creating bulk actions
The query will include any query settings or additional refinements and facet selections applied from within the Search App.
To create a bulk action:
Procedure
In the Search App, select your index from the All dropdown on the left-hand of the search bar.
The Create Bulk Action button (
) appears on the right-hand of the search bar.NoteCreate Bulk Action only appears if:- Bulk actions are enabled in the query settings of an index.
- An index is available and selected. If a user only has a single index, the All dropdown is not displayed and their index is chosen by default.
Click Create Bulk Action.
The Create Bulk Action menu appears.In the Description field, enter a brief description of the bulk action (optional).
From the Bulk Action dropdown, select an action (required).
- HCP Apply Hold: For each query result, this action applies hold to the corresponding HCP objects.
- HCP Clear Hold: For each query result, this action clears hold to the corresponding HCP objects.
- HCP Delete: For each query result, this action deletes the corresponding HCP objects.
- HCP Privileged Purge: For each query result, this action completes a privileged purge of the corresponding HCP objects. An additional config property to log a reason for this privileged delete is required.
- HCP Privileged Delete: For each query result, this action completes a privileged delete of the corresponding HCP object). An additional config property to log a reason for this privileged delete is required.
- HCP Purge: For each query result, this action purges the corresponding HCP objects.
- HCP Set Retention: For each query result, this action sets retention on the corresponding HCP objects. An additional config property to log a reason for this privileged delete is required.
- S3 Compatible Apply Hold: For each query result, this action applies hold to the corresponding S3 objects.
- S3 Compatible Clear Hold: For each query result, this action clears the hold on the corresponding S3 objects.
- S3 Compatible Delete Objcet: For each query result, this action deletes the corresponding S3 objects.
- S3 Compatible Set Retention: For each query result, this action sets retention on the corresponding S3 objects.
- Retention Mode: Selecting GOVERNANCE protects an object from being overwritten or deleted by users without admin permissions. Selecting COMPLIANCE protects an object from being overwritten or deleted by any user, including the root user. A retention mode must be selected in order to use this bulk action.
- Retention Period: The retain until date that protects the object version until the retention period expires.
- S3 Compatible Set Tags: For each query result, this action sets the specified tag on the corresponding S3 objects.
- Maintain Existing Unspecified Tags: If enabled (default), this setting maintains any existing tags that do not match the metadata prefix property. If disabled, the tags are deleted.
- Use version id: If enabled, tags can be set on an object for a specific version ID. If disabled (default), the latest version ID will be used.
- Tags to set: The name value pairs to be used as tags on the corresponding S3 objects.
Click Create.
The bulk action is created and a confirmation message appears.To view your bulk action, click your username at the top-right corner of the window and select Bulk Action Status. For more information on status, see Bulk action status.
The Bulk Action List page appears and displays all of your bulk actions.
Next steps
Deleting bulk actions
To delete a bulk action:
Procedure
Click your username at the top-right corner of the window and select Bulk Action Status.
The Bulk Action List page appears and displays all of your bulk actions.Navigate to your listed bulk action and then click Delete.
Bulk action status
Bulk action status can be viewed by clicking on your username at the top-right corner of the window and then selecting Bulk Action Status. The Bulk Action List page then appears and displays all of your bulk action information.
The status of your bulk action is automatically updated as it is applied, from Pending to Running to Completed. To manually refresh the status to see the current number of processed documents, click the Bulk Action List refresh button.
The following status information is available for all bulk actions:
- Dropped: The total number of documents that the bulk action dropped.
- Failure: The total number of documents which the bulk action has failed.
- Index: The index the query is being run against.
- Input: The total number of documents which the bulk action has seen.
- Status: The status of the underlying workflow.
- Query: The query string used by the bulk action.NoteDocuments acted upon by the bulk action will be those returned from this query at the time the bulk action was created.