Installation guide - tsgrp/HPI GitHub Wiki

OCMS Installation Guide

This document explains how to install OCMS. This guide assumes that OCMS has already been built for the target environment. See the the Building and Deploying From Source guide for more information on how to build OCMS. TSG typically performs this task for our clients.

Before beginning installation, please verify the Installation Requirements.

The OpenContent installation guide has instructions on how to set up the license file. For direct instructions see here.

To install OCMS you will need to:

  1. Install OpenContent either as an AMP (Alfresco) or a WAR (any other platform).
  2. Ensure your repository is set up for OCMS (see below)
  3. Install the ocms.war to your Application Server (Ex: Apache Tomcat)
  4. Ensure that a Proxy is set up to account for the Same Origin Policy. This is needed if OCMS and OC are deployed to different application servers.
  5. Optionally install other supporting war files. For example: OpenAnnotate.war, OpenAnnotateVideo.war, WizardAdmin.war.
  6. Add at least one user to the hpi_administrators group. Login as this user and configure OCMS. Optionally insure a user exists in the wizard_administrators group and log in to the WizardAdmin application to configure AW forms.

OCMS Deployment

OCMS can be deployed as a WAR file to a Java Application Server, or can be deployed to a web server such as Apache. For Apache Tomcat, simply drop the war file in the ${catalina.home}/webapps folder. For information on how to deploy OCMS to a web server, see: https://github.com/tsgrp/hpi/wiki/Running-HPI-on-an-Apache-HTTP-Server.

OCMS Configuration

In order for OCMS to process any custom types properly, you must configure these types in the OCMS Admin. For more information see about Configuring a new instance of OCMS and the OCMS Administration Guide.

In general, you will have to:

  1. Create an Application Config
  2. In the admin, edit the Object Type Config (OTC), and add any folder and document types
  3. Create at least one trac with an appropriate search and stage config.
  4. Optionally, add additional tracs to segment types based on business functions.
  5. Configure dashlets, picklists, etc.

Transformation Engine Setup

OCMS works best when documents are auto-renditioned to PDF upon creation or versioning. See Configuring Auto-Renditioning and Transformations for OCMS for more information on setting up auto-renditioning.

Documentum Notes

Repository Setup

The HPI DAR must be installed to the repository that OpenContent will be connecting to. Note that you must use Composer 7.1 or above to perform the install. Either the eclipse or headless versions of Composer can be used.

Run the following script to create the necessary cabinets and folders for OCMS: setup\documentum\create_config_folders.dql. This script can be obtained in the product code repository.

Folder Security

If possible, set up the repository to use Folder Security. This can be accomplished in DA with the following steps:

  1. Login to DA as an administrator (ex: dmadmin)
  2. Navigate to Administration -> Basic Configuration -> Content Servers
  3. Right click on the content server and choose properties
  4. Under 'Authorization Settings' change the 'Inherit Permission Set From' value to 'Folder'
  5. Click OK to save.

Note, if this setting is changed, the docbase must be restarted prior to using OCMS.

If User or Type security is required, then run the following query on the docbase after configuring OCMS:

UPDATE dm_sysobject (all) objects SET acl_domain = (SELECT owner_name FROM dm_acl WHERE object_name = 'hpi_admin_acl') SET acl_name = 'hpi_admin_acl' WHERE FOLDER('/hpi/default/configs', DESCEND);

Search Results Limiting

By default OCMS will limit any search results coming back to a 1000 documents. To change this, an Admin must go to the Search Config tab, select the trac they wish to change, and alter the 'Limit Search Results to` field. For Documentum or Alfresco users, please take a look at this page: Limit Search Results

Alfresco Installation

Repository Setup

After installing OpenContent and OCMS, run the setup script to create the root configuration folder and necessary subfolders.

Open a browser window and navigate to the URL below. Enter admin credentials to execute the script:

  • Alfresco 5.x and above: http://${alf-tomcat-server}:${alf-tomcat-port}/alfresco/s/hpi/setup
  • Alfresco 4.x: http://${alf-tomcat-server}:${alf-tomcat-port}/alfresco/service/hpi/setup

Solr Installation

Solr Setup

Please refer to the the Solr installation guide for information on how to install Solr.

Same Origin Policy

Section Moved: https://github.com/tsgrp/HPI/wiki/Installation-Requirements#same-origin-policy

UTF-8 Encoding

Section Moved: https://github.com/tsgrp/HPI/wiki/Installation-Requirements#utf-8-encoding