xpression Documentum Edition Installation Guide Version 3.5

Transcription

1 xpression Documentum Edition Installation Guide Version 3.5

2 EMC Corporation, Hopkinton, MA Copyright EMC Corporation. All rights reserved. The copyright protection claimed includes all formats of copyrightable material and information governed by current or future statutory or judicial law. This includes, without limitations, any material generated by the software programs that display icons or other screen interfaces. You may not copy or transmit any part of this document in electronic or printed format without the express written permission of EMC Corporation. xpression, CompuSet, and all other EMC Corporation products mentioned in this publication are trademarks of EMC Corporation. For complete copyright information, please see the file xpression Licensing Document.pdf located on your ebook Library CD.

3 TABLE OF CONTENTS 1 Before You Begin... 3 Information Boxes and Revision Bars... 3 Solution Support Getting Started... 5 What is the xpression Documentum Edition Server?... 5 Installation Overview... 5 Deployment Notes... 6 Clustered Documentum Installations... 6 Multiple Docbrokers... 6 Multiple Docbases... 6 Your Documentum Edition Repository... 6 Additional Information... 6 Integration with Documentum Workflow... 6 Location of Log Files... 7 Software and Hardware Requirements... 7 Supported Data Types Connecting to Documentum Client Applications... 9 Modify checkoutcontainer_component.xml... 9 Modify editcontainer_component.xml Modify viewcontainer_component.xml Modify Entitlement.properties Deploy SSO-xpression.jar File Step One: Obtaining Your Server License Keys Installation Checklist Step Two: Prepare Your Server Prepare the Apache Tomcat Server Prepare the JBoss Server Accessing Server on JBoss with an IP Address Prepare the Sun Java System Server Prepare the Weblogic Server Prepare the WebSphere Server Update JAR Files Installation Checklist Step Three: Deploying the Documentum Edition DAR File Installation Checklist Step Four: Set Up xprs Home... 21

4 Table of Contents Extract xprs_de_home.zip Set Up xprs Environment Variables on Linux Set Up xprs Environment Variables on Windows Installation Checklist Step Five: Configure Server Set Apache Tomcat Variable and Classpath Set JBoss Variables and Classpath Update Classpath Set JBoss Variables on Windows Set JBoss Variables on Linux Set Sun Java System AS Variable and Classpath Set WebLogic Variable and Classpath WebSphere Settings Installation Checklist Step Six: Deploy Documentum Edition WAR File Deploying on Apache Tomcat Deploying on JBoss Deploying on Sun Java System AS Deploying on WebLogic Deploying on WebSphere Deploying the DE_Server.war File Configuring the Application Installation Checklist Step Seven: Configure Properties Installation Checklist Step Eight: Verify Your Installation Installation Checklist Assigning Users and Roles Users Roles Adding Users to the xpression_admin Role Adding Users to the xpression_designer Role Adding Users to the xpression_dashboard Role Upgrading Documentum Edition Updating Your License Upgrading the Server Replacing the WAR file on JBoss Replacing the WAR file on the Sun Java System Server Replacing the WAR file on WebLogic Replacing the WAR file on WebSphere Deploying the Sample Application Deploying the Sample Application Using the Sample Application... 41

5 Befor ore You Begin 1 Before You Begin Welcome to the xpression Documentum Edition Server! This book contains complete instructions for installing and configuring the Documentum Edition of the xpression Server. This chapter contains information you need to know before you begin installing the xpression Documentum Edition Server software. Information Boxes and Revision Bars When one of the following boxes appear on a page, it alerts you to special information. CAUTION The caution box warns you that a fatal error, unsatisfactory output, or loss of data may occur if you do not follow directions carefully. Tip A tip offers suggestions to simplify a task or describes a useful shortcut. They may also describe an alternate way to use the techniques described in the text. Note A note offers information that emphasizes or supplements important points of the main text. Revision bars help you locate new or changed information. Look for these revision bars in the right margin of each affected page. Solution Support For more information or to solve a problem, you can contact EMC Document Sciences Solution Support in one of the following ways: Telephone (760) Fax (760) World Wide Web support@docscience.com 3

6 Chapter 1 Before You Begin 4

7 Getting Started ted 2 Getting Started This chapter will introduce you to the Documentum Edition Server and provide an overview of the installation process. What is the xpression Documentum Edition Server? The xpression Documentum Edition Server is part of the xpression product suite, and is tightly integrated with EMC Documentum by using Documentum as the repository for xpression. The Documentum Edition of the server enables you to: Publish xpresso documents Store, version, check in/out xpresso templates in Documentum using Documentum versioning Store Markers, XML Data, XSDs, Variable Lists, and Document Property Lists within Documentum Use external content from Documentum on a full-page and subpage basis Use the Documentum Process Suite to create a workflow for xpresso template approval The xpression Documentum Edition Server also contains the following server-based web components: xadmin. A Web-based administrative utility that enables you to configure and monitor all the functions of the xpression Documentum Edition Server, as well as define document and output management components for use during publishing. xdashboard. A Web-based administrative utility that enables you to create and maintain jobs, and perform high-volume publishing tasks. Installation Overview This section will provide you with an overview of the xpression Documentum Edition Server installation process, and includes a checklist to help guide you through the process and ensure that you don t miss any steps. Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 5

8 Chapter 2 Getting Started After installing Documentum Edition, there are several additional configuration changes you may need to implement. These additional steps are not required. Assigning Users and Roles Upgrading Documentum Edition Connecting to Documentum Client Applications Deploying the Sample Application Deployment Notes The following notes contain important information about your deployment. Clustered Documentum Installations xpression Documentum Edition supports clustered Documentum installations. Multiple Docbrokers xpression Documentum Edition supports the use of multiple docbrokers. Please refer to the dfc.properties file in your xprs Home directory. The following example demonstrates how you can configure multiple docbrokers in the dfc.properties file. dfc.docbroker.host[0]=host1 dfc.docbroker.port[0]=1489 dfc.docbroker.host[1]=host2 dfc.docbroker.port[1]=1489 Multiple Docbases xpression Documentum Edition supports multiple docbases through the ECM Configuration feature in xadmin. The ECM Configuration feature enables you to retrieve external resources such as customer data, schema, and images. The ECM Configuration is able to use any of the docbases registered in these docbrokers. There is no limitation to the number of ECM Configurations you can create. Your Documentum Edition Repository Although you can have multiple docbases, only one docbase can be configured as the central repository for Documentum Edition content. To define the repository, you must deploy the xprs.dar file to the docbase and also define that docbase in the app.properties file located in the xprs Home directory. Additional Information Please review the following topics before starting your installation. Integration with Documentum Workflow When the Documentum Edition DAR file is deployed to the target docbase, two Documentum Edition activity templates are installed and made available to Documentum Process Builder. The activity templates can be used in a Process Builder process to connect to the Documentum Edition server, select a Documentum Edition document from the docbase, select an output profile, and map document variables to process data. When running a process in Taskspace, the document can be published back to the workflow or other outlets depending on the output profile definition. 6

9 Location of Log Files Chapter 2 Getting Started When installing and configuring xpression Documentum Edition, you may need to view various log files to troubleshoot a problem or verify that a component is working correctly. The following list contains the locations of several log files that you may find useful. Tomcat Log: <Tomcat_Home>\logs Documentum Edition Server Log: The location of this log file is set in xadmin in the System Management section. The default location is: <xprs_home>\log. WebSphere Logs: <WebSphere_install_dir>\AppServer\profiles\AppSrv01\logs\server1 JBoss Log: <JBoss_install_dir>\jboss-as\server\production\log WebLogic Log: <WebLogic_install_dir>\user_projects\domains\xprs_domain\servers\AdminServer\logs Sun Java System AS: <Sun_Java_install_dir>\Sun\AppServer\domains\<domain_name>\logs Software and Hardware Requirements The xpression Documentum Edition Server has specific requirements for each platform and application server supported. For a list of hardware and software requirements, please see the xpression Operating Requirements document located at the root of the xpression ebooks CD. Supported Data Types The xpression Documentum Edition Server supports industry standard XML data sources and XSD data schemes for your variable data input. Your variable records can all be contained in a single XML file or broken out into separate XML files. Each of your XML files for a particular document must be compatible with the schema used to create the document. With this release, the xpression Documentum Edition Server supports the following data types: String, Boolean (true/false), DateTime, Date (format: YYYY-MM-DD), Time, Integer, Double, and Float. 7

10 Chapter 2 Getting Started 8

11 Connecting to Documentum Client Applications 3 Connecting to Documentum Client Applications Documentum Edition xpresso clients support Single-Sign-On (SSO) with Documentum web applications, such as, Webtop, Documentum Administrator, and Taskspace. This enables you to switch between applications without performing additional log-ins for each application. For example, if you check out a template from Webtop and launch an xpresso client to view or edit it, the SSO package will enable you to access the client without performing an additional log-in. To use this feature, you must install the Documentum Edition SSO package to each web application. For each application, perform the following steps: Modify checkoutcontainer_component.xml Modify editcontainer_component.xml Modify viewcontainer_component.xml Modify Entitlement.properties Deploy SSO-xpression.jar File Modify checkoutcontainer_component.xml To modify the checkoutcontainer_component.xml file, complete the following steps: 1. Open checkoutcontainer_component.xml from the following path in your Documentum client installation directory: \webcomponent\config\library\contenttransfer\checkout\ 2. Add the following text to the checkoutcontainer_component.xml file: <!--Modify the base checkoutcontainer component configuration for xpresso--> <scope entitlement="pkg" clientenv="not appintg"> <component modifies="checkoutcontainer:webcomponent/config/library/ contenttransfer/checkout/checkoutcontainer_component.xml"> <!--insert the xpresso post processor to the WDK component --> <insertafter path= service.transport-class > <post-processor-class> com.documentum.webcomponent.library.contenttransfer.checkout. xpressocheckoutprocessor </post-processor-class> </insertafter> </component> </scope> 3. Save and close the file. 9

