Replicate Multiple Jira Service Management Accounts via the CData Sync CLI

CData Sync for Jira Service Management is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple Jira Service Management connections. In this article we show how to use the CLI to replicate multiple Jira Service Management accounts.

Configure Jira Service Management Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple Jira Service Management accounts, use multiple configuration files. Below is an example configuration to replicate Jira Service Management to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
 <DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>System.Data.SQLite</DatabaseProvider>
 <ConnectionString>ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
 <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime>
 <TaskSchedulerInterval>Never</TaskSchedulerInterval>
</CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?>
<CDataSync>
<DatabaseType>SQLite</DatabaseType>
 <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider>
 <ConnectionString>ApiKey=myApiKey;User=MyUser;InitiateOAuth=GETANDREFRESH;</ConnectionString>
 <ReplicateAll>False</ReplicateAll>
 <NotificationUserName></NotificationUserName>
 <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString>
</CDataSync>

You can establish a connection to any Jira Service Desk Cloud account or Server instance.

Connecting with a Cloud Account

To connect to a Cloud account, you'll first need to retrieve an APIToken. To generate one, log in to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.

Supply the following to connect to data:

• User: Set this to the username of the authenticating user.
• APIToken: Set this to the API token found previously.

Connecting with a Service Account

To authenticate with a service account, supply the following connection properties:

• User: Set this to the username of the authenticating user.
• Password: Set this to the password of the authenticating user.
• URL: Set this to the URL associated with your JIRA Service Desk endpoint. For example, https://yoursitename.atlassian.net.

Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.

Accessing Custom Fields

By default, the connector only surfaces system fields. To access the custom fields for Issues, set IncludeCustomFields.

Configure Queries for Each Jira Service Management Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the Jira Service Management API. The statement below caches and incrementally updates a table of Jira Service Management data:

REPLICATE Requests;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple Jira Service Management accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Requests SELECT * FROM Requests 

Alternatively, you can use a different schema:

REPLICATE PROD.Requests SELECT * FROM Requests

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

JiraServiceDeskSync.exe -g MyProductionJiraServiceDeskConfig.xml -f MyProductionJiraServiceDeskSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar JiraServiceDeskSync.jar -g MyProductionJiraServiceDeskConfig.xml -f MyProductionJiraServiceDeskSync.sql