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. Component overview
    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. Integration with Python
      1. Integration with Django
      2. Integration with Jupyter Notebook
    6. Integration with React Native
    7. Integration with AngularJS (v1.x)
    8. Integration with TypeScript
    9. Integration with R Shiny
    10. Integration with jQuery
    11. Integration with Ionic
    12. Integration with Electron.js
    13. Integration with Webpack
    14. 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
      6. Connecting to other databases
    5. Flexmonster Data Server
      1. Getting started with Flexmonster Data Server
      2. Installation guide
      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. Referring 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
    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. Referring 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. Implementing the custom data source API server
      5. Implementing filters
      6. Supporting more aggregation functions
      7. Returning data for the drill-through view
    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
  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 Google Charts
    5. Integration with FusionCharts
    6. Integration with any charting library
  8. Customizing
    1. Customizing the Toolbar
    2. Customizing appearance
    3. Customizing the context menu
    4. Customizing the grid
    5. Customizing the pivot charts
    6. 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
    9. Documentation for older versions
  10. Flexmonster CLI Reference
    1. Overview
    2. flexmonster create
    3. flexmonster add
    4. flexmonster update
    5. flexmonster version
    6. flexmonster help
Table of contents

Referring 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 start referencing the Data Server as a DLL.

Prerequisites

In this tutorial, Visual Studio 2019 is used 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

Set up an empty component in your HTML page. If Flexmonster Pivot is not yet embedded – return to Quick start. Your code should look similar to the following example:

<div id="pivotContainer">The component will appear here</div>
<script src="flexmonster/flexmonster.js"></script>
<script>
    var pivot = new Flexmonster({
        container: "pivotContainer",
        toolbar: true,
        licenseKey: "XXXX-XXXX-XXXX-XXXX-XXXX"
   });
</script>

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 the 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 make the server configuration process easier, create a project based on the API template:

Step 3. Install Flexmonster.DataServer.Core.dll

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

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

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

dotnet add package Flexmonster.DataServer.Core 

Step 4. Include Flexmonster.DataServer.Core to 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 adding the Data Server configurations is using 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 configurations available 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. Set the configurations in the configuration file the following way:

"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 the Data Server configurations

In previous steps, we specified configurations for the Data Server in the configuration file. To apply these configurations, 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 configuration
services.ConfigureFlexmonsterOptions(Configuration);
services.AddFlexmonsterApi();
// other services configurations
}

Step 9. 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.

Step 10. 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. See how to enable CORS in ASP.NET Core.

Step 11. Run the project

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

dotnet run

Step 12. Configure the report

On the client side, configure the report as follows:

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

}
});

Note: 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: