Skip to main content
Version: v5.0

Release notes

Console App 3.5 release notes#

The Console App version 3.5 introduces the following enhancements:

New Permissions Profiles tab#

In the Passport Service console, there is a new Permissions Profiles tab. This tab lists the permissions profiles information for a given workspace. On this tab, you can perform operations such as:

  • View permissions in a profile
  • Edit permission profiles
  • Add permissions to a particular profile
  • Delete a permission profile

Improved Telemetry Config options#

In the Item Service console, there is now an improved Telemetry Config tab. This allows you to configure items in the Named Telemetry Collection item class.

With this feature, you can perform advanced telemetry configuration, including:

  • Setting up basic telemetry configuration information
  • Adding a normalization script
  • Adding one or more bindings scripts
  • Utilize a new script editor page which facilities easy editing of scripts

New features added to Data Sources Service#

On the Orchestrators tab, there is a new button - Refresh Orchestrator Runs. This updates the list of records of orchestrator runs listed on screen, to reflect the latest status of each run.

New functions to view OMAPI script logs#

In the Object Model API section, the introduction of a new OMAPI Requests tab, means that you can now view a list of the various requests made using the Object Model API service.

You can also now perform advanced searches in those request logs. You can filter requests using an extensive reange of fields, including:

  • URL
  • HTTP method
  • request status
  • created

Improved application handling.#

There are new features to assist applications handling. Under Application Management, you can now create a new application which includes two new fields in the application:

  • ID
  • Theme

Enhanced UI#

UI improvements include a new Select button which opens up a Welcome modal which is preloaded with your organization settings. You also now manually close any notification information pop-ups when they appear.

Known issues#

In this release, there are two known issues, which are as follows:

  • In the Passport Service, an issue may arise where you update an existing permission in the Permissions Profiles tab but those changes do not persist.
  • In the Object Model API section, when you apply a filter based on the status of Queued, it may still display logs with other status values.

Console App 3.4 release notes#

The Console App version 3.4 introduces the following enhancements:

Invitation management#

In the Passport Service console, a new set of management features have been added to the User Groups tab. There are now a range of options available for managing invitations to join a particular user group.

A new Invites dialog has been added when you can view a listing of all the users who have been emailed an invitation, along with the current status of each invitation.

On the new Invites dialog, you can perform a range of actions, including:

  • Search by email
  • Filter by status type
  • Send invitations to a user or multiple users
  • Copy invitation links, resend, and revoke invitations

Usergroup and workspaces partial search#

In the Passport Service console, the search functionality has been improved on the Workspaces and User Groups tabs. When running a search, you can now add a partial name in the search box. This allows for easier filtering and more focused search results.

Improvements to viewing user group permissions#

In the Passport Service console, there is now a wider range of information available for managing user group permissions in the User Groups tab. You can now view a wider range of user group permissions than was possible before.

On the Permissions dialog, a drop-down menu is available which allows a user to view permissions for the full range of user groups to which that user has access. It will also now list other user groups which are linked to the selected user group for an application.

Support for script versions#

In the Item Service Console, there is additional support for viewing version information. For items with an item class of script, you can now view previous versions of the script as well as the current version.

New system metrics added to the Item Service#

In the dashboard for the Item Service, you can now view additional system metrics, namely:

  • ScriptVersionCount
  • UserConfigVersionCount
  • NamedCompositeItemVersionSize

Console App 3.3 release notes#

The Console App version 3.3 introduces the following enhancements:

Introduction of Organization management functions#

The Organization Owner is a platform role that was introduced in Platform version 4.5. In Console App 3.3, there is a new dedicated page for the management of Organizations. A new Organization management icon is now available on the Dashboard console. Click this icon to open the new Organization Management page where Platform Managers can perform a range of functions for managing organizations, including:

  • Create a new Organization.
  • View and edit existing Organization details, such as name, description, and user attributes.
  • Configure Organization, where you can set details such as the maximum number of applications or workspaces allowed under a particular Organization.

Improved application management functions#

A range of features have been introduced to allow Applications Owners to easily manage Applications. A new Application Management option has been added to the Dashboard console. In previous releases, this was known as Application Details. Click this icon to open the new Application Management page where you can perform a range of management functions for an application, including:

  • Create a new Application.
  • View and edit an existing Application's details.
  • Configure Application settings such as the number of User Groups, Redirect URLs, Authorized Origins, Home Page, and list of Whitelisted Applications.

