PowerShell Scripting to Replicate Jira Service Desk Data to MySQL

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Jira Service Desk Data Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to Jira Service Desk. The Cmdlets allow users to easily read, write, update, and delete live data - just like working with SQL server.



Write a simple PowerShell script to replicate Jira Service Desk data to a MySQL database.

The CData Cmdlets for Jira Service Desk offer live access to Jira Service Desk data from within PowerShell. Using PowerShell scripts, you can easily automate regular tasks like data replication. This article will walk through using the CData Cmdlets for Jira Service Desk and the CData Cmdlets for MySQL in PowerShell to replicate Jira Service Desk data to a MySQL database.

After obtaining the needed connection properties, accessing Jira Service Desk data in PowerShell and preparing for replication consists of four basic steps.

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.

Collecting Jira Service Desk Data

  1. Install the module:

    Install-Module JiraServiceDeskCmdlets
  2. Connect to Jira Service Desk:

    $jiraservicedesk = Connect-JiraServiceDesk -ApiKey $ApiKey -User $User
  3. Retrieve the data from a specific resource:

    $data = Select-JiraServiceDesk -Connection $jiraservicedesk -Table "Requests"

    You can also use the Invoke-JiraServiceDesk cmdlet to execute pure SQL-92 statements:

    $data = Invoke-JiraServiceDesk -Connection $jiraservicedesk -Query 'SELECT * FROM Requests WHERE CurrentStatus = @CurrentStatus' -Params @{'@CurrentStatus'='Open'}
  4. Save a list of the column names from the returned data.

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name

Inserting Jira Service Desk Data into the MySQL Database

With the data and column names collected, you are ready to replicate the data into a MySQL database.

  1. Install the module:

    Install-Module MySQLCmdlets
  2. Connect to MySQL, using the server address and port of the MySQL server, valid user credentials, and a specific database with the table in which the data will be replicated:

    $mysql = Connect-MySQL -User $User -Password $Password -Database $Database -Server $Server -Port $Port
  3. Loop through the Jira Service Desk data, store the values, and use the Add-MySQL cmdlet to insert the data into the MySQL database, one row at a time. In this example, the table will need to have the same name as the Jira Service Desk resource (Requests) and to exist in the database.

    $data | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Requests" -Columns $columns -Values $values }

You have now replicated your Jira Service Desk data to a MySQL database. This gives you freedom to work with Jira Service Desk data in the same way that you work with other MySQL tables, whether that is performing analytics, building reports, or other business functions.

Notes

  • Once you have connected to Jira Service Desk and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-JiraServiceDesk -Connection $jiraservicedesk -Table "Requests" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Requests" -Columns $columns -Values $values }
  • If you wish to replicate the Jira Service Desk data to another database using another PowerShell module, you will want to exclude the Columns, Connection, and Table columns from the data returned by the Select-JiraServiceDesk cmdlet since those columns are used to help pipe data from one CData cmdlet to another:

    $columns = ($data | Get-Member -MemberType NoteProperty | Select-Object -Property Name).Name | ? {$_ -NotIn @('Columns','Connection','Table')}