32 Installing Content Integration Platform for EMC Documentum

This chapter contains procedures for installing and configuring the Content Integration Platform for EMC Documentum to support content transfer between WebCenter Sites and Documentum installations.

This chapter contains the following sections:

32.1 Installation Overview

Content Integration Platform for EMC Documentum enables bidirectional communication between WebCenter Sites and EMC Documentum:

  • Publishing EMC Documentum objects to WebCenter Sites.

  • Archiving WebCenter Sites assets on EMC Documentum.

In the archival process, the CS DataStore, rather than WebCenter Sites, is treated by CIP as the source of data. The CS DataStore is created when assets are published from WebCenter Sites to a RealTime destination with archiving enabled. The CS DataStore stores the published assets in its file system.

CIP supports publishing and archiving by replicating the source system's metadata to the target system. Schema that stores the source system's content is thus established on the target system. Content on the source system can then be transferred to the target system via the CIP command-line interface and cipcommander publish command. Once the publishing session ends, the synchronization engine starts monitoring the source system's published (or archived) workspaces for changes to content and automatically replicates the modified content to the target system.

This chapter shows you how to install CIP components to support publishing, archiving, or both processes, depending on your requirements:

  • To support publishing or archiving, you must install Content Integration Agent, which manages metadata and the associated content. Content Integration Agent includes:

    • mappings.xml, which maps the source system's metadata to the target system.

    • cipcommander, a command-line application used to run the CIP publish command. The same command publishes to WebCenter Sites (via Sites Agent Services) and archives to Documentum.

    • synchronization engine, which monitors the source's published (or archived) workspaces in order to keep source and target systems in agreement.

    • catalog.xml, which stores information about published and archived items and serves as a configuration file for tuning the synchronization process.

  • To enable publishing, you will install a programmatic publishing interface and database tables to store published objects, including their object type definitions:

    • The programmatic interface, named "Sites Agent Services," receives Documentum data from Content Integration Agent and stores the data to WebCenter Sites' database tables. The stored data consists of metadata in WebCenter Sites-compliant format and objects associated with the metadata.

    • Database tables for storing published objects are in the form of the Documentum flex family, a data model that must be installed on the WebCenter Sites management system and enabled on one of its content management sites. By default, the Documentum flex family also contains definitions of the Documentum object types dm_folder and dm_document. Both object types are mapped in the default mappings.xml file.

  • To enable archiving, you will install the fw_asset and fw_document object types on Documentum to provide the schema for storing WebCenter Sites assets as Documentum objects. The object types are mapped in mappings.xml.

32.2 Prerequisites

Before installing Content Integration Platform, do the following:

  • Download the Oracle WebCenter Sites Certification Matrix and release notes for this content integration product.

  • Download the following:

  • Read this chapter to gain an understanding of the installation process and note the information you will need to provide.

  • If you wish to set up CIP for publishing operations, create or select a content management site on the WebCenter Sites staging system for the Documentum flex family you will be installing.

  • In archiving operations, CIP uses the WebCenter Sites: Web Experience Management (WEM) Framework.

  • At the end of the CIP installation process, you have the option to configure event notification. If you choose to configure event notification, you must do so before publishing or archiving.

Also consider the following post-installation scenario: If your WebCenter Sites delivery system is running the Oracle WebCenter Sites: Community application and you wish to archive site visitors' comments and reviews, you will need to RealTime publish the comments and reviews from the delivery system to a separate WebCenter Sites system. The system must be running the WEM Framework. For more information, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

32.3 Packaging

Content Integration Platform is delivered as the following set of files:

File Description
cipagent-vNo.msi (for Windows) cipagent-vNo.rpm.bin (for Linux) For publishing and archiving. These files install Content Integration Agent (cipcommander and service) and configuration files that control the Content Integration Agent's process.

One of these files must be installed on a machine with the supported operating system and the ability to access both the source and target systems.

