Despite the COVID-19 outbreak, our team continues operating at full speed. We are always here to support and answer all your questions.

Feel free to reach out by filling this quick form.

Fill the form
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 AngularJS (v1.x)
      4. Integration with TypeScript
      5. Integration with R Shiny
      6. Integration with jQuery
      7. Integration with Ionic
      8. Integration with Electron.js
      9. Integration with Webpack
      10. 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. Configurations reference
      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. 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
    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. 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
  6. Configuring report
    1. What is a report
    2. Data source
    3. Slice
    4. Options
    5. Mapping
    6. Number formatting
    7. Conditional formatting
    8. Set the report for the component
    9. Get the report from the component
    10. Date and time formatting
    11. Configuring global options
    12. Export and print
    13. Calculated values
    14. Custom sorting
  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. Updating to the latest version
    1. Updating to the latest version
    2. Release notes
    3. Migration guide from 2.7 to 2.8
    4. Migration guide from 2.6 to 2.7
    5. Migration guide from 2.5 to 2.6
    6. Migration guide from 2.4 to 2.5
    7. Migration guide from 2.3 to 2.4
    8. Migration guide from 2.2 to 2.3
  10. Flexmonster CLI Reference
    1. Overview
    2. Troubleshooting the CLI
    3. flexmonster create
    4. flexmonster add
    5. flexmonster update
    6. flexmonster version
    7. flexmonster help
  11. Documentation for older versions
Table of contents

Referencing the Data Server as a DLL

This guide describes the process of embedding Flexmonster Data Server in a .NET Core application. Follow the steps below to reference the Data Server as a DLL.

Prerequisites

In this tutorial, we use Visual Studio 2019 as an IDE. If you do not have Visual Studio installed, download it here.

To use Flexmonster Data Server as a DLL, you need Microsoft .NET Core 3.0 or higher. Get it here if it’s not already installed on your machine.

Step 1. Embed the component into your web page

If Flexmonster is not yet embedded, set up an empty component in your web page:

In pure JavaScript

Complete the Quick start guide. Your code should look similar to the following example:

var pivot = new Flexmonster({
    container: "pivotContainer",
    toolbar: true
});

In Angular

Complete the Integration with Angular guide. Your code should look similar to the following example:

<fm-pivot 
[toolbar]="true">
</fm-pivot>

In React

Complete the Integration with React guide. Your code should look similar to the following example:

<FlexmonsterReact.Pivot
toolbar={true}
/>

In Vue

Complete the Integration with Vue guide. Your code should look similar to the following example:

<Pivot
ref="pivot"
toolbar>
</Pivot>

Now it’s time to embed Flexmonster Data Server into your ASP.NET Core project.

Step 2. Create a new ASP.NET Core web application

Skip this step if you already have an ASP.NET Core project. Otherwise, create a new project:

Via the File menu

Via the start window

In the project templates menu, select the ASP.NET Core template:

Then, to simplify the server configuration process, create a project based on the API template:

Step 3. Install Flexmonster.DataServer.Core.dll

Flexmonster.DataServer.Core.dll can be installed with NuGet – the Visual Studio’s package manager:

  1. Right-click on the project and select the Manage NuGet Packages item:
  2. In the Browse tab, search for the Flexmonster.DataServer.Core package and install it:

Another way to install Flexmonster.DataServer.Core.dll is by running the following command in the console:

dotnet add package Flexmonster.DataServer.Core 

Step 4. Include Flexmonster.DataServer.Core in the Startup.cs file

Startup.cs is located in the project’s root directory. Add the following line of code to the beginning of the file:

using Flexmonster.DataServer.Core;

Step 5. Register FlexmonsterAPIService in the dependency injection container

In the ConfigureServices() method of the Startup.cs file, add the following line of code:

services.AddFlexmonsterApi();

Step 6. Configure the data sources

