Connect to Okta in SpagoBI

The CData JDBC Driver for Okta enables you to connect to live Okta data from business intelligence and data mining tools that support the JDBC standard. This article shows how to integrate Okta data into a report in SpagoBI Studio and host it on SpagoBI Server.

• Deploy the Driver in SpagoBI Server
• Create a Report in SpagoBI Studio
• Host Okta Reports on SpagoBI Server

Deploy the JDBC Driver in SpagoBI Server

Follow the steps to create a JDBC data source for Okta in SpagoBI Server.

1. Copy the driver JAR into %CATALINA_BASE%/lib. These files are located in the lib subfolder of the installation directory.

2. Add a Okta driver resource to the context. The following resource definition can be added to the GlobalNamingResources element in server.xml: <Resource name="jdbc/okta" auth="Container" type="javax.sql.DataSource" driverclassname="cdata.jdbc.okta.OktaDriver" factory="org.apache.tomcat.jdbc.pool.DataSourceFactory" maxactive="20" maxidle="10" maxwait="-1"/>

3. Add the following resource link to give access to Web applications. For this article, add the following line to META-INF\context.xml for SpagoBI. <ResourceLink global="jdbc/okta" name="jdbc/okta" type="javax.sql.DataSource"/>
4. Restart the server.

After adding the driver to the resources for the SpagoBI server, add the data source: In SpagoBI, click Resources -> Data Source -> Add and enter the following information:

• Label: Enter a unique identifier for the driver.
• Description: Enter a description for the driver.
• Dialect: Select Default Dialect.
• Read Only: Select the read-only option. This option determines whether the data source is the default database to save datasets created by the end user.
• Type: Select JDBC.
• URL: Enter the JDBC URL using the required connection string properties:

  To connect to Okta, set the Domain connection string property to your Okta domain.

  You will use OAuth to authenticate with Okta, so you need to create a custom OAuth application.

  Creating a Custom OAuth Application

  From your Okta account:

  1. Sign in to your Okta developer edition organization with your administrator account.
  2. In the Admin Console, go to Applications > Applications.
  3. Click Create App Integration.
  4. For the Sign-in method, select OIDC - OpenID Connect.
  5. For Application type, choose Web Application.
  6. Enter a name for your custom application.
  7. Set the Grant Type to Authorization Code. If you want the token to be automatically refreshed, also check Refresh Token.
  8. Set the callback URL:
     • For desktop applications and headless machines, use http://localhost:33333 or another port number of your choice. The URI you set here becomes the CallbackURL property.
     • For web applications, set the callback URL to a trusted redirect URL. This URL is the web location the user returns to with the token that verifies that your application has been granted access.
  9. In the Assignments section, either select Limit access to selected groups and add a group, or skip group assignment for now.
  10. Save the OAuth application.
  11. The application's Client Id and Client Secret are displayed on the application's General tab. Record these for future use. You will use the Client Id to set the OAuthClientId and the Client Secret to set the OAuthClientSecret.
  12. Check the Assignments tab to confirm that all users who must access the application are assigned to the application.
  13. On the Okta API Scopes tab, select the scopes you wish to grant to the OAuth application. These scopes determine the data that the app has permission to read, so a scope for a particular view must be granted for the driver to have permission to query that view. To confirm the scopes required for each view, see the view-specific pages in Data Model < Views in the Help documentation.

  Built-in Connection String Designer

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

  java -jar cdata.jdbc.okta.jar

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

  A typical JDBC URL is below:

  jdbc:okta:Domain=dev-44876464.okta.com;InitiateOAuth=GETANDREFRESH
• Driver: Enter the class name for the driver: cdata.jdbc.okta.OktaDriver

Create Reports in SpagoBI Studio

Follow the steps below to populate reports based on Okta data in SpagoBI Studio. You will create a dataset that populates a chart with the results of an SQL query. In the next section, you will host this report on SpagoBI Server.

First, you will need to connect to Okta data from a report in SpagoBI Studio:

1. In SpagoBI Studio, click File -> New -> Project and select Report Project in the Business Intelligence and Reporting Tools folder.
2. Click File -> New -> Report and select Blank Report.
3. In the Data Explorer view, right-click Data Sources and click New Data Source.
4. Select JDBC Data Source and enter a name for the data source.
5. Click Manage Drivers and click Add to add the driver JAR, cdata.jdbc.okta.jar. The driver JAR is located in the lib subfolder of the installation directory.
6. In the Driver Class menu, select the driver class, cdata.jdbc.okta.OktaDriver.
7. In the Database URL box, enter the JDBC URL. A typical JDBC URL is below: jdbc:okta:Domain=dev-44876464.okta.com;InitiateOAuth=GETANDREFRESH See the "Getting Started" chapter of the driver help for a guide to obtaining the required connection properties.

After you have connected to Okta data, create a dataset that contains the results of an SQL query:

1. Right-click the DataSet folder and click New Data Set. Select the JDBC data source for Okta and enter a name for the dataset.
2. Build the SQL query. In this example, this query will be used to add a chart to the dashboard. For example: SELECT Id, ProfileFirstName FROM Users WHERE Status = 'Active'

You can use the dataset to populate report objects. Follow the steps below to create a chart.

1. In the Palette view, drag a chart onto the canvas.
2. In the Select Chart Type tab, select a bar chart.
3. In the Select Data tab, click the Use Data From option and select the Okta data set from the menu.
4. Drag Id from the table to the series for the x-axis.
5. Drag ProfileFirstName from the table to the series for the y-axis.

Host Okta Reports on SpagoBI Server

Follow the steps below to host documents based on live Okta data on SpagoBI Server. You will use the report you created in the previous section as a template. To enable report users to access the live data, create placeholder parameters to be replaced by the Okta JDBC data source on the server:

1. If you have not already done so, open the Report Design perspective in SpagoBI Studio.
2. In the Data Explorer view, right-click the Report Parameters folder and click New Parameter. Add the url parameter and assign an empty value to it. This parameter is a placeholder for the JDBC data source on the SpagoBI Server.
3. Right-click the Okta data source and click Edit.

4. In the Property Binding node, set the JDBC Driver URL binding property to the url parameter: Click the box for the property. In the Category section, select Report Parameters. Select All in the Subcategory section and double-click the parameter.

   You can also enter the following in the JavaScript syntax:

   params["url"].value

Next, create a new document for the report on SpagoBI Server.

1. In SpagoBI Server, click Documents Development -> Create Document -> Generic Document. The Document Details page is displayed.
2. To create the document, enter the following:
   • Label: Enter a unique identifier for the document.
   • Name: Enter a user-friendly name for the document.
   • Type: Select Report from the menu.
   • Engine: Select BIRT Report Engine.
   • Data Source: Select the Okta Data Source you created in Create a JDBC Data Source for Okta in SpagoBI Server.
3. In the Show Document Templates section, select the folder where you want the document to be stored.

4. In the Template section, click Choose File. Navigate to the folder containing your report project. Select the .rptdesign file.

   Note: You can find the path to the project in the project properties.

5. Click the Save button.

When you run the report on the server, the placeholder url parameter is replaced with the JDBC URL defined on the server.