Get Free Trial
Get Free Trial
  1. API reference
  2. Welcome
    1. Getting started
    2. Get Flexmonster
    3. Quick start
    4. System requirements
    5. Troubleshooting
    6. Managing license keys
    7. Migrating from WebDataRocks to Flexmonster
  3. Integration with frameworks
    1. Available tutorials
    2. Integration with Angular
    3. Integration with React
    4. Integration with Vue
    5. Other integrations
      1. Integration with Python
        1. Integration with Django
        2. Integration with Jupyter Notebook
      2. Integration with React Native
      3. Integration with Blazor
      4. Integration with AngularJS (v1.x)
      5. Integration with TypeScript
      6. Integration with R Shiny
      7. Integration with jQuery
      8. Integration with Ionic
      9. Integration with Electron.js
      10. Integration with Webpack
      11. Integration with RequireJS
  4. Connecting to Data Source
    1. Supported data sources
    2. JSON
      1. Connecting to JSON
      2. Connecting to JSON using Flexmonster Data Server
      3. Data types in JSON
    3. CSV
      1. Connecting to CSV
      2. Connecting to CSV using Flexmonster Data Server
      3. Data types in CSV
    4. Database
      1. Connecting to SQL databases
      2. Connecting to a MySQL database
      3. Connecting to a Microsoft SQL Server database
      4. Connecting to a PostgreSQL database
      5. Connecting to an Oracle database
    5. Flexmonster Data Server
      1. Introduction to Flexmonster Data Server
      2. Getting started with Flexmonster Data Server
      3. Flexmonster Admin Panel Guide
      4. Data sources guide
      5. Security and authorization guide
      6. The Data Server as a DLL
        1. Getting started with the Data Server as a DLL
        2. Referencing the Data Server as a DLL
        3. Implementing the API controller
        4. Implementing the server filter
        5. Implementing the custom parser
        6. DLL configurations reference
        7. The controller's methods for request handling
      7. The Data Server as a console application
        1. Installing the Data Server as a console application
        2. Configurations reference
        3. Data sources guide
        4. Security and authorization guide
      8. Troubleshooting the Data Server
    6. MongoDB
      1. Introduction to Flexmonster MongoDB Connector
      2. Getting started with the MongoDB Connector
      3. Embedding the MongoDB Connector into the server
      4. Configuring the MongoDB Connector
    7. Microsoft Analysis Services
      1. Connecting to Microsoft Analysis Services
      2. Getting started with Flexmonster Accelerator
      3. Referencing the Accelerator as a DLL
      4. Configuring the authentication process
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    8. Custom data source API
      1. Introduction to the custom data source API
      2. A quick overview of a sample Node.js server
      3. A quick overview of a sample .NET Core server
      4. Implement your own server
        1. Implementing the custom data source API server
        2. Implementing filters
        3. Supporting more aggregation functions
        4. Supporting multilevel hierarchies
        5. Returning data for the drill-through view
        6. Testing your custom data source API server
    9. Elasticsearch
      1. Connecting to Elasticsearch
      2. Configuring the mapping
    10. Pentaho Mondrian
      1. Connecting to Pentaho Mondrian
      2. Getting started with the Accelerator
      3. Configuring Mondrian roles
      4. Configuring username/password protection
      5. Configuring a secure HTTPS connection
      6. Troubleshooting
    11. Connecting to other data sources
  5. Accessibility
    1. Accessibility overview
    2. Keyboard navigation
  6. Configuring the component
    1. Available tutorials
    2. Getting started with the report
    3. Configure the data source
      1. Data source
      2. Mapping
    4. Define which data to show
      1. Slice
      2. Custom sorting
      3. Calculated values
    5. Manage Flexmonster’s functionality
      1. Options
      2. Configuring global options
    6. Format fields
      1. Number formatting
      2. Date and time formatting
      3. Conditional formatting
    7. Save component configs
      1. Get the report from the component
      2. Set the report for the component
      3. Share the report
      4. Export and print
  7. Charts
    1. Available tutorials
    2. Flexmonster Pivot Charts
    3. Integration with Highcharts
    4. Integration with amCharts
    5. Integration with Google Charts
    6. Integration with FusionCharts
    7. Integration with any charting library
  8. Customizing
    1. Available tutorials
    2. Customizing the Toolbar
    3. Customizing appearance
    4. Customizing the context menu
    5. Customizing the grid
    6. Customizing the pivot charts
    7. Localizing the component
  9. Security
    1. Security in Flexmonster
    2. Security aspects of connecting to an OLAP cube
      1. Ways of connecting to an OLAP cube
      2. The data transfer process
      3. Data security
      4. Data access management
  10. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.8 to 2.9
    4. Migration guide from 2.7 to 2.8
    5. Migration guide from 2.6 to 2.7
    6. Migration guide from 2.5 to 2.6
    7. Migration guide from 2.4 to 2.5
    8. Migration guide from 2.3 to 2.4
    9. Migration guide from 2.2 to 2.3
  11. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  12. Documentation for older versions
Table of contents

flexmonster add

flexmonster add|a [requiredArg] [options]

The Flexmonster CLI command that downloads the needed Flexmonster tool to the project. 

Arguments

The flexmonster add command can be run with the following required arguments:

Argument Description
accelerator Downloads the package with Flexmonster Accelerator for SSAS (the Flexmonster Accelerator.msi file) to the current folder. For example:
flexmonster add accelerator -i
fds Downloads a package with Flexmonster Data Server to the current folder.
If used with the -r option, installs the Data Server as a Windows/Unix service and runs it; then installs and runs Flexmonster Admin Panel. For example:
flexmonster add fds -r
To download the Data Server and run it as a console application, use the following command:
flexmonster add fds executable -r
Learn more about the Data Server installation process.
flexmonster Downloads Flexmonster Pivot to the node_modules/ folder and adds it as an npm dependency to the package.json file. Run the command from the folder containing package.json.
For example:
flexmonster add flexmonster
ng-flexmonster Downloads the Flexmonster Angular module to the node_modules/ folder and adds it as an npm dependency to the package.json file. Run the command from the folder containing package.json.
For example:
flexmonster add ng-flexmonster
react-flexmonster Downloads the Flexmonster React module to the node_modules/ folder and adds it as an npm dependency to the package.json file. Run the command from the folder containing package.json.
For example:
flexmonster add react-flexmonster
vue-flexmonster Downloads the Flexmonster Vue module to the node_modules/ folder and adds it as an npm dependency to the package.json file. Run the command from the folder containing package.json.
For example:
flexmonster add vue-flexmonster
theme-builder Downloads the custom theme builder to the current folder. For example:
flexmonster add theme-builder -i

Options

The flexmonster add command can be run with the following options:

Option Description
--install, -i Depending on the tool added, the option can automatically:
  • Initiate the installation of Flexmonster Accelerator for SSAS.
  • Install all the needed npm dependencies for the custom theme builder.
--run, -r The -r option can do the following:
  • For the flexmonster fds command, it installs the Data Server as a Windows/Unix service and then runs it. Besides, it installs and runs Flexmonster Admin Panel.
  • For the flexmonster fds executable command, it runs the Data Server as a console application.
--help, -h Shows the short guidance on this command in the console. Use this command to see all the possible uses of the add command.

What’s next?

You may be interested in the following articles: