emc infoarchive · emc®infoarchive version3.2 installationguide emccorporation...

EMC® InfoArchiveVersion 3.2

Installation Guide

EMC CorporationCorporate Headquarters

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

Legal Notice

Copyright © 2015 EMC Corporation. All Rights Reserved.

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS 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. Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused herein are the property of their respective owners.

Documentation Feedback

Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we canmake our documentation better or easier to use, please send us your feedback directly at [email protected]

Table of Contents

Preface ................................................................................................................................ 5

Chapter 1 Overview ..................................................................................................... 7

Chapter 2 Prerequisites and Certified Configurations ................................................. 9Special Considerations for Content Server .......................................................... 10Optional Components for InfoArchive ............................................................... 10

Chapter 3 Pre-Installation Tasks .................................................................................. 13Recommended RDBMS Settings ........................................................................ 14

Chapter 4 Installing InfoArchive .................................................................................. 15Modifying the Installation Properties File........................................................... 15Adding External Java Libraries and Resources.................................................... 16Installing InfoArchive Components and Packaging WAR/EAR Files..................... 17Distributed InfoArchive Installation................................................................... 17Deploying InfoArchive Web Services and GUI.................................................... 19Deploying InfoArchive Web Services and GUI on Apache Tomcat ................... 19Deploying InfoArchive Web Services and GUI on IBMWebSphere .................. 21Deploying InfoArchive Web Services and GUI on Oracle WebLogic ................. 22

Deploying DA Extension................................................................................... 22Deploying Records Client Extension .................................................................. 23Installing the Audit Holding ............................................................................. 23Installing Sample Holdings (Optional) ............................................................... 24Installing PhoneCallsSample Holding ............................................................ 25Configuring the PhoneCall Holding with Ant............................................. 25Ingesting Data to the PhoneCalls Holding .................................................. 26

Creating a New Holding from PhoneCalls ......................................................... 27Detail on the Ant Targets to Install a Holding ................................................. 29

Restarting Documentum Java Method Server ..................................................... 32

Chapter 5 Upgrading InfoArchive ................................................................................ 33Preparing the Environment for Upgrade ............................................................ 33Installing InfoArchive 3.2 .................................................................................. 34Updating Changed Objects ............................................................................... 34dm_ca_store ................................................................................................. 34eas_cfg_pdi .................................................................................................. 35

Updating the xDB Backup Library Format ......................................................... 35

Chapter 6 Troubleshooting Installation ........................................................................ 37

3

Table of Contents

Appendix A Files in template\content ............................................................................ 39

4

Preface

Intended AudienceThis document is intended for system administrators who are responsible for installing EMCInfoArchive.

To use this document, you must have the following:

• Administrative privileges on the host where you install EMC InfoArchive

• Working knowledge of the operating system on which you install EMC InfoArchive

• Working knowledge of EMC Documentum Content Server and EMC Documentum xDB

• Working knowledge of Apache Ant and web application servers, such as Apache Tomcat

Path ConventionsThis document uses the following path conventions:

Path Variable Description

INSTALL_DIR The temporary directory to which the EMC InfoArchive installationpackage is extracted

EAS_HOME The installation directory of EMC InfoArchive

DOCUMENTUM The installation directory of EMC Documentum Content Server

XHIVE_HOME The installation directory of EMC Documentum xDB

WEBSERVER_HOME The home directory for a web application server

Note: EMC InfoArchive was named Enterprise Archiving Solution (EAS) prior to the 3.0 release.Names of variables, properties, and object types still contain EAS or eas.

Related DocumentationThe following documentation provides additional information:

• EMC InfoArchive Release Notes

• EMC InfoArchive Configuration and Administration Guide

• EMC InfoArchive Development Guide

• EMC InfoArchive Object Reference Guide

• EMC InfoArchive Documentum Connector User Guide

5

Preface

• EMC InfoArchive SharePoint Connector User Guide

• EMC InfoArchive AppDecomm Installation and Configuration Guide

Revision History

Revision Date Description

April 2015 Initial publication

6

Chapter 1Overview

EMC InfoArchive is a unified enterprise archiving platform that stores related structured data andunstructured content in a single and consolidated repository. InfoArchive enables corporations topreserve the value of enterprise information in a single, easily accessible, unified archive.

The following InfoArchive system architecture diagram illustrates the required and optionalcomponents in a typical InfoArchive deployment.

InfoArchive includes the following components:

• InfoArchive jobs: Consists of command line jobs and Content Server jobs. InfoArchive jobs referto a series of actions you take to archive data packages, to manage Content Server objects and xDBlibraries, and to perform administrative tasks for the archiving system.

• InfoArchive Web services: Web services expose InfoArchive functions, such as ingestion, query,and order, to consumers. You can develop your own web applications to access InfoArchive byconsuming InfoArchive Web services.

• InfoArchive GUI: InfoArchive GUI is a search application that ships with the InfoArchiveinstallation package. You can customize your own application based on this application.

7

Overview

You can install InfoArchive, Content Server, and xDB on a single host, or you can distributethem among several hosts based on security, licensing, or other operation considerations. EMCrecommends that you keep the InfoArchive installation architecture as simple as possible to avoidlatency in data transfer. Do not use a distributed installation unless you have an explicit reason todo so.

InfoArchive runs on Content Server and xDB. The following documents, available from EMC OnlineSupport, provide more information about installing Content Server and xDB.

• EMC Documentum Content Server Installation Guide

• EMC Documentum xDB Administration Guide

8

https://support.emc.com/

https://support.emc.com/

Chapter 2Prerequisites and CertifiedConfigurations

The following table lists prerequisites and certified configurations for InfoArchive installation. Fordetailed operating system and database requirements for the EMC Documentum platform, refer tothe corresponding version of the EMC Documentum Environment and System Requirements Guide.

DocumentumPlatform

EMC Documentum Content Server 7.2

Operating System Windows Linux Solaris

Database SQL Server Oracle Oracle Oracle

JDK JDK 7

DA EMC Documentum Administrator 7.2

xDB EMC Documentum xDB 10.5.11

Browser One of the following:

• Microsoft Internet Explorer 10, 11

• Mozilla Firefox ESR 24.6.x, 31.x

• Google Chrome 35

Web ApplicationServer

One of the following:

• Apache Tomcat 8.0.14

• Pivotal Web Server 2.9.x (formerly known as VMware vFabric)

• Oracle WebLogic Server 12c (12.1.3)

• WebSphere Application Server V8.5.5.x

• JBoss Enterprise Application Platform 6.3.x

DFC EMC Documentum Foundation Classes (DFC) 7.2

HVS EMC Documentum High-Volume Server (HVS) 7.2

RSA DPM (Optional) EMC RSA Data Protection Manager (DPM) 3.5.2

RPS (Optional) EMC Retention Policy Services (RPS) 6.7 SP3

9

Prerequisites and Certified Configurations

CSEC (Optional) EMC Documentum Content Services for EMC Centera (CSEC) 7.2

CSS (Optional) EMC Documentum Storage Services (CSS) 7.2

Composer (Optional) EMC Documentum Composer 7.2

ViPR (Optional) ViPR 2.1.0.2.66+

Isilon (Optional) OneFS 7.1.1

Note:• Korn Shell is required for InfoArchive installation on Linux.

• DA does not support Google Chrome.

• You must install InfoArchive on an English (US) operating system using UTF-8 encoding;otherwise, archiving process may produce garbage characters.

Workaround: To remove garbage characters, add the -Dfile.encoding parameter in all .bator .sh files in the INSTALL_DIR/bin folder. For example, open eas-launch-ingestor.bat,and add the following parameter:"%JAVA_HOME%/bin/java" -Dfile.encoding=UTF-8 -Dlog4j.configuration="%LOG4J_PROP_PATH%"

Special Considerations for Content Server• Documentum High-Volume Server (HVS)must be activated on Content Server.

• Do not install Content Intelligence Services (CIS) with Content Server.

• If Content Server and xDB are installed on the same host, do not enable the XML Store featurefor Content Server. XML Store has its own xDB server instance, which will conflict with thenative xDB server.

• If Oracle database is used, the default SQL view created for the lightweight AIP objects may havea negative impact on performance. To optimize the performance, set the DM_NO_EXTRA_JOINSenvironment variable of Content Server to T and restart the repository.

• If InfoArchive command line jobs are not installed on the same machine as Content Server, DFCmust be installed on the machine where InfoArchive command line jobs are installed.

Optional Components for InfoArchiveYou can choose the following installation components to extend InfoArchive functions.

10


Component Description

EMC Retention Policy Services(RPS)

Retention Policy Services (RPS) is an application that isideally suited to manage disposition of your records froma legal standpoint. InfoArchive can utilize RPS to managelifecycle of AIP objects. Refer to the EMC InfoArchiveConfiguration and Administration Guide for more information.

EMC RSA Data Protection Manager(DPM)

RSA Data Protection Manager (RSA DPM) is an integratedsecurity solution that gives customers efficient andcomprehensive data protection. Refer to RSA resources onRSA website for more information.

Documentum Content Services forEMC Centera (CSEC)

With CSEC, you can use content-addressed storage areas, therepository representation of a Centera storage host.

Documentum Content StorageServices (CSS)

CSS allows you to create and use content storage andmigration policies.

Documentum Composer andlanguage packs

Documentum Composer provides tools to create andcustomize applications for Documentum Content Server.These applications specify how Content Server handlesdifferent types of content.

11

https://knowledge.rsasecurity.com/


12

Chapter 3Pre-Installation Tasks

Complete the following tasks before installing InfoArchive:

Note: You must have Content Server and xDB installed, and you must have superuser accessprivilege to Content Server and xDB to perform pre-installation tasks.

1. Download and install Apache Ant 1.8.1 or later, which is required for running InfoArchiveinstallation scripts.

2. Create a repository for InfoArchive in Content Server and start the repository.

3. Modify the DFC property file at Content Server level by adding the following parameter toDOCUMENTUM/config/dfc.properties:

dfc.lwo.allow_propagating_changes=true

4. Create a database for InfoArchive in xDB.

5. If you are using Oracle HotSpot JVM, set theG1 Garbage Collector (GC) option for XHIVE_OPTSin XHIVE_HOME/conf/xdb.properties:XHIVE_OPTS=-server -XX:+UseG1GC

G1 Garbage Collector (GC) for xDB server JVM can improve xDB responsiveness to webapplication servers when there is a high load of requests, such as synchronous ingestion, andsearch.

6. Restart the repository and Java Method Server.

7. Make sure you have configured the following environment variables.

Environment Variable Description

DM_HOME The directory where a version specific Documentum is installed.For example, C:\Documentum\product\7.2.

DOCUMENTUM The directory where you install Documentum. For example,C:\Documentum.

DOCUMENTUM_SHARED

Linux only. The shared directory under DOCUMENTUM. Forexample, /opt/app/dctm72/shared.

13

Pre-Installation Tasks

Environment Variable Description

XHIVE_HOME The directory where you install xDB. For example, C:\xDB.

CLASSPATH Set the following paths for the CLASSPATH variable:

• DOCUMENTUM/product/<version>/dctm-server.jar

• DOCUMENTUM/config

• DOCUMENTUM/dctm.jar

Refer to the EMC Documentum Content Server Fundamentals Guidefor more information about setting CLASSPATH.

Recommended RDBMS SettingsEMC recommends the following settings for Oracle database and Microsoft SQL Server, respectively.

Oracle Database Microsoft SQL Server

• cursor_sharing=FORCE

• optimizer_index_caching=95

• optimizer_index_cost_adj=5

• optimizer_mode=ALL_ROWS

• query_rewrite_integrity=TRUSTED

• ALLOW_SNAPSHOT_ISOLATION=ON

• READ_COMMITTED_SNAPSHOT=ON

14

Chapter 4Installing InfoArchive

The InfoArchive installation package is a Zip file. You can find the following contents after youunzip the package:• core: Contains files for installing InfoArchive jobs, InfoArchive Web services, and InfoArchiveGUI.

• holdings: Contains files for installing the audit trail holding.

• resources: Contains files for advanced users.

• tools: Contains a configuration wizard and an xDB backup migration utility.

• unsupported: Contains files for installing sample holdings.

Note: InfoArchive_AD-3.2.zip: Contains the files for installing EMC InfoArchive AppDecomm.For AppDecomm system requirements and information about how to install and configure thisapplication, refer to the EMC InfoArchive AppDecomm Installation and Configuration Guide.

Modifying the Installation Properties FileInfoArchive installation scripts use configured information in INSTALL_DIR/core/build.properties to perform installation tasks. Before running the installation scripts, you mustconfigure the following installation properties according to your machine settings.

Section Property Description

EAS_HOME The directory where you install InfoArchive. Forexample, C\:/app/eas

EAS

EAS_WORKING_DIR The directory where you save intermediate filesand logs when InfoArchive is set up and running.Usually, it is a subdirectory of EAS_HOME. Forexample, C\:/app/eas/working

15

Installing InfoArchive

Section Property Description

XDB_DB_NAME The name of the xDB database you created forInfoArchive

XDB_HOME The directory where xDB is installed

XDB_DATA The data directory for xDB

XDB_DB_HOST_SITE_A The host name of xDB. If xDB is hosted locally, setthis value to localhost; otherwise, set this valueto the remote host name or the IP address.

XDB_DB_PORT_SITE_A The xDB host port. The value is 1235 by default.

XDB_DB_USER The xDB administrator

XDB

XDB_DB_USER_PWD_CLEAR The xDB Administrator’s password

DCTM_REPOSITORY The repository you created for InfoArchive

DCTM_LAUNCHER_USER A Content Server superuser whoseuser_xprivileges value must equal56.

DCTM_LAUNCHER_USER_PWD

The launcher user’s password

DCTM_OWNER_USER The username of the InfoArchive repositoryowner. You can also set DCTM_OWNER_USER tothe same value as DCTM_LAUNCHER_USER.

DCTM

DFC_HOME The directory where dctm.jar is located

JAVA_HOME The path to JDK 7.

For Content Server 7.2, set the value to the DFCembedded JDK 7: ${DFC_HOME}/java64/1.7.0_72.

JAVA

JAVA_DAR For Content Server 7.2, use the default valueJAVA_HOME.

Note:1. Except for the backslash right after the disk volume label, you must use forward slashes in

paths in build.properties regardless of your platform. For example, C\:/app/eas(on Windows).

2. Do not use white spaces in paths. White spaces may cause problems when you configure webapplication server properties. Use my_app/eas instead of my app/eas.

Adding External Java Libraries and ResourcesIf you use advanced InfoArchive features that require external Java libraries and resources, you mustadd them to INSTALL_DIR/core/template/home/external/lib.

16


Refer to the Configuring an Encryption-Enabled Holding section in the EMC InfoArchive Configuration andAdministration Guide for an example of using RSA DPM Java libraries and resources.

The following documents on RSA website provide detailed information about RSA DPM Java KeyClient installation and configuration:

• RSA Security Concepts

• RSA Data Protection Manager Client 3.5.2 Security Configuration Guide

• RSA Data Protection Manager Java™ Key Client 3.5.2 Installation Guide

Installing InfoArchive Components andPackaging WAR/EAR Files1. Launch a command prompt window.

2. Run cd INSTALL_DIR/core.

3. Run the ant command, and you can see the following:• An overview of InfoArchive installation

• The variables configured in build.properties

4. Enter yes for prompted questions if you want to execute all steps. Use lowercase for all letters.If a failure occurs, you can resume installation from the failed step instead of starting all over again.For example, if you install InfoArchive DAR files, run the ant install-dar command, then runcommands for all subsequent steps.

After the step of packaging WAR/EAR files is completed, BUILD SUCCESSFUL is displayed in thecommand prompt window. You can find a subfolder INSTALL_DIR/core/war, which contains filesto be deployed on the web application server.

For install-dar and install-xdb, log files are created in INSTALL_DIR/core/logs regardlessof whether the step succeeded or failed.

During the installation process, new files and folders are created under INSTALL_DIR. If you want toclean temporary files and folders created during the installation, use the ant clean command todelete log, build, and war folders.

Distributed InfoArchive InstallationThe following table shows a typical distributed InfoArchive: core components installed on Host A;consuming and administrative applications installed on Host B.

17

https://knowledge.rsasecurity.com/


Host A Host B

• Content Server

• xDB

• InfoArchive Web services

• InfoArchive jobs

• InfoArchive GUI

• DA

Host A may not have DA installed, so you can use DQL scripts to interact with Content Server. Referto the EMC Documentum DQL Reference Manual for more information about how to create and modifyobjects using DQL scripts.

On Host A1. Create an access node (eas_cfg_access_node) for Host B. For example, you create an access

node named access_node_02.

a. Launch IDQL from Documentum Server Manager.

b. Enter the following DQL scripts:CREATE eas_cfg_access_node OBJECT

SET object_name = 'access_node_02',SET title = 'Access node 02',SET eas_name = 'access_node_02',SET eas_log_level = 2,SET eas_search_form_folder_path = '/System EAS/Search Forms',SET eas_act_indicators_enabled = TRUE,SET eas_def_upd_max_entries = 200,SET eas_def_upd_flush_threshold = 200,SET eas_def_upd_flush_interval = 60,SET eas_is_suspended = FALSE,SET eas_access_service[0] = '',SET eas_processed_cnt[0] = 0,SET eas_receive_enabled = FALSE,SET eas_ingest_enabled = TRUE,SET eas_fs_working_root = 'a_folder_on_Host_B',SET eas_sip_format[0] = 'eas_sip_zip',SET eas_java_class[0]= 'com.emc.documentum.eas.datamodel.sip.extractor.ZipSIPExtractor'LINK '/System EAS/Nodes'

GO

2. Update InfoArchive xDB configuration objects (eas_cfg_xdb_library) to target the xDBhost IP address or name, instead of localhost. You run the following script to update theeas_node_host property for eas_cfg_xdb_library objects:update eas_cfg_xdb_library objects set eas_node_host[0] = '<ip_address_or_server_name>'

You can confirm your changes by running the following DQL script:select eas_name, eas_node_host, eas_node_port from eas_cfg_xdb_library

3. Modify the following properties in XHIVE_HOME/conf/xdb.properties to enable the xDBhost to accept connections from remote hosts:XHIVE_SERVER_ADDRESS=*XHIVE_WEBSERVER_ADDRESS=*

4. Disable the firewall.

18


On Host B1. Copy INSTALL_HOME/core/war from Host A to Host B.

2. Open eas-services.properties in the conf folder, and modify the value ofeas_access_node to access_node_02, which was created on Host A.

3. Open eas-gui.properties in the conf folder, and modify the value of eas.webservice.location to http://ip_address_or_server_name:8080/eas-services/services/.

4. Make sure the path specified for eas_fs_working_root (see Host A step 1) exists on Host B.

Deploying InfoArchive Web Services and GUIIn the step of packaging InfoArchive WAR/EAR files, the following files and folder are created:

• eas-3.2.0000.build_number.ear

• eas-gui-3.2.0000.build_number.war

• eas-services-3.2.0000.build_number.war

• eas-da-3.2.0000.build_number.zip

• eas-records-3.2.0000.build_number.zip

• conf folder

Use the EAR package to deploy InfoArchive on J2EE servers, such as Oracle WebLogic and IBMWebSphere. Use the WAR package to deploy InfoArchive on non-J2EE servers, such as ApacheTomcat.

This guide uses Apache Tomcat, IBM WebSphere, and Oracle WebLogic for deploying InfoArchiveWeb services and GUI. For detailed information about deploying on other web application servers,refer to the documentation for the corresponding web application server.

Deploying InfoArchive Web Services and GUI onApache Tomcat

Before deploying InfoArchive Web Services and GUI on Apache Tomcat, you must add the followingproperty to WEBSERVER_HOME/conf/catalina.properties.

jnlp.com.rsa.cryptoj.fips140loader=true

1. Stop Tomcat if it is running.

2. Navigate to INSTALL_DIR/core/war.You can find the following files and a subfolder:• eas-gui-3.2.0000.build_number.war

• eas-services-3.2.0000.build_number.war

• conf folder

19


3. Copy eas-gui-3.2.0000.build_number.war and eas-services-3.2.0000.build_number.war to WEBSERVER_HOME/webapps. Then, rename them to eas-gui.war andeas-services.war respectively.

4. Set paths to .properties files as JAVA_OPTIONS.

a. Copy eas-gui.properties and eas-services.properties fromINSTALL_DIR/core/war/conf to WEBSERVER_HOME/conf.

b. Copy dfc.properties from DOCUMENTUM/config to WEBSERVER_HOME/conf.

Note: If InfoArchive Web services and Content Server are not on the same host, you mustcopy dfc.properties from the Content Server host to WEBSERVER_HOME/conf.

c. Create a script file named setenv.bat (Windows) or setenv.sh (Linux) inWEBSERVER_HOME/bin, and add the following lines to the script file. ReplaceWEBSERVER_HOME with the absolute path to the web application server root directory onthe host.set JAVA_OPTS=%JAVA_OPTS% -server -Xms1024m -Xmx1024m-XX:PermSize=128m -XX:MaxPermSize=256m-Ddfc.properties.file=WEBSERVER_HOME/conf/dfc.properties-Deas.services.properties.file=WEBSERVER_HOME/conf/eas-services.properties-Deas.gui.properties.file=WEBSERVER_HOME/conf/eas-gui.properties

Note: Setting paths to the .properties files as JAVA_OPTIONS is required for otherweb application servers. Refer to the documents of your web application server for moreinformation.

5. Restart Tomcat.

6. Enter the following URLs to verify InfoArchive Web services and GUI are deployed successfully.The host and port settings may vary depending on your installation options.http://ip_address_or_host_name:8080/eas-services

http://ip_address_or_host_name:8080/eas-gui

20


Deploying InfoArchive Web Services and GUI on IBMWebSphere1. Log in toWebSphere Administrative Console.

2. Change WebSphere server settings.

a. In the left panel of the Console, select Servers > WebSphere application servers.

b. In the right panel, click server1 in the table.

c. In the right column of the Configuration tab, expandWeb Container Settings.

d. ClickWeb container.

e. Click Custom properties in the right column.

f. Click New and create the following custom properties, with all values set to true.• com.ibm.ws.webcontainer.initFilterBeforeInitServlet

• com.ibm.ws.webcontainer.invokeFilterInitAtStartup

• com.ibm.ws.webcontainer.invokeFiltersCompatibility

• com.ibm.ws.webcontainer.invokerequestlistenerforfilter

• com.ibm.ws.webcontainer.mapFiltersToAsterisk

3. Restart WebSphere to apply the changes.

4. Deploy eas-3.2.0000.build_number.ear on WebSphere.

5. Customize web application settings.

a. In the left panel of the Console, select Applications > Application Types > WebSphereenterprise applications.

b. In the right panel, click EMC InfoArchive 3.2 in the table.

c. In the Configuration page, click Class loading and update detection.

d. In the Class loader order section, select Classes loaded with local class loader first (parentlast).

e. In the WAR class loader policy section, select Single class loader for application.

6. Customize application module settings.

a. In the left panel of the Console, select Applications > Application Types > WebSphereenterprise applications.

b. In the right panel, click EMC InfoArchive 3.2 in the table.

c. SelectManage Modules in theModules section.

d. Click web services and web GUI hyperlinks in the table, select Classes loaded with localclass loader first (parent last) in Class loader order.

7. Follow step 5 described in Deploying on Apache Tomcat to copy eas-gui.properties,eas-services.properties, and dfc.properties to a designated folder and specify thepaths in the web application server.

