How to connect to Factorial Data from IntelliJ

The CData JDBC Driver for Factorial enables you to access Factorial as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Factorial data in IntelliJ.

Create a JBDC Data Source for Factorial

Follow the steps below to add the driver JAR and define connection properties required to connect to Factorial data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

     Authentication

     Factorial uses OAuth 2.0 for authentication to connect to your HR data or to allow other users to connect to their data.

     Using OAuth Authentication

     To connect using OAuth, follow these steps:

     1. Navigate to your Factorial admin panel and create a new OAuth application.
     2. Copy the Client ID and Client Secret from your application configuration.
     3. Configure the following connection properties:

     After setting the following connection properties, you are ready to connect:

     • AuthScheme: Set this to OAuth.
     • OAuthClientId: Set this to your OAuth Client ID.
     • OAuthClientSecret: Set this to your OAuth Client Secret.
     • Scope: Set this to specify the data access permissions (default: "read write").

     Built-in Connection String Designer

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

     java -jar cdata.jdbc.api.jar
     

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

     

     A typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\Factorial.apip;AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

Edit and Save Factorial Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.