emc documentum archive services for reports documentum archive services for reports installation...

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC® DocumentumArchive Services for Reports

Version 2.5

INSTALLATION GUIDEP/N 300-009-194

A01

EMC Documentum Archive Services for Reports Installation Guide2

Copyright © 2006 - 2009 EMC Corporation. All rights reserved.

Published October 2009

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 regulatory document for your product line, go to the Technical Documentation and Advisories section on EMC Powerlink.

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.

Contents

Preface

Chapter 1 Introduction Overview.................................................................................................................. 10

Microsoft Windows Installation Scenarios ................................................... 10Unix Installation Scenario ............................................................................... 10

Enterprise Processing Server (EPS) Schema ....................................................... 10Adding a New Processing Node to the EPS Schema .................................. 12Stopping a Processing Node ........................................................................... 14

Log4j Logging Format............................................................................................ 14 Optional Components............................................................................................ 15

ASR Search Service........................................................................................... 15Print Stream Conversion Plug-ins.................................................................. 15

Chapter 2 Installing ASR (Microsoft Windows) Introduction............................................................................................................. 18 Installation ............................................................................................................... 18

Installation Environment................................................................................. 18Installing Prerequisite Software ..................................................................... 19Installing ASR Software................................................................................... 20Post-Installation Notes..................................................................................... 22

Chapter 3 Installing ASR (Unix) Introduction............................................................................................................. 26 Installation ............................................................................................................... 26

Installation Environment................................................................................. 26Installing Prerequisite Software ..................................................................... 27Installing ASR Software................................................................................... 28Post-Installation Notes..................................................................................... 30

Appendix A Upgrading from Previous Versions System Requirements............................................................................................. 34 Upgrading from Version 2.0 to Version 2.5 ......................................................... 35

Prerequisites ...................................................................................................... 35Uninstalling earlier versions of ASR.............................................................. 35Installing Version 2.5........................................................................................ 36

EMC Documentum Archive Services for Reports Installation Guide 3

Upgrading from Versions 1.5.x and 1.7.x to Version 2.5 .................................... 36Prerequisites....................................................................................................... 36Uninstalling earlier versions of ASR .............................................................. 36Installing Version 2.5 ........................................................................................ 37Copying the Configuration Files .................................................................... 37Copying the Workspaces and Project Files ................................................... 38Enabling Retrieval of Logical Documents Using Documentum................ 38Verifying Your Projects .................................................................................... 38

Upgrading from Version 1.4 and Earlier to Version 2.5 ..................................... 39Prerequisites....................................................................................................... 39Considerations................................................................................................... 39Uninstalling Version 1.4................................................................................... 39Installing Version 2.5 ........................................................................................ 40Copying the Configuration Files .................................................................... 40Copying the Workspaces and Project Files ................................................... 41Enabling Retrieval of Logical Documents Using Documentum................ 41Verifying Your Projects .................................................................................... 41

Uninstalling Version 2.5 ......................................................................................... 42Microsoft Windows........................................................................................... 42UNIX ................................................................................................................... 42Installing Version 2.5 ........................................................................................ 42

Appendix B Installing Transform Plug-in Licenses Overview .................................................................................................................. 46

How It Works .................................................................................................... 46Requesting Additional Licenses ..................................................................... 46

Obtaining and Installing the License Key............................................................ 47

Appendix C Enterprise Processing Server Files New and Replaced Files in ASR bin Directory ................................................... 50

start_server.bat and start_server.sh ................................................................ 50start_node1.bat and start_node1.sh................................................................ 52stop_all_nodes.sh and start_all_nodes.sh ..................................................... 53

New and Replaced Files in ASR config Directory.............................................. 54a1server.xml ....................................................................................................... 54ASRProcessingNodeConfig.xml ..................................................................... 55ASRProcessingServer_Log.xml and ASRProcessingServer_Log.properties 56ASRProcessingNode_Log.xml and ASRProcessingNode_Log.properties 56db_date_formats.txt and dctm_date_formats.txt ......................................... 56server.policy ....................................................................................................... 58derby.properties................................................................................................. 59asr_reserved_keys.txt ....................................................................................... 59

Appendix D Installing and Configuring RPS for Use with ASR Installing RPS on the Documentum Repository ................................................. 62 Operating Environments with ASR...................................................................... 62

ASR with DFC 5.3 and 5.3 Content Server .................................................... 62ASR with DFC 6/6.5 and Documentum 6/6.5 Content Server ............................................................... 62ASR with DFC 6 and Documentum 5.3 Content Server.............................. 65Global Registry settings in dfc.properties file............................................... 65

Troubleshooting....................................................................................................... 65


Preface

As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes.

If a product does not function properly or does not function as described in this document, please contact your EMC representative.

Audience This document is part of the EMC Documentum Archive Services for Reports documentation set, and is intended for use by system administrators.

Relateddocumentation

Related EMC Documentum documents are listed here. For the latest versions of all documents, go to the EMC technical library, at http://Powerlink.EMC.com, in the path: Home > Support > Technical Documentation and Advisories:

◆ EMC Documentum Archive Services for Reports Installation Guide

◆ EMC Documentum Archive Services for Reports Administrator’s Guide

◆ EMC Documentum Archive Services for Reports Error Message Guide

◆ EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide

◆ EMC Documentum Archive Services for Reports Search Service Installation Guide

◆ EMC Documentum Archive Services for Reports Search Service Administrator’s Guide

◆ EMC Documentum Archive Services for Reports Release Notes

Conventions used inthis document

EMC uses the following conventions for special notices.

Note: A note presents information that is important, but not hazard-related.

CAUTION!A caution contains information essential to avoid data loss or damage to the system or equipment.


http://Powerlink.EMC.com

IMPORTANT!An important notice contains information essential to software or hardware operation.

Typographical conventionsEMC uses the following type style conventions in this document:

Where to get help EMC support, product, and licensing information can be obtained as follows.

Product information — For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at:


Normal Used in running (nonprocedural) text for:• Names of interface elements (such as names of windows, dialog boxes, buttons,

fields, and menus)• Names of resources, attributes, pools, Boolean expressions, buttons, DQL

statements, keywords, clauses, environment variables, functions, utilities• URLs, pathnames, filenames, directory names, computer names, filenames, links,

groups, service keys, file systems, notifications

Bold Used in running (nonprocedural) text for:• Names of commands, daemons, options, programs, processes, services,

applications, utilities, kernels, notifications, system calls, man pages

Used in procedures for:• Names of interface elements (such as names of windows, dialog boxes, buttons,

fields, and menus)• What user specifically selects, clicks, presses, or types

Italic Used in all text (including procedures) for:• Full titles of publications referenced in text• Emphasis (for example a new term)• Variables

Courier Used for:• System output, such as an error message or script • URLs, complete paths, filenames, prompts, and syntax when shown outside of

running text

Courier bold Used for:• Specific user input (such as commands)

Courier italic Used in procedures for:• Variables on command line• User input variables

< > Angle brackets enclose parameter or variable values supplied by the user

[ ] Square brackets enclose optional values

| Vertical bar indicates alternate selections - the bar means “or”

{ } Braces indicate content that you must specify (that is, x or y or z)

... Ellipses indicate nonessential information omitted from the example



Technical support- For technical support, go to Powerlink and choose Support. On the Support page, you will see several options, including one for making a service request. Note that to open a service request, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or with questions about your account.

Your comments Your suggestions will help us continue to improve the accuracy, organization, and overall quality of the user publications. Please send your opinion of this document to:

[email protected]

If you have issues, comments, or questions about specific information or procedures, please include the title and, if available, the part number, the revision (for example, A01), the page numbers, and any other details that will help us locate the subject you are addressing.


1

This chapter provides an introduction to the installation process for Archive Services for Reports and includes the following topics:

◆ Overview ............................................................................................. 10◆ Enterprise Processing Server (EPS) Schema................................... 10

Introduction

Introduction 9

Introduction

OverviewArchive Services for Reports includes the following components:

◆ ASR Enterprise Processing Server processing component

◆ ASR Enterprise Studio configuration application

◆ ASR Console diagnostics application

◆ A series of plug-ins used to perform individual operations in ASR

Depending on the platform on which you are installing ASR, there are different scenarios to consider.

Microsoft Windows Installation ScenariosYou can run the ASR installation program for Microsoft Windows to install ASR Enterprise Processing Server, ASR Enterprise Studio, ASR Console and plug-ins on a single Microsoft Windows Server computer that meets the minimum system requirements for ASR Enterprise Processing Server. Refer to the EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements.

Alternatively, you can run the installation program for Microsoft Windows to install ASR Enterprise Processing Server and plug-ins on a Microsoft Windows computer that meets the minimum system requirements for ASR Enterprise Processing Server. You can then install the ASR Enterprise Studio and ASR Console client applications on a separate Microsoft Windows computer that meets the minimum system requirements for ASR Enterprise Studio. Refer to the EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements.

Unix Installation ScenarioYou can run the ASR installation program for Unix to install ASR Enterprise Processing Server and plug-ins on a Unix machine. You can then install the ASR Enterprise Studio and ASR Console client applications on a separate Microsoft Windows computer that meets the minimum system requirements for ASR Enterprise Studio. Refer to the EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements.

Enterprise Processing Server (EPS) Schema The new architecture differs in several ways from the ASR 1.7.x and earlier Processing Server. One difference is that the task processing responsibility has been moved from the Processing Server process to Processing Node processes, which can reside on any computer anywhere on the network. In the previous server all tasks were executed through a single class. With EPS, the server class has been changed to be a remote RMI class and the server side has a list of these remote classes that are announced to it. When a call to execute a task comes in, the server simply goes through its list and calls an available remote class to handle the request. Because of the size of the input that ASR must process, a shared drive and file based task staging is recommended.


Introduction

Figure 1 ASR Enterprise Processing Server (EPS) Schema

Enterprise Processing Server (EPS) Schema 11

Introduction

A processing node does the following:

◆ Announces itself to the processing server. Announcing to the processing server involves naming which tasks it can perform. Each processing node will be configured with its available tasks and processing server address.

◆ Processes tasks that are assigned by the processing server, including run task and rollback task.

Note: The IP addresses of the ASR Enterprise Server and its processing nodes must be static, and all machines must not be running DHCP.

Adding a New Processing Node to the EPS Schema

After installing the Enterprise Processing Server, a new processing node is created in the following ways:

