ReportDesigner General Structure

ReportDesigner was developed to enable events, alarms, and measurement data collected by LIVE EVENTS to be reported through LIVE DASH. Users can create the overall report structure, add different card types, define the data source and display properties for each card, and publish the completed report through the LIVE DASH WEB interface.

Key operations that can be performed with ReportDesigner:

  • Create standard and customized reports.
  • Prepare daily, monthly, and annual time-based analyses.
  • Present alarm, event, and performance data graphically.
  • Report SCADA data using tables, charts, and gauges.
  • Highlight individual values with Color Card components.
  • Publish designed reports through the LIVE DASH WEB interface.

The fundamental approach of ReportDesigner is to treat a report not as a single monolithic object, but as a modular structure consisting of cards with independent responsibilities. This allows detailed trend charts, alarm analyses, tables, and real-time indicator cards to be used together within the same report.

Accessing ReportDesigner

The ReportDesigner report design tool is located in the same program folder as LIVE EVENTS. To run the tool, the user only needs to execute the ReportDesigner.exe application file located in the relevant folder.

ReportDesigner application

When the application starts, the interface for designing reports to be used in the LIVE DASH web reporting environment is opened. The user can immediately start creating a new report or editing an existing report.

ReportDesigner Interface Panels

The report design screen consists of panels that separate different tasks. This structure makes it easier to create reports in a controlled manner and subsequently modify the same report.

ReportDesigner interface panels

1. Report Selection Panel

Lists previously created reports. Existing reports can be selected, viewed, and edited here.

Report Selection Panel

2. Report Operations Panel

Used to create a new report, save an existing report, and reset the cards in a report.

3. Report Group and Name

Defines the group in which the report will appear and the name under which it will be displayed in LIVE DASH.

Report Group and Name

4. Card Addition Panel

Allows table, chart, gauge, and similar card components to be selected and added to the report.

Card Addition Panel

5. Card Selection Panel

Visually lists the cards contained in the report. Selecting a card allows its properties to be edited and provides quick navigation between cards.

6. Card Properties Panel

Defines chart type, data set, operation type, display mode, titles, and other fundamental card properties.

Card Properties Panel

7. Data Selection Panel

Selects the SCADA data to be used by the card. Archived project data can be listed and filtered.

8. Additional Settings Panel

Provides configuration of advanced chart parameters, thresholds, scales, and gauge color levels.

Report Card Types

LIVE DASH reports consist of vertically arranged standard card areas. Each card operates as an independent information area within the report and can have its own data source, calculation method, and visual settings.

Normal Card (CARD)

Used to display data in graphical or tabular form. Suitable for comparing multiple data sets, time-based analysis, and monitoring trends.

  • Table views
  • Column, line, pie, radar, and timeline charts
  • Alarm, event, and performance analyses

Color Card

Used to highlight individual data values and display them quickly and clearly. Particularly suitable for making current or summary values visible on management and operational screens.

  • Current or static individual measurement values
  • Maximum, minimum, and average values
  • Uptime and downtime
  • Time-based integral of data

Depending on the data value, a Color Card can use indicators such as circular, linear, thermometer, and colored LED, as well as numeric LED and standard numerical display options. Color Cards also support live data updates.

Creating a New Report

The following sequence provides a controlled and complete workflow for creating a new report.

  1. Run the ReportDesigner application. Open the report design screen and related panels.
  2. Click ADD NEW REPORT. The system creates an empty report definition with default settings.
  3. Select the created report through the Report Selection Panel to make it active.
  4. Use the Report Group and Name Entry Panel to define the report group and the report name displayed in the system.
  5. Use the Card Addition Panel to add a Normal Card or Color Card to the report.
  6. Define the properties, data source, and, when required, additional settings for each card.
  7. Repeat the same process for all cards to be used in the report.
  8. After checking the validation indicators, click SAVE REPORTS.

Result: The saved report becomes ready for use in the LIVE DASH WEB interface. Before saving the report, it is important that the validation status of all cards is green to prevent incomplete or incorrect configurations.

