Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Mocean data. The CData API Server generates an OData API for Mocean, which is natively consumable in Reveal. In this article, we walk through connecting to Mocean in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to Mocean 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 "Mocean"
π Selecting a Connector (Salesforce is shown).
- Enter the necessary authentication properties to connect to Mocean.
Using API Key Authentication
Mocean uses API key authentication to control access to the API. To obtain an API Key:
- Log in to your Mocean account at https://dashboard.moceanapi.com
- Navigate to your account settings or API credentials section
- Copy your API Key
After obtaining your API Key, set the following connection properties:
- AuthScheme: Set this to APIKey.
Set the following in the ProfileSettings connection property:
- APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.
Example Connection String
Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
Connecting to Mocean
Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.
π Configuring a connection (Salesforce is shown).
Add Mocean Resource Definitions in API Server
After connecting to Mocean, create Resources, which represent API endpoints for Mocean data.
- Click Settings -> Resources -> Add Resource
π Adding a new resource
- Select the Mocean 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 Mocean from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the Mocean 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 Mocean 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 Mocean data. For more information on creating OData feeds from Mocean (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Mocean data in tools that consume OData APIs.