Analyze SQL Server 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 SQL Server data. The CData API Server generates an OData API for SQL Server, which is natively consumable in Reveal. In this article, we walk through connecting to SQL Server in API Server and connecting to the API Server from Infragistics Reveal to create a simple dashboard.

Connect to SQL Server 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 "SQL Server" 👁 Selecting a Connector (Salesforce is shown).
   
3. Enter the necessary authentication properties to connect to SQL Server.

   Connecting to Microsoft SQL Server

   Connect to Microsoft SQL Server using the following properties:

   • Server: The name of the server running SQL Server.
   • User: The username provided for authentication with SQL Server.
   • Password: The password associated with the authenticating user.
   • Database: The name of the SQL Server database.

   Connecting to Azure SQL Server and Azure Data Warehouse

   You can authenticate to Azure SQL Server or Azure Data Warehouse by setting the following connection properties:

   • Server: The server running Azure. You can find this by logging into the Azure portal and navigating to "SQL databases" (or "SQL data warehouses") -> "Select your database" -> "Overview" -> "Server name."
   • User: The name of the user authenticating to Azure.
   • Password: The password associated with the authenticating user.
   • Database: The name of the database, as seen in the Azure portal on the SQL databases (or SQL warehouses) page.

   SSH Connectivity for SQL Server

   You can use SSH (Secure Shell) to authenticate with SQL Server, 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 SQL Server in Password Auth Mode

   To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

   • User: SQL Server User name
   • Password: SQL Server Password
   • Database: SQL Server database name
   • Server: SQL Server Server name
   • Port: SQL Server 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 SQL Server in Public Key Auth Mode

   To connect to SQL Server via SSH in Password Auth mode, set the following connection properties:

   • User: SQL Server User name
   • Password: SQL Server Password
   • Database: SQL Server database name
   • Server: SQL Server Server name
   • Port: SQL Server 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 SQL Server Resource Definitions in API Server

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

1. Click Settings -> Resources -> Add Resource 👁 Adding a new resource
   
2. Select the SQL Server 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 SQL Server from Reveal through API Server.

1. Click Settings -> Users
2. Click Add
3. Configure a User with access to the SQL Server Connection and Resource(s) 👁 Creating a new user
   

(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.

Create a Dashboard in Reveal

With the API Server configured, we can visualize SQL Server 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 SQL Server data. For more information on creating OData feeds from SQL Server (and more than 150 other sources), visit the API Server page. Download a free, 30-day trial and start working live SQL Server data in tools that consume OData APIs.