Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live Confluence data. The CData API Server generates an OData API for Confluence, which is natively consumable in Reveal. In this article, we walk through connecting to Confluence in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to Confluence 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 "Confluence"
π Selecting a Connector (Salesforce is shown).
- Enter the necessary authentication properties to connect to Confluence.
Obtaining an API Token
An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.
Connect Using a Confluence Cloud Account
To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):
- User: The user which will be used to authenticate with the Confluence server.
- APIToken: The API Token associated with the currently authenticated user.
- Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.
Connect Using a Confluence Server Instance
To connect to a Server instance, provide the following:
- User: The user which will be used to authenticate with the Confluence instance.
- Password: The password which will be used to authenticate with the Confluence server.
- Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.
π Configuring a connection (Salesforce is shown).
Add Confluence Resource Definitions in API Server
After connecting to Confluence, create Resources, which represent API endpoints for Confluence data.
- Click Settings -> Resources -> Add Resource
π Adding a new resource
- Select the Confluence 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 Confluence from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the Confluence 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 Confluence 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 Confluence data. For more information on creating OData feeds from Confluence (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live Confluence data in tools that consume OData APIs.