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

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

Import-Module SAPBusinessOneCmdlets;

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

$conn = Connect-SAPBusinessOne -Url 'http://localhost:50000/b1s/v1' -User 'user' -Password 'password' -CompanyDB 'companydb'

Connecting to SAP Business One APIs

To connect to data, specify the following:

• Url: Set this to your SAP Business One Service Layer root URL.
• CompanyDB: Set this to your SAP Business One company database.

Authenticating to SAP Business One APIs

To authenticate to SAP Business One, you must provide the User and Password connection properties.

Retrieving Data

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

$results = Select-SAPBusinessOne -Connection $conn -Table "Orders" -Columns @("DocEntry, DocType") -Where "DocType='dDocument_Items'"

The Invoke-SAPBusinessOne 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-SAPBusinessOne -Connection $conn -Table Orders -Where "DocType = 'dDocument_Items'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myOrdersData.csv -NoTypeInformation

You will notice that we piped the results from Select-SAPBusinessOne 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-SAPBusinessOne -Url 'http://localhost:50000/b1s/v1' -User 'user' -Password 'password' -CompanyDB 'companydb'
PS C:\> $row = Select-SAPBusinessOne -Connection $conn -Table "Orders" -Columns (DocEntry, DocType) -Where "DocType = 'dDocument_Items'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Orders",
  "Columns":  [

  ],
  "DocEntry":  "MyDocEntry",
  "DocType":  "MyDocType"
} 

Deleting Data

The following line deletes any records that match the criteria:

Select-SAPBusinessOne -Connection $conn -Table Orders -Where "DocType = 'dDocument_Items'" | Remove-SAPBusinessOne

Modifying Data

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

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