Release Notes for system:inmation 1.82

This release includes large scale changes to the Relay component and it is recommended that you contact the support team before upgrading an existing installation to 1.82. Please also read the Upgrade Notes - 1.82 and Compatibility Notes - 1.82 carefully. Changes to the secure communication between the Core and WebAPI could cause problems depending on the configuration of your system.

1.82.3 - March 31, 2022

Improved in 1.82.3

MSI - Historian Mapping, Script Mapping and Function Mapping

Improvements have been to the error reporting for the Historian Mapping of the MSI functionality. Also custom script mapping and function mapping have been enhanced with improved access to related message configurations.

OPC UA Server - Performance

The OPC UA Server component is improved in 1.82.3 with increased performance when handling high numbers of subscriptions. An issue has also been fixed with certain clients where server memory usage would increase with repeated calls.

Health Monitor

Added new health calculations and performance counters for the Relay to the Health Monitor. Improvements to handling of non-existing components and some other small fixes.

Lua API - Script Events

An issue has been fixed where in certain component configurations, triggering Lua script events could cause communication issues between the relevant components.

Master/Local Core - object synchronization

Issue fixed with potential object synchronization problems when a Master Core is restarted and object updates have not been synchronized with a Local Core yet.

Batch Tracker - Error Method handling

Fixed issue with the Batch Tracker regarding continuous warnings being produced with unspecified errors.

1.82.2 - February 25, 2022

Improved in 1.82.2

OPC UA Client - Subscription, opaque identifier types

Issue fixed when subscribing to OPC UA items with Item IDs with opaque identifier types using the inmation OPC UA client. The Item IDs are now interpreted correctly and subscription is successful.

OPC UA Server - ServiceLevel and UA Read

The inmation OPC UA Server ServiceLevel parameter is now more accurately reported on connection with a UA client. When the Server is connected to the Core a ServiceLevel value of 255 is set, upon disconnection this is set to 0 (Maintenance). The Server UA Read now also includes support for more standard UA nodes. Improvements to the Server_ServerStatus_State node value reporting accuracy, now sets the node value to 1 (Failure) when server can’t communicate to the core rather than the previously reported 4 (Shutdown).

OPC UA Server - Browse

Fixed issue that could lead to errors in number of items discovered and registered when browsing an inmation OPC UA Server namespace with large number of items under a single node.

SQL Catalog - ESI-Catalog

Improvements have been made to the esi-catalog library to support multiple datatypes for values, in addition to strings and tables.

The SQL catalog is configured by default to convert property values to integers if possible, using the EnableIntegerTypeAffinity on the Core and Connector objects. This should be taken into account when using the Lua API getsystemdb function. The EnableIntegerTypeAffinity property can be switched off if required.
OEE - General Improvements

Improvements have been made to the OEE functionality and related ISA-95 model objects to optimize performance.

WebStudio - Widgets and General Improvements
  • Table Widget: Table column headers can now be customized independent of the rest of the schema’s styling (for example, cell height). Also, issue fixed where changing a cell in a duplicate column would add the id field value as field in the row data.

  • Tree Widget: Tooltips can now be defined and added to nodes and icons in the tree widget. These can be dynamic or fixed with fallback text for the dynamic option where fields might be missing from the data.

  • Advanced Form Widget and Form Widget: Improvements to relative date inputs in the form widgets. Invalid relative date entries will be indicated by a red border around the date input field. Also, improved handling of empty date field inputs for the respective form widgets.

  • Time Period Table, Batch Table and Event Table Widgets: The DateTimePicker (previously available in the form widgets) is now available in the aforementioned table widgets.

  • Chart Widget: The default chart model to be used when a WebStudio user clicks the new chart icon can now be defined in the root level of a chart widget using the onNewChart model action.

1.82.1 - February 11, 2022

New in 1.82

Stateful Relay Component

The Relay component is now a fully stateful component in the system. This includes the addition of Performance Counters and the display of Object State in DataStudio in the I/O Model.

If you are currently using Relays in your installed system, please read the Upgrade Notes - 1.82 and consult support team before upgrading to 1.82. The changes to the Relay object mean that the configuration of existing Relays should be assessed before upgrade.
Security - Encrypted Communication

