user guide - sivlabs · pdf file2. view the queries along with the descriptions as shown in...

User Guide

1

User Guide

2

What is SivDM? SivDM is a single window application to work with Documentum Repositories easier than ever. It is a handy tool to perform a plenty of Documentum tasks easily and accurately. Also a good add-on for development/administration/support. And it is the best tool for Documentum Novices. This document concentrates on the usage of the application with illustrations.

Pre-Requisites None

Intended Audience Documentum Beginners

Documentum Developers Documentum Administrators

User Guide

3

Table of Contents

1. Login ....................................................................................................................................... 5

1.1. Login Profiles ................................................................................................................... 5 1.2. Application Work Area ..................................................................................................... 6

2. Object Manipulation ............................................................................................................... 7 2.1. DQL Execution ................................................................................................................. 7

2.2. Export Results to Excel .................................................................................................... 7 2.3. Save Query ...................................................................................................................... 9 2.4. Load Query ...................................................................................................................... 9

2.5. DQL Organizer ................................................................................................................. 9 2.5.1. Frequently used object Operations .......................................................................10

2.6. Object Type Reference ...................................................................................................14 2.6.1. Object Type Hierarchy ...........................................................................................15

2.6.2. Object Type Information .......................................................................................15

2.6.3. XDQL ......................................................................................................................16 3. Script Creation .......................................................................................................................17

3.1. Create ACL ......................................................................................................................17 3.2. Apply ACL ........................................................................................................................19

3.3. Create Folder ..................................................................................................................21

3.4. Create Format .................................................................................................................23 3.5. Create Group ..................................................................................................................25

3.6. Add Members to Group ...................................................................................................27 3.7. Remove Members from Group ........................................................................................29

3.8. Delete Group...................................................................................................................30

3.9. Create Job .......................................................................................................................32 3.10. Create Method ................................................................................................................34

3.11. Grant Privilege ................................................................................................................36 3.12. Revoke Privilege .............................................................................................................38

3.13. What is Repeating Script and where is it used? .............................................................40 3.13.1. Usage ...................................................................................................................40

4. Script Execution .....................................................................................................................42

4.1. Steps to Run DQL Scripts ...............................................................................................42 4.2. Steps to Run API Scripts ................................................................................................42

4.3. Steps to Run Docbasic Scripts ........................................................................................43 5.Reverse Engineering ................................................................................................................45

5.1. ACLs and Folders ............................................................................................................45

5.1.1. Steps to extract a Folder and its subfolders ............................................................45 5.1.2. Steps to extract ACLs ..............................................................................................46

5.2. Groups ............................................................................................................................47 5.2.1. Steps to extract Groups ...........................................................................................47

5.3.1. Steps to extract Jobs ...............................................................................................49 5.4. Methods ..........................................................................................................................51

5.4.1. Steps to extract Methods ........................................................................................51

6. Utilities ....................................................................................................................................53 6.1. Folder Management ........................................................................................................53

6.1.1. Bulk Export Steps ....................................................................................................53 6.1.2. Bulk Import .............................................................................................................54

6.1.3. Bulk Delete ..............................................................................................................55

6.1.4. Navigate Repository ................................................................................................55 6.2. Group/User Information ................................................................................................56

6.2.1. Groups containing a user (directly/indirectly) ........................................................56 6.2.2. Users in a specific Group .........................................................................................57

6.2.3. Activate/Deactivate Users .......................................................................................58

6.3. Manipulate XML ..............................................................................................................59 6.3.1. Check Wellformness of XML ....................................................................................59

6.3.2. Validate XML/XSL transformation ...........................................................................59 6.4. Send Mail to Documentum Community ..........................................................................61

6.5. Easy API..........................................................................................................................61

User Guide

4

7. Repository Metrics ..................................................................................................................63

7.1. Connection from client to server ....................................................................................63 7.2. Server Disk Space Statistics ...........................................................................................63 7.3. Documents Counts .........................................................................................................64

7.4. Folder Information .........................................................................................................64 7.5. Formats Statistics ...........................................................................................................64

7.6. Orphan Statistics ............................................................................................................64

7.7. Session Statistics ............................................................................................................65 7.8. Storage Information .......................................................................................................65

8. Future Enhancements .............................................................................................................66 9. Author .....................................................................................................................................66

User Guide

5

1. Login Double click on the SivDM.exe. The application login screen is displayed as in Figure 1.

Figure 1: Login Screen

1. Enter user name, password and select the repository.

2. Click “Login” button to enter application.

1.1. Login Profiles Save your login profiles and use them for consecutive logins. Save as many as needed. Steps to create a sample profile is mentioned below,

1. Click on the “Load Profile” button in login screen, Figure 1.

2. Login profile management screen is displayed as shown in Figure 2. 3. Left side screen shows the saved profiles as a tree.

