Manage Factorial Data in DBArtisan as a JDBC Source

The CData JDBC Driver for Factorial seamlessly integrates Factorial data into database management tools like DBArtisan by enabling you to access Factorial data as a database. This article shows how to create a JDBC source for Factorial in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate Factorial Data into DBArtisan Projects

Follow the steps below to register Factorial data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory. 👁 The JDBC driver definition in the Register Datasource wizard. (Salesforce is shown.)
   
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   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.

   👁 Required JDBC connection properties in the Register Datasource wizard. (Salesforce is shown.)
   

   Below is a typical connection string:

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

6. Finish the wizard to connect to Factorial data. Factorial entities are displayed in the Datasource Explorer.

You can now work with Factorial data as you work with any other database. See the driver help documentation for more information on the queries supported by the Factorial API.