Connect to Zuora Data from PowerBuilder via ADO.NET

This article demonstrates using the CData ADO.NET Provider for Zuora 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 ADO.NET Provider for Zuora 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:

   OAuthClientID=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;Tenant=USProduction;ZuoraService=DataQuery;InitiateOAuth=GETANDREFRESH;

   Zuora uses the OAuth standard to authenticate users. See the online Help documentation for a full OAuth authentication guide.

   Configuring Tenant property

   In order to create a valid connection with the provider you need to choose one of the Tenant values (USProduction by default) which matches your account configuration. The following is a list with the available options:

   • USProduction: Requests sent to https://rest.zuora.com.
   • USAPISandbox: Requests sent to https://rest.apisandbox.zuora.com"
   • USPerformanceTest: Requests sent to https://rest.pt1.zuora.com"
   • EUProduction: Requests sent to https://rest.eu.zuora.com"
   • EUSandbox: Requests sent to https://rest.sandbox.eu.zuora.com"

   Selecting a Zuora Service

   Two Zuora services are available: Data Query and AQuA API. By default ZuoraService is set to AQuADataExport.

   DataQuery

   The Data Query feature enables you to export data from your Zuora tenant by performing asynchronous, read-only SQL queries. We recommend to use this service for quick lightweight SQL queries.

   Limitations
   • The maximum number of input records per table after filters have been applied: 1,000,000
   • The maximum number of output records: 100,000
   • The maximum number of simultaneous queries submitted for execution per tenant: 5
   • The maximum number of queued queries submitted for execution after reaching the limitation of simultaneous queries per tenant: 10
   • The maximum processing time for each query in hours: 1
   • The maximum size of memory allocated to each query in GB: 2
   • The maximum number of indices when using Index Join, in other words, the maximum number of records being returned by the left table based on the unique value used in the WHERE clause when using Index Join: 20,000

   AQuADataExport

   AQuA API export is designed to export all the records for all the objects ( tables ). AQuA query jobs have the following limitations:

   Limitations
   • If a query in an AQuA job is executed longer than 8 hours, this job will be killed automatically.
   • The killed AQuA job can be retried three times before returned as failed.
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=Id}" Header="Id" Width="SizeToHeader" />
   		...
   	</DataGrid.Columns>
   </DataGrid>
   

4. Add a reference to the CData ADO.NET Provider for Zuora 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.Zuora.ZuoraConnection conn 
conn = create System.Data.CData.Zuora.ZuoraConnection(connectionString)

System.Data.CData.Zuora.ZuoraCommand comm 
comm = create System.Data.CData.Zuora.ZuoraCommand(command, conn)

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

System.Data.CData.Zuora.ZuoraDataAdapter dataAdapter
dataAdapter = create System.Data.CData.Zuora.ZuoraDataAdapter(comm)
dataAdapter.Fill(table)	
datagrid1.ItemsSource=table.DefaultView

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