New features added to Passport Service console#

In the Passport Service console, there have been two main improvements:

  • In the User Groups tab, new users can now be invited as Organization Owners through the organization user group.

  • Users can now view name spaces in separate columns under both workspaces and user groups.

Improved UI options#

A new Select button has been added to the Console App Dashboard to allow easy access to the Organization/Application/Workspace selection modal window. To complement this, the existing Welcome dialog box has been improved to facilitate selecting Organizations, Applications, or Workspaces. You can also use a type-to-select feature to make these selections.

Issues fixed for 3.3#

For Console App version 3.3, an issue has been fixed where previously a user may have encountered issues when logging in. This problem occurred if the authentication token had expired.

Console App 3.2 release notes#

The Console App version 3.2 introduces the following enhancements:

User Group permissions#

A new Permission context menu has been added to each user group. This menu opens the User Group Permissions modal where you can view, edit and save the permission using check boxes.

You can also see different permissions by selecting different namespace options from the drop-down. For now, three namespace options are displayed:

  • namespace associated with the current app
  • project workspace
  • current user group

Telemetry Config tab#

A new tab called Telemetry Config has been added to the Item Service page. The Telemetry Config tab allows you to create a new telemetry config, or update or delete an existing one.

You can also add basic information about the telemetry config and add binding and normalization scripts. You also view this information in a JSON view. The tab will display an alert icon if there is no existing telemetry config.

Delete Workspace option#

A new Delete context menu has been added to each row of the Workspace tab. This option is only visible to application owners and allows them to delete the workspace, if required.

Improved query editor#

On the Item Service page, the query editor can now be toggled to exit full-screen mode by clicking the full-screen button in the top-right corner.

The code editor of the User Config and Script also has this feature. However, it differs as there is no full-screen button in the code editor. You click on the edit button to enter full-screen mode.

Change to listing of orchestrators and orchestrator runs#

A change has been made to the order in which orchestrator runs are listed. Now, by default, orchestrator and orchestrator runs are listed from the latest to the oldest, with the latest appearing in the first row.

Console App 3.1 release notes#

The Console App version 3.1 introduces the following enhancements:

New Platform roles#

New functionality has been added to the Passport Service which now offers three distinct types of Platform roles for the Console App:

  • Platform Manager
  • Application Owner
  • Application Developer

Each of these roles offers different privileges and abilities. Access will be restricted for any other users.

Setting limits on workspaces and usergroups#

The Console App, via the Passport Service console, now allows you to set limits on the number of workspaces and usergroups configured for a Platform application. Previously, any number of workspaces and usergroups could be configured for an application.

Enhancements to telemetry readings#

You can now view the telemetry readings in a JSON format and can easily copy this information via a single click.

You can also now easily search and filter telemetry readings based on ID, item ID, source ID and timestamp.

New search and sorting functionality for orchestrators#

In the Data Sources Service, you now sort the orchestrator and orchestrator runs in ascending and descending order respectively. You can now filter the orchestrators and orchestrator runs based on ID, name, user type, and description.

You can also now use a search function in the Data Sources Service to filter log information from the orchestrator run logs. If any orchestrator runs encountered errors, these errors will now be visible in these logs.

Implementation of Console App dashboard#

The Console App now has a new dashboard feature. The Console App dashboard displays tiles which allow access to Metrics Service information, a new feature of Platform version 4.4. They are three tiles which indicate metrics information for the supported back-end services - namely the Passport Service, Item Service and File Service.

The Passport Service tile will list the top-level metrics of workspace count and usergroup count. The Item Service tile will list the top-level metrics of size on disk and item count. The File Service tile will list the size on disk (including graphics file) and file count (including graphics file) metrics.

You can drill down from this top-level information to the lower-level metrics which are available for each service.

Enhancements to the User Interface#

A new column _userAttribute has been added to the User Group page. This column displays the workspace name with respect to the user group. This clearly indicates which user group access is required for a particular workspace.

The Console App is now available to select in the application selection menu.

The selected app and workspace are also now saved in the browser.

Console App 3.0 release notes#

The Console App version 3.0 introduces the following enhancements:

