Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

The Historian Namespace exposes properties and methods from the .NET objects used by the Historian Module execution. You can use these properties and methods on your Displays or to create Scripts and Alarms.

...

Below you find a table describing the most used properties from the Historian Namespace. Access the Historian Namespace page for a complete list of available options.

...

Property

...

Type

...

Description

...

Property path on CodeBehind

...

IsStarted

...

Boolean

...

This is a Boolean flag that indicates whether the Module Historian has started. If the flag is set to "true," it means that the Module Historian is up and running, actively archiving data according to the configured Historian Tables. If the flag is set to "false," the Module Historian has not yet started, and no data archiving is taking place.

...

Historian.IsStarted

...

OpenStatusMessage

...

String

On this page:

Table of Contents
stylenone


Runtime Attributes

HistorianTables Tag Historian Values

Like all objects in the platform, HistorianTables have their own set or properties and methods. 

Particularly, there are a few methods that are frequently used by the application, which focus on retrieving the historian contents and generating a DataTable with the results.

These methods are mainly on the Tag namespace and HistorianTabe namespaces, using the TK toolkit methods.

Method

Description

TK.GetTagHistorian

Gets Historian data from a Tag, given a date range

TK.GetValueFromHistorian

Gets one specific value from the Historian Database

Historian.Table.Table1.SaveToTextFile

Export contents to CSV files

Historian.Table.Table1.GetObjectList

Get List of Tags used by each HistorianTable


Some other methods focus on the state of the execution of the Historian Module itself.

Property Path

Type

Description

Historian.IsStarted

Boolean

Indicates if the operational status Module Historian has started.

  • True, the Module Historian actively archives data.
  • False, no data archiving occurs.

Historian.OpenStatusMessage

String

Indicates

...

the success or failure when initiating the Module Historian. If the Module Historian starts successfully, the

...

system returns an OK string. otherwise returns error message.

Historian.

...

EnableCache

Boolean

...

A Boolean flag that

...

enables the creation of temporary binary files on the server

...

to optimize the TrendChat object performance

...

when

...

handling large

...

datasets. Setting to true improves responsiveness and efficiency.


→ Read more about Objects, and access the Namespace API, at Objects and Namespaces.


In this section:

Page Tree
root@parent
spacesV10

...

Historian.EnableCache

...