Skip to content

v8_to_v10.md

Latest commit

 

History

History
79 lines (50 loc) · 5.34 KB

v8_to_v10.md

File metadata and controls

79 lines (50 loc) · 5.34 KB

MORYX 8.x to 10.x

Replaced result of visual instructions with dedicated result object

In Moryx.Factory 6.3 and 8.1 we introduced the new result object and optional extended APIs. The result object solved issues caused by localization of the different results. With Moryx 10 we remove all old APIs based on strings.

Replaced IVisualInstructions with VisualInstructionParameters

The interface was only used in VisualInstructionParameters which can and is being used as a base class in most cases anyway. Hence, IVisualInstructions is removed in favor of a more extendable base class.

Integration of Moryx.Simulation into Moryx.ControlSystem

To reduce the number of API packages and simplify the overall architecture, Moryx.Simulation has been integrated into Moryx.ControlSystem starting with Moryx 10. All simulation-related APIs and functionality are now part of the Moryx.ControlSystem package. This change streamlines dependency management and makes it easier to maintain and extend simulation features within the control system context.

The simulator module has also been renamed, and its namespace and package id have changed accordingly to reflect its new location within Moryx.ControlSystem.

Renamings and Typo-Fixes

  • TcpClientConfig.IpAdress -> TcpClientConfig.IpAddress
  • TcpListenerConfig.IpAdress -> TcpListenerConfig.IpAddress
  • ResourceRelationType.CurrentExchangablePart -> ResourceRelationType.CurrentExchangeablePart
  • ResourceRelationType.PossibleExchangablePart -> ResourceRelationType.PossibleExchangeablePart
  • MqttDriver.BrokerURL -> MqttDriver.BrokerUrl

Reduction of interfaces

Several interfaces have been removed to streamline the codebase and reduce complexity. The following interfaces are no longer available:

  • IProductType: Replaced with base-class ProductType
  • IProductInstance: Replaced with base-class ProductInstance

Data Model Changes

With MORYX 10, several changes have been made to the data model to improve performance and maintainability. Notable changes include:

  • Naming conventions across the data model have been standardized to ensure consistency and clarity. We use pluralised names for DbSet properties and singular names for entity classes. Sample: public DbSet<ProductEntity> Products { get; set; } instead of public DbSet<ProductEntity> ProductEntities { get; set; }.
  • Derived data models are now fully supported. This needs some changes how the model is defined in code first scenarios. Please refer to the Data Model Tutorial for more information.
  • Removed support of Dump and Restore operations in the data model. These operations were rarely used and added unnecessary complexity to the data model management. Use your database admin tools to perform backup and restore operations instead.

Removal of ProductFile

  • The ProductFileEntity has been removed from the data model as it was not utilized effectively. This change helps streamline the data structure and reduce unnecessary complexity.
  • If you were using ProductFileEntity, consider using alternative storage solutions such as file systems or dedicated file storage services to manage product-related files.
  • The ProductFile was removed completely.

Launcher

  • The SortIndex configuration was moved to the Moryx.Launcher.LauncherConfig.json configuration file. Refer to the Launcher documentation for more information.

Removal of Modules-Analytics

The analytics module was doing nothing and the web module was replaced by supporting external modules in Launcher. Its now supported to embed external web-pages into the shell. Refer to the Launcher documentation for more information.

Rarely used features removed

These feature were infrequently used and has been removed to simplify the codebase.

  • ExceptionPrinter: Used to print exceptions to different outputs. Use Exception.ToString() instead.
  • CrashHandler: Used to handle application crashes. This feature was used were the runtime was a console application.
  • Caller: Used to get information about the calling method. Use System.Diagnostics.StackTrace instead.
  • Moryx.Endpoints: This namespace contained all base classes for the time when an endpoint was hosted inside a module. Since we use controllers it is deprecated.
  • Moryx.Identity: This namespace contained base classes and services for the old WPF client to provide the authorization context. Since MORYX support web uis, this is deprecated
  • PortConfig: Used for old wcf services. Deprecated since ASP.NET Core.
  • ProxyConfig.Port: Use the full address instead. It contains also http/https, domain and port

Moved classes and namespaces

  • Moryx.Tools.FunctionResult: Moved to Moryx.Tools
  • Moryx.AbstractionLayer namespace: All classes have been moved to more specific domain namespaces e.g. Moryx.AbstractionLayer.Resources, Moryx.AbstractionLayer.Products, Moryx.AbstractionLayer.Processes etc.

Reworked driver APIs

All driver APIs have been reworked to use TPL async/await instead of callbacks for the following reasons:

  • The same logic looks almost synchronous.
  • Cleaner and integrates seamlessly with .NET’s exception system.
  • You can chain tasks with LINQ-like methods or await syntax.
  • Async stack-traces in IDE show the actual logical call flow — even across await boundaries.