High Volume Server Tuning Guide

Transcription

1 High Volume Server Tuning Guide This document provides guidance on High Volume Server. The High Volume Server is part of the Documentum 6,5 Architecture. The Documentum High Volume Server is an extension of Documentum Content Server that supports features implemented to solve common problems with large content stores. The three broad areas of enhancements that make up Documentum High Volume Server are batch operations and currency scoping, database partitioning, and lightweight SysObjects. September 2008

2 Copyright 2008 EMC Corporation. All rights reserved. EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com All other trademarks used herein are the property of their respective owners. 2

3 Table of Contents Introduction...4 Lightweight SysObjects...5 Overview... 5 Test... 5 Environment... 7 Results... 8 Batching...9 Overview... 9 Test... 9 Environment Results Scoping...12 Overview Test Environment Results Batching, Scoping, and Lightweight SysObjects Combined...15 Overview Test Environment Results Appendix...19 DFC Batch Loader Code (Java) DFC Scoping Code (Java)

4 Introduction This document provides guidance on High Volume Server. The Documentum High Volume Server is an extension of Documentum Content Server that supports features implemented to solve common problems with large content stores. The three broad areas of enhancements that make up Documentum High Volume Server are batch operations and currency scoping, database partitioning, and lightweight SysObjects. Lightweight SysObjects are part of an object model enhancement introduced to share system managed metadata among objects which only hold application specific data. For example, policies for security, retention, and storage are stored in a shareable system object that is shared among all the lightweight objects. Because the system managed metadata is stored only once, it significantly reduces the disk storage requirements and improves object ingestion performance. However, an application needs to be aware of lightweight SysObjects in order to display and use them. Inserting a single object into a repository is a resource intensive event. There are many applications where a large number of similar objects must be added to a repository. Batch operations can reduce the overhead by grouping these events into a batch and processing them all together. Documentum High Volume Server supports batch mode, similar to the transaction mode that allows you to submit new objects in a batch. Additionally, transaction mode is extended to support nested transactions. An additional performance enhancement introduced in Documentum High Volume Server is setting the scope for object and query currency checking in applications. This new feature allows a developer to have finer control over when and whether to check the currency of objects and queries. In cases where the developer knows that the object or query is still current, redundant currency checks can be eliminated. All tests conducted for this paper were done on Documentum 6.5 code line unless otherwise stated. Some of the tests were conducted with pre released versions of the code. For assistance with information in this paper, please contact EMC Professional Services. 4

5 Lightweight SysObjects Overview A lightweight type is a type whose implementation is optimized to reduce the storage space needed in the database for instances of the type. All lightweight SysObject types are subtypes of a shareable type. When a lightweight SysObject is created, it references a shareable supertype object. As additional lightweight SysObjects are created, they can reference the same shareable object. That shareable object is called the lightweight SysObject s parent. Each lightweight SysObject shares the information in its shareable parent object. In that way, instead of having multiple nearly identical rows in the SysObject tables to support all the instances of the lightweight type, a single parent object exists for multiple lightweight SysObjects. Lightweight SysObjects are useful if you have a large number of attributes that are identical for a group of objects. This redundant information can be shared among the lightweight objects from a single copy of the shared parent object. For example, Enterprise A Plus Financial Services receives many payment checks each day. They record the images of the checks and store the payment information in SysObjects. They will retain this information for several years and then get rid of it. For their purposes, all objects created on the same day can use a single ACL, retention information, creation date, version, and other attributes. That information is held by the shared parent object. The lightweight object (child object) has information about the specific transaction. Using lightweight SysObjects provide the following benefits: Lightweight types take up less space in the underlying database tables than a standard subtype. Importing lightweight objects into a repository is faster than importing standard SysObjects. Test A performance profile for migrating regular SysObjects to Lightweight SysObjects was collected. Those results can be found in Figure 1 in the Results section. The following steps were used in obtaining the results : 1) Define regular SysObject parent type (emc_payment) CREATE TYPE emc_payment (Bank_Code integer, Routing integer, Branch integer repeating) WITH SUPERTYPE dm_document PUBLISH 2) Define regular SysObject sub-type for check image (emc_payment_check) CREATE TYPE emc_payment_check (Account integer, Check_Number integer, Transaction_Date date, Amount float, Deductions float repeating) WITH SUPERTYPE emc_payment PUBLISH 3) Load the emc_payment and emc_payment_check types to be migrated with a DFC loader 5

