Connect to Zendesk Data in DigitalSuite Studio through RunMyProcess DSEC

The CData JDBC Driver for Zendesk implements JDBC Standards and enables a applications ranging from BI to IDE to connect with Zendesk. In this article, we describe how to connect to Zendesk data from Arkobi Digital RunMyProcess's DSEC and connect to Zendesk in RunMyProcess.

Setting up EnterpriseConnect Agent

Configure the EnterpriseConnect Agent following the EnterpriseConnect page in the RunMyProcess documentation.

Setting up JDBC Adapter

The JDBC Adapter section describes the steps to connect to RDBMS through JDBC. Follow the steps and open the JDBC.config file.

1. Create a JSON entry for the CData JDBC Driver for Zendesk, e.g. Zendesk = { "sqlDriver" : "...", "sqlSource" : "...", "sqlDriverPath" : "..." }
2. Set the "sqlDriver" field to the Class name for the CData JDBC Driver, e.g.
   cdata.jdbc.zendesk.ZendeskDriver
3. Set the "sqlSource" field to a JDBC URL for connecting to Zendesk, e.g.
   jdbc:zendesk:URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;InitiateOAuth=GETANDREFRESH

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.zendesk.jar

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

   Connecting to Zendesk

   To connect, set the URL and provide authentication. The URL is your Zendesk Support URL: https://{subdomain}.zendesk.com.

   Authenticating to Zendesk

   You can authenticate using the Basic or OAuth methods.

   Using Basic Authentication

   To use Basic authentication, specify your email address and password or your email address and an API token. Set User to your email address and follow the steps below to provide the Password or ApiToken.

   • Enable password access in the Zendesk Support admin interface at Admin > Channels > API.
   • Manage API tokens in the Zendesk Support Admin interface at Admin > Channels > API. More than one token can be active at the same time. Deleting a token deactivates it permanently.

   Using OAuth Authentication

   See the Getting Started guide in the CData driver documentation for an authentication guide.

4. Set the "sqlDriverPath" field to the name of the CData JDBC Driver JAR file, e.g.
   cdata.jdbc.zendesk.jar

Sample JDBC.config File

Put the JDBC driver JAR file (cdata.jdbc.zendesk.jar) into the same directory as unified-adapter-[version].jar.

Note: Make sure to put the CData license file (cdata.jdbc.zendesk.lic) into the same directory. Since the license is generated based on the unique identifier of the machine where the product in installed, you will need an offline activation if you want to put the file on another machine.

Starting DigitalSuite EnterpriseConnect Agent

In Windows, start RunMyProcess DigitalSuite EnterpriseConnect Agent in Windows services. To start the application through command line, see Starting the EnterpriseConnect Agent in the RunMyProcess documents.

Starting the JDBC Adapter

Start the JDBC Adapter from runAdapter.bat. Once the Adapter is running, you can access the application through the agent address (e.g. 127.0.0.1:8080). Below is an example executing the command in Windows.

Once the DigitalSuite EnterpriseConnect Agent and JDBC Adapter are running, access http://localhost:(specified-port-number)/ through your browser to open the page shown below.

Check the availability of the JDBC Adapter using tools such as Postman or cURL. Here, we use Postman to send the HTTP POST request.

Configure the RequestHeader as follows:

Configure the RequestBody as follows:

If the JDBC.config file contains credential information, sqlUsername and sqlPassword can be left empty. If you are not sure of the table name, you can retrieve the list of tables using the request SELECT * FROM sys_tables

The request is successful if the Status is 200 and the Body contains Zendesk data in JSON format.

Connect to Zendesk through DSEC Agent in DigitalSuite Studio

Create a DigitalSuite Studio project and then create a Provider in the project.

• URL: The URL for accessing JDBC Agent (e.g. http:localhost:8080/)
• Authentication Scheme: Login/password
• Login: The value from agent.user in the application.properties file
• Password: agent.password in the application.properties file
• Secured: Checked
• Use DigitalSuite EnterpriseConnect: Checked
• With domain: The value from agent.domain in application.properties file

Next, create a Connector in the Provider.

• Connector URL: Leave this empty
• Architecture: REST/XML-RPC
• Method: POST
• Result format: JSON
• Accept media type: application/json
• Character set: Automatic
• Content: Same as the Request body used in the JDBC Adapter
• Content type: application/json

The JSON data we used as the Request body in JDBC Adapter:

{ "protocol":"JDBC", "data":{ "DBType":"Zendesk", "sqlUsername":"", "sqlPassword":"", "sqlStatement":"SELECT * FROM Tickets" } }

Open Launch Test to perform the test. The test is successful if Zendesk data is shown in Result on the right pane.

Now you can use Zendesk data in RunMyProcess DigitalSuite Studio through DSEC.

For the detailed information on supported SQL commands, refer to the SQL Compliance section in our help documentation. For information on tables, refer to the Data Model section.