Note: Both the Processing Server, and processing nodes -- including those that exist on other systems -- need to have access to the project's working directory (typically something like F:\EMC\Documentum_ASR\servers\production\Workspace 1\_working) via the exact same path, using mapped network drives.

Adding a processingnode on the main EPS

processing server

Follow these steps to add an additional processing node on the main processing server:

1. Duplicate the ASRProcessingNodeConfig.xml file (see “ASRProcessingNodeConfig.xml” on page 55) using a different filename, such as node2_config.xml. Any filename can be used, with a .xml extension, but you should use a meaningful filename that helps to recognize the server node instance.

2. Edit the new config file (node2_config.xml in this example), changing <rmi_port>xxx</rmi_port> setting to match the value for this element in the a1server.xml file on the ASR Enterprise Server, and changing the <server_host>localhost</server_host> setting to the servername or static IP address of the ASR Enterprise Server.

If you want the node to write to a different log file, then you should also modify the <log4j_xml> or <log4j_properties> element; changing the existing "ASRProcessingNode_Log.xml" log config file reference to correspond to this node config file -- such as "ASRProcessingNode2_Log.xml". Then duplicate the ASRProcessingNode_Log.xml file as ASRProcessingNode2_Log.xml, to create the corresponding log file. See also step 5 for more on log files.

3. Duplicate the start_node1.bat in Windows, or the start_node1 shell script in UNIX (see “start_node1.bat and start_node1.sh” on page 52) as start_node2.bat or start_node2.sh.

4. Edit the new batch file or shell script, created in step 3, and change the name of the .xml file referenced within to match the new node2_config.xml file.

5. Setup the logging for the processing node, editing either the ASRProcessingNode_Log.xml file or the ASRProcessingNode_Log.properties file. Refer to “Log4j Logging Format” on page 14, and also “ASRProcessingNode_Log.xml and ASRProcessingNode_Log.properties” on page 56. If you set up a separate log file for the node, such as ASRProcessingNode2_Log.xml, as suggested in step 2, then you would modify this file as needed, instead.


Introduction

6. After the ASR Enterprise Processing Server has been started, open a command window and run the new start_node2.bat or start_node2.sh file. The new node instance will begin running, and will register itself with the ASR Enterprise Processing Server.

Note: If the ASR Enterprise Processing Server is stopped for any reason, and then restarted, the processing nodes must also be stopped and restarted. Refer to “stop_all_nodes.sh and start_all_nodes.sh” on page 53 for information on stoppoing and starting all nodes in a single command.

7. Processing nodes that contact the ASR Enterprise Processing Server will be listed in the ASR Enterprise Studio user interface. If you want to prepopulate the Studio interface with the new node that you have created, so that the Studio program will list it even before it registers with the server, you can add its node name to the <Node_list> section of the a1server.xml file. The node name to add should exactly match the text and case of the <name>node_name</name> field in the node2_config.xml file.

Adding a processingnode on a different

computer

Follow these steps to add a processing node to a separate computer from the EPS processing server:

1. Run the installer on the separate computer, and install all of the plug-ins that were installed on the main Enterprise Processing Server.

Note: Each node machine is required to have the same plugins installed as the Enterprise Processing Server machine.

2. Duplicate the ASRProcessingNodeConfig.xml file (see “ASRProcessingNodeConfig.xml” on page 55) using a different filename, such as remote_node2_config.xml. Any filename can be used, with a .xml extension, but you should use a meaningful filename that helps to recognize the server node instance.

Note: If modified appropriately, the existing node config, log config, and script files could be used since this was a new install. However, to remove confusion, and since additional nodes may already be installed on the Enterprise Processing Server machine, it is recommended to use a prefix in the filename, like “remote_”, to ensure that your new node name will be unique.

3. Edit the new config file (remote_node2_config.xml in this example), changing <rmi_port>xxx</rmi_port> setting to match the value for this element in the a1server.xml file on the ASR Enterprise Server, and changing the <server_host>localhost</server_host> setting to the servername or static IP address of the ASR Enterprise Server.

If you want the node to write to a different log file, then you should also modify the <log4j_xml> or <log4j_properties> element; changing the existing "ASRProcessingNode_Log.xml" log config file reference to correspond to this node config file -- such as "remote_ASRProcessingNode2_Log.xml". Then duplicate the ASRProcessingNode_Log.xml file as remote_ASRProcessingNode2_Log.xml, to create the corresponding log file. See also step 6 for more on log files.

4. Duplicate the start_node1.bat in Windows, or the start_node1 shell script in UNIX (see “start_node1.bat and start_node1.sh” on page 52) as remote_start_node2.bat or remote_start_node2.sh.

Enterprise Processing Server (EPS) Schema 13

Introduction

5. Edit the new batch file or shell script, created in step 4, and change the name of the .xml file referenced within to match the new remote_node2_config.xml file.

6. Setup the logging for the processing node, editing either the ASRProcessingNode_Log.xml file or the ASRProcessingNode_Log.properties file. Refer to “Log4j Logging Format” on page 14, and also “ASRProcessingNode_Log.xml and ASRProcessingNode_Log.properties” on page 56. If you set up a separate log file for the node, such as remote_ASRProcessingNode2_Log.xml, as suggested in step 3, then you would modify this file as needed, instead.

7. After the ASR Enterprise Processing Server has been started, open a command window on this separate node machine and run the new remote_start_node2.bat or remote_start_node2.sh file. The new node instance will begin running, and will register itself with the ASR Enterprise Processing Server.


8. Processing nodes that contact the ASR Enterprise Processing Server will be listed in the ASR Enterprise Studio user interface. If you want to prepopulate the Studio interface with the new node that you have created, so that the Studio program will list it even before it registers with the server, you can add its node name to the <Node_list> section of the a1server.xml file on the Enterprise Processing Server. The node name to add should exactly match the text and case of the <name>node_name</name> field in the remote_node2_config.xml file.

Stopping a Processing Node

In Windows, you can type Ctrl-C in the command window in which you ran the start_nodeX.bat file. Simply closing the command window, or typing ’exit’ in the command window, will also stop the operation of the processing node.

In UNIX, the act of running the start_nodeX script creates a process with a unique process ID, and the script then also creates a stop_nodeX_<process_id> script that you can run to stop the processing node operation. There are also scripts for starting and stopping all processing nodes on UNIX systems; refer to “stop_all_nodes.sh and start_all_nodes.sh” on page 53 for details.

Log4j Logging Format Logging for Archive Services for Reports has been modified to make use of an open format. Log4j is an Apache logging project for java. log4j makes it possible to enable logging at runtime without modifying the application code. Logging behavior can be controlled by editing a configuration file, without touching the application binary. A default format is installed with the product, which can be customized easily following the log4j documentation.

Note: The documentation for the log4j logging tools can be found at the following URLs:

http://wiki.apache.org/logging-log4j/http://logging.apache.org/log4j/1.2/publications.html (see links on left)

The configuration files for this new logging scheme are in the path...

<install dir>\EnterpriseProcessingServer\config\


Introduction

... and have the following filenames:

◆ ASRProcessingServer_Log.xml

◆ ASRProcessingServer_Log.properties

◆ ASRProcessingNode_Log.xml

◆ ASRProcessingNode_Log.properties

Either .xml or .properties files can be used. The .xml files will be used if present; otherwise the .properties files will be used.

The log filename produced by these config files is defined in the .xml/.properties file. The default logfile output path is ...

C:/EMC/Documentum_ASR/servers/production/_log/

... and the default logfile filenames are:

◆ ASRServer.log

◆ ASRProcessingNode.log

For more information on the specific files, refer to Appendix C.

Optional ComponentsThe following optional ASR components can also be installed. Procedures for installing each component is included in the documentation that accompanies the component.

ASR Search ServiceASR Search Service manages storage and access to archived content. Users can quickly browse, search and retrieve individual enterprise reports and data using ASR Search Service interfaces.

Refer to the following documents to install and user the ASR Search Service:

◆ EMC Documentum ASR Search Service Installation Guide

◆ EMC Documentum ASR Search Service Administrator's Guide

Print Stream Conversion Plug-ins

EMC has embedded products from the Crawford Technologies PRO suite of print stream conversion products into EMC Documentum Archive Services for Reports as plug-ins. The plug-ins support the conversion of AFP, Metacode, PCL and Postscript to Adobe PDF.

Refer to the EMC Documentum ASR Administrator’s Guide, and also the documentation that accompanies each plug-in for information on installing and using the plug-in with ASR. For licensing information on these plug-ins, refer to Appendix B, “Installing Transform Plug-in Licenses,”.

Optional Components 15

Introduction


2

This chapter provides detailed instructions for installing and activating the ASR Enterprise Processing Server on a Microsoft Windows operating system and includes the following topics:

◆ Introduction ........................................................................................ 18◆ Installation........................................................................................... 18

Installing ASR(Microsoft Windows)

Installing ASR (Microsoft Windows) 17

Installing ASR (Microsoft Windows)

IntroductionThe ASR installation program for Microsoft Windows includes the following components:





Note: For more information on Microsoft Windows installation scenarios, refer to Chapter 1.

InstallationThis section includes the following topics:

◆ “Installation Environment” on page 18

◆ “Installing Prerequisite Software” on page 19

◆ “Installing ASR Software” on page 20

◆ “Post-Installation Notes” on page 22

Note: If you are upgrading from a previous version of ASR software, refer to Appendix A, “Upgrading from Previous Versions,” before proceeding with installation of version 2.5.

Installation EnvironmentPlease consider the following points before installing the ASR Enterprise Processor software:

◆ Documentum Foundation Classes (DFC) software will be required if you plan to run the "Store in Documentum Docbase" plug-in. Before installing ASR software, install the prerequisite software described in the next section.

◆ If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details.

◆ The IP addresses of the ASR Enterprise Server and its processing nodes must be static, and all machines must not be running DHCP. You should make sure of these details before proceeding with the ASR Enterprise Server installation.

◆ The ASR 2.5 Enterprise Processing Server does not include the Report Mining plug-in. If you are planning to upgrade to the ASR 2.5 Mining Server/Client, from the ASR Report Miner distributed with earlier releases, you should install and confirm functionality of the ASR Mining Server/Client product before upgrading your ASR Processing Server to release 2.5 so that there will be no period during which your mining operations are unavailable.

Note: There is no automatic migration mechanism that can assist users of ASR Report Miner to adopt the new ASR Mining Server processes.



◆ ASR 2.5 is released with plug-ins from Crawford Technologies Incorporated (CTI) release 3.6, Build ID 2424. Customers that have installed CTI patches with builds more recent than 3.6 Build ID 2424 must backup their patched CTI binaries before installing ASR 2.5., and restore their patched CTI binaries after the install.

◆ For installation of EPS into a Windows environment, it is required to have installed the Microsoft Visual C++ 2005 SP1 Redistributable Package ATL Security Update (x86). This package installs runtime components of Visual C++ Libraries that are required to run applications developed with Visual C++ on a computer that does not have Visual C++ 2005 installed.

Note: This software is now included in and installed by the ASR EPS 2.5 Windows installer.

Installing Prerequisite Software

Documentum DFC Download and install the appropriate version of the Documentum Foundation Classes (DFC) software provided on the Documentum software download site...

http://powerlink.emc.com/

... and go to menu path ...

Home > Support > Software Downloads and Licensing > Documentum Download Center > Locate a Product

Installing DFC sets or updates a CLASSPATH environment variable.

Example:

CLASSPATH=C:\Program Files\Documentum\dctm.jar;C:\Documentum\ConfigThe CLASSPATH variable must include the full pathnames of the dctm.jar file and the Documentum\Config\ directory. These values are required to be set in order for the ASR "Store in Documentum Docbase" task to work correctly.

Processor Statedatabase

ASR uses a database to keep track of the processor state information. You can use Oracle or SQL Server for this purpose, or you can use the embedded database (DERBY) that comes with ASR. The two commercial databases are the more likely choices for implementing a heavy production installation of ASR, and are expected to be used with many of ASR’s features. However, you can use the embedded database for project development work, and/or if the commercial database software is not yet installed or expected to be used at the time you are installing ASR.

If you’re going to be using either Oracle or SQL Server in conjunction with ASR, it can also be used to store the ASR processor state information. It is simplest if the database is installed before installing ASR. There is an install dialog that requests the following information about the database, which will have to be supplied by the database administrator:

◆ Database Instance

◆ Database User

◆ Database Password (the ASR installation encrypts the password)

If you’re going to use the embedded stated database that is supplied with ASR, then it is installed and configured automatically; just select the embedded option instead of Oracle or SQL Server.

Installation 19


Note: If you are installing more than one Processing Server, each one must have its own state database. The database instance you enter in this installation must be a different value from any you may have stipulated for other Processing Server installations.

Note: If you later decide to use a different state database, you can read about how to make that adjustment in the troubleshooting appendix of the ASR Administration Guide.

Adobe Acrobat Download and install Adobe Acrobat Standard or Adobe Acrobat Professional (version 6.0 or higher) from the Adobe web site (www.adobe.com)

Note: To ensure successful integration with ASR Enterprise Studio, you must also install the latest patches for the version of Acrobat you install.

Installing ASR SoftwareTo perform a typical install of ASR Enterprise Processing Server:

1. Ensure that you are logged in as the same user account that was used to install Documentum (e.g., dmadmin), and confirm that this user has full write permissions on the ASR EPS default installation directory (e.g., \Program Files\EMC\Documentum_ASR\EnterpriseProcessingServer), or whichever directory will be selected in step 7 for the installation. The installation will not succeed if the installing user does not have sufficient write permissions.

2. Locate the Archive Services for Reports Server installer. Double click the file to launch the installation wizard.

3. After reading the information in the Introduction window of the installation wizard, click Next.

4. Read and accept the terms of the EMC License Agreement, and click Next.

5. On the Choose Install Set page of the installation wizard, select the components you want to install. Click Next.

6. On the Installation Requirements pages, read and note that the Microsoft Visual C++ 2005 SP1 Redistributable Package (x86) will be installed as part of the EPS installation. Refer to “Installation Environment” on page 18 for details.

7. In the Choose Install Folder screen, choose the folder in which you want to install ASR, the click Next.

8. On the ASR Enterprise Servers Root Folder page, select the path in which you want the ASR Enterprise Processing Server program to maintain your development and production files. You can browse using the [Choose...] button, if the default location is not where you would like the files to reside. When ready, click Next.

9. On the State DB type page, select the database type to be used for storing the Enterprise Processing Server state information. You can use the embedded option for initial development. It is recommended to use either SQL Server or Oracle if production operations are expected to grow large. Your choice here affects the default values populated in the next screen.

10. On the Get State DB information page, enter the relevant database server name or IP address, database port, database instance, database username and password. Default values are shown for the database type you chose in the previous screen. Database instance, username, and password for SQL Server and


http://www.adobe.com


Oracle should be available from the database administrator. For the embedded database, these values are as follows:

instance = eps_dbusername = epspassword = eps

Further information about State DB setup is presented in “Post-Installation Notes” on page 22.


11. This is an optional configuration. On the Server Failure Notification page, provide information about delivering an email message to someone in the event that ASR Enterprise Processing Server fails while processing. Enter the appropriate information.

Note: Only one email address should be supplied in the Recipients field. If more than one person needs to be notified, you can set up an alias in your email system and add multiple recipients to the alias.

Click Next.

12. The Transform Plug-in Registration Required page is a reminder to register the transform plug-ins that were selected (in the Choose Install Set screen) for installation. The relevant section of the Installation Guide is named for reference.

13. In the Choose Shortcut Folder page, select where to create product icons and click Next.

Note: It is recommended you select Other to install the shortcuts in the default location.

14. Review the details on the Pre-Installation Summary page and click Install.

Installing ASR Enterprise Processing Server. Installation proceeds, and displays several more screens, some with reminders to consult further sections in the installation documentation.

A progress bar shows installation activity.

Note: If you are reinstalling or upgrading, you may see the "File Already Exists" prompt, which states that the a1server.xml file will be renamed using a .backup filename extension, and replaced with a new one. After installation, you should compare the new version with the old version, especially if the earlier version had been edited by hand. Retain the .backup version in case troubleshooting becomes necessary.

Note: You will also see the license screen for the Microsoft Visual C++ 2005 SP1 Redistributable Package (x86). Click Yes to accept the terms and install the software. You may also see a progress screen for this software installation.

15. In the Logical Document Configuration Required screen, a reminder is displayed regarding enabling retrieval of logical documents using Documentum. Refer to “Enabling Retrieval of Logical Documents Using Documentum” on page 38 for this information.

Installation 21


16. The Post-Install Actions Required page makes reference to the next section of this present chapter.

17. The Install Complete page indicates that the software installation has finished successfully. Click Done, and then refer to the next section of this chapter for post-installation instructions.

Post-Installation Notes

Several post-installation steps are required to complete your ASR configuration.

Note: If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details.

Establish programpermissions

If necessary, modify the Documentum ASR Enterprise Processing Server to run using the the permissions of the installation user. This enables the ASR processing server to create and modify files using the permissions of this user. In <install dir>\EnterpriseProcessingServer\bin directory, check the executables and also the start_server.bat and start_node1.bat files.

Set Firewall Exceptionif Processing Server is

on Windows 2008

If you plan to connect to the ASR Processing Server machine from a different computer running the ASR Studio program, and the Processing Server machine is running Windows 2008, you may have to set an exception in the Windows Server’s firewall:

1. Go to Control Panel > Windows Firewall.

2. Click on Change Settings.

3. Click on the Exceptions tab.

4. Click on the Add Port button.

5. Add a name and the processing server port number, and click OK.

State DB Setup You completed some State database screens during installation. You must now create the EPS (Enterprise Processing Server) state database tables. Scripts for this purpose exist in

<install_dir>\EnterpriseProcessingServer\config\EPS

Embedded State DB optionThis database was installed with ASR. Default values are:

◆ port: 1527

◆ username: eps

◆ password: eps encoded: Caatic5j538=

◆ DB instance: eps_db

To create the EPS state database tables, run

Create_EPS_DB_Derby.sql

To delete the EPS state database tables, run

Drop_EPS_DB_ Derby.sql



Note: the tables and database will be created automatically by the Server if they do not already exist.

SQL Server State DB optionMS SQL Server should be installed before running the commands named below.

Default values are:

◆ port: 1433

◆ username: set by DBA

◆ password: set by DBA

◆ DB instance: set by DBA


Create_EPS_DB_MSSQL.sql


Drop_EPS_DB_MSSQL.sql

Oracle State DB optionOracle should be installed before running the commands named below.

Default values are:

◆ port: 1521





Create_EPS_DB_Oracle.sql


Drop_EPS_DB_ Oracle.sql

Start the ASREnterprise Processing

Server

Once the State Database has been setup and started, you can start the ASR Enterprise Processing Server by double-clicking the start server batch file.

start_server.bat

This file is in the

<install dir>\EnterpriseProcessingServer\bin

directory. This batch file opens a command window and runs the commands in the batch file. Details of the start_server.bat file can be seen in “start_server.bat and start_server.sh” on page 50.

The server can be stopped by typing Ctrl-C in the command window.


Installation 23


Set Up AdditionalProcessing Nodes

The Enterprise Processing Server schema calls for the use of multiple processing nodes. For details on setting up processing nodes, refer to “Adding a New Processing Node to the EPS Schema” on page 12. Details of the scripts for starting the processing nodes can be seen in “start_node1.bat and start_node1.sh” on page 52, and in “stop_all_nodes.sh and start_all_nodes.sh” on page 53.


3

This chapter provides detailed instructions for installing and activating the ASR Enterprise Processing Server on a Unix operating system and includes the following topics:

◆ Introduction ........................................................................................ 26◆ Installing ASR Software .................................................................... 28

Installing ASR(Unix)

Installing ASR (Unix) 25

Installing ASR (Unix)

IntroductionThe ASR installation program for Unix includes the following components:



The following client applications must be installed on a Microsoft Windows computer:



Note: For more information on Unix installation scenarios, refer to Chapter 1.

InstallationThis section includes the following topics:

◆ “Installation Environment” on page 26

◆ “Installing ASR Software” on page 28

◆ “Post-Installation Notes” on page 30

Note: If you are upgrading from a previous version of ASR software, refer to Appendix A, “Upgrading from Previous Versions,” before proceeding with installation of version 2.5.

Installation Environment

Please consider the following points before installing the ASR Enterprise Processor software:

◆ Documentum Foundation Classes (DFC) software will be required if you plan to run the "Store in Documentum Docbase" plug-in. Before installing ASR software, install the prerequisite software described in the next section.

◆ If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details.

◆ The IP addresses of the ASR Enterprise Server and its processing nodes must be static, and all machines must not be running DHCP. You should make sure of these details before proceeding with the ASR Enterprise Server installation.

