VOOZH about

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

⇱ Analyze EmailOctopus Data in Infragistics Reveal


Analyze EmailOctopus Data in Infragistics Reveal

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

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

    Start by setting the Profile connection property to the location of the EmailOctopus Profile on disk (e.g. C:\profiles\EmailOctopus.apip). Next, set the ProfileSettings connection property to the connection string for EmailOctopus (see below).

    EmailOctopus API Profile Settings

    Sign into your EmailOctopus account and navigate to Integrations & API > API > Your API Keys to generate or retrieve your API key.

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

Add EmailOctopus Resource Definitions in API Server

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

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

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