Data Discovery & Risk Insights 25.1.0 Help Center

# Custom adapters

IMPORTANT: Consult OpenText Core Data Discovery & Risk Insights support for guidance before creating custom adapters.

Custom adapters allow you to analyze and manage data that resides on systems outside of OpenText Core Data Discovery & Risk Insights default support. A custom adapter allows you to build a connection between OpenText Core Data Discovery & Risk Insights and any third-party data platform that offers programmatic connection using remote APIs or a client SDK.

You must create and deploy a dedicated OpenText Core Data Discovery & Risk Insights processing agent service using the agent’s custom adapter framework. This allows on-premises agents to interact with the data using the source’s specific connectivity protocols. You will define the custom adapter properties required to instantiate, configure, and operate the custom adapter service

Custom adapters can be edited as needed. Any changes you make to the custom adapters affect existing sources and datasets based on the custom adapter.

Custom adapters that are associated with a source cannot be deleted. You must remove the association to the source (delete the source) before you can delete the custom adapter. If associations exist, you are notified when you attempt to delete the custom adapter.

To create a custom adapter

1. From the primary navigation panel, click Sources > Custom Adapters.

   The Custom Adapters page opens.

2. Click NEW CUSTOM ADAPTER.

   The New Custom Adapter dialog opens.

3. Complete the General options for the new custom adapter.

   Option | Description
   --- | ---
   Type | Enter a name for the type of custom adapter. Limits: Maximum 20 characters, alpha-numeric and underscore only.
   Display Name | Enter a display name for the custom adapter. The display name is presented as a source type when creating a source. Limits: Maximum 50 characters.
   Adapter Port | Enter a valid port number to be used by the custom adapter.
   Icon | Set the icon to display for this custom adapter when it is enabled. Limits: Valid image file; will be resized to fit the space in the UI. Click UPLOAD to navigate to and select the desired icon.
   Disabled Icon | Set the icon to display for this custom adapter when it is disabled. Limits: Valid image file; will be resized to fit the space in the UI. Click UPLOAD to navigate to and select the desired icon.

   Click NEXT.

4. Optionally, add any desired Filter Types. The filter types represent document types to filter for as part of the adapter. Data items that match the defined filter types will be identified in datasets of the associated source and managed by OpenText Core Data Discovery & Risk Insights.

   Option | Description
   --- | ---
   [type] | (Optional) Type the name of the desired document type. Limits: Maximum 50 characters.

   To include additional filter types, click the add icon (); click the remove icon () to remove a filter type.

   Click NEXT.

5. Complete the Adapter Configuration options for the new custom adapter. These options will be applied to all sources that will be based on this custom adapter and cannot be modified at the source or dataset level. These options are not presented when you create a source based on a custom adapter.

   Option | Description
   --- | ---
   Encrypted | Specify whether the value for this option should be encrypted. Click the toggle to select () or deselect () the option. When enabled (selected), the values are encrypted and your entry is obfuscated (displays as ***) as you type the value for this option. When not enabled (deselected), the values are not encrypted and display as plain text as you type the value for this option. IMPORTANT: Fields that support encryption, such as passwords, should be encrypted. Verify that the defined fields for the third-party data repository support encryption.
   [name] | Enter a name for the custom configuration option. This represents the parameter name within the configuration of the third-party data repository. Limits: Maximum 50 characters.
   [value] | Enter a value to correspond to the configuration option

   To include additional adapter configurations, click the add icon (); click the remove icon () to remove an adapter configuration.

   Click NEXT.

6. Complete the Dataset Options for the new custom adapter. You will have the option of defining these options for any dataset that will be based on this custom adapter. These options are presented as part of the Primary Capture Rules when you create a dataset for a source that is based on a custom adapter.

   Option | Description
   --- | ---
   [name] | Enter a name for the dataset option. This represents the parameter name within the configuration of the third-party data repository. Limits: Maximum 50 characters.
   [display name] | Enter a display name to correspond to the dataset option. The display name is presented as the option in the Primary Capture Rules when you create a dataset. Limits: Maximum 50 characters.
   [selection type] | Select whether this option is presented in the dataset wizard as a Textbox (default), a Toggle, or as an Encrypted text box. If an encrypted text box, your entry for this option in the dataset wizard is obfuscated (displays as ***).
   [description] | Enter a description for this dataset option. The description is presented as a tip () for the option in the Primary Capture Rules when you create a dataset. Limits: Maximum 250 characters..

   To include additional dataset options, click the add icon ().

7. Click FINISH.

   The custom adapter is created and can be selected as a source type when creating a source.

To edit a custom adapter

1. On the Custom Adapters page, click the name of the custom adapter you want to edit.

   TIP: You can also click or hover over the row of the desired custom adapter and then click the edit icon ().

2. Edit the custom adapter as desired.

3. Click FINISH.

   The custom adapter is updated as well as all sources and datasets associated with this custom adapter.

To delete a custom adapter

1. On the Custom Adapters page, click or hover over the row for the custom adapter you want to delete.

   Action icons display in the right column.

2. Click the delete icon () associated with the desired custom adapter.

3. In the confirmation dialog, click YES to confirm the action.

   NOTE: If the custom adapter is associated with one or more sources, you will see a notification. You must review your sources and delete any associated datasets and sources before you can remove the selected custom adapter. Click OK to close the message.

   The selected custom adapter is deleted.

Copyright 2019-2025 Open Text
Version 25.1.0 | Last updated February 2025
Connect
Marketplace
Learn
Support portal
Documentation
Contact
Submit or view service request