6 program. 4) Create an object of emc_payment that will become the shared parent of the Lightweight objects CREATE emc_payment OBJECT SET bank_code = 20 SET routing = SET branch[0] = 1 SET branch[1] = 2 This will return the r_object_id of the object created. This will be used in step 7. 5) Migrate parent to Shared IAPI>apply,c,NULL,MIGRATE_TO_LITE,SHARED_PARENT_TYPE,S,emc_payment, EXECUTION_MODE,S,Run and Finalize 6) Migrate content to Lightweight SysObjects, with the parent created in step 5 IAPI>apply,c,NULL,MIGRATE_TO_LITE,SHARED_PARENT_TYPE,S,emc_payment, LIGHTWEIGHT_TYPE,S,emc_payment_check,EXECUTION_MODE,S, Run and Finalize,DEFAULT_PARENT_ID,S,<r_object_id from step 5> Record time to perform ingestion. Measure CPU, memory, I/O and disk resources. This test will be done manually and will be repeated with the following number of regular SysObjects to migrate to Lightweight SysObjects with a single partition : Run and Finalize - 10, ,000-1,000,000 Run without Finalize and Finalize - 10, ,000-1,000,000 A performance profile for splitting a regular type into shareable type and a Lightweight type was collected. Those results can be found in Figure 2 in the Results section. The following steps were used in obtaining the results : 1) Define regular SysObject type (emc_payment_check). This will become the Lightweight type. CREATE TYPE emc_payment_check (Bank_Code integer, Routing integer, Branch integer repeating, Account integer, Check_Number integer, Transaction_Date date, Amount float, Deductions float repeating) WITH SUPERTYPE dm_document PUBLISH 2) Load the emc_payment_check type to be migrated (split) with a DFC loader program. 6

7 3) Migrate content to Lightweight SysObjects IAPI>apply,c,NULL,MIGRATE_TO_LITE,SOURCE_TYPE,S,emc_payment_check,SHARED_PAR ENT_TYPE,S,emc_payment,EXECUTION_MODE,S,Split and Finalize,RECOVERY_MODE,B,false,PARENT_ATTRIBUTES,S,Bank_Code, PARENT_ATTRIBUTES,S,Routing This test will be done manually and will be repeated with the following number of regular SysObjects being migrated to Lightweight SysObjects with a single partition : Split and Finalize o 10,000 o 100,000 o 1,000,000 Split without Finalize and Finalize o 10,000 o 100,000 o 1,000,000 Environment Content Server / DataBase Server - One DELL 6850 Server with the following: Four Dual Core XEON 3.66 GHz 300 GB of internal disk, 1 x 300 GB, 10K RPM SCSI 32 GB of memory Dual Gigabit Ethernet ports One iscsi connected CLARiiON storage device ~2 TB LUN carved out of a ~4.5 TB 15-drive DAE, RAID level 0. 7

8 Results Migration of regular SysObjects to Lightweight SysObjects: 0:11:31 0:10:05 0:08:38 Elapsed Time 0:07:12 0:05:46 0:04:19 0:02:53 0:01:26 0:00:00 10,000 10, , ,000 1,000,000 1,000,000 RunAndFinalize 0:00:17 0:01:14 0:07:25 RunWithoutFinalize 0:00:36 0:00:59 0:03:56 Finalize 0:00:17 0:00:52 0:06:16 FIGURE 1 Splitting regular SysObjects into shareable and lightweight types: 0:10:05 0:08:38 0:07:12 Elapsed Time 0:05:46 0:04:19 0:02:53 0:01:26 0:00:00 10,000 10, , ,000 1,000,000 1,000,000 SplitAndFinalize 0:00:17 0:01:00 0:09:30 SplitWithoutFinalize 0:00:36 0:00:38 0:03:28 Finalize 0:00:10 0:00:28 0:04:38 FIGURE 2 8

9 Space Savings 100,000 objects Regular SysObjects LightWeight SysObjects Table Num rows Size (KB) Alloc. Num rows Size (KB) Alloc. Percent Diff. DM_SYSOBJECT_R 203,677 11,264 3, % DM_SYSOBJECT_S 101,056 45,696 1, % DMI_QUEUE_ITEM_S 101,782 30, ,783 30,720 0 % EMC_PAYMENT_CHECK_R 200,000 7, ,000 7,040 0 % EMC_PAYMENT_CHECK_S 100,000 5, ,000 10, % EMC_PAYMENT_R 200,002 7, % EMC_PAYMENT_S 100,001 3, % Totals 111,104 49, % Batching Overview Documentum High Volume Server includes a batch mode that can increase the server performance when adding objects and content. For example, when you add an item to the content server, there is a certain amount of overhead associated with setting up the session, and locking and unlocking the database tables as rows are added for the new object. Using Documentum High Volume Server s batch mode, multiple items are added as a set to the server; setup, locking, and unlocking apply to all the objects in the batch as a whole. You can gain performance improvements by surrounding some repetitive operations with a batch. To support this mode, DFC has been enhanced with the addition of a batch manager and with an extension to transactions that supports nested transactions. Test A performance profile was collected for batching of objects during ingestion. The test ingested a high volume of on-line check images. The results can be found in Figure 3 under the Results section. The following steps were used to obtain the results : First establish a baseline with regular SysObjects: 1) Define regular SysObject sub-type for check image (emc_payment_check) 9

10 emc_payment_check -Bank Code : Integer -Routing : Integer -Branch (r) : Integer -Account Number : Integer -Check_Number : Integer -Transaction Date : Date -Ammount : Decimal -Deductions (r) : Decimal -Deduction_Type (r) : String CREATE TYPE emc_payment_check (Bank_Code integer, Routing integer, Branch integer repeating, Account integer, Check_Number integer, Transaction_Date date, Amount float, Deductions float repeating, Deduction_Type string(256) repeating) WITH SUPERTYPE dm_sysobject PUBLISH 2) Run DFC Batch loader via command line (see Appendix : DFC Batch Loader Code) Record time to perform ingestion. Measure CPU, memory, I/O and disk resources. Then run the same test with Lightweight SysObjects: emc_payment -Bank Code : Integer -Routing : Integer -Branch (r) : Integer emc_payment_check -Account Number : Integer -Check_Number : Integer -Transaction Date : Date -Ammount : Decimal -Deductions (r) : Decimal -Deduction_Type (r) : String 1) Define sharable parent type (emc_payment) (same as above) CREATE SHAREABLE TYPE emc_payment (Bank_Code integer, Routing integer, Branch integer repeating) WITH SUPERTYPE dm_sysobject PUBLISH 2) Define Lightweight SysObject for check image (emc_payment_check) (same as above) CREATE LIGHTWEIGHT TYPE emc_payment_check (Account integer, Check_Number integer, Transaction_Date date, Amount float, Deductions float repeating, 10

11 Deduction_Type string(256) repeating) SHARES emc_payment PUBLISH 3) Run DFC Batch loader via command line (see Appendix : DFC Batch Loader Code) Record time to perform ingestion. Measure CPU, memory, I/O and disk resources. This was done with the following variations: - batches size o none o 10 o 50 - Content size o 0 (contentless) o 20 Kb Environment Content Server / DataBase Server - One DELL 6850 Server with the following: Four Dual Core XEON 3.66 GHz 300 GB of internal disk, 1 x 300 GB, 10K RPM SCSI 32 GB of memory Dual Gigabit Ethernet ports One iscsi connected CLARiiON storage device ~2 TB LUN carved out of a ~4.5 TB 15-drive DAE, RAID level 0. Results Batching of Lightweight SysObjects by batch size: 11

