Integrating Oracle DB | DataGrail Documentation

Capabilities

DataGrail's Oracle DB integration provides the following capabilities:

Before You Start

To successfully configure this integration, please ensure you have sufficient privileges:

• DataGrail User Role: Super Admin, Connections Manager
• Oracle DB User Role: Admin
• Secrets Manager: Write Access

Connecting with RM Agent

The Request Manager Agent allows you to automate Data Subject Requests by connecting to internal systems within your network, without requiring ingress from the public network.

The Agent connects to your Oracle DB instance using least privileged credentials that you will create and store in a secrets manager. When configuring the Oracle DB integration in DataGrail, only the location of that secrets manager entry will be referenced (e.g., AWS Secrets Manager ARN), ensuring that no secrets are shared directly with DataGrail.

Prerequisites

Before you can connect to Oracle DB, ensure the following:

• RM Agent is deployed and connected in DataGrail.
• Network is configured to allow the Agent to connect with the Oracle DB instance.

Create and Store Credentials

1. In Oracle DB, create a new user for the agent. Only grant the minimum necessary permissions for executing the request.

2. Configure the following JSON key-value pairs:

   {
      "user": "<agent user>",
      "password": "<agent password>",
      "server": "<server domain name or IP address>",
      "port": "<port, e.g. 1521>",
      "database": "<database name>"
   }

3. Store the JSON value in your secrets manager with an entry name like datagrail.rm-agent.oracle.

4. Ensure that the agent is configured to retrieve the value of this secrets manager entry.

Add the Agent Integration

1. In DataGrail, navigate to Agents and select your Agent.
2. In the top right, select Add New Integration and search for Oracle DB.
3. Under Enabled Capabilities and Enabled Identifiers, select only those that will be used for this integration.
4. Enter the Credentials Location (e.g. AWS Secrets Manager ARN).
5. Select the Data Retrieval behavior for deletion requests.

Warning: When using Retrieve Data, the data reviewed may not be exactly what is deleted due to the access and deletion logic executing separately!

6. Under Agent Query Configuration, add request logic to be executed within Oracle DB for all enabled request types.

Query Parameter Format: Use named paramstyle when formatting query parameters with identifiers (e.g., email, user_id).

Example:

SELECT * FROM users WHERE email = :email

7. Finally, select Configure Integration. Wait a few moments to ensure that the connection is successful. For failed connections, review the Agent container logs for additional details.

Troubleshooting

If you are unable to successfully connect the integration, review these common troubleshooting steps:

• Agent Unable to Connect to Oracle DB:

  1. Verify that the network is configured to allow the Agent to connect with the Oracle DB instance.
  2. Verify the Agent has permissions to access the Oracle DB credentials stored in your vault.

• Agent is Not Connected in DataGrail:

  1. Confirm that the Agent is running, and logs do not indicate any errors.
  2. The DataGrail API Key used by the Agent is valid and not expired.
  3. The Agent has permissions to access the DataGrail API Key stored in your vault.
  4. Network egress is permitted from the Agent to your DataGrail domain.

Technical Details

Need help?

If you have any questions, please reach out to your dedicated Account Manager or contact us at support@datagrail.io.

Disclaimer: The information contained in this message does not constitute legal advice. We would advise seeking professional counsel before acting on or interpreting any material.