For Flexmonster.DataServer.Core.dll, it is possible to configure data sources and different data storage options. The most convenient way of setting the Data Server configuration is to use the configuration file.

In the configuration file (e.g., appsettings.json), define the data sources to use. For example:

"DataSources": 
[
{
"Type": "json",
"Indexes": {
"index-json": {
"Path": "data.json"
}
}
},
//other data sources
],

To learn more about the available configurations for Flexmonster.DataServer.Core.dll, refer to the DLL configurations guide.

Step 7. (optional) Set the data storage options

Data storage options include the data refresh time and the cache size limit. The data refresh time defines how often the data is reloaded from a file or a database. The cache size limit is the maximum number of cached server responses for every index specified in the "DataSources" property. You can set the configurations in the configuration file like this:

"DataStorageOptions": {
"DataRefreshTime": 60,
"CacheSizeLimit": 150
}

The data refresh time is set in minutes. If the refresh time is not defined, the data is not reloaded.

If the cache size limit is not specified, the number of cached responses is 100.

Step 8. Add a configuration object to the Startup.cs file

The IConfiguration object contains user configurations and is used to pass them to the Data Server. Create a variable with the IConfiguration type and initialize it in the constructor:

public Startup(IConfiguration configuration)
{
Configuration = configuration;
}

public IConfiguration Configuration { get; }

Step 9. Add the Data Server configurations

In the previous steps, we configured the Data Server in the configuration file. To apply this configuration, add the following line of code to the ConfigureServices() method of the Startup.cs file:

services.ConfigureFlexmonsterOptions(Configuration);

Now the ConfigureServices() method of the Startup.cs file should look similar to the following:

public IConfiguration Configuration { get; }

public void ConfigureServices(IServiceCollection services)
{
// other services configurations
services.ConfigureFlexmonsterOptions(Configuration);
services.AddFlexmonsterApi();
// other services configurations
}

Step 10. Implement the API controller

The API controller is responsible for handling the requests from Flexmonster Pivot. The implementation of the controller is described in the API controller guide.

After you implement the API controller, add the following lines of code to the ConfigureServices() and Configure() methods:

public void ConfigureServices(IServiceCollection services)
{
// other configurations
services.ConfigureFlexmonsterOptions(Configuration);
services.AddFlexmonsterApi();
services.AddControllers();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// other configurations
app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}");
});

}

Step 11. Enable cross-origin resource sharing (CORS)

Due to the same-origin policy, the browser only allows requests that come from the same origin. Сross-origin resource sharing (CORS) allows web applications to make cross-domain requests.

If the ASP.NET Core server and the client share the same origin, skip this step. Otherwise, CORS must be enabled to allow Flexmonster Pivot to send requests to Flexmonster.DataServer.Core.dll:

public void ConfigureServices(IServiceCollection services)
{
// other configurations
services.ConfigureFlexmonsterOptions(Configuration);
services.AddFlexmonsterApi();
services.AddControllers();
services.AddCors();
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// other configurations
app.UseCors(builder => {
builder.AllowAnyOrigin().AllowAnyMethod().AllowAnyHeader();
});


app.UseEndpoints(endpoints =>
{
endpoints.MapControllerRoute(
name: "default",
pattern: "{controller=Home}/{action=Index}");
});
}

Find out how to enable CORS in ASP.NET Core here.

Step 12. Run the project

The ASP.NET Core project can be run either using Visual Studio or the console. To run the project from the console, enter the following command:

dotnet run

Step 13. Configure the report

On the client side, configure the report as follows:

new Flexmonster({
container: "pivotContainer",
report: {
dataSource: {
type: "api",
url: "http://localhost:5000/api", // replace with your url
index: "index-json"
}

}
});

index must match the name of the index defined in step 6 (e.g., "index_json").

Now Flexmonster.DataServer.Core.dll is configured and ready to connect to Flexmonster Pivot. Open the pivot table in the browser to see the data.

What’s next?

You may be interested in the following articles: