Flexmonster Software License Agreement (“Agreement”) has been significantly revised and is effective as of September 30, 2024.
The following modifications were made:
The modified version of Flexmonster Software License Agreement is available here.
Downloading, installing, and/or continuing to use Flexmonster Software after September 30, 2024, constitutes Licensee’s acceptance of the terms and conditions of the modified version of Flexmonster Software License 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 under License Model or Maintenance after the effective date of any modifications to Agreement, Licensee accepts and agrees to be bound by the terms and conditions of the modified Agreement.
Flexmonster Admin Panel is a cross-platform desktop application that provides a graphical user interface for Flexmonster Data Server used as a Windows/Unix service. With the Admin Panel, you can conveniently manage indexes, security, and other configs.
In this guide, you can find a description of the Admin Panel's functionality.
Flexmonster Admin Panel contains several tabs:
All configurations set in the Admin Panel are stored in the flexmonster-data-server/flexmonster-config.json file.
Note If you have been using the Data Server as a service prior to version 2.9.58, another possible location of the flexmonster-config.json
is the following folder:
C:/ProgramData/FlexmonsterDataServer/
.~/.local/share/FlexmonsterDataServer/
(will resolve to /home/[current_user]/.local/share/FlexmonsterDataServer/
).For information on running, stopping, and restarting the Data Server, see Running the Data Server.
The Indexes tab allows managing indexes. You can:
To create a new index, click Add New Index:
Each index has the following configurations:
JSON
, CSV
, or Database
.MySql
, MariaDB
, MSSQL
, PostgreSQL
, or Oracle
. Database
data source type. JSON
and CSV
data source types.;
or "
. These symbols are treated as delimiters, so if your password contains them, enclose it in single quotes (e.g., Pwd='123;"45'
).Database
data source type.Database
data source type.,
separates СSV fields. CSV
data source type.3,14
), set the decimal separator to ,
. Only for the CSV
data source type. Default value: .
.1.000
for one thousand), set the thousands separator to .
. Only for the CSV
data source type. Default value: ,
.0
, which means the Data Server will not reload the data.When the index configuration is complete, click Create to add the index to your index pool.
To edit an index, click the index name or Details:
You can make changes to everything except the data source type.
Click Save to apply the changes.
To delete the index, click Delete Index. Before deleting, you will be prompted to confirm the action.
If the data source type is JSON
or CSV
, the Mapping configuration becomes available. It allows choosing data types for fields in your dataset.
By default, the Mapping is disabled and all field types are autodetected. If you need to set data types for some fields manually, enable the Mapping and choose the needed type from the dropdown menu: Number, String, or Date. For example:
If you disable the Mapping, your adjustments will be deleted and autodetected data types will be used.
To apply the Mapping, click Save.
The Data Server reloads data in indexes based on the Refresh time configuration. However, you can refresh an index manually by clicking Reload:
This action will update the data in the index.
Note The Data Server doesn't reload disabled indexes.
Each index can be disabled. The Data Server does not preload disabled indexes, and you cannot use them in the component.
To disable an index, click Disable:
Check Status to make sure the index is disabled.
To enable the index, click Enable.
This tab contains the Data Server's configs. They are visually divided into the following parts:
This block contains general Data Server configurations:
9500
.INFO
, WARN
, ERROR
, or FATAL
. Setting a minimum log level to WARN
or a higher level can improve the Data Server’s performance. Learn more about these log levels in the Microsoft documentation.INFO
.This block allows configuring options for data storage. It contains the following configuration:
30
. Default value: 3
.0
, the Data Server does not cache the responses. Default value: 100
.This block allows configuring options for database queries. It contains the following configurations:
Database
data source type. Default state: disabled.0
, the wait time is unlimited. Only for the Database
data source type. Default value: 150
.This block allows configuring the HTTPS protocol. It contains the following configurations:
PFX Certificate
. Added by specifying the Path to PFX certificate and the Certificate password.PEM Certificate
. Added by specifying the Path to PEM certificate and the Path to certificate key.Subject-Store
. Added by specifying the Subject name and Store..pfx
certificate. Click the folder icon to choose the certificate using a file manager.PFX Certificate
..pfx
certificate. If the certificate does not require a password, skip this configuration.PFX Certificate
..pem
certificate. Click the folder icon to choose the certificate using a file manager.PEM Certificate
..pem
file that contains the private key for the certificate. Click the folder icon to choose the private key using a file manager.PEM Certificate
.Subject-Store
.Subject-Store
.Current User
or Local Machine
. Default value: Current User
.Subject-Store
.Block
.Subject-Store
. HTTP1
, HTTP2
, and HTTP1 and HTTP2
. Default value: HTTP1 and HTTP2
.This block allows configuring the data access security. It contains the following configurations:
This block allows configuring the report-sharing functionality. It contains the following configurations:
C:/ProgramData/FlexmonsterDataServer/reports/
.~/.local/share/FlexmonsterDataServer/reports/
(will resolve to /home/[current_user]/.local/share/FlexmonsterDataServer/reports/
).0
(reports are stored permanently).0
(unlimited).Besides setting the mentioned configurations, you can import the existing flexmonster-config.json
file: just specify the path to flexmonster-config.json
in the Import configuration file section and click Apply:
In the Security tab, you can manage users for basic authorization:
To create a new user, click Add New User:
Define a username and password, then select Create to add the user.
Note Once a user is created, you cannot change the username.
To edit a user, click the username or the right arrow icon:
You can edit everything except the username.
To apply the new changes, click Edit.
To delete the user, click Delete User. Before deleting, you will be prompted to confirm the action.
The Monitoring tab contains information about used memory and active connections.
The Diagnostics tab displays the most recent Data Server logs. Click Open Logs Folder to see all the logs.
To update the log list, click Refresh Logs.
The Help tab contains useful information about the Admin Panel and the Data Server:
The Admin Panel's lower-left corner contains the following controls:
You may be interested in the following articles: