cip_11gr1_for_emc_documentum_administrator_guide.pdf

7/30/2019 cip_11gr1_for_emc_documentum_administrator_guide.pdf

1/50

Oracle WebCenter Sites

Administrators Guide for Content Integration Platformfor EMC Documentum

11gRelease 1 (11.1.1)

February 2012


2/50

OracleWebCenter SitesAdministrators Guide for Content Integration Platform for EMC Documentum,11g Release 1 (11.1.1)

Copyright 2012 Oracle and/or its affiliates. All rights reserved.

Primary Author: Tatiana Kolubayev

Contributor: Valentin Vakar, Chandrashekar Avadhani, Suman Saha

This software and related documentation are provided under a license agreement containing restrictions on

use and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify,license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.Reverse engineering, disassembly, or decompilation of this software, unless required by law forinteroperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. Ifyou find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it onbehalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technicaldata delivered to U.S. Government customers are "commercial computer software" or "commercial technicaldata" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplementalregulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to therestrictions and license terms set forth in the applicable Government contract, and, to the extent applicable

by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, CommercialComputer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City,CA 94065.

This software or hardware is developed for general use in a variety of information management applications.It is not developed or intended for use in any inherently dangerous applications, including applications thatmay create a risk of personal injury. If you use this software or hardware in dangerous applications, then youshall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure itssafe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of thissoftware or hardware in dangerous applications.

Oracle and J ava are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks oftheir respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks areused under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced

Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products,and services from third parties. Oracle Corporation and its affiliates are not responsible for and expresslydisclaim all warranties of any kind with respect to third-party content, products, and services. OracleCorporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to youraccess to or use of third-party content, products, or services.


3/50

3

Oracle WebCenter Sites Administrators Guide for CIP for EMC Documentum

Table of

Contents

About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Terms and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6Third-Party Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

1 Installing Content Integration Platform for EMC Documentum . . . . . . . . . . . 7

Installation Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Packaging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Installation Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10StepI. Install Content Integration Agent. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

StepII. Install CIP Publishing Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Step II I. Install Schema to Support Archiving to Documentum . . . . . . . . . . . . . . . .14

Step IV. Back Up the Default mappings.xml File . . . . . . . . . . . . . . . . . . . . . . . . . .14

Next Step. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

2 Configuring Event Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Overview of Event Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Configuring Event Notification Workflows for WebCenter Sites . . . . . . . . . . . . . . . . . .18

Installing Default Workflows on WebCenter Sites. . . . . . . . . . . . . . . . . . . . . . . . . . .20

Verifying the Installation of Default Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . .20Enabling Default Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Configuring Event Notification Workflows for EMC Documentum . . . . . . . . . . . . . . . .21

3 Publish ing to Oracle WebCenter Sites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Overview of the Publishing Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

System Architecture and Process Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .24

Mapping Framework. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25


4/50

Table of Contents4


Publishing Procedures. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Publishing via the Default Mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Publishing via Customized Mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Maintaining the Integrated Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

Tuning the Synchronization Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

Unpublishing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30

4 Arch iving to EMC Documentum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Overview of the Archival Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

System Architecture and Process Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34

CS DataStore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35

Mapping Framework. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .37

Steps for Archiving WebCenter Sites Assets to Documentum. . . . . . . . . . . . . . . . . . . . .38

Step I. Prepare the Documentum System to Store WebCenter Sites Assets. . . . . .38

Step II. Configure the Path to the CS DataStore. . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Step III. Add Metadata to mappings.xml . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Step IV. RealTime Publish the Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Step V. Archive the CS DataStore on Documentum . . . . . . . . . . . . . . . . . . . . . . . .40

Step VI. Archive Visitor-Generated Content. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41

Testing Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

Tuning the Synchronization Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

A. Defau lt Mapp ing Speci ficat ions fo r Publ ishing . . . . . . . . . . . . . . . . . . . . . . .45

Mapping Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46

Documentum Flex Family Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49


5/50

5


About This Guide

This guide contains procedures for installing, configuring, and using Oracle WebCenterSites: Content Integration Platform for EMC Documentum to transfer content betweenOracle WebCenter Sites and EMC Documentum. Supported modes include publishingDocumentum objects to WebCenter Sites and archiving the assets of WebCenter Sites toEMC Documentum.

Applications discussed in this guide are former FatWire products. Naming conventions arethe following:

Oracle WebCenter Sites is the current name of the product previously known asFatWire Content Server. In this guide,Oracle WebCenter Sites is also calledWebCenter Sites.

Oracle WebCenter Sites: Content Integration Platformis the current name of the

application previously known asFatWire Content Integration Platform. In this guide,Oracle WebCenter Sites: Content Integration Platformis also calledContentIntegration Platform, or CIP. The version described in this guide supports integrationwith EMC Documentum.

Oracle WebCenter Sites: Web Experience Management Framework is the currentname of the environment previously known asFatWire Web Experience ManagementFramework. In this guide, Oracle WebCenter Sites: Web Experience ManagementFramework is also calledWEM Framework.

Oracle WebCenter Sites: Community is the current name of the application previouslyknown asFatWire Community Server. In this guide, Oracle WebCenter Sites:Community is also calledCommunity.

Content Integration Platform for EMC Documentum integrates with Oracle WebCenterSites according to specifications in theOracle WebCenter Sites 11g Release 1 (11.1.1.x)Certification Matrix. For additional information, see the release notes for ContentIntegration Platform for EMC Documentum. Check the WebCenter Sites documentationsite regularly for updates to theCertification Matrixand release notes.

Audience

This guide is intended for general administrators of WebCenter Sites, who also haveexperience with installing and configuring enterprise-level software. Also required is a


6/50

About This Guide6


strong understanding of the WebCenter Sites flex asset model and RealTime publishing, inaddition to a clear understanding of EMC Documentum and its data models.

Related Documents

For more information, see the following documents:

Oracle WebCenter Sites Administrators Guide

Oracle WebCenter Sites: Developing a Java Adapter and Plug-In for ContentIntegration Platform

Conventions

The following text conventions are used in this guide:

Boldfacetype indicates graphical user interface elements that you select.

Italictype indicates book titles, emphasis, or variables for which you supply particular

values. Monospace type indicates file names, URLs, sample code, or text that appears on the

screen.

Monospace bol d type indicates a command.

Terms and Acronyms

This guide uses CIP-specific terms such asCS Data Store. The terms are defined in theGlossary section at the end of this guide.

Third-Party Libraries

Oracle WebCenter Sites and its applications include third-party libraries. For additionalinformation, seeOracle WebCenter Sites 11gR1: Third-Party Licenses.


7/50

7


Chapter 1

Installing Content Integration Platform forEMC Documentum

This chapter contains procedures for installing and configuring the Oracle WebCenterSites: Content Integration Platform for EMC Documentum to support content transferbetween WebCenter Sites and Documentum installations.

This chapter contains the following sections:

Installation Overview

Prerequisites

Packaging

Installation Steps

Next Step


8/50

Chapter 1. Installing Content Integration Platform for EMC Documentum

Installation Overview8


Installation Overview

Content Integration Platform for EMC Documentum enables bidirectional communicationbetween 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 byCIP as the source of data. The CS DataStore is created when assets are published fromWebCenter Sites to a RealTime destination with archiving enabled. The CS DataStorestores the published assets in its file system.

CIP supports publishing and archiving by replicating the source systems metadata to thetarget system. Schema that stores the source systems content is thus established on thetarget system. Content on the source system can then be transferred to the target systemvia the CIP command-line interface andci pcommander publ i sh command. Once thepublishing session ends, the synchronization engine starts monitoring the source systems

published (or archived) workspaces for changes to content and automatically replicates themodified 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, whichmanages metadata and the associated content. Content Integration Agent includes:

- mappi ngs. xml , which maps the source systems metadata to the target system.

- ci pcommander , a command-line application used to run the CIP publ i shcommand. The same command publishes to WebCenter Sites (via Sites AgentServices) and archives to Documentum.

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

- catal og. xml , which stores information about published and archived items andserves as a configuration file for tuning the synchronization process.

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

- The programmatic interface, named Sites Agent Services, receivesDocumentum data from Content Integration Agent and stores the data toWebCenter Sites database tables. The stored data consists of metadata inWebCenter Sites-compliant format and objects associated with the metadata.

- Database tables for storing published objects are in the form of theDocument umflex family, a data model that must be installed on the WebCenter Sitesmanagement system and enabled on one of its content management sites. Bydefault, theDocument umflex family also contains definitions of theDocumentum object typesdm_f ol der anddm_document . Both object types aremapped in the defaultmappi ngs. xml file.

To enable archiving, you will install thef w_asset and f w_document object typeson Documentum to provide the schema for storing WebCenter Sites assets asDocumentum objects. The object types are mapped inmappi ngs. xml .


9/50


Prerequisites9


Prerequisites

Before installing Content Integration Platform, do the following:

Download theOracle WebCenter Sites Certification Matrixand release notes for thiscontent integration product.

Download the following:

- Microsoft Visual C++2008 Redistributable (x86) fromht t p: / / www. mi crosof t . com

- OpenSSL fromht t p: / / www. openssl . or g

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

If you wish to set up CIP for publishing operations, create or select a contentmanagement site on the WebCenter Sites staging system for theDocument umflexfamily you will be installing.

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

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

Also consider the following post-installation scenario: If your WebCenter Sites deliverysystem is running the Oracle WebCenter Sites: Community application and you wish toarchive site visitors comments and reviews, you will need to RealTime publish thecomments and reviews from the delivery system to a separate WebCenter Sites system.For more information, seeStep VI. Archive Visitor-Generated Content, on page41.

Packaging

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

File Description

ci pagent - vNo. msi (for Windows)ci pagent - vNo. r pm. bi n (for Linux)

For publishing and archiving. These files install ContentIntegration Agent (ci pcommander andser vi ce) andconfiguration files that control the Content IntegrationAgents process.

One of these files must be installed on a machine withthe supported operating system and the ability to access

both the source and target systems.

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

This file must be deployed on a system other thandelivery. The system must have access to theWebCenter SitesShar ed directory.


10/50


Installation Steps10


Installation Steps

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

StepI. Install Content Integration Agent

StepII. Install CIP Publishing ComponentsStep III. Install Schema to Support Archiving to Documentum

Step IV. Back Up the Default mappings.xml File

Next Step

Step I. Install Content Integration Agent

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

2. Run theci pagent file on a machine with a supported operating system and theability to access the source and target systems.

- Windows:

Runci pagent - 2. 0. 0- 127. msi and follow the prompts.

The following folders are created in the target directory:

bi nci pagent . execi pcommander . exe

conf. . al l conf f i l es

secur i t y. . al l cer t i f i cat es and pr i vat e keys

l ogs. . l og f i l e

l i censes

. . l i censes- Linux:

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

. / ci pagent - 2. 0. 0- 128. el 5. i 386. r pm. bi n

The following directories are installed:

usrl ocal

bi nci pagent - exe

cs_documentum_schema. zi p For publishing. This file installs theDocument umflexfamily on WebCenter Sites, on the CM site that you

specify.

document um_cs_schema. dar For archiving. This file installs schema on theDocumentum system to support the content of theCS DataStore.

File Description


11/50




ci pcommanderl i b

ci pagent. . al l l i br ar i es

shar e

ci pagentconfsecur i t yl ogsl i censes

3. Back up the configuration filecatal og. xml (located in i nt egr at i on_agent /conf / ).

4. Editcat al og. xml .

Thecat al og. xml file stores configuration settings that Content Integration Agentrequires to connect to the source system and Oracle WebCenter Sites. You will editthis file to provide Content Integration Agent with system location and userinformation.

a. Opencat al og. xml in a text editor.b. Edit the adapter for Oracle WebCenter Sites:

Locate the provider element with name cs and id 70b1e307- 26a1- 499c-9295- cf 0b6bd01342 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 thehost and the port number where WebCenter Sites is running. Do not alter thecontext name and context-related path unless you they differ from the default(ht t p: / / l ocal host : 8080/ csagent ser vi ces/ I nf ost or i aSer vi ce).

- username:User name of the account that has permissions to modifyWebCenter Sites database tables (e.g., f wadmi n, the general administrator).

- password: Above users password (e.g., xcel admi n, assumingf wadmi n isthe username).

- context: Leave this blank.

c. Edit the adapter for the EMC Documentum installation:

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

- urlDocumentum: URL pointing to the server where DocumentumFoundation Services (DFS) are running. Include the context name, but omitcontext-related paths. Typically you need to modify only the host name (thedefault value isht t p: / / l ocal host: 9090).

- username:User name for the account that has permissions to publishablecontent.

- password: Above users password.

- filter:This parameter contains awher e clause which is applied to filter outdocument versions that are not intended for publication. For example, topublish the latest approved version of a document, you can specify valuessuch as the following:

r _pol i cy_i d = ' 0000000000000000'


12/50




- or -

r _cur r ent _st at e = 1

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

d. Savecat al og. xml .5. Restart the Content Integration Agent executable:

- Windows: Restart the Content Integration Agent service.

- Linux: Type as root user: / sbi n/ ser vi ce r est ar t ci pagent

6. In f aci l i t i es . xml , enable the java facility section. Specify the path to Java onyour system.

7. Continue to the next step, A. Installing Sites Agent Services.

Step II. Install CIP Publishing Components

If you wish to install only archival capability, skip toStep III. Install Schema to SupportArchiving to Documentum, on page14. Otherwise, complete all the steps in this sectionto install publishing capability.

A. Instal ling Sites Agent Services

1. Edit the following files incsagent servi ces. war (all the files are located incsagent servi ces/ WEB- I NF/ cl asses):

- commons- l oggi ng. pr opert i es: defines the log file and log detail settings.

- csAgent Ser vi ces. pr oper t i es: enables access to the WebCenter Sitesdatabase.

Note

The Content Integration Agent executable can be run as a standalone processor as a system daemon. The executable will start a simple HTTP server on thedefault port7070, which is reserved for CI PCommander communicationswith Content Integration Agent. Port 7070 is bound to the localhost, andtherefore does not expose your system to any additional security risks.

Thef i l eserver facility default configuration takes port 7071 and attemptsto automatically detect the host name. If multiple network interfaces areinstalled on the machine where Agent is running, we advise changingaut o tothe DNS name or the IP address that is accessible from the Sites AgentServices installation.

