Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
Get Free Trial
  1. API reference
  2. Welcome
    1. Getting started
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with AngularJS (v1.x)
      4. Integration with TypeScript
      5. Integration with R Shiny
      6. Integration with jQuery
      7. Integration with Ionic
      8. Integration with Electron.js
      9. Integration with Webpack
      10. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    4. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
    5. Flexmonster Data Server
      1. Introduction to Flexmonster Data Server
      2. Getting started with Flexmonster Data Server
      3. Configurations reference
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referencing the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
      7. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referencing the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
        6. Testing your custom data source API server
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    11. Connecting to other data sources
  5. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  6. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  8. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. Localizing the component
  9. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
  10. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  11. Documentation for older versions
Table of contents

Connecting to a Microsoft SQL Server database using Flexmonster Data Server

This tutorial describes how to connect to a Microsoft SQL Server database using Flexmonster Data Server – a special server developed by Flexmonster. This server communicates with the client using the custom data source API – our custom communication protocol allowing you to retrieve already aggregated data from a server to Flexmonster Pivot.

The approach described below can also be used for connecting to Microsoft Azure SQL databases.


To download the Data Server, you will need Flexmonster CLI — a command-line interface tool for Flexmonster. If needed, install the CLI globally using npm:

npm install -g flexmonster-cli

After that, a new flexmonster command will be available in the console. Learn more about Flexmonster CLI and its commands in our documentation.

Now follow the steps below to connect to Microsoft SQL Server using the Data Server.

To learn specifics of connecting to a remote SQL Server database, see this section.

Step 1. Embed the component into your web page

If Flexmonster is not yet embedded, set up an empty component in your web page:

In pure JavaScript

Complete the Quick start guide. Your code should look similar to the following example:

var pivot = new Flexmonster({
    container: "pivotContainer",
    toolbar: true

In Angular

Complete the Integration with Angular guide. Your code should look similar to the following example:


In React

Complete the Integration with React guide. Your code should look similar to the following example:


In Vue

Complete the Integration with Vue guide. Your code should look similar to the following example:


Step 2. Download Flexmonster Data Server

The previous step demonstrated how to configure Flexmonster Pivot. Now it’s time to set up Flexmonster Data Server.

Get the Data Server with the following CLI command:

flexmonster add fds

The flexmonster add fds command will download the .zip archive with Flexmonster Data Server and automatically unpack the files in the current folder. As a result, the flexmonster-data-server/ folder will appear in your working directory.

The Data Server can be configured in the flexmonster-data-server/flexmonster-config.json file. To learn more about all the available configurations, see the configurations reference.

To set configurations needed for a Microsoft SQL Server database, follow the steps below.

Step 3. Configure the data source type

Set the "Type" property in flexmonster-config.json to "database". It should be done as follows:

"DataSources": [
        "Type": "database"

Step 4. Configure the database type

Specify the name of the database you want to use by adding the "DatabaseType" configuration to the flexmonster-config.json file. In this case, the configuration value should be "mssql":

"DataSources": [
"Type": "database",
"DatabaseType": "mssql"

Step 5. Configure the connection with the database

To enable the server to fetch data from your database, you have to provide the connection string to the database. The connection string should be added to flexmonster-config.json as follows:

"DataSources": [
  "Type": "database",
      "DatabaseType": "mssql",

Have a look at the examples of different connection strings for Microsoft SQL Server and Microsoft Azure SQL.

Step 6. Define the data subset

In the flexmonster-config.json file, create an index for the subset of data you want Flexmonster Pivot to visualize. "Query" is an SQL query for the data. For example:

"DataSources": [
  "Type": "database",
      "DatabaseType": "mssql",
      "Indexes": {
      "index_database": {
          "Query": "SELECT * FROM tablename"

"index_database" is a dataset identifier. It will be used to configure the data source on the client side.

In a similar way, additional indexes can be specified:

"Indexes": {
"index_database": {
  "Query": "SELECT * FROM tablename"
   "another_index_database": {
    "Query": "SELECT column FROM tablename"

Step 7. Run the server

To start the Data Server, run the following command in the console:

on Windows


on macOS and Ubuntu/Linux


As soon as you start Flexmonster Data Server, it automatically preloads the data specified in the "Indexes" property. Thus, when Flexmonster Pivot requests the data, the server responds with already preloaded data.

The Data Server keeps preloaded data in the server’s RAM, so the number of indexes you can specify is limited by the server’s RAM amount.

Step 8. Configure the report

On the client side, the report should be configured as follows:

var pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true,
report: {
dataSource: {
type: "api",
url: "http://localhost:9500",
index: "index-database"

index must match the name of the index defined in step 6 (e.g., "index_database").

When Flexmonster Pivot requests the data, Flexmonster Data Server server sends the response and then caches it. In case the component sends the same request once again, the server responds with the data from its cache. The Data Server clears the cache when restarted.

The Data Server’s cache has a memory limit. When the cache does not have enough memory for a new response, the Data Server server deletes one of the previously cached responses.

You can manage the cache size via the “CacheSizeLimit” property.

Connecting to a remote Microsoft SQL Server database

To enable a remote connection to a Microsoft SQL Server database, you should properly configure your SQL Server instance.

Follow this guide to set up the server so that it allows remote connections. For more details on the SQL Server configuration, refer to this guide

Step 1. Specify the connection string to your database in the flexmonster-config.json file:

"DataSources": [ 
  "Type": "database",
   "DatabaseType": "mssql",
   "ConnectionString": "Server=<server_IP>\\MSSQLSERVER, port;
Uid=root; Pwd=password; Database=database_name",
   "Indexes": {

port can be omitted if your SQL Server instance uses the default 1433 port. Otherwise, specify a port used for the server.

The next step is to configure the server instance itself. 

Step 2. In SQL Server Management Studio, right-click the server instance and choose Properties > Connections. Then allow remote connections to your server:

Step 3. Open SQL Server Configuration Manager and enable TCP/IP for the server instance:

Step 4. This step also requires SQL Server Configuration Manager. In the SQL Server Services tab, run the needed SQL Server instance and SQL Server Browser:

For details on how to run SQL Server Browser, see this Microsoft’s guide.

Step 5. Open the 1433 port for TCP in the Windows firewall. Refer to the Microsoft’s guide for instructions. Note that for named SQL Server instances, the 1434 port should be opened for UDP.

Step 6. Run the Data Server:

on Windows


on macOS and Ubuntu/Linux


Now the Data Server should successfully connect to your Microsoft SQL Server database.

What’s next?

You may be interested in the following articles: