EMC® Documentum® XML Store

Version 7.2

Deployment and Administration Guide

EMC Corporation Corporate Headquarters: Hopkinton, MA 01748–9103 1–508–435–1000 www.EMC.com

Legal Notice Copyright © 1999-2015 EMC Corporation. All Rights Reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED "AS IS." EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks used herein are the property of their respective owners. Documentation Feedback Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can make our documentation better or easier to use, please send us your feedback directly at [email protected]

Table of Contents

Chapter 1

Deployment Overview ......................................................................................7 XML Store overview ...........................................................................................7 XML Store enabled repository .............................................................................8 XML Store deployment modes ............................................................................8 Pre-deployment tasks .......................................................................................10

Chapter 2

Deploying XML Store...................................................................................... 11 XML Store deployment workflow ....................................................................... 11 Entering XML Store license key.........................................................................12 Enabling XML Store for a repository ..................................................................13 Enabling XML Store to work with multiple Content Servers..................................14

Chapter 3

Administrating XML Store ..............................................................................17 Storing XML content in XML Store.....................................................................17 Creating additional XML Storage Areas .............................................................17 xDB administration tool .....................................................................................18 Migrating from an embedded to an external xDB ................................................18 Changing the primary xDB instance used by XML Store .....................................20 Managing xDB passwords ................................................................................21 Configuring JBoss HTTP connector for large XML file imports and exports ...........22 Additional xDB administrative tasks ...................................................................22

Appendix A

Sample web.xml files......................................................................................23

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

3

Preface

Intended audience This guide is intended for system administrators who are responsible for deploying and administrating XML Store on Documentum Content Server. To use this document, you need the following: • Administrative privileges on the computer where you are deploying XML Store • Working knowledge of Microsoft Windows or Linux • Working knowledge of EMC Documentum Content Server administration and configuration, including high-availability (HA) configurations

Related Documentation For more information, see the following resources:

• EMC Documentum Content Server Installation Guide • EMC Documentum Content Server Administration and Configuration Guide • EMC Documentum xDB Administration Guide

Revision History The following changes have been made to this guide: Revision Date

Description

February 2015

Initial publication.

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

5

Chapter 1 Deployment Overview This chapter contains the following topics: •

XML Store overview

•

XML Store enabled repository

•

XML Store deployment modes

•

Pre-deployment tasks

XML Store overview XML Store is an optional module of Documentum Content Server that gives Content Server extended capabilities to store and process XML data in the repository by integrating it with Documentum xDB, a highly scalable, native XML database. XML Store adds standards-based XQuery to the XML capabilities of Documentum Content Server. XML Store enables richer searches, reusing, and composing of content in a more flexible manner. XML Store offers fine-grained access to any content fragment without requiring that content be chunked or burst into individual content objects. This functionality means users throughout the enterprise can conduct richer searches, achieve more flexible reuse and content composition. XML Store preserves XML content as is, without mapping XML to RDBMS table rows and columns. The XML structure is preserved, allowing users to efficiently and accurately query content at any level of detail (for example, individual elements, attributes, content objects, or metadata attributes), even on large information sets. As a native XML repository, XML Store provides performance advantages over relational databases and file systems through specialized XML indexing methods, caching, and architecture optimized for XML. XML Store optimizes performance for XML content files and handles access to XML content using XQuery. The XML Store works with all other Content Server features, such as versioning, security, and lifecycles, including XML applications. XML Store provides the following features: • XML-specific storage type for storing XML content. • XQuery interface for searching and retrieving XML content and Documentum attributes through XQuery syntax. • XML Store administrator interface to improve search performance by creating XML indexes and controlling the generation of segments and file/segment mappings. EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

7

Deployment Overview

XML Store enabled repository XML Store is an optional module that adds a native XML database server to the Content Server repository. When you deploy XML Store for a Content Server, an xDB instance is deployed containing an xDB federation, which is logically a container of one or more xDB databases. A Content Server instance is associated with an xDB federation, and each xDB database in the federation maps to a repository in the Content Server. When you enable XML Store for a Content Server repository, a corresponding xDB database is created. Figure 1

XML Store enabled repository

The EMC Documentum xDB Administration Guide provides the detailed information on Documentum xDB.

