Skip to main content
Version: v5.0

Platform 5.0 release notes

The Platform version 5.0 release introduces the following features and enhancements:

Introduction of new AI Service#

One of the main features of Platform version 5.0 is the introduction of the new AI Service. This new service adds several powerful AI features to the platform, offering the following capabilities:

  • AI Agents: An AI-powered component which understands input, can invoke tools as required and then responds based on its assigned role. Agents can be configured to process user prompts and retrieve real-time data.
  • Teams: Teams are groups of AI agents configured to work together to solve a task.
  • Tools: These are utilities which help agents retrieve or process platform data. A set of built-in system tools (see below) are provided but you can also create custom tools when needed.
  • KnowledgeBase: A collection of helpful information that the Large Language Model (LLM) can retrieve and use through Retrieval-Augmented Generation (RAG) to generate more accurate answers.
  • Conversations: Interactive sessions which maintain the context between the user and the team across multiple exchanges of information.

The AI Service also includes the following system tools:

  • Related Query Tool: Generates Item Service queries from user prompts.
  • Code Assist Tool: Creates scripts using the platform API, based on user prompts.
  • Platform API Tools: A collection of tools for all READ operation methods in the platform API.

For more information on the new AI Service, refer to the AI Service overview page

Addition of new Notification Service#

The Notification service is another new service which has been introduced for this release. The new Notification Service allows users to create rules for how application level events are transformed into notifications.

The Notification Service facilitates the creation of triggers which are rules which determine when a notification is sent. Scripts can also be utilized to allow for more complex determinations of which events result in triggers.

This service also allows other application users to register interest in topics so that they receive notifications on their devices. This provides a way for users to subscribe to groups to receive notifications of interest.

For more information on the new Notification Service, refer to the Notification Service overview page

New Workflow Service#

The new Workflow Service is a robust workflow engine which streamlines workflow creation and management. This makes it easier for application developers to build, orchestrate, and monitor complex processes.

The Workflow Service utlizes the following key concepts:

  • Workflow: A workflow is a business process or job that the Workflow Service will execute.
  • WorkflowDef: A WorkflowDef is a blueprint that defines the sequence, structure, and rules for the execution of a workflow.
  • Workflow worker: A Workflow worker picks up a task from the task queue and runs that task. It then reports back on the task result and status.
  • Task: A task represents one unit of work and is one step in a Workflow.
  • TaskDef: A TaskDef defines a task's name, type, retry policies, time-outs, and more.

For more information on the new Workflow Service, refer to the Workflow Service overview page.

Improved IafViewer support for graphics#

The IafViewer has been improved with a wide range of enhancements to its graphical capabilities.

For this release, the main IafViewer improvements are:

  • Enhanced viewing modes: The new IafViewer now supports both 2D and 3D graphics for viewing models, synchronized Mapbox, ArcGIS online web maps, and also supports photosphere imagery.
  • More flexible architecture: Domain experts now have direct access to the underlying technology with dynamic mode loading that avoids unnecessary dependencies.
  • Addition of new user interface and user experience options: With the addition of the Layout and Display properties, you have more options for configuring the UI and UX.
  • Persistent graphics data: Data such as GIS, model composition, and annotations are now persisted with permissions-based controls applied to users and user groups.

Additional IafViewer improvements include:

  • Tagged model composition: Improved flexibility and performance for Navisworks.
  • 3D vertical realignments: Realignments are now possible in GIS mode.
  • Extended camera controls: You now have more granular control over 3D views.
  • Better handling of multiple instances: Dealing with multiple instances of IafViewer is now standardized for features such as model comparisons and similar actions.

For more information about these new features in the IafViewer, refer to the IafViewer overview page.

Support for Navisworks plug-ins#

A new IPA plug-in is available to support Autodesk's Navisworks application. This also includes support for Scene-Graph Package (SGPK) files.

For more information about this new plug-in, refer to the Navisworks IPA plug-in page.

Improved OMAPI service#

When making a request for script logs, a new request parameter is now available which allows you to receive more information about the script details in the response.

For more information about this, refer to the Object Model API Service page.

Issues fixed for 5.0#

For release 5.0, a wide range of issues have been fixed through feature testing, regression testing and backwards compatibility testing.

Platform 4.6 release notes

The Platform version 4.6 release introduces the following features and enhancements:

GIS feature for the IafViewer#

The functionality of the IafViewer has been greatly expanded with the addition of the Geographic Information System (GIS) feature. This introduces geospatial capabilities to BIM visualization in the IafViewer. This enables you to place a BIM model on a real-world map using actual latitude and longitude coordinates.

The GIS feature also offers a range of powerful controls for the positioning, viewing, and displaying of building models in real-world maps, including:

  • Advanced support for GIS positioning of models with precise settings such as bearing, longitude, and latitude.
  • Controls for the displaying of models using settings such as zoom, pitch, and bearing.
  • A style setting which allow the selection of different map styles to define the look and feel of the map's terrain and road networks.
  • A globe view setting which visualizes large-scale geography in relation to a model.
  • A range of settings for displaying the elevation mode of a model.

Issues fixed for 4.6#

For release 4.6, a range of issues have been resolved through regression testing and implementing various bug fixes.

Platform 4.5 release notes

The Platform version 4.5 release introduces the following new features:

Introduction of new organization feature#

The organization feature has been introduced to the Passport Service. This is a new resource which sits at the top of the system resource hierarchy. An organization aggregates the other system resources, such as applications, under it.

To support this new feature, a new platform role has also been introduced - the organization owner.

The Passport Service also supports the configuration of multiple parameters for an organization.

New usage metrics have been added to the platform#

The Metrics Service provides detailed information about system events in a range of back-end services. For this release, two new sets of usage metrics have been added to the Item Service and the Passport Service.

In the Item Service, new metrics have been introduced which record a range of information, including:

  • Named Composite Item Count
  • Named Composite Item Version Count
  • Named Composite Item Related Connection Count
  • Script Version Count
  • User Config Version Count
  • Named Composite Item Size

In the Passport Service, two new metrics have been introduced:

  • Application Count
  • User Count

Improved IaFViewer#

The IafViewer has been improved with the addition of the following enhancements:

  • Performance: The performance of the IaFViewer has been improved with the introduction of caching for model composition. This feature enables users from different disciplines to save and retain their model composition user interface preferences, such as depth, layer settings, and linked model descriptions, when loading their projects. Previously, users had to manually reconfigure those settings each time they loaded a project. With this new caching feature, each user's custom configuration is automatically applied every time a project is loaded, which streamlines the workflow and improves overall productivity.

  • Grid Helpers: The new Grid Helper feature displays visual reference grids on a 3D model. This visual tool assists with more effective navigating, aligning, and analyzing of 3D models.

New functionality for Item Service and Related Items#

In the Item Service, new API calls has been added which allow you to configure permissions for specific Related Items. This new API feature allows you to match a set of Related Items with a set of given criteria, allowing fine-grained access control of Related Items which match the query criteria.

Improved Object Model API#

The Object Model API has been improved with the addition of the new request history functionality. Now script execution logs can be retrieved using request IDs.

To support this new feature, new REST API calls have been introduced which support the retrieval of request details.

Enhanced File Upload information#

In the File Service, the normal Film Upload and Resumable File Upload features have been improved. New content-type options have been added which improve the overall functionality. New resource events have been added which provide more information in the event of a file upload being cancelled.

New features in IPA Plug-ins#

Improved functionality has been added to the IPA Plug-ins in the following areas:

  • The exporting of 3D models from AutoCAD is now supported
  • You can also export ACAD object properties
  • A sandbox environment can now be added to the plug-in configuration

Account Settings improvements#

Improvements have been made to the Account Settings user interface, including:

  • The addition of a new account settings side menu
  • Updated page design
  • A hover effect has been added to certain buttons

Issues fixed for 4.5#

