Visualize AlloyDB Data in TIBCO Spotfire through OData



Integrate AlloyDB data into dashboards in TIBCO Spotfire.

OData is a major protocol enabling real-time communication among cloud-based, mobile, and other online applications. The CData API Server, when paired with the ADO.NET Provider for AlloyDB, provides AlloyDB data (or data from 200+ other ADO.NET Providers) 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 AlloyDB data in real time.

Set Up the API Server

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

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

The following connection properties are usually required in order to connect to AlloyDB.

  • Server: The host name or IP of the server hosting the AlloyDB database.
  • User: The user which will be used to authenticate with the AlloyDB server.
  • Password: The password which will be used to authenticate with the AlloyDB server.

You can also optionally set the following:

  • Database: The database to connect to when connecting to the AlloyDB Server. If this is not set, the user's default database will be used.
  • Port: The port of the server hosting the AlloyDB database. This property is set to 5432 by default.

Authenticating with Standard Authentication

Standard authentication (using the user/password combination supplied earlier) is the default form of authentication.

No further action is required to leverage Standard Authentication to connect.

Authenticating with pg_hba.conf Auth Schemes

There are additional methods of authentication available which must be enabled in the pg_hba.conf file on the AlloyDB server.

Find instructions about authentication setup on the AlloyDB Server here.

Authenticating with MD5 Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to md5.

Authenticating with SASL Authentication

This authentication method must be enabled by setting the auth-method in the pg_hba.conf file to scram-sha-256.

Authenticating with Kerberos

The authentication with Kerberos is initiated by AlloyDB Server when the ∏ is trying to connect to it. You should set up Kerberos on the AlloyDB Server to activate this authentication method. Once you have Kerberos authentication set up on the AlloyDB Server, see the Kerberos section of the help documentation for details on how to authenticate with Kerberos.

When you configure the connection, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

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

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 Data Visualizations on External AlloyDB 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:8032/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 Orders.
  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 ShipCity in the Numbers section and ShipName 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.

Ready to get started?

Learn more or sign up for a free trial:

CData API Server