Connect to Superchat Data from PowerBuilder via ADO.NET

This article demonstrates using the CData API Driver for ADO.NET in PowerBuilder, showcasing the ease of use and compatibility of these standards-based controls across various platforms and development technologies that support Microsoft .NET, including Appeon PowerBuilder.

This article shows how to create a basic PowerBuilder application that uses the CData API Driver for ADO.NET to retrieve data.

1. In a new WPF Window Application solution, add all the Visual Controls needed for the connection properties. Below is a typical connection string:

   Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

   Superchat uses API Key authentication. The API key is passed via the X-API-KEY request header on every call.

   Authentication

   To authenticate to Superchat, you need to obtain your API key from the Superchat workspace settings.

   Using API Key Authentication

   You can obtain your API key from Settings > Integrations > API Key in your Superchat workspace.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Superchat API key.

   Example connection string:

   Profile=C:\profiles\Superchat.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
   

2. Add the DataGrid control from the .NET controls.
3. Configure the columns of the DataGrid control. Below are several columns from the Account table:

   <DataGrid AutoGenerateColumns="False" Margin="13,249,12,14" Name="datagrid1" TabIndex="70" ItemsSource="{Binding}">
   <DataGrid.Columns>
    <DataGridTextColumn x:Name="idColumn" Binding="{Binding Path=Id}" Header="Id" Width="SizeToHeader" />
    <DataGridTextColumn x:Name="nameColumn" Binding="{Binding Path=}" Header="" Width="SizeToHeader" />
   		...
   	</DataGrid.Columns>
   </DataGrid>
   

4. Add a reference to the CData API Driver for ADO.NET assembly.

Connect the DataGrid

Once the visual elements have been configured, you can use standard ADO.NET objects like Connection, Command, and DataAdapter to populate a DataTable with the results of an SQL query:

System.Data.CData.API.APIConnection conn 
conn = create System.Data.CData.API.APIConnection(connectionString)

System.Data.CData.API.APICommand comm 
comm = create System.Data.CData.API.APICommand(command, conn)

System.Data.DataTable table
table = create System.Data.DataTable

System.Data.CData.API.APIDataAdapter dataAdapter
dataAdapter = create System.Data.CData.API.APIDataAdapter(comm)
dataAdapter.Fill(table)	
datagrid1.ItemsSource=table.DefaultView

The code above can be used to bind data from the specified query to the DataGrid.