Communication between the Core and the following components/clients is now fully encrypted: Server, WebAPI and DataStudio. Please see the Secure Communication documentation for information about the available security modes.

If upgrading your existing installation, please read Upgrade Notes - 1.82 regarding your existing Web API service configuration before proceeding. In certain case the communication between Web API and Core could be disrupted.
Security - Global Settings for Encrypted Communication

The new Encrypted Connections Only property on the Root object can now be used to disallow unencrypted communication between components.

When activated, this will prevent older clients that do not support encryption (for example, older Web API versions) from communicating with the Core service. It can also prevent components that have not been configured for secure communication from communicating with the Core. Please read Upgrade Notes - 1.82 for more information before activating.
Secure by Default

Security mode for Intercomponent Communication is now TLS-SRP by default. Password must follow the system password policy.

Deployment Templates

Large scale installations of AspenTech Inmation can be now be executed in a standardized way using Deployment Templates. The template contains the necessary setup and configuration files to complete the installation with minimal human interaction.

WebStudio - Customizable Submit Button

It is now possible to customize the "Submit" button for the Table, Form and Advanced Form widgets. This is done using the "submitButton" property in the widget "options".

Improved in 1.82

OPC UA Client - Structured Datatype Support

1.82 contains improved support for OPC UA structured datatypes when connecting to an OPC UA Server with the UA Client.

ISA95 Equipment Model and KPI Model Integration

Improved Integration between ISA95 Equipment Model and KPI Model. ISA95 Site Objects can automatically create objects in the KPI Model.

Batch Tracker

Improvements and extensions have been made to the Batch Tracker including more robust data read error handling.

WebStudio - Support to Hide Active Floating Tab

The Tabs widget now supports hiding the active floating tab by using the message topic setActiveTab with activate set to "none".

Upgrade Notes - 1.82

Upgrade to Stateful Relay Objects

When upgrading your system containing Relay objects, there are certain existing configuration types that might need to be checked in order to upgrade in a controlled manner without problems. contact the support team before upgrading an existing installation to 1.82.

Components - Encrypted Connections Only property

The Encrypted Connections Only property on the Root object should only be activated once the Security Mode for all connected components has been configured to use Secure Communication (for example, TLS_SRP). If not, they could be locked out, without the possibility to remotely reconfigure for secure communication.

Web API Encryption - Encrypted Connections Only property

From 1.82, the Web API - Core communication has encryption enabled by default. If the Encrypted Connections Only property (introduced in 1.82) is activated, older Web API versions (<1.82) will not be able to communicate with the Core. It is recommended to update the old Web API service and reinstall with the default encryption enabled. Additionally, a Web API 1.82 or higher installed with default encryption will be unable to communicate with Core service versions <1.82. Please visit the Web API installation section for more installation options.

Web API - Authentication

From 1.80 onwards, a new installation of the system requires that a non-default authentication profile and password be specified for Web API communication to the Core. If using an older Web API version (that is not updated together with a Core on the same host) to communicate with a newly installed 1.80 or above Core service, the Web API might not be able to communicate using the default profile. It is recommended to update the old Web API service and reinstall using the new authentication profile and password.

Security Improvements

Introduced in 1.80, the password policy related to Profile objects and component communication passphrases will still be compatible with existing passwords on existing deployments. However, it may have an effect on custom deployment scripts. If those scripts automatically change such password/passphrase properties, they might fail due to violating the new policies.

MongoDB version 4.4.10

From 1.78.3, AspenTech Inmation is shipped with MongoDB version 4.4.10 (previously 4.4.8 with 1.78.2 and 4.0.2 in older versions). If using the Windows installer, the existing installation of MongoDB will not be upgraded automatically. To perform the upgrade manually, please visit the MongoDB upgrade instructions for Standalone, Replica Sets or Sharded Clusters depending on your own installation.

Continued usage of older component versions with new Core

The system allows the user to control component updates and configure how these component updates are verified when the Core service itself is updated. However, it is not recommended to leave Core/component versions unaligned for extended periods of time as this can potentially lead to communication issues between the components. Maintaining objects under components with different class versions to the Core could also lead to unexpected behavior.

Interoperability of 1.72 and older Components - Store and Forward (SaF)

Connectors and Local Cores that are not up-to-date (not version 1.74 or newer) will be unable to forward historical data or events to parent Cores version 1.74 or newer. This affects only the systems where said components are configured for the manual-permissive software update mode. The data will be stored locally at the outdated component (within the configured storage limits) until the component is updated, then the previously stored data will be forwarded normally.

Code Execution Component Property

The Code Execution Component property is not configurable in DataStudio for KPI Model Site and S95 EM Site objects created in 1.78 or earlier. Please contact the support team for more information on configuring this property in your existing system.

Compatibility Notes - 1.82

Deprecation of the SCI::

With 1.82, the Simple Call Interface (SCI) API has been deprecated and will be removed in a future version. Users are advised to use WebAPI’s REST API directly or any of our other API clients.

Deprecation of the OPC DA XML data source::

With 1.82, the OPC DA XML data source has been deprecated and will be removed in a future version.

OPC Classic Event Handling

The previous way of returning classic OPC COM events in getvalue as a flat list of key/value pairs (version 1.76 and older) is deprecated. The defaults switch introduced in 1.78 is now the default.

Administrative Group Property

In 1.76, the AdministrativeGroup Property of the Profile class changed from a boolean datatype to integer with codings available in the AdministrativeGroup Coding Group. This is only an issue if upgrading from versions older than 1.76.

Password Policies

The Password Property of the Profiles class can now be null. Existing Lua scripts that use getvalue with this property need to be able to handle the case that the returned value can be nil. A login with a profile with a null password is not possible.

Deprecation of os.setlocale function

The Lua os.setlocale library function was deprecated in 1.76. Although the function will still work in this release, it will be replaced or removed in a future release.

Compatibility of 1.82 with Visual KPI 5.92.4.546

system:inmation v1.82 is compatible with Visual KPI versions 5.55.1.344 and greater, with the exception of 5.57. system:inmation v1.82 has been tested with Visual KPI version 5.92.4.546. Also visit the Transpara Release Notes for detailed interoperability information.

Supported Operating Systems and other Applications in 1.82

Please see the System Requirements section of the documentation for more information and recommendations regarding installation environments.

Component Supported Operating Systems

Core Service (64bit)

Windows Server 2019

Windows Server 2016

Windows Server 2012 R2

Windows Server 2008 SP2

Windows 11

Windows 10

Windows 8/8.1

Windows 7 Prof. SP2 (64-bit)

Windows Vista SP2 (64-bit)

Web API Service (64bit)

Windows Server 2019

Windows Server 2016

Windows Server 2012 R2

Windows 11

Windows 10

Windows 8/8.1

Connector, Relay, Server Service (64bit)

Windows Server 2019

Windows Server 2016

Windows Server 2012 R2

Windows Server 2008 SP2

Windows 11

Windows 10

Windows 8/8.1

Windows 7 Prof. SP2 (64-bit)

Windows Vista SP2 (64-bit)

Connector, Relay, Server Service (32bit)

Windows Server 2019

Windows Server 2016

Windows Server 2012 R2

Windows Server 2008 SP2

Windows Server 2003 SP2

Windows 11

Windows 10

Windows 8/8.1

Windows 7 Prof. SP2 (64-bit)

Windows 7 Prof. SP1 (64-bit)

Windows 7 Prof. (32-bit)

Windows XP SP1 (32-bit)

MongoDB 4.4.10

Windows Server 2019

Windows Server 2016

Windows 11

Windows 10

DataStudio

Windows OS must support .NET 4.6.2

Windows Server 2019

Windows Server 2016

Windows Server 2012 R2

Windows Server 2008 SP2

Windows Server 2003 SP2

Windows 11

Windows 10

Windows 8/8.1

Windows 7 Prof. SP2 (64-bit)

Windows 7 Prof. SP1 (64-bit)

Windows 7 Prof. (32-bit)

Visual KPI

Windows Server 2019

Windows Server 2016

Windows Server 2012 R2

Windows 11

Windows 10

WebApps

Google Chrome > 88.0

Microsoft Edge (Chromium version) > 88.0

Microsoft Edge (old version) 44.0

