Skip to main content
Skip table of contents

Documentum Connector Upgrade from 5.0 to 5.1

For the 5.1 release, major changes were made to the Documentum Connector as called out in the release notes.  This topic will help you upgrade from 5.0 to 5.1.


Before upgrading the Documentum Connector, complete the following prerequisite steps:

  1. Make a copy of the file to use during the upgrade. 
    1. Remote Desktop into the Documentum web server with Administrative privileges. 
    2. Locate the recordlion-rest folder (see below)

    3. Copy the file (\recordlion-rest\WEB-INF\classes) to a location you can reference during the upgrade
  2. Create a backup of the database (DocumentumConnector if it was not renamed during installation) for a backup plan.
  3. Make a note of all repositories and docbases that are currently being managed by Gimmal Records.
    1. Remote Desktop into the Documentum web server with Administrative privileges.
    2. Launch the Documentum Connector.
    3. Make a note of all selected repositories and the docsbases selected.


Upgrade to version 5.1

Be sure you have completed the prerequisites before upgrading the Documentum Connector to 5.1,

  1. Remote into the server as an Administrator on which the Documentum Connector is installed.
  2. Stop the following Documentum Connector Services:
    • Gimmal Documentum Classification Service
    • Gimmal Documentum Retention Service

  3. Download the Documentum Connector ISOs from the Gimmal Software Downloads site.  If you do not have access to the software download site, please contact Gimmal Support
  4.  Using the provided ISO, install version 5.1 of the Documentum Connector by using these steps.

    The documentation refers to 'Install' but since the Documentum Connector version 5.0 is currently still installed, the ISO will show the option to 'Upgrade' instead. 

    Ensure that you run the installer as the Local Administrator.

  5. Deploy the recordlion-rest war file by following these steps.

    As a precautionary step, do not delete the previously used recordlion-rest file when replacing it with the new recordlion-rest file, just simply rename it. (below it has been renamed to recordlion-rest VERSION 5.0).

  6. Update the file for the recordlion-rest  by following these steps.

    If you do not know where to find the dfc. properties, reference step 1 in the prerequisites.

  7. Confirm the KeyValue tables have been added to the DocumentumConnector table
    1. Expand the DocumentumConnector table in SQL Server Management Studio, then expand Tables

    2. Confirm that there is an initial entry in the KeyValues table that has a value of True

    3. Confirm recordlion-rest have been successfully deployed by opening a web browser to the URL http://@yourDocumentumDomainOrIpAddress/recordlion-rest-, and confirm that the web page below renders

Documentum Connector Initial Re-recordization

Version 5.1 of the Documentum Connector has a new feature where URIs will now be in a clickable format. However, if you are upgrading from version 5.0 to 5.1, you must go through the initial process of re-recordizing all the previous records to switch out the old URI format with the new clickable URI format. After completing these steps, you continue to proceed to use the connector as usual.

  1. Remote into the machine where the Documentum Connector is installed.
  2. Launch the Documentum Connector.
  3. In the 'Connection' tab, all the information should already be populated with the previous connection information.

  4. Enter the 'Documentum Web Application Root' value, then click 'Save'.  You will receive a confirmation if this is successful.

    It is highly recommended to not adjust any of the Documentum information in the Connection tab after saving. Changing this setting can result in duplicate records being added.

  5. Restart the machine to clear any potential credential caches before proceeding to the next steps.
  6. Click the 'Repository Configuration' -> select the docbases and object types that you made note of in the prerequisites.

    Only select repositories and docbases that were noted in the prerequisites at this time.

  7. Start Documentum Connector Services:
    • Gimmal Documentum Classification Service
    • Gimmal Documentum Retention Service
  8. Click Job Configuration, then click Custom Classification Job.

    Please do not set a Next Run Time for Incremental Classification Job or Retention Job before you run this essential step first.

  9. Select all the docbases and object types you wish to undergo the initial step of re-recordizing all the records to update to the new clickable URI format and press 'Run now'.

    This should again be the repositories and docbases noted in the prerequisites.

  10. Open SQL Server Management Studio and double-check that the KeyValue entry in the Documentum Connector database has been populated.

    If you've made the mistake of forgetting a docbase or object type that you forgot to initially re-recordize to use the new URI format, just edit this entry to display True and follow steps 5-9 again. 

  11. Upgrade to version 5.1 is complete. If you wish, you can go ahead and re-enable retention and incremental classification and proceed normally.  
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.