☝️Small business or a startup? See if you qualify for our special offer.
+
All documentation
  • Introduction
  • Connecting to data source
    1. Supported data sources
    2. Connecting to other data sources
  • Browser compatibility
  • Documentation for older versions
  • Data sources guide

    This tutorial describes how to connect Flexmonster Data Server used as a Windows/Unix service to your data. Server configurations vary depending on the data source type: database, JSON, or CSV.

    Prerequisites

    • Flexmonster Data Server installed as a service
    • Flexmonster Admin Panel

    If they are not already installed, complete the following guide: Installing Flexmonster Data Server as a Windows/Unix service.

    Connecting to databases

    Flexmonster Data Server supports the following databases: MySQL, MariaDB, Microsoft SQL Server, Microsoft Azure SQL, PostgreSQL, and Oracle.

    To connect to a database with Flexmonster Data Server, open Flexmonster Admin Panel and go to Indexes > Add New Index. Then fill in the Name, Type, Database type, Connection string, and Query fields:

    Sample configuration of a MySQL index

    "index-database" is a dataset identifier. It will be used to configure the data source in Flexmonster Pivot.

    When the index configuration is complete, click Create. The index will be automatically added to your index pool.

    Learn more about connecting to a database with the Data Server in our detailed guides:

    Connecting to JSON

    To connect to JSON with Flexmonster Data Server, open Flexmonster Admin Panel and go to Indexes > Add New Index. Then fill in the Name, Type, and Path to file fields:

    Sample configuration of a JSON index

    "index-json" is a dataset identifier. It will be used to configure the data source in Flexmonster Pivot.

    When the index configuration is complete, click Create. The index will be automatically added to your index pool.

    Learn more about connecting to JSON with the Data Server in our detailed guide: Connecting to JSON using Flexmonster Data Server.

    Connecting to CSV

    To connect to CSV with Flexmonster Data Server, open Flexmonster Admin Panel and go to Indexes > Add New Index. Then fill in the Name, Type, and Path to file fields. Also, specify Delimiter, Decimal separator, and Thousands separator if non-default characters are used in your CSV file:

    Sample configuration of a CSV index

    "index-csv" is a dataset identifier. It will be used to configure the data source in Flexmonster Pivot.

    When the index configuration is complete, click Create. The index will be automatically added to your index pool.

    Learn more about connecting to CSV with the Data Server in our detailed guide: Connecting to CSV using Flexmonster Data Server.

    Configuring the report

    In Flexmonster Pivot, the report should be configured as follows:

    const pivot = new Flexmonster({
    container: "pivotContainer",
     report: {
       dataSource: {
         type: "api",
         url: "http://localhost:9500",
         index: "index-json"
    }
    }
    });

    Note The index must match the name of the index defined when configuring Flexmonster Data Server (e.g., "index‑json").

    See the full list of Flexmonster properties used to configure the dataSource object.

    List of supported configuration parameters

    When connecting to data using Flexmonster Data Server, you can use the following properties of the DataSourceObject:

    List of properties
    Property/TypeDescription
    type
    String
    The data source type. When connecting to data using Flexmonster Data Server, set the type to "api".
    url
    String
    The URL to Flexmonster Data Server.
    index
    String
    The dataset identifier.
    mapping
    MappingObject | String
    optional Defines how fields from the data source are treated and presented within the component. For example, you can specify the field’s captions, define a type for a field, configure multilevel hierarchies, etc. Read more in the Mapping guide.
    Can be either an inline MappingObject or a URL to a JSON file with the mapping Live example.
    requestHeaders
    Object
    optional Adds custom request headers. Consists of "key": "value" pairs, where "key" is a header name and "value" is its value Live example.
    Note The requestHeaders property is not saved when obtaining the report via save() and getReport() API calls.
    singleEndpoint
    Boolean
    optional When set to true, all Flexmonster Pivot’s requests are sent to a single endpoint specified in the url property.
    Default value: false.
    withCredentials
    Boolean
    optional Indicates whether cross-site Access-Control requests should be made using credentials such as authorization headers (true) or not (false). For more details, refer to MDN web docs.
    Setting the withCredentials flag to true is recommended when using Windows authentication and other types of server authentication. When set to false, the browser does not ask for credentials and does not include them in outgoing requests.
    Default value: false.
    concurrentRequests
    Boolean
    optional When set to false, Flexmonster sends a request for each expand/drill-down separately and waits for the Data Server’s response before sending a new request. This can result in slow performance when there are a lot of expands/drill-downs in the report.
    When the concurrentRequests is true, Flexmonster sends requests for expands/drill-downs of a particular level simultaneously. To get the best performance, enable the HTTP/2 protocol in the Data Server.
    Default value: false.

    Display non-Latin characters correctly

    If your data contains non-Latin characters, ensure you have set UTF-8 encoding for your data and page. This is required to display the data correctly in the component.

    About response caching

    When Flexmonster Pivot requests data, Flexmonster Data Server sends a response and then caches it. If the component sends the same request again, the server responds with the data from its cache.

    The Data Server’s cache has a limit. When the cache does not have enough space for a new response, the Data Server deletes one of the previously cached responses. You can manage the cache size via the Cache size limit configuration.

    The Data Server clears the cache when restarted.

    See also