8. Download JAX-WS RI 2.2.8 from the JAX-WS website: https://jax-ws.java.net/.

21


9. Unzip the downloaded package, and copy the following files to both EMCInfoArchive 3.2.ear/eas-gui/WEB-INF/lib and EMC InfoArchive3.2.ear/eas-services/WEB-INF/lib.• lib/jaxb-api.jar

• lib/jaxb-impl.jar

• lib/jaxws-api.jar

• lib/jaxb-core.jar

10. Start the deployed web application, and access InfoArchive Web service and GUI with thefollowing URLs. The host and port settings in URLs may vary depending on your serverconfiguration.http://ip_address_or_host_name:9080/eas-services

http://ip_address_or_host_name:9080/eas-gui

Deploying InfoArchive Web Services and GUI on OracleWebLogic1. Go toWebLogic Admin Console, select domain_name > Web Applications.

2. Select Archived Real Path Enabled.

3. Follow step 5 described in Deploying on Apache Tomcat to copy eas-gui.properties,eas-services.properties, and dfc.properties to a designated folder and specify thepaths in the web application server.

4. Deploy the EAR package on WebLogic.

Deploying DA ExtensionInfoArchive utilizes EMC Documentum Administrator (DA) to provide a user interface forperforming most configuration and administrative functions. If DA is not deployed, you must firstdeploy a standard DA. The EMC Documentum Administrator Deployment Guide provides detailedinformation about how to deploy DA.

Note: If this is the first time you deploy DA, you must manually modify configuration files inTomcat in order to use DA.

• Disable the enablePooling setting in WEBSERVER_HOME/conf/web.xml.

• Add the following property to WEBSERVER_HOME/conf/catalina.properties.

org.apache.jasper.compiler.Parser.STRICT_WHITESPACE=false

In addition to the deployment of a standard DA, you must deploy the DA extension.

To Deploy DA Extension:1. Navigate to INSTALL_DIR/core/war.

2. Unzip eas-da-3.2.0000.build_number.zip.

22


3. Copy DA extension folders to a standard DA directory or package.If you do not have da.war under WEBSERVER_HOME/webapps, copy the subfolders to thedirectory where the standard DA is deployed.If you have da.war under WEBSERVER_HOME/webapps, you can copy the subfolders into theWAR package to update da.war, and then deploy the WAR package.

4. Restart Tomcat.

Deploying Records Client ExtensionTo take advantage of Retention Policy Services (RPS) extended retention management features suchas event-based retention, multi–phase retention, and markups, you must deploy a standard RecordsClient and its extension. The EMC Documentum Records Client Deployment Guide provides detailedinformation about how to deploy Records Client.

To Deploy Records Client Extension:1. Navigate to INSTALL_DIR/core/war.

2. Unzip eas-records-3.2.0000.build_number.zip.

3. Copy Records Client extension folders to the Records Client application root directory.

4. Copy dfc.properties from Documentum/config to EAS_HOME/conf.

5. Specify the path to dfc.properties. Follow instructions of step 4 in Deploying on ApacheTomcat.

6. Restart the web application server.After you deploy the Records Client extension, you can perform the following InfoArchive actions toAIP objects from shortcut menu in Records Client.

• Reject

• Invalidate

• Apply the purge lock

• Change retention

You can also access InfoArchive object property dialog boxes from Records Client, instead ofswitching back to DA.

Installing the Audit HoldingThe audit holding EAS-AUDIT-001 is used for archiving audit trail records. You install the auditholding by running ant scripts in the INSTALL_DIR/holdings/EAS-AUDIT-001 folder.

23


1. Open build.properties under INSTALL_DIR/holdings/EAS-AUDIT-001 with a texteditor and modify the values for the following parameters:• DCTM_REPOSITORY, refer to DCTM_REPOSITORY in the #DCTM section in

INSTALL_DIR/core/build.properties

• DCTM_USER, refer to DCTM_LAUNCHER_USER in the #DCTM section in INSTALL_DIR/core/build.properties

• DCTM_USER_PWD, refer to DCTM_LAUNCHER_USER_PWD in the #DCTM section inINSTALL_DIR/core/build.properties

2. Launch a command prompt window.

3. Run cd INSTALL_DIR/holdings/EAS-AUDIT-001.

4. Run the ant command.

5. Enter yes for the prompted question.

6. When you see BUILD SUCCESSFUL in the command prompt window, the audit holdinginstallation is completed.

The installation log is saved in INSTALL_DIR/holdings/EAS-AUDIT-001/logs, which providesdetailed information about the installation process.

Note: You may follow the same steps to install sample holdings in the unsupported folder. Sampleholdings help you get started with InfoArchive.

Installing Sample Holdings (Optional)This section uses the PhoneCallsSample holding as an example to demonstrate how to install asample holding.

The PhoneCalls sample holding is located in install/unsupported/holdings/PhoneCallsSample. The folder contains a phoneCalls SIP under PhoneCallsSample/samples and configuration files to create the PhoneCalls holding objectsin DA under PhoneCallsSample and PhoneCallsSample/template

.

24


The file build.properties contains properties specific to the InfoArchive installation and to theholding, such as the DA account, the holding name, and the holding structure. The default values aresuitable for the main simple holding configuration.

Installing PhoneCallsSample Holding

The installation of the PhoneCalls sample holding mainly comprises the following two stages:• Configuring the PhoneCall Holding with Ant

• Ingesting Data to the PhoneCalls Holding

Configuring the PhoneCall Holding with Ant

1. Edit the build.properties file in the PhoneCallsSample folder to modifyDCTM_REPOSITORY, DCTM_USER, and DCTM_USER_PWD according to your environment.

2. Open a command prompt window, change the directory as shown below:cd $INSTALL_DIR\unsupported\holdings\PhoneCallsSample

3. Run the ant command in the command prompt window. You are prompted whether or not toinstall the holding. Enter yes to confirm the installation.

Upon a successfully installation, the system returns BUILD SUCCESSFUL in the command promptwindow.

The build and logs folders are generated at the PhoneCallsSample folder. The ant scripts usethe property values set in build.properties to populate the placeholders in the template folder,and put the populated files in the newly created build folder. Therefore, build and templatecontain the equal number of files.

In the logs folder, a text file is created with the output of the Ant task. If an issue occurs duringholding installation, refer to this log file for troubleshooting.

In DA, you see every object created with the ant command. All these objects are described in theEMC InfoArchive Object Reference Guide.

25


Ingesting Data to the PhoneCalls Holding

You can test the PhoneCallsSample holding by ingesting the sample data fromPhoneCallsSample/samples.1. Open $INSTALL_DIR\unsupported\bin\eas-launch-ingest- sequence.ps1 and

modify the following variables according to your environment:• EasHome: The installation directory of InfoArchive

• RepositoryName: The Docbase name for InfoArchive

• SIPFilePattern: The reception folder and file name pattern for the SIPs to be ingested. Touse the SIP file provided in the PhoneCalls holding, set this variable to INSTALL_DIR\unsupported\holdings\PhoneCallsSample\samples\PhoneCallsSample-2011-01_10.zip. This file will be deleted after a successful ingestion.This script executes receive, ingest, and confirm jobs consecutively.

2. Open a Windows PowerShell prompt. Change the execution policy with the commandSet-ExecutionPolicy RemoteSigned

3. Run the command eas-launch-ingest-sequence.ps1.

26


4. Log in to the InfoArchive GUI (http:host:port/eas-gui/) with a Documentum account that hasrights on the holding, for example, a user with phonecall_role. In the navigation pane, openthe PhoneCalls search form, as shown below:

You can run a search or a background search on the Phone Calls data.

Creating a New Holding from PhoneCallsYou can create the configuration of a holding in the following ways:• Use the holding configuration wizard

• Create a template file from a sample holding (introduced in this section)

• Create a holding with the wizard and then manually update the template file

• Directly create configuration objects in DA

27


To create a new holding from the PhoneCalls sample holding, follow these steps:1. Create a folder for the new holding under INSTALL_DIR\ unsupported\holdings. (For

example My_Holding).

2. Copy the following files and folders to your new holding folder (My_Holding):• PhoneCallsSample/template folder with every file and sub-folder from PhoneCallsholding

• build.properties

• build.xml

• eas-ant-dctm.jar

3. Create the folder samples to store the new holding data (SIP).

4. Edit the build.properties for your new holding. This file is composed of three main sections.Two of them have to be updated for a simple classic holding. The other one could be modified foran advanced configuration.• The first section is about the environment (DCTM_REPOSITORY, DCTM_USER,

DCTM_USER_PWD, HOLDING_NAME, and HOLDING_NAME_LOWERCASE). Update theseproperties according to your environment.

• The second section is the information specific to your holding data structure (the SIP).

— Set the HOLDING_SCHEMA_1_ID with the value of the PDI (for example, for phonecalls,set it to urn:eas-samples:en:xsd:phonecalls.1.0).

— Set HOLDING_CRITERIA_NAME to a node value of the PDI file you want to search on.

— Specify the type of HOLDING_CRITERIA_NAME in HOLDING_CRITERIA_TYPE.

— HOLDING_CRITERIA_PKEY_MIN_ATTR and HOLDING_CRITERIA_PKEY_MAX_ATTR areused in index creation for searches.

— Define the root element of your holding data in QUERY_1_RESULT_ROOT_ELEMENT.

The following diagram illustrates how the properties in the second section are related withPhoneCallsSample PDI file.

28


• The third part is about ACL, ID, name, and description. In most cases, these properties don’tneed to be changed.

1. Update the content of the files located under template/content to configurethe query, the search form, and the stylesheet. Also copy the XSD of the data(template/content/eas_holding_schema_1.0.xsd). Refer to Appendix A, whichdescribes the files in the content folder, when updating these files.

2. Then run the ant command in the command prompt window to install your holding. For moreinformation, see Detail on the Ant Targets to Install a Holding.

3. After the installation completes successfully, try to ingest data (a SIP package) and check whetheryou can perform searches and background searches in InfoArchive GUI.

Detail on the Ant Targets to Install a Holding

The following table explains the Ant targets running with the ant command during the installationof a holding. These tasks are called with the target install-holding-task.

Ant Task Description

000.create.repository.structure

Creates folders and the root cabinet for the holding (under System EAS,Search Forms, and the holding cabinet).

This Ant task is defined in the file template/000-repository-structure.xml.

130.create.acls Creates ACL.

This Ant task is defined in the file template/130-acl.xml.

010.create.groups Creates dm_group (roles).

This Ant task is defined in the file template/010-groups.xml.

020.create.holding Creates the eas_cfg_holding object with parameters to set up the holdings(the main object configuration). See details on properties of this object in theEMC InfoArchive Object Reference Guide.

This Ant task is defined in the file template/020-holdings.xml.

29



021.create.library.pool

Creates the eas_cfg_xdb_library_pool object. This task sets the parametersto configure the xDB libraries.

The content of this object is filled with content/ eas_cfg_xdb_library_pool.xq.

This Ant task is defined in the file template/021-library- pool.xml.

022.create.aip.parent.policy

Creates the eas_cfg_aip_parent_policy object. This task manages theproperties to configure the policy for storing (default aip mode, xdb mode,quota for the number of AIPs per parent, quota for the number of AIUsper parent, and so on.)

This task contains an xquery. The content of this object is filled withcontent/ eas_cfg_aip_parent_policy.xq.

This Ant task is defined in the file template/022-aip-parent-policy.xml.

030.create.schemas Creates the eas_cfg_schema object. This object contains the xsd of theholding data (for the SIP). The user has to provide the schema of the holding.

The content of this object is filled with content/ eas_holding_schema_1.0.xsd. (the schema of the holding).

This Ant task is defined in the file template/030-schemas.xml.

040.create.pdi Creates the eas_cfg_pdi object. The content of this object is filled withcontent/eas_cfg_pdi.xml, which defines the indexes to search on data ofthe holding.

