Data Discovery & Risk Insights 26.3.0 Help Center

# API-based custom activities

You can use the OpenText Core Data Discovery & Risk Insights APIs to enable and configure custom action processing that is not native to opentext core.

## Use cases

The following are potential use cases for using the APIs to support custom actions.

- You want to generate a list of sensitive documents to handover to File Governance Suite (FGS) File Report to generate a file access report.

- Currently, redaction is not supported internally. You want to mark a workbook for external processing and then carry out the redaction task on the binary files through a 3rd party product.

- You want to protect sensitive documents using Microsoft AIP.

## Prerequisites

The following prerequisites must be met prior to using the external workflow APIs to support custom actions in OpenText Core Data Discovery & Risk Insights.

- Create API-based systems in Connect to define the custom actions.

- Create workspaces and workbooks in Manage and populate with the desired documents to be acted upon. The workspaces must have the custom action feature enabled.

- Initiate the custom action to the desired workbook. The custom action is initiated from the ACTIVITY tab of the workbook detail pane.

  Initiating the custom action flags the workbook as ready for the external action. The processing status for the workbook changes to Pending. The Pending status indicates that the data is ready to be picked up and processed. If desired, a new category could be defined to assign this data, allowing you to filter for this data later.

- Ensure the user that will be using the APIs and conducting the action in Manage meets the following requirements.

  - The user must be assigned one or more roles in Administration that include the following permissions.

    - Administration > API Developer permission

    - The user must be assigned a role in Administration that includes the Manage > customAction and the Workspace Security > customAction permissions.

    - The user must be assigned a role in Administration that includes the Manage > Search and view documents and the Workspace Security > Search and view documents permissions.

    - The user must be assigned a role in Administration that includes requires the ‘Search and view documents’ Manage and Workspace permissions.

    TIP: Permissions to access the API-based custom actions are created when the custom action system is created. The permissions display at the bottom of the Manage and Workspace Security role permissions in Administration but are not assigned to existing roles by default. For more information, see Roles.

  - For the individual workspace in which the desired workbook exists, the user must be assigned a role that includes the customAction permission. This is set on the Security page of the Create Workspace or Edit Workspace dialog.

Copyright 2019-2026 Open Text
Version 26.3.0 | Last updated July 2026
Connect
Marketplace
Learn
Support portal
Documentation
Contact
Submit or view service request