Integrate with Claude Compliance Data in JReport Designer

The CData JDBC Driver for Claude Compliance data enables access to live data from dashboards and reports as if Claude Compliance were a relational database, allowing you to query Claude Compliance data using familiar SQL queries. This article shows how to connect to Claude Compliance data as a JDBC data source and create reports based on Claude Compliance data in JReport Designer.

Connect to Claude Compliance Data

1. Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

   ...
   set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Claude Compliance 2016\lib\cdata.jdbc.claudecompliance.jar;
   ...
   

2. Create a new data source by clicking File New Data Source.
3. In the resulting dialog, create a name for the data source (CData JDBC Driver for Claude Compliance), select JDBC, and click OK.
4. In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
   • Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:

     cdata.jdbc.claudecompliance.ClaudeComplianceDriver

   • URL: Enter the JDBC URL. This starts with jdbc:claudecompliance: and is followed by a semicolon-separated list of connection properties.

     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.

     Below is a typical JDBC URL:

     jdbc:claudecompliance:APIKey=your_compliance_access_key;

   • User: The username to authenticate with; typically left blank.
   • Password: The password to authenticate with; typically left blank.
   

5. In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.

   

   Click Done once the dialog has completed loading the tables.

6. In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Claude Compliance), right-click on Queries, and select Add Query.
7. In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK.
8. In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:

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

   

   With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Claude Compliance data to a new or existing report.

   NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.

Add Claude Compliance Data to a Report

You are now ready to create a report with Claude Compliance data.

1. Create a new report (File New Page Report) or open the Chart Wizard for an existing report.
2. Select the Query (or create a new one; see above).

3. Assign a Category and Value for the chart from the columns in your Query and click Finish.

4. Click the View tab for your report to see the chart.