8.x Breaking Changes
  • 08 Apr 2024
  • 8 Minutes to read
  • Dark
    Light

8.x Breaking Changes

  • Dark
    Light

Article Summary


Overview

As Decisions evolves, minor version releases bring exciting updates, enhancements, and bug fixes that developers eagerly anticipate. However, alongside these advancements, the potential for breaking changes exists – alterations to the platform that may disrupt existing functionalities and lead to compatibility issues. This article provides a detailed description of breaking changes introduced in minor releases. We aim to equip developers with insights to effectively manage and adapt their projects to these updates.

Please contact support at support@decisions.com with any questions or concerns about the following breaking changes.


8.18.x

Breaking ChangeDescription
PGP ModuleUsers with the PGP module who have a Flow with the Sign File, Clear Sign File, or SignAndEncryptFile steps should drag and drop these steps again after upgrading.
[DT-039588] Chart Settings > Default Colors are not being respected on Report Charts
Changes to the way colors appear on charts were made. Please review your charts to make sure they display correctly.
[DT-039515] Form: Form components aren't displaying the translated date time.
Customers with date/time translation on may see dates not translating correctly upon upgrade.

8.17.x

Breaking ChangeDescription
Account, Group, and Document StepsChanges were made to steps involving accounts, groups, and documents. Upon upgrade, these steps may need to be modified.
Folder and Document PermissionsPermissions may need to be checked and potentially updated upon upgrade. Users with 'Can Add' permission on the folder can successfully upload documents within that folder.
[DT-037050] Remove DefaultAccountEmailAddress from Settings.xmlAdmin@decisions.com was the default email address for setting up the accounts in prior versions. In 8.17, this has been removed and must be specified by the user on installation. This also applies to Containers - two variables need to be specified.

8.16.x

Breaking ChangeDescription
Account and Group StepsChanges were made to steps involving accounts and groups. Upon upgrade, these steps may no longer work. Flows that use those steps may not work for anyone who does not have Administrator or System level permissions.

8.15.x

Breaking ChangeDescription
[DT-031045] Input label for the AD step "List Users in OU" needs to be more specific/changedPreviously, In the "ListUsersInOrganization Unit" AD Module step, we were passing the whole URL in the OU input; now, you only need to pass the OU name. Existing flows will break if they are passing the whole URL.
[DT-038752] "Add Account to Groups" Step: Account ID input works if you are not using "Account ID"The Add Account To Groups step would take in non-AccountId values. The step has been changed to throw an exception.
[DT-038761] Github Modules - Required 8.15 - Update Module.Build.xml to Module.Build.jsonModule settings files have changed from XML to JSON. This impacts all modules. Any users with custom modules will need to rebuild them, or the modules will not function.
[DT-038556] Fix Sequence Generation Code/[DT-038494] Duplicate Sequence Creation for Case Folder Naming PostgresIf the output of step GetNextNumber was modified to anything other than the default name (GetNextNumber1_Output) upon upgrading the name will revert to GetNextNumber1_Output and this will break any Flow looking for that output.
[DT-033112] DB Connection StringOutput data options on DatabaseData steps have been removed. Existing value mappings may break.
Decisions Server using MySQL might break on upgrading to v8.15
In MySQL connector versions 8.0.32 and lower, there was a dependency on the Google.Protobuf.dll. However, starting from Decisions version 8.15, it is included in the platform by default. Attempting to upgrade to version 8.15 or higher while using older MySQL connector versions can result in a failed upgrade.

To ensure a smooth upgrade to version 8.15 or later, it is recommended to delete the Google.Protobuf.dll file from the C:\Program Files\Decisions\Decisions Server\Instances\Control\CustomReferences folder before initiating the upgrade process.

8.14.x

Breaking ChangeDescription
[DT-030733] FHIR Module: Add FHIR R4 Cannot have R3 and R4 FHIRA new FHIR integration module has been introduced to support FHIR R4. It is important to know that environments can now exclusively utilize the R3 or R4 modules.
[DT-038230] Kill List: Entity Actions to Create Text Merge EntityRemoving the Text Merge Entity from the product. This is not the text merge created within steps; it is a reusable text merge created in a designer folder. If you are using text merge entities, it will continue to work as expected, but you will no longer be able to create new ones. 
[DT-038273] Remove Script Form Step From ProductThe step "Script Form" Form has been removed from the Decisions Toolbox. If you are using this step, it will continue to work as expected, but we will not be supporting this in the future.

8.13.x

Breaking ChangeDescription
[DT-037857] RuleSet Unit Test Rule Errors Out After Originating Flow is Deleted

Unit Tests within Rule Sets for Flows/Rules have been refactored:

  • Unit Tests created for Rules and Flows will only apply to the Individual Rules/Flow. They will no longer be shared across all the rules and flows in the folder.
  • Unit Tests that are declared for the entire ruleset will continue to function as they currently do.
The updated functionality may cause issues for some of the existing customers. We will include an action on the Unit Test to allow users to change the associated Rule/Flow. Unit tests are now only created for a single entity at a time.
[DT-038111] Page header containers cannot be loaded initially collapsedIn previous versions, when the header container was configured with "Initially Visible" set to False and "Is Collapsible" set to True, the control loaded in a collapsed state (the body of the container was collapsed while the control was still accessible). However, in the current update, marking the control as hidden will result in its complete invisibility. The ability to load the control body in a collapsed state has also been removed. This change might impact cases where customers were using this behavior unintentionally.
OPEN AI Beta Changes
For those who have utilized the beta version of OpenAI module steps within a Flow, replacing them with the updated module steps is important, as the beta steps could potentially encounter compatibility issues. An indicator of a step no longer functioning is the appearance of a light blue box in place of the original step image.
Get Started Server Instance step breaks on upgrade from 5xStarting from version 8.13, the 'Get Started Server Instance' step is no longer supported. As a result, upgrading from version 5x to version 8.13 may cause the 'OnUserAssignedToInstanceFlow' to break. It's important to note that this Flow/functionality has already been removed in the latest versions.

8.12.x

Breaking ChangeDescription
Known Issues with InstallationKnown Issue with installation when using Azure SQL Servers Authenticated using Azure Service Principles
SQL Server Version UpgradeDecisions v8.12 and above require SQL Server 2016 or newer. For more information, refer to Installation Requirement.
[DT-038003] Sequence IDs are Resetting on Upgrade to 8xIf the Flow Prefix contains special characters such as #QAtest or @NewTest, customers upgrading from version 6.14 and above to the latest 8x version will be required to regenerate their sequence number, as the Flow will display a warning. The affected characters include:
[ ] { } @ . / \ " ' + ; : < > ? # ! $ % ^ & * ( ) ~ `
[DT-037231] Encryption Warning in LogsChanged encryption to use only AES. This will affect RepoSSO; the Repository Server and Decisions Server should both be on the same version.

8.11.x

Breaking ChangeDescription
[DT-037674] Service with space in the Name gives an error while making Rest CallSpaces were removed from the service names; this will break any service calls to the following services used before upgrading to this version. Business Metric Service, Common Designer Service, Data Definitions Edit Service, Data Designer Service, Flow Edit Service, Form Edit Service, Inputs Service, Matrix Rule Edit Service, Module Resources, TruthtableEdit Service
[DT-029835] Add Ability to Interact With Flow Inputs and Outputs in BPMN FlowsBPMN Flows now have the ability to output data. This is to make them more functional with default Flow Behaviors and interact with their data. The Task, Start Event, and Multiple End Event steps were removed from the Platform during this implementation. If any of these steps were used in previously built BPMN Flows, the Flows will need to be updated upon upgrading.
[DT-037514] SonarQube: Path Traversal Injection Issues

This setting has been included to allow customers to specify File Paths to which the Decisions Server can write files. The primary purpose of adding this setting is to prevent File Path Traversal (OSWAP vulnerability).

To fix this issue, please add the following setting to your Settings.xml file: AllowedFileAccessPaths

This Setting should be used if the Customer is getting an error "{FilePath} is outside the allowed directory paths"

Default Value: Empty


8.10.x

Breaking ChangeDescription
[DT-037052] Use ULIDs instead of GUIDs to generate Unique IDsNewly created entities will be assigned a ULID format instead of GUID for their IDs. This change may cause interruptions to any integrations with Decisions that rely on the GUID format.

8.9.x

Breaking ChangeDescription
For upgrades to 8.9 and newer

Download and install the latest versions of the following from the .NET Microsoft site:

  • ASP.NET Core Runtime 7.x.x (x64).
  • .NET Desktop Runtime 7.x.x
  • ASP.NET Core Runtime 7.x.x (Hosting Bundle).
Download and install the latest MySQL connector version 8.0.33; the recommended .dll file to be used for the MySQL connector is from .NET 7.0. For more information, refer to Connect to MySQL.
[DT-037155] Split PDF into Single Pages not working properly

The Split PDF into Single Pages step will need to be replaced and remapped upon upgrade if used in versions 8.5-8.8.1.


8.8.x

Breaking ChangeDescriptionScreenshot
[DT-036459] File Upload Button cannot be cleared by Active Form Flow

In previous versions, the Multi File Upload and Multi File Upload Area Form Controls could be set from Active Form Flow or Data Flow if the Specify Inputs property was false. This has been fixed but will break for customers who set the values in these controls, and the Specify Inputs property is false.

The change affects Simple Forms and Normal Forms.


8.5.x

Breaking ChangeDescription
[DT-035693] Less files structure refactoring

As part of the change included for the DT, the storage location for LESS files will be moved. This will cause custom LESS files to be lost upon upgrading. It is recommended that users create a backup of any custom LESS files that were created.


Changes that were made using the Theme Editor will persist upon upgrading.


8.0.

Breaking ChangeDescription
[DT-036590] HTML-To-PDF step formatting issue V8

In Version 8, the HTML to PDF library does not support CSS 3 Styles. Therefore, if any customers are using the HTML to PDF step, it may result in the PDF not being generated as expected. 


To avoid this, customers must update the styles within the HTML by replacing the CSS 3 styles with compatible ones.



Was this article helpful?