Flexmonster Software License Agreement (“Agreement”) has been revised and is effective as of January 8, 2025.
The following modifications were made:
The modified version of Agreement is available here.
Downloading, installing, and/or continuing to use Flexmonster Software after January 8, 2025, constitutes Licensee’s acceptance of the terms and conditions of the modified version of Agreement. If Licensee does not agree to any of these terms and conditions, they must cease using Flexmonster Software and must not download, install, use, access, or continue to access Flexmonster Software. By continuing to use Flexmonster Software or renewing the license or maintenance after the effective date of these modifications to Agreement, Licensee accepts and agrees to be bound by the terms and conditions of the modified Agreement.
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.
The Data Server is available for the following operating systems:
npm install -g flexmonster-cli
To install the Data Server, continue with the following steps.
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.
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.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.
If Flexmonster is not yet embedded, set up an empty component in your webpage:
Complete the Integrating Flexmonster guide. Your code should look similar to the following example:
const pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true
});
Complete the Integration with React guide. Your code should look similar to the following example:
<FlexmonsterReact.Pivot
toolbar={true}
/>
Complete the Integration with Angular guide. Your code should look similar to the following example:
<fm-pivot [toolbar]="true"> </fm-pivot>
Complete the Integration with Vue guide. Your code should look similar to the following example:
<Pivot toolbar />
To connect to Flexmonster Data Server, configure the report as follows:
const pivot = new Flexmonster({
container: "pivotContainer",
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.
See the full list of Flexmonster properties used to configure the dataSource object.
Open the webpage in the browser: the pivot table with the sample CSV data is shown.
Learn more about configuring the report.
When connecting to data using Flexmonster Data Server, you can use the following properties of the DataSourceObject:
| Property/Type | Description |
|---|---|
| type String | The data source type. When connecting to data using Flexmonster Data Server, set the type to "api". |
| url String | The URL to the 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. |
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:
Step 1. Stop the Data Server by closing the program.
Step 2. Delete the flexmonster-data-server/ and C:/ProgramData/FlexmonsterDataServer/ folders.
Step 1. Stop the Data Server by closing the program.
Step 2. Delete the flexmonster-data-server/ and ~/.local/share/FlexmonsterDataServer/ (will resolve to /home/[current_user]/.local/share/FlexmonsterDataServer/) folders.
Step 1. Stop the Data Server by closing the program.
Step 2. Delete the flexmonster-data-server/ and ~/.local/share/FlexmonsterDataServer/ (will resolve to /home/[current_user]/.local/share/FlexmonsterDataServer/) folders.
You may be interested in the following articles: