Difference between revisions of "Update to UBIK 5.2 and configure plugin deployment"
(→Recommended update procedure) |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 11: | Line 11: | ||
* Identify the plugins currently used by the database. | * Identify the plugins currently used by the database. | ||
* Install UBIK® Studio 5.2 and ensure that it can connect to the database. | * Install UBIK® Studio 5.2 and ensure that it can connect to the database. | ||
| + | * '''Stop all applications, processes, and services that are connected to the database to be updated.''' | ||
* Ensure that an appropriate database backup is available according to the project's update procedure. | * Ensure that an appropriate database backup is available according to the project's update procedure. | ||
* Decide whether the plugins should be configured in the database or continue to be supplied through the Injection folder. | * Decide whether the plugins should be configured in the database or continue to be supplied through the Injection folder. | ||
| + | |||
== Recommended update procedure == | == Recommended update procedure == | ||
| + | |||
| + | === Stop all applications, processes, and services that are connected to the database to be updated === | ||
| + | Important: Before starting the database update, stop all applications, processes, and services that are connected to the database being updated. Ensure that no other UBIK® instance or related service is accessing the database during the update. | ||
=== Start UBIK Studio 5.2 === | === Start UBIK Studio 5.2 === | ||
| Line 44: | Line 49: | ||
The selected standard plugins are stored in the database. They therefore do not have to be maintained manually in the Injection folder for each UBIK® Studio installation. | The selected standard plugins are stored in the database. They therefore do not have to be maintained manually in the Injection folder for each UBIK® Studio installation. | ||
| + | |||
== Alternative: Use the Injection folder == | == Alternative: Use the Injection folder == | ||
| Line 65: | Line 71: | ||
After initialisation has completed, verify the database version and the loaded plugins in '''View → Plugins'''. | After initialisation has completed, verify the database version and the loaded plugins in '''View → Plugins'''. | ||
| − | {{Attention|When plugins are supplied through the Injection folder, administrators must maintain the Injection folder on every relevant UBIK® | + | {{Attention|When plugins are supplied through the Injection folder, administrators must maintain the Injection folder on every relevant UBIK® installation.}} |
| + | |||
== Migrate from the Injection folder == | == Migrate from the Injection folder == | ||
Latest revision as of 17:13, 5 November 2026
This page describes how to update an existing UBIK® database to version 5.2 and how to configure the required standard plugins using the plugin selection introduced with UBIK® 5.2.
If you do not have an existing database and want to initialise a new one, see Injection Management.
The database-stored plugin configuration is the recommended approach. The Injection folder remains supported, especially for custom plugins and for compatibility with existing installations.
Contents
Prerequisites
Before starting the update:
- Identify the plugins currently used by the database.
- Install UBIK® Studio 5.2 and ensure that it can connect to the database.
- Stop all applications, processes, and services that are connected to the database to be updated.
- Ensure that an appropriate database backup is available according to the project's update procedure.
- Decide whether the plugins should be configured in the database or continue to be supplied through the Injection folder.
Recommended update procedure
Stop all applications, processes, and services that are connected to the database to be updated
Important: Before starting the database update, stop all applications, processes, and services that are connected to the database being updated. Ensure that no other UBIK® instance or related service is accessing the database during the update.
Start UBIK Studio 5.2
Start UBIK® Studio 5.2 and connect to the existing database that is to be updated.
During database initialisation, the Add Plugins dialogue is displayed automatically.
Select the plugins
Select the same standard plugins that were used by the database before the update.
Save the changes. UBIK® Studio continues startup and updates and initialises the database. This may take one or two minutes.
Verify the update
After initialisation has completed, verify that:
- the database was updated to UBIK® 5.2;
- all previously used plugins are loaded;
- embedded submodules are available.
The selected standard plugins are stored in the database. They therefore do not have to be maintained manually in the Injection folder for each UBIK® Studio installation.
Alternative: Use the Injection folder
The existing Injection-folder mechanism is still supported.
Deploy the plugins
Copy all required plugins to the Injection folder of the UBIK® Studio 5.2 installation.
Update the database
Start UBIK® Studio 5.2 and connect to the existing database.
When the Add Plugins dialogue is displayed, do not select plugins that are already provided through the Injection folder. Confirm the dialogue and continue.
UBIK® Studio updates the database to version 5.2 and initialises the plugins supplied through the Injection folder.
Verify the result
After initialisation has completed, verify the database version and the loaded plugins in View → Plugins.
 | When plugins are supplied through the Injection folder, administrators must maintain the Injection folder on every relevant UBIK® installation. |
Migrate from the Injection folder
An installation that was initially updated using the Injection folder can be migrated later to the database-stored plugin configuration.
- Open the plugin administration in UBIK® Studio.
- Select Add Plugins.
- Select the standard plugins currently supplied through the Injection folder.
- Save the changes. The plugin configuration is now stored in the database.
- Remove the selected standard plugins from the Injection folder.
- Restart UBIK® Studio and reconnect to the database.
- Verify that the configured plugins are loaded successfully.
| The Injection folder can still be used in addition to the database-stored configuration, for example for custom plugins. Avoid deploying the same standard plugin through both mechanisms. |
Verification checklist
- The database opens successfully with UBIK® Studio 5.2.
- The database reports version 5.2.
- All required plugins are loaded.
- Expected embedded submodules are available.
- Standard plugins stored in the database are no longer duplicated in the Injection folder.
