VOOZH about

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

⇱ Analyze HCL Domino Data in Infragistics Reveal


Analyze HCL Domino Data in Infragistics Reveal

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use the CData API Server to create an OData API on top of HCL Domino data and visualize live HCL Domino 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 HCL Domino data. The CData API Server generates an OData API for HCL Domino, which is natively consumable in Reveal. In this article, we walk through connecting to HCL Domino in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to HCL Domino 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 "HCL Domino" πŸ‘ Selecting a Connector (Salesforce is shown).
  3. Enter the necessary authentication properties to connect to HCL Domino.

    Connecting to Domino

    To connect to Domino data, set the following properties:

    • URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
    • DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

    Authenticating with Domino

    Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

    Login Credentials

    To authenticate with login credentials, set the following properties:

    • AuthScheme: Set this to "OAuthPassword"
    • User: The username of the authenticating Domino user
    • Password: The password associated with the authenticating Domino user

    The driver uses the login credentials to automatically perform an OAuth token exchange.

    EntraID (formerly AzureAD)

    This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

    • AuthScheme: Set this to "EntraID (formerly AzureAD)"
    • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
    • OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
    • OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
    • CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
    • AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

      The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

    πŸ‘ Configuring a connection (Salesforce is shown).

Add HCL Domino Resource Definitions in API Server

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

  1. Click Settings -> Resources -> Add Resource πŸ‘ Adding a new resource
  2. Select the HCL Domino 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 HCL Domino from Reveal through API Server.

  1. Click Settings -> Users
  2. Click Add
  3. Configure a User with access to the HCL Domino 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 HCL Domino 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 HCL Domino data. For more information on creating OData feeds from HCL Domino (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live HCL Domino data in tools that consume OData APIs.