Module Generator: Changes to a productive module

The Module Generator allows you to implement changes in productive modules as quickly and easily as process adjustments. The goal is to keep process and software design identical – your business processes should not have to adapt exclusively to predefined software processes.

Special considerations for changes to live modules

Unlike the initial release of a module, changing a productive module has special requirements: there may already be hundreds of datasets present, and users are actively working with them. The Module Generator prevents errors caused by active users during migration and data inconsistencies.

Understanding data migrations

A data migration is necessary when you delete elements from the configuration. In this case, you must select a new value for all existing data that currently uses the deleted value. This occurs when you delete a status, a task type, or an option in the Selection from list attribute type. The software will then prompt you to select a new value.

Process for changes to productive modules

Before release

The process starts the same way as the initial release: the Module Generator first checks for configuration errors and potential issues. We recommend testing in a temporary test version afterwards.

Perform the release

Depending on what changes you make, the release runs differently:

• No critical changes: If no data migrations are needed and no critical settings have changed, you click Update module, and the change is applied immediately.
• Confirmation required: Some changes require a confirmation message. Before release, all relevant adjustments are listed – such as deleting a status or security-critical changes like editing permissions in the workflow. You must confirm these before the migration can proceed.

Activate and perform migration mode

When data migrations are required, migration mode is activated. The module is then set to read-only mode.

Inform users and wait for completion

Migration mode serves as preparation for the actual migration. This allows users to be informed early that a software update will be performed soon. After activation, you can see how many users are currently editing content in the module.

While migration mode is active, you can continue working in Q.wiki. You can navigate to the configuration at any time by clicking the In Migration status in the configuration list.

Start migration

Once no users are working in the module anymore, you click Start migration. The data migration is then executed. The duration depends on the number of elements and the complexity of the changes. For smaller modules, changes will be available after just a few seconds. After that, you are redirected to the overview page and the updated module is ready to use.