Consume Sybase OData Feeds in PowerBuilder

The CData API Server produces secure feeds of Sybase data that you can consume in PowerBuilder DataWindows. The API Server supports the major Web services, including OData, Atom, JSON, HTML, CSV, TSV, and RSS. It also supports the major authentication schemes and SSL.

This article shows how to create a DataWindow that uses the CData API Server to execute reads and writes.

Set Up the API Server

Follow the steps below to begin producing secure Sybase OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Sybase

After you deploy the API Server, provide authentication values and other connection properties needed to connect to Sybase by clicking Settings -> Connections and adding a new connection in the API Server administration console.

To connect to Sybase, specify the following connection properties:

• Server: Set this to the name or network address of the Sybase database instance.
• Database: Set this to the name of the Sybase database running on the specified Server.

Optionally, you can also secure your connections with TLS/SSL by setting UseSSL to true.

Sybase supports several methods for authentication including Password and Kerberos.

Connect Using Password Authentication

Set the AuthScheme to Password and set the following connection properties to use Sybase authentication.

• User: Set this to the username of the authenticating Sybase user.
• Password: Set this to the username of the authenticating Sybase user.

Connect using LDAP Authentication

To connect with LDAP authentication, configure Sybase server-side to use the LDAP authentication mechanism.

After configuring Sybase for LDAP, you can connect using the same credentials as Password authentication.

Connect Using Kerberos Authentication

To leverage Kerberos authentication, begin by enabling it setting AuthScheme to Kerberos. See the Using Kerberos section in the Help documentation for more information on using Kerberos authentication.

You can find an example connection string below:

Server=MyServer;Port=MyPort;User=SampleUser;Password=SamplePassword;Database=MyDB;Kerberos=true;KerberosKDC=MyKDC;KerberosRealm=MYREALM.COM;KerberosSPN=server-name

You can then choose the Sybase entities you want to allow the API Server access to by clicking Settings -> Resources.

Additionally, click Settings -> Server and change the following settings for compatibility with PowerBuilder:

• Default Format: Select XML (Atom) in the menu.
• Default Version: Select 2.0 in the menu.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Create a Profile for Sybase

Follow the steps below to use the Database Painter tool to create a database profile for the OData API of the API Server. In the Database Painter, you can graphically manipulate data as well as execute SQL queries.

1. Click Tools -> Database Painter.
2. Right-click the OData node and click New Profile.
3. In the Database Profile Setup dialog, enter the following:
   • Profile Name: Enter a user-friendly name for the profile.
   • URI: Enter the URL to the OData endpoint of the API Server. This URL will resemble the one below:

     http://MyServer:8080/api.rsc

   • Supply User Id and Password: Click this option to use HTTP Basic authentication. Note that the API Server also supports Windows authentication.
   • User Id: Enter the name of an user in the API Server.
   • Password: Enter the authtoken of an user in the API Server.
   👁 The profile for the OData feed. (Salesforce is shown.)
   
4. To view and modify a table, right-click a table and then click Edit Data -> Grid.

👁 Modify database objects in the Database Painter. (Salesforce is shown.)

Using Sybase Data with PowerBuilder Controls

You can use standard PowerBuilder objects to connect to OData feeds and execute queries. The following example shows how to retrieve Sybase data into a DataWindow.

You can add the following code to the open method:

SQLCA.DBMS = "ODT"
SQLCA.DBParm = "ConnectString='URI=http://MyServer:8080/api.rsc;UID=MyAPIUser;PWD=MyAuthtoken'";
CONNECT USING SQLCA;
dw_products.SetTransObject(SQLCA);
dw_products.Retrieve();