Apple Safari (macOS) > 14.0

Apple Safari (iPadOS experimental) > 14.0

Mozilla Firefox > 86.0

Fixed Issues in 1.82

TFS ID Title Area Date
20212 Action items triggered by event streams can lead to deadlocks system:inmation\Services 2022-03-30
20211 When an invalid continuation point is passed to UA HistoryRead call to release the continuation point, 'Good' status is returned system:inmation\Services 2022-03-30
20181 Server service does not release the memory system:inmation\Services 2022-03-30
20132 Subscriptions to the UA Server don't work well when there are a lot of monitored items system:inmation 2022-03-31
20117 MSI: Script Mapping, Function Mapping: How to find self within a Message Configuration object system:inmation\Services 2022-03-23
20014 BT: excessive number of unspecific warnings during normal operation system:inmation 2022-03-31
19961 MSI: Historian Mapping: Invalid path does not lead to an approriate error response, but to a timeout message system:inmation 2022-03-10
19960 MSI: Historian Mapping, in error case, optional responses are not filled with "" system:inmation\Services 2022-03-10
19725 ServiceLevel value of inmation OPC UA server is always zero system:inmation\Services 2022-02-23
19705 Redundant event stream objects are active in both master and local Core (duplicate events) system:inmation 2022-02-11
19639 Using Persistency Mode appends ".0" to numeric strings system:inmation\DataStudio 2022-02-14
19631 System database stores "number-like" string values as numbers system:inmation\Services 2022-02-14
19601 OpcUa_BadInvalidArgument error in inmation.log system:inmation\Services 2022-02-23
19479 MSI: Pending messages not set/reset correctly system:inmation 2022-02-22
19440 Core service stops running when the password of SCRAM-SHA-256 auth. mode is removed in MongoDB connection property compound system:inmation\Services 2022-02-07
19285 WebStudio - Advanced Form: Resize does reset some fields when editing system:inmation\WebStudio 2022-01-21
19213 MassConfig Console incorrect for escaped paths system:inmation\DataStudio 2022-01-20
19163 History is not transferred if the latest point in history has bad quality system:inmation\Services 2022-02-11
19138 Object move in Asset Model failing system:inmation\Services 2022-01-17
19070 WebStudio - Advanced Form: Default property values are not applied to the form data system:inmation\WebStudio 2022-01-21
19034 Local core crashes with error code 0xc0000005 system:inmation\Services 2022-01-20
18996 Python API Client returns results from wrong request system:inmation\Services 2022-01-19
18734 OPC UA Subscription does not work for Item IDs with opaque identifier type system:inmation\Services 2022-02-23
18362 Python API Client not working after a token refresh system:inmation\Services 2022-01-19
18093 Report Item - Query Objects property is not set when "OK" button is used system:inmation\DataStudio 2022-03-02
13413 Local and Master Core may have different object versions system:inmation\Services 2022-03-30

Known Issues in 1.82

TFS ID Title Area Date
9677 Excel Addin - Actions pane is not shown when some other add-ins are enabled system:inmation 2019-07-12
9388 Excel add-in - There is no order in the object tree or in the search result system:inmation\DataStudio 2019-06-19
9383 Excel Addin - VBA Module popup appears every time a new worksheet is used system:inmation\DataStudio 2019-06-18
9345 Web API - Authentication; ’sub’ claim in token not always the same for same Active Directory user. system:inmation\Web API 2019-06-14
6511 ProcessValueLink property causes confusion system:inmation 2018-08-16
6296 The UA connection is functional despite 'Server Certificate Endpoint Host mismatch (creating session)' error system:inmation\Services 2018-08-02
6264 Changing the port of the Core is not working system:inmation 2018-08-01
19460 Error when trying to save a Chart over a pre-existing chart with the same name. system:inmation\WebStudio 2022-01-28
19200 AuditTrail: Periodic external writes created by Local-Core system:inmation 2022-01-13
19189 Renaming the parent connector object breaks ODBC datasource system:inmation\Services 2022-01-13
19103 Filegrid widget documentation checking system:inmation\Documentation 2022-01-03
19056 Server object unable to connect after image removal system:inmation\Services 2021-12-21
18819 It is not possible to connect to Web API service if a very long access token lifetime is set system:inmation\Web API 2021-12-07
18784 External Writes not in Audit Trail system:inmation 2021-12-03
18553 Strange status behavior with server model objects system:inmation\Services 2021-11-22
18375 msgqueue - address in use system:inmation\Services 2021-11-05
18340 Documentation of CustomTimeRetention property is incorrect/misleading system:inmation\Documentation 2021-11-04
18338 ModObjectState no longer documented after v1.70 system:inmation\Documentation 2021-11-04
18175 AdvancedLuaScript Property - example leads to misunderstanding system:inmation\Documentation 2021-10-19
17953 Custom Event Types being a child of another Custom Event Type is not handled in inmation UA A+C client system:inmation 2021-09-24
17766 IO-Node UA node-data properties are not read when object is created manually (without browsing). system:inmation 2021-09-06
17728 WebAPI - allocation timeout creates error 500 system:inmation\Web API 2021-09-01
17433 WebStudio Form Date input field doesn't send the date in the current format after it's been changed system:inmation\WebStudio 2021-08-05
16941 No data in the real time trend after changing Marker startup type option system:inmation\DataStudio 2021-07-19
16886 Code Deletion by two times pushing F9 system:inmation\DataStudio 2021-07-12
16393 MongoDB index creation failure for one collection marks the whole connection pool as being bad system:inmation 2021-06-16
15516 UA Datasource cannot browse a particular OPC UA server system:inmation 2021-04-30
15499 DataStudio - Sorting of numeric values in tables/grid displays in alphabetic order system:inmation 2021-04-29
15460 gethistory() returns null values when querying historical data for objects with a reference to the same Process Value system:inmation\Services 2021-04-27
15222 Password protected UA certificates can't be used system:inmation 2021-04-07
15203 Events Received perf. counter of Custom Event Data Store object causes confusion system:inmation 2021-04-01
15118 Problems in image loading with escaped object names / paths system:inmation 2021-03-23
15076 syslib.execute() times out when the executed Lua chunk returns a function system:inmation 2021-03-18
14432 Inherited location option is not functioning system:inmation 2021-01-21
14016 Web API - ReadHistoricalData endpoint returns 0 instead of NoValue with TimeAverage and TimeAverage2 aggregates system:inmation 2020-11-27
13925 The MONGODB function(inmation.Backup library) returns "0:nil" after the successful operation system:inmation 2020-11-19
13574 Unable to keep report group header together with details system:inmation\DataStudio 2020-10-15
13525 Handling of KPI Tables without STARTTIME&ENDTIME arguments creates error system:inmation 2020-10-12
13228 Scroll speed change on Windows OS is not applied in DataStudio system:inmation\DataStudio 2020-09-10
12985 UA Client - URI Mismatch between ApplicationDescription and Certificate system:inmation\Services 2020-08-17
12505 The data holder object is corrupt when it is created below the connector by an action item with a triggering link system:inmation 2020-07-07
12453 historicaldataattime does not work for datatype string for VKPI widgets system:inmation\Web API 2020-06-29
12393 History Transfer Controller is not producing data points at Expected Frequency while using an aggregate system:inmation 2020-06-19
12299 Master core version is unknown from local core version system:inmation 2020-06-03
12134 Memory ramp-up with simultaneous Lua script instances system:inmation 2020-05-06
12079 inmation Server spams Windows Event logs system:inmation 2020-04-28
11984 inmation.mass can INSERT but not REMOVE system object system:inmation 2020-04-15
11715 Core service silently deletes or ignores critical objects in the image system:inmation 2020-03-06
11361 MongoDB Backup - The content of the source folder is not copied fully to the destination folder during the full backup system:inmation 2020-01-27
11288 It is possible to create multiple core and system objects with Lua mass system:inmation 2020-01-21
11238 Web API authentication fails with a profile that has a backslash(\) in its password system:inmation 2020-01-16
10590 Configurations of MongoDB replica set are not passed to the Core system:inmation\Services 2019-10-18

UA Compliance Tests

Total Tests 831

✅ Passed

723

❌ Failed

108

Pass Percentage

87.00%

For more details see UA Compliance Tests page.