12 Modify editcontainer_component.xml Chapter 3 Connecting to Documentum Client Applications To modify the editcontainer_component.xml file, complete the following steps in your Documentum client installation directory: 1. Open editcontainer_component.xml from the following path: \webcomponent\config\library\contenttransfer\edit\ 2. Add the following text to the editcontainer_component.xml file: <!--Modify the base editcontainer component configuration for xpresso--> <scope type="dm_sysobject" entitlement="pkg" clientenv="not appintg"> <component modifies="editcontainer:webcomponent/config/library/ contenttransfer/edit/editcontainer_component.xml"> <!--insert the xpresso post processor to the WDK component --> <replace path= service.post-processor-class > <post-processor-class> com.documentum.webcomponent.library.contenttransfer.edit. xpressolauncheditor </post-processor-class> </replace> </component> </scope> 3. Save and close the file. Modify viewcontainer_component.xml To modify the Viewcontainer_component.xml file, complete the following steps in your Documentum client installation directory: 1. Open viewcontainer_component.xml from the following path: \webcomponent\config\library\contenttransfer\view\ 2. Add the following text to the editcontainer_component.xml file: <scope type="dm_sysobject" entitlement="pkg" clientenv="not appintg"> <component modifies="viewcontainer:webcomponent/config/library/ contenttransfer/view/viewcontainer_component.xml"> <!-- replace the xpresso post processor to the WDK component --> <replace path= service.post-processor-class > <post-processor-class> com.documentum.webcomponent.library.contenttransfer. view.xpressolaunchviewer </post-processor-class> </replace> </component> </scope> 3. Save and close the file. Modify Entitlement.properties To modify the Entitlement.properties file, complete the following steps in your Documentum client installation directory: 1. Open Entitlement.properties from the following path: \WEB-INF\classes\com\documentum\web\formext\config\ 2. The file should contain a number of lines that begin with entitlement_service followed by a number. The numbers should start at one and increment for each entitlement_service. 10

13 For example: Chapter 3 Connecting to Documentum Client Applications entitlement_service.1=com.documentum.web.formext.config.rpsentitlementservice entitlement_service.2=com.documentum.web.common.collaborationservice$entitlement 3. Add a new line after the last entitlement_service line. 4. On the new line, type the following text: entitlement_service.x= Where x is the next number in the sequence. For example, if the highest number in the list is three, use the number four. 5. On the new line, type the following text after the equals (=) sign: com.documentum.web.formext.config.xpressoentitlementservice The entire line should look like this: entitlement_service.x=com.documentum.web.formext.config.xpressoentitlementservice Where x is the highest number in the sequence. 6. Save and close the file. Deploy SSO-xpression.jar File To deploy the SSO-xpression.jar file, complete the following steps: 1. Locate the SSO-xpression.jar file located in your installation package. 2. Copy the SSO-xpression.jar file to the \WEB-INF\lib folder for your Documentum web application. 11

14 Chapter 3 Connecting to Documentum Client Applications 12

15 Step One: Obtaining Your Server License Keys 4 Step One: Obtaining Your Server License Keys EMC Document Sciences Customer Care provides the license key files necessary to install and use the xpression Documentum Edition Server. You ll need a license key file for each of your xpression Documentum Edition Server installations. You can contact Customer Care in the following ways: Phone: customercare@docscience.com (760) (press 2 to be connected directly to Customer Care) To obtain your xpression Documentum Edition Server license key file, you simply need to request it from EMC Document Sciences Customer Care. You don t need the license key file to install the xpression Documentum Edition Server, but you will need it before you can use the server. The first time you access xadmin, you will be asked for the license key file, and will not be able to complete any tasks until you provide it. For more information, see. Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 13

16 Chapter 4 Step One: Obtaining Your Server License Keys 14

17 Step Two: Prepar epare Your Server 5 Step Two: Prepare Your Server Before you begin deploying xpression Documentum Edition, you must first prepare your server. Each server type has a different set of instructions and requirements. Please view the section for your application server type. Prepare the Apache Tomcat Server Prepare the JBoss Server Prepare the Sun Java System Server Prepare the Weblogic Server Prepare the WebSphere Server Prepare the Apache Tomcat Server For an Apache Tomcat server, simply perform a default installation of Apache Tomcat. In later steps, you will make some changes to the Apache Tomcat java classpath and java options. After installing your server, proceed to Step Three: Deploying the Documentum Edition DAR File. Prepare the JBoss Server For a JBoss server, simply perform a default installation of JBoss. In later steps, you will make some changes to the JBoss configuration by adding a variable and updating the classpath. After installing your server, proceed to Step Three: Deploying the Documentum Edition DAR File. Accessing Server on JBoss with an IP Address By default, JBoss is unable to access the server using an IP address. To access the server using an IP address, please update your configuration using one of the following three methods: Start the server with the following command: run -b <ip_address> Where <ip_address> is a specific IP address that you want to use. Start the server with the following command: run -b This will start the server for all IP addresses binding to the host. Modify the server.xml file in the /deploy/jboss-web.deployer sub-directory. Find the following text: <connector port="8080" address="$(jboss.bind.address)" Change the address value to a specific IP address or to for all IP addresses binding to the host. 15

