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

Implementing the custom data source API server

This guide will help you implement your own custom data source API server. To configure your server so that it can exchange data with Flexmonster, follow these steps:

Step 1. Set up Flexmonster

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:

<fm-pivot 
[toolbar]="true">
</fm-pivot>

In React

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

<FlexmonsterReact.Pivot
toolbar={true}
/>

In Vue

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

<Pivot
ref="pivot"
toolbar>
</Pivot>

Step 2. Configure the connection in the Flexmonster report

In report.dataSource, define these parameters to connect to your custom data source API:

var pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true,
report: {
dataSource: {
    type: "api",
        url: "http://localhost:3400/api/cube",
        index: "data-set-123"
    }

}
});

Here, url is the base URL to your API endpoints and index is the identifier of your data set. index will be sent with every request.

At this step, since the back end isn’t configured yet, you won’t see any data in the pivot table if you open it in a browser.

In the next steps, you will find out how to pass the data from your server to Flexmonster using the custom data source API.

Step 3. Create endpoints to handle POST requests

Flexmonster sends POST requests to the API endpoints using the JSON format. After receiving the responses from the server, it visualizes the data in the pivot table or pivot charts. The first step in the API implementation is to create endpoints on your server to handle these POST requests.

Note: If Flexmonster Pivot is running on a different server, enable CORS.

All requests have the type property in the request body. There are 4 types of requests that can be distinguished by the URL path and type value:

  • <url>/handshake (optional) – The first (handshake) request to establish a connection between the client and server sides.
  • <url>/fields – Request for all fields with their types (i.e., meta-object or schema).
  • <url>/members – Request for all members of the field.
  • <url>/select – Request for the data.

The value of type will always be the same as the endpoint name, e.g., when a request is sent to <url>/fields, the value of type is "fields".

We also recommend that you check our sample Node.js server or sample .NET Core server that implements Flexmonster’s custom data source API for an example implementation.

Step 4. (optional) Handle the /handshake request

The first request that is sent to <url>/handshake by Flexmonster after configuring the connection is the /handshake request. It is used to establish a connection between the client and server sides and exchange some basic information. The front end sends the version of the custom data source API that it implements. Then, Flexmonster Pivot expects the version of the custom data source API implemented by the back end in response.

The /handshake request allows verifying version compatibility. If the server sends the version of the custom data source API in response to the /handshake request, the client can check whether the server and the client implement the same version of the custom data source API.

To receive notifications about version compatibility, respond to the /handshake request with the implemented version of the custom data source API:

const API_VERSION = "2.8.5";

cube.post("/handshake", async (req, res) => {
    try {
        res.json({ version: API_VERSION });
    } catch (err) {
        handleError(err, res);
    }
});

Note that the /handshake request is optional. If the server side does not implement it, Flexmonster will proceed to the next request.

Step 5. Handle the request for the data structure

The next request that is sent by Flexmonster is the /fields request sent to <url>/fields. Read more details about the /fields request in the documentation and implement a response to it for your dataset.

The custom data source API supports 3 field types: "string", "number", and "date". Note that at least one aggregation has to be supported by the server side for at least one field. For example, a field in the response can have "aggregations": ["sum"] defined:

{
"uniqueName": "Quantity",
"type": "number",
"aggregations": ["sum"]
}

This means that the backend will provide aggregated data for this field and it can be selected as a measure in Flexmonster Pivot on the client side.

When the response to the /fields request is successfully received by Flexmonster Pivot, the Field List with all available fields is shown. To see it, open the HTML page in a browser.

From now on, the client configured in step 2 should show you the data.

Step 6. Handle requests for members

The next request to handle is the request for the field’s members that is sent to <url>/members.

Read more details about the /members request in the documentation and implement a response for your dataset.

Now in the Field List, you will be able to select a string field for rows or for columns and retrieve its members.

Note: for the custom data source API, date members should be passed to Flexmonster in the Unix timestamp format to be recognized correctly. For example, the date "2016-02-07" is "1454803200" in the form of a Unix timestamp.

Step 7. Handle requests for aggregated data

When a field is selected for rows and/or columns and a numeric field is selected for measures in the Field List, the /select request is sent to the endpoint <url>/select.

To handle the /select request, at least one aggregation function must be implemented. It is easiest to start with one aggregation (e.g., "sum") and extend the list of supported aggregations later.

This is the time to handle the query.aggs part of the request (the /select request can also have query.filter and query.fields but they can be skipped for now):

{
    "type": "select"
    "index": string,
    "query": {
        "aggs": {
            "values"[]: {
                "field": FieldObject,
                "func": string
            },
            "by": {
                "rows": FieldObject[],
                "cols": FieldObject[]
            }
        }
    }
}

When the response to a /select request is successfully received by Flexmonster, the pivot table is shown.

What’s next?

You may be interested in the following articles: