The following installation and configuration changes have been made for the Intergraph Smart 3D Plant and Admin Web APIs.
Version 14 Update 2 (available February 2025)
-
Web servers no longer require .NET 6.0 Desktop Runtime.
Version 14 Update 1 (available November 2024)
There are no additional changes in Update 1.
Version 14 (available September 2024)
Terminology
-
The Smart 3D Web API has been renamed to Smart 3D Plant API.
-
In the Configuration Utility, the process of configuring Smart 3D sites and plants for use with the API is now referred to as configuring Smart 3D Data instead of Smart 3D Web Services. The related Welcome page option and configuration page have been renamed accordingly.
Hardware and software recommendations
Many of the requirements and recommendations have changed. Please review the Hardware and Software Recommendations section closely.
Environment
For help understanding the environment, please see Environment Overview and Considerations.
-
The two APIs share the same configuration for:
-
Configuration database connection, setup credentials, and configuration credentials - Both APIs use the same configuration database and connect to that database with the same credentials.
-
Cache location and connection - Both APIs use the same caching mechanism, either Redis or local process memory.
-
Messaging connection and credentials - Both APIs use the same RabbitMQ server and connect to it with the same credentials.
-
Enabled Smart 3D sites and plants - When a Smart 3D site or plant is enabled, it is enabled for both APIs.
-
-
Load balancing has been improved:
-
The APIs now share some service instances.
-
New types of services are used to distribute the workload.
-
You can now configure multiple instances of the Plant service on multiple machines.
-
-
Logging has been improved - We have implemented Application Insights.
-
Rate limiting has been added - You can manage rate limiting for each API. To do so, use the MaximumRequest and MaximumActionRequests settings in the application settings file for the respective API.
-
Health diagnostics have been changed:
-
The diagnostic endpoints are no longer unsecured. You must now have an access token to call the resources.
-
The following /diagnostic endpoints have been removed: echo, upload, and download.
-
The /diagnostic/status endpoint has been renamed to /health.
-
Configuration workflow
The configuration workflow has been significantly changed to:
-
Make configuration easier
-
Better reflect the shared configuration for the two APIs
-
Better reflect load balancing and logging improvements
-
Simplify configuration of the authorization provider
The specific changes include:
-
A single Configuration Utility is now used to configure both APIs.
-
After you configure the web server and authorization server for the first API, the same values will appear by default when you begin configuring second API. You can change the defaults.
-
You can change the Base URL for each web server (Plant and Admin).
-
You can configure app settings using new pages in the Configuration Utility instead of config files. This includes settings such as CORS, server timeout, cache timeout, page size, maximum page size, and long operation server timeout for the Admin API.
-
Instead of configuring the application insights logging level and instrumentation key, the Configuration Utility now takes the Application Insights connection string.
If you need to configure the logging level, you can still do so in the NLog configuration
file application insights target.
-
If you are using Smart API Manager for authorization, you must now manually register the API with Smart API Manager.
-
When you reconfigure an existing site, the Configuration Utility prompts you to restart the website after completing the changes.
Documentation
-
This guide has been significantly reorganized to reflect the streamlined configuration and to clarify the requirements and recommendations for different parts of the environment.