Should you need to change the port, edit the port designation inf aci l i t i es . xml and add - p to all commands that startCI PCommander .

Note

Sites Agent Services can be installed on any WebCenter Sites system other thandelivery. We recommend a content management (staging) system.


13/50




a. Using a text editor, edit commons- l oggi ng. pr opert i es to point to the SitesAgent Services log file (agent ser vi ces. l og).

b. Create a data source specific to the application server. (More information isavailable in the guide for installing WebCenter Sites on the application server you

are using.)

c. ModifycsAgent Ser vi ces. pr oper t i es to enable access to the WebCenterSites database.

1) Using a text editor, set the following properties:

- upl oader . username: User name of an account with permissions to editflex families.

- upl oader. password: Password for the above user name.

- cs. i nstal l Di r : WebCenter Sites installation directory (e.g., C: \ CS)

- cs.url: WebCenter Sites URL. Point to the WebCenter Sites webapplication. The default value is: ht t p: / / l ocal host: 8080/ cs

2) SavecsAgent Ser vi ces. pr oper t i es.

2. Deploy csagent servi ces. war on the application server on the WebCenter Siteshost.

3. Restart the application server.

4. Continue to the next step, B. Installing EMC Documentum Schema on OracleWebCenter Sites.

B. Installing EMC Documentum Schema on OracleWebCenter Sites

In this step, you will importcs_documentum_schema. zi p into WebCenter Sites to

support the publication of Documentum objects to WebCenter Sites.

To install the Documentum schema

1. Runcat al ogmover. bat (or cat al ogmover . sh on Linux) from the WebCenterSites installation directory.

Note

Before using CatalogMover, connect it to WebCenter Sites:

1. ChooseServer >Connect.

2. Provide the following information:

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

- Name: Cont ent Ser ver

- Password:

- Below the Password field, select (or enter) a value that applies toyour WebCenter Sites installation.

3. ClickConnect.


14/50


Next Step14


2. Go toCatalog >Auto Import Catalog(s).

a. Select the file to import.

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

Catalog Data Directory: Leave the default valueCatalog 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:

a. Enable theDocument umflex family on the content management site you havechosen or created, as explained inPrerequisites, on page9.

b. For quick access to published content, create a tree tab (namedDocumentum, forexample).

For instructions on enabling flex families, creating sites, and creating tree tabs, see theOracle WebCenter Sites Administrators Guide.

4. Continue to the next step, Step III. Install Schema to Support Archiving toDocumentum.

Step III. Install Schema to Support Archiving to Documentum

Install document um_cs_schema. dar using Documentum Composer (installationinstructions and user information are available in theDocumentum Composer UserGuide):

CREATE TYPE f w_asset (f w_i d char ( 255) ,f w_name char ( 64) ,f w_cr eatedby char ( 64) ,f w_cr eat eddate t i me,f w_descr i pt i on char ( 128) ,f w_publ i st char ( 255) ,f w_st at us char ( 2) ,f w_subt ype char ( 32) ,f w_updat edby char ( 64) ,f w_updat eddat e t i me,f w_publ i sheddat e t i me) WI TH SUPERTYPE dm_document

CREATE TYPE f w_document (f w_publ i sheddat e t i me,f w_name char ( 64)

) WI TH SUPERTYPE dm_document

Step IV. Back Up the Default mappings.xml File

Themappi ngs. xml file is located on the server that hosts Content Integration Agent.

Next Step

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


15/50


Next Step15


Optional. Configure event notification workflows to inform CIP administrators aboutevents that are triggered on the target system by changes to data in the source systemsmonitored workspaces (i.e., published or archived workspaces).

To publish from Documentum to WebCenter Sites, skip toChapter 3, Publishing toOracle WebCenter Sites for background information and instructions.

To archive WebCenter Sites assets to Documentum, skip toChapter 4, Archiving toEMC Documentum for background information and instructions.

Note

If you choose to configure event notification workflows, you must do sobefore publishing any Documentum objects or archiving any WebCenter Sitesassets. For instructions on configuring event notification workflows, seeChapter 2, Configuring Event Notification.


16/50


Next Step16



17/50

17


Chapter 2

Configuring Event Notification


Overview of Event Notification

Configuring Event Notification Workflows for WebCenter Sites

Configuring Event Notification Workflows for EMC Documentum


18/50

Chapter 2. Configuring Event Notification

Overview of Event Notification18


Overview of Event Notif ication

Event notification keeps Content Integration Platform administrators informed about thesynchronicity of source and target systems as changes to content are made on either

system. Event-driven notices are delivered to administrators in a simple workflow processwhich can be enabled globally or selectively for specific events (such as item creation) andfor specific types of items.

Configuring Event Notification Workflows forWebCenter Sites

In the CIP publishing model, event notification is the process of informing CIPadministrators of actions that occur on WebCenter Sites when changes are made tomonitored workspaces cabinets or folders on Documentum.

Monitoring of a workspace begins once its metadata and associated objects are firstpublished to WebCenter Sites via theci pcommander publ i sh command. Thesynchronization engine starts listening to the workspace for changes to content andautomatically replicates them to WebCenter Sites, where they are treated as events. Ifevent notification is configured, the events invoke WebCenter Sites workflows to sendnotices confirming the events. Failed events also trigger notices if the associatedworkflows are configured.Table1lists the supported events and default workflows.

Note

If you choose to configure CIP for event notification, you must do so beforepublishing objects to WebCenter Sites or archiving assets to Documentum. Forinstructions, see:

Configuring Event Notification Workflows for WebCenter Sites

Configuring Event Notification Workflows for EMC Documentum, onpage21

Table 1: Default workflows for WebCenter Sites

Event inWebCenter Sites Workflow Process

Asset creation CI PAsset Cr eat ed. Invoked when an object is created in amonitored cabinet or folder and the counterpart asset is created inWebCenter Sites.

Asset deletion CI PAssetDel et ed. Invoked when an object is deleted from amonitored cabinet or folder and the counterpart asset is deleted fromWebCenter Sites.

Asset deletion failure CI PAsset Del et i onFai l ed. Invoked when:

An object that was deleted from the monitored cabinet or folder ischecked out on the WebCenter Sites system.

An object that was deleted from the monitored cabinet or folder hasdependencies that would become unresolved on the WebCenterSites system if the counterpart asset were to be deleted.


19/50


Configuring Event Notification Workflows for WebCenter Sites19


Default workflows have the following properties:

Default workflows consist of one state and two steps. When an event occurs, only thefirst step of the corresponding workflow is taken. If the option Assign from list ofparticipants is chosen, all members with the selected roles are assigned the first task.

All supported events trigger notices to users with roleCI PAdmi n. Tasks may or maynot be assigned, depending on the event:

- A task is assigned for the following events: creation, deletion failure,modification, and modification failure. The task is simply a way of notifying theuser whether an event occurred or failed on WebCenter Sites. The task can beremoved; there is no obligation to take a step.

- For deletion events, no task is assigned (the asset no longer exists).

Asset modification CI PAsset Modi f i ed. Invoked when an object in the monitoredcabinet or folder is modified and the counterpart asset is created inWebCenter Sites.

Asset modificationfailure

CI PAsset Modi f i cat i onFai l ed. Invoked when an object in themonitored cabinet or folder is modified, but its counterpart asset ischecked out in WebCenter Sites.

Note

Although workflows related to the publishing processes can be created, it is

typically more convenient to use workflows that are provided with CIP. If youwish to create your own workflows, refer to instructions in the Oracle WebCenterSites Administrators Guide.

Table 1: Default workflows for WebCenter Sites (continued)

Event inWebCenter Sites Workflow Process


20/50


Configuring Event Notification Workflows for WebCenter Sites20


Installing Default Workflows on WebCenter Sites

1. Runcat al ogmover. bat (or cat al ogmover . sh on Linux) from the WebCenterSites installation directory.

2. Go toCatalog >Auto Import Catalog(s).a. Selectwor kf l ows. zi p (in the same directory or level as all cs_*_schema. zi p

files).

b. 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. Create the default workflows by invoking the following URL:

ht t p: / / : / /Cont ent Server ?pagename=OpenMarket / Xcel erat e/ I nst al l at i on/CI PCreat eWor kf l ows&user name=&=

where:- host is the address of the WebCenter Sites installation

- port is the port of the WebCenter Sites installation

- cont ext _pat h is the context path where the WebCenter Sites web application isdeployed

- user name is the WebCenter Sites administrators user name

- password is the WebCenter Sites administrators password

For example, the URL of the default configuration is:

ht t p: / / l ocal host : 8080/ cs/ Cont ent Server ?pagename=OpenMarket /Xcel er at e/ I nst al l at i on/ CI PCr eat eWor kf l ows&user name=f wadmi n&passwor d=xcel admi n

When the workflows are created, the following message is displayed:

Wor kf l ows f or Cont ent I nt egr ati on Pl at f or m wer e creat edsuccessf ul l y

Verifying the Installation of Default Workflows

When the default workflows are created, associated items (such as roles and email objects)are also created in WebCenter Sites.

To verify default workflows and their associated items

1. Log in to the WebCenter Sites Admin interface as a general administrator (defaultcredentials: f wadmi n / xcel admi n).

2. Verify that the following items have been created:

- CI PAdmi n role, which will be used as the management role in all CIP workflows.All users with theCI PAdmi n role will be notified of all CIP events in the defaultworkflows.

- Workflow processes:CIP Asset Created, CIP Asset Deleted, CIPAssetDeletionFailed,CIPAssetModified, and CIP AssetModificationFailed


21/50


Configuring Event Notification Workflows for EMC Documentum21


- Workflow states:CIPAssetCreated, CIPAssetDeleted, CIPAssetDeletionFailed,CIPAssetModified, and CIPAssetModificationFailed

- Workflow step action:

CIPAssetDeleted, which results in an email notice to the CIP administrators.

- Email object:CIPAssetEvent

Enabling Default Workflows

Default workflows are pre-configured in the defaultmappi ngs. xml file. Each listed assettype contains a commented workflow configuration section.

To enable a CIP workflow

1. Openmappi ngs. xml (on the Content Integration Agent host), go to the section and uncomment the required workflows

(below) for each asset type that must be enabled for event notification:CI PAsset Cr eatedCI PAssetModi f i edCI PAsset Del et edCI PAsset Del et i onFai l ed

CI PAssetModi f i cat i onFai l ed

2. Assign theCI PAdmi n role to CIP administrators. Verify that CIP administrators areable to receive email. For instructions, see theOracle WebCenter Sites AdministratorsGuide.

3. If a relatively large number of events occur on the source system, it is best to useworkflow groups, as they allow you to resolve tasks in bulk. Workflow groups are notpackaged by default. They must be created manually. For instructions, see theOracleWebCenter Sites Administrators Guide.

Configuring Event Notification Workflows forEMC Documentum

In the archival model, event notification is the process of informing CIP administrators ofactions that occur in Documentum folders when changes are made to monitoredCS DataStores.

Monitoring of a CS DataStore begins when its metadata and associated files are firstarchived to Documentum via theci pcommander publ i shcommand. Thesynchronization engine starts listening for changes to the content of the CS DataStore and

Note

If a workflow group has the name of the invoked workflow process, theworkflow process will be automatically added to the group.


22/50


Configuring Event Notification Workflows for EMC Documentum22


automatically replicates them to the Documentum target folders, where they are treated asevents. If event notification is configured, the events invoke Documentum workflows tosend notices confirming the events.Table2lists the supported events.

To enable notifi cation work flows for archival events

1. Create your own workflow processes in Documentum or re-use workflow processes.Define the packages as necessary.

2. Openmappi ngs. xml and go to.

a. Uncomment the required workflow processes and packages (below) for each assettype that must be enabled for event notification:

Pr ocessNamePr ocessNamePackageNamePackageName

b. ReplacePr ocessNamewith the name of the workflow process that should beautomatically started.

c. PackageName is an optional parameter. IfPackageName is not specified, anasset will be placed into the first available package.

Table 2: Event Notification Workflows for the Archival ProcessEvent in

Documentum Workflow

Object creation Invoked when a new asset is created in the CS DataStore and itscounterpart object is created in Documentum.

Object modification Invoked when an asset is modified in the CS DataStore and itscounterpart object is created in Documentum.

Note

Event notification related to the archival process requires you to create or reuseDocumentum workflows.


23/50

23


Chapter 3

Publishing to Oracle WebCenter Sites


Overview of the Publishing Process

Publishing Procedures

Maintaining the Integrated Systems


24/50

Chapter 3. Publishing to Oracle WebCenter Sites

Overview of the Publishing Process24


Overview of the Publishing Process

Publishing from EMC Documentum to Oracle WebCenter Sites requires the CIPcomponents Content Integration Agent and Sites Agent Services, shown in Figure1.

Figure 1: System Architecture for Publish ing to Oracle WebCenter Sites

System Architecture and Process Flow

Content Integration Agent is used to synchronize the source and target workspaces via theci pcommander publ i shcommand, the synchronization engine, and themappi ngs. xml file, which provides the metadata map. Sites Agent Services exposes theweb interface used by Content Integration Agent to perform the synchronization process.Following a publishing session, the synchronization process runs automatically. Details ofthe implementation are described below.

Initial Synchronization

When theci pcommander publ i sh command is issued, the synchronization engineinitializes the source and target by replicating metadata and associated content as outlinedbelow (and inFigure2, on page25):

1. The synchronization engine reads themappi ngs. xml file,

2. refers to the Documentum workspace (i.e., cabinet or folder) named in theci pcommander publ i sh command,

a. reads the workspaces objects to retrieve their mapped metadata,

b. converts the metadata to WebCenter Sites-compliant format, using themappi ngs. xml file

3. stores the WebCenter Sites-compliant metadata to WebCenter Sites (via Sites AgentServices),
http://-/?-http://-/?-


25/50




4. retrieves from Documentum the content of binary objects associated with themetadata, and

5. stores the objects (via Sites Agent Services) to the target flex family.

Figure 2: Publishing Process

Monitoring the Data Source

Following the initial synchronization, the synchronization engine starts monitoring thepublished cabinet or folder and automatically replicates changes to WebCenter Sites (via

Sites Agent Services). For example, when an object based on the published metadata iscreated, modified, or deleted in the monitored cabinet or folder, the synchronizationengine replicates the new or modified object, or the objects deletion to WebCenter Sites.If metadata schema is modified, the workspace must be republished.

Tuning the Integration

Content Integration Agent contains a configuration file namedcatal og. xml , whichstores information about the publishing session. Various parameters in the file can betuned once the synchronization process is initialized. When objects are unpublished,their information is deleted fromcat al og. xml . For more information about tuning, seeTuning the Synchronization Process, on page30.

Mapping Framework

The CIP mapping framework determines the success of the publishing andsynchronization processes. Documentum objects can be published to WebCenter Sites aslong as their metadata is mapped. The basic mapping framework for publishing involvestwo configurable components: theDocument umflex family and themappi ngs. xml file.

2b Convert metadata to

WebCenter Sites format

4 Retrieve binaryobject contentassociated withmetadata in step 2

2a Retrieve mapped

metadata3 Store metadata

(Sites-compliant)

ContentIntegration

Agent

5 Store binaryobject contentassociated withmetadata in step 3

1 Readmappi ngs. xml

EMC

Documentum

Oracle

WebCenter Sites


26/50




Target Flex Family

TheDocument umflex family, provided with CIP, stores published objects and their objecttype definitions as WebCenter Sites assets.AppendixA provides flex familyspecifications.

For simplicity, we recommend using the default flex family. Should you need to createyour own flex family, refer to instructions in theOracle WebCenter Sites AdministratorsGuide. Use the information inAppendixA of this guide as a model of the flex family.

mappings.xml

The defaultmappi ngs. xml file contains adocument um2cs section, which specifies themappings listed below:

Thedm_f ol der type maps toDocumentum_Fol der; dm_f ol der in theDocument umflex family, where

- Document um_Fol der is a flex parent asset type that stores folder assets.

- dm_f ol der is a parent definition (of typeDocument um Par ent Def i ni t i on)that defines the folder type.

Thedm_document type maps toDocument um_Document ; dm_document in theDocument umflex family, where

- Document um_Document is a flex asset type that stores document assets.

- dm_document is a child definition (of typeDocument um Chi l d Def i ni t i on)that defines the document type.

Attributes are mapped in thetags. Attributes arenamed as listed under the Types node of the Documentum WebTop interface:

- t i t l e- subj ect

- keywor ds- r _ver si on_l abel- r_ f ul l _cont ent _si ze

Mapping, Publishing, and Synchronization

When publishing, bear in mind the following mapping specifications:

Documentum objects based on default metadata can be published to WebCenter Siteswithout you having to modify either the default mappi ngs. xml file or theDocument umflex family. Running theci pcommander publ i sh commandreplicates the specified workspace and its subfolders to theDocument umflex familyasflexparents; documents are replicated asflex child assets. The published workspaceis then monitored by the synchronization engine.

Publishing objects based on custom metadata (such as a new document type) requiresyou to first update at least the flex family with the new metadata. The mappi ngs. xml file may or may not require updates, depending on the nature of the metadata. Detailsof custom mappings can be found inPublishing via Customized Mappings,onpage29.


27/50


Publishing Procedures27


Publishing Procedures

Publishing via the Default Mapping

Publishing via Customized Mappings

Publishing via the Default Mapping

In this section, you will publish cabinets and folders to WebCenter Sites using the defaultmappi ngs. xml file andDocument umflex family.

To publ ish

1. Start Content Integration Agent.

2. Run theCI PCommander executable (located in thebi n folder of the system whereContent Integration Agent is installed).

3. Publish objects of the types that are specified in the defaultmappi ngs. xml file (fordefinitions of publishing parameters, seeTable3, on page28):

ci pcommanderpubl i sh - sour ce_r epname

- sour ce_pat h - t ar get _r epname - mappi ng - r epl i c_mode - bul k_r esynch_i nt er val

Examples:

- To publish theI mages cabinet to the CIPDemo content management site:

ci pcommander publ i sh d7a96a63- e78c- 407c- 8d7f - e84988806e4970b1e307- 26a1- 499c- 9295- cf 0b6bd01342

- sour ce_r epname I mages- sour ce_pat h /- t ar get _r epname CI PDemo

- mappi ng document um2cs

- To publish the/ Sampl e/ Trees folder in the I mages cabinet to the CIPDemocontent management site:

ci pcommander publ i sh d7a96a63- e78c- 407c- 8d7f - e84988806e4970b1e307- 26a1- 499c- 9295- cf 0b6bd01342

- sour ce_r epname I mages- sour ce_pat h / Sampl e/ Trees- t ar get _r epname CI PDemo- mappi ng document um2cs

Note

If you changed the port instep5 on page12(starting Content Integration

Agent), make sure that the new port is set in f aci l i t i es . xml , and add- p to theci pcommander publ i sh command instep3, below(which startsCI PCommander ).


28/50




4. When the publishing session ends, the synchronization engine starts monitoring thepublished object.

- Verify that modifications and deletions are replicated to WebCenter Sites (forexample, modify the replicated objects, add folders and documents to the

monitored object, and delete documents).

- Objects can also be unpublished. For information, seeUnpublishing,onpage30.

- To optimize the synchronization process, seeTuning the SynchronizationProcess, on page30.

Table 3: Publishing Parameters

Publishing Parameter Required Value

R Provider ID for Documentum:

d7a96a63- e78c- 407c- 8d7f - e84988806e49

R Provider ID for WebCenter Sites:

70b1e307- 26a1- 499c- 9295- cf 0b6bd01342

- source_r epname R : Name of the cabinet containing the objectsto be published. Enter the name exactly as it appears in theURL.

- sour ce_path : Path to the object you want to publish.

/(to publish the cabinet specified by)

/ / / . . . / (to publish the last folder in the path)

- t arget _r epname R Name of the content management site (on WebCenter Sites) onwhich the target flex family is enabled. Enter the sites displayname, exactly as it appears on theAdmin tab in the WebCenterSites Admin interface.

- mappi ng R : Value of themappi ng i d inmappi ngs. xml .The value isdocument um2cs.

- r epl i c_mode f ul l | new | updat ed

f ul l means that a full replication will be performed (bydefault), i.e., newly created items, updated items, anddeletions.

newmeans that only newly created items will be replicated(updates and deletions will not be replicated).

updat ed means that only new and updated items will bereplicated (deletions will not be replicated).

- bul k_resynch_i nt er val

: Number of seconds between two successivesynchronization events.

Default value: 600

For optimal performance, set the synchronization interval to avalue that agrees with the frequency of updates to the monitoredfolders. For more information, seeTuning the SynchronizationProcess, on page30.


29/50




Publishing via Customized Mappings

If the objects you plan to publish are based on unmapped metadata, you must first map theobject types.

To publish via customized mappings

1. Depending on which type of metadata you have created, update the relevant mappingcomponents as shown below. (We suggest reusing theDocument umflex family. Themappi ngs. xml file is located on the Content Integration Agent host).

2. If you create flex filters, add the correspondingj ar files to both the WebCenter Sitesand the Sites Agent Services applications.

3. Publish the objects. For instructions, seePublishing Procedures, on page27.

New Metadata Update Guidelines

New folder type Document umflexfamily

Create a parent definition for the new folder type.(The default parent definition isdm_f ol der .)

mappi ngs. xml Map the new folder type (sour ce i d).Thet arget i d takes the value

Document um_Parent ; (whereDocument um_Par ent defines the storagetable for folder assets).

New document type Document umflexfamily

Create a child definition for the new documenttype. (The default child definition isdm_document .)

mappi ngs. xml Map the new document type (sour ce i d).Thet arget i d takes the valueDocument um_Chi l d;

(whereDocument um_Chi l d defines the storagetable for document assets).

New documentattribute

Document umflexfamily

Add the new attribute to the Documentum flexfamily.

Updatingmappi ngs. xml is conditional

Mapping the new attribute is required only if itsname differs on the source and target.

Note: Incorrect mapping of attributes does notstop the publication process, but it does produce awarning message and an entry in the log file.


30/50


Maintaining the Integrated Systems30


Maintaining the Integrated Systems

Tuning the Synchronization Process

Unpublishing


When a cabinet or folder is published, cat al og. xml is updated with data points from theci pcommander publ i sh command. The data points identify the Documentum andWebCenter Sites systems (in thetags) and specify replication settings (inthe tag).

Following a publishing session, the synchronization engine monitors the published cabinet(folder), usingcatal og. xml . TheBul kResynchI nt erval andRepl i cModeparameters listed in the sample file below can be reset as shown inTable3, on page28.(Thecat al og. xml file is located in theconf folder on the Content Integration Agent

server.)

Sample catalog.xml

Document s/ I mages0c000001800045f e0b0000018002c58e

Fi r st Si t eI I 68ef 906a- 6c59- 406a- 84c2- b73b098cdb93

600f ul l

10

Unpublishing

You can unpublish objects fromcat al og. xml and WebCenter Sites by executing theci pcommander unpubl i sh command. The command clears catal og. xml of allentries that are associated with published objects (for a sample publication entry, see the


31/50




sample file onpage30). The- del et e parameter removes the same entries fromWebCenter Sites database.

Theunpubl i sh command takes the following form and parameters:

ci pcommander unpubl i sh

Table 4: Unpublish Parameters

UnpublishParameter Description

- al l Clearscat al og. xml ofall publication entries.

- l i nki d Clearscat al og. xml ofselectedpublication entries.

l i nki d specifies the published objects link to the WebCenter Sitessystem. Use the value in the published objects tag, which isnested within the objects tag (for sample code, seepage30).

For example, to unpublish an object withl i nki d332e73c8- e977-4ba4- 85c2- d7636281e192 fromcat al og. xml , run the followingcommand:

ci pcommander unpubl i sh l i nki d 332e73c8- e977- 4ba4-85c2- d7636281e192

- del et e Removes from WebCenter Sites database the same objects that you areunpublishing fromcat al og. xml .

Legal values:

Default value: true


32/50





33/50

33


Chapter 4

Archiving to EMC Documentum


Overview of the Archival Process

Steps for Archiving WebCenter Sites Assets to Documentum

Testing Synchronization



34/50

Chapter 4. Archiving to EMC Documentum

Overview of the Archival Process34


Overview of the Archival Process

Archiving WebCenter Sites assets to EMC Documentum requires the components showninFigure3. Users who are familiar with the process of publishing Documentum objects to

WebCenter Sites will recognize archiving to be a similar process.

Figure 3: System Architecture for Archiving

The main differences between publishing and archiving are the following:

In the archival process, Content Integration Agent treats the CS DataStore, rather thanWebCenter Sites, as its source of data. The CS DataStore contains assets in folders andfiles that map to Documentum folders of typedm_f ol der and files of typef w_document . The CS DataStore is created when assets in the WebCenter Sitessystem are published to a RealTime destination while archiving is enabled.

Content Integration Agent archives data to Documentum directly. It does not requirethe Sites Agent Services component to store data on the target system.

System Architecture and Process Flow

Content Integration Agent synchronizes the CS DataStore and target Documentum foldervia thepubl i sh command, the synchronization engine, and themappi ngs. xml file,which provides the metadata map. Following the initial archival session, thesynchronization process runs automatically. Details of the implementation are describedbelow.

Initial Synchronization

Issuing thepubl i sh command invokes the synchronization engine to archive theCS DataStore to Documentum and thereby initialize the synchronization process. Thecomplete set of steps is outlined below (and shown in Figure3):

1. Assets in WebCenter Sites are RealTime published with archiving enabled.


35/50




2. The CS DataStore is created.

3. Issuing thepubl i sh command invokes the synchronization engine, which then:

a. refers to the CS DataStore (which is specified in thepubl i sh command),

b. reads the files in the CS DataStore, retrieves their metadata, andc. converts the metadata to a Documentum-compliant format, using

mappi ngs. xml .

4. The synchronization engine then stores the CS DataStore files to the targetDocumentum folder.

Monitoring the CS DataStore

Following the initialization process, the synchronization engine monitors the archivedCS DataStore and automatically replicates changes to the Documentum target folder.When an asset based on the archived metadata is created or modified in the monitoredCS DataStore (during a RealTime publishing process), the synchronization engine

replicates the new or modified asset to the target folder on Documentum. If metadata ismodified, themappi ngs. xml file must be reconfigured and the CS DataStore must berepublished.

Tuning the Integration

Content Integration Agent contains a configuration file namedcatal og. xml , whichstores information about the archival session and allows tuning of the synchronizationinterval. For more information about tuning, seeTuning the Synchronization Process,on page42.

CS DataStore

The CS DataStore contains WebCenter Sites assets in folders and files that map toDocumentum folders of typedm_f ol der and files of type f w_document .A CS DataStore is created when assets are published to a RealTime destination witharchiving enabled. The export path is:

/ CI P_DataSt ore/

Figure4, on page36illustrates the archival of a sample CS DataStore.

Root folder. Specified by thecs. pgexport f ol der property inf ut ur et ense. i ni .

Default folder. Folders under

CI P_DataStore are archivedto Documentum.

Folders archived to Documentum.Each folder stores files representingassets that were published to agiven destination. Each folder namemust be specified in the ARCHI VETOparameter for the RealTime publishingdestination.


36/50




Figure 4: Sample CS DataStore Archived to Documentum

Figure5shows the contents of a typical asset folder (the same folder, named458, is alsoshown inFigure4).Note that the administrative files shown in Figure5are hiddenfiles. They are shown here only for illustration purposes.

Figure 5: Sample Asset Folder

Archive toDocumentum Asset Type fo lder. Stores assets of

the specified type.

Asset folders. Each 2nd-level assetfolder stores a single asset of thetype specified by the folder.

Data Model folder. Stores asset typespecifications.

Presentation logic folder. StoresTemplate asset and CSElementspecifications.

Website Content folder. Stores assetspublished to the destination.

Target folder. Custom defined.(All folders are of type dm_f ol der .)

Asset File. Typef w_assetThe mai n. xml file represents the asset.It contains the equivalent of the assets Inspectform with additional system-defined information

Administ rat ive Files (hidden). Typef w_documen- The. r egi st r y file summarizes the contents othe current folder.

- The. deps file contains the list of assetsreferenced by this asset (inmai n. xml ).

Referenced Files. Typef w_documentThese files are referenced by the asset inmai n. xReferenced files can be image files, pdf documenWord documents, and so on.

Asset fo lder. Second-level folder. Containsinformation about a single asset of the specifiedtype (MyFl exAsset ).

Target folder. Custom defined.

Website Content folder. Stores all published assets.

Asset Type folder. Stores assets of the specified type.


37/50




Mapping Framework

The CIP mapping framework determines the success of the archival and synchronizationprocesses. A CS DataStore can be archived to Documentum as long as its metadata is

mapped. The basic mapping framework involves two configurable components: objecttypes in the Documentum workspace and themappi ngs. xml file.

Object Types in the Documentum Workspace

Default Documentum target types aref w_asset and f w_document um, which could bemodified or replaced with custom types.

mappings.xml

The defaultmappi ngs. xml file contains adocument um2cs section, which specifies themappings listed below:

csds_Fol der is the data type for all folders in the CS DataStore. Folders of typecsds_Fol der map to Documentum folders of typedm_f ol der :

csds_Document is the data type for all files (exceptmai n. xml ) in the CS DataStore.Files of typecsds_Document map to Documentum documents of typef w_document .

csds_Asset is the data type of themai n. xml file, which defines the asset (seeFigure5, on page36). Files of typecsds_Asset map to Documentum documents of

type f w_asset .

Attributes of thecsds_Asset document type map to Documentum attributes asshown. All WebCenter Sites attributes are system-defined.

Thedatemodi f i ed attribute is a special attribute that stores the last publication date.The date is taken from the last modification time of the corresponding asset file in theCS DataStore. Thedatemodi f i ed attribute maps to the Documentum attributef w_publ i sheddate.

source id target id source id target id

i d f w_i d publ i st f w_publ i st

name f w_name st at us f w_st at us

cr eat edby f w_cr eat edby subt ype f w_subt ype

cr eat eddat e f w_cr eat eddat e updat edby f w_updat edby

descr i pt i on f w_descr i pt i on updat eddat e f w_updat eddat e


38/50


Steps for Archiving WebCenter Sites Assets to Documentum38


Mappings, Publishing, and Synchronization

When archiving, bear in mind the following mapping specifications:

Default mapping. Any CS DataStore can be archived to Documentum without your

having to modify the defaultmappi ngs. xml file. Running thepubl i sh commandarchives the CS DataStore to the target Documentum folder. The source CS DataStoreis then monitored by the synchronization engine. When a RealTime publishing sessionupdates the CS DataStore, the new assets and modified assets are automaticallyreplicated to the target Documentum folder by the synchronization engine.

Custom mapping. You can map selected asset types and definitions to your ownDocumentum object type. Instructions are available inStep III. Add Metadata tomappings.xml, on page39.

Steps for Archiving WebCenter Sites Assets to

DocumentumStep I. Prepare the Documentum System to Store WebCenter Sites Assets

Step II. Configure the Path to the CS DataStore

Step III. Add Metadata to mappings.xml

Step IV. RealTime Publish the Site

Step V. Archive the CS DataStore on Documentum

Step VI. Archive Visitor-Generated Content

Step I. Prepare the Documentum System to Store WebCenterSites Assets

1. Create a cabinet for WebCenter Sites assets (FWCabi net , for example).

2. Create a folder for the given assets (WebSi t e1, for example).

3. If you configured event notification, store the associated workflow processesanywhere on the Documentum system.

Step II. Configure the Path to the CS DataStore

In this step, you will enable the WebCenter Sites RealTime publishing system to exportyour selected site in a CS DataStore along the following path (see also CS DataStore,onpage35):

/ CI P_DataSt ore/

where:

defines the root directory of the CS DataStore. (Thecs. pgexpor t f ol der property is located in the f ut ur et ense. i ni file on theWebCenter Sites delivery system.)

CI P_DataSt ore is a default subdirectory of. Its subfolderswill be archived on Documentum.


39/50




is a subfolder that holds theassets of the published site.

To con figure the path to the CS DataStore

1. Configure the root directory of the CS DataStore by setting thecs. pgexpor t f ol der property in thef ut ur et ense. i ni file of the delivery system.

2. Configure the RealTime publishing process to support archiving.

a. Configure publishing as shown in theOracle WebCenter Sites AdministratorsGuide. If RealTime publishing is already configured, start with Creating aRealTime Destination Definition on the Source System.

b. In the Add New Destination form, set the More Arguments field as follows:

ARCHI VETO=

c. Complete the remaining steps up to and including mirroring site configurationdata to the destination database.

Step III. Add Metadata to mappings.xml

To add custom mappings tomappi ngs. xml , include the following information,depending on whether you are mapping a flex or basic asset type:

For flex asset types, sour cei d takes the form; . Forbasic asset types, sour cei d takes the form . Thet arget i dspecifies the corresponding Documentum object type.

For example:

- To map all flex assets of typeCont ent _C with asset definitionFSI I Ar t i cl e tothef w_cont ent object type, add the following line to mappi ngs. xml :

- To map all basic assets of typeFW_Ar t i cl e to thef w_art i cl e object type, addthe following line tomappi ngs. xml :

Step IV. RealTime Publish the Site

Publish the content management site and verify that the CS DataStore was created in thespecified path (in Step II. Configure the Path to the CS DataStore).

Note

If you are publishing a small number of assets (less than thousands) andwish to store their files to the same folder in the CS DataStore, specifyUSEHASHDI RS=f al se to disable hash folders.


40/50




Step V. Archive the CS DataStore on Documentum

In this step, you will run the CIP publ i sh command to archive theand initialize the synchronization process.

1. Start Content Integration Agent.

2. Run theCI PCommander executable (located in thebi n folder of the system whereContent Integration Agent is installed):

ci pcommanderpubl i sh

- sour ce_r epi d - t ar get _r epname - t arget _pat h - mappi ng - bul k_r esynch_i nt er val - handl er set csdatast ore- creat e f al se- r epl i c_mode updat ed

For example:

ci pcommanderpubl i sh 7833d862- 4f 8b- 4285- 84f 2- 731d5af 81865 d7a96a63-e78c- 407c- 8d7f - e84988806e49- sour ce_r epi d c: \ t emp\ csdat ast ore- t arget_r epname Ar chi ve- t ar get _pat h / f at wi r e- mappi ng csds2document um- bul k_resynch_i nt er val 60- handl er set csdat ast or e- creat e f al se- r epl i c_mode updated

Note

If you changed the port instep5 on page12(starting Content Integration Agent),make sure that the new port is set in f aci l i t i es . xml , and add - p tothe command instep2, below (which startsCI PCommander ).


Publishing Parameter Value

provider ID for the WebCenter Sites system:

7833d862- 4f 8b- 4285- 84f 2- 731d5af 81865

Provider ID for the Documentum system:

d7a96a63- e78c- 407c- 8d7f - e84988806e49

- sour ce_r epi d : Path to thefolder on the file system.
http://-/?-http://-/?-


41/50




3. Verify on Documentum the directory structure of the archived assets. For backgroundinformation, seeCS DataStore, on page35.

Step VI.Archive Visitor-Generated Content

If your WebCenter Sites delivery system runs the WebCenter Sites: Communityapplication and you wish to archive its visitor-generated content (comments and reviews),publish the content from the delivery system to a RealTime destination on a separateWebCenter Sites system (seeFigure6, on page42). Procedures for archiving visitor-generated content are identical to those for archiving assets.

- t arget _r epname : Name of the Documentum cabinet to which

will bearchived.

- t ar get _pat h : Path to the Documentum folder inthe cabinet specified by t arget _r epname. To publish to the cabinetitself, skip this parameter.

- mappi ng : mapping identifier from themappi ngs. xml file.

Default value: csds2document um

- bul k_r esynch_i nt er val

: Number of seconds between two successivesynchronization events. For optimal performance, set this value to anumber that correlates with the frequency of RealTime publishingsessions.

Default value:600- handl erset References the handlerset element fromhandl ers. xml .

Allowed value:csdatast ore

- creat e Specifies whether to create target repository.

Allowed value:f al se

- r epl i c_mode Specifies which types of changes will be replicated.

Allowed value:updat ed(only new and updated items will be replicated; deletions will not bereplicated).


Publishing Parameter Value


42/50


Testing Synchronization42


Figure 6: Archiving Visitor-Generated Content

Testing Synchronization

After thepubl i sh command executes, the archive session ends and the synchronizationengine starts monitoring the source CS DataStore. Verify that modifications are replicatedto Documentum:

1. Create and modify assets on the published content management site.

2. Republish the site to export the samefolder.

3. Look for updates in the target Documentum folder.


When thepubl i shcommand executes, the CS DataStore is archived to Documentum andcat al og. xml is updated with data points from thepubl i sh command. The data pointsidentify the CS DataStore and Documentum system (in thetags) andspecify replication settings for the CS DataStore (in the tag).

Following the archival session, the synchronization engine starts monitoring the publishedCS DataStore. The synchronization interval can be reset incat al og. xml .


43/50


Tuning the Synchronization Process43


SeeBul kResynchI nt erval inTable5, on page40. (Thecatal og. xml file is locatedin theconf folder.)

Sample catalog.xml

C: \ cs\ expor t \ CI P_datast ore\ DCTM

Ar chi ve/ Fi r st Si t eI I

0c0000018002bd870b0000018002bd91

3updat ed

10


44/50


Tuning the Synchronization Process44



45/50

45


Appendix A

Default Mapping Specifications forPublishing

This appendix contains the following sections:

Mapping Framework

Documentum Flex Family Specifications


46/50

Appendix A. Default Mapping Specifications for Publishing

Mapping Framework46


Mapping Framework

The default mapping framework for the publishing model supplies the followingcomponents (also listed inTableA-1):

TheDocument umflex family, pre-configured to match the object types and attributeslisted above.

A mappi ngs. xml file, in which the object types and attributes listed above aremapped to assets in theDocument umflex family:

- Thedm_f ol der type is mapped to a flex parent definition asset nameddm_f ol der .

- Thedm_document type is mapped to a flex definition asset nameddm_document .

- Attributes are mapped to flex assets of typeDocument um At t r i but e.

When thepubl i sh command is issued:

Folders are published as flex parent assets to theDocumentum Fol der asset type.

Documents are published as flex assets to theDocument umDocument asset type.

During publishing, Content IntegrationAgent refers to themappi ngs. xml file todetermine the types of objects to publish.

The folder that is named in thepubl i shcommand is the starting point of thepublication process. The folder ispublished as a flex parent asset of typeDocumentum Fol der, along with all thesubfolders and documents it contains.

To reproduce the folders structure(subfolders and documents), ContentIntegration Agent refers to pathinformation. If subfolders exist,Content Integration Agent chainsthe counterpartDocumentum Fol der assets to reproduce the hierarchy.

Documents are treated as flex assets oftypeDocument um Document .

They are placed under their respectiveDocumentum Fol der parents.
http://-/?-http://-/?-


47/50


Documentum Flex Family Specifications47


Documentum Flex Family Specifications

TableA-1summarizes the mapping of default object types in Documentum to asset typesand assets in WebCenter Sites Document umflex family. In customized implementations,

you can either re-use the flex family or create your own.

Table A-1: Documentum Default Data and Flex Family Analogs

DocumentumObject Type

WebCenter Sites: Document umFlex Family

Flex Asset Type Assets

Document Attributea

t i t l e subj ect keywor ds

r _ver si on_l abel r _ f ul l _cont ent _si ze

a. Attribute names are those listed in the Types node of the Documentum WebTop interface.

Documentum Attribute

Stores document attributes. t i t l e

subj ect

keywor ds

ver si on l abel f i l e si ze

Folder

dm_f ol der (default)

Documentum Parent Definition

Stores folder type definitions.

Parentdefinitions

dm_f ol der (default)

Document um_Fol der

Flex Parent asset type.Stores folder assets.

Documentum folders

Document

dm_document (default)

Documentum Child Definition

Stores document type definitions.

Document definitions

dm_document (default)

Document um_Document

Flex (Child) asset type.Stores document assets.

Documentum documents

default mappings.xml:

sourceid targetid

dm_f ol der Document um_Fol der ;

dm_document Document um_Document ;
http://-/?-http://-/?-


48/50


Documentum Flex Family Specifications48



49/50

49


Glossary

This glossary explains the terms used throughout this guide that are specific to ContentIntegration Platform.

Arch iv ing

The process of storing WebCenter Sites assets to Documentum. Stored assets can beassigned compliance and retention policies. See also cip commander publish command.

Assets

WebCenter Sites assets, both basic and flex.

ci p commander publ i sh command

CIP command used to initialize the source and target workspaces. Thepubl i sh

command replicates the source systems specified workspace to the target system andinitializes the synchronization engine, which then starts monitoring the source workspace.Thepubl i sh command is used in both models, publishing and archiving.

CM

Content management, such as creating and editing assets in WebCenter Sites.

CS DataStore

CIP name for the hierarchical folder structure that stores WebCenter Sites assets forarchiving on Documentum. The CS DataStore is created and exported during a RealTimepublishing session that is enabled for archiving.

Items

General term for WebCenter Sites assets and Documentum objects.

mappings.xml

The metadata map that enables Content Integration Platform to interpret Documentumobjects as WebCenter Sites assets and vice versa.

Monitored Workspace

A published or archived workspace. The workspace is monitored by the CIPsynchronization engine, which automatically replicates updated content based onpreviously replicated metadata (defined inmappings.xml).


50/50

Glossary50

Objects

Documentum objects, such as cabinets, folders, and documents.

Publishing

Replicating Documentum objects to WebCenter Sites. Publishing does not produce awebsite. See alsocip commander publish command.

Synchronization

The process of keeping content on source and target systems in agreement. Thesynchronization interval can be configured. See alsocip commander publish command.

Workspace

An object that stores data to be published or archived. In the publishing model, the sourceworkspace is a Documentum cabinet containing the folder that will be published; thetarget workspace is a WebCenter Sites flex family (Document umby default). In thearchiving model, the source workspace is aCS DataStore; the target workspace is aDocumentum folder.