Migrate To Keyword Type Group - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Essential
Standard
Premier
CAUTION:

Before migrating to a Keyword Type Group, create a backup of the database and have all users exit the system.

Selecting Migrate to Keyword Type Group causes the currently assigned Keyword Types (displayed as Selected in the Keyword Type Assignment dialog box) to be appended to a Keyword Type Group.

The following considerations should be made prior to performing the migration:

  • Keyword Type Group migration is not currently supported in databases using 64-bit integer fields.

  • The migration process cannot be undone.

  • You cannot choose to migrate only certain Keyword Types to the Keyword Type Group. All Keyword Types assigned to the Document Type are migrated as one group.

  • You cannot have an existing Keyword Type Group assigned to the Document Type.

  • Multiple instances of a Keyword Type cannot exist on documents in the migrating Document Type. If multiple instances of a Keyword Value exist on one or more doucments included in the migration, please contact Hyland Software Database Services.

  • During migration, any Keyword Types that exist on the Document Type, but are not defined in the Keyword Type Group will be lost.

  • Any Keyword Types that exist in the Keyword Type Group, but are not Selected for the Document Type, are retained in the Keyword Type Group with null Keyword Values.

This button is active under the following conditions:

  • If the Document Type has Keyword Type Groups assigned to it when opening the dialog, the button will be disabled until the user removes the Keyword Type Groups and saves the Document Type Keyword settings.

  • If the Document Type does not have any Keyword Type Groups assigned to it when opening the dialog, the button will be enabled unless the user assigns a Keyword Type Group to the document, at which point the button will be disabled.

Note:

Depending upon the number of documents in the system that contain these Keyword Types, this process may take a long time. Before you begin, ensure you have enough time to complete the entire process.

The Migrate to Keyword Type Group function was intended to be used when the Keyword Types to be migrated and the Keyword Types defined in the Keyword Type Group correlate 1:1. For this reason, a Document Type's Keyword Types cannot be migrated to a Keyword Type Group if there are multiple instances of a Keyword Value on at least one document. If multiple instances of a Keyword Value exist on one or more documents included in the migration, please contact Hyland Software Technical Support in order to consult with Hyland Software Database Services.

To migrate Keyword Types:

  1. At the Keyword Type Assignment dialog box, select Migrate to Keyword Type Group.
    Note:

    Selecting Keyword Types or using Add/Remove to reconfigure Keyword Types at this time will not affect the migration process to an existing Keyword Type Group. If a Keyword Type that is outside of the Keyword Type Group is added or removed, it will be ignored during the migration. If a Keyword Type is added/removed that is already defined in the Keyword Type Group, no new values will exist that can be migrated.

  2. The Keyword Type Group Migrate dialog box is displayed. An existing Keyword Type Group can be selected for appending, or a new group can be created for appending.

    Select an existing Keyword Type Group and select Migrate. Or, type in the name for a new Keyword Type Group in the data entry field and click Create & Migrate. (If a new Keyword Type Group was created, it will consist of the Selected Keyword Types.)

  3. The system warns that the migration process may be time consuming. To proceed, enter the following password: DATABASE BACKUP COMPLETE
  4. Click OK.
    CAUTION:

    The system prompts you with a warning, asking if you want to perform Keyword Validation. It is strongly recommended that you perform the validation (especially if you have existing documents in the system that contain these Keyword Types).

    • This is the only chance to perform validation - once the migration is complete, the system will not prompt you for validation again.

    • If there is not a 1:1 correlation between Keyword Types, the system will display a data handling warning. Clicking the Show Details button displays missing Keyword Types from both the Keyword Type Group and the Document Type.

When the Migrate process is complete, the Keyword Type Group becomes the default selection for the Document Type.

CAUTION:

After migration is performed, re-launch all open instances of the OnBase Client module and the OnBase Web Client module. The new Keyword Type structure is not recognized by active instances of these modules until they have been re-launched. If you do not re-launch these modules, changes to the Keyword Values associated with migrated Keyword Types will not be saved.