4. Click on the nodes of tree to modify/delete profile. 5. Double click on a tree node or click on “Login using this Profile” button to login 6. Click on the “Save Profile” button to save a new profile/modify existing profile.

Figure 2: Creating new user login profile

Once the login button is clicked, login credentials are validated. If login is passed, application

splash screen is displayed.

User Guide

6

1.2. Application Work Area Once login details are provided correctly, application work area is displayed as shown in Figure 3. The logged in user and repository name is shown in the status bar of application. And by default it shows the DQL execution screen. Menus are categorized based on the Documentum activities and they will be covered in forthcoming sections.

Figure 3: Application Work Area

User Guide

7

2. Object Manipulation There is always a need to view the object details in a fast way. SivDM provides an easy approach to query, store results and modify objects.

2.1. DQL Execution 1. Click “Object Manipulation� Query to View/Modify” in menu bar 2. Enter DQL in the query field. 3. Click on the “Execute Query” button. 4. Results are shown in the grid along with the number of rows affected by query. 5. Click on the < and > buttons to see the query history of current session.

6. Click on “Save Query” to save the query for future use. 7. Click on “Load Query” to load the saved queries. 8. Click on “Export to Excel” to export the result to an excel sheet.

Figure 4: DQL Execution

2.2. Export Results to Excel Use this option after DQL is executed and results are displayed in the grid.

1. Click on the “Export to Excel” button. 2. Select a folder and enter the name of the excel sheet in the Save dialog box. Shown in

Figure 5

3. Sample excel sheet is shown in Figure 6.

User Guide

8

Figure 5: Export to Excel

Figure 6: Result Saved in Excel

User Guide

9

Overcome Excel Limitation using SivDM If the result is more than 65535 rows, win32 errors occur when opening excel sheet or results are truncated after opening the sheet! This problem is overcome in SivDM by

carrying out the excess rows of the result to a new sheet of the same workbook.

2.3. Save Query

1. Click on the “Save this Query” button to save the query entered in query box. 2. Enter the description of the query as shown in Figure 7

Figure 7: Query Description

2.4. Load Query

1. Click on the “Load Query” button to view the saved queries (irrespective of current session).

2. View the queries along with the descriptions as shown in Figure 8 3. Double click on any query to load the query into the DQL box.

Figure 8: Load Query

2.5. DQL Organizer Organize your favorite/frequently used DQLs here. These DQLs will be available in the load screen of DQL execution. See Figure 9.

User Guide

10

Figure 9: DQL Organizer

2.5.1. Frequently used object Operations If the results of DQL contain r_object_id, a pop up menu is available on every record of the result grid as shown in Figure 10. The popup menu may vary depending on the object type of the record. Figure 10 shows the popup menu for dm_document objects.

Figure 10: Actions on a dm_document object

Double click on any record to view the dump.

The functionalities of the popup menu are explained as follows.

1. Delete Delete any object by using this action. Delete current version or entire object version tree can be deleted by choice. See Figure 11

User Guide

11

Figure 11: Delete Options

2. Dump Object dumps are always required for analysis and troubleshooting activities. Sample object dump is shown in Figure 12. If you select an object id and double click on it, dumping can be continued to another level (Shown in Figure 13). This has no limit on seeing new dumps and this makes analysis easier.

Figure 12: View Dump

User Guide

12

Figure 13: Continuous Dump

3. Export Meta Data as XML This is used when you want to load an object’s Meta data in an XML Parser or as a DB record using 3rd party tools.

4. Queue to another user

This is equivalent to Quick Flow in WebTop. Enter user name if you know or search for the user and enter other details. This feature can be used by Documentum support people as a quick fix

to stuck workflow issues. See the Figure 14 for details.

Figure 14: Queue to another user

5. View Content View content associated to the document object in the respective editors.

User Guide

13

6. View Folder Path Object’s folder path in the repository can be seen easily using this option. Sample is shown in Figure 15

Figure 15: Folder Path

7. View Relations Parents and child relationships of an object is shown as in Figure 16.

Figure 16: Relations of an Object

8. View Renditions View all renditions with details as shown in Figure 17.

Figure 17: Renditions

9. View Versions

User Guide

14

View the version tree of an object as shown in Figure 18.

Figure 18: Versions

10. Update Object

Modify attribute values easier than ever. Play with repeating values and all data types. Add/remove/insert repeating values of any type. Change the values as required and click on “Update” button to save the object.

Figure 19: Update Screen

2.6. Object Type Reference

User Guide

15

View how object types are organized in repository. This is shown as a tree with all the types in

repository. Also see the attribute details/description quickly and easily.

2.6.1. Object Type Hierarchy

Click Object Manipulation�� Type Reference�� Hierarchy in the menu. Object Type tree is shown as in Figure 20 and click on any object to see the attribute details as in Figure 21. Save the details as an excel sheet. Also there is an option to save the entire tree as

an image.

Figure 20: Object Type Tree

Figure 21: Attribute details

2.6.2. Object Type Information

User Guide

16

Click Object Manipulation�� Type Reference�� Information in the menu. View the object type and registered table descriptions along with the hierarchy tree. This is shown in Figure 22.

Figure 22: Type Information

2.6.3. XDQL

Test your XDQLs with a variety of options. Results are seen immediately. Also save the result as XML for further analysis. This is shown in Figure 23

Figure 23: XDQL

User Guide

17

1. Download a script template 2. Enter the values in the template 3. Upload the script template 4. Create script!

3. Script Creation Though Documentum API/DQL scripts are not tough to create, there is always some human error

introduced while creating scripts which lead to big issues in the system. SivDM uses the template approach to create variety of DQL/API scripts. Also maintaining them will be very easy as the templates are Excel spreadsheets. These are the simple steps to create a script,

Following are the scripts created using SivDM, 1. Create ACL 2. Apply ACL

3. Create Folder 4. Create Group/Role 5. Destroy Group/Role

6. Add/remove users to/from group 7. Create Job 8. Create Method

9. Create Format 10. Grant/Revoke privilege to/from users

11. Create repeating scripts

There is an expectation that the values entered in the template should be of specified format. Please follow that.

3.1. Create ACL Click Script Creation��ACL��Create on the menu bar. Create ACL screen is shown as in Figure 24.

Figure 24: Create ACL screen

User Guide

18

Download the template to your local machine by clicking the “Download Template” button. Template details are tabulated below.

S.no Template Column Expected Value

1 ACL Name Name of the acl

2 Owner Name ACL owner name – valid repository user_name

3 Description ACL Description

4 ACL Class Integer - 0,1,2,3 (Refer Object Reference guide for details)

5 Users/Groups Enter user_name or/add group_name separated by commas

6 Permissions Permission Level - Integer 1 to 7 (Refer Object Reference guide for details) separated by commas. Provide the permissions for all users and groups mentioned in the column 5

7 XPermissions Provide the following Xpermission strings EXECUTE_PROC CHANGE_LOCATION CHANGE_STATE CHANGE_PERMIT CHANGE_OWNER DELETE_OBJECT Separated by semicolons

Example to create one script:


1 ACL Name TEST

2 Owner Name Dm_admin

3 Description This is Test ACL

4 ACL Class 3

5 Users/Groups test_grp,test_user,dm_world,dm_owner

6 Permissions 3,3,3,7

7 XPermissions EXECUTE_PROC;EXECUTE_PROC;;CHANGE_STATE,

CHANGE_PERMIT,CHANGE_OWNER,DELETE_OBJECT

Figure 25: Uploaded Template with Values

User Guide

19

#***********************************************

# Created Using SivDM Script Engine

#***********************************************

# Script Number:1

create,c,dm_acl

set,c,l,object_name TEST

set,c,l,description This is Test acl

set,c,l,owner_name

dm_admin grant,c,l,test_grp,3,EXECUTE_PROC

grant,c,l,test_user,3,EXECUTE_PROC grant,c,l,dm_world,3

grant,c,l,dm_owner,7,CHANGE_STATE,CHANGE_PERMIT,CHANGE_OWNER,DELETE_OBJECT

save,c,l

########################################### Please validate the script before runnning! ###########################################

Click on the “Create Script” button to create script as shown below.

Create all your acls as a single script file by entering details of all acls in a single template.

3.2. Apply ACL

Click Script Creation��ACL��Apply on the menu bar. Apply ACL screen is shown as in Figure 27.

Figure 27: Apply ACL screen

Figure 26 : Create ACL Script

User Guide

20



1 ACL Name Name of the acl

2 ACL Domain ACL Domain user name

3 Sysobject Type Type name

4 Sysobject Path Folder path excluding the sysobject name

5 Sysobject name object_name



1 ACL Name TEST

2 ACL Domain dm_admin

3 Sysobject Type dm_document

4 Sysobject Path /dm_admin

5 Sysobject name Test.doc


Click on the “Create Script” button to create script as shown in Figure 29.

User Guide

21

Figure 29: Apply ACL script

3.3. Create Folder

Click Script Creation��Folder��Create on the menu bar. Create Folder screen is shown as in Figure 30.

Figure 30: Create Folder screen



1 Folder Name Name of the folder

2 Title Description

3 Object Type dm_cabinet, dm_folder or any folder sub type

4 ACL Name ACL to apply

5 ACL Domain ACL owner

6 Link to folder Folder to link. Leave it blank for Cabinets

#*********************************************** # Created Using SivDM Script Engine

#***********************************************

# Script Number:1

update dm_document object

set acl_domain='dm_acl' set acl_name='TEST'

where folder('/dm_admin') and object_name='Test.doc'

Go

###########################################

Please validate the script before runnning! ###########################################

User Guide

22



1 Folder Name Test

2 Title Test Folder created by SivDM

3 Object Type dm_folder

4 ACL Name TEST

5 ACL Domain dm_admin

6 Link to folder /dm_admin



User Guide

23

Figure 32: Create Folder script

3.4. Create Format Click Script Creation��Format on the menu bar. Create Format screen is shown as in Figure 33.

Figure 33: Create Folder screen



1 Format Name Enter format name

2 DOS Extension Refer Documentum Object Reference Guide


#***********************************************

# Script Number:1

create,c,dm_folder

set,c,l,object_name Test

set,c,l,title

Test Folder by SivDM set,c,l,acl_name

TEST set,c,l,acl_domain

dm_admin link,c,l,'/dm_admin'

save,c,l

########################################### Please validate the script before runnning!

###########################################

User Guide

24

3 Description Description of format

4 MIME type Refer Documentum Object Reference Guide

5 Mac Creator Refer Documentum Object Reference Guide. Leave blank if doesn’t apply

6 Mac Type Refer Documentum Object Reference Guide. Leave blank if doesn’t apply

7 Can Index 0 - No index; 1 - Index



1 Format Name Test_format

2 DOS Extension html

3 Description Test Format for HTML

4 MIME type text/html

5 Mac Creator

6 Mac Type

7 Can Index 1



User Guide

25

Figure 35: Create Format script

3.5. Create Group Click Script Creation��Group��Create on the menu bar. Create Group screen is shown as in Figure 36.

Figure 36: Create Group screen



1 Group Name Enter the group name

2 Description Description about group

3 Group Class Possible Values are role, group and domain

4 Owner Name Group owner


#***********************************************

# Script Number:1

create dm_format object

set name='Test_Format' set dos_extension='html'

set description='Test format for HTML'

set mime_type='text/html' set can_index=1

Go

###########################################

Please validate the script before runnning!

###########################################

User Guide

26

5 Group Address Group Address

6 Is Private 0-public; 1-private



1 Group Name Test_grp

2 Description Test group created by SivDM

3 Group Class group

4 Owner Name dm_admin

5 Group Address [email protected]

6 Is Private 0



Figure 38: Create Group script

#***********************************************


#***********************************************

# Script Number:1 create dm_group object

set group_name='Test_grp' set description='Test Group created by SivDM'

set group_class='group' set owner_name='dm_admin'

set group_address='[email protected]'

set is_private=0 Go

###########################################


User Guide

27

3.6. Add Members to Group Click Script Creation��Group��Add members on the menu bar. Add Members to Group screen is shown as in Figure 39.

Figure 39: Add Members to Group screen




2 Groups/User names Enter group_name/user_name separated by comma




2 Groups/User names test_user ,test_grp

User Guide

28



Figure 41: Add member to Group script


#***********************************************

# Script Number:1

alter group 'Test_grp'

add 'test_user',' test_grp' Go


User Guide

29

3.7. Remove Members from Group Click Script Creation��Group��Remove members on the menu bar. Remove Members from Group screen is shown as in Figure 42.

Figure 42: Remove Members from Group screen




2 Groups/User names Enter group_name/user_name separated by comma




2 Groups/User names test_user ,test_grp


User Guide

30


Figure 44: Remove member from Group script

3.8. Delete Group Click Script Creation��Group��Delete on the menu bar. Delete Group screen is shown as in Figure 45.

Figure 45: Remove Members from Group screen







#***********************************************


#***********************************************

# Script Number:1

alter group 'Test_grp'

drop 'test_user, test_grp' Go

###########################################


User Guide

31



Figure 47: Delete Group Script

#***********************************************

# Created Using SivDM Script Engine #***********************************************

# Script Number:1

drop group 'Test_grp' Go


User Guide

32

3.9. Create Job Click Script Creation��Create Job on the menu bar. Create Job screen is shown as in Figure 48.

Figure 48: Create Job screen



1 Job Name Name of the job

2 Method Name Method used by the job

3 Start Date Start date in mm/dd/yyyy format

4 Next Invocation Date Next invocation date in mm/dd/yyyy format

5 Pass Standard Arguments 1-pass; 0-don’t pass

6 Run Mode Integer 1 to 9. (Refer Object Reference guide for details)

7 Run Interval Integer (Refer Object Reference guide for details)

8 Expiration Date Expiration date in mm/dd/yyyy format

9 Run Now 1-Run now; 0-Run later



1 Job Name test_job

2 Method Name test_method

3 Start Date 05/01/2007

4 Next Invocation Date 05/02/2007

5 Pass Standard Arguments 1

6 Run Mode 2

7 Run Interval 1

