SmartHub INFER Release Notes

SmartHub INFER™ Release Notes - Sept 30, 2024

SmartHub INFER™ IoT Center is a secure, enterprise-grade, edge and IoT solution that provides visibility and control over all IoT use cases. It helps companies to onboard, configure, monitor, manage and secure IoT devices and infrastructure. The solution enables IT and Operational Technology (OT) to simplify device management and operationalize IoT use cases quickly by reducing the complexity of managing all the heterogeneous edge and IoT systems in one place.

What’s New?

Learn the latest features, improvements, and bug fixes in this release notes.

Track User actions INFER™ has now introduced an option that would allow you to opt in for INFER™ to track your actions on the UI. This feature will help INFER™ to improve the user experience based on the data collated in the backend.

New Features and Improvements

While creating or editing a Device Template, you can now add the file type or file extension while creating or editing a Device template.
User information in Audit Log - You can now track every action when you are creating, updating or even deleting in Audit Log on the INFER™ UI. For more information, see SmartHub INFER™ User Guide.
Space Management - You can view and assign the required parent space in the Space tree while creating a Space. INFER™ provides you with extensive hierarchical view of sub-spaces that are aligned to the selected parent space.
When an API key token is created, the API token’s expiration validity ranges from 1 to 365 days. However, you still have option to use the default maximum validity.
Certificates - This release introduces enhanced certificate management capabilities in INFER™ to provide edge administrators with greater control and security when handling certificates across their devices and systems.

Multi-functional Certificate Support: INFER™ now allows edge administrators to import certificates, ensuring secure delivery to the edge. These certificates can be used by the INFER™ Agent and adapters to configure devices for specific purposes, enhancing security and flexibility at the edge.

Certificate Import and Management: Administrators can seamlessly import certificates into INFER™, simplifying the process of managing secure connections and data protection at the edge.

Assign and Unassign Certificates: The ability to assign or unassign certificates to devices provides administrators with fine-grained control over certificate usage, ensuring that devices are only equipped with the necessary certificates when required.
Alert Definition - You can now select one or more than one Notification Definitions for an Active and a Cancelled alert. See INFER™ User Guide for more information.

Resolved Issues

1. Re-enrollment of Gateway

Problem Statement
The gateway’s identity changes when it is replaced due to hardware failure or VM loss.

Solution When generating a gateway credential from a maintenance state on INFER™, a pop-up appears on the UI. This allows you to revoke the old credential and generate a new authentication credential. Ensure you have the REENROLL_DEVICE permission to re-enroll a gateway.

2. Disabled Edit/Delete button

Problem Statement

When the parent Org ID is empty, the UI still displays the Edit/Delete button. This issue is now resolved.

Known Issues

None

REST APIs

GET device templates API adds “fields” and “allowedApplications”.
GET audit logs API now allows querying by multiple device IDs. INFER™ has now introduced a new query parameter that accepts a list of IDs, and removed the query parameter for a single device ID.
GET bulk register API updates bulk registration to include entities in response.

SmartHub INFER™ Release Notes - June 19, 2024

What’s new in SmartHub INFER™?

Learn the latest features, improvements, and bug fixes in this release notes.

New Features and Other Improvements

System

Restriction of Multiple Forgot Password requests: Sending numerous Forgot Password requests results in sending a significant number of emails, which can lead to service interruptions and diminish the user experience. To address this issue, we have implemented a waiting period of just 60 seconds before allowing another Forgot Password attempt.

Settings

Org Settings now support the integration of SmartHub’s vertical application like CONVERGE.
Root Org ID is read-only: Organization ID for the root org is now read-only from the INFER™ UI.

Alerts & Notifications

In the Alert Definition wizard, you can now use the Enter key to go to next page.

Device Templates

While specifying sensitive custom properties of a device template, empty values are not allowed.
Allowed File Types: More Whitelisted file extensions (.log, .txt, .png, .jpg, .jpeg) can be uploaded using the Edit Device Template wizard.

Devices

Devices are updated on space deletion: When a space is deleted, the Device Management service unassigns associated devices.
Encryption of sensitive properties: Device passwords as a property were not marked sensitive until now. Now when a property in a Device Template is marked as sensitive, the property with the identical key in the associated devices are marked as sensitive and also encrypted asynchronously.
Cancel pending commands: During device maintenance/migration/deletion, existing pending commands obstructed further action. Now such pending commands can be cancelled.
Bulk Command cancellation: You can also select multiple PENDING commands and cancel them from the Device Commands page. You can state the reason for doing so and this information is captured in audit logs.
Bulk Assign Spaces to Devices: You can now assign spaces to devices in bulk using a xslx file through the Device List action. You can download the sample spreadsheet, fill in the details and re-upload to bulk assign spaces.
Download devices in bulk: You can now download more than 1000 devices across pages in a CSV.

REST APIs

