How to pipe Cvent Data to CSV in PowerShell

The CData Cmdlets Module for Cvent is a standard PowerShell module offering straightforward integration with Cvent. Below, you will find examples of using our Cvent Cmdlets with native PowerShell cmdlets.

Creating a Connection to Your Cvent Data

Before you can authenticate to Cvent, you must create a workspace and an OAuth application.

Creating a Workspace

To create a workspace:

1. Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) >> Admin.
2. In the Admin menu, navigate to Integrations >> REST API.
3. A new tab launches for Developer Management. Click on Manage API Access in the new tab.
4. Create a Workspace and name it. Select the scopes you would like your developers to have access to. Scopes control what data domains the developer can access.
   • Choose All to allow developers to choose any scope, and any future scopes added to the REST API.
   • Choose Custom to limit the scopes developers can choose for their OAuth apps to selected scopes. To access all tables exposed by the driver, you need to set the following scopes:

     event/attendees:read	event/attendees:write	event/contacts:read
     event/contacts:write	event/custom-fields:read	event/custom-fields:write
     event/events:read	event/events:write	event/sessions:delete
     event/sessions:read	event/sessions:write	event/speakers:delete
     event/speakers:read	event/speakers:write	budget/budget-items:read
     budget/budget-items:write	exhibitor/exhibitors:read	exhibitor/exhibitors:write
     survey/surveys:read	survey/surveys:write

Creating an OAuth Application

After you have set up a Workspace and invited them, developers can sign up and create a custom OAuth app. See the Creating a Custom OAuth Application section in the Help documentation for more information.

Connecting to Cvent

After creating an OAuth application, set the following connection properties to connect to Cvent:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId: The Client ID associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.
• OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.

$conn = Connect-Cvent  -OAuthClientId "$OAuthClientId" -OAuthClientSecret "$OAuthClientSecret"

Selecting Data

Follow the steps below to retrieve data from the Events table and pipe the result into to a CSV file:

Select-Cvent -Connection $conn -Table Events | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myEventsData.csv -NoTypeInformation

You will notice that we piped the results from Select-Cvent 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.

Deleting Data

The following line deletes any records that match the criteria:

Select-Cvent -Connection $conn -Table Events -Where "Virtual = true" | Remove-Cvent

Inserting and Updating Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Cvent, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\MyEventsUpdates.csv | %{
  $record = Select-Cvent -Connection $Cvent -Table Events -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Cvent -Connection $cvent -Table Events -Columns ("Id","Title") -Values ($_.Id, $_.Title) -Where ("Id = `'"+$_.Id+"`'")
  }else{
    Add-Cvent -Connection $cvent -Table Events -Columns ("Id","Title") -Values ($_.Id, $_.Title)
  }
}

As always, our goal is to simplify the way you connect to data. With cmdlets users can install a data module, set the connection properties, and start building. Download Cmdlets and start working with your data in PowerShell today!