Configuring Card Properties

An added card is selected from the numbered sub-card areas in the Card Selection Panel. The properties of the selected sub-card are displayed in the relevant panels. The card's behavior within the report is determined by the following fundamental parameters.

PropertyDescription
Chart TypeDetermines whether the card operates as a chart, table, or gauge.
Data Set TypeDetermines whether data is retrieved on a second or minute basis: second_1 or minute_1.
IntervalDetermines the time interval over which data is evaluated, such as second, minute, hour, day, month, or year.
Operation TypeDefines the mathematical or logical operation applied to the data set.
Display ModeDetermines whether data is presented as a chart, summation, combined view, or alarm analysis.
Main TitleThe main title of the card. A short expression summarizing the card content is recommended.
SubtitleA more detailed description supporting the main title.
X AxisDefines what the horizontal axis represents, such as time, hour, or second.
Y AxisDefines what the vertical axis represents, such as power (MW) or production (MWs).
ThemeDetermines the card's color palette and overall visual appearance.
Width / HeightDetermines the horizontal and vertical dimensions of the card. Values can be entered as percentages or pixels.
Card properties settings

Chart Types

The chart type directly determines the purpose for which a card is used. ReportDesigner provides numerous display options for different data types and analysis requirements.

SCADA Data

Available chart types include zoomline, zoomlinedy, line, logline, spline, scatter, zoomscatter, kagi, column3d, column2d, logcolumn2d, bar3d, bar2d, area2d, splinearea2d, pie2d, pie3d, doughnut2d, doughnut3d, tabulator, and various 3D visualizations.

ALARM Data

Available options include alarmlist, funnel2d, funnel3d, pyramid2d, pyramid3d, radar, marimekko, pareto2d, pareto3d, radial, timeline, heatmap, sankey, chord, and various column/pie visualizations.

COLOR CARD Displays

Available displays include singledata, 7segmentdisplay, 14segmentdisplay, 16segmentdisplay, cylinder, lineargauge, angulargauge, halfangular, bulb, and thermometer.

Data Set Type and Time Dimension

Data Set Type determines the resolution at which data is retrieved from the database. When second_1 is selected, one day's data consists of 86,400 data points; when minute_1 is selected, it consists of 1,440 data points.

Performance Note: As the number of data points increases, report generation time and daily data volume also increase. Therefore, using minute_1 in reports provides a more balanced solution in terms of processing time and storage size for most scenarios.

The Interval parameter determines the time period over which data is evaluated: second, minute, hour, day, month, year. This selection is particularly important for integral calculations. For example, hour corresponds to hourly integral evaluation, while day corresponds to daily integral evaluation.

Operation Types

Operation Type determines the mathematical or logical operation applied to the selected data set. Available options may vary according to the chart type.

OperationMeaning
curveStandard line chart.
integralIntegral value of the data.
counterEvaluation of the counter value when the SCADA data has counter characteristics.
maximumHighest value within the selected time interval.
minimumLowest value within the selected time interval.
recent / lastMost recent value within the selected time interval.
averageAverage value within the selected time interval.
uptimeTotal device operating time based on exceeding the defined threshold.
downtimeTotal device downtime based on remaining below the defined threshold.
dayintDaily integral value of the data.

Display Modes

Display Mode determines how selected data is presented on the card. The same data can provide different analytical perspectives through different display options.

SCADA and standard charts:

  • normal: chart of the selected data
  • summation: total chart of the selected data
  • combined: individual data and their total shown together
  • stacked: data displayed as a stacked chart
  • stackedplus: stacked chart with the total additionally displayed as a line chart

ALARM lists: The options showtop1, showtop5, showtop10, showtop20, showtop30, showtop50, and showall can be used to display the most frequently occurring alarms or all alarms.

For ALARM analysis, relational analysis options such as location2level, location2group, location2type, group2type, group2level, type2level, type2group, level2type, and level2group can be used.