18 Chapter 5 Step Two: Prepare Your Server Prepare the Sun Java System Server To install the Sun Java System Server, complete the following steps: 1. Start the Sun Java System Application Server Installation Wizard. At the Welcome page, click Next. 2. At the Software License Agreements3 page, select Yes and click Next. 3. At the Select Installation Directory page, define the installation directory and click Next. If the directory does not exist, the wizard will ask if you want to create the new directory or select a new directory. 4. At the Java 2 SDK Location page, define the path to your Java SDK location. Please ensure you are using a supported version. For complete and updated information, see the Operating Requirements document on your ebook CD or in your downloaded documentation package. Click Next when finished. 5. At the Admin Configuration page, define a user name and password that will serve as the admin account for the Sun Java System Application Server. Also, ensure you select the Prompt for Admin User Name and Password option. Finally, notice the Admin Port and HTTP Port boxes. The values in these boxes are the default port numbers. You can use the default port numbers or define a different port number. Please record the port number for future reference. Click Next. 6. At the Registration Options page, you can sign up for a Sun Online Account, login with your account information, or Skip Registration. Click Next. 7. Click Finish to complete the installation process. 8. From the Windows Start menu, start the xpression Documentum Edition server. 9. After the server starts, open the Sun Java System Application Server Admin Console from the Windows Start menu. After installing your server, proceed to Step Three: Deploying the Documentum Edition DAR File. Prepare the Weblogic Server For a Weblogic server, simply perform a default installation and create a new domain for xpression Documentum Edition. To create a new domain, complete the following steps: 1. Start the BEA Weblogic installation wizard. 2. Select Create new Weblogic domain and click Next. 3. Select Generate a domain configured automatically to support the following BEA products. Do not select Workshop for WebLogic Platform. Click Next. 4. Supply a user name and password for the default administrative user. 5. The Configure Server Start Mode and JDK page appears. Select Development Mode and Sun SDK 1.5.0_11. Click Next. 6. The Do you want to customize any of the following options? page appears. Select No and click Next. 7. The Create WebLogic Domain page appears. Supply a name location for the domain, and click Create. In later steps, you will make some changes to the server configuration. After installing your server, proceed to Step Three: Deploying the Documentum Edition DAR File. Prepare the WebSphere Server For a WebSphere server, simply perform a default installation and then start the server from the Windows Start Menu. In this step, you will make one adjustment to your default WebSphere installation. In later steps, you will make additional changes to the server configuration. After completing this step, proceed to Step Three: Deploying the Documentum Edition DAR File. 16

19 Update JAR Files Chapter 5 Step Two: Prepare Your Server Due to a bug in the default WebSphere 7 deployment, you must update two JAR files. If you fail to perform this step, you will see a WebService error when using Documentum Edition. Complete the following steps: 1. Navigate to the following directory on your server: <server_installation_dir>\de_server\webcontent\web-inf\lib where <server_installation_dir> is the directory where you installed the DE Server. 2. Locate the following JAR files: woden-api-1.0m8.jar woden-impl-dom-1.0m8.jar 3. Copy the two JAR files to the following directory on your server machine: <WebSphere_install_dir>\AppServer\plugins 4. Open the following JAR file: <WebSphere_install_dir>\AppServer\plugins\org.apache.axis2.jar 5. In the org.apache.axis2.jar file, open the META-INF folder, and open MENIFEST.MF for editing 6. In the MENIFEST.MF file, locate the following section: Import-Package:. 7. If the last line in the section does not end with a comma (,), place a comma at the end of the last line. 8. Create a new line at the end of the Import Package section and type the following text: org.apache.woden.resolver 9. Save and close the file. Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 17

20 Chapter 5 Step Two: Prepare Your Server 18

21 Step Three: Deploying the Documentum Edition DAR File 6 Step Three: Deploying the Documentum Edition DAR File In this step, you must deploy the Documentum Edition DAR file using the Documentum Composer DAR Installer. Please see the Operating Requirements for complete details about which versions of the DAR Installer are supported by xpression. The Documentum Edition DAR file is named XPRS.dar and is located in the xprs_de_dar folder on your installation CD or in your downloaded installation package. This file will be deployed to a docbase, making that docbase the central repository for the storage of Documentum Edition content. To deploy the DAR file, complete the following steps: 1. Start the Documentum Composer DAR Installer. The DAR installer is located in your composer directory, the same directory that contains eclipse.exe. By default, this directory is \\<DCTM_install_dir>\product\6.5\install\composer\</DCTM_install_dir> 2. Run the DAR installer. The DAR Installer page appears. 3. In the *DAR box, supply the full path and file name of the XPRS.dar file. 4. Locate the Docbroker Details section. In the *Docbroker Host drop-down box, select the name of the docbroker host. If no names appear in the list, please type the name of your Docbroker Host or Connection Broker. 5. In the *Docbroker Port box appears, type the port number. By default, this number is Click Connect. 7. Locate the Repository Details section. In the *Repository drop-down box, select the name of the repository. 8. In the User Name box, type the user name for the repository. 9. In the Password box, type the password for the user name. 10. Click the Install button. 11. The DAR Installer will deploy the DAR file and display a success message when complete. Click Close to close the DAR Installer. If you receive and error, ensure you are using a supported version of the DAR Installer. Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 19

22 Chapter 6 Step Three: Deploying the Documentum Edition DAR File 20

23 Step Four: Set Up xprs Home 7 Step Four: Set Up xprs Home In this step, you must deploy the xprs Home directory and then record the path for that directory in several places on your system. Extract xprs_de_home.zip To set up xprs home, complete the following steps: 1. First, locate the xprs_de_home folder on your installation CD or in your downloaded installation package. 2. In that folder you will find xprs_de_home.zip. Unzip this file to the directory that you want to serve as the xprs DE Home directory. For this set of instructions, we will assume you are deploying to the C:\ drive of a Windows machine, which means your xprs DE Home directory will be C:\xPRS_DE_Home\. Set Up xprs Environment Variables on Linux Next, setup an environment variable for the xprs DE Home directory. For Linux, complete the following steps: 1. Open the profile file located in your /etc/ directory. 2. Add the following text to the file: # Java develop JAVA_HOME=<java_jdk_path> PATH=$JAVA_HOME/bin:$PATH CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar export JAVA_HOME export PATH export CLASSPATH Where <java_jdk_path> is the location where you installed the Java environment. For example: /opt/jdk1.5.0_06 3. Save the file. 4. Open the setclasspath.sh file from your apache tomcat /bin directory. For example: /opt/apache-tomcat /bin/ 5. Add the following text to the file: # Clear user classpath CLASSPATH=$CLASSPATH:<xPRS_DE_Home>/config JAVA_OPTS="-Xms256m -Xmx512m -DXPRS_HOME=<xPRS_DE_Home>" Where <xprs_de_home> is the location where you extracted the xprs_de_home.zip file in the last step. 6. Save the file. 21

