Design BIRT Reports on Claude Compliance Data

The CData JDBC Driver for Claude Compliance integrates connectivity to Claude Compliance APIs into your data-driven Java applications. You can use the CData JDBC Driver for Claude Compliance with the BIRT (Business Intelligence Reporting Tools) platform to create BIRT reports that reflect changes to your data in real time.

1. If you have not already done so, install the BIRT Framework plugin and the Database Development plugin for Eclipse.
2. Click File -> New -> Report. The Report Design perspective is opened.
3. In the Data Explorer, right-click Data Sources and click New Data Source.
4. Select the Create from a Data Source Type in the Following List option and select JDBC Data Source.
5. Click Manage Drivers and add the driver JAR, located in the lib subfolder of the installation folder.
6. In the Database URL box, enter the JDBC URL containing the connection string.

   The driver connects to Claude Compliance using a Compliance Access Key, the only supported authentication method. Set the following connection property:

   • APIKey: The Compliance Access Key you created.

   Creating a Compliance Access Key

   1. Enable the Compliance API for your organization.
   2. Sign in to claude.ai as a primary owner or organization owner and open Organization settings > API > Keys.
   3. Select Create Key and assign only the scopes your integration needs:
      • read:compliance_activities for Activities and the typed activity views.
      • read:compliance_org_data for organizations, roles, groups, and settings.
      • read:compliance_user_data for users, chats, files, projects, and downloads.
      • delete:compliance_user_data for the explicit Delete stored procedures.
   4. Create the key and copy it when it appears. The key starts with sk-ant-api01- and is shown only once.

   Optionally, set OrganizationUUID to limit organization-scoped views (such as OrganizationUsers and ComplianceRoles) to a single linked organization. If it is left empty, those views default to the first available organization and do not include data from all linked organizations.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Claude Compliance JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   
   java -jar cdata.jdbc.claudecompliance.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical JDBC URL is below:

   
   jdbc:claudecompliance:APIKey=your_compliance_access_key;
   

7. Right-click the Data Sets folder and select the JDBC data source for Claude Compliance.
8. In the resulting dialog, build the SELECT query to be used to retrieve the data for the report. This article uses the following query:

   
   SELECT Id, Name FROM Projects WHERE OrganizationUuid = 'abcdef01-2345-6789-abcd-ef0123456789'
   

9. In the Palette, drag a Chart onto the editor. The chart wizard is displayed.
10. After selecting the chart type, drag columns onto the chart fields on the Select Data tab.
11. Click Run -> View Report -> In Web Viewer to view the report.

Your BIRT reports can now pick up any updates to Claude Compliance data.

To publish the report to your application server, add the driver JAR to the BIRT Viewer's classpath. For more information, see the CData KB for guides to deploying the JDBC Driver on Java application servers.