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 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. Share the report
    11. Date and time formatting
    12. Configuring global options
    13. Export and print
    14. Calculated values
    15. 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. 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

Configuring the mapping

This tutorial explains how to define a mapping object for an Elasticsearch index in a report and which settings this mapping object supports.

A mapping object can have the following properties:

  • caption (optional) – String. Overrides the default name of the field.
  • aggregations (optional) — Array of strings. Represents the list of aggregation functions that can be applied to the current measure.
  • filters (optional) – Boolean. Allows enabling and disabling the UI filters for a specific field. When set to false, the UI filters are disabled. Default value: true.
  • visible (optional) – Boolean. When set to false, hides the field from the Field List.
  • interval (optional) – String. Used for the date histogram. Check out the supported time units.
  • time_zone (optional) – String. Used for the date histogram. You can specify time zones as either an ISO 8601 UTC offset (e.g., +01:00 or -08:00) or as a time zone ID as specified in the IANA time zone database, such as America/Los_Angeles. Check out this example.
  • format (optional) – String. Used for the date histogram. Check out the supported date format/patterns.
    If the datePattern option is defined, format will override its value for the field.
  • min_doc_count (optional) – Number. Used for the date histogram. Can be used to show intervals with empty values (min_doc_count: 0). Default value: 1 (empty intervals are hidden).

How to hide unnecessary fields in Elasticsearch

All unnecessary fields can be hidden by setting visible: false:

var pivot = new Flexmonster({
container: "pivotContainer",
toolbar: true,
report: {
dataSource: {
type: "elasticsearch",
/* the host for the connection */
node: "https://olap.flexmonster.com:9200",
/* the name of Elasticsearch index to connect */
index: "fm-product-sales",
/* additional setting to configure index mapping */
mapping: {
"@timestamp": {
visible: false
},
"@version": {
visible: false
},
"host": {
visible: false
},
"message": {
visible: false
},
"path": {
visible: false
}
}

}
}
});

Check out the example on JSFiddle.

How to format dates in Elasticsearch

There are two ways to format dates in Elasticsearch: 

  • Using the options.datePattern property – this will apply formatting to all date fields in the dataset. 
  • Using the mapping.format property – this will apply formatting to a certain field. If options.datePattern is defined, mapping.format will override its value.

options.datePattern

When formatting dates with the options.datePattern property, use date patterns described in the Elasticsearch documentation.

The following example demonstrates how to format dates using the options.datePattern:

new Flexmonster({
    container: "pivotContainer",
    toolbar: true,
    report: {
      dataSource: {
        type: "elasticsearch",
        node: "https://olap.flexmonster.com:9200",
        index: "fm-product-sales"
      },   
      options: {
       datePattern: "dd MMMM, yyyy"
      }

    }
});

See the full code on JSFiddle.

mapping.format

When formatting dates with the mapping.format property, use date patterns described in the Elasticsearch documentation.

The following example demonstrates how to format dates using mapping.format:

new Flexmonster({
container: "pivotContainer",
toolbar: true,
report: {
dataSource: {
type: "elasticsearch",
node: "https://olap.flexmonster.com:9200",
index: "fm-product-sales",
mapping: {
"@timestamp": {
format: "dd/MM/yyyy"
}
}
}
}
});

Check out the example on JSFiddle.

Formatting dates in the drill-through view

Elasticsearch date patterns are fully applied to dates in the pivot and compact views, while dates in the drill-through view may remain unformatted.

If you need a date pattern that is applied in all the views similarly, format date fields using patterns supported in both Flexmonster and Elasticsearch:

Supported date patterns
Expand the list of the date patterns
  • d – Day of the month. It is represented as a one or two-digit number. For example, 2 or 18.
  • dd – Day of the month. It is represented as a two-digit number. For example, 02 or 18.
  • M – Month. It is represented as a one or two-digit number. For example, 3 or 11.
  • MM – Month. It is represented as a two-digit number. For example, 03.
  • MMM – Month. It is represented as a three-letter abbreviation of the name of the month. For example, Mar.
  • MMMM – Month. It is represented as the full name of the month. For example, March.
  • yy – Year. It is represented as a two-digit number. For example, 16.
  • yyyy – Year. It is represented as a four-digit number. For example, 2016.
  • h – Hour of the day using the 12-hour format [1 – 12]. It is represented as a one or two-digit number. For example, 1 or 12.
  • hh – Hour of the day using the 12-hour format [1 – 12]. It is represented as a two-digit number. For example, 01 or 12.
  • H – Hour of the day using the 24-hour format [0 – 23]. It is represented as a one or two-digit number. For example, 0 or 23.
  • HH – Hour of the day using the 24-hour format [0 – 23]. It is represented as a two-digit number. For example, 00 or 23.
  • k – Hour of the day using the 24-hour format [1 – 24]. It is represented as a one or two-digit number. For example, 1 or 24.
  • kk – Hour of the day using the 24-hour format [1 – 24]. It is represented as a two-digit number. For example, 01 or 24.
  • m – Minutes [0 – 59]. It is represented as a one or two-digit number. For example, 0 or 59.
  • mm – Minutes [0 – 59]. It is represented as a two-digit number. For example, 00 or 59.
  • s – Seconds [0 – 59]. It is represented as a one or two-digit number. For example, 0 or 59.
  • ss – Seconds [0 – 59]. It is represented as a two-digit number. For example, 00 or 59.