Visualize Adobe Target Data in TIBCO Spotfire through OData

OData is a major protocol enabling real-time communication among cloud-based, mobile, and other online applications. The CData API Server provides Adobe Target data to OData consumers like TIBCO Spotfire. This article shows how to use the API Server and Spotfire's built-in support for OData to access Adobe Target data in real time.

Set Up the API Server

If you have not already done so, download the CData API Server. Once you have installed the API Server, follow the steps below to begin producing secure Adobe Target OData services:

Connect to Adobe Target

To work with Adobe Target data from TIBCO Spotfire, we start by creating and configuring a Adobe Target connection. Follow the steps below to configure the API Server to connect to Adobe Target data:

1. First, navigate to the Connections page.
2. Click Add Connection and then search for and select the Adobe Target connection.
3. Enter the necessary authentication properties to connect to Adobe Target.

   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.

   
4. After configuring the connection, click Save & Test to confirm a successful connection.

Configure API Server Users

Next, create a user to access your Adobe Target data through the API Server. You can add and configure users on the Users page. Follow the steps below to configure and create a user:

1. On the Users page, click Add User to open the Add User dialog.
2. Next, set the Role, Username, and Privileges properties and then click Add User.
3. An Authtoken is then generated for the user. You can find the Authtoken and other information for each user on the Users page:

Creating API Endpoints for Adobe Target

Having created a user, you are ready to create API endpoints for the Adobe Target tables:

1. First, navigate to the API page and then click Add Table .
2. Select the connection you wish to access and click Next.
3. With the connection selected, create endpoints by selecting each table and then clicking Confirm.

Gather the OData Url

Having configured a connection to Adobe Target data, created a user, and added resources to the API Server, you now have an easily accessible REST API based on the OData protocol for those resources. From the API page in API Server, you can view and copy the API Endpoints for the API:

Create Data Visualizations on External Adobe Target Data

1. Open Spotfire and click Add Data Tables -> OData.
2. In the OData Connection dialog, enter the following information:
   • Service URL: Enter the API Server's OData endpoint. For example:

     http://localhost:8080/api.rsc

   • Authentication Method: Select Username and Password.
   • Username: Enter the username of an API Server user. You can create API users on the Security tab of the administration console.
   • Password: Enter the authtoken of an API Server user.
   
3. Select the tables and columns you want to add to the dashboard. This example uses Activities.
4. If you want to work with the live data, click the Keep Data Table External option. This option enables your dashboards to reflect changes to the data in real time.

   If you want to load the data into memory and process the data locally, click the Import Data Table option. This option is better for offline use or if a slow network connection is making your dashboard less interactive.

5. After adding tables, the Recommended Visualizations wizard is displayed. When you select a table, Spotfire uses the column data types to detect number, time, and category columns. This example uses Name in the Numbers section and Id in the Categories section.

After adding several visualizations in the Recommended Visualizations wizard, you can make other modifications to the dashboard. For example, you can apply a filter: After clicking the Filter button, the available filters for each query are displayed in the Filters pane.