csagentservices.war For publishing. This file installs Sites Agent Services, including property files for setting the detail of log files and regulating access to the WebCenter Sites database.

This file must be deployed on a system other than delivery. The system must have access to the WebCenter Sites Shared directory.

cs_documentum_schema.zip For publishing. This file installs the Documentum flex family on WebCenter Sites, on the CM site that you specify.
documentum_cs_schema.dar For archiving. This file installs schema on the Documentum system to support the content of the CS DataStore.

32.4 Installation Steps

In this section, you will install Content Integration Platform for EMC Documentum. Your steps are the following:

32.4.1 Step 1. Installing Content Integration Agent

  1. If you are using Windows, install Microsoft Visual C++ 2008 Redistributable Package (x86) on the machine that will host Content Integration Agent.

  2. Run the cipagent file on a machine with a supported operating system and the ability to access the source and target systems.

    • Windows:

      Run cipagent-2.0.0-127.msi and follow the prompts.

      The following folders are created in the target directory:

        .. all conf files
        .. all certificates and private keys
        ..log file
    • Linux:

      Run (as a root user) the following command on the source system:


      The following directories are installed:

             cipagent -exe
               ..all libraries
  3. Back up the configuration file catalog.xml (located in integration_agent/conf/).

  4. Edit catalog.xml.

    The catalog.xml file stores configuration settings that Content Integration Agent requires to connect to the source system and Oracle WebCenter Sites. You will edit this file to provide Content Integration Agent with system location and user information.

    1. Open catalog.xml in a text editor.

    2. Edit the adapter for Oracle WebCenter Sites:

      Locate the provider element with name "cs" and id "70b1e307-26a1-499c-9295-cf0b6bd01342" and set the following parameters:

      • urlAS: Point to the Web Services module deployed with WebCenter Sites. Only the host name and port need to be modified. Typically, they name the host and the port number where WebCenter Sites is running. Do not alter the context name and context-related path unless you they differ from the default (http://localhost:8080/csagentservices/InfostoriaService).

      • username: User name of the account that has permissions to modify WebCenter Sites database tables (e.g., fwadmin, the general administrator).

      • password: Above user's password (e.g., xceladmin, assuming fwadmin is the username).

      • context: Leave this blank.

    3. Edit the adapter for the EMC Documentum installation:

      Locate the provider element with name "documentum" and id "d7a96a63-e78c-407c-8d7f-e84988806e49" and set the following parameters:

      • urlDocumentum: URL pointing to the server where Documentum Foundation Services (DFS) are running. Include the context name, but omit context-related paths. Typically you need to modify only the host name (the default value is http://localhost:9090).

      • username: User name for the account that has permissions to publishable content.

      • password: Above user's password.

      • filter: This parameter contains a where clause which is applied to filter out document versions that are not intended for publication. For example, to publish the latest approved version of a document, you can specify values such as the following:

        r_current_state = 1

        - or -

        r_policy_id = '0000000000000000'

        (taking into account that the approved state has "1" as an index)

    4. Save catalog.xml.

  5. Restart the Content Integration Agent executable:

    • Windows: Restart the Content Integration Agent service.

    • Linux: Type as root user: /sbin/service restart cipagent


    The Content Integration Agent executable can be run as a standalone process or as a system daemon. The executable will start a simple HTTP server on the default port 7070, which is reserved for CIPCommander communications with Content Integration Agent. Port 7070 is bound to the localhost, and therefore does not expose your system to any additional security risks.The fileserver facility default configuration takes port 7071 and attempts to automatically detect the host name. If multiple network interfaces are installed on the machine where Agent is running, we advise changing auto to the DNS name or the IP address that is accessible from the Sites Agent Services installation.Should you need to change the port, edit the port designation in facilities.xml and add -p <port> to all commands that start CIPCommander.
  6. In facilities.xml, enable the java facility section. Specify the path to Java on your system.

  7. Continue to the next step, Section 32.4.2, "Step 2. Installing CIP Publishing Components."

32.4.2 Step 2. Installing CIP Publishing Components

If you wish to install only archival capability, skip to Section 32.4.3, "Step 3. Installing Schema to Support Archiving to Documentum." Otherwise, complete all the steps in this section to install publishing capability. A. Installing Sites Agent Services


Sites Agent Services can be installed on any WebCenter Sites system other than delivery. We recommend a content management (staging) system.
  1. Edit the following files in csagentservices.war (all the files are located in csagentservices/WEB-INF/classes):

    • commons-logging.properties: defines the log file and log detail settings.

    • csAgentServices.properties: enables access to the WebCenter Sites database.

    1. Using a text editor, edit commons-logging.properties to point to the Sites Agent Services log file (agentservices.log).

    2. Create a data source specific to the application server. (More information is available in the guide for installing WebCenter Sites on the application server you are using.)

    3. Modify csAgentServices.properties to enable access to the WebCenter Sites database.

      • Using a text editor, set the following properties:

        uploader.username: User name of an account with permissions to edit flex families.

        uploader.password: Password for the above user name.

        cs.installDir: WebCenter Sites installation directory (e.g., C:\CS)

        cs.url: WebCenter Sites URL. Point to the WebCenter Sites web application. The default value is: http://localhost:8080/cs

      • Save csAgentServices.properties.

  2. Deploy csagentservices.war on the application server on the WebCenter Sites' host.

  3. Restart the application server.

  4. Continue to the next step, Section, "B. Installing EMC Documentum Schema on Oracle WebCenter Sites." B. Installing EMC Documentum Schema on Oracle WebCenter Sites

In this step, you will import cs_documentum_schema.zip into WebCenter Sites to support the publication of Documentum objects to WebCenter Sites.

To install the Documentum schema 

  1. Run catalogmover.bat (or catalogmover.sh on Linux) from the WebCenter Sites installation directory.


    Before using CatalogMover, connect it to WebCenter Sites:Below the "Password" field, select (or enter) a value that applies to your WebCenter Sites installation.
    • Choose Server, then select Connect.

    • Provide the following information:

      Server: The name of the HTTP server you want to connect to, and the port on which the server is running.



    • Click Connect.

  2. Go to Catalog, then select Auto Import Catalog(s).

    1. Select the file to import.

    2. In the import dialog, fill in the fields as shown below:

      Catalog Data Directory: Leave the default value

      Catalog ACL List: Browser, SiteGod, xceleditor, xceladmin

  3. Log in to the WebCenter Sites' Admin interface as a general administrator (fwadmin/xceladmin, by default) and continue as follows:

    1. Enable the Documentum flex family on the content management site you have chosen or created, as explained in Section 32.2, "Prerequisites."

    2. For quick access to published content, create a tree tab (named Documentum, for example).

    For instructions on enabling flex families, creating sites, and creating tree tabs, see the Oracle Fusion Middleware WebCenter Sites Administrator's Guide.

  4. Continue to the next step, Section 32.4.3, "Step 3. Installing Schema to Support Archiving to Documentum."

32.4.3 Step 3. Installing Schema to Support Archiving to Documentum

Install documentum_cs_schema.dar using Documentum Composer (installation instructions and user information are available in the Documentum Composer User Guide):

CREATE TYPE fw_asset (fw_id char(255),fw_name char(64),fw_createdby char(64),fw_createddate time,fw_description char(128),fw_publist char(255),fw_status char(2),fw_subtype char(32),fw_updatedby char(64),fw_updateddate time,fw_publisheddate time) WITH SUPERTYPE dm_document

CREATE TYPE fw_document (fw_publisheddate time,fw_name char(64)) WITH SUPERTYPE dm_document

32.4.4 Step 4. Backing Up the Default mappings.xml File

The mappings.xml file is located on the server that hosts Content Integration Agent.

32.5 Next Steps

Once CIP is installed, complete the following steps, as necessary: