Upgrading from 2.1 to 2.2 - tsgrp/HPI GitHub Wiki

HPI Config Updates

When migrating an existing HPI application from 2.1 to 2.2, it is recommended to backup your existing /hpi/configs folder, delete the configs and re-configure HPI. While it may be possible to update existing configs, it's most likely faster to reconfigure HPI.

In HPI 2.2, tracs now have their own configs. Therefore, it is possible to share stage and search configs between tracs if desired. Also, there's no need to have separate Object Type Configs (OTC) per trac. In fact, coming up in 2.3 HPI will only have one default OTC. While not necessary for 2.2, it's recommended to configure all object types on one OTC and delete the others in order to prep for HPI 2.3. The only reason to have more than one default OTC in HPI 2.2 is if you need to show different Object Type configurations on different tracs. In HPI 2.3 this will be handled by the Form Config module.

Alfresco

No repository updates needed other than an updated OpenContent install.

Documentum

Aside from installing the updated hpi.dar, the following items should be evaluated during the upgrade:

Verify HPI folder structure and permissions

The permissions and structure changed somewhat from HPI 2.1. The DAR ignores your existing /hpi folder, so you must verify and make any updates to match the folder structure and permissions here: https://github.com/tsgrp/hpi/wiki/Configuring-a-new-instance#setup-repo

If any users have created user preferences files, these files should be moved from /hpi/configs/UserPreferences to /hpi/user. The UserPreferences folder can be deleted. Preferences files in the user folder should have the hpi_user_acl.

hpi_emailed relationship type

In HPI 2.2, the hpi_emailed relationship type changed slightly. In the 2.2 codebase, we expect the hpi_email_message object to be the parent type in the relationship and dm_document to be the child type. HPI 2.1 was reversed. If you are upgrading from 2.1 to 2.2 and use the hpi_emailed relationship, you'll have to swap the object ID's in all of the dm_relation objects where the relation_name is 'hpi_emailed'. This can be done in a number of ways:

  • Write up a quick Java main to query the objects and make the updates.
  • Make the updates via DQL. In the past, we've used an excel spreadsheet to dump the data and generate the queries quickly.

Note, double check your relation object values before executing these steps. If you deployed as part of a TSG project, there's a chance you may not need to do anything.

Max Search Results Feature

If you plan on using the max search results feature in any of your tracs, follow the server.ini instructions on the installation guide in the [repository setup] (https://github.com/tsgrp/hpi/wiki/Installation-guide#repository-setup) section

hpi_email_message TBO

The TBO and related jar definitions for iText and Apache POI must be removed from the repository. If this TBO is left in place, emails will have attachments pulled off twice - once by HPI/OC and once by the TBO.

  1. Login to DA as dmadmin or a system administrator
  2. Navigate to /System/Modules/TBO/ directory
  3. Delete the hpi_email_message folder
  4. This change should take effect right away. However, if you see issues, stop all client instances (Tomcats, JMS, etc) and clear their TBO cache.