◆ The ASR 2.5 Enterprise Processing Server does not include the Report Mining plug-in. If you are planning to upgrade to the ASR 2.5 Mining Server/Client, from the ASR Report Miner distributed with earlier releases, you should install and confirm functionality of the ASR Mining Server/Client product before upgrading your ASR Processing Server to release 2.5 so that there will be no period during which your mining operations are unavailable.



◆ ASR 2.5 is released with plug-ins from Crawford Technologies Incorporated (CTI) release 3.6, Build ID 2424. Customers that have installed CTI patches with builds more recent than 3.6 Build ID 2424 must backup their patched CTI binaries before installing ASR 2.5., and restore their patched CTI binaries after the install.

Installing Prerequisite Software

Documentum DFC Download and install the appropriate version of the Documentum Foundation Classes (DFC) software provided on the Documentum software download site...

http://powerlink.emc.com/

... and go to menu path ...

Home > Support > Software Downloads and Licensing > Documentum Download Center > Locate a Product

Download and install the appropriate version of the Documentum Foundation Classes (DFC) software provided on the ASR software download site. Refer to the ASR Release Notes for information on supported versions.

Environment VariablesThree environment variables participate in the installation and/or operation of DFC and ASR:

◆ DOCUMENTUM environment variable must be defined and exported to the root Documentum installation directory.

◆ DOCUMENTUM_SHARED environment variable must be defined and exported to the shared directory.

◆ CLASSPATH environment variable is established or updated during the installation of DFC. It must include the full pathname to the dctm.jar file and the Documentum/config directory. It must be defined and also exported. These two values in this variable must be defined in order for the "Store in Documentum Docbase" task to work correctly.

In order to install DFC on a UNIX system, the DOCUMENTUM and DOCUMENTUM_SHARED environment variables need to be defined and exported in the shell prior to running the DFC installer. These same values must be defined and exported for ASR to work as well. As a convenience, you can refer to the set_dctm_env.sh file, usually located in the $DOCUMENTUM_SHARED/dfc directory.

Note: the ASR start_server script checks during startup that the DOCUMENTUM and DOCUMENTUM_SHARED environment variables are defined, and if not, a warning is printed to the console.

File and Directory PermissionsAfter installing the DFC, make sure that the permissions are set to 777 on the dfc/shared/cache and dfc/shared/config directories. This is required to enable the "Store In Documentum" task to create lock files and write to the cache. If a user other than the DFC installation user runs ASR on this machine, and these directories and their contents are not world writable, there can be permissions errors due to the current user not having rights to those locations.

Installation 27


Processor Statedatabase

ASR uses a database to keep track of the processor state information. You can use Oracle or SQL Server for this purpose, or you can use the embedded database (DERBY) that comes with ASR. The two commercial databases are the more likely choices for implementing a heavy production installation of ASR, and are expected to be used with many of ASR’s features. However, you can use the embedded database for project development work, and/or if the commercial database software is not yet installed or expected to be used at the time you are installing ASR.

If you’re going to be using either Oracle or SQL Server in conjunction with ASR, it will also be used to store the ASR processor state information. It is simplest if the database is installed before installing ASR. There is an install dialog that requests the following information about the database, which will have to be supplied by the database administrator:

◆ Database Instance

◆ Database User

◆ Database Password (the ASR installation encrypts the password)

If you’re going to use the embedded stated database that is supplied with ASR, then it is installed and configured automatically; just select the embedded option instead of Oracle or SQL Server.

Note: If you later decide to use a different state database, you can read about how to make that adjustment in the troubleshooting appendix of the ASR Administration Guide.

Installing ASR SoftwareTo perform a typical installation of ASR Enterprise Processing Server and plug-ins:

1. Ensure that you are logged in as the same user account that was used to install Documentum (e.g., dmadmin), and confirm that this user has full write permissions on the ASR EPS default installation directory (e.g., /opt/EMC/Documentum_ASR/EnterpriseProcessingServer), or whichever directory will be selected in step 9 for the installation. The installation will not succeed if the installing user does not have sufficient write permissions.

2. Place the installation files in a desired location. Unzip the files if necessary (gunzip) and use chmod 777 on the files.

3. Run the installation executable.

4. After reading the information in the Introduction window of the installation wizard, click Next.

5. Read and accept the terms of the EMC License Agreement, and click Next.

6. On the Choose Install Set page of the installation wizard, select the components you want to install. Click Next.

7. On the Clients Unavailable page, note that the ASR Enterprise Studio and ASR Console client applications can be installed only on Microsoft Windows machines. Click Next.

8. On the Installation Requirements page, read and verify that all requirements have been met (refer to “Installation Environment” on page 26). If necessary, use the link provided to update the system with any required components not yet installed, or click Cancel to end the installation and manually update. When ready, click Next.



9. On the Choose Install Folder screen, choose the folder in which you want to install ASR.

10. On the ASR Enterprise Servers Root Folder page, select the path in which you want the ASR Enterprise Processing Server program to maintain your development and production files. You can browse using the [Choose...] button, if the default location is not where you would like the files to reside. When ready, click Next.

11. On the State DB type page, select the database type to be used for storing the Enterprise Processing Server state information. You can use the embedded option for initial development. It is recommended to use either SQL Server or Oracle if production operations are expected to grow large. Your choice here affects the default values populated in the next screen.

12. On the Get State DB information page, enter the relevant database server name or IP address, database port, database instance, database username and password. Default values are shown for the database type you chose in the previous screen. Database instance, username, and password for SQL Server and Oracle should be available from the database administrator. For the embedded database, these values are as follows:

instance = eps_dbusername = epspassword = eps

Further information about State DB setup is presented in “Post-Installation Notes” on page 30.


13. This is an optional configuration. On the Server Failure Notification page, provide information about delivering an email message to one or more recipients in the event that ASR Enterprise Processing Server fails while processing. Enter the appropriate information.

Note: Only one email address should be supplied in the Recipients field. If more than one person needs to be notified, you can set up an alias in your email system and add multiple recipients to the alias.

Click Next.

14. The Transform Plugin Registration Required page is a reminder to register the transform plug-ins that were selected (in the Choose Install Set screen) for installation. The relevant section of the Installation Guide is named for reference. When ready, click Next.

15. Review the details on the Pre-Installation Summary page and click Install.

16. The components of ASR are installed.

Installation proceeds, and displays several more screens, some with reminders to consult further sections in the installation documentation.

A progress bar in the Installing ASR Enterprise Processing Server page shows that installation is continuing.

Installation 29


Note: If you are reinstalling or upgrading, you may see the "File Already Exists" prompt, which states that the a1server.xml file will be renamed using a .backup filename extension, and replaced with a new one. After installation, you should compare the new version with the old version, especially if the earlier version had been edited by hand. Retain the .backup version in case troubleshooting becomes necessary.

17. A reminder is displayed regarding enabling retrieval of logical documents using Documentum. Refer to “Enabling Retrieval of Logical Documents Using Documentum” on page 38 for this information. Click Next.

18. The Post-Install Actions Required page makes reference to the next section of this present chapter. Click Next.

19. The Install Complete page indicates that the software installation has finished successfully. Click Done.

Post-Installation Notes

Several details need to be attended in order to complete the ASR installation.

Setting permissions If the installation was performed while logged on as a user other than root, you must update the owner of checkpassword as follows:

1. Navigate to the install location.

2. Navigate into the bin directory (e.g., /opt/EMC/Documentum_ASR/EnterpriseProcessingServer/bin).

3. You must give checkpassword root user permissions. Perform a

chown root checkpassword.

You must run this command as a root user. In addition to giving checkpassword root owner permissions, you must modify the sticky bit to allow this executable to be run as root by non-root users. Perform the following command:

$ chmod +s ./checkpassword

4. Verify the configuration by performing a ls -l to display the permissions. The results displayed should be similar to the following:

-r-sr-s--x 1 root admin 12100 Dec 8 2006 checkpassword

Note: In this example, the group is admin. Your group should be the same as the group of the user that installed ASR processing server (e.g., dmadmin). You can run the following two commands to set the permissions correctly:

chmod o+x checkpasswordchmod ug+s checkpassword

Note: If you are planning to use the "Store in Documentum Docbase" plug-in, then you must now also install separately the "Extern Store" plug-in for Content Server, which provides for logical document configuration. Refer to the EMC Documentum Archive Services for Reports Extern Store Plug-in for Content Server, Installation Guide for details.

State DB Setup You completed some State database screens during installation. You must now create the EPS (Enterprise Processing Server) state database tables. Scripts for this purpose exist in



<install_dir>/EnterpriseProcessingServer/config/EPS

Embedded State DB optionThis database was installed with ASR. Default values are:

◆ port: 1527

◆ username: eps

◆ password: eps encoded: Caatic5j538=

◆ DB instance: eps_db


Create_EPS_DB_Derby.sql


Drop_EPS_DB_ Derby.sql

Note: the tables and database will be created automatically by the Server if they do not already exist.

SQL Server State DB optionMS SQL Server should be installed before running the commands named below.

Default values are:

◆ port: 1433





Create_EPS_DB_MSSQL.sql


Drop_EPS_DB_MSSQL.sql

Oracle State DB optionOracle should be installed before running the commands named below.

Default values are:

◆ port: 1521





Create_EPS_DB_Oracle.sql


Drop_EPS_DB_ Oracle.sql

Start the ASREnterprise Processing

Server

After setting up and starting the State Database, you can start the ASR Enterprise Processing Server by running

Installation 31


start_server.sh

This script is in the <install_dir>/EnterpriseProcessingServer/bin directory. Details of the start_server.bat file can be seen in “start_server.bat and start_server.sh” on page 50.

Note: Each time you run the start_server.sh script, a new script called stop_server.sh is created. To stop the ASR processing server, run stop_server.sh.


Set up AdditionalProcessing Nodes

The Enterprise Processing Server schema calls for the use of multiple processing nodes. For details on setting up processing nodes, refer to “Adding a New Processing Node to the EPS Schema” on page 12. Details of the scripts for starting the processing nodes can be seen in “start_node1.bat and start_node1.sh” on page 52, and “stop_all_nodes.sh and start_all_nodes.sh” on page 53.


A

This appendix provides instructions on upgrading from a previous release of ASR Enterprise Processing Server to version 2.5, and includes the following sections:

◆ System Requirements ........................................................................ 34◆ Upgrading from Version 2.0 to Version 2.5..................................... 35◆ Upgrading from Versions 1.5.x and 1.7.x to Version 2.5 ............... 36◆ Upgrading from Version 1.4 and Earlier to Version 2.5 ................ 39

Upgrading fromPrevious Versions

Upgrading from Previous Versions 33

Upgrading from Previous Versions

System RequirementsBefore performing an upgrade you must ensure that your environment meets the minimum hardware and software requirements for ASR 2.5. Refer to the following requirements:

◆ Microsoft Windows prerequisite software – “Installing Prerequisite Software” on page 19

◆ Unix prerequisite software – “Installation Environment” on page 26

◆ EMC Documentum Archive Services for Reports Release Notes for the minimum system requirements.



Upgrading from Version 2.0 to Version 2.5This section explains how to upgrade from version 2.0 to version 2.5.

PrerequisitesUpgrading to ASR version 2.5 requires that you uninstall the previous version of ASR. To ensure business continuity, you should first copy any important information from the prevous ASR version 2.0 installation directory (C:\Program Files\Documentum_ASR\EnterpriseProcessingServer) to a temporary location for safekeeping. Typically, this information will not be disturbed during the upgrade, but having the backup is recommended. Important information includes:

◆ The ASR config directory which typically contains references to ASR projects you want to retain.

◆ The ASR Server directory which typically contains ASR Workspace and Project files.

◆ Licenses for any Crawford Technologies PRO suite of print stream conversion products. This area may get overwritten with temporary licences which have a newer timestamp, when ASR 2.5 is installed.

Windows%ALLUSERSPROFILE%\Application Data\crawfordtech

Unix/usr/local/crawfordtech/

Uninstalling earlier versions of ASR

Before installing version 2.5, you must uninstall the previous version. This section describes procedures for uninstalling on Microsoft Windows and Unix.

Microsoft Windows

Note: IMPORTANT: Ensure you have read and taken action on the recommendations in “Prerequisites” on page 36 .

To uninstall earlier versions on Microsoft Windows:

1. Click Start > Settings > Control Panel. The Control Panel window appears.

2. Select Add or Remove Programs.

3. Locate Documentum ASR in the Add or Remove Programs window, and choose to uninstall it.

4. Close the Add or Remove Programs window and the Control Panel window.

Unix

Note: IMPORTANT: Ensure you have read “Prerequisites” on page 36.

To uninstall earlier versions of ASR on Unix:

1. Navigate to the current ASR Enterprise Processing Server installation location

2. Run the uninstaller binary file located in the uinstall directory.

Upgrading from Version 2.0 to Version 2.5 35


Installing Version 2.5

Install version 2.5 of ASR using the instructions found in one of the following sections:

◆ “Installing ASR (Microsoft Windows)” on page 17

◆ “Installing ASR (Unix)” on page 25

Upgrading from Versions 1.5.x and 1.7.x to Version 2.5This section explains how to upgrade from version 1.5.x through 1.7.x of Archive Services for Reports to version 2.5.

Prerequisites

Upgrading to ASR version 2.5 requires that you uninstall the previous version of ASR. To ensure business continuity, you should first copy any important information from the prevous ASR version 1.5.x or 1.7.x installation directory (C:\Program Files\Documentum_ASR\ProcessingServer) to a temporary location so that it can be referenced later in the upgrade process. Important information includes:

◆ The ASR config directory which typically contains references to ASR projects you want to retain.

◆ The ASR Server directory which typically contains ASR Workspace and Project files.

◆ Licenses for any Crawford Technologies PRO suite of print stream conversion products. This area may get overwritten with temporary licences which have a newer timestamp, when ASR 2.5 is installed.



Uninstalling earlier versions of ASRBefore installing version 2.5, you must uninstall the previous version. This section describes procedures for uninstalling on Microsoft Windows and Unix.

Microsoft Windows

Note: IMPORTANT: Ensure you have read and taken action on the recommendations in “Prerequisites” on page 36 .

To uninstall earlier versions on Microsoft Windows:





3. Locate Documentum ASR in the Add or Remove Programs window, and choose to uninstall it.


Unix


To uninstall earlier versions of ASR on Unix:


2. Run the uninstaller binary file located in the uinstall directory.





Copying the Configuration FilesAfter installing ASR version 2.5, copy the configuration files according to the table below:

Table 1 Configuration File Locations

Operating System Copy Copy Files To

Windows The following files (if they exist):• asr_studio.config• asr_console.config• fopcfg.xml• system.iniFrom the temporary location for the config directory established in “Prerequisites” on page 36.

C:\Program Files\EMC\Documentum_ASR\EnterpriseProcessingServer\config. Rename asr_console.config to asr_console_eps.config, and rename asr_studio.config to asr_studio_eps.config

UNIX The following files (if they exist):• fopcfg.xml• system.iniFrom the temporary location for the config directory established in “Prerequisites” on page 36.

/opt/EMC/Documentum_ASR/servers/config

Crawford Technologies PRO suite licenses, if any

Any files copied to a temporary location, per the “Prerequisites” on page 36.

Windows:%ALLUSERSPROFILE%\Application Data\crawfordtech

Unix: /usr/local/crawfordtech/

Upgrading from Versions 1.5.x and 1.7.x to Version 2.5 37


Copying the Workspaces and Project Files

After installing ASR version 2.5, move the Workspaces and Project files according to the table below:

Enabling Retrieval of Logical Documents Using Documentum

If you are using Documentum Webtop and Documentum Administrator (DA) for retrieval of logical documents, please follow the instructions the EMC Archive Services for Reports Extern Store Plug-in Installation Guide to complete the setup.

Verifying Your Projects

With any upgrade of ASR, it is important for the user to verify that all projects still run as with the previous release of ASR by running them using ASR Enterprise Studio 2.5 and ASR Enterprise Processing Server 2.5.

Table 2 Workspaces and Project File Locations

Operating System Copy Copy Files To...

Windows All folders and files within the the temporary location for the Server directory established in “Prerequisites” on page 36.

... the location you selected in the ASR Common Root Folder screen during installation. The default path for this location is:C:\EMC\Documentum_ASR\EnterpriseProcessingServer

UNIX All folders and files within the the temporary location for the Server directory established in “Prerequisites” on page 36.

/opt/EMC/Documentum_ASR/servers



Upgrading from Version 1.4 and Earlier to Version 2.5This section explains how to upgrade from versions 1.4 and earlier of Archive Services for Reports to version 2.5.

PrerequisitesUpgrading to ASR version 2.5 requires that you uninstall the previous version of ASR. To ensure business continuity, you should first copy any important information from the ASR version 1.4 installation directory (C:\Program Files\Acartus\ApertureONE) to a temporary location so that it can be referenced later in the upgrade process. Important information includes:

◆ The ASR 1.4 config directory which typically contains references to ASR projects you want to retain.

◆ The ASR 1.4 Server directory which typically contains ASR Workspace and Project files.

◆ Licenses for any Crawford Technologies PRO suite of print stream conversion products. This area gets overwritten with temporary licences which have a newer timestamp, when ASR 2.5 is installed.



Considerations

Understand the following considerations:

◆ If you intend to use a Documentum repository with ASR 2.5, the database must be case-sensitive.

◆ If you intend to use a StoreInArchive repository with ASR 2.5, you can continue to use the existing ASR 1.4 database if it was created as not case sensitive. If the database is case-sensitive, you will need to create a new database association and configure that database as case-sensitive.

Uninstalling Version 1.4Before installing version 2.5, you must uninstall version 1.4. This section describes procedures for uninstalling on Microsoft Windows or Unix.

Microsoft Windows

Note: IMPORTANT: Ensure you have read “Prerequisites” on page 36 .

To uninstall ASR version 1.4 on Microsoft Windows:



3. Locate Acartus - ApertureONE Processing Server in the Add or Remove Programs window, and choose to uninstall it.

Upgrading from Version 1.4 and Earlier to Version 2.5 39



Unix


To uninstall ASR version 1.4 on Unix:


2. Run the uninstaller binary file located in the Uninstall_Acartus ApertureONE Processing Server directory.





Copying the Configuration FilesAfter installing ASR version 2.5, copy the configuration files according to the table below:

Table 3 Configuration File Locations

Operating System Copy Copy Files To

Windows The following files (if they exist):• a1studio.config• a1console.config• fopcfg.xml• system.iniFrom the temporary location for the config directory established in “Prerequisites” on page 36.

C:\Program Files\EMC\Documentum_ASR\EnterpriseProcessingServer\configYou must also rename the following files:• a1studio.config to

asr_studio_eps.config

• a1console.config to asr_console_eps.config

UNIX The following files (if they exist):• fopcfg.xml• system.iniFrom the temporary location for the config directory established in “Prerequisites” on page 36.

/opt/EMC/Documentum_ASR/servers/config

Crawford Technologies PRO suite licenses, if any

Any files copied to a temporary location, per the “Prerequisites” on page 36.

Windows:%ALLUSERSPROFILE%\Application Data\crawfordtech

Unix: /usr/local/crawfordtech/



Copying the Workspaces and Project Files

After installing ASR version 2.5, move the Workspaces and Project files according to the table below:

Enabling Retrieval of Logical Documents Using Documentum

If you are using Documentum Webtop and Documentum Administrator (DA) for retrieval of logical documents, please follow the instructions the EMC Archive Services for Reports Extern Store Plug-in Installation Guide to complete the setup.

Verifying Your Projects

With any upgrade of ASR, it is important for the user to verify that all projects still run as with the previous release of ASR by running them using ASR Enterprise Studio 2.5 and ASR Enterprise Processing Server 2.5.

Table 4 Workspaces and Project File Locations

Operating System Copy Copy Files To...

Windows All folders and files within the the temporary location for the Server directory established in “Prerequisites” on page 36.

... the location you selected in the ASR Common Root Folder screen during installation. The default path for this location is:C:\EMC\Documentum_ASR\EnterpriseProcessingServer

UNIX All folders and files within the the temporary location for the Server directory established in “Prerequisites” on page 36.

/opt/EMC/Documentum_ASR/servers

Upgrading from Version 1.4 and Earlier to Version 2.5 41


Uninstalling Version 2.5If for some reason you need to uninstall ASR version 2.5, you can follow the steps in this section, for both Microsoft Windows and UNIX.

Microsoft Windows To uninstall ASR version 2.5 on Microsoft Windows:



3. Locate ASR Processing Server in the Add or Remove Programs window, and choose to uninstall it.


The removal process displays some status screens, and may display results messages in an "Uninstall Complete" dialog. The uninstall process is designed not to remove the directories where your project information is stored. Therefore, the following messages are merely informational, and not a warning:

Unable to remove directory C:\EMC\Documentum_ASR\servers\production

Unable to remove directory C:\EMC\Documentum_ASR\servers\development

Having uninstalled ASR 2.5, your ASR 2.5 project information remains. In the case where you want to reinstall the software your project information is ready to be made use of. On Windows, the default location for these is C:\EMC\Documentum_ASR\servers\. If you chose a different server project location, the pathnames in the Uninstall Complete -- Messages screen would be different.

UNIX Note: IMPORTANT: Ensure you have read “Prerequisites” on page 36.

To uninstall ASR version 2.5 on Unix:

1. Navigate to the current ASR Server installation location

2. Run the uninstaller binary file located in the uninstall directory.

Installing Version 2.5 Install version 2.5 of ASR using the instructions found in one of the following sections:

◆ “Installing ASR (Microsoft Windows)” on page 17.

◆ “Installing ASR (Unix)” on page 25.



Uninstalling Version 2.5 43

B

This appendix provides instructions on obtaining and activating a license for each of the transform plug-ins available for ASR, and includes the following sections:

◆ Overview ............................................................................................. 46◆ Obtaining and Installing the License Key....................................... 47

Installing TransformPlug-in Licenses

Installing Transform Plug-in Licenses 45

Installing Transform Plug-in Licenses

OverviewEMC has embedded products from the Crawford Technologies PRO suite of print stream conversion products into EMC Documentum Archive Services for Reports as plug-ins. The ASR installation program installs plug-ins that support the following conversions:

◆ AFP to PDF

◆ AFP to PDF/A

◆ Metacode DJDE to PDF

◆ Metacode DJDE to PDF/A

◆ PCL to PDF

◆ PCL to PDF/A

◆ Postscript to PDF

◆ Postscript to PDF/A

How It WorksThe transform plug-ins are licensed using a single license key file which enables one or more transform to be used in a production environment. Although transform plug-ins will function without the license key, the output will include a watermark which indicates the plug-in is running with an evaluation license.

Requesting Additional LicensesIf you have requested and obtained a license key for one or more transform plug-ins, and subsequently want to add more transform plug-ins to the license key, you must repeat the procedure described in “Obtaining and Installing the License Key” on page 47. This enables you to to obtain a replacement license key that supports the additional transform plug-ins.



Obtaining and Installing the License KeyTo obtain a license key for a transform plug-in, you must generate a system key from the ASR Enterprise Processing Server, email the system key output to EMC (along with some required information), receive the license key from EMC, and install the key.

To obtain a license key:

1. The ASR installation includes a system key generation application named ctsyskey. Locate the application in the ASR installation directory as shown in Table B-1:

2. Run the system key generation application. The application generates output similar to the following:

CTISYSKEY_BEGIN=====> AD15FC56AB6C3D4A5199E67B8929181227657DB095057756CFA1DA0D6B5A91B8D0B7316B8667086CBBEB0A922289F3A594B3519BEACBEFBE2655 <=====CTISYSKEY_END

3. Do one of the following:

• Copy the output

• Redirect the output from ctsyskey to a file using standard file redirection command such as ctsyskey > syskey.txt

4. Paste the output in an email message addressed to [email protected]. The email must also include the following information:

• The name of all transform plug-ins to be licensed

• The name of the company that licensed the transform plug-ins

• The contact information of the individual where the license key should be sent, including:

– Name– Email address– Phone

• The name of the host machine on which the transform plug-in(s) will be run

• The host machine operating system environment

When the request is received, EMC will generate a license key file and upload it to the your customer account in the EMC Download Center at emc.subscribenet.com.

Table B-1 System Key Generation Application Location

Platform Location

Microsoft Windows ASR_INSTALL_DIR\Crawford\ctsyskey\windows

IBM AIX ASR_INSTALL_DIR/Crawford/ctsyskey/aix

Sun Solaris ASR_INSTALL_DIR/Crawford/ctsyskey/solaris

HP-UX ASR_INSTALL_DIR/Crawford/ctsyskey/hpux

Linux ASR_INSTALL_DIR/Crawford/ctsyskey/linux

Obtaining and Installing the License Key 47


If this license key file is not available in the Download Center within 48 hours of receiving an order notification email from the licensing team, you can contact the licensing team at [email protected].

5. Place the license key file (prolcnse.lic) in the appropriate location for your processing server platform:

• Windows – %ALLUSERSPROFILE%\application data\crawfordtech

• Windows 2008 -- This version of Windows does not have a Documents and Settings directory, so a %ALLUSERSPROFILE%\application data\crawfordtech directory does not exist to contain the prolcnse.lic file. In this case, you must create a directory to contain the Crawford license, and then add the following LICENSEFILE command to the .ini file for each of the Crawford plug-ins for which you have purchased a license...

LICENSEFILE=DD

where: DD is the full path, including the filename, to the license file.

• Unix – /usr/local/crawfordtech/


C

This appendix provides copies and descriptions of the batch and config files associated with the Enterprise Processing Server features in ASR 2.5, located in the <ASR_INSTALL_DIR>/bin and <ASR_INSTALL_DIR>/config directories.

Descriptions are provided in the following sections:

◆ New and Replaced Files in ASR bin Directory .............................. 50◆ New and Replaced Files in ASR config Directory......................... 54

Enterprise ProcessingServer Files

Enterprise Processing Server Files 49

Enterprise Processing Server Files

New and Replaced Files in ASR bin DirectoryWith ASR release 2.0 and later, in Windows, the default bin directory location is:

C:\Program Files\EMC\Documentum_ASR\EnterpriseProcessingServer\bin

The new files supplied with the Enterprise Processing Server upgrade are:

◆ start_server.bat and start_server.sh (described below)

◆ start_node1.bat and start_node1.sh (described below)

◆ stop_all_nodes.sh and start_all_nodes.sh (described below)

◆ derby.properties (described below)

The replaced files supplied with the Enterprise Processing Server upgrade are:

◆ asr_ep_server.jar