XML Store deployment modes There are two ways you can deploy XML Store: use an embedded XML database managed by the Content Server or use an external XML database for high availability Content Server configuration. Embedded XML database Select this deployment mode if high availability is not required. It is called embedded because the XML database runs entirely within the Content Server’s Java Method Server (JMS) and communicates over HTTP or HTTPS with the Content Server through an XML Store plug-in.

8

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Deployment Overview

Figure 2

Embedded XML database

External XML database Select this deployment mode if you want to have the XML Store fail over to a secondary Content Server in the event the primary Content Server is unavailable. In this mode, you install a standalone xDB instance before deploying XML Store. The Installing Content Server and Java Method Server for High-Availability in EMC Documentum Content Server Installation Guide provides the detailed information about high availability. XML Store uses Java Method Server failover mechanisms that allow methods to run on one or more servers when the Java Method Server for any one Content Server becomes unavailable. When a Java Method Server or Content Server is down, the XML Store can still be accessed and managed through other Content Servers. The configuration removes a single point of failure from any one Content Server node for XML Store, but does not provide failover for xDB itself. Additional steps are required to provide automatic failover for other aspects of the system. The EMC Documentum xDB Administration Guide provides the detailed information about configuring xDB for failover. Figure 3

External XML database (xDB)

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

9

Deployment Overview

Pre-deployment tasks Before you deploy XML Store, perform the following tasks: • Obtain license keys for XML Store and Content Storage Services (CSS) XML Store and Content Storage Services are both optional modules that require separate license keys. To store XML documents in an XML Store enabled repository, you must also enable Content Storage Services for the repository to configure assignment policies. You can do this before or during XML Store deployment. • Install a standalone xDB instance (required for HA configurations) If you plan to deploy XML Store in a high-availability (HA) environment using an external XML database, you must install a standalone xDB instance (version 10.2) first before deploying XML Store. When you install xDB: – Make note of the xDB host name, port number, superuser password, and data location during the installation. You will be required to provide the information when you deploy XML Store. – During installation, choose Advanced Settings and select the Other hosts may access the server option. – Ensure that the xDB client and xDB server have the xDB libraries with the same version. The EMC Documentum xDB Administration Guide provides the detailed instructions on installing xDB.

10

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Chapter 2 Deploying XML Store This chapter contains the following topics: •

XML Store deployment workflow

•

Entering XML Store license key

•

Enabling XML Store for a repository

•

Enabling XML Store to work with multiple Content Servers

XML Store deployment workflow XML Store is an optional module of Content Server that can be deployed during or after Content Server installation. After entering the XML Store license key, you can enable XML Store when you create a new repository or when you upgrade or update an existing one. The following diagram illustrates the general process for deploying XML Store for Content Server repositories. Steps specific to XML Store deployment are highlighted in yellow and will be explained in detail. The EMC Documentum Content Server Installation Guide provides the information about Content Server installation and configuration steps.

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

11

Deploying XML Store

Figure 4

XML Store deployment workflow

Entering XML Store license key As an optional module of Content Server, XML Store requires a separate license key. To enter the XML Store license key: 1. Access the Content Server module licensing screen in one of these two ways: • During Content Server installation, Installer notifies you that Content Server has been successfully installed and asks you whether you want to launch the Content Server configuration program to configure a repository now. Select Configure Now and the Content Server configuration program runs and displays the Content Server module licensing screen. • After you install Content Server and exit Installer, launch the Content Server configuration program and select Licensing; then click Next. After you provide the installation owner password, the Content Sever module licensing screen is displayed. 2. In the Content Server module licensing screen, select XML Store and enter its license key. If you have not activated the Content Storage Services module, also select Content Storage Services and enter its license key. Click Next. 3. The Content Server configuration program asks you whether you want to update any existing repositories with the new module. Click Yes to proceed to enable XML Store for a repository or No to exit.

12

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Deploying XML Store

Enabling XML Store for a repository When the XML Store license key has been entered, you can enable XML Store for any repository in the Content Server. Whether you are creating a new repository, upgrading a repository from an earlier version, or updating an existing repository, the Content Server Configuration Program will ask you whether to enable modules for the repository if they are not enabled yet. To enable XML Store for a repository: 1. In the Content Server configuration program, when prompted to enable a module for the repository, select XML Store. If the Content Storage Services module has not been enabled for the repository, also select Content Storage Services. Click Next. 2. Specify a storage location for XML Store. The default location is $DOCUMENTUM\data\xhive_storage. 3. Select a deployment mode. For detailed information about the two deployment modes, see XML Store deployment modes, page 8. • Embedded xDB instance managed by the Content Server: Select this deployment mode when you deploy XML Store for just one Content Server. • External xDB instance (required for high availability): Select this deployment mode if you want to deploy XML Store to work with more than one Java Method Server or Content Server configured for failover in a high-availability environment. You must have already installed a standalone xDB instance. If you select this option, provide the following xDB information: • xDB Host: Enter the name or IP address of the xDB host. • xDB Port: Enter the port number the xDB instance uses. • xDB Superuser Password: Enter the xDB superuser password. This password is set when you install xDB and is used to create xDB databases in XML Store. • xDB Data Location: Specify a valid path on the external xDB host where to store xDB data. This must be the same path specified for xDB during its installation. If you select this option, you also need to perform additional configuration to deploy XML Store for multiple Content Servers. See Enabling XML Store to work with multiple Content Servers, page 14. 4. If you select Embedded XML Database (xDB), provide the following information for XML Store. a. Set the xDB superuser password. The superuser account will be used to create xDB databases in the XML store. Click Next. b. Specify the following information for the XML Store: • XML Store Port: Enter an available port number to be used by the embedded xDB. The default is 1235. • XML Store Directory Location: Specify a directory location where the xDB database files will be stored. The default is $DOCUMENTUM\data\xhive_storage. Click Next. 5. Enter the fully qualified domain name (FQDN) of the Content Server host. 6. The deployment process begins. When complete, exit the Content Server Configuration Program. EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

13

Deploying XML Store

Enabling XML Store to work with multiple Content Servers To deploy XML Store to work with multiple Content Servers, after you complete the deployment process for the first (primary) Content Server with an external XML database, you must perform some additional steps. For information about XML Store deployment mode with an external xDB, see XML Store deployment modes, page 8. If you deployed XML Store with an embedded XML database, you need to migrate data in the embedded XML database to an external XML database first and then perform additional steps. See Migrating from an embedded to an external xDB, page 18. To deploy XML Store to work with additional Content Server nodes: 1. Make sure that Content Server and Java Method Server instances have been properly configured for failover in a high availability environment. The Installing Content Server and Java Method Server for high Availability section in the EMC Documentum Content Server Installation Guide provides the detailed information. Install additional Content Server nodes including the Content Server and JBoss components. The sections Installing and configuring the remote Content Server and Installing and configuring JMS for HA on multiple hosts in the EMC Documentum Content Server Installation Guide provides the detailed information about adding Content Server nodes. 2. Copy the XML Store plugin XHiveConnector from the primary Java Method Server to additional Java Method Server. a. From the primary Content Server node, locate the deployed XhiveConnector.ear, located by default in $DOCUMENTUM\jboss_directory\server\DctmServer_MethodServer\deploy. b. Copy the whole XhiveConnector.ear folder to the same location within the JBoss on additional Content Server nodes. c. If the JBoss is located in different locations on the additional Content Server node, verify the entries in the files dfc.properties and log4j.properties are correct for the additional Content Servers. The paths in these files must match the path for the additional Content Server nodes. The files dfc.properties and log4j.properties are located by default in the following directory: $DOCUMENTUM\jboss_directory\server\DctmServer_MethodServer\deploy\XhiveConnector.ear \APP-INF\classes • Dfc.properties: The file has only one line: #include E:\Documentum\config\dfc.properties. You must make sure that this path is correct for the additional Content Servers.

• Log4j.properties: Evaluate all paths in this file to make sure that they are accurate for the additional Content Server nodes. This file’s entries are similar to the following: likelog4j.appender.F1.File=E:/Documentum/jboss_directory /server/DctmServer_MethodServer/logs/XhiveConnector.log

d. Restart the Java Method Server. 3. On additional Content Servers, add XHiveConnector to the newly created jms_config object, using Documentum Administrator or by running a custom script. a. Launch Content Server Manager and start the IDQL utility; then use the following DQL query to obtain the server config ID, r_object_id: 1> ?,c,select r_object_id, object_name,server_config_id from dm_jms_config 2> go

14

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Deploying XML Store

b. The results returned are similar to the following: r_object_id object_name 3d015b3880000102 repo 3d015b3880000c57 xmlharcs_repo