Enhanced Search: The new Metric Query APIs allows you to make individual queries for each device and metric, along with data type.
All internal endpoints are now enhanced to GET and UPDATE system role.
GET device API is now non-paginated and made public.
GET device API now lists connectedDeviceCount key in the projection list without pagination.
GET device API now includes TemplateName as a query param as part of device request.
GET commands API is updated to support querying by multiple deviceIds and maxSamplesPerDevice.
PUT /api/{deviceId}/commands API enhanced to support command cancellations.
GET commands API updated with deviceIds and maxSamplesPerDevice.
GET spaces API enhanced to filter by multiple attributes.
GET spaces API now returns the response without pagination and projects the requested fields.
New GET alerts API returns the response without pagination and projects the requested fields. It also ensures that Mongo performs all the querying and project operations.
New resource type Device is added as a query parameter for existing list of alert APIs, metricKey is replaced by metricName.
Bulk Command cancellation: Previously, the Agent was the only client which could modify the command’s status to either FAILED or EXECUTED. With an Agent down, and without it’s API token, it’s hard to update the command status. Now, the UPDATE commands API is enhanced to allow any client (UI/API-KEY/Agent) to update the status of commands. This API now accepts multiple command objects in the request body. The new state CANCELLED is also added to PENDING, EXECUTED, and FAILED.
Use the new sleep_and_process_command method to put the THING (adapter) to sleep and execute the commands sent to it in the background, in a single thread.
Enhanced Search: You can run searches across all the pages of Notifications & Notification Definitions.

INFER™ Release Notes - Dec 2023

What’s new in SmartHub INFER™?

Learn the latest features, improvements, and bug fixes in this release notes.

New Features and Other Improvements

System

Restriction of Multiple Forgot Password requests: Sending numerous Forgot Password requests results in sending a significant number of emails, which can lead to service interruptions and diminish the user experience. To address this issue, we have implemented a waiting period of just 60 seconds before allowing another Forgot Password attempt.

Software Management

Download devices in bulk: You can now download more than 1000 devices across pages in a CSV.

Settings

Org Settings now support the integration of SmartHub’s vertical application like CONVERGE.
Root Org ID is read-only: Organization ID for the root org is now read-only from the INFER-UI.

Spaces

Bulk Assign Spaces to Devices: You can now assign spaces to devices in bulk using a CSV file through the Device List action.

Alerts & Notifications

In the Alert Definition wizard, you can now use the Enter key to go to next page.

Device Templates

While specifying sensitive custom properties of a device template, empty values are not allowed.
Allowed File Types: More Whitelisted file extensions (.log, .txt, .png, .jpg, .jpeg) can be uploaded using the Edit Device Template wizard.

Devices

Devices are updated on space deletion: When a space is deleted, the Device Management service unassigns associated devices.
Encryption of sensitive properties: Device passwords as a property were not marked sensitive until now. Now when a property in a Device Template is marked as sensitive, the property with the identical key in the associated devices are marked as sensitive and also encrypted asynchronously.
Cancel pending commands: During device maintenance/migration/deletion, existing pending commands obstructed further action. Now such pending commands can be cancelled.
Bulk Command cancellation: You can also select multiple PENDING commands and cancel them from the Device Commands page. You can state the reason for doing so and this information is captured in audit logs.

REST APIs

Enhanced Search: The new Metric Query APIs allows you to make individual queries for each device and metric, along with data type.
All internal endpoints are now enhanced to GET and UPDATE system role.
GET device API is now non-paginated and made public.
GET device API now lists connectedDeviceCount key in the projection list without pagination.
GET device API now includes TemplateName as part of device response.
GET commands API is updated to support querying by multiple deviceIds and maxSamplesPerDevice.
PUT /api/{deviceId}/commands API enhanced to support command cancellations.
GET commands API updated with deviceIds and maxSamplesPerDevice.
GET spaces API enhanced to filter by multiple attributes.
GET spaces API now returns the response without pagination and projects the requested fields.
New GET alerts API returns the response without pagination and projects the requested fields. It also ensures that Mongo performs all the querying and project operations.
New resource type Device is added as a query parameter for existing list of alert APIs, metricKey is replaced by metricName.
New internal API to get dpKey.
New PUT API is created to save DPKeys in new Collection (dpKey).
As part of enhanced Forgot Password flow, notification get call is moved to notification-uservice-libs, adhering to microservice principles.
Hex values are now encrypted with plain text encryptor.
Encryption logic is moved to new class in userservice library.
InternalRestCallUtil.java is now moved to DeviceManagement.
Bulk Command cancellation: Previously, the Agent was the only client which could modify the command’s status to either FAILED or EXECUTED. With an Agent down, and without it’s API token, it’s hard to update the command status. Now, the UPDATE commands API is enhanced to allow any client (UI/API-KEY/Agent) to update the status of commands. This API now accepts multiple command objects in the request body. The new state CANCELLED is also added to PENDING, EXECUTED, and FAILED.
Use the new sleep_and_process_command utility to put the THING (adapter) to sleep and execute the commands sent to it in the background, in a single thread.