Ometa Framework Release v6.0.0
Below you can find important information regarding the 6.0.0 release of the Ometa Framework. As this is a major version, breaking changes might be applicable.
⚠️ Breaking Changes
⚠️ SQL Server 2012 - 2014
SQL Server versions 2012 and 2014 are no longer supported. Using these versions may lead to potential issues and breakages. We strongly recommend upgrading to SQL Server 2016 or a newer version to ensure continued compatibility and receive the latest updates and security patches.
⚠️ Windows Server 2012
Windows Server 2012 is no longer officially supported. As a result, Ometa cannot guarantee the proper functioning of the software on this platform. To ensure a stable and supported environment, we advise upgrading to Windows Server 2016 or a newer version.
⚠️ SharePoint Server 2013 - 2016
SharePoint Server 2013 and 2016 are no longer supported. Consequently, SharePoint solution packages (wsp) will no longer be delivered or maintained. To take advantage of the latest features, security enhancements, and ongoing support, we recommend upgrading to SharePoint Server 2019 or a newer version. Alternatively, consider transitioning to SharePoint Online for a more modern and cloud-based collaboration experience.
⚠️ Azure Key Vault Authentication
Authentication using Azure Key Vaults will be removed in v6. We recommend using certificate authentication instead. See this article for a guide on configuring authentication using certificates throughout the framework.
Services
BAM Windows Service
In previous releases the BAM Windows service had some database maintenance features built in. Those features are removed because they only applied to the BAM database, and they have been replaced by a full chapter about database and performance maintenance: SQL Server Performance which applies to all databases.
Any maintenance configuration left in the appsettings.json file will have no breaking effect. It will simply be ignored by the BAM service.
CSL
In version 6.0.0 some CSL functionality will be changed.
Preserved Function Names
Some function names are preserved by Ometa to ensure correct behavior on these functions. In versions before 6.0.0 there could be a ambiguous call to one of those preserved names (e.g. 'Edit'). This name could be used to target the preserved function or the user created one. To ensure that targeting the right function, Ometa updated the preserved function names with '$$obiz'. This way a user can target the correct function.
| Preserved name | Target |
|---|---|
| $$obiz-New | Creation view |
| $$obiz-Edit | Update view |
| $$obiz-Update | Update view |
| $$obiz-InlineEdit | Inline edit function |
| $$obiz-Details | Single Record view |
| $$obiz-Refresh | Refresh function |
| $$obiz-Export | Export function |
| $$obiz-ContextSetter | Context Setter function |
| $$obiz-AuditTrailDetails | Audit Trail view |
Deprecations
Case Property Context
Context With 'caseproperty.' prefix
To prevent conflicts with case properties and other context fields, the case property fields starting with the prefix 'caseproperty.' are deprecated. You'll have to use the prefix 'case.properties.' or 'originatingcase.properties.' to target (originating) case properties. Starting from v7.0.0, the fields starting with the prefix 'caseproperty.' will no longer be added to the context of a method.
Caseid Context Field
The context field named 'Caseid' is deprecated. Starting from v7.0.0, this field will no longer be automatically added to the context of a method.