Installing the Accelerator as a Windows Service

This guide describes how to install Flexmonster Accelerator as a Windows Service.

The main benefits of running the Accelerator as a Windows service are:

• It runs in the background and out of sight.
• It starts automatically on Windows startup.
• It’s hard for a user to inadvertently quit the application.

Prerequisites

• Microsoft Analysis Services installed and configured
• Microsoft .NET Framework 4.7.2 or higher
• Flexmonster CLI
  Install it with the following command:

  npm install -g flexmonster-cli

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. Install Flexmonster Accelerator

Start the installation process with the following CLI command:

flexmonster add accelerator -i

The flexmonster add accelerator command does the following:

• Downloads the .zip archive with Flexmonster Accelerator.
• Automatically unpacks the files in the current folder — as a result, the flexmonster-accelerator/ folder will appear in your current directory.

The -i option, which stands for --install, automatically starts the installation using the Flexmonster Accelerator.msi setup file. When the installation begins, just follow the wizard.

The flexmonster-accelerator/ folder has the following structure:

• Flexmonster Accelerator.msi – a server-side utility that handles the connection between Microsoft Analysis Services and Flexmonster Pivot.
• flexmonster.config – a file that contains configuration parameters for the utility (connection string, port, etc.).

You can check whether the Accelerator is up and running by navigating to its URL in the browser (http://localhost:50005 by default).

Step 3. Configure Flexmonster Accelerator on the server

After a successful installation, run Flexmonster Accelerator Manager:

Click the Config button to open the flexmonster.config file, which contains configurations for the Accelerator. To learn more about them, see the configurations reference.

When the configuration is finished, restart Flexmonster Accelerator using the Accelerator Manager: click the Stop button and then click Start. Then you can close Flexmonster Accelerator Manager — the service will continue working in the background.

Step 4. Open a port for the Accelerator in the firewall

If you plan to allow connections to the Accelerator from outside the server, open the appropriate port in the firewall. The default port number is 50005, but it can be changed using the PORT parameter in the flexmonster.config file.

Step 5. Configure the component

Now it’s time to configure the client – Flexmonster Pivot Table and Charts. Let’s create a minimal configuration using the JavaScript API (replace proxyUrl, catalog and cube parameters with your specific values):

var pivot = new Flexmonster({
  container: "pivotContainer", 
  componentFolder: "node_modules/flexmonster/",
  toolbar: true,  
  report: { 
    dataSource: { 
      type: "microsoft analysis services", 

      /* URL to Flexmonster Accelerator */ 
      proxyUrl: "http://localhost:50005", 

      /* Catalog name */ 
      catalog: "Adventure Works DW Standard Edition", 
            
      /* Cube name */ 
      cube: "Adventure Works", 
                
      // Flag to use the Accelerator instead of XMLA protocol binary 
      binary: true 
    } 
  } 
}); 

var pivot = new Flexmonster({
  container: "pivotContainer", 
  componentFolder: "node_modules/flexmonster/",
  toolbar: true,  
  report: { 
    dataSource: { 
      type: "microsoft analysis services", 

      /* URL to Flexmonster Accelerator */ 
      proxyUrl: "http://localhost:50005", 

      /* Database name */ 
      catalog: "Adventure Works DW Standard Edition", 
            
      /* Model name */ 
      cube: "Adventure Works", 
                
      // Flag to use the Accelerator instead of XMLA protocol binary 
      binary: true  
    } 
  }
});  

Live example

Now launch the webpage from a browser — there you go! A pivot table is embedded in your project.

Cache control

Usually, a cache can improve performance greatly. However, if the underlying database ever changes, the cache goes out of date. By default, caching is enabled and controlled by the Accelerator.

It is also possible to disable the cache with the CACHE_ENABLED parameter in the flexmonster.config file:

CACHE_ENABLED = false

What’s next?

You may be interested in the following articles:

• Configuring the authentication process
• Configuring a secure HTTPS connection