Consume Adobe Target OData Feeds in PowerBuilder

The CData API Server produces secure feeds of Adobe Target 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 retrieve data.

Set Up the API Server

Follow the steps below to begin producing secure Adobe Target 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 Adobe Target

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

To connect to Adobe Target, you must provide the Tenant property along with OAuth connection properties mentioned below. Note that while other connection properties can influence processing behavior, they do not affect the ability to connect.

To determine your Tenant name:

1. Log in to Adobe Experience. The URL will look similar to: "https://experience.adobe.com/#/@mycompanyname/preferences/general-section".
2. Extract the value after the "/#/@". In this example, it is "mycompanyname".
3. Set the Tenant connection property to that value.

User Accounts (OAuth)

You must set AuthScheme to OAuthClient for all user account flows.

Note: Adobe authentication via OAuth requires updating your token every two weeks.

All Applications

CData provides an embedded OAuth application that simplifies OAuth authentication. Alternatively, you can create a custom OAuth application. Review Creating a Custom OAuth App in the Help documentation for more information.

Obtaining the OAuth Access Token

Set the following properties to connect:

• InitiateOAuth: Set to GETANDREFRESH to automatically perform the OAuth exchange and refresh the OAuthAccessToken as needed.
• OAuthClientId : Set to the client Id assigned when you registered your app.
• OAuthClientSecret : Set to the client secret assigned when you registered your app.
• CallbackURL : Set to the redirect URI defined when you registered your app. For example: https://localhost:3333

With these settings, the provider obtains an access token from Adobe Target, which it uses to request data. The OAuth values are stored in the location specified by OAuthSettingsLocation, ensuring they persist across connections.

You can then choose the Adobe Target 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 Adobe Target

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 Adobe Target 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 Adobe Target 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_activities.SetTransObject(SQLCA);
dw_activities.Retrieve();