Reveal is a data visualization solution provided by Infragistics and can be paired with the CData API Server to build dynamic dashboards from live MySQL data. The CData API Server generates an OData API for MySQL, which is natively consumable in Reveal. In this article, we walk through connecting to MySQL in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.
Connect to MySQL 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 "MySQL"
π Selecting a Connector (Salesforce is shown).
- Enter the necessary authentication properties to connect to MySQL.
The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.
SSH Connectivity for MySQL
You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).
SSH Connections to MySQL in Password Auth Mode
To connect to MySQL via SSH in Password Auth mode, set the following connection properties:
- User: MySQL User name
- Password: MySQL Password
- Database: MySQL database name
- Server: MySQL Server name
- Port: MySQL port number like 3306
- UserSSH: "true"
- SSHAuthMode: "Password"
- SSHPort: SSH Port number
- SSHServer: SSH Server name
- SSHUser: SSH User name
- SSHPassword: SSH Password
SSH Connections to MySQL in Public Key Auth Mode
To connect to MySQL via SSH in Password Auth mode, set the following connection properties:
- User: MySQL User name
- Password: MySQL Password
- Database: MySQL database name
- Server: MySQL Server name
- Port: MySQL port number like 3306
- UserSSH: "true"
- SSHAuthMode: "Public_Key"
- SSHPort: SSH Port number
- SSHServer: SSH Server name
- SSHUser: SSH User name
- SSHClientCret: the path for the public key certificate file
π Configuring a connection (Salesforce is shown).
Add MySQL Resource Definitions in API Server
After connecting to MySQL, create Resources, which represent API endpoints for MySQL data.
- Click Settings -> Resources -> Add Resource
π Adding a new resource
- Select the MySQL 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 MySQL from Reveal through API Server.
- Click Settings -> Users
- Click Add
- Configure a User with access to the MySQL 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 MySQL 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 MySQL data. For more information on creating OData feeds from MySQL (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live MySQL data in tools that consume OData APIs.