Migrate from edoc contract app version 1.6.0 to a higher version

You can perform a migration from version 1.6 in the administration. Earlier versions of edoc contract app are not supported during migration.

The following information is transferred during migration:

• Configuration: only the settings from edoc contract app version 1.6.0 that are relevant and required for the new version are adopted. These are the following configuration options:

  • Sender settings (name, address) for reminder e-mails.

  • Number of days before a termination, renewal, etc. that should be used for the automatic calculation of the reminder date.

• Document categories: the following mappings are applied.

  • Mapping of the fields relevant for edoc contract.

  • Mapped reminder types.

• Document information: the annotation and retrieval of the document information are applied.

• Reminder overview: the specified visibility of the individual columns is adopted.

• Reminder: the reminders created are transferred. Reminders for documents that no longer exist in the ECM system are not transferred.

Note on users and groups

In version 1.6.0 of edoc contract, the unique d.velop documents abbreviations (formerly d.3ecm) were used for users and groups. These abbreviations may differ from the user and group names in Keycloak.

The migration mechanism checks whether there is a unique equivalent for the user and group names. If there is no unique equivalent, a standard procedure is used that you can configure. After the migration or analysis has been performed, you will find files containing the unknown users (invalid_users.json) and groups (invalid_groups.json) in the working directory.

There is a tool on the migration page that you can use to assign unknown users and groups to valid users and groups. This mapping changes the data in the version 1.6.0 database.

How to perform a migration

To prepare for a migration, first analyze the old data. No changes are made to the new edoc contract version.

Prepare the migration from version 1.6

Proceed as follows to prepare the migration:

1. Create a new data source with the name mig_db in the edoc contract app editor. Store the access data for the old edoc contract database from version 1.6.

2. Open the administration of edoc contract.

3. Click on Perform migration.

4. Optional: change the default configuration of the migration and define default users and groups that are used if the determination of the corresponding user or group abbreviation is incorrect.

5. Click on Analyze legacy data (Do not perform migration) to open the migration results folder.

6. Log in with Keycloak to get an overview of the migration analysis in the migration results folder.

Once you are satisfied with the result, you can start the actual migration process.

Perform the migration from version 1.6 to a higher version

Proceed as follows to carry out the migration process:

1. If you have not yet created a new data source: create a new data source with the name mig_db in the edoc contract app editor. Store the access data for the old edoc contract database from version 1.6.

2. Open the administration of edoc contract.

3. Click on Perform migration.

4. Optional: change the default configuration of the migration and define default users and groups that are used if the determination of the corresponding user or group abbreviation is incorrect.

5. Click on Perform migration to open the migration results folder.

6. Log in with Keycloak to get an overview of the migration analysis in the migration results folder.

7. Check in the administration in the new edoc contract version whether the settings from the previous version have been transferred correctly.

8. Check whether the reminders have been transferred correctly.

Information on the migration results folder

You will find several files in the folder. You will find the following information in the files:

• counter.json: contains the counters for how many reminders, documents and so on have been processed.

• invalid_groups.json: contains a list of group abbreviations that exist in the previous version and have no equivalent in the new edoc contract version.

• invalid_users.json: contains a list of group abbreviations that exist in the previous version and have no equivalent in the new edoc contract version.

• messages.json: contains information and error messages that occurred during the migration.

• migrate.log: is the log file with a lot of information about the processing.

• reminders.json: contains a list of all reminders that have been migrated.