Installing the Data Server as a console application

This guide describes how to install Flexmonster Data Server as a console application. Flexmonster Pivot can be downloaded here. You can also learn about other ways of using the Data Server.

Supported operating systems

The Data Server is available for the following operating systems:

• Windows (32-bit and 64-bit).
• macOS (64-bit and ARM64).
• Ubuntu/Linux (64-bit and ARM64).

Installing Flexmonster Data Server

Prerequisites

• Flexmonster CLI
  Install it with the following command:

  npm install -g flexmonster-cli

To install the Data Server, continue with the following steps.

Step 1. Download

To get the Data Server, run the flexmonster add fds command:

flexmonster add fds executable

This command installs the Data Server for your operating system.

The Data Server's files can be found in the flexmonster‑data‑server/ folder in your working directory.

Step 2. See the download package structure

The flexmonster-data-server/ folder has the following structure:

• flexmonster-data-server — an executable version of Flexmonster Data Server.
• flexmonster-config.json — the Flexmonster Data Server configuration file. It contains a configured ready-to-use CSV data source "sample-index". Learn more about the Data Server configuration.
• sample-data/data.csv — the file with sample CSV data to create "sample-index".
• service-install — the executable file to install the Data Server as a service.
• service-uninstall — the executable file to uninstall the Data Server as a service.
• Flexmonster-Admin-Panel — the file to install Flexmonster Admin Panel.
  Note that the Admin Panel will not connect to the Data Server used as a console application.

Step 3. Run the Data Server

To start using Flexmonster Data Server as a console application, run the executable file from the console:

flexmonster-data-server.exe

./flexmonster-data-server

Now Flexmonster Data Server is up and running. To check its status, open the http://localhost:9500/ URL in a browser.

Connecting to the Data Server

Step 1. Embed the component into your webpage

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

let pivot = new Flexmonster({
  container: "pivotContainer",
  componentFolder: "node_modules/flexmonster/",
  toolbar: true
});

<FlexmonsterReact.Pivot
 toolbar={true}
/>

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

<Pivot
 toolbar
/>

Step 2. Configure the report

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

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

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

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

Learn more about configuring the report.

Uninstalling the Data Server

To completely uninstall the Data Server, you need to delete the Data Server's executable and folders.

Note The uninstallation is irreversible, so ensure you back up the flexmonster-config.json file.

Uninstall the Data Server with the following steps:

What's next?

You may be interested in the following articles:

• Data sources guide
• Configurations reference
• Security and authorization guide
• Troubleshooting the Data Server