8 Expiration Date 05/02/2027

9 Run Now 1

User Guide

33



Figure 50: Job Script


#***********************************************

# Script Number:1

create dm_job object

set object_name='Test_job' set method_name='Test_method'

set start_date=date('05/01/2007') set a_next_invocation=date('05/01/2007')

set pass_standard_arguments=1

set run_mode=2 set run_interval=1 set expiration_date=date('05/01/2027') set run_now=1

Go


User Guide

34

3.10. Create Method Click Script Creation��Create Method on the menu bar. Create Method screen is shown as in Figure 51.

Figure 51: Create Method screen



1 Method Name Name of the method

2 Method Type dmawk, docbasic or java (Refer Object Reference guide for details)

3 Verb Method verb (Refer Object Reference guide for details)

4 Run As Server 0 - No; 1 - Yes

5 Use Method Server 0 - No; 1 - Yes

6 Trace Launch 0 to 10 (Refer Object Reference guide for details)

7 Special App “Workflow” to make method as workflow method else leave this blank



1 Method Name Test_Method

2 Method Type java

3 Verb com.test.TestMethod

4 Run As Server 1

5 Use Method Server 1

6 Trace Launch 5

7 Special App Workflow

User Guide

35



Figure 53: Create Method


#***********************************************

# Script Number:1

create dm_method object

set object_name='Test_Method'

set method_type='java' set method_verb='com.test.TestMethod'

set run_as_server=1 set use_method_server=1 set trace_launch=5 set a_special_app='Workflow'

Go

###########################################


User Guide

36

3.11. Grant Privilege Click Script Creation��Privilege��Grant on the menu bar. Grant Privileges to Users screen is shown as in Figure 54.

Figure 54: Grant Privilege screen



1 Users Names Enter user_names separated by commas

2 Privileges Enter the following strings as per requirement separated by commas SUPERUSER SYSADMIN CREATE TYPE CREATE CABINET CREATE GROUP CONFIG AUDIT PURGE AUDIT VIEW AUDIT



1 Users Names Test1, Test2, Test3

2 Privileges CREATE TYPE, CREATE CABINET,CREATE GROUP

User Guide

37



Figure 56: Grant Users

#***********************************************


# Script Number:1 grant CREATE TYPE, CREATE CABINET,CREATE GROUP to Test1, Test2, Test3

Go

###########################################


User Guide

38

3.12. Revoke Privilege Click Script Creation��Privilege��Revoke on the menu bar. Revoke Privileges to Users screen is shown as in Figure 57.

Figure 57: Revoke Privilege screen



1 Users Names Enter user_names separated by commas

2 Privileges Enter the following strings as per requirement separated by commas SUPERUSER

SYSADMIN

CREATE TYPE CREATE CABINET

CREATE GROUP CONFIG AUDIT

PURGE AUDIT

VIEW AUDIT



1 Users Names Test1, Test2, Test3

2 Privileges CREATE TYPE, CREATE CABINET,CREATE GROUP

User Guide

39



Figure 59: Revoke from Users

#***********************************************


#***********************************************

# Script Number:1

revoke CREATE TYPE, CREATE CABINET,CREATE GROUP

from Test1, Test2, Test3

Go

###########################################

Please validate the script before runnning!

###########################################

User Guide

40

3.13. What is Repeating Script and where is it used? There would be a requirement that a piece of script needs to be duplicated with different set of data as input. For example, you have 10000 object ids from a 3rd party database and need to delete them in Documentum using scripts. You would write a program/excel sheet manipulation to do that but now it is very simple using SivDM

3.13.1. Usage 1. Create a script to repeat (dql/api) and save it locally. 2. The values which are fetched from an excel sheet is specified as shown below Figure. The

object Id and folder path are replaced with identifiers.

Figure 60 : Script to be repeated

3. Create an excel sheet with values as shown in Figure 61. The column names must exactly match the identifiers provided in the script above. (Object Id and Folder Path)

Figure 61: Data Sheet

4. Click Script Creation��Repeating Script on the menu bar. Repeating Script screen is shown as in Figure 62.

# Script to be duplicated/repeated.

# Object Id and Folder Path are columns in the data excel # sheet.

The script is duplicated by replacing the Object # Id and Folder Path from excel sheet.

delete dm_document object where r_object_id='<Object Id>' and folder('<Folder Path>')

User Guide

41

#***********************************************


delete dm_document object where r_object_id='090063bc80000151' and

folder('/Temp/repeatingTest1')



delete dm_document object where r_object_id='090063bc80000152' and folder('/Temp/repeatingTest3')

delete dm_document object where r_object_id='090063bc80000153' and folder('/Temp/repeatingTest4')




Figure 62: Repeating Script screen

5. Select the path script in the screen 6. Select the data sheet in the screen 7. Select the output script screen 8. Click Create Script button to create the repeating script. 9. Repeating Script is created as shown in Figure 63.

Figure 63: Repeating Script screen

There is no restriction on the number of Identifiers used in the

script/with excel sheet columns

User Guide

42

4. Script Execution Executing scripts are easier than ever with SivDM. DQL, API and Docbasic scripts can be run

using the script execution engine. Following are the features,

1. Run DQL/API/Docbasic in the current login Repository or any other repository. 2. Get the logs of execution for validation/troubleshooting

4.1. Steps to Run DQL Scripts

1. Click Script Execution� Run DQL script 2. DQL Execution screen is shown as in Figure 64

Figure 64 : Run DQL Scripts

3. Enter connection credentials, if you want to execute script other repository 4. Enter DQL and log paths 5. Click on Run button to Execute script

4.2. Steps to Run API Scripts 1. Click Script Execution� Run API script 2. API Execution screen is shown as in Figure 65

User Guide

43

Figure 65 : Run API Scripts

3. Enter connection credentials, if you want to execute script other repository 4. Enter DQL and log paths 5. Click on Run button to Execute script

4.3. Steps to Run Docbasic Scripts

1. Click Script Execution� Run Docbasic script 2. Docbasic Execution screen is shown as in Figure 66

Figure 66 : Run Docbasic Scripts

3. Enter Docbasic script and log paths 4. Enter the entry method name of the Docbasic script

User Guide

44

5. Click on Run button to Execute script

User Guide

45

5. Reverse Engineering This option is very useful in case of migrating the following objects across repositories.

1. ACL 2. Groups 3. Folders 4. Jobs 5. Methods

5.1. ACLs and Folders Extract ACLs and Folders from a repository as a script and install it in other repositories. The repository folders/cabinets are displayed as a tree as shown in Figure 67.

5.1.1. Steps to extract a Folder and its subfolders

1. Right Click on any cabinet to see the popup menu shown in Figure 67. 2. Click on menu item “Generate Script to create ‘Temp’ and its subfolders”

Figure 67 : Reverse Engineer ACL and Folders

3. A question dialog opens with message as shown in Figure 68. If “Yes” is clicked ACL

applying script is also created for the folders.

Figure 68: ACL Apply needed?

4. Progress bar is shown until the scripts are created. 5. Once the script is created a message is shown as in Figure 69

Figure 69: Success Message

6. Sample script created is shown in Figure 70

User Guide

46

Figure 70: Sample Script

5.1.2. Steps to extract ACLs 1. Right Click on any cabinet to see the popup menu shown in Figure 71. 2. Click on menu item “Generate ACL script for ‘Temp’ and its subfolders”

Figure 71 : Reverse Engineer ACL

3. A question dialog opens with message as shown in Figure 72. If “Yes” is clicked, Groups in the ACL will also be created.

Figure 72: Groups needed?

4. Progress bar is shown until the scripts are created.


#***********************************************

#Script Number : 1

create,c,dm_cabinet set,c,l,object_name

Temp set,c,l,acl_name

dm_450063bc80000104

set,c,l,acl_domain mlpdev

save,c,l

#Script Number : 2

create,c,dm_folder

set,c,l,object_name ACL Replication

set,c,l,acl_name dm_450063bc80007522

set,c,l,acl_domain

mlpdev link,c,l,'/Temp' save,c,l


User Guide

47

5. Once the script is created a message is shown as in Figure 73




5.2. Groups Extract Groups from a repository as a script and install it in other repositories. The repository groups (only the top most) are displayed as a tree as shown in Figure 75.

5.2.1. Steps to extract Groups

1. Right Click on any cabinet to see the popup menu shown in Figure 75. 2. Click on menu item “Generate Script to create ‘test_grp’ and its subgroups”


#*********************************************** # Script Number:1

create,c,dm_acl

set,c,l,object_name dm_450063bc80000104

set,c,l,description cdfdev

set,c,l,acl_class

0 set,c,l,owner_name

cdfdev grant,c,l,dm_world,7,EXECUTE_PROC,CHANGE_LOCATION

grant,c,l,dm_owner,7,EXECUTE_PROC,CHANGE_LOCATION grant,c,l,docu,7

save,c,l

# Script Number:2

create,c,dm_acl set,c,l,object_name

dm_450063bc80007521

set,c,l,description cdfdev set,c,l,acl_class 0

set,c,l,owner_name cdfdev

grant,c,l,dm_world,3,EXECUTE_PROC,CHANGE_LOCATION

grant,c,l,dm_owner,7,EXECUTE_PROC,CHANGE_LOCATION grant,c,l,docu,5

save,c,l

###########################################


User Guide

48

Figure 75: Reverse Engineer Groups






#*********************************************** create,c,dm_group

set,c,l,group_name,test_grp

set,c,l,group_class,group set,c,l,group_display_name,test_grp

set,c,l,owner_name,dm_admin append,c,l,users_names,dm_admin

append,c,l,users_names,dm_autorender_win31 append,c,l,users_names,dm_autorender_mac append,c,l,users_names,dm_mediaserver

save,c,l


User Guide

49

5.3. Jobs Extract Jobs from a repository as a script and install it in other repositories. The repository jobs are displayed as a tree as shown in Figure 78.

5.3.1. Steps to extract Jobs 1. Right Click on any Job to see the popup menu shown in Figure 78.

2. Click on menu item “Generate Script to create ‘dm_DataDictionaryPublisher’”

Figure 78: Reverse Engineer Jobs

3. Progress bar is shown until the scripts are created. 4. Question Dialog is shown as in Figure 79. If “Yes” is clicked then method associated with

the script is also created.

Figure 79: Create Method?

5. Once the script is created a message is shown as in Figure 80



User Guide

50



#***********************************************

create dm_job object

set object_name='dm_DataDictionaryPublisher' set method_name='dm_DataDictionaryPublisher'

set a_next_invocation=date('06/01/2008 21:09:15','mm/dd/yyyy hh:mi:ss') set method_arguments[0]='-window_interval 1440'

set method_data[0]=''

set method_trace_level=0 set start_date=date('11/22/2006 08:09:15','mm/dd/yyyy hh:mi:ss')

set pass_standard_arguments=1 set run_mode=1

set run_interval=30 set expiration_date=date('01/27/2013 19:40:00','mm/dd/yyyy hh:mi:ss')

Go

####### Method Script ######


set object_name='dm_DataDictionaryPublisher'

set method_args[0]='' set method_type='dmbasic' set method_verb='./dmbasic -f../install/admin/mthd7.ebs -eDataDictionaryPublisher'

set run_as_server=1 set timeout_default=604800

set timeout_max=604800

set timeout_min=30 set a_special_app='1.0.0'

Go

###########################################


User Guide

51

5.4. Methods Extract Methods from a repository as a script and install it in other repositories. The repository methods are displayed as a tree as shown in Figure 82.

5.4.1. Steps to extract Methods 1. Right Click on any Method to see the popup menu shown in Figure 82. 2. Click on menu item “Generate Script to create ‘Demote’”

Figure 82: Reverse Engineer Methods




User Guide

52



#***********************************************

####### Method Script ######


set object_name='Demote' set method_args[0]=''

set method_type='dmbasic'

set method_verb='./dmbasic -eDemote' set run_as_server=1

set timeout_default=86400 set timeout_max=604800

set timeout_min=60 set use_method_content=1

set a_special_app='Workflow'

Go


User Guide

53

6. Utilities A number of useful utilities are provided for Developers and Administrators. Following is the list of them,

1. Folder Management 2. User/Group Info 3. Manipulate XML 4. Send Mail to Documentum Users 5. Easy API

6.1. Folder Management Manage folders in bulk mode. This utility is useful for administrator/support people. Folder management screen is shown in Figure 85

Figure 85: Folder Management

6.1.1. Bulk Export Steps 1. Select a cabinet/folder in the tree and click “Bulk Export” 2. Select the destination folder from your local machine as shown in Figure 86.

Figure 86: Select Export Directory

3. Progress bar is displayed when the export is happening. 4. Once the export is done, success message is shown as in Figure 87

User Guide

54


6.1.2. Bulk Import 1. Select a cabinet/folder in the tree and click “Bulk Import” 2. Select the source folder from your local machine as shown in Figure 88.

Figure 88: Select Import Source

3. Select the type of documents and folder as shown in Figure 89.

Figure 89: Select Type

4. Click Import button. 5. Progress bar is displayed when the import is happening. 6. Once the import is done, success message is shown as in Figure 90


User Guide

55

6.1.3. Bulk Delete Delete a folder and its content easily using this option.

1. Select a folder and click “Delete” 2. Question dialog appears as shown in Figure 91

Figure 91: Delete Dialog

6.1.4. Navigate Repository Navigate through the folders and documents in the repository easier and faster and perform these operations on the folders/documents. Operations are shown in Figure 92 and 93.

Figure 92: Document Operations Figure 93: Folder Operations

User Guide

56

6.2. Group/User Information View much useful information on User/Group immediately. Following are the utilities available in this section,

1. Groups containing a user (directly/indirectly) 2. Users in a specific group 3. Activate/Deactivate user

6.2.1. Groups containing a user (directly/indirectly) Following are the steps to view the groups contain a specific user. Figure 94 shows the screen for this option.

1. Enter username if known or use search functionality. (See Figure 95 for search) 2. Select criteria. (Direct or Indirect Groups) 3. View Groups.

4. Export to Excel if needed.

Figure 94: Groups containing User

User Guide