12 Doc's / Sec Batch Size Batch Size FIGURE 3 Scoping Overview Another Documentum High Volume Server feature allows control over object currency checking by using a scope manager. When objects are fetched or queries are run, they are saved temporarily for use by the client. How long an object or query can be used until it has to be refetched or rerun is managed by currency checking (the object or query result could change because of the actions of others working in the repository). The scope manager controls the checking of object currency, so that objects are checked once during the currently defined scope. The assumption is that the object or query will not change during the scope. This reduces the RPC communication traffic between DFC and Documentum High Volume Server and reduces redundant policy checks on objects. Test A performance profile of Scoping on-line queries and object retrieval (without partitioning) was collected. Graphs of those results can be found below in Figure 5 and Figure 6 of the Results section. The testing was accomplished using the following steps : 1) Run DFC Scoping code via command line (see Appendix : DFC Scoping Code) The queries used were : 1) select r_object_id,i_vstamp from dm_sysobject where object_name='_acsconfig_masterchangerecord' and FOLDER('/System/AcsConfig') ORDER BY r_object_id 2) select dd_change_count from dmi_change_record 3) select r_object_id from dmc_module where a_module_type='tbo' and object_name='dm_store' and folder('/system/modules',descend) 4) select r_object_id from dm_type where name = 'dmr_content' 12

13 5) select r_object_id from dm_sysobject where folder ('/System/Storage Policies') and object_name = 'dm_ssa_change_object' And for the large fetch test, to test disk caching 6) select * from DMI_QUEUE_ITEM_S where item_type not like 'emc%' Record time to perform ingestion. Measure CPU, memory, I/O and disk resources. This test will be done manually and will be repeated with a fixed batch size of 50, a scope boundary of BATCH and the following variations: number of objects ingested (i.e. number of times the query will be run) with and without Scoping o 100 o 1,000 o 10,000 o 100,000 No Server side scoping, no dfc scoping (baseline) Server side scoping, no dfc scoping o enableserverscoping(true) o with queries above o without queries above Server side scoping, dfc scoping o enableserverscoping(true) o setdefaultscope (BATCH, false) o with queries above No Server side scoping, dfc scoping o setdefaultscope (BATCH, false) o with queries above No Server side scoping, dfc scoping, large query o setdefaultscope (BATCH, false) o with large query defined above Environment Content Server / DataBase Server - One DELL 6850 Server with the following: Four Dual Core XEON 3.66 GHz 300 GB of internal disk, 1 x 300 GB, 10K RPM SCSI 32 GB of memory Dual Gigabit Ethernet ports One iscsi connected CLARiiON storage device ~2 TB LUN carved out of a ~4.5 TB 15-drive DAE, RAID level 0. 13

14 Results Scoping of DQL query: Average Time For DQL execution 40 milli seconds E+05 No Scope Server dfc both dfc(disk) Iterations FIGURE 5 RPC Counts Count E+05 No Scope Server dfc both dfc(disk) Iterations FIGURE 6 14

15 Batching, Scoping, and Lightweight SysObjects Combined Overview Documentum High Volume Server allows for all of the techniques described in this paper to be used in unison. There is a synergistic effect of doing them all together as well. For example, although batching seems to add little in way of a performance gain on its own, when combined with scoping and lightweight objects, we see a whole greater than the sum of its parts with respect to performance. Test A performance profile was collected for scoping and batching of lightweight objects during ingestion. The test ingested a high volume of on-line check images. The results can be found in Figure X under the Results section. The following steps were used to obtain the results : First establish a baseline with regular SysObjects: 1) Define regular SysObject sub-type for check image (emc_payment_check) emc_payment_check -Bank Code : Integer -Routing : Integer -Branch (r) : Integer -Account Number : Integer -Check_Number : Integer -Transaction Date : Date -Ammount : Decimal -Deductions (r) : Decimal -Deduction_Type (r) : String CREATE TYPE emc_payment_check (Bank_Code integer, Routing integer, Branch integer repeating, Account integer, Check_Number integer, Transaction_Date date, Amount float, Deductions float repeating, Deduction_Type string(256) repeating) WITH SUPERTYPE dm_sysobject PUBLISH 2) Run DFC Batch loader via command line (see Appendix : DFC Batch Loader Code) Record time to perform ingestion. Measure CPU, memory, I/O and disk resources. Then run the same test with Lightweight SysObjects: 15