◆ asr_ep_server/*

◆ asr_studio_eps.exe (replaces asr_studio.exe)

start_server.bat and start_server.sh

This script file starts the server. Executed from the command line in a command window.

Note: The start_server script can take several minutes to bring the server to full operation, depending on the number of ASR projects that it has to load. With 20,000 projects, it can take as long as ten minutes before the processing nodes are registered with the server, and interaction with the server via the ASR Enterprise Studio is functional. If the starting of the server and nodes is being managed by a shell script or batch file, it may me necessary to build in pauses, depending on the number of projects that the ASR Enterprise Processing Server has to load.

The start_server.bat file (for Windows) file contains a single line of text.

..\jre\bin\java -Xmx512M -Djava.security.policy=../config/server.policy -classpath asr_ep_server.jar com.acartus.apertureone.tampa.server.Server

The start_server.sh file (for UNIX) contains these lines.

#!/bin/sh

# The start_server _must_ exist in the bin/ dir.asr_bin_dir=`dirname $0`;cd $asr_bin_dir;

# PWDASR_BIN=".";

OS=`uname`

# Update the dynamic library load path to find ASR and DCTM modules# for each platform.

if [ "$OS" = "AIX" ]then LIBPATH=$LIBPATH:$ASR_BIN export LIBPATHelif [ "$OS" = "HP-UX" ]



then SHLIB_PATH=$SHLIB_PATH:$ASR_BIN export SHLIB_PATHelif [ "$OS" = "SunOS" ]then LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ASR_BIN export LD_LIBRARY_PATHelif [ "$OS" = "Linux" ]then LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ASR_BIN export LD_LIBRARY_PATHelse echo "The operating system '$OS' is not supported. Exiting."; exit 1;fi

# Check environment variables for startup.if [ -z "$DOCUMENTUM" ] || [ ! -d "$DOCUMENTUM" ]then echo "WARNING: StoreInDocumentumDocbase plugin will not work correctly."; echo " DOCUMENTUM environment variable does not exist or "; echo " does not point to a valid directory."; echo "";fi

if [ -z "$DOCUMENTUM_SHARED" ] || [ ! -d "$DOCUMENTUM_SHARED" ]then echo "WARNING: StoreInDocumentumDocbase plugin will not work correctly."; echo " DOCUMENTUM_SHARED environment variable does not exist or "; echo " does not point to a valid directory."; echo "";fi

# Add the ASR_BIN directory to the PATH env. variable for exec() functions.PATH=$ASR_BIN:$PATHexport PATH

if [ -f ./stop_server.sh ]then echo "Attempting to stop previous execution of ASR Processing Server..."; ./stop_server.shfi

echo "Starting ASR Enterprise Processing Server...";

asr_ep_server_cp="./asr_ep_server.jar:./asr_ep_server/activation.jar:./asr_ep_server/dbinterface.jar:./asr_ep_server/mail.jar:./asr_ep_server/smtp.jar:./asr_ep_server/asrdomhelpers.jar:./asr_ep_server/derby.jar:./asr_ep_server/mailapi.jar:./asr_ep_server/sqljdbc.jar:./asr_ep_server/asremail.jar:./asr_ep_server/derbyclient.jar:./asr_ep_server/ojdbc5.jar:./asr_ep_server/xalan.jar:./asr_ep_server/asrencoding.jar:./asr_ep_server/derbynet.jar:./asr_ep_server/orai18n.jar:./asr_ep_server/xercesImpl.jar:./asr_ep_server/asrlogging.jar:./asr_ep_server/imap.jar:./asr_ep_server/pop3.jar:./asr_ep_server/xml-apis.jar:./asr_ep_server/asrtampa.jar:./asr_ep_server/jpinterface.jar:./asr_ep_server/resolver.jar:./asr_ep_server/xmlsec.jar:./asr_ep_server/asrutils.jar:./asr_ep_server/log4j-1.2.13.jar:./asr_ep_server/serializer.jar:./asr_ep_server/xsltc.jar"

../jre/bin/java \ -Xmx512M \ -Djava.security.policy=../config/server.policy \ -classpath "${asr_ep_server_cp}:$CLASSPATH" \ com.acartus.apertureone.tampa.server.Server $@ >&1 &

# Determine the process_id of the background java process just created.asr_ep_server_pid=$!echo "INFO: asr_ep_server pid: $asr_ep_server_pid"

New and Replaced Files in ASR bin Directory 51


# Generate stop_server shell script.echo "#!/bin/sh" > stop_server.sh;echo "" >> stop_server.sh;echo "kill -9 $asr_ep_server_pid" >> stop_server.sh;echo "rm ./stop_server.sh" >> stop_server.sh;

chmod 770 ./stop_server.sh;

start_node1.bat and start_node1.sh

This .bat file (Windows) or shell script (UNIX) starts an instance of a server node. It should be executed from the command line in a command window on the machine that is running the processing node process.

Duplicates of this file must be created manually, for starting each new processing node that is defined. Each start_nodex.bat or start_nodex.sh file is paired with a corresponding node config file that describes the node.

The start_node.bat file contains a single line of text, which passes the name of the node config file to the server as it starts. The example below shows the default node config file name in bold.

..\jre\bin\java -Xmx512M -Djava.security.policy=..\config\server.policy -classpath asr_ep_server.jar com.acartus.apertureone.tampa.server.ProcessingNode ..\config\ASRProcessingNodeConfig.xml

The start_node1.sh file contains the following lines:

#!/bin/sh

# Name of the node's config file. Make changes here!config_file="ASRProcessingNodeConfig.xml"

# The start_server _must_ exist in the bin/ dir.asr_bin_dir=`dirname $0`;cd $asr_bin_dir;

# PWDASR_BIN=".";

OS=`uname`

# Update the dynamic library load path to find ASR and DCTM modules# for each platform.

if [ "$OS" = "AIX" ]then LIBPATH=$LIBPATH:$ASR_BIN export LIBPATHelif [ "$OS" = "HP-UX" ]then SHLIB_PATH=$SHLIB_PATH:$ASR_BIN export SHLIB_PATHelif [ "$OS" = "SunOS" ]then LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ASR_BIN export LD_LIBRARY_PATHelif [ "$OS" = "Linux" ]then LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$ASR_BIN export LD_LIBRARY_PATH



else echo "The operating system '$OS' is not supported. Exiting."; exit 1;fi

# Check environment variables for startup.if [ -z "$DOCUMENTUM" ] || [ ! -d "$DOCUMENTUM" ]then echo "WARNING: StoreInDocumentumDocbase plugin will not work correctly."; echo " DOCUMENTUM environment variable does not exist or "; echo " does not point to a valid directory."; echo "";fi

if [ -z "$DOCUMENTUM_SHARED" ] || [ ! -d "$DOCUMENTUM_SHARED" ]then echo "WARNING: StoreInDocumentumDocbase plugin will not work correctly."; echo " DOCUMENTUM_SHARED environment variable does not exist or "; echo " does not point to a valid directory."; echo "";fi

# Add the ASR_BIN directory to the PATH env. variable for exec() functions.PATH=$ASR_BIN:$PATHexport PATH

echo "Starting ASR Enterprise Processing Server Node...";

asr_ep_server_cp="./asr_ep_server.jar:./asr_ep_server/activation.jar:./asr_ep_server/dbinterface.jar:./asr_ep_server/mail.jar:./asr_ep_server/smtp.jar:./asr_ep_server/asrdomhelpers.jar:./asr_ep_server/derby.jar:./asr_ep_server/mailapi.jar:./asr_ep_server/sqljdbc.jar:./asr_ep_server/asremail.jar:./asr_ep_server/derbyclient.jar:./asr_ep_server/ojdbc5.jar:./asr_ep_server/xalan.jar:./asr_ep_server/asrencoding.jar:./asr_ep_server/derbynet.jar:./asr_ep_server/orai18n.jar:./asr_ep_server/xercesImpl.jar:./asr_ep_server/asrlogging.jar:./asr_ep_server/imap.jar:./asr_ep_server/pop3.jar:./asr_ep_server/xml-apis.jar:./asr_ep_server/asrtampa.jar:./asr_ep_server/jpinterface.jar:./asr_ep_server/resolver.jar:./asr_ep_server/xmlsec.jar:./asr_ep_server/asrutils.jar:./asr_ep_server/log4j-1.2.13.jar:./asr_ep_server/serializer.jar:./asr_ep_server/xsltc.jar"

../jre/bin/java \ -Xmx512M \ -Djava.security.policy=../config/server.policy \ -classpath "${asr_ep_server_cp}:$CLASSPATH" \ com.acartus.apertureone.tampa.server.ProcessingNode \ ../config/${config_file} $@ >&1 &

# Determine the process_id of the background java process just created.asr_ps_node_pid=$!echo "INFO: asr processing server node pid: $asr_ps_node_pid"

# Generate stop_node shell script.echo "#!/bin/sh" > stop_node_${asr_ps_node_pid}.sh;echo "" >> stop_node_${asr_ps_node_pid}.sh;echo "## name of the start script: $(basename $0)" >> stop_node_${asr_ps_node_pid}.sh;echo "## name of the config file: ${config_file}" >> stop_node_${asr_ps_node_pid}.sh;echo "kill -9 $asr_ps_node_pid" >> stop_node_${asr_ps_node_pid}.sh;echo "rm ./stop_node_${asr_ps_node_pid}.sh;" >> stop_node_${asr_ps_node_pid}.sh;

chmod 770 ./stop_node_${asr_ps_node_pid}.sh;

stop_all_nodes.sh and start_all_nodes.sh

In the case where the ASR Enterprise Server is stopped for any reason, and then restarted, the ASR Processing Nodes must also be stopped and restarted. These scripts assist with stopping and restarting the processing nodes on a UNIX system.

New and Replaced Files in ASR bin Directory 53


Note: There are no analogous batch files for use with nodes running on a Windows system, since the Windows command window does not return a command prompt, and this prevents constructing such scripts.

The stop_all_nodes.sh file has the following content:

#!/bin/sh

## Run all the stop_node scripts.

for file in `find . -name "stop_node*.sh"`do echo "calling $file"; ./$file;done

The start_all_nodes.sh file has the following content:

#!/bin/sh

## Run all the start_node* scripts.## Script names need to be match "start_node[digit]*.sh"

for file in `find . -name "start_node[[:digit:]]*.sh"`do echo "calling $file"; $file; sleep 1done

New and Replaced Files in ASR config Directory With ASR release 2.0 and later, in Windows, the default config directory location is:

C:\Program Files\EMC\Documentum_ASR\EnterpriseProcessingServer\config

The new files supplied with the Enterprise Processing Server upgrade are:

◆ a1server.xml

◆ ASRProcessingNodeConfig.xml

◆ ASRProcessingServer_Log.xml (and ASRProcessingServer_Log.properties)

◆ ASRProcessingNode_Log.xml (and ASRProcessingNode_Log.properties)

◆ db_date_formats.txt (and db_date_formats.txt.orig)

◆ dctm_date_formats.txt (and dctm_date_formats.txt.orig)

◆ server.policy

◆ derby.properties

◆ asr_reserved_keys.txt

a1server.xml If you have upgraded from ASR 1.5.x to ASR 2.5, this file replaces the former ASRServer.xml file. If you have upgraded from ASR 1.7.x to ASR 2.5, this file is upgraded.

Notes:


◆ The <Node_list>NODE_NAME</Node_list> entries in this file can be manually edited to name the processing nodes you are using. If this is done, the "Processing Node Status" display in the ASR Enterprise Studio Program will be prepopulated with node names, even before the nodes register with the ASR Enterprise Processing Server.

◆ When adding node names to the <Node_list>NODE_NAME</Node_list> list, it is important to use the same name and case that is used in the nodes config files (copies of the ASRProcessingNodeConfig.xml file -- see the next section in this manual). If there is a case mismatch, then the Studio program (not case sensitive) will treat them as one node, and the Processing Node Status display will be inaccurate.

◆ For details on the elements of the a1server.xml config file, refer to the troubleshooting section of the EMC Documentum Archive Services for Reports Administration Guide.

ASRProcessingNodeConfig.xml

This is the config file for the first server node. You must create one of these for each server node that is established. See “Enterprise Processing Server (EPS) Schema” on page 10 for more information on creating additional processing nodes.

Notes:

◆ The <plugins_dir></plugins_dir> path value should match this same tag in the a1server.xml file.

◆ The <name>NODE_NAME</name> value in this file should match, including case, any <Node_list>NODE_NAME</Node_list> entry for this processing node in the a1server.xml file. If case is a mismatch, then the Server Status display in the studio program will not match the Processing Node Status display. This is especially important on UNIX machines, as the server will treat names like node1 and Node1 as two different nodes, while the Studio program (not case sensitive) will treat them as the same node, and only list one of them.

◆ The <log4j_xml>xxx</log4j_xml> and it’s alternate <log4j_properties>xxx</log4j_properties> elements show the paths to the config files that are used to set up logging for each ASR Processing node. See the next section for more information on the

◆ The <rmi_port>xxx</rmi_port> setting should match the value for this element in the a1server.xml file.

◆ The <server_host>localhost</server_host> setting should be set to the servername or the static IP address of the ASR Enterprise Server.

<?xml version="1.0" encoding="UTF-8"?><configuration> <version>1.0</version> <name>NODE_NAME</name> <rmi_port>2040</rmi_port><plugins_dir>C:/Program Files/EMC/Documentum_ASR/EnterpriseProcessingServer/bin/plugins</plugins_dir> <server_host>localhost</server_host>

New and Replaced Files in ASR config Directory 55

<log4j_xml>../config/ASRProcessingNode_Log.xml</log4j_xml></configuration>

ASRProcessingServer_Log.xml and ASRProcessingServer_Log.properties

This is the default config file for the log4j process logging tool. This .xml file controls how log information is written to the log file at <install_dir>\servers\production\_log\ASRServer.log. The ASRProcessingServer_Log.xml file contains comments within the <! -- xxx --> tags which can be read to understand how to manipulate logging output.

Note: If the ASRProcessingServer_Log.xml file is renamed or removed, then the ASRProcessingServer_Log.properties file is used to control logging output. The .properties file is also commented to describe usage.

Note: The documentation for the log4j logging tools can be found at the following URLs:

http://wiki.apache.org/logging-log4j/http://logging.apache.org/log4j/1.2/publications.html (see links on left)

ASRProcessingNode_Log.xml and ASRProcessingNode_Log.properties

This is the config file that describes the logging setup for the first Processing Node. You must create one of these for each processing node that has been set up. This .xml file controls how log information is written to the log file at <install_dir>\servers\production\_log\ASRProcessingNode.log. The ASRProcessingNode_Log.xml file contains comments within the <! -- xxx --> tags which can be read to understand how to manipulate logging output.

Note: If the ASRProcessingNode_Log.xml file is renamed or removed, then the ASRProcessingNode_Log.properties file is used to control logging output. The .properties file is also commented to describe usage.

db_date_formats.txt and dctm_date_formats.txt

These two files determine the values presented in the date format drop-down menus that you see when completing the logical documents Properties dialog for either a Store in Archive or Store in Documentum task. These text files are editable, so that users can add custom date formats as needed to accomodate their particular reports. These files are not replaced when doing an upgrade to an existing EPS installation.

◆ db_date_formats.txt (and its duplicate db_date_formats.txt.orig). This file controls the date formats available when configuring hybrid Store in Archive and Store in Documentum tasks. The date formats for hybrid storage tasks do not include time valuations. Entries in this file are in uppercase characters.


The db_date_formats.txt.orig file is provided as a reference, in case task developers want to revert a customized date_format file to the default settings.

The separators shown in the file are the slash (/) and the dash (-). Other separators that can be used in these patterns include the period (.), the pipe symbol (|) and the comma (,).

Text of the default db_date_formats.txt is shown below.

# IMPORTANT NOTE: Case-sensitivity is important!## Legend: M = month, D = day, Y = year, # MMM = expanded month, MON = expanded monthM/D/YM/Y/DD/M/YD/Y/MY/D/MY/M/DM-D-YM-Y-DD-M-YD-Y-MY-D-MY-M-DMMDDYYMMYYDDDDMMYYDDYYMMYYDDMMYYMMDDMMDDYYYYMMYYYYDDDDMMYYYYDDYYYYMMYYYYDDMMYYYYMMDDDD-MON-YYDD-MMM-YY

◆ dctm_date_formats.txt (and its duplicate dctm_date_formats.txt.orig). This file controls the date formats available when configuring nonhybrid Store in Documentum tasks. Entries in this file are in lowercase characters.

The dctm_date_formats.txt.orig file is provided as a reference, in case task developers want to revert a customized date_format file to the default settings.

The separators shown in the file are the slash (/) and the dash (-). Other separators that can be used in these patterns include the period (.), the pipe symbol (|) and the comma (,). The colon (:) is used as a separator for the time values.

The Java SimpleDateFormat specifiers can also be used to configure the time of day, if AM/PM distinctions need to be made. Refer to the Java online spec for details. In general, the following specifiers will be useful:

a: AM/PM markerH: Hour in day (0-23)k: Hour in day (1-24)K: Hour in am/pm (0-11)h: Hour in am/pm (1-12)



Using these, 12:45 AM could be enabled as a time by the string

'hh:mm aa'

Text of the default dctm_date_formats.txt file is shown below.

# IMPORTANT NOTE: Case-sensitivity is important!## Legend: mm = month, dd = day, yy = year, # hh = hour, mi = minutes, ss = seconds# mon = expanded month, month = expanded month<default>mm/dd/yymon dd yyyymm/yymm/yyyydd/mm/yydd/mm/yyyymm/yy hh:mi:ssmm/yyyy hh:mi:ssdd/mm/yy hh:mi:ssdd/mm/yyyy hh:mi:ssyy/mmmm/dd/yyyyyyyy/mmyy/mm/ddyyyy/mm/ddyy/mm hh:mi:ssyyyy/mm hh:mi:ssyy/mm/dd hh:mi:ssyyyy/mm/dd hh:mi:ssyyyyyymon-yydd-mon-yymon-yyyyyy hh:mi:ssyyyy hh:mi:ssmon-yy hh:mi:ssmon-yyyy hh:mi:ssmonth yymonth yyyymonth, yymonth, yyyymonth yy hh:mi:ssdd-mon-yyyymonth yyyy hh:mi:ssmonth, yy hh:mi:ssmonth, yyyy hh:mi:ssmm/dd/yy hh:mi:ssmm/dd/yyyy hh:mi:ssmonth dd yymonth dd yyyymonth dd, yymonth dd, yyyymon dd yy

server.policy This file has one line:

grant {permission java.security.AllPermission;};



derby.properties This is the properties file for the built-in database used by ASR 2.5 with EPS, in cases where MS-SQL and Oracle are not made use of.

#Java DB Properties File#Tue Sep 25 14:08:49 MDT 2007derby.drda.startNetworkServer=true

# name and location of the derby log derby.stream.error.file=C:/EMC/Documentum_ASR/servers/production/_log/derby.log

asr_reserved_keys.txtThis is an editable file that defines reserved terms that are not allowed as field names in configuring the Extract Data from PDF 2 plug-in. For details, refer to the Plug-ins chapter of the ASR 2.5 Administration Guide. The following strings are not allowed in field names:

◆ Oracle SQL reserved words (DML, DDL, etc.)

◆ SqlServer 2005 SQL reserved words (DML, DDL, etc.)

◆ Documentum DQL reserved words (at large)

◆ tokens beginning with numbers

◆ SQL special characters (e.g. %, single quotes, double quotes, $, etc.)

◆ spaces


D

This appendix provides instructions for installing Retention Policy Services (RPS) on the Documentum Content Server for use with ASR, and includes the following sections:

◆ Installing RPS on the Documentum Repository............................ 62◆ Operating Environments with ASR................................................. 62◆ Troubleshooting.................................................................................. 65

Installing andConfiguring RPS for Use

with ASR

Installing and Configuring RPS for Use with ASR 61

Installing and Configuring RPS for Use with ASR

Installing RPS on the Documentum RepositoryTo configure RPS on the repository, for use with ASR:

1. At the time of installation of repository, choose to install “Retention Policy Services” and enter the key that you received with your license.

2. Also download the following from http://documentum.subscribenet.com

• Documentum Retention Policy Services Content Server Files for windows

• Documentum Retention Policy Services DocApp

3. On the Content Server host, extract the contents of “Documentum Retention Policy Services Content Server Files for windows” and run rpsServerWinSetup.exe. This installs the files needed for RPS.

4. Using Documentum Application Installer, install the Documentum Retention Policy Services DocApp on the repository.

Operating Environments with ASRASR has been tested with RPS in several Documentum environments.

ASR with DFC 5.3 and 5.3 Content Server

Ingestion of reports into an RPS-enabled folder works fine using a normal installation of DFC 5.3 against an RPS-enabled 5.3 repository. No Global Registry entry is required in the dfc.properties file.

ASR with DFC 6/6.5 and Documentum 6/6.5 Content Server

On the DFC client, Global Registry entry in C:\Documentum\Config\dfc.properties is mandatory; for details refer to “Global Registry settings in dfc.properties file” on page 65. Also, this client must be registered as a "privileged" client in the Global Repository. This can be achieved through Documentum Administrator. The steps are detailed below:

1. Logon to the repository using Documentum Administrator (DA). Click the node "Privileged Clients" on the left side browsertree.



Figure 3 Click "Privileged Clients" on the left pane

2. From the File menu, click "Manage Clients"

Figure 4 Click "Manage Clients" on the file menu

Operating Environments with ASR 63


3. A "Manage Clients" dialog appears. Select the client you want to register as a "privileged client" from the left pane and add it to the right pane by clicking the right arrow. Click OK to close the dialog.

Figure 5 Manage Clients dialog

4. Right click on the client you just added and click "Approve Privilege".

Figure 6 Approving Privilege for selected client



This DFC 6 client is now a "privileged client". ASR is now ready to ingest documents into an RP-enabled folder.

Note: The user creating the documents in the repository, and the user storing the objects in the RP folder, must be in the dmc_rps_contributor role. This can be done through DA on an individual basis, or "dm_world" can be added to this role to allow everyone to store into an RP folder.

ASR with DFC 6 and Documentum 5.3 Content Server

When ASR is run with DFC 6, Global Registry setting in C:\Documentum\Config\dfc.properties is mandatory. Without this, ingestion does not happen. Also, there is no concept of “Privileged Client” here since the repository being used is pre D6. Ingestion into an RP-enabled folder happens when the Global Registry setting is configured in dfc.properties file on the client side (the same system on which ASR is installed).

Global Registry settings in dfc.properties file

When ASR is running on a system with DFC 6 (or greater) installed, the following entries are required in the C:\Documentum\Config\dfc.properties file on both the Content Server and the DFC client running ASR:

dfc.globalregistry.repository=<name of repository config’d as global registry>dfc.globalregistry.username=<usually it is dm_bof_registry>dfc.globalregistry.password=<password of dm_bof_registry user>

At the time of installation of a repository, the user is asked if he wants to configure the repository to be a Global Registry. If he chooses yes, he would be asked to choose a password for dm_bof_registry user. The dfc.properties file on the Content Server will then be updated with these values. The same values need to be copied to the dfc.properties file on the DFC client system where ASR is running.

Note: These global registry settings are required only when ASR is running on a system with DFC 6 or greater, installed.

TroubleshootingWhen ASR is used with DFC 6 or 6.5 ingesting reports into a D6 or 6.5 repository, the “Privileged Client” configuration in Documentum Administrator is mandatory. If the DFC client is not registered as a “privileged client”, the following error is seen:

Error applying retention policy to object : DfException:: THREAD: http-8080-8; MSG: [DM_SESSION_E_SETUP_ROLES_FOR_RPC]error: "Error initializing dynamic roles for RPC SysObjFullFetch (0b1999be800008ba)."; ERRORCODE: 100; NEXT: DfException:: THREAD: http-8080-8; MSG: [DM_GROUP_E_PROTECTED_ROLE_UNKNOWN_CLIENT]error: "The requested role (dmc_rps_escalated_retusr) is marked protected and the requesting application was either not known in this docbase's dm_client_rights table or its credentials did not match those in the dm_client_rights table."; ERRORCODE: 100; NEXT: null____DfException:: THREAD: http-8080-8; MSG: [DM_SESSION_E_SETUP_ROLES_FOR_RPC]error: "Error initializing dynamic roles for RPC SysObjFullFetch (0b1999be800008ba)."; ERRORCODE: 100; NEXT: DfException:: THREAD: http-8080-8; MSG: [DM_GROUP_E_PROTECTED_ROLE_UNKNOWN_CLIENT]error: "The requested role (dmc_rps_escalated_retusr) is marked protected and the requesting application was either not known in this docbase's dm_client_rights table or its credentials did not match those in the dm_client_rights table."; ERRORCODE: 100; NEXT: null

Troubleshooting 65


To resolve this issue, register the client as a “privileged client”.

The user creating the documents in the repository, and the user storing the objects in the RP folder, must be in the dmc_rps_contributor role. This can be done through DA on an individual basis, or "dm_world" can be added to this role to allow everyone to store into an RP folder.
