VOOZH about

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

⇱ Analyze Instantly Data in Infragistics Reveal


Analyze Instantly Data in Infragistics Reveal

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

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

    Using API Key Authentication

    Instantly uses API keys to authenticate requests. You can find or create your API key in the Instantly workspace settings under API & Webhooks.

    After setting the following connection properties, you are ready to connect:

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Instantly API key (Bearer token for API v2).

    Example connection string

    Profile=C:\profiles\Instantly.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
    
    πŸ‘ Configuring a connection (Salesforce is shown).

Add Instantly Resource Definitions in API Server

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

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

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