24 Set Up xprs Environment Variables on Windows Chapter 7 Step Four: Set Up xprs Home Next, setup an environment variable for the xprs DE Home directory. For Windows, complete the following steps: 1. Right-click the My Computer icon and click Properties. 2. Click the Advanced tab. 3. Click the Environment Variables button. 4. Under System Variables, click New. 5. In the Variable Name box, type XPRS_HOME. 6. In the Variable Value box, type the path to the xprs DE Home directory you created. For example, C:\xPRS_DE_Home. 7. Click OK. Click OK two more times to close the remaining windows. Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 22

25 Step Five: Configure Server 8 Step Five: Configure Server Each server uses different configuration instructions. Please use the instructions for your application server. Set Apache Tomcat Variable and Classpath Set JBoss Variables and Classpath Set Sun Java System AS Variable and Classpath Set WebLogic Variable and Classpath WebSphere Settings Set Apache Tomcat Variable and Classpath In this step, you must define a variable with the path to the DE_Home directory you created in a previous step. You must also add a path to the server classpath.complete the following steps: 1. To access the Apache Tomcat Properties on Windows, right-click the Apache Tomcat icon in the system tray and select Configure. 2. Click the Java tab. 3. In the Java Options box, type the following text on a new line: DXPRS_HOME= Where <xprs_de_home> is the path to the xprs DE Home directory you created. 4. In the Java Classpath box, type the path to the /config subdirectory of the xprs DE Home directory you created. This step provides Tomcat with the location of dfc.properties and app.properties. You will configure these files in a later step. For example: On Windows: C:\xPRS_DE_Home\config On Linux: /opt/xprs_de_home/config 5. Click OK. Set JBoss Variables and Classpath You must create a user variable for your JBoss installation and a system variable for your Java environment. 23

26 Update Classpath 1. Locate the run.bat file from the application server /bin directory. Open this file for editing. 2. Locate the following line: Chapter 8 Step Five: Configure Server set JBOSS_CLASSPATH= To the end of this value, add the path to the xprs DE Home /config directory. Ensure you precede the path with a semicolon. For example: ;C:\xPRS_DE_Home\config 3. Next, locate the following line: set JAVA_OPTS= To the end of this value, add the path to the xprs Home directory. Ensure you precede the path with a semicolon. Add the following text to the end of the value. -DXPRS_HOME=<xPRS_DE_Home> Where <xprs_de_home> is the directory where you deployed the xprs_de_home.zip file. 4. Save and close run.bat. Set JBoss Variables on Windows 1. Right-click My Computer and select Properties. 2. Click the Advanced tab. 3. Click the Environment Variables button. 4. In the User Variables section, please determine if a JBOSS_HOME variable already exists. This variable should point to the JBoss installation directory. If it does not exist, click New. 5. In the Variable name box, type: JBOSS_HOME 6. In the Variable value box, type the path to your JBoss installation. For example: C:\JBoss 7. Click OK. 8. In the System Variables section, click New. 9. In the Variable name box, type: JAVA_HOME 10. In the Variable value box, type the path to the directory where you installed the JAVA JDK. For example: C:\Program Files\Java\jdk1.6.0_ Click OK. 12. Continue clicking OK to exit the Environment Variables and My Computer pages. Set JBoss Variables on Linux 1. Open the profile file located in your /etc/ directory. 2. Add the following text to the file: # JBOSS HOME JBOSS_HOME=<jboss_install_path> export JBOSS_HOME Where <jboss_install_path> is the location where you installed JBoss. For example: /opt/jboss 3. Save the file. 24

27 Set Sun Java System AS Variable and Classpath To modify the Sun Java System AS classpath settings, complete the following steps: 1. Start the Server. 2. Next, open the Admin console. 3. Supply a valid user name and password for the server. 4. In the Common Tasks pane, click Application Server. 5. In the Application Server pane, click the JVM Settings tab. 6. In the second tab window, click Path Settings. Chapter 8 Step Five: Configure Server 7. In the Server Classpath box, type the path to your xprs Home /config directory. For example: C:\xPRS_DE_Home\config 8. Save your changes. Set WebLogic Variable and Classpath To set server variables and the server classpath, complete the following steps: 1. Locate the folder for the Weblogic domain you created. Open the /bin subdirectory. 2. Open the startweblogic.cmd file for editing. 3. On an empty line, type the following text which creates a server variable: set DE_CLASSPATH= 4. Next, type the path to the xprs Home /config directory after the equal sign (=). For example, the entire line should resemble the following: set DE_CLASSPATH=<xPRS_DE_Home>\config Where <xprs_de_home> is the directory where you deployed the xprs_de_home.zip file. 25

28 Chapter 8 Step Five: Configure Server 5. Next, locate the following line: set CLASSPATH= 6. At the end of the line, add the following text. It is the variable you created in step 3. ;%DE_CLASSPATH% 7. Finally, locate the following line: set JAVA_OPTIONS= 8. Add the following text to the end of the line. -DXPRS_HOME= 9. After the equal sign (=), add the path to your xprs Home directory. For example: -DXPRS_HOME=<xPRS_DE_Home> Where <xprs_de_home> is the directory where you deployed the xprs_de_home.zip file. 10. Save and close the file. WebSphere Settings The WebSphere settings cannot be defined until after the WAR file is deployed. Please proceed to Deploying on WebSphere. Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 26

29 Step Six: Deploy Documentum Edition WAR File 9 Step Six: Deploy Documentum Edition WAR File In this step, you must deploy the Documentum Edition WAR file on your server. Please use the instructions for your application server. Deploying on Apache Tomcat Deploying on JBoss Deploying on Sun Java System AS Deploying on WebLogic Deploying on WebSphere Deploying on Apache Tomcat These instructions will describe how to statically deploy the WAR file, but you may use any valid method for deploying WAR files on your server. See your server documentation for more information. 1. First, stop the application server. 2. Next, locate your Tomcat appbase. By default, the appbase is located at: $CATALINA_HOME/webapps. 3. The Documentum Edition WAR file is named DE_Server.war. It is located in the xprs_de_war folder on your installation CD or in your downloaded installation package. Copy the DE_Server.war file to your appbase. 4. Restart the Tomcat server. Deploying on JBoss These instructions will describe how to deploy the WAR file while the server is still running, but you may use any valid method for deploying WAR files on your server. See your server documentation for more information. 1. Locate the JBoss deployment directory for your server. For these instructions, we will use: <JBoss_install_dir>\default\deploy\ 2. The Documentum Edition WAR file is named DE_Server.war. It is located in the xprs_de_war folder on your installation CD or in your downloaded installation package. Copy the DE_Server.war file to your deployment directory. 3. JBoss will auto-deploy the WAR file. 27

30 Deploying on Sun Java System AS To deploy the DE_Server.war file, complete the following steps: 1. Start the Server. Chapter 9 Step Six: Deploy Documentum Edition WAR File 2. Next, open the Admin console and supply a valid user name and password for the server. 3. In the Common Tasks pane, expand the Applications folder and click Web Applications. 4. On the Web Applications page, click Deploy. 5. Deploy the DE_Server.war file. It is located in the xprs_de_war folder on your installation CD or in your downloaded installation package. Browse to this location and click OK. Deploying on WebLogic To deploy the DE_Server.war file, complete the following steps. 1. Navigate to the Weblogic domain directory for the Documentum Edition Server. 2. Open the autodeploy directory. 3. Locate the DE_Server.war file. It is located in the xprs_de_war folder on your installation CD or in your downloaded installation package. Copy DE_Server.war to the autodeploy directory. Deploying on WebSphere In this section, we will deploy the DE_Server.war file and configure the application on the server. Deploying the DE_Server.war File To deploy the DE_Server.war file, complete the following steps: 1. Start the xpression Server and log in. 2. In the left console pane, expand the Applications item. 3. Click New Application. 4. In the right console pane, click New Enterprise Application. 5. Determine the location of the DE_Server.war file. It is located in the xprs_de_war folder on your installation CD or in your downloaded installation package. If you have copied it to your locale file system, select Local File System. If you have copied it to a remote file system, select Remote File System. Click Browse and navigate to the DE_Server.war file. Click Next. 6. The Preparing for the application installation step appears. Select the Fast Path option and click Next. 7. The Select installation options step appears. Leave all options at their default values and click Next. 8. The Map modules to servers step appears. Select the DE_Server_guide.war module and click Next. 9. The Map virtual hosts for Web modules step appears. Leave all options at their default values and click Next. 10. The Map context roots for Web modules step appears. For the DE_Server_guide.war module, type the following text in the Context Root box: /DE_Server 11. The Summary step appears. Click Finish. 12. Save your changes to the master configuration. 28

31 Configuring the Application To set the WebSphere 7 classpath, complete the following steps: 1. In the left console pane, expand the Servers item. 2. Expand the Server Types item. 3. Click WebSphere application servers. Chapter 9 Step Six: Deploy Documentum Edition WAR File 4. In the right console pane, locate the table that contains links for each of your applications. Click the link for Documentum Edition application. 5. Scroll down and locate the Server Infrastructure section on the right side of the page. In the Server Infrastructure section, expand the Java and Process Management item. 6. Click Process Definition. 7. In the Additional Properties section, click Java Virtual Machine. 8. In the Classpath box, type the path to the xprs Home /config directory. For example: C:\<xPRS_DE_Home>\config Where <xprs_de_home> is the directory where you extracted the xprs_de_home.zip file. 9. Click OK. 10. Save your changes. 11. Next, click Virtual Hosts, click default host, and click Host Aliases. 12. View the first port number in the list. This is the port number for your server. For these instructions, we will use Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 29

32 Chapter 9 Step Six: Deploy Documentum Edition WAR File 30

33 Step Seven: en: Configure Proper operties 10 Step Seven: Configure Properties In this step, you must configure your properties files to define connection information for your docbase, which serves as the repository for xpression. 1. First, navigate to the /config directory located in your xprs DE Home directory. You will find two properties files: dfc.properties and app.properties. 2. Open dfc.properties for editing. 3. On the appropriate lines, supply the name of your docbroker host, docbroker port, repository (docbase) name, and the administrative username and password for your docbase. Your file should resemble the following example: dfc.docbroker.host[0]=docbrokerhostname dfc.docbroker.port[0]=1489 dfc.globalregistry.repository=docbasename dfc.globalregistry.username=docbaseadmin dfc.globalregistry.password=password dfc.diagnostics.resources.enable=false 4. Save dfc.properties. 5. Open app.properties for editing. 6. Supply the name of your repository on the following line: repository= 7. Save app.properties. Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 31

34 Chapter 10 Step Seven: Configure Properties 32

35 Step Eight: Verify Your Installation tion 11 Step Eight: Verify Your Installation Next, complete the following steps to ensure your software installed properly. 1. Start your server. 2. Open the following URL in Internet Explorer: Where <server> is the name or IP address of the server that hosts xpression Documentum Edition, and <portnumber> is the port number of the server. The default port number for JBoss and the Sun Java System is The default port number for Weblogic is For WebSphere, we will use the default port number of Your port number may be different. 3. When prompted, supply the username and password of a Documentum user that has been assigned the xpression_admin role. 4. Unless you have previously licensed the software, the license page will appear. Click Browse to locate and select the license key file (license.xml) and click OK 5. Click Save. 6. Next, set up the default file paths on the System Management Configuration page. This page identifies the default folder for log files, images, output, temp files, and a variety of fonts. Please specify existing directories and click Save. 7. You should now be able to navigate through the xadmin menus. 8. Next, open the following URL in Internet Explorer: Open the following URL in Internet Explorer: Where <server> is the name or IP address of the server that hosts xpression Documentum Edition, and <portnumber> is the port number of the server. The default port number for JBoss and the Sun Java System is The default port number for Weblogic is For WebSphere, we will use the default port number of Your port number may be different. 9. Should now be able to navigate through the xdashboard menus. 33

36 Chapter 11 Step Eight: Verify Your Installation Installation Checklist Step One: Obtaining Your Server License Keys Step Two: Prepare Your Server Step Three: Deploying the Documentum Edition DAR File Step Four: Set Up xprs Home Step Five: Configure Server Step Six: Deploy Documentum Edition WAR File Step Seven: Configure Properties Step Eight: Verify Your Installation 34

37 Assigning Users and Roles 12 Assigning Users and Roles The Access Control List (ACL) for Documentum Edition must be configured through a Documentum client that has the capability of user management. Both Documentum Webtop and Documentum Administrator have the capability of managing user privileges. One of them is required to initialize the Documentum Edition ACL environment. After installing and verifying your installation, you can add users and assign them to predefined roles for the xpression Documentum Edition Server. All Documentum Edition users must be authenticated through Documentum, no other authentication mechanisms are supported. Users Users are authenticated through Documentum. To add users, simply create new user accounts through the Documentum administrative facilities like Webtop. All xpression Documentum Edition users must have the User Source option set to Inline Password. Once your users are created, you can make them eligible for xpression Documentum Edition by assigning to them one of the three xpression roles. Users may be assigned to more than one role. Roles After installing Documentum Edition, there will be three new roles available in Documentum: xpression_admin, xpression_designer, and xpression_dashboard. The xpression_admin role enables users to log in to xadmin. The xpression_designer role enables users to use their design client applications to connect to the server in online mode. The xpression_dashboard role enables users to log in to xdashboard To verify and view the new xpression roles, complete the following steps. 1. Ensure the xpression Documentum Edition Server is installed correctly. 2. Log in to Documentum Webtop using Administrator privileges. 3. Expand the Administration item in the left pane. 4. Expand the User Management item in the left pane. 5. Click the Roles item in the left pane. 6. In the right pane, notice that all three new xpression roles appear in the list. 35

38 Adding Users to the xpression_admin Role To assign users to the xpression_admin role, complete the following steps. 1. Ensure the xpression Documentum Edition Server is installed correctly. 2. Log in to Documentum Webtop using Administrator privileges. 3. Expand the Administration item in the left pane. 4. Expand the User Management item in the left pane. 5. Click the Roles item in the left pane. 6. In the right pane, double-click the xpression_admin role. Chapter 12 Assigning Users and Roles 7. The right pane displays all existing users with the xpression_admin role. To add a new user, click the File menu and select Add Member(s). 8. Webtop will display a list of all users in a column on the left and all xpression_admin users in a column on the right. Select a user from the left column and click the right-arrow button to move it to the right column. Repeat this step for each user that will receive the xpression_admin role. 9. Click OK. Adding Users to the xpression_designer Role To assign users to the xpression_designer role, complete the following steps. 1. Ensure the xpression Documentum Edition Server is installed correctly. 2. Log in to Documentum Webtop using Administrator privileges. 3. Expand the Administration item in the left pane. 4. Expand the User Management item in the left pane. 5. Click the Roles item in the left pane. 6. In the right pane, double-click the xpression_designer role. 7. The right pane displays all existing users with the xpression_designer role. To add a new user, click the File menu and select Add Member(s). 8. Webtop will display a list of all users in a column on the left and all xpression_designer users in a column on the right. Select a user from the left column and click the right-arrow button to move it to the right column. Repeat this step for each user that will receive the xpression_designer role. 9. Click OK. 36

