Learn more
 

Ready to get started?

Download a free trial of the Jira Service Desk ODBC Driver to get started:

 Download Now

Learn more:

Jira Service Desk Icon Jira Service Desk ODBC Driver

The Jira Service Desk ODBC Driver is a powerful tool that allows you to connect with live data from Jira Service Desk, directly from any applications that support ODBC connectivity.

Access Jira Service Desk data like you would a database - read, write, and update Jira Service Desk Customers, Organizations, Requests, etc. through a standard ODBC Driver interface.

In this article

Related articles

Replicate Jira Service Desk Data from PowerShell


Write a quick PowerShell script to query Jira Service Desk data. Use connectivity to the live data to replicate Jira Service Desk data to SQL Server.



The CData ODBC Driver for Jira Service Desk enables out-of-the-box integration with Microsoft's built-in support for ODBC. The ODBC driver instantly integrates connectivity to the real Jira Service Desk data with PowerShell.

You can use the .NET Framework Provider for ODBC built into PowerShell to quickly automate integration tasks like replicating Jira Service Desk data to other databases. This article shows how to replicate Jira Service Desk data to SQL Server in 5 lines of code.

You can also write PowerShell code to execute create, read, update, and delete (CRUD) operations. See the examples below.

Create an ODBC Data Source for Jira Service Desk

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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, you will need to 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.

Connect to Jira Service Desk

The code below shows how to use the DSN to initialize the connection to Jira Service Desk data in PowerShell:

$conn = New-Object System.Data.Odbc.OdbcConnection $conn.ConnectionString = "DSN=CData JiraServiceDesk Source x64"

Back Up Jira Service Desk Data to SQL Server

After you enable caching, you can use the code below to replicate data to SQL Server.

Set the following connection properties to configure the caching database:

  • CacheProvider: The name of the ADO.NET provider. This can be found in the Machine.config for your version of .NET. For example, to configure SQL Server, enter System.Data.SqlClient.

  • CacheConnection: The connection string of properties required to connect to the database. Below is an example for SQL Server:

    Server=localhost;Database=RSB;User Id=sqltest;Password=sqltest;

The SQL query in the example can be used to refresh the entire cached table, including its schema. Any already existing cache is deleted.

$conn.Open() # Create and execute the SQL Query $SQL = "CACHE DROP EXISTING SELECT * FROM " + $Requests $cmd = New-Object System.Data.Odbc.OdbcCommand($sql,$conn) $count = $cmd.ExecuteNonQuery() $conn.Close()

The driver gives you complete control over the caching functionality. See the help documentation for more caching commands and usage examples. See the help documentation for steps to replicate to other databases.

Other Operations

To retrieve Jira Service Desk data in PowerShell, call the Fill method of the OdbcDataAdapter method. To execute data manipulation commands, initialize the OdbcCommand object and then call ExecuteNonQuery. Below are some more examples CRUD commands to Jira Service Desk through the .NET Framework Provider for ODBC:

Retrieve Jira Service Desk Data

$sql="SELECT RequestId, ReporterName from Requests" $da= New-Object System.Data.Odbc.OdbcDataAdapter($sql, $conn) $dt= New-Object System.Data.DataTable $da.Fill($dt) $dt.Rows | foreach { $dt.Columns | foreach ($col in dt{ Write-Host $1[$_] } }

Update Jira Service Desk Data

$cmd = New-Object System.Data.Odbc.OdbcCommand("UPDATE Requests SET CurrentStatus='Open' WHERE Id = @myId", $conn) $cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myId","001d000000YBRseAAH") $cmd.ExecuteNonQuery()

Insert Jira Service Desk Data

$cmd = New-Object System.Data.Odbc.OdbcCommand("INSERT INTO Requests SET CurrentStatus='Open' WHERE Id = @myId", $conn) $cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myId","001d000000YBRseAAH") $cmd.ExecuteNonQuery()

Delete Jira Service Desk Data

$cmd = New-Object System.Data.Odbc.OdbcCommand("DELETE FROM Requests WHERE Id = @myid", $conn) $cmd.Parameters.Add(new System.Data.Odbc.OdbcParameter("myId","001d000000YBRseAAH") $cmd.ExecuteNonQuery()