16 emc_payment -Bank Code : Integer -Routing : Integer -Branch (r) : Integer emc_payment_check -Account Number : Integer -Check_Number : Integer -Transaction Date : Date -Ammount : Decimal -Deductions (r) : Decimal -Deduction_Type (r) : String 3) Define sharable parent type (emc_payment) (same as above) CREATE SHAREABLE TYPE emc_payment (Bank_Code integer, Routing integer, Branch integer repeating) WITH SUPERTYPE dm_sysobject PUBLISH 4) Define Lightweight SysObject for check image (emc_payment_check) (same as above) CREATE LIGHTWEIGHT TYPE emc_payment_check (Account integer, Check_Number integer, Transaction_Date date, Amount float, Deductions float repeating, Deduction_Type string(256) repeating) SHARES emc_payment PUBLISH 5) Run DFC Batch loader via command line (see Appendix : DFC Batch Loader Code) Record time to perform ingestion. Measure CPU, memory, I/O and disk resources. This was done with the following variations: - batches size o none o 10 o 50 - Content size o 0 (contentless) o 20 Kb Environment Content Server - One DELL 6850 Server with the following: Two Dual Core XEON 2.9 GHz 300 GB of internal disk, 1 x 300 GB, 10K RPM SCSI 12 GB of memory 16

17 Dual Gigabit Ethernet ports One Fiber Channel connected CLARiiON storage device via one Emulex 2 GB FC host bus adapter (HBA) ~2 TB LUN carved out of a ~4.5 TB 15-drive DAE, RAID level 0. Database Server - One IBM eserver pseries p5-510 with the following: Four dual-core, 1.65 GHz, 64-bit POWER5 processors ~219 GB of internal disk, 3 x 73 GB 10K rpm Dual Channel Ultra320 SCSI disk drive assembly 8 GB of memory Dual Gigabit Ethernet ports One Fiber Channel connected CLARiiON storage device via one Emulex 2 GB FC host bus adapter (HBA) ~500 GB LUN carved out of a ~4.5 TB 15-drive DAE, RAID level 0 AIX 5.3 Driver Box - One IBM eserver pseries p5-510 with the following: Four dual-core, 1.65 GHz, 64-bit POWER5 processors ~219 GB of internal disk, 3 x 73 GB 10K rpm Dual Channel Ultra320 SCSI disk drive assembly 8 GB of memory Dual Gigabit Ethernet ports One Fibre Channel connected CLARiiON storage device via one Emulex 2 GB FC host bus adapter (HBA) ~500 GB LUN carved out of a ~4.5 TB 15-drive DAE, RAID level 0 AIX 5.3 Results Scoping Batching and Lightweight (SBLW) of on-line checks during ingestion: 17

18 Throughput Docs/Second Throughput Docs/Second 0 Base 1 Thread SBLW 1 Thread Base 5 Thread SBLW 5 Thread Base 10 Thread SBLW 10 Thread D6.0 SP1 20 thread Base 20 Thread SBLW 20 thread FIGURE 7 Normalized per Doc CPU Load Driver CS DB 20 0 D6.0 SP1 20 thread Base 20 Thread SBLW 20 thread Load Driver CS DB FIGURE 8 18

19 Appendix DFC Batch Loader Code (Java) // lw_batch.java // // Copyright (C) 2003, Documentum, Inc., All rights reserved // import com.documentum.com.dfclientx; import com.documentum.com.idfclientx; import com.documentum.fc.client.*; import com.documentum.fc.common.*; import java.text.dateformat; import java.util.date; public class lw_batch // Login Info - will obtain from command-line args String docbasename; // args[0] String username; // args[1] String password; // args[2] int batchsize; // args[3] int numdocs; // args[4] Date start_time; Date end_time; //variables used for most programs IDfClientX clientx; IDfClient client; IDfSession session; IDfSessionManager smgr; IDfBatchManager bmgr; IDfSysObject sysobj; IDfScopeManager scopemgr; IDfId objid; public void begin(string[] args) try start_time = new Date(); end_time = new Date(); parsecmdline(args); //create a Client object clientx = new DfClientX(); client = clientx.getlocalclient(); //create a Session Manager object smgr = client.newsessionmanager(); //create an IDfLoginInfo object named BatchTest IDfLoginInfo logininfoobj = clientx.getlogininfo(); logininfoobj.setuser(username); logininfoobj.setpassword(password); //bind the Session Manager to the login info smgr.setidentity(docbasename, logininfoobj); session = smgr.getsession(docbasename); scopemgr = smgr.getscopemanager(); // Set Server side scoping 19

20 scopemgr.enableserverscope(true); // Set the default scoping boundary scopemgr.setdefaultscope(scopeboundary.batch, true); start_time.settime(system.currenttimemillis()); " + DateFormat.getDateTimeInstance().format(start_time)); // Create Parent sysobj = (IDfSysObject)session.newObject("emc_payment"); sysobj.setobjectname("check_parent"); // Content type and storage must be set on parent, else lightweight object is materalized sysobj.setstoragetype("filestore_02"); sysobj.setcontenttype("tiff"); // set shared attributes sysobj.setint("bank_code", 1); sysobj.setint("routing", ); sysobj.setrepeatingint("branch",0,1); sysobj.setrepeatingint("branch",1,2); sysobj.save(); objid = sysobj.getobjectid(); bmgr = session.getbatchmanager(); bmgr.openbatch(batchsize, true, true, true, null); /** * openbatch (int batchsize, Boolean querysafe, Boolean oneauditperbatch, Boolean * oneeventperbatch, Properties options). * This API opens a batch and set the batch attributes. * batchsize - hint to server cache size for number of objects created in the batch * before server flush the batch. Since each type is related to several tables * and some tables are for repeating attributes. Server will use the batchsize as * the base to determine the cache size on the table level. * querysafe - indicates if a flush should be called by DFC when query is issued within * batch. * oneauditperbatch - indicates server generates one audit trail for the batch vs. one * audit trail per object insert. * oneeventperflush - indicates server generates one event for the batch vs. one event * per object insert. * Options - contains a set of hints to server. Currently, there is only one driver=bcp. * Server will ignore the options it does not support. */ IDfTime currdate = new DfTime(); int amount = 0; for(int i=0; i<numdocs; ++i) // Create children sysobj = (IDfSysObject)session.newLightObject("emc_payment_check",objId); sysobj.setobjectname("check_" + i + 1); sysobj.setfile("paycheck.tif"); // set indivdual attributes sysobj.setint("check_number", i + 1); sysobj.settime("transaction_date", currdate); // set indivdual attributes - in batches of 25 if (i%25 == 0) amount = i; sysobj.setint("account", amount); sysobj.setdouble("amount", amount+25.00); sysobj.setrepeatingdouble("deductions",0,10.00); sysobj.setrepeatingdouble("deductions",1,20.00); sysobj.setrepeatingstring("deduction_type",0,"charity"); 20

21 sysobj.setrepeatingstring("deduction_type",1,"foodbank"); sysobj.save(); // commit every 1000 if (i%1000 == 0) bmgr.commitbatch(); bmgr.closebatch(); catch(throwable e) if(e instanceof DfException) System.out.println("DFC Exception:"); String s = ((DfException)e).getStackTraceAsString(); System.out.println(s); else System.out.println("Non-DFC Exception"); e.printstacktrace(); finally try if(bmgr.isbatchactive()) bmgr.abortbatch(); catch(exception be) //empty if (session!= null) smgr.release(session); end_time.settime(system.currenttimemillis()); " + DateFormat.getDateTimeInstance().format(end_time)); System.out.println("Elapsed " + CalculateTimeDiff(start_time, end_time) + " sec"); private static long CalculateTimeDiff(Date start_time, Date end_time) long time_value; Date diff_time = new Date(); diff_time.settime(end_time.gettime() - start_time.gettime()); time_value = (end_time.gettime() - start_time.gettime()) / 1000; return time_value; /** * void parsecmdline(string[] args) * * Copies args[] variables into friendlier-named variables */ void parsecmdline(string[] args) if(args.length > 0) for(int i = 0; i < args.length; ++i) switch(i) 21