39 Adding Users to the xpression_dashboard Role To assign users to the xpression_dashboard role, complete the following steps. 1. Ensure the xpression Documentum Edition Server is installed correctly. 2. Log in to Documentum Webtop using Administrator privileges. 3. Expand the Administration item in the left pane. 4. Expand the User Management item in the left pane. 5. Click the Roles item in the left pane. 6. In the right pane, double-click the xpression_dashboard role. Chapter 12 Assigning Users and Roles 7. The right pane displays all existing users with the xpression_dashboard role. To add a new user, click the File menu and select Add Member(s). 8. Webtop will display a list of all users in a column on the left and all xpression_dashboard users in a column on the right. Select a user from the left column and click the right-arrow button to move it to the right column. Repeat this step for each user that will receive the xpression_dashboard role. 9. Click OK. 37

40 Chapter 12 Assigning Users and Roles 38

41 Upgrading Documentum Edition 13 Upgrading Documentum Edition This chapter contains information about upgrading Documentum Edition components. Updating Your License To update your server license, complete the following steps: 1. Obtain a new license key file from EMC Document Sciences Customer Care. 2. Log on to xadmin, click System Management and click License. 3. In the right pane, click Browse to locate and select the license key file (license.xml) and click OK 4. Click Save. Upgrading the Server To upgrade the server, please follow the steps provided in your upgrade package. This section contains general information about upgrading the server. To upgrade the server, you must replace the DE_Server.war file on your server. Replacing the WAR file on JBoss To update DE_Server.war on JBoss, you must delete the existing WAR file in your application server s /deploy directory before replacing it with the new file. Replacing the WAR file on the Sun Java System Server To update DE_Server.war on Sun Java System AS, log in to the Admin console, and disable and undeploy the current DE_Server.war deployment. Next, deploy the new DE_Server.war file. Finally, ensure the server classpath is updated. Replacing the WAR file on WebLogic To update DE_Server.war on Weblogic, delete the WAR file from the autodeploy directory and copy the new file into the directory. Replacing the WAR file on WebSphere To update DE_Server.war on WebSphere, access the WebSphere administrative console and view the Enterprise Applications page. Select the existing DE_Server.war file and click Stop. Next, click Uninstall. Deploy the new WAR file. 39

42 Chapter 13 Upgrading Documentum Edition 40

43 Deploying the Sample Application 14 Deploying the Sample Application The steps in this chapter describe how to install and use a typical sample workflow for the approval of xpresso templates. This sample application requires Documentum TaskSpace, Documentum Process Builder, and Documentum Forms Builder. Deploying the Sample Application Complete the following steps to deploy the sample application: 1. Locate the following DAR files in your installation package: DEWorkflowDemoProject.dar and TCMReferenceProject.dar. 2. Start the Documentum Composer DAR Installer. The DAR installer is located in your composer directory, the same directory that contains eclipse.exe. By default, this directory is \\<DCTM_install_dir>\product\6.5\install\composer\</DCTM_install_dir> 3. Run the DAR installer. The DAR Installer page appears. 4. In the *DAR box, supply the full path and file name of the DEWorkflowDemoProject.dar file. 5. Locate the Docbroker Details section. In the *Docbroker Host drop-down box, select the name of the docbroker host. If no names appear in the list, please type the name of your Docbroker Host or Connection Broker. 6. In the *Docbroker Port box appears, type the port number. By default, this number is Click Connect. 8. Locate the Repository Details section. In the *Repository drop-down box, select the name of the repository where you want to deploy the sample application. 9. In the User Name box, type the user name for the repository. 10. In the Password box, type the password for the user name. 11. Click the Install button. 12. The DAR Installer will deploy the DAR file and display a success message when complete. 13. Repeat steps 4 through 12 for the TCMReferenceProject.dar file. 14. Click Close to close the DAR Installer. If you receive and error, ensure you are using a supported version of the DAR Installer. Using the Sample Application To use the sample application, complete the following steps. These steps assume the user has some experience with Process Builder and TaskSpace. Please see the Process Builder and TaskSpace documentation for specific information about those products. 1. Start Process Builder. 2. Connect to the docbase where you deployed the two DAR files in the last step. 3. Open the Review xpresso Document process located in the following folder: /System/Applications/DEWorkflowDemoProject 41

44 Chapter 14 Deploying the Sample Application In this workflow, Designer1 submits a document to Designer2. Designer two can approve or reject the document. Rejection sends the document back to Designer1. Approval sends the document to Approver1 for final approval. 4. We must associate users with Designer1, Designer2, and Approver1. Click the Uninstall Template button. 5. Right-click Designer2 and select Activity Inspector. 6. Click the Performer tab. 7. Click Select Performer and select a user from the docbase. 8. Repeat steps 5 through 7 for Designer1 and Approver1. 9. Click OK. 10. Right-click Link to Folder and select Activity Inspector. 11. In the Destination Folder section, click the Browse button and select a folder from your docbase. 12. Click OK. 13. Save the process. After the save action has completed, Process Builder will offer to Validate and Install the process. Please allow Process Builder to perform these steps. 14. Ensure that the users you have defined in the workflow are members of the ts_desiger role. Then, log into TaskSpace as the user you defined as Designer Click the Processes tab. 16. Select the Review xpresso Document process and click Start Process. 17. Click the Tasks tab and double-click the Designer2 task. 18. Click Add to attach an xpresso document to the workflow. 19. Submit the document. 20. Log on to TaskSpace as the user you defined as Approver Click the Tasks tab and double-click the Approver1 task. 22. Click Approve to approve the document. 23. Back at the Inbox page, you should see a Link to Folder task. Double-click the Link to Folder task. 24. Click Complete. 42

45

46