With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our OracleEloquaReporting Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Connecting to OracleEloquaReporting

Oracle Eloqua Reporting supports the following authentication methods:

• Basic authentication (User and Password)
• OAuth 2.0 code grant flow
• OAuth 2.0 password grant flow

Basic Authentication (User and Password)

To perform authentication with a user and password, specify these properties:

• AuthScheme: Basic.
• Company: The company name associated with your Oracle Eloqua Reporting account.
• User: Your login account name.
• Password: Your login password.

OAuth Authentication (Code Grant Flow)

To authenticate with the OAuth code grant flow, you must set AuthScheme to OAuth and create a custom OAuth application.

The following subsections describe how to authenticate to Oracle Eloqua Reporting from the three most common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId: The client Id assigned when you registered your application.
• OAuthClientSecret: The client secret that was assigned when you registered your application.
• CallbackURL: The redirect URI that was defined when you registered your application.

When you connect, the cmdlet opens Oracle Eloqua Reporting's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the cmdlet refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the cmdlet automatically refresh the OAuth access token:

1. Before connecting to data for the first time, set these connection parameters:
   • InitiateOAuth: REFRESH.
   • OAuthClientId: The client Id in your application settings.
   • OAuthClientSecret: The client secret in your application settings.
   • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
   • OAuthSettingsLocation: The path where you want the cmdlet to save the OAuth values, which persist across connections.
2. On subsequent data connections, set:
   • InitiateOAuth
   • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your application settings.
   • OAuthClientSecret: The Client Secret in your application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

• Option 1: Obtain the OAuthVerifier value.
• Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL as follows:

1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

   Set these properties:

   • InitiateOAuth: OFF.
   • OAuthClientId: The client Id assigned when you registered your application.
   • OAuthClientSecret: The client secret assigned when you registered your application.

2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

   Copy this URL and paste it into a new browser tab.

3. Log in and grant permissions to the cmdlet. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, to obtain the OAuth authentication values, set these properties:

   • InitiateOAuth: REFRESH.
   • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
   • OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified file.
   • OAuthClientId: The client Id in your custom OAuth application settings.
   • OAuthClientSecret: The client secret in the custom OAuth application settings.

5. Test the connection to generate the OAuth settings file.

6. You are ready to connect after you re-set these properties:

   • InitiateOAuth: REFRESH.
   • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the cmdlet.
   • OAuthClientId: The client Id assigned when you registered your application.
   • OAuthClientSecret: The client secret assigned when you registered your application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set these connection properties:

• InitiateOAuth: REFRESH
• OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the cmdlet.
• OAuthClientId: The client Id assigned when you registered your custom OAuth application.
• OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

OAuth Authentication (Password Grant Flow)

With the OAuth password grant flow, you can use your OAuth application's credentials alongside your user credentials to authenticate without the need to grant permission manually via a browser prompt. You must create an OAuth app (see Creating a Custom OAuth Application) to use this authentication method.

Set the following:

1. AuthScheme: OAuthPassword
2. Company: The company's unique identifier.
3. User: Your login account name.
4. Password: Your login password.
5. OAuthClientId: The client Id assigned when you registered your custom OAuth application.
6. OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Creating a Connection Object

You can then use the Connect-OracleEloquaReporting cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-OracleEloquaReporting -User 'user' -Password 'password' -Company 'MyCompany'

Retrieving Data

The Select-OracleEloquaReporting cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-OracleEloquaReporting -Connection $conn -Table "AccountActivity.Account" -Columns @("accountId, accountName") -Where "accountId='1'"

The Invoke-OracleEloquaReporting cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-OracleEloquaReporting -Connection $conn -Table AccountActivity.Account -Where "accountId = '1'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myAccountActivity.AccountData.csv -NoTypeInformation

You will notice that we piped the results from Select-OracleEloquaReporting 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 object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-OracleEloquaReporting -User 'user' -Password 'password' -Company 'MyCompany'
PS C:\> $row = Select-OracleEloquaReporting -Connection $conn -Table "AccountActivity.Account" -Columns (accountId, accountName) -Where "accountId = '1'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "AccountActivity.Account",
  "Columns":  [

  ],
  "accountId":  "MyaccountId",
  "accountName":  "MyaccountName"
} 

Modifying Data

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

Import-Csv -Path C:\MyAccountActivity.AccountUpdates.csv | %{
  $record = Select-OracleEloquaReporting -Connection $conn -Table AccountActivity.Account -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-OracleEloquaReporting -Connection $conn -Table AccountActivity.Account -Columns @("accountId","accountName") -Values @($_.accountId, $_.accountName) -Where "Id  = `'$_.Id`'"
  }else{
    Add-OracleEloquaReporting -Connection $conn -Table AccountActivity.Account -Columns @("accountId","accountName") -Values @($_.accountId, $_.accountName)
  }
}