VOOZH about

URL: https://www.cdata.com/kb/tech/alloydb-odata-infragistics-reveal.rst

⇱ Analyze AlloyDB Data in Infragistics Reveal


Analyze AlloyDB Data in Infragistics Reveal

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData API Server to create an OData API on top of AlloyDB data and visualize live AlloyDB data in Infragistics Reveal.

Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live AlloyDB data. The CData API Server generates an OData API for AlloyDB, which is natively consumable in Reveal. In this article, we walk through connecting to AlloyDB in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to AlloyDB from API Server

CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Open API Server and click Settings -> Connection -> Add Connection πŸ‘ Adding a connection
  2. Select "AlloyDB" πŸ‘ Selecting a Connector (Salesforce is shown).
  3. Enter the necessary authentication properties to connect to AlloyDB.

    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. πŸ‘ Configuring a connection (Salesforce is shown).

Add AlloyDB Resource Definitions in API Server

After connecting to AlloyDB, create Resources, which represent API endpoints for AlloyDB data.

  1. Click Settings -> Resources -> Add Resource πŸ‘ Adding a new resource
  2. Select the AlloyDB connection πŸ‘ Selecting a connection (Salesforce is shown)
  3. Select the table you wish to retrieve and click Next πŸ‘ Selecting a Table (Salesforce is shown)
  4. (Optional) Edit the resource to select specific fields and more
  5. Save the settings

Add an API Server User

Create a User to connect to AlloyDB from Reveal through API Server.

  1. Click Settings -> Users
  2. Click Add
  3. Configure a User with access to the AlloyDB Connection and Resource(s) πŸ‘ Creating a new user
πŸ‘ API Server users

(Optional) Configure Cross-Origin Resource Sharing (CORS)

When accessing and connecting to multiple different domains from an application such as Ajax, there is a possibility of violating the limitations of cross-site scripting. In that case, configure the CORS settings in Settings -> Server.

  • Enable cross-origin resource sharing (CORS): ON
  • Allow all domains without '*': ON
  • Access-Control-Allow-Methods: GET, PUT, POST, OPTIONS
  • Access-Control-Allow-Headers: Authorization

Save the changes to the settings.

πŸ‘ Configuring CORS settings

Create a Dashboard in Reveal

With the API Server configured, we can visualize AlloyDB data in Reveal.

  1. Log into Reveal and click Dashboards -> New πŸ‘ Adding a new dashboard
  2. Click Data Source -> OData Feed πŸ‘ Adding a new OData data source
  3. Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc πŸ‘ Configuring the OData URL
  4. Select Generic Credentials and specify the API Server username and authentication token πŸ‘ Configuring the credentials
  5. Select the entity you wish to visualize πŸ‘ Selecting an entity to visualize (Salesforce is shown.)
  6. Select fields and choose a chart type πŸ‘ Visualizing data in Reveal (Salesforce is shown.)

More Information & Free Trial

At this point, you have created a simple dashboard from live AlloyDB data. For more information on creating OData feeds from AlloyDB (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live AlloyDB data in tools that consume OData APIs.