Report Item

The Report Item object is used in conjunction with the Report Designer Display to create reports containing real-time and historical data. The resulting reports can be displayed on the Dashboard Display or exported to file using the Report Generator object.

More detail on how to create and configure the Report Item can be found in the Using Reporting Jumpstart.

Object Properties

Common

Object Name

The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description

This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

System Alias

The system alias is an additional name for an object, which can be used as a shortcut for identification and has to be unique in the system.

Display Alias

Alternate label for objects to be used for easier identification in the displays.

Engineering Unit

The Engineering Unit or unit of measurement is a definite magnitude of a physical quantity, defined and adopted by convention or by law, that is used as a standard for measurement of the same physical quantity.

Decimal Places

The maximum number of decimal digits that will be displayed to the right of the decimal point.

Lua Script Body

Script editor to enter an advanced Lua script.

Dedicated Thread Execution

When set, the item executes in a thread not shared with other items.

Functional Component

This determines in which service component the object is functional. The default zero value denotes the Master Core.

Report

Properties used to create report.

Report Design Time Data

This optional property can hold the expected report scheme which was used at design time.

Fit Source Data

Choose this option if you have stored design time data in the appropriate property and you want the system to evaluate differences between design and source data. This may impact the performance.

DataSet Name

Name of the DataSet visible in Report Designer.

RealtimeQueryOptions

Options to configure Report Designer datasource Realtime.

Table Name Prefix

The prefix of the table name helps to create unique table names.

Item Names Template-Able

Use flexible item names when a report is created, this allows to use this report as a template.

Query Objects

List of objects that are used in the query.

Properties

Choose properties for selected class.

NamespaceQueryOptions

Options to configure Report Designer datasource Namespace.

Table Name Prefix

The prefix of the table name helps to create unique table names.

Item Names Template-Able

Use flexible item names when a report is created, this allows to use this report as a template.

Properties

Choose properties for selected class.

HistoryQueryOptions

Options to configure Report Designer datasource History.

Table Name Prefix

The prefix of the table name helps to create unique table names.

Query Objects

List of objects that are used in the query.

Properties

Choose properties for selected class.

Aggregates

Select multiple History Aggregates to use.

Timesettings

Provide settings for this time window with start, end and interval.

Request Boundary Values

If set, a request with aggregate Raw data will also request the boundary values for the selected time window.

Absolute Datetime Start

Absolute Datetime start container.

Is Relative Start

Indicates if the Datetime Start property is relative or not.

Absolute Datetime End

Absolute Datetime end container.

Is Relative End

Indicates if the Datetime end property is relative or not.

Report Design Data

Contains one or multiple property sets for this Report Item.

Report name

The logical name of the report.

Order

The display order of this report in the report selection list.

Default

If this property is checked this report is the default report.

Report Design

The design data for the report, which is used to render the source data.

Limit Settings

Define limits for EU range and alarming.

Low EU Range

Low EU Range.

High EU Range

High EU Range.

Low Limit

Alarming low limit.

High Limit

Alarming high limit.

Archive Options

Selection between different archive options.

Archive Selection

Select default Production Archive or Test Archive of the master core or a custom set of data stores.

Storage Strategy

Summarizes the settings for historization, aggregration and forecasting for a particular ItemValue.

  • Raw History: ItemValue is stored in Raw History Collections.

  • Aggregation 1 min: ItemValue is stored in 1-minute Aggregation Record Collections.

  • Aggregation 5 min: ItemValue is stored in 5-minute Aggregation Record Collections.

  • Aggregation 10 min: ItemValue is stored in 10-minute Aggregation Record Collections.

  • Aggregation 15 min: ItemValue is stored in 15-minute Aggregation Record Collections.

  • Aggregation 1 h: ItemValue is stored in hourly Aggregation Record Collections.

  • Aggregation 1 day: ItemValue is stored in daily Aggregation Record Collections.

Persistency Timeout

When set, the persisted dynamic value is not used if it is older than the specified timeout in seconds (e.g. 86400 would be the correct setting to persist the dynamic value for a maximum of one day). If not set, no timeout is used.

Auxiliary State Management

Configurable settings for auxiliary state management.

Strategy

Specifies how auxiliary state changes are handled.

  • Inherit: Inherit the setting from the parent object. In case of no parent object, the "Persist" mode is used.

  • Persist: All object auxiliary states are indicated and persisted to the archive.

  • Volatile: Auxiliary state changes are volatile and not persisted.

  • Inhibit: Inhibit all auxiliary state changes.

Lifecycle Management

Lifecycle Management.

Object Maturity

This selection classifies the productive state of the object. It can be used in conjunction with catalogue functions in order to identify specific objects in respect to their maturity state.

  • Test (Sandbox): The object currently fulfills test purpose.

  • Development: The object is currently under development.

  • Qualification: The object is part of a qualification use case.

  • Production: The object is part of a productive use case.

  • Expendable: The object implements functionality which is not crucial to system operation.

  • Removable: The object can be removed by automated cleanup tasks.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String

A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name

A custom property name which can be used programmatically.

Property Value

The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name

A custom table name which can be used programmatically.

Table Data

Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.