Determine which server ID to use by examining the object_name that matches that of the dm_jms_config object on the additional node. c. Navigate to the $DM_HOME\bin directory and run the dm_jms_admin tool with the following parameters: dm_jms_admin -docbase docbasename -username installowner -password password -action add -jms_host_name hostname -jms_port port -servlet_name XhiveConnector -base_uri /XhiveConnector/servlet/XhiveConnectorServlet -server_config_id serverconfigID -proximity 1

For example: dm_jms_admin -docbase repo -username Administrator -password Pass123 -action add -jms_host_name secondaryCS -jms_port 9080 -servlet_name XhiveConnector -base_uri /XhiveConnector/servlet/XhiveConnectorServlet -server_config_id 3d015b3880000c57 -proximity 1

4. Enable xHiveConnector on any additional Content Servers. • The Content Server invokes a shared library or DLL to handle content stored in XML Store. The shared library or DLL is represented in the repository by a dm_plugin object. The shared library or DLL is stored as the content of the plugin object, and is created, by default, in filestore_01 during Content Server installation. • View information for this plugin object using the IAPI command: API> retrieve,c,dm_plugin where object_name like ’%xhive%’ dump,c,l. For XML Store to function properly on additional Content Servers in a distributed configuration, this plugin must be present in a distributed storage area accessible by all Content Servers. • Use the DQL statement and information provided to ensure that each Content Server node has a properly configured file store component in a distributed storage environment. This step is required when storage is distributed. If filestore_01 is accessible by all content servers, for example, through a UNC path, then a distributed store is not needed. • For more information to complete the necessary steps, refer to the Implementing Single-Repository Models section of the EMC Documentum Content Server Distributed Configuration Guide. Specifically, refer to the step for moving the objects currently in filestore_01 to the distributed store. 5. Verify the Proximity value for each Target Host on each Content Server. Because JMS failover does not support Remote Content Server configuration, the projection target range for each Content Server must be outside the range of 9000 to 9999. If the projection target falls in this range, JMS failover does not work as expected. Check both the server.ini file and the server config object for each Content Server: 1. Examine the server.ini file for each server, located by default in the Documentum directory, .../dba/config/repositoryname/ server.ini for the primary content server. Additional content servers .ini file is in the same directory as server_machine_name_service_name.ini For example: [DOCBROKER_PROJECTION_TARGET] host = cshost1 port = 1489

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

15

Deploying XML Store

#proximity=9001 [DOCBROKER_PROJECTION_TARGET_1] #host = #port = #proximity = #host=cshost1 #port=1489 #proximity=9010

2. Examine the server config object for each server in Documentum Administrator: a.

Select Administration > Basic Configuration > Content Servers, then right-click on server configuration and select Properties.

b.

Select Connection Brokers and ensure the Proximity value for each Target Host falls outside the range of 9000 to 9999.

For information about setting proximity values, refer to the section Setting proximity values for Content Server projection to a connection broker in the EMC Documentum Content Server Distributed Configuration Guide.

16

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Chapter 3 Administrating XML Store This chapter contains the following topics: •

Storing XML content in XML Store

•

Creating additional XML Storage Areas

•

xDB administration tool

•

Migrating from an embedded to an external xDB

•

Changing the primary xDB instance used by XML Store

•

Managing xDB passwords

•

Configuring JBoss HTTP connector for large XML file imports and exports

•

Additional xDB administrative tasks

Storing XML content in XML Store XML documents do not get saved in the XML Store by default, but must be configured with an assignment policy. Assignment policies are part of the optional Content Storage Services (CSS) module that requires a separate license key. Assignment policies are only available after you activate Content Storage Services for the repository. You can create and manage assignment policies using Documentum Administrator. To configure assignment policies: 1. Open Documentum Administrator and log in to the repository. 2. Select Administration > Storage Management > Assignment Policies. 3. Create new policies or modify existing policies, as described in the Storage Management chapter of the Documentum Administrator User Guide.

Creating additional XML Storage Areas After an initial XML Store has been installed with Content Server, additional XML storage areas can be configured using Documentum Administrator. To add an XML storage area: 1. Open Documentum Administrator and connect to the repository where you want to create a new XML storage area. 2. Navigate to Administration > Storage. 3. Select File > New > External Free Store. EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

17

Administrating XML Store

4. Enter the following information on the New External Free Store - Info page: File Store Property

Description

Name

The name of the new XML storage area.

Execute Plug-In

• Specify whether the plug-in is executed on the server or client. • Choose xhive_win32shrlib_externalstorage for your platform.

Storage Class

Select XML to create an XML storage area.

Application server URL

Enter the URL of the xDB application server. For example: http://myhost:9080/XhiveConnector/servlet/XhiveConnectorServlet

Store Location

Enter $DOCUMENTUM/data/xhive_storage as the location of the new XML storage area.

5. Click OK. The new XML storage area appears on the Storage page.

xDB administration tool The XML Store deployment also includes xDB Admin Client, an administration tool that lets developers and administrators manage xDB databases through a graphical user interface. To launch xDB Admin Client: 1. Navigate to the /bin directory of the Content Server installation. For example, if Content Server is installed on a Windows machine, the default installation directory is C:\Documentum\product\release_number\bin, where release_number is the Content Server version. 2. Double-click xdb.bat. The xDB command-line window displays. 3. Type admin after the xdb> prompt. The administrator tool page displays. 4. Select Database > Connect. 5. Select the database name from the list, enter the username and password of a valid database user and then click OK. The EMC Documentum xDB Admin Client page displays. The Admin Client section in the EMC Documentum xDB Administration Guide provides more information about xDB Admin Client.

Migrating from an embedded to an external xDB If you have already deployed XML Store using an embedded xDB, you can still migrate it to an external xDB for failover in a high availability environment using a migration utility. This utility is used only for repositories that are already XML Store enabled, upgraded to Content Server version 7 or later, and accessible to multiple Content Server nodes. To migrate XML Store from an embedded xDB to an external one: 1. Make sure that the external xDB has been properly installed and configured. See Pre-deployment tasks, page 10. 18

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Administrating XML Store

2. Make sure that the Content Server and repositories have been upgraded to version 7 or later, and XML Store enabled. For information about upgrading Content Server and repositories, refer to EMC Documentum Content Server Installation Guide. 3. Copy the xDB database files from the embedded xDB database to the external xDB database using xDB Admin Client. Before beginning the move or copy of database files, note the following: • Each XML Store is represented in the xDB database as a library under the root-library. The name of the library is in the form of an object ID, for example, “630056ce80000114”. Obtain this information using the xDB Admin Client. • The documents stored in the XML Store library are put into a segment that has the same name as the object ID. This ID corresponds to a separate file, for example, E:\Documentum\data\xhive_storage\testdb1-630056ce80000114-0.XhiveDatabase.DB. • If a document does not have a specified segment, the data is stored in the default segment which is automatically created with the database, for example, E:\Documentum\xhive_storage\testdb1-default-0.XhiveDatabase. These steps describe copying database files from embedded xDB to an external xDB using the xDB Admin client, such as through backup and restore, or replication. The EMC Documentum xDB Administration Guide provides more information about copying database files. Complete the move using the xDB Admin Client: a. In the federation on the target (external) xDB machine, create a database that has the same name as the database in the source (embedded) xDB. b. In the newly created database, create a segment for each XML Store. The name of the segment must be the same as the name of the XML Store, for example, “630056ce80000114” c. In the source (embedded) xDB, serialize the root-library by right-clicking on the root-library and selecting Library Management > Serialize. When prompted, supply a filename for the serialized data. d. In the target (external) xDB, connect to the newly created database. Click the database node in the tree pane, then right-click on the database node and select Deserialize root library. A dialog displays and prompts for the file serialized from the source xDB. After the data is deserialized, the root-library is identical to the source database. 4. Run the migration utility, which modifies the web.xml file in the XhiveConnector.ear. Note: To unlock the web.xml file so that the migration utility can make modifications, stop the Java Method Server on the Content Server machine before beginning the migration. Find example web.xml files showing the changes made by the utility in Sample web.xml files, page 23. These modifications are required in order for the XML Store plugin on this Content Server to use the external xDB. The utility also modifies the xdb.properties file. The command line for the conversion tool is: convertEmbeddedXDB xdbHost xdbPort serverVersion docbase installOwner xDBSuperuserPassword, where: • xdbHost: the name of the machine where the standalone xDB is installed. • xdbPort: the port where the standalone xDB is configured. • serverVersion: the version string of the Content Server (e.g. 7.0.0000.0200) • docbase: the name of the repository that is enabled for XML Store. • installOwner: the user name of the Content Server installation owner. • xDBSuperuserPassword: the superuser password of the xDB. EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

19

Administrating XML Store

• The utility makes the following changes in the web.xml file: Change the bootstrapFileName value to REMOTE Change the xhiveaddress value to the xDB host Change the xhiveport value to the port where xDB is running on the external xDB host Add a parameter called Content-Server-Version. The value is the version string of the current Content Server. – Add a parameter called docbase-docbasename. The value is the name of the docbase enabled for XML Store. • The utility modifies the xdb.properties file, located in the $DM_Home\bin directory, changing the XHIVE_BOOTSTRAP, XHIVE_SERVER_ADDRESS and XHIVE_SERVER_PORT values to the values provided from the command line when the utility is run. 5. Once the utility has run, XML Store is configured to use the external xDB. Restart the Java Method server for the changes made by the migration utility to take effect. – – – –

Changing the primary xDB instance used by XML Store Sometimes, the external xDB may become unavailable during system restoration, hardware upgrade, disaster recovery, or system maintenance. In such situations, pointing XML Store to an available xDB instance is required to continue processing. This topic describes the process for changing XML Store configuration to call an available xDB instance if the xDB instance in use becomes unavailable. Note: This process is unrelated to any backup or high availability scenarios described in EMC Documentum xDB Administration Guide. The intention of this process is simply to change the pointers in the web.xml file to point from one xDB instance to a different xDB instance for the purposes of redirecting XML Store. • Before beginning this task, an available xDB instance must be installed and configured. It can be a new xDB instance or a replica. For information about replicating xDB data, refer to the xDB documentation. • Redirecting XML Store from one external xDB instance to another is like the process of migrating XML Store data and processing from an embedded xDB instance to an external xDB instance. All steps in this high-level procedure are described in more detail in the topic Migrating from an embedded to an external xDB, page 18. Refer to that topic for help completing these steps, including detailed recommendations, guidelines for moving the database files, and commands for running the migration utility. 1. Ensure that an alternate instance is installed and working and XML Store data files are accessible to the instance. You can also promote an existing xDB replica node to the primary node. The EMC Documentum xDB Administration Guide provides information about installing a standalone xDB instance. 2. Move the xDB database files from the unavailable xDB database to a new xDB database using the xDB Administration client, so the new xDB can access the xDB database files. 3. Run the migration utility to modify the web.xml file in the XhiveConnector.ear. Provide the xDB Host and xDB Port for the new external primary xDB instance. 4. Once the utility has run, XML Store is configured to use the new xDB instance. Restart the Java Method server for the changes made by the migration utility to take effect. 20

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Administrating XML Store

Managing xDB passwords The xDB security model is based on three levels: user, administrator, and superuser. These user types have different access levels.

xDB superuser account and password An xDB federation has one superuser account with the username superuser. The superuser account for the initial and default federation is created during the xDB installation process, and enables initial database configuration. The superuser can create and delete databases, and perform administrative operations such as setting the license key and performing backups. However, the superuser cannot access regular xDB data. When you enable XML Store for the first repository for a Content Sever, you are required to set an xDB superuser password: for embedded xDB, you do this during Content Server configuration; for external xDB, you set the superuser password when installing the xDB instance and provide this information when configuring Content Server. The xDB superuser password is used to create the xDB database for the initial repository, and for any other repository of the Content Server you enable XML Store for after your initial XML Store deployment—one xDB database for each repository. Once you set the xDB superuser password for the first time, the Content Server configuration program will not ask you again for it when you enable XML Store for subsequent repositories of the Content Server. The Changing the superuser password using the Admin Client section in the EMC Documentum xDB Administration Guide provides instructions on changing the xDB superuser password.

xDB administrator account and password An xDB database administrator account is created during database creation. An administrator can access all the data and user information in one database. When you enable XML Store for a repository, the Content Server configuration program uses the xDB superuser account to create an xDB database with an administrator account: username Administrator and the same password as the repository owner password. This process is transparent to the user since the user is not required to provide the administrator username and password. Note: For an XML Store enabled repository to work properly, the xDB administrator password must be kept in sync with the repository owner password at all times. If either password is changed, the other password must be changed as well. The Changing the administrator password using the Admin Client section in the EMC Documentum xDB Administration Guide provides instructions on changing the xDB database administrator password. The Managing encrypted passwords section in the EMC Documentum Content Server Administration and Configuration Guide provides instructions on changing the encrypted Content Server repository owner password.

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

