Ready to get started?

Connect to live data from Aha with the API Driver

Connect to Aha

PowerShell Scripting to Replicate Aha Data to MySQL



Write a simple PowerShell script to replicate Aha data to a MySQL database.

The CData Cmdlets for Aha offer live access to Aha 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 Aha and the CData Cmdlets for MySQL in PowerShell to replicate Aha data to a MySQL database.

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

Start by setting the Profile connection property to the location of the Aha! Profile on disk (e.g. C:\profiles\aha.apip). Next, set the ProfileSettings connection property to the connection string for Aha! (see below).

Aha! API Profile Settings

The Aha! API uses OAuth-based authentication.

You will first need to register an OAuth app with Aha!. This can be done from your Aha! account under 'Settings' > 'Personal' > 'Developer' > 'OAuth Applications'. Additionally, you will need to set the Domain, found in the domain name of your Aha account. For example if your Aha account is acmeinc.aha.io, then the Domain should be 'acmeinc'.

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the client_id that is specified in you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI you specified in your app settings.
  • Domain: Set this in the ProfileSettings to your Aha domain.

Collecting Aha Data

  1. Install the module:

    Install-Module APICmdlets
  2. Connect to Aha:

    $api = Connect-API -Profile $Profile -ProfileSettings $ProfileSettings -Authscheme $Authscheme -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackUrl $CallbackUrl
  3. Retrieve the data from a specific resource:

    $data = Select-API -Connection $api -Table "Ideas"

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

    $data = Invoke-API -Connection $api -Query 'SELECT * FROM Ideas WHERE AssignedToUserId = @AssignedToUserId' -Params @{'@AssignedToUserId'='my_user_id'}
  4. Save a list of the column names from the returned data.

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

Inserting Aha 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 Aha 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 Aha resource (Ideas) and to exist in the database.

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

You have now replicated your Aha data to a MySQL database. This gives you freedom to work with Aha 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 Aha and MySQL in PowerShell, you can pipe command results to perform the replication in a single line:

    Select-API -Connection $api -Table "Ideas" | % { $row = $_ $values = @() $columns | % { $col = $_ $values += $row.$($col) } Add-MySQL -Connection $mysql -Table "Ideas" -Columns $columns -Values $values }
  • If you wish to replicate the Aha 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-API 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')}