Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to pipe Clio Data to CSV in PowerShell
Use standard PowerShell cmdlets to access Clio tables.
The CData Cmdlets Module for Clio is a standard PowerShell module offering straightforward integration with Clio. Below, you will find examples of using our API Cmdlets with native PowerShell cmdlets.
Creating a Connection to Your Clio Data
Start by setting the Profile connection property to the location of the Clio Profile on disk (e.g. C:\profiles\Clio.apip). Next, set the ProfileSettings connection property to the connection string for Clio (see below).
Clio API Profile Settings
Clio uses OAuth-based authentication.
First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally you will need to set the Region in ProfileSettings connection property.
After setting the following connection properties, 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 that is specified in your app settings.
- Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.
$conn = Connect-API -Profile "$Profile" -ProfileSettings "$ProfileSettings" -Authscheme "$Authscheme" -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret" -CallbackUrl "$CallbackUrl"
Selecting Data
Follow the steps below to retrieve data from the Bills table and pipe the result into to a CSV file:
Select-API -Connection $conn -Table Bills | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myBillsData.csv -NoTypeInformation
You will notice that we piped the results from Select-API into a Select-Object cmdlet and excluded some properties before piping them into an Export-Csv cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each "row" in the result set, and we do not necessarily want that information in our CSV file.
The Connection, Table, and Columns are appended to the results in order to facilitate piping results from one of the CData Cmdlets directly into another one.