This Ant task is defined in the file template/040-pdi.xml.

050.create.queries Creates the eas_cfg_query object (query.01 and query.02) for an AICcollection. This object is linked to a result_schema and version. It managesthe quota for the search and the order.

The content of this object is filled with content/ eas_cfg_query.01.xml forquery.01 and with content/ eas_cfg_query.02.xml for query.02 . It definesthe mapping between the search criteria and the xPath. It specifies if thesearch is ciphered and the xquery to use for the search.

This Ant task is defined in the file template/050-queries.xml.

060.create.quota Creates the eas_cfg_query_quota objects (quota.S for the quota on searchand quota.A for the quota on the background search).

This Ant task is defined in the file template/060-quotas.xml.

070.create.alias.sets Creates the dm_alias_set object.

This Ant task is defined in the file template/070-alias- sets.xml.

080.create.orders Creates the eas_cfg_order object to configure asynchronous search (profil,acl, quota, and so on).

30


This Ant task is defined in the file template/080-orders.xml.

090.create.confirmations

Creates the eas_cfg_confirmation object (for receipt, storage, reject, invalidand purge event). It contains an xquery.

The content of this object eas_cfg_search_form is filled withcontent/eas_cfg_confirmation.xq.

This Ant task is defined in the file template/090- confirmations.xml.

100.create.search.forms

Creates the eas_cfg_search_form_folder and eas_cfg_search_form objectsfor the search form in InfoArhive GUI to configure access to the form.

The content of this object eas_cfg_search_form is filled withcontent/eas_cfg_search_form.01.xml (the XForm).

This Ant task is defined in the file template/100-search- forms.xml.

110.create.stylesheets

Creates the eas_cfg_stylesheet object to define the search result page inInfoArhive GUI. It contains an XML defining structure of the search resultset (columns, details, and so on).

The content of this object is filled with content/eas_cfg_stylesheet.01.xml.

This Ant task is defined in the file template/110- stylesheets.xml.

The following table explains the Ant targets of encryption. These tasks are not included in theholding wizard. The PhoneCalls sample has an example of encryption that can be activated with theant task activate-holding-crypto-task.


020.update.holding.crypto.ingest

Updates the holding configuration object (eas_cfg_holding) for the crypto.This task is defined in the file 020-holdings.xml.

020.create.holding.crypto

Creates an additional holding crypto object (eas_cfg_holding_crypto) Thistask is defined in the file 020-holdings.xml.

040.create.pdi.crypto Creates a specific pdi crypto object (eas_cfg_pdi_crypto). This task isdefined in the file 040-pdi.xml.

050.update.query.crypto

Updates the eas_cfg_query object for the crypto. This task is defined inthe file 050-queries.xml.

100.update.search.form.crypto

Updates the eas_cfg_search_form for the encryption. This task is defined inthe file 100-search-froms.xml.

140.create.crypto.providers.cfg

Creates the eas_cfg_crypto_provider configuration object. This task isdefined in the file 140-create-cryptoproviders.xml.

31


Restarting Documentum Java Method ServerYou must restart Java Method Server (JMS) to complete the installation process.

32

Chapter 5Upgrading InfoArchive

InfoArchive upgrade refers to migration of files, objects, and repositories, and a full installation ofInfoArchive 3.2. To upgrade InfoArchive, you must perform the following tasks:

1. Preparing the upgrade environment

2. Installing InfoArchive 3.2

3. Updating changed objects

4. Updating xDB backup library format

Preparing the Environment for UpgradeBefore upgrading InfoArchive, make sure that you perform the following action items:

• Check system requirements. Note that JDK 7 and xDB 10.5.11 are the new requirements forall install configurations of InfoArchive 3.2.

• Close all AIP parents (eas_aip_parent) and xDB pooled libraries (eas_cfg_xdb_pooled_library).

• Ensure all AIP objects are in one of the steady states:— Completed

— Waiting_Destruction

— Waiting_Confirmation

— Rejected

— Invalidated

To verify the status of objects, run the following DQL queries and ensure all queries return 0.select count(*) from eas_aip where eas_state_code not in

('COM','PUR-WCONF','PUR-WDEL','REJ-DONE','INV-DONE')or eas_is_in_unsteady_state = true;

select count(*) from eas_open_aip_parent_rel;select count(*) from eas_xdb_pooled_library where eas_close_date is nulldate;

33

Upgrading InfoArchive

• Run the following clean jobs to remove orphan objects, pruned objects, and obsolete folders.— eas_dctm_clean

— eas-launch-clean

— eas-launch-xdb-clean

Installing InfoArchive 3.2After you finish preparing the environment, you can proceed to the installation of InfoArchive 3.2following the steps described in this guide. You must deploy WAR packages again. When youdeploy the DA extension, you must copy the extension files to a clean DA installation, instead of theDA installation used by InfoArchive 3.1 or 3.0.

Updating Changed ObjectsIf you upgrade from InfoArchive 3.0, you must update the objects that have been changed sinceInfoArchive 3.1.

Note: InfoArchive 3.2 does not introduce new data types. Therefore, if you upgrade from 3.1, you donot need to perform the tasks in this section.

dm_ca_store

You create a dm_ca_store object when you save archived data on Content Addressable Storage(CAS) platforms, such as EMC Centera.

Remove the following attribute from an existing dm_ca_store object:

• eas_pdi_crypto_encoding

Add the following attributes to the existing dm_ca_store object:

• eas_crypto_encoding

• eas_pdi_crypto_hash_algo

• eas_pdi_crypto_hash_salt

• eas_pdi_crypto_iv

• eas_sip_crypto_iv

• eas_ci_crypto_iv

34


eas_cfg_pdi

You must update the XML content of the eas_cfg_pdi object in order to be compliant with the PDIXML Schema, including the following steps:

• Add a pdi.aiu.cnt data section into the XML:<data id="pdi.aiu.cnt">

<select.query xml:space="preserve">declare namespace n = "urn:eas-samples:en:xsd:phonecalls.1.0";

