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

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site.

Install-Module SFMarketingCloudCmdlets

The following line is then added to your profile, loading the cmdlets on the next session:

Import-Module SFMarketingCloudCmdlets;

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

$conn = Connect-SFMarketingCloud -User "MyUser" -Password "MyPassword" 

Connecting to Salesforce Marketing Cloud

For both REST and SOAP APIs, you have the option to refine data access using the following properties:

• Instance: The instance of the Salesforce Marketing Cloud API used. The default Instance is s7 of the Web Services API; however, you can use this property to specify a different instance.
• Subdomain: If the instance is greater than s10, you must also specify the subdomain.

REST API

To connect, set Schema to REST.

The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom OAuth application to obtain values for the OAuthClientId and OAuthClientSecret connection properties. See Creating a Custom OAuth App for more information.

SOAP API

To connect, set Schema to SOAP.

The Salesforce Marketing Cloud SOAP API can connect using OAuth, but also supports a legacy use of login credentials.

Note: Data extension objects in Salesforce Marketing Cloud are only accessible through the SOAP API.

Authenticating to Salesforce Marketing Cloud

User Accounts (OAuth)

Set the AuthScheme to OAUTH. Also, in all OAuth flows, set AccountId to the specific MID of the target business unit. NOTE: This is not available for legacy packages. The following OAuth sections assume that you have set both these connection properties.

Desktop Apps

Follow the steps below to authenticate with the credentials for a custom OAuth application. See Creating a Custom OAuth App for information about custom OAuth applications. Get an OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: The Client Id in your application settings.
• OAuthClientSecret: The Client Secret in your application settings.
• CallbackURL: The Redirect URL in your application settings.

When you connect the cmdlet opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

1. Choose one of two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
   • 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, as described in "Transfer OAuth Settings" below.
2. Then configure the cmdlet to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

1. Choose one of these options:
   • If you are using the Embedded OAuth Application click Salesforce Marketing Cloud OAuth endpoint to open the endpoint in your browser.
   • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
     • InitiateOAuth: Set to OFF.
     • OAuthClientId: Set to the client Id assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application.
     Then call the rpgrestsp-getoauthauthorizationurl stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
2. Log in and grant permissions to the cmdlet. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• InitiateOAuth: REFRESH.
• OAuthVerifier: The verifier code.
• OAuthClientId: (custom applications only) The Client Id in your custom OAuth application settings.
• OAuthClientSecret: (custom applications only) The Client Secret in the custom OAuth application settings.
• OAuthSettingsLocation: The location of the settings file where OAuth values are saved when you set InitiateOAuth to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. When this connection property is set, the data persists across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

• InitiateOAuth: REFRESH.
• OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) The client secret assigned when you registered your application.
• OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

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

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

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties:

• OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) The client secret assigned when you registered your application.
• OAuthSettingsLocation: The location of your OAuth settings file. Make sure this location gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Server-to-Server (OAuthClient)

When creating an application in Salesforce Marketing Cloud, you can select server-to-server authentication. In this case, the application's permissions are configured directly in the Salesforce Marketing Cloud UI. As such, there is no user context and hence no browser-based login or permission grants. For this scheme, you must create your own credentials.

Specify the following properties to enable server-to-server OAuth authentication for your application:

• AuthScheme: OAuthClient.
• InitiateOAuth: GETANDREFRESH.
• OAuthClientId: The client Id.
• OAuthClientSecret: The client secret.
• Subdomain: Specify the Salesforce Marketing Cloud API subdomain.

User/Password Accounts (Basic)

The Salesforce Marketing Cloud SOAP API can connect using either your login credentials or OAuth authentication. Note that this authentication scheme is not available for REST API-based applications.

To connect to data using login credentials authentication, set the following:

• AuthScheme: Basic.
• User: The Salesforce Marketing Cloud user account.
• Password: The password used to authenticate the user.
• UseLegacyAuthentication: True.

Retrieving Data

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

$results = Select-SFMarketingCloud -Connection $conn -Table "Subscriber" -Columns @("Id, Status") -Where "EmailAddress='[email protected]'"

The Invoke-SFMarketingCloud 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-SFMarketingCloud -Connection $conn -Table Subscriber -Where "EmailAddress = '[email protected]'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySubscriberData.csv -NoTypeInformation

You will notice that we piped the results from Select-SFMarketingCloud 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-SFMarketingCloud -User "MyUser" -Password "MyPassword" 
PS C:\> $row = Select-SFMarketingCloud -Connection $conn -Table "Subscriber" -Columns (Id, Status) -Where "EmailAddress = '[email protected]'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Subscriber",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Status":  "MyStatus"
} 

Deleting Data

The following line deletes any records that match the criteria:

Select-SFMarketingCloud -Connection $conn -Table Subscriber -Where "EmailAddress = '[email protected]'" | Remove-SFMarketingCloud

Modifying Data

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

Import-Csv -Path C:\MySubscriberUpdates.csv | %{
  $record = Select-SFMarketingCloud -Connection $conn -Table Subscriber -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-SFMarketingCloud -Connection $conn -Table Subscriber -Columns @("Id","Status") -Values @($_.Id, $_.Status) -Where "Id  = `'$_.Id`'"
  }else{
    Add-SFMarketingCloud -Connection $conn -Table Subscriber -Columns @("Id","Status") -Values @($_.Id, $_.Status)
  }
}