Page History
When an aggregate is updated, it is marked as changed for the search functionality, and is indexed at the next synchronization moment (How to configure full-text index synchronization). There exist two scenarios in which you want to start the indexing manually, without updating the stored aggregate itselffor all existing aggregates.
- You are upgrading to version 9.7 or higher and want to benefit from the full text search. The aggregates that you already have stored in database must be indexed.
- All your aggregates already are indexed and a new version of the model is published to production wit new business logic, you want to re-index all aggregates so that derived values that are changed with the new logic can be found during the search.
...
In the next section the steps that are needed to use the migration service are described. These steps can be skipped if you are not interested in the scenario in which this service is useful, and you can use the AQ_Aggregate_Update instead. The last section of this article describes how to model the flow which you need to model for indexing aggregates.
Step-by-step guide to add the migration service
UI Text Box | ||
---|---|---|
| ||
This service is not a standard service, and it is not part of the AquimaLibrary. You have to ask for the code at support@blueriq.com and add the definition to the globals manually. |
- In Studio add a custom service named
AQ_Aggregate_Index_Migrate
- The service definition looks like this:
- The aggregateId is always required.
The aggregate version is optional. In case this is not specified, the latest version of an aggregate will be indexed.
We need a service that is able to update an aggregate. This service has the following parameters:
Parameter Direction Value Data Type Description Fill AggregateType Input Module Element Aggregate Select the aggregate that you want to update. Required AggregateID Input Expression Integer Please provide the attribute containing the ID of the aggregate entry to index. Required AggregateVersion Input Expression Integer If a specific version of the aggregate needs to be updated. If not provided then the latest one is updated. Optional StoreInstances Input Expression Entity Specify the starting point instance(s) used for storage. Optional Event Name Event Type Description AppException Cancel The service takes this exit if indexing failed for some reason.
Step-by-step guide to model the migration flow
- A project that wants to index the aggregates has to create an exposed migration flow.
- This flow should be called for every aggregate Id in the database. It can be passed as a parameter in the URL, and retrieved from there with the BB_SetRequestParameters service.
- In this flow you then call the AQ_Aggregate_Read to load the existing aggregate into the profile. It might be needed to also load referenced aggregates in order to obtain a complete profile.
- The next step is to use the
AQ_Aggregate_Index_Migrate
or AQ_Aggregate_Update service to update the aggregate index.
...