You are viewing the documentation for Blueriq 16. Documentation for other versions is available in our documentation directory.
Before you upgrade make sure to read the General Upgrade instructions as well as the Upgrade instructions for previous versions.
The changes are color coded. Orange elements have been changed, Green elements have been added and Red elements have been removed compared to the 16.x release.
Table of contents
AQ_File_Upload
The implementation of the AQ_File_Upload has changed in several ways.
Container Type
The container type has been updated.
- The FileExtension parameter is updated be an expression parameter
- The MaxFileSize parameter is updated be an expression parameter
- The Mode parameter is changed into the MaxFileAmount expression parameter
- The 'Single file' mode is migrated to an expression with the value '1', the 'Multiple files' is migrated to an expression with the value '-1'. This is done to have the same effect as the old implementation, however it is strongly advised to change the former multi file upload into a stricter value. This should be done to mitigate possible DOS attacks.
When loading your model in a Studio Server from 16.1 the parameters will be migrated automatically. This does require you to update to the latest BlueriqBasicModelling Library version.
Runtime configuration
The blueriq.fileupload.maxuploadsize
now contains a sensible default of 10MB. Formerly this was to be set to '-1', which was infinite, meaning that you could upload files of an unlimited size. To prevent a DOS attack we have now set it to 10MB, it is advised to adjust the setting to the maximum you require for your solution.
Enforcing the max-upload-size
We now override the MaxFileSize parameter of the AQ_File_Upload container if it is either not set, or if it exceeds the blueriq.fileupload.maxuploadsize
property. Setting the blueriq.fileupload.maxuploadsize
back to '-1' will result in the behaviour prior to 16.1.
Enforcing max amount of files
A maximum amount of files is enforced by the Material theme and Runtime when configured. This will result into error message if the amount of files that are uploaded exceeds the allowed files.
Messages
Two new multiple lingual message properties have been added:
Property | Default |
---|---|
fileupload.validation.fileamount | The maximum amount of files is exceeded |
fileupload.description.fileamount | Allowed amount of files: {0} |
Frontend Theme changes
A few changes have been made to the @blueriq/angular library and the Material Theme to support these new functionalities, the changes in the Runtime are made backwards compatible to ensure an easy upgrade.
@blueriq/angular 0.17.1
In @blueriq/angular 0.17.1 library we have added a maxFileAmount
property to the FileUpload
class to support frontend validation on how many files there may be uploaded to the Runtime. Just as other properties of this class, a maxFileAmountDescription
and maxFileAmountValidationMessage
have been added as well. See the FileUpload page from more information about these properties.
Material Theme
Required container
To use the functionality of required file upload containers, we have added a new Field
as child of the FileUpload
container. This field will contain the required validation message after the container has been validated. An example of how to execute these changes can be found in the following links.
Maximum amount of files
To support frontend validations for a maximum amount of files, you will need to update the @blueriq
libraries to version 0.17.1. This version contains additional properties on the FileUpload
class to show validation messages, descriptions and contains the maxFileAmount
property.
Furthermore the CustomFileUploader
class has been changed to support validations on maximum amount of files. This required some additional changes in the FileUploadComponent
to display the validation messages. An example of how to execute these changes can be found in the following links.
JWT Mapping properties
Both the OpenID Connect Properties and the Oauth JWT Authentication Provider contain properties for JWT claims mapping. These properties were prefixed with openid-connect, which does not make sense for the JWT Authentication provider. Therefore, we renamed the prefix of these properties to blueriq.security.jwt-claims
. If you have configuration for the OpenID Connect Properties or the Oauth JWT Authentication Provider, please update the prefix of the properties as specified in JWT Mapping properties.
Studio configuration
When upgrading from a Blueriq 16.0 installation, the configuration file of the Studio Server needs to be updated as otherwise the Studio Server fails to start. Open the [BlueriqInstallationDirectory]\Studio\Services\StudioService.exe.config file using Administrator permissions and locate the <oidc>
element within the <security>
element. Remove the enabled=""true"
(or possibly enabled="false"
, in which case the user role mapping needs to be reconfigured using Keycloak groups) attribute from this element and save the file. You can then proceed with starting the Studio Service.
Known issues
For an overview of known issue please refer to: Known issues.