For release 4.5, a range of issues have been fixed through feature testing, regression testing and backwards compatibility testing.

Platform 4.4 release notes

The Platform version 4.4 release introduces the following new features:

Usage Metrics#

The new Metrics Service allows you to record detailed information about system events in a range of back-end services. It is a powerful tool which allows you to monitor what is happening in your Twinit apps and how system resources are being used.

The Metrics Service provides insights into metrics such as the number of user groups, disk space, and the usage of various system resources.

For this release, the Metrics Service will work with these three back-end services:

  • Passport Service (supports metrics on workspace count and usergroup count)
  • Item Service (supports a wide selection of metrics such as named user collection count, named file collection count, named telemetry collection count and many others)
  • File Service (supports metrics such as file count, file version count, preview image file size and others)

The Metrics Service provides a REST API for retrieving metrics information.

Improved IaFViewer#

The IaFViewer has been significantly improved with the addition of new functionality as follows:

  • Animation: With the updated animation framework, you can now add layers of animation over 2D drawings which can animate model elements, graphics, and sprites. This is a very useful tool for displaying animations of system workflows. This new feature supports the use of animation scripts which allow you to use a range of graphical elements in your animations. The new workflow feature also supports multiple animations including animated GIFs and animating properties such as scale, rotation, and opacity.

  • Annotations: New annotation tools have been added in the Annotations and measurement pane. This feature allows you to add annotations to a 3D model in the form of text callouts, lines, and polygon graphics. You also import and export annotations.

  • Enhancements for developers: There is a new feature which allows developers to use model composition to set default visibility for the different disciplines of a Building Information Model (BIM) such as mechanical, electrical and plumbing systems.

Improved support for IPA Plugins#

Platform version 4.4 has improved support for the latest IPA Plugins. There is now support for the latest versions of these plugins:

  • Revit 2025
  • AutoCAD 2025
  • Civil3D 2025

Improved Account setting page#

The Account setting page has been improved as follows:

  • A new sidebar menu has been introduced with additional options.
  • On the Account setting page, the My applications panel has been redesigned.
  • There are several improvements to the user interface.

New Platform roles in Passport Service#

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.

Other enhancements for the Passport Service#

The Passport Service now supports multiple configuration options for an application.

In the Console App, 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.

Further enhancements to the Passport Service have been made through the introduction of new API calls.

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 and use partial matches.

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.

Issues fixed for 4.4#

For release 4.4, a range of issues have been fixed through feature testing, regression testing and backwards compatibility testing.

Platform 4.3 release notes

The Platform version 4.3 release introduces the following new features:

Support for encryption#

The Item Service now supports encryption for related items in Named User Collections. A new field _encryptionEnabled has been added which determines when encryption will be applied.

This new feature offers several benefits, including:

  • Improves security as specified related items will be encrypted before being stored in the database.
  • Ideal for securely storing secrets in the database.
  • Fields which are encrypted cannot be used in searches, ensuring improved security for retrieving sensitive information.

Knowledge Graph Viewer component#

The Knowledge Graph Viewer component provides a React component to create knowledge-graph style interactive diagrams for visualizing data models used for digital twins.

The Knowledge Graph Viewer allows you to do the following:

  • Build your own customized Knowledge Graph Viewer apps to display data models for digital twins
  • Import, view and edit ontologies
  • Create and view knowledge graph queries

Improvements to IafViewer#

Several important improvements have been made to the IafViewer React component, including:

  • Model composition has been introduced which allows 2D and 3D models to be destructured and loaded as an array of linked files instead of one complete file. This optimizes load times and also offers more flexibility in deciding which parts of the model to view using the new Compose on Demand facility.
  • A new option - Focused Planes, has been added to the Cutting Planes pane to build a cutting plane around the selected model. As well as providing more efficient loading times, this feature can be used to make visible a selected element that is obscured from view by other elements in the model. This is achieved by added a transparency effect to adjoining planes.
  • The handling of element click events in the IafViewer has been improved through the introduction of enhanced React selection handling. This improved callback mechanism ensures a faster response to user interactions.

