Getting started with Flexmonster Data Server

This walkthrough describes how to install Flexmonster Data Server. Flexmonster Pivot can be downloaded here.

Follow these guides to start using the Data Server:

Installing Flexmonster Data Server
Connecting to the Data Server

Installing Flexmonster Data Server

For easy and smooth installation of Flexmonster Data Server, follow the steps below.

Prerequisites

Flexmonster Data Server can be installed with Flexmonster CLI — a command-line interface tool for Flexmonster. Install the CLI globally using npm:

npm install -g flexmonster-cli

Now a new flexmonster command is available in the console. Learn more about Flexmonster CLI and its commands in our documentation.

Step 1. Download

Flexmonster Data Server is available for the following operating systems: Windows (both 32-bit and 64-bit), Ubuntu/Linux, and macOS. Depending on your operating system, Flexmonster CLI will download the appropriate version of the Data Server.

To start the installation, run the following CLI command:

flexmonster add fds

Step 2. See the download package structure

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. It has the following structure:

flexmonster-config.json – the Flexmonster Data Server configuration file. It contains a configured ready-to-use CSV data source "sample-index".
flexmonster-data-server or flexmonster-data-server.exe for Windows – an executable version of Flexmonster Data Server.
flexmonster-setup-users or flexmonster-setup-users.exe for Windows – an additional utility for security and authorization management.
sample-data/data.csv – the file with sample CSV data to create "sample-index" (see flexmonster-config.json).

Step 3. Run the Data Server

To start using Flexmonster Data Server, just run the executable file from the console:

on Windows

flexmonster-data-server.exe

on macOS and Ubuntu/Linux

./flexmonster-data-server

Now Flexmonster Data Server is up and running. To connect Flexmonster Pivot to the Data Server, follow the next guide.

Connecting to the Data Server

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:

<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 report

To connect to Flexmonster Data Server, configure the report as follows:

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

"sample-index" is the index defined in flexmonster-config.json for the sample-data/data.csv file.

Open the web page in the browser: the pivot table with the sample CSV data is shown.

What’s next?

You may be interested in the following articles: