Oracle Universal Recrds Management Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide December 2009 Universal Recrds Manager Adapter fr Dcumentum Installatin Guide, Cpyright 2009, Oracle. All rights reserved.
1 INSTALLATION OVERVIEW... 3 1.1 OVERVIEW... 3 1.2 ABOUT THE GUIDE... 4 1.2.1 Audience... 4 1.2.2 Cnventins... 4 1.3 ABOUT UNIVERSAL RECORD MANAGER (URM):... 5 1.4 SOFTWARE REQUIREMENTS... 5 1.4.1 Supprted Databases... 5 1.4.2 Cmpatibility with URM and Cntent Server... 5 1.4.3 Optinal Hardware Requirements... 5 1.4.4 Dcumentum Server... 5 2 INSTALLING ORACLE URM ADAPTER FOR DOCUMENTUM... 6 2.1 OVERVIEW... 6 2.2 PRE-INSTALLATION TASKS AND CONSIDERATIONS... 6 2.2.1 Steps t set the envirnment fr Dcumentum Adapter... 6 2.2.2 Installing the Adapter files... 6 2.3 POST-INSTALLATION TASKS AND CONSIDERATIONS... 12 2.3.1 Database setup fr URM... 12 2.3.2 Setting up Envirnment Variables... 12 2.3.3 Enable lcking f dcuments (as Recrds in URM) in Dcumentum... 15 2.3.4 Enable remval f dcuments frm URM... 17 Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 2 f 25
1 Installatin Overview 1.1 Overview This sectin cntains the fllwing tpics: Abut This Guide Abut Universal Recrds Manager Abut Dcumentum Adapter Sftware Requirements Optinal Hardware Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 3 f 25
1.2 Abut the guide This guide prvides instructins n hw t install Dcumentum Adapter n a cmputer running either Micrsft Windws r Linux. Nte: The infrmatin cntained in this dcument is subject t change as the prduct technlgy evlves and as hardware, perating systems, and third-party sftware are created and mdified. Imprtant: Befre prceeding with the installatin, make sure that yu read the release nte that is shipped with the sftware. It cntains up-t-the-minute installatin issues and cnsideratins. 1.2.1 Audience This guide is intended fr system administratrs wh need t run and cnfigure Dcumentum adapter. 1.2.2 Cnventins The fllwing cnventins are used thrughut this guide: Frward slashes (/) are used t separate parts f an Internet address. Fr example, http://www.racle.cm/en/index.htm. A frward slash might r might nt appear at the end f an Internet address. Backward slashes (\) are used t separate the levels in a path t a Windws server, directry, r file. Fr example, C:\stellent\idcm1\. A backward slash will always appear after the end f a Windws server, directry, r file path. Frward slashes (/) are als used t separate the levels in a path t a UNIX server, directry, r file. Fr example, /usr/stellent/idcm1. File names and file paths within text are indicated by the fllwing cnventin: <filename> file in the <path_t_directry> directry. Ntes, technical tips, imprtant ntices, and cautins use these cnventins: Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 4 f 25
1.3 Abut Universal Recrd Manager (URM): Oracle Universal Recrds Manager (URM) prvides the ability t perfrm recrds management, retentin management, and litigatin supprt acrss the entire enterprise. Frm a single Oracle URM server, rganizatins can define all their plicies fr recrds and retentin management, as well as perfrm legal searches and apply litigatin hlds. URM allws rganizatins t manage their recrds and retentin plicies, dispsitin prcesses, and litigatin r audit hlds in a central repsitry knwn as a URM Server. They can then apply thse plicies, dispsitins, and hlds t cntent stred in multiple repsitries thrugh URM adapters. The repsitries can be any server r applicatin that hlds cntent whse retentin is t be cntrlled. 1.4 Sftware Requirements 1.4.1 Supprted Databases The current versin f the Adapter supprts the fllwing databases: Oracle Database 10g, Micrsft SQL 1.4.2 Cmpatibility with URM and Cntent Server Currently, the Oracle URM Adapter cmmunicates with Oracle Universal Recrds Manager 10gR3 (10.1.3.3.2). Currently, this versin f URM is supprted nly n Oracle Cntent Server versins 10gR3 (10.1.3.3.2) and later. 1.4.3 Optinal Hardware Requirements Installatin f URM Adapter requires 1 GB RAM. 1.4.4 Dcumentum Server Dcumentum cntent server 5.3 shuld be installed. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 5 f 25
2 Installing Oracle URM Adapter fr Dcumentum 2.1 Overview This dcument cntains the installatin detail f the Universal Recrds Management adapter fr prviding recrd and retentin management fr Dcumentum. The Oracle URM Adapter fr Dcumentum btains all plicies frm the URM server and applies them t the cntent items stred in Dcumentum. The Adapter prvides the bridge between URM which manages the retentin plicies and Dcumentum stres the cntent. The Adapter als sends infrmatin back t the URM server, s it can maintain an up-t-date catalg f the enterprise's imprtant cntent. Thus, cmpanies can apply their recrds and retentin plicies t cntent, mre cnsistently, with less administrative effrt, and less disruptin fr users. This dcument will help administratrs at the users end t cnfigure and set up this adapter n the system. 2.2 Pre-Installatin Tasks and Cnsideratins 2.2.1 Steps t set the envirnment fr Dcumentum Adapter Install JDK 1.5 Setup DFC envirnment (i.e. DFC Client needs t be installed). 2.2.2 Installing the Adapter files The fllwing are the steps that need t be fllwed t use the installer fr installing the adapter n the user s machine: Fr Windws Machine: Duble click n Dcumentum Adapter installer t start installatin. The Install shield wizard dialg bx pens as belw. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 6 f 25
Fr Linux Machine: The prvided bin file DcumentumAdapter has t be run. Navigate t the lcatin where the bin file is lcated. Type the fllwing cmmand t run the installer. /<filename>.bin E.g.:./DcumentumAdapter.bin Nte: The remaining steps belw after the installer starts remain the same fr bth Windws and Linux machines. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 7 f 25
Click n the Next buttn t start with the installatin steps Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 8 f 25
Brwse t the directry where the installer needs t be installed and click Next. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 9 f 25
A summary is prvided as shwn belw. Click Next. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 10 f 25
The dialg bx shws the prgress as the Adapter is installed. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 11 f 25
After clicking the finish buttn the installer will cpy the all the adapter related files in the specified flder. Nte: If yu want t uninstall the files frm the flder, click the uninstaller.exe in the _uninst flder. 2.3 Pst-Installatin Tasks and Cnsideratins 2.3.1 Database setup fr URM Execute the Database scripts t create the tables related t URM adapter. Run the fllwing scripts (depending n the database being used is racle r MSSQL) are: Adapter_Oracle.sql r Adapter_MS.sql Framewrk_Oracle.sql r Framewrk_MS.sql These scripts are present in the script flder f the installed directry f Dcumentum Adapter. Nte: If yu are using Oracle database then the user that is ging t run the scripts needs t have CREATE TABLE, CREATE SEQUENCE and CREATE TRIGGER permissins n the database. 2.3.2 Setting up Envirnment Variables Fr Windws System Assuming that the DFC (Dcumentum Fundatin Classes) envirnment has been set up n the C drive the fllwing needs t be ensured: Add Database driver fr java :- Oracle Driver: - jdbc14.jar in lib/racle flder inside the installed directry f the Dcumentum Adapter. MS SQL Driver: - sqljdbc.jar in lib/micrsft flder inside the installed directry f the Dcumentum Adapter. Add dfc.jar, dfcbase.jar, bsf.jar and dctm.jar in the lib/dcumentum flder inside the installed directry f Dcumentum Adapter flder. These jars are Dcumentum specific jars which can be btained frm the flder where DFC client is installed n yur lcal machine (E.g.: C:\Prgram Files\Dcumentum). Check if the fllwing path has be added t the system variable PATH: C:\Prgram Files\Dcumentum\Shared; Check if the fllwing paths have been added t the system variable CLASSPATH: C:\Prgram Files\Dcumentum\Shared; C:\Prgram Files\Dcumentum\dctm.jar; C:\Dcumentum\cnfig; Nw Add a new system variable DFC_DATA=C:\Dcumentum; Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 12 f 25
Fr Linux System Assuming that the DFC (Dcumentum Fundatin Classes) envirnment has been set in rt f the Linux machine and fllwing needs t be ensured. Add Database driver fr java :- Oracle Driver: - jdbc14.jar in lib/racle flder inside the installed directry f Dcumentum Adapter. MS SQL Driver: - sqljdbc.jar in lib/micrsft flder inside the installed directry f Dcumentum Adapter. Add dfc.jar, dfcbase.jar, bsf.jar and dctm.jar in the lib/dcumentum flder inside the installed directry f Dcumentum Adapter flder. These jars are Dcumentum specific jars which can be btained frm the flder where DFC client is installed n yur lcal machine (E.g.: /rt/dcumentum_shared). Check if the system variable PATH has been set t /rt/dcumentum_shared : Fr this type the cmmand ech $ PATH. If the variable has nt been set then use the fllwing cmmand: PATH = $PATH:/dcumentum/shared. Check if the system variable CLASSPATH has been set t: rt/dcumentum_shared; rt/dcumentum_shared/dctm.jar; rt/dcumentum_shared/cnfig; This Classpath setting needs t be dne t set the Dcumentum path in rder t run the adapter successfully. Fr this type the cmmand ech $ CLASSPATH. If the variable has nt been set then use the fllwing cmmand: CLASSPATH = $CLASSPATH:/rt/dcumentum_shared. CLASSPATH = $CLASSPATH:/rt/dcumentum_shared/dctm.jar. CLASSPATH = $CLASSPATH:/rt/dcumentum_shared/cnfig. Nte: If user is getting prblem in lcating the dfc.prperties please fllw the steps Windws Cpy the dfc.prperties in the Dcumentum Adapter flder and check the dfc.data.dir prperty. This shuld be <drive>:\./<dcumentum> e.g. dfc.data.dir=c\./dcumentum Linux Cpy the dfc.prperties in the Dcumentum Adapter flder and check the dfc.data.dir prperty. This shuld be./<dir>/<dcumentum> e.g. dfc.data.dir=. /dcumentum Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 13 f 25
Nte: If user is getting a warning n the cmmand prmpt while running the adapter WARN cm.dcumentum.fc.cmmn.dflgger - Failed t lad lg4j.prperties. Using default lg4j cnfiguratin Cpy the lg4j.prperties file in the installed directry f Dcumentum Adapter, frm the fllwing lcatin:- In Windws: - <drive>:/dcumentum/cnfig In Linux: -./<dir>/dcumentum_shared/cnfig Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 14 f 25
2.3.3 Enable lcking f dcuments (as Recrds in URM) in Dcumentum Lgin t the database (e.g. Oracle/MySQL) fr the Dcumentum repsitry with the required user credentials (i.e. While creating dcbase fr Dcumentum, we select/create user credentials fr the database t be created fr the crrespnding dcbase. We have t use the same user credentials t create the table fr registering recrds). Next run the fllwing SQL script Recrds_Functinality.sql in the scripts/dcumentum_db Scripts flder. recrds_functinalty_ms.sql r recrds_functinalty_racle.sql Install the dcapp TBO_URM_Recrd (prvided with the adapter)using Dcumentum Applicatin Installer (DAI) in the fllwing way: Open DAI by navigating thrugh the fllwing: Start> Prgrams > Dcumentum > Applicatin Installer Lgin t the required dcbase with the crrect user credentials. Navigate t the lcatin where the dcapp is lcated by clicking n the brwse buttn at tp as illustrated belw. Click the OK buttn Click n the Start Install buttn t start installatin. Click the Quit buttn after successful installatin. Next run the DQL script in the fllwing manner: Cpy the attached idql32.exe and the urmstatusdql.dql script file t the same lcatin at any machine which has DFC installed in it (URM Adapter machine). Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 15 f 25
Open a cmmand prmpt and navigate t the lcatin where the idql32.exe has been saved. Run the fllwing cmmand. idql32 "<dcbasename>" -U"<user name>" -P"<passwrd>" -R"<dql script file name"> E.g.: idql32 "URM" -U"dmadmin" -P"Hell#123" -R"urmStatusDQL.dql" Successful executin will be shwn in the cmmand prmpt windw as belw. Alternate Apprach:- User can achieve the functinality by fllwing the steps belw: Lgin in t Dcumentum Administratr with super-user lgin credentials. Open DQL executr and register the URM_STATUS table using the fllwing DQL: REGISTER TABLE dm_db.urm_status (r_bject_id CHAR (16),ISRECORD CHAR(1),ISFROZEN CHAR(1)) ; Update the access t the registered table using the fllwing DQL: UPDATE dm_registered bject set wrld_table_permit= 15 where bject_name='urm_status'. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 16 f 25
2.3.4 Enable remval f dcuments frm URM These are the steps t enable Audit trail fr dcument delete event t keep a lg entry fr very dcument that is deleted frm the Dcumentum (DCTM) repsitry: Enabling audit trail fr a particular event requires these tw prcedures t be carried ut: A. Give a user the auditing pwers t register events t audit. B. Enable an event t be recrded in the audit trail. Giving a user the auditing pwers t register events t be audited Steps t enable the auditing pwers fr a user are as fllws: Lgin t Dcumentum Administratr with super user credentials. Navigate t the Users Management > Users ptin thrugh the brwser tree n the left side as illustrated belw. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 17 f 25
Type the user name in User Name bx t search fr the user t whm auditing pwers will be given as illustrated belw. Click n the inf icn fr the user t change its attributes. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 18 f 25
Scrll thrugh the prperties page and change the extended privileges t Cnfig, View and Purge audit as illustrated belw. Click OK t cmplete the prcess. Enabling an event t be recrded in Audit trail These are the steps t enable the Audit trail fr a dcument delete event t keep a lg entry fr every dcument that is deleted frm the Dcumentum (DCTM) repsitry: Lgin t Dcumentum Administratr with the auditr s user credentials Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 19 f 25
Navigate t the Audit Management thrugh the brwser tree in the left hand side as illustrated belw. Click the Managing Auditing by events selected fr all bjects in the repsitry Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 20 f 25
Click the Add ptin t add an event as illustrated belw. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 21 f 25
Type the event name dm_destry in the Starts with bx and click the G buttn t search the required event as illustrated belw. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 22 f 25
Select the checkbx fr dm_destry event and click the Add buttn t add the event as illustrated belw. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 23 f 25
Type the event name dm_prune in the Starts with bx and click the G buttn t search the required event. Select the checkbx fr dm_prune event and click the Add buttn t add the event as illustrated belw. In the Selected Items dm_destry and dm_prune will appear. Click the OK buttn. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 24 f 25
The event registered shuld appear n the list. Click the OK buttn t cmplete the peratin as illustrated belw. Every delete peratin which is cnducted pst registratin f the event will be recrded in t audit trail. Fr running the adapter, please refer t Administratin guide fr Oracle URM Adapter fr Dcumentum. Oracle Universal Recrds Manager Adapter fr Dcumentum Installatin Guide 25 f 25