For Timeline, inalarms presents incoming alarms, inoutalarms presents incoming and outgoing alarms in a Gantt-like time display, while events presents events on a timeline.

Chart and Card Display Settings

Card readability depends not only on selecting the correct data, but also on labeling the data correctly and presenting it at an appropriate size on the screen.

  • Main Title: briefly expresses the main content of the card.
  • Subtitle: description supporting the title.
  • X Axis Title: identifies the quantity represented by the horizontal axis.
  • Y Axis Title: identifies the quantity represented by the vertical axis.
  • Theme: defines the card's color palette and visual consistency.
  • Width: can be defined as a percentage or pixels.
  • Height: can be defined as a percentage or pixels.

When entering a percentage value, the % character must be added at the end, for example 100%.

Show Table and Transpose Table

Show Table

Allows the tabular equivalent of graphical data, especially hourly or daily integrals, to also be displayed in the report.

Transpose Table

Changes the row and column arrangement in cards where table display is enabled, presenting the same data from a different perspective.

Data Selection and Data Definition

In charts that require data selection, the operation is performed through the Data Selection Panel. Archived project data is listed, and the list can be narrowed by entering keywords in the filter field at the top of the panel.

Data Selection Panel

By clicking a data item in the data list, the user can view its details below the list. The selected data is added to the active card's data list using the ADD button. The data definition is associated with the database definition number, ColID.

Important: The data definition format must be preserved as Data Definition = Database Definition Number (ColID). For example, production=55 or unit1=21. For the reporting system to work correctly, the ColID to the right of the equals sign must not be changed.

Data definition editing When long automatic definitions need to be adjusted, double-click the data brought into the card settings to open the quick editing area. Only the definition before the equals sign may be changed. The format must always be preserved.

To delete data, right-click the selected data and use the Delete option from the menu. Some card and chart types may not require data selection; for example, data selection is not required for alarm-type charts.

Validation and Error Display

ReportDesigner provides visual validation information while card properties are being defined. This approach makes it easier to identify incomplete or unnecessary configurations before the report is saved.

Red

Indicates that an entry is incorrect, incomplete, or unnecessary for the selected chart type. Settings marked in red must be corrected.

Green

Indicates that the relevant setting is correct and complete. It is recommended that all cards show a green validation status before saving the report.

Additional Card Settings

When required, advanced chart-specific settings can be defined through the Card Additional Settings Entry Panel. These settings vary according to the chart or gauge type being used. Card additional settings

  • For SCADA charts, the Add Min Max option can be used to define the minimum and maximum values of the Y axis.
  • Entered settings can be edited through the quick section opened by double-clicking the relevant row.
  • Color levels can be defined for numeric GAUGE displays.

Alarm Filter Settings

The Alarm Filter Settings Screen in ReportDesigner is used to determine in a detailed and controlled manner which alarms will be included in or excluded from a report. This allows LIVE DASH reports to become selective, flexible, and multi-criteria reports based on the alarm structure defined in the SCADA project.

  1. Select the relevant report or report component in ReportDesigner.
  2. Open the right-click menu on the Extra Settings Addition Panel.
  3. Click Add Alarm Setting.
  4. Define the filter criteria through the Alarm Filter Settings Screen opened by the system.

Alarm Selection Methods

Individual Alarm Selection

Specific alarms can be selected manually from the alarm list. Suitable for reporting a small number of clearly defined alarms.

Text Filter

Text filtering can be performed by alarm name or description. This makes it easier to locate a required alarm in projects containing many alarms.

Location-Based Filtering

Alarm locations such as Unit 1, Unit 2, and switchyard can be selected so that only alarms belonging to specific locations are included in the report.

Type, Group, and Level

Alarm type, alarm group, and alarm level can be included or excluded from the report.

Include: Add inc_ before the type, group, or level. Examples: inc_Critical, inc_Mechanical, inc_Analog.

Exclude: Add exc_ before the type, group, or level. Examples: exc_Info, exc_TestAlarms, exc_System.