Improved features for telemetry readings#

You can now do the following with telemetry readings:

  • You can now view the telemetry readings of named telemetry collections from the Item Service.
  • You can filter readings by timestamp by providing From and To values.

Enhancements to Item Service#

You now have better access to information relating to the Item Service:

  • You can now view Item Service resource permissions for each user and see if they can perform operations such as create, read, update, delete, share, run, and assign.

  • You now have a graphic view of Item Service query results and can view the query results list as a graph or table.

  • You can now view related collections for named user collections. You can view all the related named user collections under the item class named composite items. This will also support graph view.

Implementation of server side sorting on Item Service page#

New functionality has been added regarding server side sorting which works as follows for different consoles:

  • Passport Service Console: This only supports fully matched searches. You must enter a complete name in order to find a record from the API.
  • File Service Console: This now supports partial matching in searches.
  • Item Service Console: You can now narrow your searches by applying multiple filters through adding fields and values.

Enhanced UI in Console App#

The following UI enhancements have been made:

  • You can now easily select which application and workspace you want to use. After you log in, a pop-up window will be displayed which allows you to select the application and workspace.
  • You are now presented with more UI information in the left panel of the Console App. If you hover over the icon of a service, the service name will now be displayed as a tool tip.
  • After you log in, you are now presented with an improved UI feature where graphical tiles are displayed for each service, along with some information on each service. This allows you to easily navigate directly to each service.

New field in Console App#

A new field: Home Page, has been added to the Application Details page. This field refers to the application URL.

Improved handling of queries on related items#

This improved handling works as follows:

  • Queries on related items will now be displayed in three formats: JSON, table, and graph.
  • You can now view the related items in a knowledge graph format by clicking the parent node which will display all the child nodes.

New graph query functionality#

A developer can now run graph queries using the new queries below. The results are returned in JSON format.

  • findInCollections
  • findWithRelated
  • distinctRelatedItemField
  • findWithRelatedGraph

Improved viewing of DataSources Service information#

A range of improvements have been made to how you view information from the DataSources Service, including:

  • You can now view the list of orchestrators and orchestrator runs.
  • You can also view the steps and logs of orchestrator runs.
  • You can now view the scheduled orchestrator runs.
  • You can filter on the list of orchestrators, based on the days, up to the last seven days.
  • You can now drill-down from the list of orchestrators to view their runs without deleting.
  • An orchestrator run will be now listed for seven days and will then be removed.

Improved configuration options for named user items#

You can now specify which users have edit access to named user items and can edit script and user configuration data.

Improvements to user groups#

A user list will now be available for each user group and you can now view all the users who have access to the group.

Improved facilities for notification templates#

You can now view the notification template code and preview the template. You can also now edit the code more easily.

New telemetry details in Item Service Console#

You can now view the telemetry configuration details of the IoT (Internet of Things) integration in the project.

Improvements to Object Mode API Console configuration#

You can now view the OMAPI configuration in the OMAPI service and it can be displayed in both tree view and edit view.

Enhanced handling of deletions for redirect URLs and authorized origins#

Now, when you attempt to delete any URLs or authorized origins, you will be prompted for a confirmation before proceeding with the delete operation.

Extended user access feature#

You can now remain logged in after 24 hours. The application uses the refresh token to maintain your session, so it should not expire after 24 hours.

Console App 2.0 release notes#

Application Details page#

You can now edit application details on the Application Details page.

Server-side filtering#

You can now use server-side filtering across all consoles in the Console App by using the search field with the following variations:

  • Passport Service console: Supports fully matched search only. You must enter a complete name in order to find a record from the API.
  • File Service console: Supports partial matching
  • Item Service console: You can add multiple filters by adding the fields and values you want to filter by to narrow your search. For more information, see Filtering your related item search.

Version support#

You can now perform actions on file and item versions:

Rotated refresh tokens#

After 24 hours, the Console App automatically refreshes the token, getting a new authentication token without user’s involvement.

Pending user group invites#

When you log in, any pending user group invites appear in a pop-up dialog. You can accept or reject invites.

Custom theme#

Configure branded logos and styles in the config.js file.

Console App 1.0#

The Console Application is a graphical user interface you can use to view and manage application and workspace data and resources stored in the platform services.