Improvements made to Account Settings#

A range of improvements have been made to the Account Settings section of the Admin page, including:

  • UI design has been updated and a new side menu has been added.
  • New pointer hovering features have been introduced. For example, hovering the pointer over invites now displays additional information about who is invited.
  • Long application descriptions are no longer truncated.

Enhancements made to resource events#

A range of enhancements have been made to system resource events, including:

  • When a resumable file is cancelled, in the events API, the event is now displayed as "UPLOAD_INITIATED" instead of "UPLOAD_INTERRUPTED".
  • When the file version is created, updated or deleted in the events API, the event is displayed as "ResourceCreated" instead of "ResourceUpdated".
  • Item Service events are generated for bulk item create, update or delete.
  • Item Service events are also generated when a collection version is created or deleted.
  • There are now create/updated/delete resource events for Item Service scripts and user configs.

Cascade delete of workspaces#

An additional feature has been added to remove stale data when a workspace is deleted. Now, whenever a workspace is deleted, after seven days, the namespaces associated with that workspace will also be marked as deleted. If no administrative intervention is used to restore the workspace, then all data associated with those namespaces in all data services (PassportService, ItemService, FileService, ObjectModelAPIService, Datasources) will be also permanently deleted.

Improved security for Trivy and Python scripts#

Several security vulnerabilites relating to Trivy and Python scripts have been addressed, including:

  • In the IAM service, Keycloak has been upgraded from 16.x to the latest version 24.x, ensuring that the latest authentication features are supported.
  • A Local File Inclusion (LFI) vulnerability which previously might occur during a model import has now been fixed.
  • Username and password support for Redis is now available for all Platform services.
  • You can now access the Account Settings page through IAM login.
  • Outdated components, connectors and targets in the DataSources Service have now been deprecated.

Enhanced white labelling#

Improvements have been made to the white labelling facility, including:

  • Enhancements to white labelling handling have been made to the DataSources Service and Script Manager.
  • White labelling changes have been made to IAF packages: iaf-object-store, iaf-kafka, iaf-script-exec, and iaf-configmgr.

Enhancements to DataSources Service#

The handling of data sources has been enhanced in the following areas:

  • You can now create an Axon query which fetches only the past month's data instead of the entire data set.
  • A new algorithm have been introduced to pick up runs in the queue.

Improved support for IPA plug-ins#

Improvements have been made to a wide range of plug-ins, including:

  • Enhanced support for Revit, ACAD, Civil3D, IFCXplorer and Navisworks plug-ins
  • Improved white labelling for platform plug-ins
  • Plug-in modules have been renamed

New Script Executor functions#

A new model import script has been introduced which now combines what previously involved five orchestrator steps into one single step. This is achieved by moving the entire model import process to the Script Executor Service where a single default_script_target is sufficient.

The Model File Reader has been added as part of the Script Executor Service. The updated import script uses the Model File Reader for operations such as the downloading, unzipping, and streaming of model files.

These improvements also involved a more secure and isolated execution of application-defined scripts within a sandbox at the back end. These changes require adjustments to the back end script implementations and existing back end scripts will require migration.

Several Iaf packages were changed, and expressions script support was removed for: data-utils, script-iaf, script-data, and script-ui packages.

Issues fixed#

For release 4.3, a range of issues have been fixed through feature testing, regression testing and backwards compatibility testing.

Platform 4.2 release notes

Platform 4.2 hot fix#

Issue: OMAPI endpoints return 500 error in all environments after 4.2 update

  • Root cause: Problem with the process overwrite script that injects into the script for execution
  • Impacts: Alwadi, Hour app, EuSandbox, EuProd, SAStaging
  • Fix: Removed overwriting process object changes from platform-v4.2

Platform 4.2#

Data sources stream importing#

You can now use stream processing to import a model in a model import script. With stream processing, the occurrence files stream in smaller chunks, one at a time. This allows for the smooth processing of large models, such as a city model.

Stream processing provides the following benefits:

  • Ability to import models of any size
  • Significant cost-cutting due to reduction of RAM resources required
    • Test example: A 2GB model which needed 12GB of RAM is now possible with 512 MB of RAM, consuming only 280MB.
  • Parallel imports
    • Test example: A parallel import of five Bimpk files totalling 2GB is now possible with 4GB of RAM

Account Settings#

The Account Settings page is a centralized location where the logged-in user can view and update the following user account details:

  • User profile information such as name, email, and user role
  • Change user password
  • Delete your account
  • Use the QR code authenticator to access apps
  • Generate a user access key
  • View your applications
  • View your application invites

The Account settings page features white labelling and is suitable for custom themes.

Script executor service#

Object Model API or orchestrator script executions are managed in the script executor service by the script manager and executed by a script worker.

Script manager#

The script manager schedules and manages script execution job requests and handles script respose data and logs from the script worker job.

Script worker#

The script worker executes scripts after it receives script execution requests from the script manager and returns script response data and logs to the script worker.

File system wrapper#

Added wrapper object to the services to handle file system operations such as read stream and write stream operations from scripts, as well as system directory operations.

IPA plugins#

Revit plugin#

Added Revit 2024 support

Civil3D plugin#

Added Civil3D 2024 support

AutoCAD plugin#

Added AutoCAD 2024 support

Platform 4.1 release notes

The platform 4.1 version release contains the following new features and updates:

IoT integration#

Set up IoT integration in order to stream data generated by IoT devices to a time series telemetry collection in the Item Service.

To enable optimum IoT integration, the following resources have been added to the Item Service:

  • Telemetry config: Use the config to define your bindings between named telemetry collections, telemetry items, and the raw IoT data.
  • Normalization script: Normalizes IoT data for consumtion as Item Service readings.
  • Telemetry worker: Handles Item Service events and provisions your Telemetry config-defined source connectors with the Kafka Connect API

Telemetry worker#

The telemetry worker manages telemetry bindings and IoT data behind the scenes.

Bindings#

The telemetry worker creates, updates, and deletes telemetry config bindings when you use the Telemetry config APIs to manage telemetry configs or telemetry collections and items with bindings.

IoT data#

The telemetry worker consumes telemetry messages and creates readings while handling errors and validating API payloads.

Telemetry config API#

You can create, update, find, and delete telemetry configs using the following JavaScript Platform APIs and REST APIs:

Platform API#

REST#

Datasource sources#

Create log files for orchestrator runs using the Get an Orchestrator Run's Logs by ID API.

Item Service permission#

Perform the following permission-based operations in the Item Service:

  • Create permissions for telemetry configs
  • Look up permissions by telemetry config IRN
  • delete permissions in passport service on telemetry config delete
  • Supports Telemetry config resource check like you can a named user item

IafViewer#

The following features have been added or updated for the IafViewer:

Panel updates#

The panel user interface for the Settings and Cutting Planes panels has been updated for an improved user experience with enhanced user interaction with tools and more screen space for model interaction.

Cutting planes picker#

Set cutting planes with a single mouse click using the cutting planes picker. Simply click the cutting planes picker icon, then click the model where you want to cut.

Pan navigation#

Users can now navigate a model using pan navigation. Pan navigation is now the default navigation mode.

Focus mode#

Focus mode automatically zooms to a selected item. Simply click the Focus mode icon, then click the item you want to focus on.

Tool tips#

Toolbar tools now feature tool tips. To view the tool tip, hover over a tool icon.

Viewer customization#

Customize and save tool bar and panel configurations for different roles or use cases. Users can switch between customized configurations for the task at hand.

Save View Orientation#

You can now save a model view orientation with the option to reset it.

Updated React component#

Use the updated feature react component commands to further configure the IafViewer user interface and user experience.

IPA Plug-in#

The following features have been added or updated for the IPA plug-in:

Plug-in unification#

  • Revit plug-ins: The Revit plug-ins have been unified to a single plug-in that supports multiple Revit versions from 2018 to 2023

  • Civil3D plug-ins: have been unified to a single plug-in that supports multiple Revit versions from 2030 to 2023

Revit plug-in#

Room transparency export option#

There is now an option to export RoomTransparency.

Export model without 3D view#

You can now export a model without having to open it in 3D view. This makes it quicker to export large models.

4.1.1 patch#

Platform plugins#

The Plugin download page is now available as a standalone page.

Extensive whitelabelling has been carried out for the following plugin elements:

  • Desktop launch icon and icon name
  • Plugin window name
  • Plugin Sign In page logo
  • Plugin Sign In page policy text
  • Plugin Sign In page plugin name
  • Plugin download names

Item Service#

Telemetry Config#

A new first class resource, TelemetryConfig, has been implemented in Item Service. The TelemetryConfig class defines the bindings between NamedTelemetryCollections, Telemetry Items and IoT data. The Item Service supports one Telemetry Config per namespace.

The following asynchronous CRUD API methods have been created for the TelemetryConfig class:

  • Create Telemetry Config
  • Delete Telemetry Config
  • Update Telemetry Config
Telemetry Worker#

The Telemetry Worker handles Item Service events in the followings ways:

  • Provisions source connectors using the Kafka Connect API based on the connector types defined in the Telemetry Config
  • Uses “_bindings” property from the Telemetry Config to query the NamedTelemetryCollections and Telemetry Items that match the criteria
  • Creates a MongoDB collection of telemetry bindings for each namespace and stores and caches bindings for each source id

Based on Telemetry Config events, the Telemetry Worker handles the following:

Telemetry Config events#

On Telemetry Config update

  • Creates telemetry_bindings defined in the updated Telemetry Config with versioning
  • Populates the cache
  • Removes the previous version's telemetry bindings
  • Removes the previous version's cache entry
  • Updates the new version in the Telemetry Config

On Telemetry Config delete

  • Deletes all the bindings in respective telemetry_bindings
  • Removes the cache entry with the prefix namespace
  • Removes the source connector for the namespace
Telemetry Item events#

On Telemetry Item create

  • Creates a binding in telemetry_bindings and creates a cache if the telemetry item or items match the query in telemetry config bindings

On Telemetry Item update

  • Identifies the bindings and telemetry items that relate to the previous source id
  • Creates new bindings for only those telemetry items and removes old ones
  • Creates cache for new source ids and removes previous source ids

On Telemetry Item delete

  • Deletes the bindings in telemetry_bindings and removes the cache keys if the telemetry item or items match the query in telemetry config bindings
Telemetry Collection events#

On Telemetry Collection Delete

  • Identifies the keys to remove using telemetry_bindings collection if the Telemetry Collection matches with the query in the telemetry config bindings
  • Removes bindings from cache
  • Remove bindings from telemetry_bindings collection

On Telemetry Collection Version Delete

  • Identifies the keys to remove using telemetry_bindings collection if the deleted Telemetry Collection version matches with the query in the telemetry config bindings
  • Remove bindings from cache
  • Remove bindings from telemetry_bindings collection
Script change events#
  • Create an asynchronous task to update the cache if the changed script is referrenced in the Telemetry Config

Passport Service#

Permission Profile support for Telemetry Configs#
  • Permission Profile APIs support CREATE, READ, EDIT, DELETE, SHARE actions on Telemetry Configs in the same manner as any NamedUserItem class
  • Get permissions support by telemetry config irn, for example itemsvc:telemetryconfig:<id> or itemsvc:telemetryconfig:*
  • When you create a Permission with a telemetry config id in the irn, the existence of the resource is verified
  • Support to check if resource exists when a permission profile refers to a Telemetry Config
  • Supports delete permissions to remove permissions in the Passport Service when a TelemetryConfig is deleted

Revit IPA Plugin#

3D verification#

The plugin now checks if the active view is 3D view and suitable for 3D export. In this case, it will export as 3D and if not, a dialog appears and requests the user select a 3D view for export.