You are viewing the documentation for Blueriq 13. Documentation for other versions is available in our documentation directory.

With the removal of several deprecations in Blueriq 13, some modeling features are no longer available. We cannot automatically migrate all deprecated features from within Studio itself, so a separate tool is made available that aids in automatically migrating your project. This tool must be run on the latest Blueriq 12 Studio version, so you have a chance to verify the automatic migration.

The tool is distributed as standalone jar which should be run from the command line:

java -jar studio-migration-tool-1.1.2.jar > migration.log

Java Version

Java 11 is required to run this tool

Configuration

Configuration properties may be specified in an application.yml file in the same directory as the blueriq-studio-migration.jar. That file is used by default when running the tool.

Studio Connection

The tool uses the Management Service of Blueriq Studio so you should configure a Studio connection with authentication details:

application.yml
migration:
  studio:
    url: http://localhost:93/Studio/Server/Services/ManagementService
    auth-type: basic | ntlm | kerberos
    username: admin
    password: welcome
    domain: (only used with ntlm authentication)

Studio Version

At least Studio version 12.12.3/12.13 is required. Upon running the tool it will check the Studio version to verify it is compatible.

Migration scope

You may specify for which repository/branch/project the migrations should be run. It is allowed to omit the list of projects, branches and even repositories in which case the tool iterates over all projects/branches/repositories. A complete example is provided:

application.yml
migration:
  repositories:
  - name: Repo
    branches:
    - name: Trunk
      projects:
      - Project1
      - Project2

Migrating Formats to Presentation Styles

This migration creates presentation styles for all used formats on the AQ_CaseList, AQ_WorkList, AQ_InstanceLinker containers and replaces all usages of formats with usages of presentation styles instead.

Target Project

All presentation styles are created in a dedicated project which is intended to be distributed as library. The details of this project should be configured as follows:

application.yml
migration:
  r13:
    formats:
      target-project:
        repository: Library
        branch: Trunk
        project: Styles

If you leave out the properties above, the migration for formats will be skipped.

The migration tool does not automatically ensure that each project has a library include of this target-project, so you may see validation errors for missing presentation styles. If this is the case, ensure that the target-project is configured as library include such that its presentation styles are available.

Format splitting behavior

By default, each format is considered as a single presentation style. If you have used a convention of using spaces, commas or other characters as a delimiter for multiple styles, the migration tool can be configured with such delimiters:

application.yml
migration:
  r13:
    formats:
      delimiters:
        - ","

Using the above configuration, each format is first split by a comma to obtain the individual presentation styles that will be created.

Example application.yml

Above, only snippets of the application.yml are shown. A complete application.yml file may look like this:

application.yml
migration:
  studio:
    url: http://localhost:93/Studio/Server/Services/ManagementService
    auth-type: basic 
    username: admin
    password: welcome
  r13:
    formats:
      target-project:
        repository: Kinderbijslag
        branch: trunk
        project: Kinderbijslag

An example of the log file of a successful run:

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::       (v2.2.10.RELEASE)

2021-09-15 15:49:02.527  INFO 30032 --- [           main] c.blueriq.studio.migration.Application   : Starting Application on LAP-3029 with PID 30032 (C:\studio-migration-tool-1.1.2.jar started by t.daatselaar in C:\)
2021-09-15 15:49:02.530  INFO 30032 --- [           main] c.blueriq.studio.migration.Application   : No active profile set, falling back to default profiles: default
2021-09-15 15:49:05.867  INFO 30032 --- [           main] o.s.ws.soap.saaj.SaajSoapMessageFactory  : Creating SAAJ 1.3 MessageFactory with SOAP 1.1 Protocol
2021-09-15 15:49:06.636  INFO 30032 --- [           main] c.b.s.m.datasources.StudioVersion        : Running against Studio version 12.13.29.3705
2021-09-15 15:49:06.642  INFO 30032 --- [           main] c.blueriq.studio.migration.Application   : Started Application in 5.023 seconds (JVM running for 5.816)
2021-09-15 15:49:06.644  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Running migration 'formats to presentation styles'
2021-09-15 15:49:06.669  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Repository Kinderbijslag (1 of 1 repositories)
2021-09-15 15:49:06.684  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Branch Kinderbijslag/Trunk (1 of 1 branches)
2021-09-15 15:49:06.710  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/Kinderbijslag (1 of 8 projects)
2021-09-15 15:49:06.755  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : Processing module: Interaction Module Kinderbijslag/Trunk/Kinderbijslag/Kinderbijslag
2021-09-15 15:49:07.093  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.093  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/Aggregate (2 of 8 projects)
2021-09-15 15:49:07.103  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.103  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/AquimaLibrary (3 of 8 projects)
2021-09-15 15:49:07.113  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.113  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/AquimaPresentationStyles (4 of 8 projects)
2021-09-15 15:49:07.124  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.124  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/Dashboard (5 of 8 projects)
2021-09-15 15:49:07.132  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.132  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/BlueriqTheme (6 of 8 projects)
2021-09-15 15:49:07.144  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.144  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/DCM (7 of 8 projects)
2021-09-15 15:49:07.153  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.153  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Migrating Project Kinderbijslag/Trunk/AquimaTheme (8 of 8 projects)
2021-09-15 15:49:07.165  INFO 30032 --- [           main] c.b.s.m.r13.formats.FormatsMigration     : No formats found
2021-09-15 15:49:07.165  INFO 30032 --- [           main] c.b.studio.migration.MigrationWorkflow   : Finished running migration 'formats to presentation styles'

Want to use it?

Download Migration Tool

Release notes

1.1.2 -  

Bug fix:

Identifier

Issue

Solution

CSD-3835

In some cases the migration tool clears the Selection parameter in AQ_InstanceLinker containers.

The Blueriq management service module, which is used, had an outdated model of the Studio management service. This resulted in that the AQ_InstanceLinker Selection parameter would be cleared. The model is updated such that the Selection parameter is not cleared anymore.

1.1.1 -  

  • Initial public release of r12 → r13 Studio migration tool


Memory and performance

We advise to run this tool on the same server as Blueriq Studio to avoid network overhead, which may have a severe impact on the performance. For very large projects we also advise to run the tool for each repository separately and restart the Studio service in between runs, otherwise the Studio server may run out of memory causing the migration tool to fail.

  • No labels

1 Comment

  1. Daniel Venema

    Troubleshooting info: Studio Migration tool

Didn't find the answer you were looking for? Try the advanced search!