Multiple filter criteria can be used together in the same report. This makes it possible to select alarms belonging to a specific alarm group and specific levels at a specific location, creating reports that are more meaningful from an operational perspective.

Alarm Filtering Example

Example filter:

  • Location: Unit 1
  • Alarm Group: Mechanical
  • Alarm Level: inc_Critical, inc_Warning, exc_Info

As a result of this configuration, only Critical and Warning alarms belonging to the Mechanical group at Unit 1 are included in the report; Info-level alarms are excluded.

This method removes unnecessary alarm clutter from reports and enables targeted alarm lists suitable for operational, maintenance, and management purposes.

Editing Alarm Filters

When a previously defined alarm filter needs to be changed, double-click the relevant filter row in the Extra Settings panel. The Alarm Filter Settings Screen opens again, and the required changes can be made using the same methods.

Editing Existing Reports and Cards

Previously created reports can be reopened in the same ReportDesigner environment and updated in terms of report group, report name, cards, data sources, and visual settings.

  1. Run the ReportDesigner application.
  2. Select the report to be edited through the Report Selection Panel.
  3. The selected report's pages and cards will be displayed in the design area.
  4. If necessary, change report information through the Report Group and Name Entry Panel.
  5. Select the sub-card to be edited through the Card Selection Panel.
  6. Update card properties, data selections, and additional settings as required.
  7. Save the changes using the SAVE REPORTS button.

The saved configuration becomes ready for use in the LIVE DASH WEB interface.

Live Data (LIVE DATA) Feature

The LIVE DATA feature automatically updates display types selected as Color Cards in LIVE DASH at defined intervals. This transforms the report screen from a static report showing only historical data into a dynamic monitoring screen reflecting the latest values from the data source.

Application

Used with cards configured as Color Cards that display current or most recent values.

Activation

Select Live Data in the Card Properties Entry Panel and use recent as the Operation Type.

Important: The Live Data feature can only be used with Color Cards. The refresh interval is defined in the EOSliveevents.xml file using the following parameter:

<LiveDataRefresh>5000</LiveDataRefresh>

The default value is specified as 5000 milliseconds (5 seconds). Very short refresh periods are not recommended because they can cause unnecessary data traffic.

Saving and Publishing the Report

After report design is completed, click the SAVE REPORTS button in the New Report Addition, Save, and Report Reset Panel.

After saving, the report becomes available in the LIVE DASH WEB interface. Before saving, it is important to verify that the validation status of all cards is green to prevent incomplete or incorrect card configurations.

Recommended workflow: Create the report → define the group and name → add cards → define card properties → select data → define alarm filters → configure additional settings → check validation status → save the report → view it in LIVE DASH WEB.

Reporting Approach with ReportDesigner

ReportDesigner can be considered not merely a chart creation tool, but a modular reporting layer that organizes operational data collected by the LIVE EVENTS infrastructure according to different decision-making levels.

Operational Analysis

Enables current and historical SCADA data to be examined using trends, tables, and summary indicators.

Alarm Analysis

Enables alarm density and alarm behavior to be examined more meaningfully using location-, group-, type-, and level-based filters.

Time-Based Reporting

Hourly, daily, monthly, and annual evaluations can be performed using second- or minute-based data sets.

Live Display

Color Cards and the LIVE DATA feature can make the report screen reflect current operating values.

This structure allows the same reporting environment to be configured for different purposes, including operations, maintenance, performance, alarm management, and management monitoring.

Summary

LIVE DASH ReportDesigner is a flexible report design tool used to transform process, event, and alarm data collected by LIVE EVENTS into web-based reports. Normal Card and Color Card structures allow detailed analyses and rapid status indicators to be combined within the same report.

Selecting the correct data set, appropriate operation type, correct display mode, and required alarm filters together ensures that reports are meaningful not only visually but also operationally. After report design is completed, the process is finalized by checking validation statuses, saving the report, and publishing it in the LIVE DASH WEB environment.

← Back to Previous Content