Establishing a Connection

Creating a JDBC Data Source

You can create a JDBC data source to connect from your Java application. Creating a JDBC data source based on the CData JDBC Driver for Acumatica consists of three basic steps:

Add the driver JAR file to the classpath. The JAR file is located in the lib subfolder of the installation directory. Note that the .lic file must be located in the same folder as the JAR file.
Provide the driver class. For example:
```
cdata.jdbc.acumatica.AcumaticaDriver
```
Provide the JDBC URL. For example:
```
jdbc:acumatica:Url = https://try.acumatica.com/ISV/;EndpointName=Default;EndpointVersion=24.200.001;User=user;Password=password;Company=CompanyName;

or

jdbc:cdata:acumatica:Url = https://try.acumatica.com/ISV/;EndpointName=Default;EndpointVersion=24.200.001;User=user;Password=password;Company=CompanyName;
```
You can use the second format above whenever there is a conflict in your application between drivers using the same URL format to ensure you are using the CData driver. The URL must start with either "jdbc:acumatica:" or "jdbc:cdata:acumatica:" and can include any of the connection properties in name-value pairs separated with semicolons.

Connecting to Acumatica

In order to connect to the Acumatica data source, you must specify the following connection properties.

URL: (Required) The base URL for the Acumatica ERP instance. For example: https://domain.acumatica.com/.
Schema: (Optional) There are two schemas that contain different data. The default one is REST, which uses the Acumatica REST Contract-Based API, and the OData schema, which uses the Acumatica OData API. The OData schema is used to query Acumatica Generic Inquiries.
Company: (Partially required) Set this to the name of your company or tenant. It is required if Schema is set to OData.
EndpointVersion: (Optional) The version of the Web Services endpoint. For example: 24.200.001. This applies only to the REST schema.
EndpointName: (Optional) The name of the Web Services endpoint. For example: Default. This applies only to the REST schema.

To find out the EndpointVersion and EndpointName for your Acumatica instance, log into Acumatica in a web browser, and then navigate to the Web Service Endpoints page. If necessary, navigate to this page by editing the web browser URL and replacing ScreenId=00000000 (the homepage) with ScreenId=SM207060. If you are redirected back to the homepage, this means your user does not have the necessary permissions to access web services. Under Endpoints properties get the Endpoint Name and Endpoint Version.

Exposing Generic Inquiries

The driver is capable of discovering generic inquiry data as tables and views. However, you must first extend the Web Services Endpoint to expose them.

The process for exposing generic inquiries is different depending on the schema specified in the Schema connection property.

REST Schema

Generic Inquiries are not exposed via REST by default. To expose them:

Navigate in the Acumatica UI to Integration > Show All > Web Service Endpoints.
Click the "Default" endpoint with the most recent Endpoint Version.
From the available action buttons (in the button bar below the endpoint name at the top of the page), click EXTEND ENDPOINT.
- You may have to find this action in the full action list, which you can view by clicking the "..." button.
Use Endpoint Name to name the extended endpoint and Endpoint Version to specify the endpoint version you want it to have, then click OK.
On the page for your new extended endpoint, click the + Insert button (above the ENDPOINT tree structure).
Create an entity definition for a new custom object as follows.
- Name the object in the Object Name field.
- Leave the Object Type field set to the default -- Top-Level.
- In the Screen Name field, click the magnifying glass icon to search for the screen associated with your generic inquiry. Select the screen matching the Site Map Title field of your generic inquiry.
  - Ensure that the autopopulated Screen ID field's value matches that of your generic inquiry.
- Click OK.
Create a new "Results" entity under your custom object as follows:
- Select the newly created object in the ENDPOINT tree structure, then click the + Insert button.
- Set Field Name to "Result".
- Specify a name for this object in Object Name.
- Set Object Type to Detail.
- Click OK.
In the ENDPOINT tree structure, expand the node for your custom object, select the new Results object you just created, then click FIELDS > POPULATE.
In the Populate Field window's Object field, select "Result" (the object you just created).
Select the check box for each field you want to expose from the general inquiry, then click OK.
To see the exposed general inquiry in your table list, set EndpointName to the name of your extended endpoint and set InquiryTables to the name of your top-level custom object from step 6 above.

OData Schema

Generic Inquiries are not exposed via OData by default. To expose them, navigate in the Acumatica UI to Customization > Profiles > Generic Inquiry and select the Expose via OData checkbox.

Authenticating to Acumatica

There are two authentication methods available for connecting to Acumatica data source, Basic and OAuth.

User Credentials

Set the AuthScheme to Basic and set the User and Password to your login credentials.

OAuth

OAuth requires the authenticating user to interact with Acumatica using the browser, so all OAuth flows require a custom OAuth application. Also, for all flows, set AuthScheme to OAuth. The following sections assume that you have done so.

Desktop Applications

CData provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

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

InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
OAuthClientId: Set this to the client Id in your application settings.
OAuthClientSecret: Set this to the client secret in your application settings.
CallbackURL: Set this to the Redirect URL in your application settings.

When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

Extracts the access token from the callback URL and authenticates requests.
Obtains a new access token when the old one expires.
Saves OAuth values in OAuthSettingsLocation that persist across connections.

Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Acumatica. See Creating a Custom OAuth App for more information about custom applications. You can then use the driver to acquire and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the client Id in your application settings.
OAuthClientSecret: Set this to the client secret in your application settings

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the callback URL you specified in your application settings. If necessary, set the Scope parameter to request custom permissions.
The stored procedure returns the URL to the OAuth endpoint.
Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL. If necessary, set the Scope parameter to request custom permissions.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following for the first data connection:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the client Id in your application settings.
OAuthClientSecret: Set this to the client secret in your application settings.
OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: Set this to the location where the driver saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

OAuthClientId: Set this to the client Id in your application settings.
OAuthClientSecret: Set this to the client secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After retrieving the new tokens, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.