View source for Update to UBIK 5.2 and configure plugin deployment

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.

The database-stored plugin configuration is the recommended approach. The Injection folder remains supported, especially for custom plugins and for compatibility with existing installations.

== 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.
* 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.

{{Note|The example used for this procedure starts with a UBIK® 5.0 database using the UBIK Interface CUI and MO plugins. The iCAL plugin is installed automatically as an embedded submodule of MO.}}

== Recommended update procedure ==

=== 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.

<!-- Add screenshot: Add Plugins dialogue during first connection -->

=== Select the plugins ===

Select the same standard plugins that were used by the database before the update.

[[File:AddPlugins_Studio.png|center|upright|220px|"Add Plugins" Dialog]]

Save the changes. UBIK® Studio continues startup and updates and initialises the database. This may take one or two minutes.

{{Note|Do not interrupt database initialisation.}}

=== 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.

In the example, CUI and MO are loaded. iCAL is also available because it is included as a submodule of MO.

<!-- Add screenshot: Loaded plugins after initialisation -->

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.

In the example, CUI and MO are copied to the Injection folder.

=== 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'''.

{{Warning|When plugins are supplied through the Injection folder, administrators must maintain the Injection folder on every relevant UBIK® Studio 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.

{{Note|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.

== See also ==

* [[Injection Management]]
* [[Plugins]]
* [[HowTo:Create UBIK Plugin|Create UBIK Plugin]]