Ready to get started?

Download a free trial of the DocuSign Cmdlets to get started:

 Download Now

Learn more:

DocuSign Icon DocuSign Cmdlets

An easy-to-use set of PowerShell Cmdlets offering real-time access to DocuSign data. The Cmdlets allow users to easily query live data - just like working with SQL server.

PowerShell Scripting to Replicate DocuSign Data to MySQL



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

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

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

To connect to DocuSign, set the following connection properties:

  • UseSandbox: indicates whether current user account is sandbox or not (FALSE by default)
  • AccountId (optional): set it in the connection string if you have access to multiple Account Ids

Authenticating to DocuSign

DocuSign uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties. See the Help documentation more information.

Collecting DocuSign Data

  1. Install the module:

    Install-Module DocuSignCmdlets
  2. Connect to DocuSign:

    $docusign = Connect-DocuSign -OAuthClientId $OAuthClientId -OAuthClientSecret $OAuthClientSecret -CallbackURL $CallbackURL
  3. Retrieve the data from a specific resource:

    $data = Select-DocuSign -Connection $docusign -Table "Documents"

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

    $data = Invoke-DocuSign -Connection $docusign -Query 'SELECT * FROM Documents WHERE DocumentName = @DocumentName' -Params @{'@DocumentName'='TPSReport'}
  4. Save a list of the column names from the returned data.

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

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

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

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

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