Merge project with local changes to new version

Use the procedure in this topic to merge a project with local changes to a new version.

If you have a project with local changes and then upgrade a package to a newer version, it is possible to merge the previous local changes to the current version.

For the best results, keep notes of all changes made to a project. This is so you can manually redo them if necessary, and to confirm if a merge is successful.

The following guidelines should be met when customizing your project.

  • It is important that you do not delete, move, or rename any Classes, Field Groups, Fields, or locators in the project. If you delete one of these items and then add it back, the internal ID is no longer the same.

  • All new Classes, Field Groups, Fields, or Locators should have a name that will not conflict with future releases of the solution. For example, add the "Custom_" prefix to all added items.

  • Add script below the marking line that says ' Modify script only below this line. Any modifications above that line can cause problems with the package, and are not included in a merge.

  • In script, refer to lookup fields and other items by their name and not by their index IDs. This is because the indexes can change and the names are not likely to change.

  • Do not remove any Databases, Dictionaries, Recognition Profiles, Table Models, or other dependent settings.

  • You can modify Recognition Profiles by adding an additional language.

Document sets and training sets are not included in the merge process. This means that if you have documents in either the Classification Set or the Extraction Set, make a copy of these outside of the project folder to ensure they are not lost during the merge. You can copy them back after the merge.

If you have training sets, merge these manually. If you do not backup your training documents before you perform the steps below, the documents are lost when your project is merged.

Procedure
  1. On the File menu, select Merge Local Changes from Previous Version.

    The Choose Project Version with Desired Local Changes window is displayed.

  2. Select the version to merge and select OK.

    The Select Items to Merge window is displayed.

    All changes to existing items are highlighted in yellow. All new items are highlighted in green. Any items highlighted in red indicate there is a conflict where two items have the same name. The item is renamed when merged.

  3. Review the highlighted items by hovering over them or selecting the information button.
  4. Select all items to merge and then select OK.

    You can use the Select All button if you are merging all new and modified items.

    The changes are merged to the new version of the project.