What’s New?
These release notes outline what has changed in the latest release on 22 April 2021.
Enhancements
- Service Identifier For Customer
- Enhancements to Rest API Support
- Change to the storage of Share Classes
- Chrome 90 release. Migration from Chrome 89.
1. Service Identifier For Customer
What Changed?
A new field stored against the serviceTransaction called "Business Service Identifier" intended as a reference number for communication between the client and business regarding an application. This may be used in a resubmission of applications via API or when a customer calls a call center regarding an application. A default identifier will be generated for each service but the project is free to change this identifier as they require.
This field is also included in web service responses as the txnReference field.
Why?
To separate internal service identifier from the identifier communicated to clients.
Associated upgrade changes required
New businessServiceIdentifier needs to be populated for any inflight transactions. See script ‘add-business-service-identifier.js’
Any API response tests will need to be updated to expect the new field.
2. Enhancements to Rest API Support
What’s Changed?
REST API support is being enhanced to add new marshallers, schema validation has been enabled on incoming requests and outgoing responses. Some components have had updates to improve the data included in the request or response.
- The new retainOnRevalidate flag on the ErrorCode allows the addition of validation errors during marshalling to the view tree that will not be cleared by a standard validate on submit. This is as some errors may require the initial payload for validation.
- Fix to Selector marshaller as the response was not validating against the schema.
- Addition of a new marshaller to the pattern where a box contains a group selector with selection groups. This will now be treated as a discriminated object type allowing the schema to specify with greater detail which children are expected based on using the group selector as a discriminant.
- Email component is REST aware and will exclude the ‘_ConfirmEmail’
- AddressSelection and PersonSelection components updated to allow reuse of Persons and Addresses via API. This should be considered ALPHA in this release.
Why?
Ongoing improvements to OpenAPI support.
Associated upgrade changes required
OpenAPI specs will be automatically updated. This may mean that sample requests and responses need to be updated.
3. Change to Storage of Standard Share Classes
What’s Changed?
The standard share classes are no longer stored as domains in the domain tree. Only custom share classes live in the domain tree. The AllocationSummary domain in the domain tree no longer holds the CustomYn attribute to indicate if it’s a summary about a custom share class.
Details of the changes
Before:
The components went through the configured share classes data constraint and added them into the share class repository. If the user added any custom share classes, they were also added to the same repository. The Share Class drop-down was backed by this repeater.
Each allocation record had a child reference to the share class domain from the share classes repository.
AllocationSummary record stored whether it’s representing a custom share class.
After:
The component carves a dynamic data constraint which is comprised of the values from the configured share classes data constraint(to start with). The custom share classes are still added to the share classes repository. This data constraint is kept in sync as and when any custom share classes are added by the user.
No child reference is maintained, and AllocationSummary does not store if it references a Custom share class or a standard one.
An event "share-class-repository-updated" is fired when there is any change to the repository
Why?
The standard share classes are configurable and are the same for all entities, hence they need not be stored against each entity.
Associated upgrade changes required
The Shareholding and ShareholderAllocation components have changed to accommodate not storing the standard share classes in the domain tree. If there has been any customisation to these components around actions taken when the repository has been populated, they would need to be revisited/retested.
A data fix has been provided to fix up existing data. See script ‘RemoveStandardShareClasses.js’. The script does the following for non-ghost service transactions –
- Removes standard share classes from the domain tree.
- Removes child references from the ShareAllocation domain
- Removes CustomYn attribute on the AllocationSummary domain.
4. Chrome 90 release. Migration from Chrome 89.
What’s Changed?
Migrated Chrome from version 89 to version 90.
Why?
To ensure Chrome is fully upgraded.
Associated upgrade changes required
User will need to update their browsers to keep running tests in chrome.
Fixes
- TFS 2429755 – VERNE: Attributes set on activate are not returned in POST response when devMode is off.
