---
title: "Historian | Examples | N3uron KB V.1.20"
slug: "historian-examples"
description: "Historian is a N3uron module designed to provide a high-performance time-series storage system based on a MongoDB database. In x64 bit systems…"
updated: 2021-12-16T09:47:53Z
published: 2021-12-16T09:47:53Z
canonical: "docs.n3uron.com/historian-examples"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.n3uron.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Examples

## Retrieving data using WebUI

In this example, historized data will be monitored using **WebUI**.![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/09-Tags-used-for-this-example.png)

Figure 9: Tags used for this example

- **Step 1:** Add a new module in the “Modules” section, choose a name, and select “Historian” as the “Module type”.
- **Step 2:** Configure the Logger and API settings for the **Historian** module. In this example, the default configuration is left unedited since, in most cases, this is a valid configuration.
- **Step 3:** Configure the module. For this example, the configuration was left as per default.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/10-Module-configuration.png)

Figure 10: Module configuration

- **Step 4:** Configure the Tags History section.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/11-Tag-configuration.png)

Figure 11: Tag configuration

- **Step 5:** In the Data/Historical section, navigate to Tag list three to drag and drop the tags that will be historized to **Selected tags**, configure data retrieval parameters (**Date mode**, **Interval**, and **Mode**) and apply historization. In this example, the chosen parameters are **Current** for **Date mode** (other available options are: **Absolute** and **Relative**), 1 hour for Interval, and **Raw** for **Mode** (other available options are: **Aggregated**, **Delta**, and **Filter**).

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/12-Data-visualization-configuration.png)

Figure 12: Data visualization configuration

**Result****:**![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/13-Chart-of-historical-data.png)Figure 13: Chart of historical data

## Storing data using an external MongoDB engine

In this example, data will be stored and monitored in an external MongoDB engine. The GUI (graphical user interface) for MongoDB used for this example is **MongoDB Compass**.

- **Step 1:** Add a new module in the “Modules” section, choose a name and select “Historian” as the “Module type”.
- **Step 2**: Configure the **Logger** and **API** settings for the **Historian** module. In this example, the default configuration is left unedited since, in most cases, this is a valid configuration.
- **Step 3:** Configure the module by disabling the Embedded DB engine and configure the rest of the parameters.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/14-Historian-module-configuration.png)

Figure 14: Historian module configuration

- **Step 4:** Configure the MongoDB client and connect it to **N3uron**’s **Historian**.

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/15-MondoDB-compass-configuration.png)

Figure 15: MongoDB compass configuration

**Result:** A database named “n3uron” (as configured previously in the module configuration section) is automatically created by **Historian**. This database contains the following collections: Tags collection, Samples collection (everyday a new collection is created), and Alarms collection (everyday a new collection is created).![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/16-Databases-created-in-compass.png)

Figure 16: Databases created in compass

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/17-Collections-inside-the-database.png)

Figure 17: Collections inside the database

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/18-2021-07-09-samples-collection.png)

Figure 18: 2021-07-09 samples collection

![](https://cdn.document360.io/54093ab5-6b22-4542-a265-04377931f11a/Images/Documentation/19-Tags-collection.png)

Figure 19: Tags collection