☝️Small business or a startup? See if you qualify for our special offer.
+
All documentation
  • Introduction
  • Connecting to data source
    1. Supported data sources
    2. Connecting to other data sources
  • Browser compatibility
  • Documentation for older versions
  • Flexmonster Admin Panel guide

    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.

    Overview

    Flexmonster Admin Panel contains several tabs:

    • Indexes — manage indexes for your data.
    • Settings — edit the Data Server's configs: port, HTTPS, and others. 
    • Security — configure users for basic authorization.
    • Monitoring — monitor memory usage and active connections to the Data Server.
    • Diagnostics — see the Data Server's logs. 
    • Help — check out useful information about the Admin Panel and the Data Server.

    All configurations set in the Admin Panel are stored in the flexmonster-data-server/flexmonster-config.json file.

    You can add or change configurations directly in the flexmonster-config.json file. This can be useful if you want to use the Data Server as a service on a computer without a GUI. Also, it allows you to set configurations that are not available in the Admin Panel (e.g., HSTS, RefreshSchedule, DataRefreshSchedule). See all available configurations.

    Note flexmonster-config.json might be located in the following folder if you have been using the Data Server as a service prior to version 2.9.58:

    • On Windows – C:/ProgramData/FlexmonsterDataServer/.
    • On macOS and Ubuntu/Linux – ~/.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.

    Indexes

    The Indexes tab allows managing indexes. You can:

    • Add indexes
    • Edit and delete them
    • Reload indexes
    • Disable them

    Add indexes

    To create a new index, click Add New Index:

    Each index has the following configurations:

    • Name. This field defines the index name. It will be used to configure the connection on the client side.
    • Type. This dropdown menu contains possible data source types: JSON, CSV, or Database.
      Depending on the chosen data source type, you will need to set different configurations that are described below.
    • Refresh time. Defines how often the Data Server reloads the data for the index. The refresh time is specified in minutes and is measured from the moment the Data Server starts up.
      By default, the refresh time is 0, which means the Data Server will not reload the data.

    Index configurations for the JSON and CSV data source types:

    • Path to file. In this field, specify the path to the file with your data. You can click the folder icon to choose the needed file using Explorer.

    Index configurations for the CSV data source type:

    • Delimiter. Specify the field delimiter if anything other than , separates СSV fields.
    • Decimal separator. It defines the specific character used to separate decimal parts of numbers. For example, if commas separate decimal parts of numbers (e.g., 3,14), set the decimal separator to ,. Default value: ..
    • Thousands separator. Defines the specific character used to separate groups of digits in numbers. For example, if periods separate groups of digits in numbers (e.g., 1.000 for one thousand), set the thousands separator to .. Default value: ,.

    Index configurations for the Database data source type:

    • Database type. The database name: MySql, MariaDB, MSSQL, PostgreSQL, or Oracle.
    • Connection string. Specify the connection string to your database here. Click Test to check whether the provided connection string is correct.
      Note that there are specifics of setting passwords with special characters in the connection string. The Data Server parses such passwords correctly unless the password contains ; or ". These symbols are treated as delimiters, so if your password contains them, enclose it in single quotes (e.g., Pwd='123;"45').
    • Query. Specify an SQL query to define the subset of data that the Data Server should fetch.

    When the index configuration is complete, click Create to add the index to your index pool.

    Edit or delete indexes

    Reload indexes

    Disable indexes

    Settings

    The Settings tab

    This tab contains the Data Server's configs. They are visually divided into the following parts:

    • General
    • Data storage
    • Database query
    • Https
    • Security
    • Report sharing
    • Import configs

    General

    Data storage

    Database query

    Https

    Security

    Report sharing

    This block allows configuring the report-sharing functionality. It contains the following configurations:

    • Endpoint. Indicates whether the endpoint to share reports is enabled in the Data Server. Default value: disabled.
    • Custom path to folder. This configuration is available only when the endpoint is enabled. Defines the folder to which the Data Server saves reports. By default, reports are saved to the following locations:
      • On Windows - C:/ProgramData/FlexmonsterDataServer/reports/.
      • On macOS and Ubuntu/Linux - ~/.local/share/FlexmonsterDataServer/reports/ (will resolve to  /home/[current_user]/.local/share/FlexmonsterDataServer/reports/).
    • Report expiration time. Defines how long the saved reports are stored. The time is set in minutes. Default value: 0 (reports are stored permanently).
      This configuration is available only when the endpoint is enabled.
    • Max folder size. The maximum memory size available for report saving (in MB). Default value: 0 (unlimited).
      This configuration is available only when the endpoint is enabled.
    • Auto delete. Should be used with the Max folder size configuration. Defines whether to delete older reports when the folder is full. If enabled, older reports will be deleted automatically until there is enough memory for a new report. Default value: disabled (older reports are not deleted).
      This configuration is available only when the endpoint is enabled.

    Import configs

    Security

    In the Security tab, you can manage users for basic authorization:

    • Add users
    • Edit and delete users

    Add users

    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.

    Edit or delete users

    Monitoring

    Monitoring tab in the Admin Panel

    The Monitoring tab contains information about used memory and active connections.

    Diagnostics

    Diagnostics tab in the Admin Panel

    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.

    Help

    Help tab in the Admin Panel

    The Help tab contains useful information about the Admin Panel and the Data Server:

    • A user interface overview.
    • Links to troubleshooting and other related documentation.
    • Admin Panel and Data Server versions.

    Running the Data Server

    Start the Data Server

    The Admin Panel's lower-left corner contains the following controls:

    • Start Server - click to start the Data Server. This button appears when the Data Server is stopped.
    • Stop Server - click to stop the Data Server. This button appears when the Data Server is running.
    • Restart Server - click to restart the Data Server.

    What’s next?

    You may be interested in the following articles: