HighByte Intelligence Hub Version 3.1

New Features:

• Added the ability to import and export full or partial project configurations through the UI.
• Added a REST Data Server API to read Connection Inputs and Instances and write to Outputs.
• Enhanced Input, Instance, and Flow templating to allow template parameters to be pulled from third-party sources like SQL, CSV, etc.
• Added templating support to Flows.
• Added an Apache Kafka Connection that supports Outputs.
• Improved the speed and interoperability of the OPC UA Connection.
• Added a Point Changes Input type to the PI System Connector to support reading late arriving and changed data in PI Archives.
• Added a PI System Input type for reading Asset Framework metadata and hierarchy.
• Added support in PI Point reads to import the point list from an external source like CSV, PI Asset Framework query, etc.
• Added support for reading and writing PI System Digital Points.
• Enhanced PI Point outputs to support all PI output types (replace, insert, insert compressed, etc.).
• Improved the speed of PI Output Asset writes when “create” is enabled.
• Enhanced PI outputs to allow the _timestamp field in the data to control the write time.
• Added FTP support to the File Connector.
• Added settings to AWS IoT SiteWise Outputs to control where data is placed in the IoT SiteWise hierarchy and how it is named.
• Added Sparkplug Input and Output support for CMD messages.​
• Enhanced test reads that return data greater than 256KB to return  partial results.
• Added support in Data Pipelines for multiple input stages.
• Added support for Data Pipelines Status information under the System namespace.
• Enhanced Modbus Connection Inputs to support 32/64-bit registers and BYTE/WORD/DWORD ordering.
• Added REST Client settings for configuring an HTTPS proxy.
• Enhanced User Claims to allow naming of each claim.
• Updated the SQL Input test reads to show the full read results.
• Enhanced the tagging view to allow users to more easily see what is tagged.
• Enhanced the UI for the REST Client headers to enter each header in a table format.
• Renamed the license file from intelligencehub-license.json to intelligencehub.license.
• Added an error log message to Connection Outputs if a write is dropped, because a previous write is in progress and store and forward is disabled.
• Updated Custom Conditions to not cache the lastValue if lastValue is not used in the expression.
• Improved the 404 error page shown in the UI to include information on the object that cannot be found.
• Added attribute filter settings to the Write New Target stage in pipeline.
• Added support for importing proprietary models using dynamic references.
• Added an Element Unify Connection with the ability to import Templates as Models and Graph Queries as Instances.
• Enhanced custom conditions to not retain lastValue and lastReturn value if they are not being referenced.
• Added the ability to include Sparkplug properties during reads.
• Added the ability for payload attributes to retain their original data types when passed through a JavaScript expression.
• Added the ability to auto-generate an admin password on initial startup when using the HIGHBYTE_AUTOGENERATE_ADMIN_PASSWORD environment variable.

Fixes:​​

• Fixed an issue where indexing was not working for PI Connection Raw Point read types.
• Fixed a bug where Webhook Connections created in version 2.5 would not work in 3.0 or 3.1 unless they were re-saved in the UI.
• Fixed a bug in Data Pipelines where a Write New Target stage would fail to write if the connection had store and forward enabled.
• Fixed a bug in PI System Outputs where including a _name attribute in the payload caused points to be prefixed with the _name value.
• Fixed a bug in Remote Hub connections where the connection failed if the remote hub hostname did not meet the internal naming conventions (e.g., only numbers).
• Fixed issues when trying to start an Event based flow with a non-event based source did not result in a Flow status error.
• Fixed a bug in the File Connector where writing to an invalid directory did not cause the Flow to go into error.
• Fixed a bug in PI Outputs where milliseconds were removed from ISO-8601 timestamps.
• Fixed a bug in PI Inputs where Indexing would fail to increment for large queries.
• Fixed a bug where Parquet File test reads with Indexing enabled would always read from the start of the file and not from the current index location.
• Fixed a bug that occurred when adding a tag to a user Claim and not selecting “Add” before selecting “Save”. This caused the Claim to be saved with a null value.
• Fixed an issue where the username was not shown in the UI when logging in with third party SAML authentication.
• Fixed a bug where the Activity Page title for Pipelines was not showing the correct label.
• Fixed a UI issue where a child model’s Array and Required fields were misaligned.
• Fixed a bug where the Condition details page “Overview” option remained highlighted after selecting the Usage tab.
• Fixed a bug where Input, Instance, and Condition references were not renamed when indexed into the referenced payload.
• Fixed a bug where users could create models with the name “Any”.
• Fixed a bug where users could update users/roles to have the name of an existing user/role.
• Fixed a bug where indexing PI Point reads could return duplicate payloads.

 
Breaking Changes:

• Changed the AWS IoT SiteWise Output to no longer build out Asset names using “parent.child” hierarchy. IoT SiteWise no longer requires asset names to be globally unique. This change requires users to re-create Assets or use a Pipeline to re-create the previous naming hierarchy.
• Changed Sparkplug Inputs to not include the Device name in the payload if the Device name is explicitly set in the Input. The “Include Metadata” option can be used to access the Device name.

Patches (2023.6.1.735):

• Reverted change that improved efficiency of Instance array expansion. This change broke Instance expressions that used let or const to define JavaScript variables. This build allows let and const to be used as they were in prior versions. The efficiency improvement will be revisited in a a future release.
  
• Fixed a bug where flows were not restarted automatically when some flow dependencies of the flow were updated.

HighByte Intelligence Hub Version 3.0

New Features:

• Added Data Pipelines. Pipelines take flow output and provide additional capabilities like buffering and transforming, making it easier to implement use cases like protocol translation, file buffering, and more.
• Added support for a new embedded MQTT Broker that supports v3.1.1 and v5 of the MQTT standard.
• Enhanced the UI navigation and layout.
• Added support for Tagging to group objects in Central Configuration mode.
• Enhanced the roles and claims policy syntax to support assigning access rights at a Tag level.
• Added product licensing.
• Added support for performing test writes on Outputs.
• Added support for UA Methods as OPC UA Connection Inputs.
• Added branch read support to OPC UA Inputs.
• Added an option to OPC UA Outputs for automatically casting write data types to the UA Server defined type.
• Added the ability to browse MQTT Connections for Inputs.
• Added the ability to browse MQTT and OPC UA Connections from the Reference panel and auto-create inputs.
• Enhanced the AWS IoT SiteWise Connection to support updating Models and Assets with new attributes and hierarchy.
• Enhanced the AWS IoT SiteWise Connection to support AWS STS (Security Token Service) Authentication.
• Added support for using System Variables in Connection settings to make it easier to manage Dev/Test/Production environments.
• Enhanced System Variable to allow viewing and configuring variables through the UI in both the Settings and Remote Hub Configuration views.
• Added support for LDAPS to Active Directory authentication.
• Enhanced Sparkplug Inputs to allow for using wildcards as the Group or Edge of Node. In this mode, a single Input can ingest the entire Sparkplug namespace.
• Enhanced Sparkplug Inputs to include metadata (edge, group, and device IDs).
• Enhanced Webhook inputs to support file, form-encoded-url, and other content types.
• Added HTTPS and bearer token authentication support to Webhook Inputs.
• Added support for retrieving HTTP header information on REST Client and Webhook Inputs.
• Improved the REST Client Connection Output to find files in the payload when set to Binary mode.
• Improved REST Client Connection Inputs to support binary payloads and control the inputs content type.
• Enhanced the REST Client Connection to log the HTTP response body on failures.
• Added support for synchronizing Conditions, Instances, and Flows via Central Configuration.
• Added an option to OPC UA Collections and Branches to ignore bad quality values.
• Added an environment variable to control the location of the settings.json file on startup.
• Enhanced the Redundancy settings to include an optional connection timeout, required in some environments to support faster switchover times.
• Added support for mass OPC UA Input import via CSV file.
• Enhanced Model Import to support importing models in JSON format.
• Updated Store and Forward to support Files.
• Added String Array support to the Sparkplug Connector.

Fixes:​​

• Fixed an issue where changes to Global Functions were not picked up by a Custom Condition unless the condition was re-saved.
• Fixed an issue in Custom Conditions where recursive logic could cause high CPU utilization.
• Fixed an issue in Custom Conditions where internal keys “_name”, “_model”, and “_timestamp” were shown when iterating an objects key.
• Fixed a bug where a test read result with a quoted JSON text was shown as JSON and not an escaped string.
• Fixed an issue with CSV and Parquet File Output writes failing when the output directory didn’t exist.
• Fixed an issue with AWS IoT SiteWise Outputs where hierarchy that was not part of a model definition was not created correctly in the SiteWise Asset and Model.
• Fixed the shell scripts for Linux and Windows to allow launching the runtime from outside the runtime directory.
• Fixed an issue with Outputs where payloads with a “.” character in the attribute names created hierarchy in the output data.
• Instances no longer log errors for read errors on non-required fields.
• Fixed an issue with long read response payloads causing the UI to hang when performing test reads. Read responses are now truncated to 256K characters.
• Fixed an issue in Store and Forward where data types for null/empty values were not propagated to the Output.
• Fixed an issue where MQTT inputs that subscribed to /parent/# did not receive publishes sent to the topic /parent.
• Changed MQTT inputs to receive data in Binary format to return an Int8 array versus UInt8 array.
• Fixed an issue where event-based Flows did not work if a Sparkplug Input had a Device defined.
• Improved error handling in the Sparkplug Connection to log parsing errors for incoming data.
• Fixed a bug in Sparkplug Outputs where bad quality data was not being sent to the Output.
• Fixed a bug with the Azure IoT Edge Connection where the connection would not reconnect without manually saving the Connection in the UI.
• Fixed a bug with the Parquet Connection outputs that caused invalid data when using an Output across multiple flows.
• Fixed an issue where PI points that started with a “_” character were not written to PI.
• Fixed an issue where Sparkplug Inputs added hierarchy to leaf attribute names.
• Fixed a bug where flows that start with the same name shared the same status.
• Fixed a bug where the CSV Connection failed to read some UTF-8 CSV files that contained a BOM.
• Fixed a bug with the MQTT Connection where subscribing to a top like “topic/” with a trailing “/” caused reads to fail.
• Fixed a startup race condition that could sometimes cause the hub to not restart.
• Fixed a bug that caused SQL Outputs that write to Stored Procedures to fail.

 
Breaking Changes:

• Changed the default internal hub binding from “ihub” to “hub”. This only impacts customers using the internal binding with internal functions like ihub.withMetaData. Users need to either change this to hub.withMetaData or update the Application Settings Hub Binding Name parameter to use “ihub” instead of “hub”.
• Changed the text log output time format to YYYY-MM-dd hh:mm:ss (ISO 8601 standard) to be consistent with the rest of the product. This may impact log reading applications like Splunk or DataDog if they are not configured to read the timestamp generically.

View all release notes >>