Cmdlets for SAP Gateway

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our SAPGateway 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 SAPGatewayCmdlets

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

Import-Module SAPGatewayCmdlets;

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

$conn = Connect-SAPGateway -User "username" -Password "password" -URL "https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/"

Connecting to SAP Gateway

SAP Gateway provides two ways to connect to data:

  • To connect to your own local data via the desktop (non-browser connection, referred to below as "basic authentication"), use the CData-supplied embedded OAuth application.
  • To connect to shared data over the network (browser connection), use a custom OAuth application.

To access SAP Gateway tables, set the following connection properties:

  • Url = the URL of your environment, or the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment url would just be: https://sapes5.sapdevcenter.com. Add any additional properties using the CustomUrlParams property.
  • Namespace = the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full url to the service is specified.
  • SAP Gateway = the service from which you want to retrieve data. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full url is specified.
  • CustomUrlParams = any required additional properties that need to be included with the HTTP request; for example, sap-client=001&sap-language=EN.

Authenticating to SAP Gateway

SAP Gateway allows both basic and OAuth 2.0 authentication. Use basic authentication to connect to your own account, or use OAuth to authenticate to shared data via a browser connection.

Basic

To enable basic authentication, set the following properties:

  • AuthScheme = Basic.
  • User = the username you use to log in to SAP Gateway.
  • Password = the password you use to log in to SAP Gateway.

After you set the above properties are set, you are ready to connect. Use your personal credentials to access your local data.

OAuth

The following subsections provide details about authenticating from a desktop application, the web, or a headless machine. For information about creating 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

  • 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 SAP Gateway's OAuth endpoint in your default browser.

Log in and grant permissions to the application. When the access token expires, the cmdlet refreshes the access token automatically.

Headless Machines

If you need to authenticate via OAuth with a user account 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 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.

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. Do the following:

  1. Set the following properties:
    • InitiateOAuth = OFF.
    • OAuthClientId = the client Id assigned when you registered your application.
    • OAuthClientSecret = the client secret assigned when you registered your application.
  2. Use the appropriate CalllbackURL to call the GetOAuthAuthorizationURL stored procedure.
  3. Copy the returned URL into a browser and open the page.
  4. Log in and grant permissions to the cmdlet. You are redirected to the redirect URI.
  5. Record the code parameter that is appended to the redirect URI. You will use it later, when you set up the OAuthVerifier connection property.
  6. To exchange the OAuth verifier code for OAuth refresh and access tokens, set the following connection properties, which provide the OAuth authentication values:
    • InitiateOAuth = REFRESH.
    • OAuthVerifier = the noted verifier code (the value of the code parameter in the redirect URI).
    • OAuthClientId = the client Id in your custom OAuth application settings.
    • OAuthClientSecret = the client secret in the custom OAuth application settings.
    • OAuthSettingsLocation = persist the encrypted OAuth authentication values to the specified file.
  7. Test the connection to generate the OAuth settings file, then re-set the following properties to connect:
    • InitiateOAuth = REFRESH.
    • OAuthClientId = the client Id assigned when you registered your application.
    • OAuthClientSecret = the client secret assigned when you registered your application.
    • OAuthSettingsLocation = the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the cmdlet to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Before 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 previously 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 the following connection properties:

  • InitiateOAuth = REFRESH.
  • OAuthClientId = the client Id assigned when you registered your application.
  • OAuthClientSecret = the client secret assigned when you registered your application.
  • 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.

Retrieving Data

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

$results = Select-SAPGateway -Connection $conn -Table "SampleTable_1" -Columns @("Id, Column1") -Where "Column2='Bob'"
The Invoke-SAPGateway 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-SAPGateway -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\mySampleTable_1Data.csv -NoTypeInformation

You will notice that we piped the results from Select-SAPGateway 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-SAPGateway -User "username" -Password "password" -URL "https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/"
PS C:\> $row = Select-SAPGateway -Connection $conn -Table "SampleTable_1" -Columns (Id, Column1) -Where "Column2 = 'Bob'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "SampleTable_1",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Column1":  "MyColumn1"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-SAPGateway -Connection $conn -Table SampleTable_1 -Where "Column2 = 'Bob'" | Remove-SAPGateway

Modifying Data

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

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060