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. Component overview
    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
      6. Connecting to other databases
    5. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      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. Referring 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
    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. Referring 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. Returning data for the drill-through view
    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
  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. Customizing the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. Customizing the grid
    5. Customizing the pivot charts
    6. 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
    9. Documentation for older versions
  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
Table of contents

Configurations reference

This tutorial describes Flexmonster Data Server configuration. To install the Data Server, refer to our installation guide.

Table of contents:

Available configurations

Flexmonster Data Server can be configured in the flexmonster-config.json file. It contains the following properties:

  • "DataSources" – Array of objects. Allows configuring the data sources. Each object has the following properties:
    • "Type" – String. The type of the data source: "json""csv", or "database".
    • "DatabaseType" (optional) – String. The type of the database: "mysql""mssql""postgresql", or "oracle". Only for "database" data source type.
    • "ConnectionString" (optional) – String. A connection string for the database. Only for "database" data source type.
    • "Indexes" – Object. Contains a list of datasets. Each dataset is represented by a "key": "value" pair, where "key" is a dataset name, and "value" is an object with the following properties:
      • "Path"(optional) – String. The path to the file with data. Only for "json" and "csv" data source types.
      • "Query" (optional) – String. The query to execute (e.g., "SELECT * FROM tablename"). Only for "database" data source type.
      • "Delimiter" (optional) – String. Defines the specific fields separator to split each CSV row. There is no need to define it if the CSV fields are separated by ,. This property is required only if another character separates fields. Default value: ",".
      • "DecimalSeparator" (optional) – String. Defines the specific character used to separate decimal parts of numbers. For example, to import CSV data with commas used to separate decimal parts of numbers (e.g., 3,14), set the "DecimalSeparator" property as ",". Default value: ".".
      • "ThousandSeparator" (optional) – String. Defines the specific character used to separate groups of digits in numbers. For example, to import CSV data with periods used to separate groups of digits in numbers (e.g., 1.000 for one thousand), set the "ThousandSeparator" property as ".". Default value: ",".
  • "Security" (optional) – Object. Allows managing the data access security. It contains the following properties:
    • "Authorization" (optional) – Object. Has the following properties:
      • "Enabled" – Boolean. Indicates whether the “Basic Authorization” for Flexmonster Data Server is enabled. When set to true, the authorization is enabled. Default value: false.
    • "CORS" (optional) – Object. Allows configuring the cross-origin resource sharing for Flexmonster Data Server. It contains the following properties:
      • "AllowOrigin" (optional) – String. The origin from which the server accepts the requests. If "AllowOrigin" is set to "*", requests from all origins are accepted.
        Note that if authorization is enabled ("Enabled": true), "*" cannot be set as the origin. In this case, specific origins must be defined. Several origins can be defined as follows:
        "AllowOrigin": "http://localhost, https://example.com"
        Default value: "*".
    • "HSTS" (optional) — Object. Allows configuring the Strict-Transport-Security (HSTS) response header. Contains the following properties:
      • "MaxAge" — Number. Defines how long the browser remembers that the site should be accessed only via HTTPS. The "MaxAge" property is set in seconds.
      • "IncludeSubDomains" (optional) — Boolean. Defines whether the Strict-Transport-Security header applies to the site’s subdomains (true) or not (false). Default value: false.
      • "Preload" (optional) — Boolean. Defines whether the site is in the HSTS preload list (true) or not (false). For details refer to the MDN documentation about HSTS. Default value: false.
    • "Headers" (optional) — Object. Allows adding response headers. This object consists of "key": "value" pairs, where "key" is a header name, and "value" is its value.
      We recommend adding response headers carefully and only if they are required for the project. Specifying an existing header with the wrong value can lead to runtime errors.
      Here is an example of how response headers can be specified:
      "Headers": {
      "Content-Security-Policy": "default-src 'self'",
      "X-Content-Type-Options": "nosniff",
      "X-Frame-Options": "SAMEORIGIN",
      "X-XSS-Protection": "1; mode=block"
      }
  • "DataStorageOptions" (optional) – Object. Allows configuring options for data storage. It has the following properties:
    • "DataRefreshTime" (optional) – Number. Defines how often the data is reloaded from a file or a database. The refresh time is set in minutes. If the "DataRefreshTime" is not specified, the data will not be reloaded.
    • "CacheSizeLimit" (optional) – Number. The maximum number of cached server responses for every index defined in the "DataSources" property. When set to 0, the Data Server does not cache the responses. Default value: 100.
  • "Port" (optional) – String. The number of the port Flexmonster Data Server runs on. Also, it can be set by running this command in the console:

    on Windows

    flexmonster-data-server.exe -p 7777

    on macOS and Ubuntu/Linux

    ./flexmonster-data-server -p 7777
    Default value: "9500".
  • "HTTPS" (optional) – Object. Allows configuring the HTTPS protocol. It contains the following properties:
    • "Enable" (optional) – Boolean. Indicates whether the HTTPS protocol is enabled (true) or not (false). Default value: false.
    • "Certificate" (optional) – Path-Password Object|Subject-Store Object. Allows adding a certificate. By default, if the certificate is not specified, the generated development certificate will be used. The certificate can be added with either Path-Password Object or Subject-Store Object. Each of them has different properties.
      The Path-Password Object has the following properties:
      • "Path" – String. The URL to the certificate file.
      • "Password" – String. The password to access the certificate.
      The Subject-Store Object has the following properties:
      • "Subject" – String. The certificate subject name.
      • "Store" – String. The store from which the certificate is loaded.
      • "Location" (optional) – String. The location of the store from which to load the certificate. It can be either "CurrentUser" or "LocalMachine". Default value: "CurrentUser".
      • "AllowInvalid" (optional) – Boolean. Indicates whether to allow using invalid certificates (e.g., self-signed certificates). When set to true, invalid certificates are allowed to use. Default value: false.
    • "Protocols" (optional) – String. Establishes the HTTP protocols enabled on a connection endpoint or for the server. It can be one of the following values: "Http1", "Http2", and "Http1AndHttp2". Default value: "Http1AndHttp2".

Setting configurations dynamically

To store the connection strings and other configurations more securely, set them dynamically as command-line arguments or environment variables.

Follow a short guide to set dynamic configurations:

Step 1. Assign the parameter to the needed configuration as follows:

"DataSources": [{ 
"Type": "database",
"DatabaseType": "postgresql",
"ConnectionString": "${param}",
"Indexes": {
    "index_database": {
        "Query": "SELECT * FROM ${param2}"
      }
}
}],

param and param2 are the names of your parameters.

Step 2. Using the parameter’s name (e.g., param), pass your value to the Data Server:

As a command-line argument
on Windows

flexmonster-data-server.exe param=connectionString param2=tableName

As a command-line argument
on macOS and Ubuntu/Linux

./flexmonster-data-server param=connectionString param2=tableName

As an environment
variable

Create an environment variable, where the variable name is your parameter’s name (e.g., param), and the variable value is a needed value (e.g., connectionString).

Examples

Here is an example of configured flexmonster-config.json:

{
"DataSources": [
{
"Type": "json",
"Indexes": {
"index_json": {
"Path": "./data/data.json"
}
}
},
{
"Type": "database",
"DatabaseType": "mysql",
"ConnectionString":
"Server=localhost;Port=3333;Uid=root;Pwd=pwd;Database=TestDB",
"Indexes": {
"index_database": {
"Query": "SELECT * FROM TestTable;"
}
}
}
],
"Security": {
"Authorization": {
"Enabled": false
},
"CORS": {
"AllowOrigin": "*"
},
"HSTS": {
      "MaxAge": 31536000,
      "IncludeSubDomains": true
     },
     "Headers": {
      "Content-Security-Policy": "default-src 'self'",
      "X-Content-Type-Options": "nosniff",
      "X-Frame-Options": "SAMEORIGIN",
      "X-XSS-Protection": "1; mode=block"
     }
},
"DataStorageOptions": {
"DataRefreshTime": 60,
"CacheSizeLimit": 150
},
"Port": "9500",
"HTTPS": {
   "Enabled": true,
   "Certificate": {
  "Subject": "localhost",
  "Store": "My"
   },
   "Protocols": "Http2"
}
}

What’s next?

You may be interested in the following articles: