Historian 2.0 Builder
- 1 Historian Builder App
- 1.1 Getting Started
- 1.1.1 Create a chart
- 1.1.2 Range Picker
- 1.1.3 Chart Settings
- 1.1.4 View Chart
- 1.1.5 Edit Chart
- 1.1.6 Chart Navigator
- 1.1.6.1 Open a chart
- 1.1.6.2 Import Chart
- 1.1.7 Export Chart
- 1.1.7.1 Export
- 1.1 Getting Started
Historian Builder App
The Historian Builder app in FIN allows users to create customizable charts and tables that are used to visually analyze and display data trends.
Users can import points of various types and graph their historical values as a series.
Users can import and export charts.
Getting Started
Navigate to App Launcher and select the Historian Builder tile from the System Integrator Apps section.
Users will land on a blank screen with the following options available:
Open Chart: launches the Chart Navigator popup, allowing users to view a list of existing charts and select one to view. This option also allows users to:
| Create Chart: allows users to create charts with defined parameters. |
Select Create Chart to add a new chart or Open Chart to view and edit an existing chart.
Create a chart
The DB Tree contains the set of points with histories in a hierarchical order that users may add to the chart.
Prerequisite: The history data is available in the DB Tree.
Select the Historian Builder app in FIN and select Create Chart.
The New Chart window displays.
In the DB Tree, locate the building for which users want to create the chart, and select the caret icon adjacent to it. Drill down to the points needed.
Add data points to the chart by doing any of the following:
Drag and drop the data point to the chart.
Alternatively, select the + next to the point.
To remove the data point, select the - next to the point.
The chart displays the added data points and new options like edit names display.
Select the pencil icon to rename the chart.
Set the range of the chart with Range Picker.
Select whether to repeat the chart using the toggle under the DB Builder tree.
Enabling repeat chart sets the Repeat Target to the current time range within the current context. For example, if users set the Repeat Target to Floor 1, all Vavs on Floor 1 will be mapped onto the timescale of the current chart.
Make necessary changes to the chart with Chart Settings.
Ensure that all changes are applied, if not select the Refresh button and then select Save.
The chart is saved in the Historian Builder app, and the UI will switch to View Mode, from where further changes can be made by toggling to Edit Mode. This new chart can always be found later in Chart Navigator.
Range Picker
Allows users to set the range of the chart with the following:
Day: Creates a chart with range of a day. Users can set the range as today or yesterday.
Week: Creates a chart with range of a week. Users can set the range as the current week or last week.
Month: Creates a chart with range of a month. Users can set the range as the current month or last month.
Quarter: Creates a chart with range of a quarter. Users can set the range as the current quarter or last quarter.
Year: Creates a chart with range of a year. Users can set the range as the current year or last year.
Custom: Allows users to set the range manually. Users can select the range as - Today, This Week, This Month, This Year from the calendar that displays.
Relative: Creates a range relative to a reference day in the calendar.
Users can set the range from the reference day in two ways:
Users can specify the reference day and the desired number of days to include in the range.
Selecting the Now checkbox sets the range relative to the current day. Users can either enter the range manually or choose from the following predefined time frames:
Last 24 Hours
Last Week
Last Month
Last Quarter
Last Year
By default, the time frame Before the reference day is selected. To create a range after the reference day, select After. To set the reference day as the midpoint of the range, select Within.
Chart Settings
The Chart Settings allow users to modify an existing chart using the options present in the Series, Axis, and Chart tabs.
Choose from the options listed below for each category.
Select Apply.
Ensure that all changes have been applied by selecting the Refresh button.
Select Save.
Series
Allows users to modify the parameters related to the representation of points in a chart.
Arrows: Use the arrows at the left-hand side of a point or grab and drag the hamburger icon to move the point up or down in the sequence
Display Name (optional): Allows users to modify the default name of the series without changing it in the database. To permanently modify the name of the series, apply the settings and save the chart.
Color: Modifies the color of the series in the chart.
Type: Modifies the type of graphical representation. Users can select any of the following types - Line, Dashed Line, Step Line, Curve, Area, Scatter, and Bar. The graphical representation types change based on the associated point.
The table below lists point types and their series types.
Boolean / Enum | Number |
|
|
Delete: Allows users to delete a point from the chart.
RollUp
RollUp: Modifies the representation of measurement intervals displayed in the chart.
Fold function: Allows users to select how users want the data to be displayed from any of the following options:
- avg: Average of the data within the given interval.
- mean: Mean of the data within the given interval.
- count: Number of times the samples are measured within the set interval.
- sum: Sum of the measured numeric values within the interval.
- min: Minimum values for the specified intervals.
- max: Maximum values for the specified intervals.
- standard Deviation: Standard deviation value of the data within the given interval.
- median: Middle value of the samples in each interval.Interval: Allows users to set the time period between each measurement points. Users can select any of the following - nanosecond, microsecond, millisecond, second, minute, hour, day, or week.
For example: There is a numeric point on the chart that displays samples measured every 10 minutes. If users want to modify the point to display samples as the average of the values measured over one hour, users can select the RollUp checkbox and modify the interval.
Axis
Allows users to modify the axis of the chart.
X-Axis Time Format: Switches between 12 hour and 24 hour format.
Default Y-Axis Position: Moves the position of the Y-axis from left to right or vice-versa.
Chart
Allows users to modify the appearance of the chart.
Default range: Allows users to set the default range of the chart. This range is displayed by default when the chart is opened.
Background color: Changes the background color of the chart.
Show grid: Toggles between a chart with a background grid and without a background grid.
Show gaps: Displays the gaps between the values within the interval.
Show mouseover: Enables and disables the mouseover functionality.
The mouseover displays the values of the points at a particular location on the series. Each point is represented by a distinct color, which can be edited.The hollow circle denotes that the mouseover is between two measurement points on the series.
The filled circle denotes that the mouseover is at a measurement point on the series.
Align timezones: Aligns the time zones of the points, if there are points from different time zones added to the chart.
View Chart
Allows users to view the chart without making any changes. However, users can zoom in on specific time stamps, select and view different ranges using the range picker, switch to a table view for detailed data, and export the chart. When users open a chart from Chart Navigator, the chart opens in View Chart by default.
If users switch from View Chart to Edit Chart, a confirmation dialog box displays. Upon selecting Leave, the chart displays in Edit Chart.
View Chart options:
| 2. Chart Navigator: this dialog box includes:
|
|
|
|
|
| 8. Range Sliders: drag these bars to set start and stop times and narrow in on data for a specific time window. |
|
|
|
|
View chat allows users to view the chart. Users cannot make any changes to chart in View Chart.
Edit Chart
Allows users to edit and save the chart with all the options available in Create Chart.
Edit Chart options:
| 2. Edit: selecting this pencil icon allows users to modify the default name of the chart. |
|
|
| 6. Range Picker: selecting the calendar icon allows users to set a range by Day, Week, Month, Quarter, Year, Custom, or Relative. |
|
|
|
|
|
|
Relativize: When enabled, the Relativize feature allows users to automatically replicate a chart across multiple targets of the same type. For example, if a user creates a chart for AHU-1 with points X, Y, and Z on Floor 1 in City Center, and sets the Repeat Target as City Center AHU-1, the system will automatically generate similar charts for all AHUs across other floors within the database—provided they match the same target filter.
This feature streamlines chart creation and ensures consistency across similar equip types.
Once a chart has been relativized, it is not recommended to un-relativize it. Doing so will break the link to the original target structure, and the chart will need to be recreated manually to ensure it points to the correct data sources.
Chart Navigator
Allows users to open, rename, delete or import a chart.
Open a chart
Prerequisite: At least one chart must exist.
From the Historian Builder app, select Open Chart.
The Chart Navigator dialog box displays with the saved charts.
Select the chart to edit from the Chart Navigator dialog box and select open.
The selected chart displays in the View Chart mode.
Import Chart
Select the Historian Builder app and select Open Chart.
The Chart Navigator dialog box displays.
Select the Import button.
By default, the Downloads section of user local machine displays.
Select the Hayson file that users want to import and select Open.
The Chart Navigator dialog box displays the imported file.
Select the file and select Open.
The chart displays in the Historian Builder app.
Export Chart
Allows users to export the charts and/or the tables in various export types in their respective file formats. The following formats are available for each data type:
Exportable data by presentation and file formats
Data Presentation | File Format Options |
Chart |
|
Record |
|
Table |
|
Export the Record of the chart, which can be imported into another project. The record is exported in HAYSON (.json) format.
Export
At least one chart exists in Historian Builder.
From the Historian Builder app, select Open Chart.
The Chart Navigator dialog box displays.
Select the chart to export data from and select open.
The chart displays in the View Chart section.
If you are exporting a table, toggle table view. Otherwise, remain in chart view.
Select export.
The export chart popup appears.
Alter the name as desired.
In the Export Chart dialog box, select the Export Type.
Set the file type from the dropdown and select OK.
The selected file is exported and can be found in your downloads.