EMC® Documentum®
Content Intelligence Services
Version 6.5
Installation Guide
P/N 300­007­313 A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748‑9103
1‑508‑435‑1000
www.EMC.com
Copyright © 2002 ‑ 2008 EMC Corporation. All rights reserved.
Published July 2008
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
Table of Contents
..........................................................................................................................
5
Chapter 1
Introduction ...........................................................................................
Content Intelligence Services components ....................................................
Compatibility .............................................................................................
Upgrading .................................................................................................
Mixed environment ................................................................................
In‑place upgrade ....................................................................................
Installed version of JBoss.............................................................................
Related documentation ...............................................................................
7
7
8
8
8
10
10
10
Chapter 2
Installing Content Intelligence Services ................................................
Preinstallation task .....................................................................................
Installing Content Intelligence Services ........................................................
Postinstallation procedure ...........................................................................
13
13
13
16
Chapter 3
Uninstalling Content Intelligence Services ............................................
Uninstalling CIS .........................................................................................
Downgrading CIS .......................................................................................
19
19
19
Preface
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
3
Table of Contents
List of Figures
Figure 1.
4
Upgrading with a mixed environment .............................................................
9
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Preface
This book contains the instructions for installing the server‑side components of Content Intelligence
Services (CIS). CIS can also be administered through Documentum Administrator. The Documentum
Administrator Deployment Guide provides instructions for installing Documentum Administrator. The
WDK and Webtop Release Notes provides details on the hardware and software requirements for
Documentum Administrator.
Intended audience
This guide is intended primarily for administrators who are managing Content
Intelligence Services applications.
Revision history
The following changes have been made to this document.
Revision Date
Description
July 2008
Initial Publication
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
5
Preface
6
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Chapter 1
Introduction
Content Intelligence Services organizes documents into taxonomies. A taxonomy is a hierarchical set
of categories used to organize content in the repository based on a different set of criteria from the
cabinet and folder structure. The alternate organization, often based on the subject matter of the
content, provides one place for users to look for all content related to common topics of interest.
Content Intelligence Services can assign documents to relevant categories based on a semantic
analysis of their content. When you define your taxonomy, you identify keywords, phrases, and
patterns associated with each category. CIS server uses these keywords, phrases, and patterns as
evidence terms: when the server processes a document, it assigns the document to these categories
based on the evidence terms it finds in the content.
When required, you can also configure CIS to classify documents based on the property values
(document metadata). In this case, documents are assigned according to the values of the repository
attributes. This may be an essential condition for documents to match with a category.
When a document is assigned to a category, you can decide to link this document in the folder
associated with the category. You can also select to add the category names to an attribute of the
document. You can enable or disable these features when you configure CIS.
Content Intelligence Services components
Content Intelligence Services includes these key components:
•
The Content Intelligence Services client (CIS client), such as Documentum
Administrator, Webtop, Web Publisher, or any custom application using the Content
Intelligence Application Programming Interface (CI API), can be used for creating
and managing the taxonomy used for categorizing documents. Use Documentum
Administrator to configure CIS. The CI API handles communication between the CIS
client, the CIS server, and the Documentum repository.
•
The Content Intelligence Services server (CIS server) performs the automatic
categorization of documents based on taxonomy and category definitions.
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
7
Introduction
•
A repository is also required to store CIS data (such as taxonomy definitions and
document set definitions)
Documentum Administrator (DA) includes a Content Intelligence node that enables you
to create and manage the taxonomy used for categorizing documents. Documentum
Administrator is installed separately. The Documentum Administrator Deployment Guide
provides instructions for installing Documentum Administrator.
Compatibility
CIS version 6.5 is compatible with Content Server version 5.3, 5.3 SPx, 6.0, 6.0 SPx and 6.5.
However, CIS is not fully backward compatible with the client applications. CIS version
6.5 requires the CI API version 6 SP1 or above: DA 6 SP1, DA 6.5, Web Publisher 6
SP1, Web Publisher 6.5, and so on. This means that any client application such as DA
version 6 does not work with CIS version 6.5.
Upgrading
There are various possible scenarios upgrading CIS:
•
From version 5.3 SPx to version 6.5 (requires to also upgrade DA)
•
From version 6 to version 6.5 (requires to also upgrade DA)
•
From version 6 SP1 to version 6.5 (possible to keep DA 6 SP1)
Using two machines, you can upgrade using a mixed environment: keep the previous
version environment on one machine and setup a version 6.5 environment on another
machine. If only one machine is available, then you must perform an in‑place upgrade
over the existing installation.
The Documentum Administrator Deployment Guide and the Documentum Administrator
Installation Guide provide information on how to install and configure Documentum
Administrator.
Mixed environment
If two machines are available, you can set two environments in parallel.
8
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Introduction
To upgrade with two machines
1.
Keep an environment with the previous version of CIS on one machine—we call it
Machine1. Also keep the corresponding Documentum Administrator to administer
it. You will continue to use it for Production mode for your repository.
2.
Set up another machine—Machine2—with CIS version 6.5 and Documentum
Administrator version 6.5, and use it in Test mode.
On Machine2, do the following:
a.
Install Documentum Administrator (DA) version 6.5 and CIS version 6.5. For the
next substeps, use the newly installed DA.
b. Configure CIS for the repository used by the previous CIS.
c.
Set CIS server version 6.5 as the Test server for the repository.
d. Synchronize the definitions of the taxonomies and document sets in Test mode.
e.
3.
Validate the classification results comparing them with the results obtained in
Production mode.
If the results are satisfying, you can uninstall the environment on machine1 and set
up a version 6.5 environment in Production mode or you can use the environment
on machine2 in Production mode.
Figure 1. Upgrading with a mixed environment
Note: In this procedure, to simplify the explanation, Documentum Administrator is
described as if installed on the same machine as CIS. This is not a requirement and DA
can be installed on a separate machine.
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
9
Introduction
In­place upgrade
This procedure can be used to upgrade any previous release to version 6.5.
To upgrade in­place:
1.
Install and set up Documentum Administrator version 6.5.
2.
Uninstall the previous CIS version as described in Chapter 3, Uninstalling Content
Intelligence Services.
3.
Install CIS version 6.5 as described in Installing Content Intelligence Services, page
13.
4.
In Documentum Administrator, configure CIS:
a.
Configure CIS for a repository.
b. Set the Production and Test servers.
c.
Synchronize the definitions of the taxonomies and document sets in Test mode
first.
d. Validate the classification results before using CIS in Production mode.
Installed version of JBoss
CIS is delivered with and deployed on a specific instance of JBoss, designated as the
EMC Documentum Application Server. CIS is not supported on any other application
servers, or on any version of JBoss other than the delivered version. If you want to install
CIS on a machine already hosting an instance of JBoss, make sure there are no conflicts.
For example, the default listening port is 8060 and the default port number for CIS is
18460, if they are already used, you should select other ports during the installation.
Related documentation
The following documentation is available for using and customizing Content Intelligence
Services:
10
•
Content Intelligence Services Administration Guide
•
Content Intelligence Services Release Notes
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Introduction
Note: The installer used in this version of Content Intelligence Services does not include
the PDF documents in the installation.
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
11
Introduction
12
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Chapter 2
Installing Content Intelligence Services
This chapter contains the following sections:
•
Preinstallation task, page 13
•
Installing Content Intelligence Services, page 13
•
Postinstallation procedure, page 16
Preinstallation task
Uninstall any previous installation of CIS. Chapter 3, Uninstalling Content Intelligence
Services provides details on how to uninstall CIS depending on the installed version.
Installing Content Intelligence Services
Use this procedure to install the CIS server software.
Before performing the following procedure, review the Release Notes to ensure that you
have met the hardware and software requirements.
To install Content Intelligence Services:
1.
Log in to the CIS server host machine as a user with Administrator privileges.
You must have Administrator privileges on the host machine to run the installation
program. The person who installs CIS server is automatically the installation owner.
2.
From the EMC download website: https://EMC.subscribenet.com, download the
CIS software file: Content_Intelligence_Services_6.5_windows.war to a temporary
directory on the host machine.
You should have received instructions through email regarding how to download
products from the download website. The previous URL takes you to the download
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
13
Installing Content Intelligence Services
website login page. If you cannot locate your password, click on Download Center
Registration at the bottom of the page. Your user name is your email address.
Note: Starter taxonomies and language dictionaries are also available from the
download site. Before importing these taxonomies, you have to enable CIS in
Documentum Administrator. For further details, see the Content Intelligence chapter
in the Documentum Administrator User guide. The installation of language dictionaries
and the import of the taxonomies are described in the Content Intelligence Services
Administration Guide.
3.
4.
Unzip the downloaded file, it consists of the following files:
•
appServer.jar,
•
bofciSetup.jar
•
cis.ear,
•
cisSetup.jar,
•
cisWinSuiteSetup.exe,
•
cisWinSuiteSetup.jar,
•
dctmAppServerSetup.jar,
•
dfcWinSetup.jar,
•
jboss420.zip,
•
serviceWrapperManager.jar,
•
serviceWrapperSetup.jar,
Run the installer file: cisWinSuiteSetup.exe.
The Welcome window of the installation wizard appears with a list of products
and components which can be installed on the machine. If the same product or
component is already installed but its version is older than the one of the installer, it
is updated. If the version is the same, it is not installed nor updated.
5.
Click Next.
The license agreement appears.
6.
Read the license agreement, and if you accept it, select the option I accept the terms
of the license agreement.
7.
Click Next.
The Select optional features window appears.
8.
Specify whether to install optional components associated with the DFC runtime
environment.
•
Select the Developer Documentation checkbox to request installation of
Javadocs.
Then, click Next.
14
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Installing Content Intelligence Services
9.
Specify the directory into which the installation program should place the DFC
runtime environment, then click Next. The installation program skips this step
if it finds a registry entry that contains the required information for a previously
installed DFC runtime environment.
10. Specify the root directory for Documentum user information, then click Next.
This directory is used by Documentum products to store working files, as well as
program settings and log files. The installation program skips this step if it finds a
registry entry that contains the required information for a previously installed DFC
runtime environment.
11. Specify the hostname and port number for the machine that hosts the connection
broker, and click Next. You can use an IP address or a DNS name. The installation
program skips this step if it finds a dfc.properties file containing the required
information from a previously installed copy of the DFC runtime environment. The
information is duplicated in a dfc.properties file specific to CIS.
After the installation, you can change the connection broker host
and port values by editing the dfc.properties file in<CIS installation
directory>\deploy\cis.ear\APP‑INF\classes\ and modifying the parameters:
dfc.docbroker.host and dfc.docbroker.port.
12. Enter the Installation Owner Password. For the installation owner password, enter
the network password for the user performing the installation. The password is
required for setting up server security and services on the server that is hosting CIS.
13. Provide the application server information:
•
Enter and confirm the password for the application server administrator.
•
Enter the number of the Listen port for the application server instance, or accept
the default one (8060).
Click Next.
14. Enter the Port number for the CIS server. The default value for the port number
is 18460.
In the Repository name field, enter the name of the repository that CIS will use.
15. Review the summary. The installation program summarizes what it plans to install
and where it plans to install it. Click Back to change anything. Otherwise, click Next.
The installation will now install CIS and related products.
16. In the Designate Global Registry window, complete these substeps:
a.
If you do not wish to designate a global registry at this time, it is safe to unselect
the Designate the global registry repository to use checkbox. If you choose to
skip global registry designation, click Next and bypass the following substeps.
b. In the Repository Name text box, type the name of the repository to be used
as the global registry.
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
15
Installing Content Intelligence Services
c.
In the remaining two text boxes, specify the global registry user login and
password. The global registry user should be a user restricted to READ
privileges on the /System/Modules folder on the repository designated as the
global registry.
d. If the global registry or the global registry user is not configured or inaccessible
to the client where you are installing, unselect the Test Connection checkbox.
e.
Click Next. If the Test Connection checkbox is checked, the installation program
will attempt to validate the global registry and user settings that you have
specified.
The installation program skips this step if a global registry is detected on the machine.
17. The installation program will start an application server instance, after which the
installation is complete. Click Finish to complete the installation.
By default, CIS is installed in the directory: C:\Documentum\jboss4.2.
0\server\DctmServer_CIS.
Note: After the installation, if you want CIS to use another repository, you
must modify the name of the repository in the dfc.properties in <CIS installation
directory>\deploy\cis.ear\APP‑INF\classes\.
Postinstallation procedure
To complete the installation of CIS, you must enable the repository for CIS in
Documentum Administrator.
While CIS server is running, open Documentum Administrator to enable the repository
for CIS. To do so, open the Content Intelligence node and enable the repository; then,
open the CIS configuration page and specify the machine host for the CIS server and the
appropriate credentials.
If the repository was already enabled in DA, update the values as needed in order to
create a new authentication file. There is one authentication file per repository and per
CIS server. When you modify the repository used by a CIS server, you must re‑configure
it in DA to create a new authentication file. When you change the CIS server for a given
repository, you also need to re‑configure it in DA.
The Enabling Content Intelligence Services chapter in Documentum Administrator User Guide
provides details on how to enable CIS.
When the CIS server starts, it checks the user credentials against the repository before
opening a session. If no credentials are found or if they are invalid (for example, after a
repository change), the CIS server starts in a restricted mode that only allows receiving
new or updated credentials. The user cannot launch any classification run but he/she can
change the credentials in Documentum Administrator. When the CIS server receives
16
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Installing Content Intelligence Services
the valid credentials, it tries to connect to the repository. If successful, it switches to
full mode.
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
17
Installing Content Intelligence Services
18
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Chapter 3
Uninstalling Content Intelligence
Services
This chapter contains the procedure for uninstalling the server components of CIS.
Uninstalling CIS
Before uninstalling CIS, stop the CIS managed server as described in the Content
Intelligence Services Administration Guide.
To uninstall CIS:
1.
Select Start > Settings > Control Panel > Add/Remove Programs.
The Add/Remove window appears.
2.
In the Change or Remove Programs tab, select Documentum Content Intelligence
Services in the list of software.
3.
Click Change/Remove.
Downgrading CIS
If you plan to install a lower version of CIS after installing and uninstalling CIS version
6.5, you must also uninstall other components that were installed with CIS. If you don’t
uninstall these components, they will not be updated. The procedure below describes
which components to uninstall and the required order.
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
19
Uninstalling Content Intelligence Services
To uninstall embedded components:
The procedure below assumes you already uninstalled CIS and the Add/Remove
window of the Control Panel is still open. Uninstall the embedded components in the
given order.
1.
Select Documentum Application Server and click Change/Remove.
2.
Select Documentum Service Wrapper and click Change/Remove.
3.
Select Documentum DFC Runtime Environment and click Change/Remove.
You can now install a lower version of CIS.
20
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
Index
A
P
authentication, 16
postinstallation tasks, 16
preinstallation task, 13
C
cis.server.docbase property, 16
compatibilty, 8
components, 7
D
downgrading, 19
E
enable CIS in DA, 16
U
uninstallation, 19
application server, 20
CIS, 19
DFC, 20
embedded components, 20
service wrapper, 20
upgrading, 8
in‑place upgrade, 10
mixed environment, 8
J
JBoss version, 10
EMC Documentum Content Intelligence Services Version 6.5 Installation Guide
21