Version Changelog

For detailed explanation of configuration please see Server App Configuration

Note: There's a small update utility available which performs the following scenario. See here.

• Find out what version you have (for older versions it is shown in the browser's title when you are using the historian app - eg. Historian Dashboard v1.4. Recent versions - from v1.6 - contain this information at the end of the HELP page or as a hover title for the HISTORIAN label at the start of the page).
• Shutdown the web server

sudo service apache2 stop

• Make a backup of the whole /var/www/poweranalyzer folder
• Remove everything from the /var/www/poweranalyzer folder except the App_Data folder
• Unpack the provided update package into the /var/www/poweranalyzer folder (it should have similar structure like the folder at startup, just without the App_Data folder)
• Update access rights to all contained files

sudo chown -R www-data:www-data /var/www/poweranalyzer
sudo chmod -R u+rwx /var/www/poweranalyzer

• Follow the per-version upgrade procedures (see below) from the last version you had up to the recent version
• Start the web server

sudo service apache2 start

• Verify that the app is working by browsing the historian website

• CSV SOE Export now may include Template Info

• Minor bugfixes

• Signal search mode (simple/advanced) switching
• Inputs for time specification in the Data Access tab
• Charting improvements

• Minor bugfixes
• Reporting - template validations
• Licensing message clarification

• Pareto chart
• Czech localization
• Localization hiding
• New calculation wizard command
• Configurable date format for legend
• Configurable SOE columns order
• Default month format for charts changed (MM=> MMM)
• Configurable access restrictions for related links
• Reporting tutorial (video)
• Minor bugfixes & improvements

It's now recommended to provide default mime types for VTT (video subtitle) files in order to video play correctly. For IIS web servers these mime types are stored within Historian configuration, however for Apache web server it's needed to include the AddType text/vtt .vtt line into web site configuration (see Server docs for details).

• Notification about data not being updated (yellow box in the corner)
• Chart - Area under the line fill
• Signal search form hints
• Improved chart colors for printing
• Fixable legend for chart
• Automatic generation of groups.xml configuration file
• Minor bugfixes & improvements

• Signal drag&drop
• Chart - configurable ticks on axis
• Issue "Multiple data access pages opened at once" addressed
• Minor bugfixes & improvements

• New UI
• Minor bugfixes & improvements

• New TXP Average aggregation method
• Min/Max/Avg at the end of data exports
• Report improvements (report tools clipboard function
• Minor bugfixes & improvements (charts printing, signal histogram, signal autocomplete speed)
• CPU/NET server usage chart
• Multiple vertical axis for chart
• TAV list speedup

• New Signal Hierarchy Analytic tool
• Jitter for charts
• Animation + slider for pointschart
• Storing Chart configuration
• Charts printing
• Minor bugfixes & improvements (CSV export, signal group name above signal list, soe export percentage)

• reports&calculation helper tools
• new DB STATS page
• new LOCATION page
• extended textual descriptions
• double arrows for charts
• additional links to signal detail
• invalid data now marked in charts
• improved axis autoconfiguration

Updated file kks_mapping.desc (App_Data\signals\descriptions), extended list of events (inside instance.xml, elements eventTypes & soeList)

<eventTypes>
      <eventType type="A" ikzPrefix="0x0002" userVisible="true" />
      <eventType type="C" ikzPrefix="0x0800" userVisible="true" />
      <eventType type="D" ikzPrefix="0x8000" userVisible="true" />
      <eventType type="E" ikzPrefix="0x0001" userVisible="true" />
      <eventType type="EA" ikzPrefix="0x0003" userVisible="true" />
      <eventType type="F" ikzPrefix="0x0040" userVisible="true" />
      <eventType type="FD" ikzPrefix="0x8040" userVisible="true" />
      <eventType type="FI" ikzPrefix="0x0140" userVisible="true" />
      <eventType type="I" ikzPrefix="0x0100" userVisible="true" />
      <eventType type="IS" ikzPrefix="0x4100" userVisible="true" />
      <eventType type="O" ikzPrefix="0x0010" userVisible="true" />
      <eventType type="OD" ikzPrefix="0x8010" userVisible="true" />
      <eventType type="OE" ikzPrefix="0x0200" userVisible="true" />
      <eventType type="OI" ikzPrefix="0x0110" userVisible="true" />
      <eventType type="OMCST-S" ikzPrefix="0x7890" userVisible="false" />
      <eventType type="S" ikzPrefix="0x4000" userVisible="true" />
      <eventType type="SD" ikzPrefix="0xc000" userVisible="true" />
      <eventType type="T" ikzPrefix="0x0008" userVisible="true" />
      <eventType type="TLFCST-S" ikzPrefix="0x7868" userVisible="false" />
      <eventType type="TLFSMCST" ikzPrefix="0x3c68" userVisible="false" />
      <eventType type="TOMCST-S" ikzPrefix="0x7898" userVisible="false" />
      <eventType type="W" ikzPrefix="0x0004" userVisible="true" />
      <eventType type="WOFMCST-" ikzPrefix="0x78d4" userVisible="false" />

      <eventType type="OLMSMST-" ikzPrefix="0x74b0" userVisible="false" />
      <eventType type="TOLMSMST" ikzPrefix="0x74b8" userVisible="false" />
      <eventType type="WOLFCST-" ikzPrefix="0x7874" userVisible="false" />
      <eventType type="WTOLFCST" ikzPrefix="0x787c" userVisible="false" />
      
      <eventType type="M" ikzPrefix="0x0080" userVisible="true" />
      <eventType type="EF" ikzPrefix="0x0041" userVisible="true" />
      <eventType type="EW" ikzPrefix="0x0005" userVisible="true" />
    </eventTypes><soeList>
      <eventGroup name="A">
        <eventType type="A" />
      </eventGroup>
      <eventGroup name="C">
        <eventType type="C" />
      </eventGroup>
      <eventGroup name="D">
        <eventType type="D" />
      </eventGroup>
      <eventGroup name="E">
        <eventType type="E" />
        <eventType type="EA" />
        <eventType type="EF" />
        <eventType type="EW" />
      </eventGroup>
      <eventGroup name="F">
        <eventType type="F" />
        <eventType type="FD" />
        <eventType type="FI" />
      </eventGroup>
      <eventGroup name="I">
        <eventType type="I" />
        <eventType type="IS" />
      </eventGroup>
      <eventGroup name="M">
        <eventType type="M" />
      </eventGroup>
      <eventGroup name="O">
        <eventType type="O" />
        <eventType type="OD" />
        <eventType type="OE" />
        <eventType type="OI" />
        <eventType type="OMCST-S" />
        <eventType type="OLMSMST-" />
      </eventGroup>
      <eventGroup name="S">
        <eventType type="S" />
        <eventType type="SD" />
      </eventGroup>
      <eventGroup name="T">
        <eventType type="T" />
        <eventType type="TLFCST-S" />
        <eventType type="TLFSMCST" />
        <eventType type="TOMCST-S" />
        <eventType type="TOLMSMST" />
      </eventGroup>
      <eventGroup name="W">
        <eventType type="W" />
        <eventType type="WOFMCST-" />
        <eventType type="WOLFCST-" />
        <eventType type="WTOLFCST" />
      </eventGroup>
    </soeList>

• Minor bugfixes & improvements (charts, german localization)

• Scheduled reports
• Updated guide

• Signal indexation is now being done without SQL queries
• New signals now will contain descriptions
• Weird signals (IKZ ending with -5/-7/-8/-12) should be ignored
• Minor bugfixes

Nothing special. Can be deployed through the update script. However some installations may contain the bpr_typea.desc file inside App_Data/signals/descriptions folder which is unnecessary now and may be deleted.

• Chart axis autodetection improvements (v1.7.1)
• SOE Aggregations (v1.7.1)
• Improved signal search dialog on the HOME tab (was too slow for many signals) (v1.7.1)
• Minor bugfixes
• Dashboard/Status page (v1.7.3)

Nothing special. Can be deployed through the update script.

• Dashboard page simplification and improvements
• Guides included in HELP/CALCULATION pages
• Menu changes
• New icons for charts, increased spacing between buttons
• German localization support
• Updating through TAV information tables (if-available)
• Minor bugfixes

Nothing special. Can be deployed through new update script.

• Minor bugfixes

Nothing special.

• chart component improvements (showing unit, icons clarifications, IE export fix, vertical axis maintains manual settings even after navigation in time)
• supported browser check (displays red bar on top of the page when unsupported browser is used). For the moment the supported browsers are: Firefox, Chrome, Safari, Edge (any version) and MSIE (at least version 11). Safari may have some scrolling issues, however it's not considered as unsupported (due to presentation requirements by Petr, etc.)
• signal groups can be now saved as public or private. Old signal groups are considered as public
• calendar component now shows all years with data
• page title now contains server name instead of version (which can be now found at the bottom of the HELP page or as a hover title for the HISTORIAN label at the top of the page)
• soe invalid ordering bugfix
• user is notified when he/she tries to create a user whose login contains unsupported characters
• AJAX errors (errors in javascript code encountered during communication with server) now produce more user-friendly error dialog
• application is generally more tolerant to errors in data (it can handle signals whose table names are missing and will not crash if the columns of the data table are mismatched). However this is only partial workaround and the real bugfix is to correct the data!

Nothing special.

• New custom JS component for charts (allowing fullscreen mode, PNG export, etc.), dygraph library removed
• signal search using descriptions now allowed on HOME and ALARM MANAGEMENT
• minor bugfixes for: excel export, overview screen
• unlimited export from HOME, increased limits for charts
• improved since-till date entering for ALARM MANAGEMENT and excel exports (at HOME)
• user management (new section SETTINGS)
• new TXP aggregation method (last value is valid until new value arrives)
• PNG export of overview&timeline screens

It is recommended to double check the MySQL server configuration as specified here. The number of files opened at once has been raised from 5000 to 10000 (in order to evaluate complex queries durint plant restarts).

For version where user restrictions are in place, one should update the instance.xml configuration file as follows:

Restrict access to the settings using following line (there will be already similar lines for realms dashboard/apiv1):

<accessRestriction type="restricted" realm="settings" />

Grant access to the settings to at least one user (user definition will contain similar lines for at least the dashboard realm):

<allowedRealm>settings</allowedRealm>

You may want to update the deployment notices which contain some info about the limitations. Just updat the deploymentNote inside instance.xml file.

<deploymentNote place="Index">Maximum one year period in this demo. Don't know where to start? Try March 2011 ...</deploymentNote>

• Overview/Signal timeline (alá iOS version)
• PointsChart (under HOME tab when 2 signals are selected)
• New calculation commands (failure, countSignalsByGroups, countEventsByGroups)
• Tabs renamed (Calculation/SOE -> Data Analysis/Alarm Management)
• Simplified datetime selection (under Home & Alarm Management tabs)

Nothing special.

• Signal groups (under HOME tab)

Nothing special.

• Configurable text descriptions (for Home and SOE tabs)
• Events Grouping for SOE tab
• Renaming app back to Historian

Add following elements to the instance.xml

<deploymentNote place="SoeList">Don't know where to start? Try March 2011 ...</deploymentNote>
    <deploymentNote place="Index">Maximum one year period in this demo. Don't know where to start? Try March 2011 ...</deploymentNote>
    
    <soeList>
      <eventGroup name="A">
        <eventType type="A" />
      </eventGroup>
      <eventGroup name="C">
        <eventType type="C" />
      </eventGroup>
      <eventGroup name="D">
        <eventType type="D" />
      </eventGroup>
      <eventGroup name="E">
        <eventType type="E" />
        <eventType type="EA" />
      </eventGroup>
      <eventGroup name="F">
        <eventType type="F" />
        <eventType type="FD" />
        <eventType type="FI" />
      </eventGroup>
      <eventGroup name="I">
        <eventType type="I" />
        <eventType type="IS" />
      </eventGroup>
      <eventGroup name="O">
        <eventType type="O" />
        <eventType type="OD" />
        <eventType type="OE" />
        <eventType type="OI" />
        <eventType type="OMCST-S" />
      </eventGroup>
      <eventGroup name="S">
        <eventType type="S" />
        <eventType type="SD" />
      </eventGroup>
      <eventGroup name="T">
        <eventType type="T" />
        <eventType type="TLFCST-S" />
        <eventType type="TLFSMCST" />
        <eventType type="TOMCST-S" />
      </eventGroup>
      <eventGroup name="W">
        <eventType type="W" />
        <eventType type="WOFMCST-" />
      </eventGroup>
    </soeList>

• SOE tab
• Home tab - per second interpolation
• Home tab - ability to draw multiple signals into one chart (button JointChart)
• Home tab - separate page for signal detail (with descriptions, documentations, etc.)
• Overview tab - internal preview

• API for iOS application now requires API key. This key is set inside the instance.xml file and should be contained also in the iOS application.

<!-- Allowed identification of API clients -->
<apiKey realm="apiv1">32d6c98vc98d6ree53d</apiKey>

• New and work-in-progress features now may be hidden from the UI by adding an element hideFeature inside the instance.xml file

<!--Features that should be hidden from UI-->
<hideFeature>WebHistorian.Calculations</hideFeature>
<hideFeature>WebHistorian.Overview</hideFeature>

• There's a new page called SOE which allows browsing through the RAW SOE records. They may also be exported into CSV file, but there's an upper limit of records allowed to export. It's configured in instance.xml by the maxRecordsForSoeList element.

<maxRecordsForSoeList>5000000</maxRecordsForSoeList>

• New support for async calculations was introduced in this version. The results of the calculations are stored as files. The system will automatically delete calculations older than some interval predefined in instance.xml

<!--remove calculations older than ... -->
<removeCalculationsOlderThan>1.00:00:00</removeCalculationsOlderThan>

• Access restrictions for web
• App licensing
• New configuration options (see below)

• App access restrictions are now configured separately for iOS app and for web dashboard. Therefore inside instance.xml instead of

<accessRestriction type="open" />

use:

<accessRestriction type="open" realm="apiv1" />
<accessRestriction type="open" realm="dashboard" />

• if you decide to close the app from public (=switch it to the restricted mode), than you need to include particular user accounts (element called allowedUser) inside the instance.xml file. See docs for more details

• from this version up you need to bind the application to particular hardware (more precisely to the mac addresses of the machine). The application will do this for you if you provide a file called licenseOverride (file contains some secret keys inside, therefore is provided separately) inside the App_Data/start folder. The access rights for this file should be set in a way that allows the app to read and remove the file. After success, this file is automatically removed.

• Application can now survive some errors during start up. To enable this feature, you should include following element inside the instance.xml file. This functionality has been implemented as a temporary workaround around some problematic SQL deployments.

<!--whether to swallow soft errors (eg. signal mapping initilization)-->
<allowSoftFailures>true</allowSoftFailures>

• Now you may configure the navigation inside the iOS app between signal hour view and SOE timeline. Simply include following code in the file instance.xml.

<signalJumpEvent previousTime="0.00:10:00" followingTime="0.00:10:00" previousSignals="20" followingSignals="5" />