22 case DOCBASE: // 0 docbasename = args[i]; break; case USERNAME: // 1 username = args[i]; break; case PASSWORD: // 2 password = args[i]; break; case BATCHSIZE: // 3 batchsize = Integer.parseInt(args[i]); break; case NUMDOCS: // 4 numdocs = Integer.parseInt(args[i]); break; else help(); System.exit(1); // you never return from this method //end: parsecmdline(string[] args) public static void main(string[] args) new lw_batch().begin(args); private static void help() String[] helplist = "You must set arguments before executing this program.", "Usage: java lw_batch docbase user pwd batchsize numdocs", "", "Where: ", " docbase is your Docbase name", " user is your user name for the Docbase", " pwd is users password", " batchsize is batch size to use", " numdocs is number of Docs to load", "", "Example from command line:", "", " java lw_batch train5 tuser1 password ", ; for(int i = 0; i < helplist.length; ++i) System.out.println(helpList[i]); //end: help() static final int DOCBASE =0; static final int USERNAME =1; static final int PASSWORD =2; static final int BATCHSIZE =3; static final int NUMDOCS =4; 22

23 DFC Scoping Code (Java) // Scoping.java // // Copyright (C) 2003, Documentum, Inc., All rights reserved // import com.documentum.com.*; import com.documentum.fc.client.*; import com.documentum.fc.common.*; public class Test // Login Info - will obtain from command-line args String docbasename; //args[0] (train5) String username; //args[1] (dmadmin) String password; //args[2] (training) //variables used for most programs IDfClientX clientx; IDfClient client; IDfSession session; IDfSessionManager smgr; public void begin(string[] args) String checkalwayspolicy String checkoncepolicy String checkneverpolicy = Check Always; = Check Once; = Check Never; String operationboundary = Operation; String transactionboundary = Transaction; String batchboundary = Batch; try //create a Session Manager and get a session parsecmdline(args); //create a Client object clientx = new DfClientX(); client = clientx.getlocalclient(); //create a Session Manager object smgr = client.newsessionmanager(); //create an IDfLoginInfo object named ScopingTest IDfLoginInfo logininfoobj = clientx.getlogininfo(); logininfoobj.setuser(user); logininfoobj.setpassword(pass); //bind the Session Manager to the login info smgr.setidentity(docbase, ScopingTest); session = smgr.getsession(docbasename); true) // Set the default scoping boundary if (smgr.setdefaultscope(transactionboundary,checkneverpolicy, false)!= System.out.println(Error setting default scope); //do work in the Repository here Utils.listContentsOfFolder(/dmadmin, session); //end of Repository work System.out.println(Finished); catch(throwable e) 23

24 if(e instanceof DfException) System.out.println(DFC Exception:); String s = ((DfException)e).getStackTraceAsString(); System.out.println(s); else System.out.println(Non-DFC Exception); e.printstacktrace(); //end: catch() finally if (session!= null) smgr.release(session); // end: begin() /** * void parsecmdline(string[] args) * * Copies args[] variables into friendlier-named variables */ void parsecmdline(string[] args) if(args.length > 0) for(int i = 0; i < args.length; ++i) switch(i) case DOCBASE: // 0 docbasename = args[i]; break; case USERNAME: // 1 username = args[i]; break; case PASSWORD: // 2 password = args[i]; break; else help(); System.exit(1); // you never return from this method //end: parsecmdline(string[] args) /** * Standard startup code for any standalone Java * application. This is done so that the class * may supply member variables to other methods * of this class and make non-static methods that * may act as getters and setters, etc for the * fields of this object. */ public static void main(string[] args) new Test().begin(args); /** * Project properties: * /p /cp:p <JAVAPACKAGES> Test train4i dmadmin training 24

25 */ void help() String[] helplist = You must set arguments before executing this program., Usage: java Test Repository user pwd cabinet filepath,, Where:, docbase is your Docbase name, user is your user name for the Docbase, pwd is users password,, Example from command line:,, java Test train5 tuser1 password, ; for(int i = 0; i < helplist.length; ++i) System.out.println(helpList[i]); //end: help() final int DOCBASE =0; final int USERNAME =1; final int PASSWORD =2; 25