count(XPath_to_elements)</select.query>

</data>

• Remove the <count> element from the minmax data section.<data id="minmax"><count xml:space="preserve">declare namespace n = "urn:eas-samples:en:xsd:phonecalls.1.0";count(XPath_to_elements)</count></data>

• (Optional) Add new processors for InfoArchive 3.2. For example, pdi.aiu.id, pdi.ci.id. Refer tothe EMC InfoArchive Configuration and Administration Guide for more information about AIUID and Content ID.

Updating the xDB Backup Library FormatThe format of xDB backup library renditions has been changed from eas_xdb_library/eas_xdb_library_gzip to eas_xdb_backup/eas_xdb_backup_gzip since InfoArchive 3.1. Ifyou upgrade from 3.0, perform the following task:

Use the xDBmigration command-line tool in INSTALL_DIR/tools/XdbBackupMigration/build/bin to change the format of xDB backup libraries to eas_xdb_backup/eas_xdb_backup_gzip.

Refer to Converting xDB Library (Pool) Backup Renditions in the EMC Documentum InfoArchiveConfiguration and Administration Guide for more information about how to update the xDB backuplibrary format.

35


36

Chapter 6Troubleshooting Installation

The command prompt window displays installation status messages, including the errors that occurduring the installation. You can also find status in log files saved in INSTALL_DIR/core/logs.Log files are named as step_name.YYYY-DD-MM-Time.log.

You can locate errors by searching for error or BUILD FAILED in a log file. Most installation errorsare caused by inappropriate settings in build.properties. Certain warnings are expected becauseyou may run the scripts for multiple times and warnings may happen when the scripts delete anexisting object.

Error Message Troubleshooting Steps

C:\...\install\core\build.xml:593:No WEB-INF/web.xml file wasadded. If this is your intent, setneedxmlfile=’false’

Check EAS_VERSION in INSTALL_DIR/core/build.properties. For InfoArchive 3.2, thevalue for EAS_VERSION is 3.2.0000.412.

The system cannot find the filespecified or similar ones.

Check the related paths in INSTALL_DIR/core/build.properties. Make sure you useforward slashes in paths.

Owner object (user OR group) notfound in the target repository.

In INSTALL_DIR/core/build.properties,confirm the value for DCTM_OWNER_USER is avalid Content Server superuser.

The build.properties file ismissing.

Ensure the current directory is INSTALL_DIR/core.

37

Troubleshooting Installation

Error Message Troubleshooting Steps

Failed to deploy the DAR to therepository DCTM_REPOSITORY.

Check DCTM_REPOSITORY in INSTALL_DIR/core/build.properties. Ensure therepository is created and is started usingDocumentum Server Manager.

The running Ant version is tooold. Ant version 1.8.1 or later isrequired.

Use Apache Ant 1.8.1 or later.

38

Appendix A

Files in template\content

The following table describes the files that you may need to update in the Install_DIR\unsupported\holdings\PhoneCallsSample\template\content folder. Refer to thefollowing documents when you modify these files:• EMC InfoArchive Object Reference Guide

• EMC InfoArchive Configuration and Administration Guide

File Name Description

eas_cfg_aip_parent_policy.xq

Defines an xQuery. This file imposes constraints for searching a compatibleopen eas_aip_parent. You can also define values for the ingestion mode(AIP mode and xdb mode).

Links to the Ant task 022.create.aip.parent.policy.eas_cfg_confirmation.xq

Applicable types of the confirmation.

Links to the Ant task 090.create.confirmations.

eas_cfg_pdi.xml Defines the indexes to search later on the data of the holdings(pdi.index.creator, minmax, and toc.creator).

Links to the Ant task 040.create.pdi.

eas_cfg_query.01.xml

Defines the query configuration for search operations. This file defines thedata that can be queried from the XML content. The partition criteria areused to search on the suitable AIPs. The first part defines an xQuery tocreate custom query processing logic.

Links to the Ant task 050.create.queries.

eas_cfg_query.02.xml

Defines a query for the confirmation. This file only defines a query-templatesection. (No needs to update anything in this file for a standard holding ifyou only needs to write the status, the sip, and the aip_id .)

Links to the Ant task 050.create.queries.

eas_cfg_search_form.01.xml

Defines the search form for InfoArchive interfaces in XForm. The first partdescribes the structure of the XML content (the data model). The secondpart defines the mapping for the search (xForm bindings). The third part isthe display of the search form (the form controls). See Figure 1.

Links to the Ant task 110.create.stylesheets.

39


File Name Description

eas_cfg_stylesheet.xml

Defines the search results page for InfoArchive interfaces based on an XMLstylesheet. The tags describe the result page structure (columns, links, anddetails). See Figure 3.

Links to the Ant task 110.create.stylesheets.

eas_cfg_xdb_library_pool.xq

An xQuery to manage the library of the pool in which AIPs are ingested(for the search). It may also contain a date to specify when the library ofthe pool can be closed and options to dynamically read the ingestion mode(AIP and xdb modes) in the SIP.

Links to the Ant task 021.create.library.pool.

eas_holding_schema_1.0.xsd

The XSD of the PDI (the data).

Links to the Ant task 030.create.schemas.

The search form is configured with eas_cfg_search_form.01.xml using xform.

The file eas_cfg_search_form.01.xml is composed of three parts, which you need to update(model, binding, and html).

40


The elements (such as CallStartDate, CallEndDate, CustomerId, and CustomerLastName)defined in the search form must also be defined as search configuration of the ingestion in the fileseas_cfg_pdi.xml and eas_cfg_query.01.xml.

The configuration of the search result page is set by the column elements of eas_cfg_stylesheet.01.xml. The label, the xpath, and the type must be filled.

The PhoneCall sample holding delivers two files pertaining to localization of search forms and stylesheets respectively:eas_cfg_search_form.i18n.xml and eas_cfg_stylesheet.i18n.xml.

41

emc infoarchive · emc®infoarchive version3.2 installationguide emccorporation...

Documents