21

Administrating XML Store

Configuring JBoss HTTP connector for large XML file imports and exports If you want to import and export large XML files into and out of the XML Store, you must configure the JBoss HTTP connector to allow for more HTTP requests in an open connection; otherwise, large file imports and exports may fail because JBoss may close the connections before the files have been transferred completely. To configure JBoss HTTP Connector for large XML file imports and exports: 1. Open the following file in an XML editor: $DOCUMENTUM\jboss_directory\server\DctmServer_MethodServer\deploy\ jbossweb.sar\server.xml 2. Locate the HTTP/1.1 Connector element and set its maxKeepAliveRequests attribute to a larger value, say 1000 or 1500. The maxKeepAliveRequests attribute specifies the maximum number of HTTP requests which can be pipelined until the connection is closed by the server. Setting this attribute to 1 will disable HTTP/1.0 keep-alive, as well as HTTP/1.1 keep-alive and pipelining. Setting this to -1 will allow an unlimited amount of pipelined or keep-alive HTTP requests. If not specified, this attribute is set to 100. By default, this value is set to 500. 3. Save server.xml and restart JBoss.

Additional xDB administrative tasks You can perform additional administrative tasks on the xDB federation and databases independent of Content Server administration. The following relevant sections in the EMC Documentum xDB Administration Guide provides instructions on performing these administration tasks: • Creating and restoring backups • Managing indexes • Working with XQueries

22

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Appendix A Sample web.xml files

This appendix covers the following topics:

Sample web.xml files This section provides examples of web.xml files used by the Java Method Server to manage important information about how to connect to the XML database, both for embedded and external xDB deployments. The file is located in XhiveConnector.ear. Key parameters in the file are listed below: Parameter

Description

prettyPrintFormat

If true, XML content will be exported with added white space to display a hierarchical format with new lines and indentations; if false, XML content will be exported as it was inserted.

web.xml for an embedded xDB configuration Here is an example of the web.xml file located in XhiveConnector.ear for an embedded xDB: Documentum Xhive Connector This servlet stores and retrieves data from the Xhive DB ExternalStoreConnector Documentum Xhive Connector com.documentum.server.impl.method.xhiveconnector. ExternalStoreConnectorServlet extPluginClassName com.documentum.server.impl.method.xhiveconnector. XhiveStorePlugin EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

23

web.xml for an embedded xDB configuration

bootstrapFileName E:\Documentum/xhive_storage/XhiveDatabase.bootstrap cachePages 10000 xhiveaddress ContentServer xhiveport 1235 securityHintSize 200 processBatchSize 100 prettyPrintFormat true 1 ExternalStoreConnector /servlet/XhiveConnectorServlet xhiveconnector.html

24

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Sample web.xml files

web.xml for an external xDB configuration The migration utility changes the bootstrapFileName parameter value to “REMOTE” to signal the XhiveConnector to use the xhiveaddress and xhiveport parameters to connect to the external xDB. After the utility runs, the web.xml is similar to the following: ?xml version="1.0" encoding="UTF-8" ?> Documentum Xhive Connector This servlet stores and retrieves data from the Xhive DB ExternalStoreConnector Documentum Xhive Connector com.documentum.server.impl.method.xhiveconnector. ExternalStoreConnectorServlet extPluginClassName com.documentum.server.impl.method.xhiveconnector. XhiveStorePlugin bootstrapFileName REMOTE cachePages 10000 xhiveaddress ExternalXDBHost xhiveport 1235 securityHintSize

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

25

web.xml for an external xDB configuration

200 processBatchSize 100 prettyPrintFormat true Content-Server-Version 7.0.0000.0203 docbase-testdb1 testdb1 1 ExternalStoreConnector /servlet/XhiveConnectorServlet xhiveconnector.html

26

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

Index A additional XML storage area, 17 administrator, 21 assignment policies, 17

D deployment workflow, 11

P password, 21 pre-deployment tasks, 10

S superuser, 21

X xDB Admin Client, 18 XML database embedded, 8 external, 9 XML documents, storing, 17

EMC Documentum XML Store Version 7.2 Deployment and Administration Guide

27