57

Figure 95: Search Function

6.2.2. Users in a specific Group Find users present in a specific group either directly or indirectly using this option. Figure 96

shows the screen for this option. Following are the steps; 1. Enter group name. 2. Select criteria. (Direct or Indirect Users)

3. View Users. 4. Export to Excel if needed.

Figure 96: Users in Group

User Guide

58

6.2.3. Activate/Deactivate Users Activate or Deactivate users by simple right click option. This feature is useful for Administrators/Support people

Figure 97: Activate/Deactivate Users

User Guide

59

6.3. Manipulate XML Documentum Web publisher uses XML aggressively. Developers need not login to Web Publisher every time to test their XML/XSL. This section covers the following options which would be helpful for developers.

1. Check Wellformness of XML (local and in Repository) 2. Test XSL (local and in Repository)

6.3.1. Check Wellformness of XML 1. Select an XML from local or from repository

2. Click on “Validate” button. 3. If the XML is wellformed it is shown as a tree.

Figure 98: Local XML Validation

6.3.2. Validate XML/XSL transformation 1. Select XML and XSL (Local or Repository)

2. Select destination Directory 3. Select output format

4. Click on Apply Transform to apply transformation 5. Pass Session to XSL if XDQL is used in XSL (This is option is only available for Repository

XSLT)

User Guide

60

Figure 99: XSLT Locally

Figure 100: XSLT on Repository Files

User Guide

61

6.4. Send Mail to Documentum Community Send mail to Documentum users/groups easier than ever. But this needs SMTP to be configured with Documentum. Figure 101 shows the screen for this utility. Following are the steps,

1. Select a group in the Repository 2. Add/Remove users. 3. Enter Subject 4. Select a Message file (Currently supports text files only) 5. Add attachment if any 6. Preview the mail before sending 7. Click “Send Mail” button to send to the intended recipients.

Figure 101: Send Mail to Documentum Community

6.5. Easy API Execute API without knowing the commands. Frequently used operations are shown as tree.

Select a node in the tree and provide the relevant data to execute the API transparently. This option helps developers/support people to save time in executing API commands accurately. Following are the options available,

1. Execute SQL 2. Lifecycle Operations 3. Document Operations

4. Workflow Operations 5. Workflow Template Operations 6. Work item tasks

Figure 102 shows the Easy API screen

User Guide

62

Figure 102: Easy API

User Guide

63

7. Repository Metrics Metrics are always required to study/know the state of Repository at any point of time. Statistics of the repository is needed to understand the load and other parameters. Based on the statistics the infrastructure and business decisions are taken. This critical requirement is solved by SivDM. As this is a straightforward option it is not explained in a detailed way. Following are the useful metrics of a Repository provided by SivDM,

7.1. Connection from client to server • View the various parameters of a connection from server to client

• This is useful for support personnel while troubleshooting clients

• Save the result as HTML for reference

7.2. Server Disk Space Statistics • Cabinet Vs Disk Space • Web Cabinets Vs Disk Space

• Object Types Vs Disk Space • Save as Excel and HTML • Also view readymade Pie and Bar charts for analysis (Figure 103)

• Legends are also provided for the charts.

Figure 103: Bar Chart

User Guide

64

Figure 104: Pie Chart

Some Patience is needed to view the results. Result time varies based on the volume of documents

7.3. Documents Counts • Cabinet Vs Document Count

• Web Cabinet Vs Document Count

• Object Type Vs Document Count • Save as Excel and HTML • Also view readymade Pie and Bar charts for analysis (Figure 103)


7.4. Folder Information • Cabinet Info

• Web Cabinet Info

• Save as Excel and HTML • Also view readymade Pie and Bar charts for analysis (Figure 103) • Legends are also provided for the charts.

7.5. Formats Statistics • Formats Vs Type • Formats Vs Document Count

• Save as Excel and HTML • Also view readymade Pie and Bar charts for analysis (Figure 103)


7.6. Orphan Statistics • Users • Groups • Save as Excel and HTML

User Guide

65

7.7. Session Statistics • View the list of repository Sessions • Release a selected session • Save as Excel Sheet

7.8. Storage Information • Various Storages present in the Repository • Storage Vs Object Type Distribution

• Storage Vs Format Distribution • Storage Vs File Count Distribution • Storage Vs Disk space Distribution

• Save as Excel and HTML • Also view readymade Pie and Bar charts for analysis (Figure 103) • Legends are also provided for the charts.

User Guide

66

8. Future Enhancements Following are the tasks currently being worked and soon would be available. Check the updated version of the application in http://sivlabs.wordpress.com

• D6 upgrade • Lots of Metrics

• Few more utilities in API and folder management • Few more administration utilities • Making the UI better with less blocking

9. Author Name: Sivasubramanian.A Email Id: mailto:[email protected]