Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Cosmos DB data. The CData API Server generates an OData API for Cosmos DB, which is natively consumable in Reveal. In this article, we walk through connecting to Cosmos DB in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to Cosmos DB from API Server
CData API Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.
- Open API Server and click Settings -> Connection -> Add Connection
π Adding a connection
- Select "Cosmos DB"
π Selecting a Connector (Salesforce is shown).
- Enter the necessary authentication properties to connect to Cosmos DB.
To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:
- AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
- AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
π Configuring a connection (Salesforce is shown).
Add Cosmos DB Resource Definitions in API Server
After connecting to Cosmos DB, create Resources, which represent API endpoints for Cosmos DB data.
- Click Settings -> Resources -> Add Resource
π Adding a new resource
- Select the Cosmos DB connection
π Selecting a connection (Salesforce is shown)
- Select the table you wish to retrieve and click Next
π Selecting a Table (Salesforce is shown)
- (Optional) Edit the resource to select specific fields and more
- Save the settings
Add an API Server User
Create a User to connect to Cosmos DB from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the Cosmos DB 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 Cosmos DB data in Reveal.
- Log into Reveal and click Dashboards -> New
π Adding a new dashboard
- Click Data Source -> OData Feed
π Adding a new OData data source
- Specify the API Server API endpoint URL, for example: https://serverurl/api.rsc
π Configuring the OData URL
- Select Generic Credentials and specify the API Server username and authentication token
π Configuring the credentials
- Select the entity you wish to visualize
π Selecting an entity to visualize (Salesforce is shown.)
- 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 Cosmos DB data. For more information on creating OData feeds from Cosmos DB (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Cosmos DB data in tools that consume OData APIs.