system 6.0 object reference

EMC® Documentum®

SystemVersion 6

Object Reference ManualP/N 300-005-215

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

Copyright © 1992 - 2007 EMC Corporation. All rights reserved.

Published August 2007

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS 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.

Table of Contents

Preface .......................................................................................................................... 13

Chapter 1 Object Basics ........................................................................................ 15Computed properties.................................................................................. 15Property datatypes ..................................................................................... 25Note on string datatype nomenclature ..................................................... 26

Referencing properties ................................................................................ 26Identifiers .................................................................................................. 27Names ................................................................................................... 27Object type and property names .......................................................... 28User and group names ........................................................................ 28Table and column names..................................................................... 29

Object identifiers .................................................................................... 29Property identifiers................................................................................. 29Collection identifiers............................................................................... 29Type identifiers ...................................................................................... 30Session identifiers ................................................................................... 30

Relationships ............................................................................................. 30User-defined relationships ...................................................................... 31Creating a relationship type .................................................................... 31Creating a relationship between two objects ............................................. 32Security and relationships ....................................................................... 33SYSTEM security ................................................................................ 33PARENT and CHILD security ............................................................. 33None ................................................................................................. 34

The permanent_link and copy_child properties ........................................ 34Compatibility with prior releases......................................................... 35

Defining delete behavior ......................................................................... 35Destroying a relationship type................................................................. 37Destroying a relationship between objects ................................................ 37Relationships and object operations ......................................................... 38Checkin, Saveasnew, and Branch ......................................................... 38Save................................................................................................... 38Destroy .............................................................................................. 38Object replication ............................................................................... 39

Chapter 2 Core Persistent Object Types ................................................................ 41

Chapter 3 Lightweight Object Type and Properties for Shareable ObjectTypes and the Property Bag ................................................................ 507

Chapter 4 Non-persistent Object Types ............................................................... 513

Chapter 5 Documentum Process Builder Object Types ....................................... 531

Chapter 6 Collaboration Object Types ................................................................. 553

EMC Documentum System Version 6 Object Reference 3

Table of Contents

Chapter 7 Document Submission Manager Object Types .................................... 575

Chapter 8 Retention Policy Services Object Types .............................................. 599

Chapter 9 Site Caching Services Object Types .................................................... 629

Chapter 10 Forms Builder Object Types ................................................................ 645

Chapter 11 Editorial Publishing Services Types .................................................... 653

Appendix A Language and Country Codes ............................................................. 679

Appendix B RDBMS Tables for Documentum Types ............................................... 683Overview ................................................................................................. 683The tables............................................................................................. 683The views ............................................................................................ 684Returning database table information .................................................... 684

The user type tables in the Oracle RDBMS.................................................. 684

Appendix C Obsolete, Deprecated, or Unused Object Types .................................. 687

4 EMC Documentum System Version 6 Object Reference

Table of Contents

List of Tables

Table 1. The computed properties ................................................................................ 15Table 2. Computed properties for lifecycles .................................................................. 23Table 3. The property datatypes ................................................................................... 25Table 4. Effects of setting permanent_link and copy_child properties ............................. 34Table 5. Deletion behavior when deleting a parent object............................................... 36Table 6. Deletion behavior when deleting a child object ................................................. 37Table 7. Properties defined for the ACL type................................................................. 42Table 8. Properties defined for the ACS config type ....................................................... 46Table 9. Properties defined for the activity type............................................................. 52Table 10. Properties defined for the aggr domain type..................................................... 67Table 11. Properties defined for the alias set type ............................................................ 69Table 12. Property defined for the app ref type ............................................................... 71Table 13. Property defined for the application type ......................................................... 72Table 14. Properties defined for the aspect relation type .................................................. 75Table 15. Properties defined for the aspect type object type.............................................. 76Table 16. Properties defined for the assembly type .......................................................... 77Table 17. Properties defined for the audit trail type ......................................................... 79Table 18. Properties defined for the audit trail acl type .................................................... 85Table 19. Properties defined for the audit trail attrs type.................................................. 88Table 20. Properties defined for the audit trail group type ............................................... 89Table 21. Properties defined for the auth config type ....................................................... 92Table 22. Properties defined for the blob store type ......................................................... 93Table 23. Properties defined for the bocs config type ....................................................... 94Table 24. Property defined for the builtin expr type ........................................................ 97Table 25. Properties defined for the CA store type........................................................... 98Table 26. Properties defined for the cabinet type ........................................................... 101Table 27. Properties defined for the cache config type ................................................... 102Table 28. Properties defined for the category type ......................................................... 104Table 29. Properties defined for the category assign type ............................................... 107Table 30. Properties defined for the category class type ................................................. 110Table 31. Properties defined for the change record type................................................. 114Table 32. Properties defined for the CI config type ........................................................ 116Table 33. Properties defined for the class type............................................................... 119Table 34. Default aspect properties defined for the class type......................................... 120Table 35. Properties defined for the client registration type............................................ 121Table 36. Properties defined for the client rights type .................................................... 122Table 37. Properties defined for the completed workflow type ....................................... 124


Table of Contents

Table 38. Properties defined for the completed workitem type ....................................... 128Table 39. Properties defined for the component type ..................................................... 134Table 40. Properties defined for the composite predicate type ........................................ 135Table 41. Properties defined for the cond expr type ....................................................... 136Table 42. Properties defined for the cond ID expr type .................................................. 137Table 43. Properties defined for the config scope relation type ....................................... 139Table 44. Properties defined for the constraint set object type ........................................ 140Table 45. Properties defined for the cont transfer config type ......................................... 141Table 46. Properties defined for the containment type ................................................... 143Table 47. Properties defined for the content type........................................................... 146Table 48. Properties defined for the cryptographic key type........................................... 155Table 49. Properties defined for the DD attr info type.................................................... 157Table 50. Properties defined for the DD common info type ............................................ 163Table 51. Properties applicable to object types and properties ........................................ 169Table 52. Properties applicable only to object types ....................................................... 172Table 53. DD info properties applicable to properties .................................................... 172Table 54. Properties defined for the DD type info type .................................................. 176Table 55. Properties defined for the display config type................................................. 179Table 56. Properties defined for the distributed store type ............................................. 181Table 57. Properties defined for the dms config type ..................................................... 183Table 58. Properties defined for the docbase config type................................................ 185Table 59. Properties defined for the docset type ............................................................ 196Table 60. Properties defined for the docset run type ...................................................... 198Table 61. Properties defined for the domain type .......................................................... 201Table 62. Properties defined for the dump object record type......................................... 204Table 63. Properties defined for the dump record type .................................................. 205Table 64. Properties defined for the email message type ................................................ 209Table 65. Properties defined for the esign template type ................................................ 211Table 66. Properties defined for the expr code type ....................................................... 213Table 67. Properties defined for the expression type...................................................... 214Table 68. Properties defined for the external file store type ............................................ 216Table 69. Properties defined for the external store type.................................................. 218Table 70. Properties defined for the federation type ...................................................... 221Table 71. Properties defined for the file store type ......................................................... 224Table 72. Properties defined for the folder type............................................................. 225Table 73. Properties defined for the foreign key type ..................................................... 226Table 74. Properties defined for the format type............................................................ 227Table 75. Properties defined for the ft index agent config type ....................................... 231Table 76. Properties defined for the FT engine config type ............................................. 235Table 77. Properties defined for the fulltext index type .................................................. 236Table 78. Properties defined for the func expr type........................................................ 238Table 79. Properties defined for the group type............................................................. 241Table 80. Properties defined for the index type ............................................................. 245


Table of Contents

Table 81. Properties defined for the jar type .................................................................. 247Table 82. Properties defined for the java library type ..................................................... 248Table 83. Properties defined for the job type ................................................................. 249Table 84. Properties defined for the job request type ..................................................... 254Table 85. Properties defined for the job sequence type................................................... 256Table 86. Properties defined for the key type ................................................................ 258Table 87. Properties defined for the LDAP config type .................................................. 259Table 88. Properties defined for the linked store type .................................................... 267Table 89. Properties defined for the link record type ..................................................... 268Table 90. Properties defined for the load object record type ........................................... 271Table 91. Properties defined for the load record type..................................................... 273Table 92. Properties defined for the location type .......................................................... 275Table 93. Properties defined for the locator type ........................................................... 277Table 94. Properties defined for the media profile type.................................................. 278Table 95. Properties defined for the message address type............................................. 280Table 96. Properties defined for the message archive type ............................................. 282Table 97. Properties defined for the message attachment type........................................ 285Table 98. Properties defined for the message route type ................................................ 286Table 99. Properties defined for the message route user data type .................................. 288Table 100. Properties defined for the message user data type........................................... 289Table 101. Properties defined for the method type .......................................................... 291Table 102. Properties defined for the module type .......................................................... 297Table 103. Properties defined for the module config type ................................................ 300Table 104. Properties defined for the mount point type ................................................... 302Table 105. Properties defined for the network location map type ..................................... 304Table 106. Properties applicable to object type and properties ......................................... 306Table 107. Properties applicable only to properties ......................................................... 307Table 108. Properties defined for the other file type ........................................................ 310Table 109. Properties defined for the output device type ................................................. 311Table 110. Properties defined for the package type ......................................................... 313Table 111. Properties defined for the plugin type ............................................................ 317Table 112. Properties defined for the policy type ............................................................ 319Table 113. Properties defined for the preset info type ...................................................... 328Table 114. Properties defined for the preset package type................................................ 329Table 115. Properties defined for the procedure type ...................................................... 331Table 116. Properties defined for the process type........................................................... 332Table 117. Properties defined for the process correlation set type..................................... 338Table 118. Atributes defined for the public key certifcate type ......................................... 340Table 119. Properties defined for the qual comp type ...................................................... 342Table 120. Properties defined for the queue item type .................................................... 346Table 121. Properties defined for the reference type ........................................................ 354Table 122. Properties defined for the registered type....................................................... 359Table 123. Properties defined for the registry type .......................................................... 361


Table of Contents

Table 124. Properties defined for the relation type .......................................................... 364Table 125. Properties defined for the relation SSA policy type ......................................... 366Table 126. Properties defined for the relation type object type ......................................... 367Table 127. Properties defined for the relationship def type .............................................. 371Table 128. Default aspect properties defined for the relationship def type ........................ 375Table 129. Properties defined for the replica record type ................................................. 376Table 130. Properties defined for the retainer type .......................................................... 378Table 131. Properties defined for the routecase condition type......................................... 384Table 132. Properties defined for the scope config type ................................................... 388Table 133. Properties defined for the sequence type ........................................................ 391Table 134. Properties defined for the server config type .................................................. 392Table 135. Properties defined for the Smart List type ...................................................... 404Table 136. Properties defined for the state extension type................................................ 406Table 137. Properties defined for the state type object type .............................................. 407Table 138. Properties defined for the SSA policy type...................................................... 408Table 139. Properties defined for the store type .............................................................. 409Table 140. Properties defined for the subcontent type ..................................................... 416Table 141. General properties of SysObjects .................................................................. 419Table 142. SysObject folder-related properties ................................................................ 422Table 143. Virtual document-related properties .............................................................. 423Table 144. SysObject content-related properties .............................................................. 425Table 145. Web-content properties ................................................................................. 426Table 146. SysObject security-related properties ............................................................. 428Table 147. SysObject version-related properties .............................................................. 430Table 148. SysObject event-related property ................................................................... 432Table 149. SysObject lifecycle-related properties ............................................................. 432Table 150. SysObject aspect-added properties................................................................. 433Table 151. Properties defined for the taxonomy type....................................................... 434Table 152. Properties defined for the TCF activity type ................................................... 435Table 153. Properties defined for the TCF activity template type...................................... 436Table 154. Properties defined for the transition condition type ........................................ 437Table 155. Properties defined for the type object type...................................................... 441Table 156. Properties defined for the type info type ........................................................ 444Table 157. Properties defined for the user type ............................................................... 448Table 158. Properties defined for the validation descriptor type....................................... 457Table 159. Properties defined for the validation module type .......................................... 458Table 160. Properties defined for the validation relation type .......................................... 460Table 161. Properties defined for the value assist type..................................................... 462Table 162. Properties defined for the value func type ...................................................... 464Table 163. Properties defined for the value list type ........................................................ 465Table 164. Properties defined for the value query type .................................................... 466Table 165. Properties defined for the vstamp type........................................................... 468Table 166. Properties defined for the WF attachment type ............................................... 469


Table of Contents

Table 167. Property defined for the WF package schema type.......................................... 470Table 168. Properties defined for the wf package skill type.............................................. 471Table 169. Properties defined for the WF timer type........................................................ 473Table 170. Properties defined for the workflow type ....................................................... 475Table 171. Properties defined for the work item type ...................................................... 481Table 172. Properties defined for the work queue type .................................................... 487Table 173. Properties defined for the work queue doc profile type ................................... 489Table 174. Properties defined for the work queue policy type .......................................... 491Table 175. Properties defined for the work queue user profile type .................................. 493Table 176. Properties defined for the wq skill info object type.......................................... 495Table 177. Properties defined for the wq task skill object type.......................................... 498Table 178. Properties defined for the wq user skill object type ......................................... 499Table 179. Properties defined for the xml application type............................................... 500Table 180. Properties defined for the xml config type ...................................................... 502Table 181. Properties defined for the xml custom code type............................................. 503Table 182. Properties defined for the xml style sheet type................................................ 504Table 183. Properties defined for the xml zone type ........................................................ 505Table 184. Properties defined for the lightweight object type ........................................... 508Table 185. Properties added to a type in specific circumstances ....................................... 509Table 186. Properties defined for the connection config type............................................ 515Table 187. Properties defined for the docbase locator type............................................... 518Table 188. Properties defined for the docbroker locator type ........................................... 521Table 189. Properties defined for the server locator type.................................................. 522Table 190. Properties defined for the session config type ................................................. 525Table 191. Properties defined for the wfsd element object type ........................................ 533Table 192. Properties defined for the wfsd element boolean object type............................ 534Table 193. Properties defined for the wfsd element date object type ................................. 535Table 194. Properties defined for the wfsd element double object type ............................. 536Table 195. Properties defined for the wfsd element integer object type ............................. 537Table 196. Properties defined for the wfsd element string object type ............................... 539Table 197. Properties defined for the wfsd type info object type....................................... 540Table 198. Properties defined for the wfsdrp boolean object type ..................................... 545Table 199. Properties defined for the wfsdrp date object type .......................................... 546Table 200. Properties defined for the wfsdrp double object type ...................................... 547Table 201. Properties defined for the wfsdrp integer object type ...................................... 548Table 202. Properties defined for the wfsdrp parent object type ....................................... 549Table 203. Properties defined for the wfsdrp string object type ........................................ 551Table 204. Properties defined for the calendar event type ................................................ 555Table 205. Properties defined for the comment type........................................................ 558Table 206. Properties defined for the datatable type ........................................................ 560Table 207. Properties defined for the datatable schema type ............................................ 562Table 208. Properties defined for the datatable schema ex type ........................................ 563Table 209. Properties defined for the datatable settings type............................................ 564


Table of Contents

Table 210. Properties defined for the notepage type ........................................................ 567Table 211. Properties defined for the readcomment type ................................................. 568Table 212. Properties defined for the richtext type .......................................................... 569Table 213. Properties defined for the room type.............................................................. 570Table 214. Properties defined for the topic type .............................................................. 573Table 215. Properties defined for the dmc dsm application type ...................................... 576Table 216. Properties defined for the dmc dsm backbone type ......................................... 577Table 217. Properties defined for the dmc dsm doc properties type.................................. 578Table 218. Properties defined for the dmc dsm drug product type ................................... 580Table 219. Properties defined for the dmc dsm drug substance type................................. 581Table 220. Properties defined for the dmc dsm excipient type.......................................... 582Table 221. Properties defined for the dmc dsm facilities equip type.................................. 583Table 222. Properties defined for the dmc dsm indication type ........................................ 584Table 223. Properties defined for the dmc dsm safety eval type ....................................... 586Table 224. Properties defined for the dmc dsm sect doc attributes type ............................ 587Table 225. Properties defined for the dmc dsm section type............................................. 589Table 226. Properties defined for the dmc dsm section extension type .............................. 591Table 227. Properties defined for the dmc dsm stf backbone type..................................... 592Table 228. Properties defined for the dmc dsm stf section type ........................................ 594Table 229. Properties defined for the dmc dsm study attributes type................................ 595Table 230. Properties defined for the dmc dsm study report type..................................... 596Table 231. Properties defined for the dmc dsm submission type ...................................... 597Table 232. Properties defined for the rps action type ....................................................... 600Table 233. Properties defined for the rps action rel type .................................................. 601Table 234. Properties defined for the rps authority type .................................................. 602Table 235. Properties defined for the rps base date type .................................................. 604Table 236. Properties defined for the rps child strategy type ............................................ 606Table 237. Properties defined for the rps condition type .................................................. 608Table 238. Properties defined for the rps contact type ..................................................... 609Table 239. Properties defined for the rps disposition method type ................................... 610Table 240. Properties defined for the rps event type ........................................................ 612Table 241. Properties defined for the rps execution rule type ........................................... 614Table 242. Properties defined for the rps hold type ......................................................... 615Table 243. Properties defined for the rps notification type ............................................... 617Table 244. Properties defined for the rps phase rel type................................................... 619Table 245. Properties defined for the rps retainer Type.................................................... 621Table 246. Properties defined for the rps retainer event rel type ....................................... 624Table 247. Properties defined for the rps retention policy type......................................... 625Table 248. Properties defined for the scs admin config type ............................................. 630Table 249. Properties defined for the webc config type .................................................... 632Table 250. Properties defined for the webc target type .................................................... 639Table 251. Properties defined for the xfm adaptor config type ......................................... 646Table 252. Properties defined for the xfm form type........................................................ 648


Table of Contents

Table 253. Properties defined for the xfm instance type ................................................... 650Table 254. Properties defined for the xfm schema type .................................................... 651Table 255. Properties defined for the eps config cache type.............................................. 654Table 256. Properties defined for the eps elem type mapping type ................................... 655Table 257. Properties defined for the eps element type .................................................... 656Table 258. Properties defined for the eps issue type ........................................................ 658Table 259. Properties defined for the eps mapping type .................................................. 659Table 260. Properties defined for the eps metadata mapping type.................................... 660Table 261. Properties defined for the eps page detail type ............................................... 661Table 262. Properties defined for the eps performer mapping type .................................. 662Table 263. Properties defined for the eps placement type ................................................ 663Table 264. Properties defined for the eps pubinfo cache type ........................................... 664Table 265. Properties defined for the eps publication type ............................................... 665Table 266. Properties defined for the eps relation type .................................................... 666Table 267. Properties defined for the eps schedule mapping type .................................... 667Table 268. Properties defined for the eps section type ..................................................... 668Table 269. Properties defined for the eps state type ......................................................... 669Table 270. Properties defined for the eps state mapping type........................................... 670Table 271. Properties defined for the eps state perm mapping type .................................. 671Table 272. Properties defined for the eps state transition type .......................................... 672Table 273. Properties defined for the eps template mapping type..................................... 673Table 274. Properties defined for the eps transition override type .................................... 674Table 275. Properties defined for the eps wf template mapping type ................................ 675Table 276. Properties defined for the eps workflow data type .......................................... 676Table 277. Recommended language codes...................................................................... 679Table 278. Recommended country codes........................................................................ 680Table 279. Columns of the dm_user_s table .................................................................... 684Table 280. Columns of the dm_user_r table .................................................................... 685


Table of Contents


Preface

This manual is the reference manual for the EMC Documentum object hierarchy. It is a companion toContent Server DQL Reference Manual, Content Server Fundamentals, Content Server Administration Guide,and Documentum Distributed Configuration Guide.

Intended audienceThis manual is written for application developers and system administrators and anyothers who want to build a content or work-group management application that accessesand uses repository objects. It assumes that you are familiar with the concepts ofdocument processing, object-oriented programming, and client-server applications. Italso assumes working knowledge of SQL.

ConventionsThis manual uses the following conventions in the syntax descriptions and examples.

Syntax conventions

Convention Identifies

italics A variable for which you must provide a value.

[ ] square brackets An optional argument that may be included only once

{ } curly braces An optional argument that may be included multipletimes

Revision historyThe following changes have been made to this document.


Preface

Revision history

Revision date Description

August 2007 Initial release


Chapter 1Object Basics

This chapter provides reference information about objects and properties that is not specific to aparticular object type. The topics in this chapter are:• Computed properties, page 15• Property datatypes, page 25• Referencing properties, page 26• Identifiers, page 27• Relationships, page 30

Computed propertiesThis section lists the computed properties supported by Content Server. Computedproperty values are not stored in the repository with an object’s description but arecomputed at runtime when needed.

Table 1, page 15, lists all computed properties except those that are specific to lifecycles.The lifecycle-specific computed properties are found in Table 2, page 23.

Table 1. The computed properties

Property Single orrepeating

Description

_accessor_app_permit

R Application_permit values of the entriesfor an ACL. The value at each indexposition represents the application_permitproperty value for the entry representedby the corresponding index position in_accessor_name.

_accessor_name R The list of users and groups for whomsome level of access to the selected object is


Object Basics


Description

defined. This property has valid values onlyif the repository is using ACLs for security.

This property reflects the current statusof an object’s ACL. Therefore, if you arechanging an object’s permissions, thisvalue reflects those changes, regardless ofwhether you have saved the changes. Checkthe _acl_ref_valid property to determinewhether the values in _accessor_name havebeen saved.

_accessor_permit R The permission levels assigned to eachuser or group defined in _accessor_name.The values, expressed as integers, areassociated with the user or group at thecorresponding index position. For example,the permission level at _accessor_permit[4]is assigned to the user or group specifiedby _accessor_name[4].

This property reflects the current statusof an object’s ACL. Therefore, if you arechanging an object’s permissions, this valuealways reflects those changes, regardlessof whether you have saved them. Checkthe _acl_ref_valid property to determinewhether the values in _accessor_permithave been saved.

_accessor_permit_type

R Permit types of the entries. The value ateach index position is the permit type ofthe entry represented by the correspondingindex position in _accessor_name.

_accessor_xpermit R Contains the integer value of the extendedpermissions assigned to each user orgroup returned by _accessor_name.The values, expressed as integers, areassociated with the user or group at thecorresponding index position. For example,the permission level at _accessor_xpermit[4]is assigned to the user or group specifiedby _accessor_name[4].


Object Basics


Description

_accessor_xpermit_names

R A list of the extended permissions, instring form, assigned to each user or groupdefined in _accessor_name.

_acl_ref_valid S A Boolean property that indicateswhether the values of _accessor_nameand _accesssor_permit have been saved.If they have been saved, this property isFALSE. If the values have not been saved,_acl_ref_valid is TRUE.

_alias_set S The name of the alias set object bound toan object. This property is applicable toSysObjects, user objects, and server configobjects.

_all_users_names R A list of all users directly or indirectlycontained in a group.

This property is cached on the server andclient the first time it is queried in a session.Subsequent queries against it in the sessionreturn the cached values. To ensure thatthe returned values are correct, you canforce the server to refresh the cache byissuing a IDfPersistentObject.revert methodon the group object. Changing the groupmembership also invalidates the cache andforces a refresh.

_allow_change_location

S A Boolean value indicating whether theuser has the Change Location permission.

_allow_change_permit

S A Boolean value indicating whether theuser has the Change Permission permission.

_allow_change_state S A Boolean value indicating whether theuser has the Change State permission.

_allow_execute_proc S A Boolean value indicating whether theuser has the Execute Procedure permission.

_allow_change_owner

S A Boolean value indicating whether theuser has the Change Ownership permission.

_change_folder_links S A Boolean value indicating whether the userhas the Change Folder Links permission


Object Basics


Description

_attribute_list_values R A string property containing the listof audited properties and their valuesrecorded in an audit trail entry.

The first index position stores the value ofdm_audittrail.attribute_list. The remainingindex positions stores the values from thedmi_audittrail_attrs object associated withthe audittrail object, if any.

The length of the property is the maximumlength allowed by the underlying RDBMSfor character data types.

_cached S A Boolean property indicating whether theobject is in the object cache. It returns TRUEif the object is in the cache and FALSE if not.

_changed S A Boolean property that indicates whetherthe object has been changed since it was lastsaved.

The server checks the object cache and if theobject is not in the cache or is in the cachebut hasn’t been changed, server returnsFALSE. TRUE is returned if the object ispresent in the cache and has been changed.

_componentID R The chronicle IDs of the componentdocuments that make up a virtualdocument. The ID value at each indexposition is the chronicle ID for thecomponent at that position in the virtualdocument.

The zero position, _containID[0], representsthe chronicle ID for the virtual document.A virtual document is always considered acomponent of itself.


Object Basics


Description

_containID R The object IDs of the containment objectsthat link the component document toits containing virtual document. The IDvalue at each index position represents thecontainment object for the component atthat position in the virtual document.

The zero position, _containID[0], representsthe containment object for the virtualdocument. A virtual document is alwaysconsidered a component of itself.

_content_state R An integer value representing the state of acontent for a given SysObject. State valuesand their meanings are:

0, meaing available and online1, meaning archived2, meaning offline3, meaning error fetching contentfrom the repository

For example, if _content_state[1] = 1, thenthe first content for the object is archived.

_count S The number of properties in the object

_current_state S The current lifecycle state of the object.

_docbase_id S That portion of a specified object ID thatcorresponds to the repository ID.

_dump S A description of the object, including allproperties and their values

_has_config_audit S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_has_create_type S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_has_create_group S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.


Object Basics


Description

_has_create_cabinet S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_has_purge_audit S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_has_superuser S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_has_sysadmin S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_has_view_audit S A Boolean property indicating whether theuser has the privilege. T (TRUE) means theuser has the privilege.

_id S A unique object identifier that contains theobject’s r_object_id value

_is_restricted_session S A Boolean property that indicates whetherthe current session is a restricted session inwhich the only valid operation is changingthe user’s password. T means that thecurrent session is such a session. F meansthat the session is not restricted to a changepassword operation.

_isdeadlocked S A Boolean property that indicates whetherthe current session was chosen as the victimof a deadlock.

This property is reset when the next methodthat issues an RPC call is executed.

_isnew S A Boolean property that indicates whetherthe object is a new object, that is, whetherthe object has been saved in the repository.


Object Basics


Description

_isreplica S For use in a distributed storageenvironment, this indicates whetheran object is a replica (read-only copy) or theoriginal object. This property is valid onlyfor cabinets, folders, documents, notes, andsmart lists.

_istransactionopen S A Boolean property that indicates whetheran explicit transaction is open. TRUE meansa transaction is open. FALSE means there isno transaction open.

_lengths R Lengths of an object’s properties. Propertylength is measured in the number of bytesrequired by its datatype, such as a 4-byteinteger. However, this information is onlyuseful for character string columns.

_masterdocbase S The repository ID of the repository thatowns an object. Unless the object is a replica,this value is the ID of the local repository. Ifthe object is a replica, the value is the ID ofthe foreign repository that owns the object.

This property is an integer property.

_names R Names of an object’s properties.

_permit S An integer number that corresponds tothe permissions for an object of a specifieduser. If the user is unspecified in the query(for example: get,c,object_id,_permit), thecurrent user is assumed.

The permission returned represents themost permissive permission the user has forthe specified object.

A value of 0 indicates that the object is not aSysObject. Values of 2 to 7 correspond to theobject-level permissions Browse throughDelete, respectively.

The Content Server Administration Guide hasdetails about the permissions defined forobjects.

_policy_name S Name of the lifecycle to which the object isattached.


Object Basics


Description

_repeating R Whether properties are single or repeating.Values are 0 for single-valued propertiesand 1 for repeating properties.

_resume_state S Name of the lifecycle’s normal state whichimmediately preceded the current state ofthe object.

_sign_data S An XML file that contains the propertiesused to generate the hashed signature foran audit trail entry.

The output is well-formed XML. Itincludes the values of the entry’s associateddmi_audittrail_attrs object, if one exists.

_status S Level of the error (if any) resulting from amethod call against an object. The level isrepresented as a numeric value. The valuesare:

0, for informational messages (OK, forexample)

1, for trace messages

2, for warning messages

3, for error messages

4, for fatal error messages

If two or more errors occur, only the firsterror’s level is stored unless the subsequenterror is more severe. In such cases, thenumber associated with the more severeerror is stored. If no errors occur, thisproperty contains 0 (for OK). To clear thisproperty, use the reset method.

_type_id S The object ID of the dm_type object for theobject type of the specified object. This isreturned as a string value.

_type_name S The internal name of the object’s type.


Object Basics


Description

_types R Datatypes of an object’s properties. Thedatatypes are specified as numbers:

0, for Boolean1, for Integer2, for String3, for ID4, for Time5, for Double

_typestring S Returns the number of supertypes ina specified object’s hierarchy and typeinformation about each supertype.

_values R Total number of values of an property(useful for repeating properties).

_xpermit R Contains the integer value of the extendedpermissions the current user or the specifieduser has on the object.

_xpermit_list S Contains a full list of the extendedpermissions, in string form, currentlysupported by server. Note that thiscomputed property returns the same listregardless the object ID.

_xpermit_names s Contains the list of the extendedpermissions, in string form, the current useror the specified user has on the object.

Table 2, page 23, lists additional computed properties that apply only to lifecycles(dm_policy objects).

Table 2. Computed properties for lifecycles


Description

_alias_sets R List of the object names of the valid aliassets for the lifecycle. The value at eachindex position corresponds to the alias setspecified at the same index position in thealias_set_ids property.


Object Basics


Description

_entry_criteria R List of expressions that must evaluate toTRUE before an object can be promoted toa state. The value at each index positioncorresponds to the conditions set for thestate defined at that index position.

This computed property is read andwrite. Setting _entry_criteria sets theentry_criteria_id property in the policyobject. The Content Server Fundamentals hasdetails.

_included_types S The list of acceptable object types for thispolicy, in lower case, separated by commas.

_next_state R The name of next state. Exception states andthe terminal state do not have a next state.

_previous_state R The name of previous state. Exceptionstates and the base state do not have aprevious state.

_state_extension_obj[[index]]

R The object ID of the state extension objectassociated with a particular lifecycle state.

The index value identifies the lifecycle stateby identifying the state’s state number. Forexample, _state_extension_obj[0] returnsthe object ID of the state extension objectassociated with the lifecycle state number 0.

If an index value is not included, the defaultis 0.

_state_type R Identifies whether the state is an exceptionstate or, if is not an exception state, it’splace in the sequence of lifecycle states.The information at each index position isapplicable to the state whose state numbercorresponds to the index position number.Valid values are:

1, for Exception0, for Base (first normal state)1, for Terminal (last normal state)2, for Step (normal between base andterminal states)


Object Basics

Property datatypesTable 3, page 25, lists the Documentum datatypes, their RDBMS equivalents, their rangeof values, and their default values. Note that the length specifications for the stringdatatype are expressed as number of bytes.

Table 3. The property datatypes

Docu-mentumPropertyDatatypes

DQL Type Oracle DB2, Sybase,and MS SQLServer

ValueRange

DefaultValue

DM_INTEGER

integer number(10) integer -2147483647to+2147483647

0

DM_BOOLEAN

boolean,bool

number(6) integer 1 (TRUE) or0 (FALSE)

0 (FALSE)

DM_STRING

For valuesfor non-qualifiablestringproperties,refer to thefootnote **

string,character,char

char(64)max lengthis 4000

varchar, charfor DB2 andSybase.

On DB2:maximumlength is2000

For Sybase,refer to thefootnote *

nvarcharand ncharon SQLServer, withmaximumlengthof 4000(Unicode)or 7000 (non-Unicode)

0 (blankstring) tomaximumfor RDBMS

a null string,specified ""


Object Basics

Docu-mentumPropertyDatatypes

DQL Type Oracle DB2, Sybase,and MS SQLServer

ValueRange

DefaultValue

DM_DOUBLE

double,float

number 1 x10-129 to 1 x10+129

float 1.7e-308to 1.7e+308

specific toRDBMS

0.0

DM_TIME time, date date timestamp(DB2)

datetime(MS SQLServer andSybase)

01/01/1753to 12/31/9999

current time

DM_ID ID char(16) char(16) notapplicable

an ID of allzeros

* The maximum length of a string property on a Sybase RDBMS is dependent on theconfiguration of the underlying database tables; specifically, on the page size of thetables and whether they are configured as APL or DOL tables. For allowed sizes forthe various sizes and configurations, refer to the Sybase installation and configurationdocumentation.

** The maximum length of a non-qualifiable property defined as a string datatype isthe value in the max_nqa_string key in the server.ini file. If not set, the maximumlength of a non-qualifiable string property is the maximum length defined by theunderlying relational database.

Note on string datatype nomenclature

The lengths defined for a string-datatype property in Table 3, page 25, and in thereference descriptions of object types are expressed as bytes. For example, thedm_sysobject.title property is string(255). This means that it is a string datatype thataccepts a value that is a maximum of 255 bytes long.

Referencing propertiesYou can reference persistent properties in DFC method calls or DQL statements.Computed properties can be referenced only in DFC calls; you cannot reference themin DQL statement.


Object Basics

DFC provides get and set methods for most properties. For those that do not havespecific get and set methods, you can use the getDatatype and setDatatype methodsin the IDfTypedObect interface. For example, if you were retrieving the value of astring property, you could call IDfTypedObject.getString with the property nameas the argument. There is a get and set method for each supported datatype in theIDfTypedObject interface.

When you reference a property in DQL, use the property’s name. For example:SELECT "title","subject" FROM "dm_document"WHERE ANY "keywords" IN ('floorplan','cubicle')

If the property is a property defined for an aspect, qualify the property name with theaspect name. For example:SELECT "title","editingAspect.editor_name" FROM "dm_document"WHERE ANY "keywords" IN ('floorplan','cubicle')

If the name matches a DQL reserved word, you must double-quote the name when youreference it in a method call or DQL statement.

IdentiersContent Server recognizes the following kinds of identifiers:• Names (Names, page 27)• Object identifiers (Object identifiers, page 29)• Property identifiers, page 29• Collection identifiers Collection identifiers, page 29)• Type identifiers (Type identifiers, page 30)• Session identifiers (Session identifiers, page 30)

Names

Names identify types, properties, tables, columns, users, and groups.

Names fall into three groups, depending on which naming rules apply to them. Thegroups are:• Object type and property names

The rules for these are described in Object type and property names, page 28.• User and group names

The rules for these are described in User and group names, page 28.


Object Basics

• Table and column names

The rules for these are described in Table and column names, page 29.Three naming rules apply to all names:• Do not begin a name with the prefix dm. Documentum reserves this prefix for its

own use.• The name must consist of ASCII characters.• If a name matches a DQL reserved word, enclose the name in double quotes

whenever you use it in a DQL query.

Note: It is good practice not to choose names that conflict with DQL reserved words.In addition to these rules, other rules apply specifically to each group of names.

Object type and property names

Object type and property names must observe the following rules:• The maximum allowed length is 27 characters.• The first character must be a letter. The remaining characters can be letters, digits, or

underscores.• The name cannot contain spaces or punctuation.• The name cannot be any of the words reserved by the underlying RDBMS.In addition, object type names cannot end in an underscore (_).

Type and property names are not case sensitive.

User and group names

User and group names must observe the following rules:• The maximum allowed length is 32 characters.• If the name is enclosed in single quotes when referenced, it can contain any character

allowed in a character string literal (spaces, apostrophes, and so forth).• If the name is enclosed in double quotes when referenced, it can be a DQL reserved

word.User names are case sensitive. Group names are not case sensitive. All group names arestored in lowercase in the repository regardless of the case used for the name whencreating the group.


Object Basics

Table and column names

Table and column names must observe the following rules:• The maximum length allowed by Content Server is 64 characters. The RDBMS or

operating system may impose stricter limits on the name’s length.• The first character must be a letter. The remaining characters can be letters, digits,

or underbars.• The name cannot contain spaces or punctuation.• The name cannot be any of the words reserved by the underlying RDBMS.Table and column names may or may not be case sensitive, depending on the rulesimposed by the RDBMS or operating system.

Object identiers

Object identifiers, or object IDs, are assigned by Content Server when an object is created.You cannot assign them yourself nor can you change them. Object IDs are expressedas a 16-character string.

Property identiers

Property identifers are assigned by Content Server when the property is defined for anobject type. That can occur when the object type is created or when a type is alteredto add a property.

Property identifiers are unique within the object type’s type hierarchy. The identifierscannot be changed. They are used instead of property names, to identify propertieswhen properties are stored in a property bag.

Collection identiers

A collection identifier represents the non-persistent object (collection) that contains theresults of a query or a method call. When the server executes the query or method thatreturns a collection, it places the results in a collection and returns an identifier for thecollection to the user or application. The user or application must use that identifier toretrieve the results.

Collection identifiers are two characters. The first is the letter q and the second is anumeric character.


Object Basics

Type identiers

A type identifier is a two-character string that appears as the first two characters of anobject’s object ID. Each system-defined object type has a unique type identifier. Forexample, the type identifier for the dm_document type is 09, and all objects of typedm_document have an object ID that begins with 09.

When you create an object type, it inherits its type identifier from the system-definedsupertype. For example, any user-defined subtypes of dm_document also have a typeidentifier of 09.

User-defined types that have no supertype have a type identifier of 00.

Session identiers

Session identifiers are used in trace file entries to identify the session associated with anentry. A session identifier has the format sn, where n is an integer number.

RelationshipsA relationship is an association between two objects in the repository. Somesystem-defined relationships are installed with Content Server. (For example,annotations are implemented as a system-defined relationship between a SysObject,generally a document, and a note object.) Documentum also allows you to define yourown kinds of relationships.

Each kind of relationship is described by a dm_relation_type object. The properties of arelation type object name the relationship, define the security that applies to instances ofthat relationship, and define the behavior when an object participating in an instance ofthat relationship is copied, versioned, or deleted.

Each instance of a particular relationship is described by a dm_relation object. A relationobject identifies the two objects involved in the relationship and describes the type ofrelationship. Relation objects also have several properties that you can use to manageand manipulate the relationship.

Both types, dm_relation_type and dm_relation, are persistent and, consequently, objectsof those types have object IDs and are stored in the repository. However, you cannotversion relation type or relation objects, nor are object-level permissions applied to theseobject types. (Security for relationships is set by the value defined for the security_typeproperty of the relation type object. Refer to Security and relationships, page 33 formore information.)


Object Basics

User-dened relationships

You must provide the procedures that manage and manipulate the objects in auser-defined relationship. Content Server enforces only security for user-definedrelationships. If the nature of the relationship requires actions other than securitymanagement, you must write the procedures for those actions. For example, supposeyou define a relationship between two documents that requires one document to beupdated automatically when the other document is updated. The server does notperform this kind of action. You must write a procedure that determines when the firstdocument is updated and then updates the second document.

Creating a relationship type

A relation type object describes a relationship. Before you can create relation objectsrepresenting instances of a relationship, the relationship must be described by a relationtype object. Creating a relation type object requires Sysadmin or Superuser privileges.

To dene a type of relationship:1. Create a relation type object.

2. Set the object’s child_type, parent_type, relation_name, and security_typeproperties.Security and relationships, page 33, describes the possible settings for security_type.

3. Set the permanent_link and child_copy properties.These properties control how instances of the relationship are handled whenthe parent object is copied or versioned using a 5.3 (or higher) DFC-basedapplication. For complete information about how these properties control behaviorand compatibility with client library versions, refer to The permanent_link andcopy_child properties, page 34.

4. To define non-default delete behavior, set the direction_kind and integrity_kindproperties.Defining delete behavior, page 35, describes how the settings of these propertiesaffect behavior when users delete objects participating in relationships.

5. Use the Save method to save the object.


Object Basics

Creating a relationship between two objects

To create a relationship between two objects, you must create the relation object thatdescribes their relationship. A relation object represents an instance of the relationshipdescribed by a relation type object.

To create a relationship between two objects:1. Create a dm_relation object.

2. Set the object’s attributes.You must set the following attributes:• relation_name

This identifies the type of relationship between the two objects. It must matchthe value of the relation_name attribute of an existing relation type object.

• parent_id

This identifies the object that is considered the parent in the relationship. Usethe object’s object ID.

• child_id

This identifies the object that is considered the child in the relationship. Usethe object’s object ID.

Additionally, you may want to set the optional attribute, child_label. Settingthe child_label attribute defines which version of the child participates in therelationship. The version is not required to be the same version you identified inthe child_id attribute. If the object specified in child_id does not carry the correctversion label, the server searches the version tree containing the version identified inthe child_id attribute for the version specified in child_label and uses that versionin the relationship.

Note: If the applications that will manage and manipulate the objects in therelationship are running against the DMCL or a pre-5.3 DFC, you may also wantto set the permanent_link attribute. In the DMCL or a pre-5.3 DFC, this attributecontrols whether the relationship is maintained when the parent object is copied orversioned. (In a 5.3 DFC, this behavior is controlled by attributes in the relationship’sdefinition instead of by the permanent_link attribute at the relation instance level. Formore information, refer to The permanent_link and copy_child properties, page 34.)

3. Save the object.


Object Basics

Security and relationships

Documentum manages security for all relationships, system- or user-defined.

The security level defined for a relation type object determines who can create, modify,or drop instances of that relationship. You define security by setting the security_typeproperty for the relation type object. There are four valid settings:• SYSTEM• PARENT• CHILD• NONE

SYSTEM security

SYSTEM security means that only superusers or system administrators can directlycreate, modify, or drop the relation objects that represent instances of the relationship.

SYSTEM-level security does not prevent an owner of an object from destroying an objectthat participates in the relationship even though destroying the object automaticallydestroys all relation objects associated with the object. The object owner is not requiredto be a superuser or system administrator.

PARENT and CHILD security

PARENT and CHILD security levels mean that the permissions to create, modify, ordrop instances of a relationship depend on the object type of either the parent or child,whichever is specified. If you specify PARENT, the server uses the object type specifiedas the parent in the relationship to determine the permissions. If you specify CHILD,the server uses the object type specified as the child to determine the permissions. Ineither case, the rules that the server applies are the same:• If the object type is dm_user or dm_group, only a superuser or system administrator

can create, modify, or drop instances of the relationship.• If the object type is dm_sysobject or a SysObject subtype, a user must have at

least Relate permission on the object to create, modify, or drop instances of therelationship.

• If the object type is a persistent type that is not covered by either of these two rules,security is not enforced. For example, objects of type dm_store fall into this category.


Object Basics

None

NONE security means that any user can create, modify, or drop instances of therelationship. If you do not want the server to enforce security for a particular type ofrelationship, set the security_type property for the relation type object to NONE.

The permanent_link and copy_child properties

The permanent_link and copy_child properties control how instances of the relationshipare handled by a 5.3 DFC-based application when the parent object is copied or versioned.They do not effect behavior if the application is based on pre-5.3 DFC or any version ofthe DMCL. (For more details, refer to Compatibility with prior releases, page 35.)

The permanent_link property determines whether the relationship is maintained whenthe parent is copied or versioned. The property is T (TRUE) by default, meaning that therelationship is maintained. The copy_child property is used only when permanent_linkis true and when the parent is copied. copy_child is not used if the parent is versioned.

If permanent_link is true and the parent is copied, then copy_child is used to determinewhether the relationship with the new parent is established with the old child or anew copy of the child. Table 4, page 34, describes the behavior for all combinations ofpermanent_link and copy_child.

Table 4. Effects of setting permanent_link and copy_child properties

permanent_link=T permanent_link=F

copy_child=0 The child object is not copied.A new relation object iscreated that associates thenew copy or version of theparent object with the oldchild.

The relationship is not maintainedwhen the parent is copied orversioned.

copy_child=1 If the parent is copied (usingIDfCopyOperation), the childobject is copied. A newrelation object is created thatassociates the new copy orversion of the parent objectwith the new copy of thechild object.

If the parent object isversioned, the child object

The relationship is not maintainedwhen the parent is copied orversioned.


Object Basics

permanent_link=T permanent_link=F

is not copied and a newrelation object is created thatassociates the new version ofthe parent object with the oldchild.

Compatibility with prior releases

The dm_relation_type.permanent_link and dm_relation_type.copy_child properties arerecognized and supported only by DFC versions 5.3 and later. The DMCL and pre-5.3versions of DFC do not recognize or support these properties.

The DMCL and pre-5.3 versions of DFC will continue to use dm_relation.permanent_linkto determine whether to maintain an instance of a relation when the parent objectis copied or versioned.

In DFC 5.3 and later, the value of dm_relation_type.permanent_link is the default valuefor the dm_relation.permanent_link property. Consequently, if a user or applicationcreates an instance of a relationship using an application that is using a 5.3 or later versionof DFC and the user or application does not set the dm_relation.permanent_link property,the DFC sets the property’s value to the value of the dm_relation_type.permanent_linkproperty by default. This ensures that the relationship is correctly handled whether theparent object is manipulated by an application using DFC 5.3 or later, the DMCL, or apre-5.3 DFC application.

Dening delete behavior

How Content Server behaves when a user deletes an object that participates in arelationship depends on how the direction_kind and integrity_kind properties are setin the relationship’s definition (the dm_relation_type object). These properties areinteger properties.

The direction_kind property defines the direction of the relationship. Valid values are:

Value Meaning

0 From the parent to the child (default)

1 From the child to the parent

2 Bidirectional (the objects are treated as siblings)


Object Basics

The integrity_kind property defines what deletion rule is applied to objects participatingin instances of the relationship. The possible values are:

Value Meaning

0 Allow delete (default)

1 Restrict delete

2 Cascade delete

The allow delete option means that a user with appropriate permissions can delete anobject referenced as parent or child in the relationship without restriction. All relationobjects that reference the object are also deleted.

The restrict delete option means that an object participating in the relationship cannot bedeleted until the relation object is deleted. You must destroy the relation object beforeyou can delete the participating object.

The cascade delete option means that when a user deletes an object participating ina relationship instance, Content Server may also destroy the participating partner inthe relationship, depending on the direction of the relationship. For example, if therelationship is parent to child and a user deletes the parent, Content Server automaticallyremoves the child also. The deletions may cascade to other relationships in which thepartner is participating.

Table 5, page 36, describes the behavior for all combinations of direction_kind andintegrity_kind when a parent object is deleted from the repository.

Table 5. Deletion behavior when deleting a parent object

direction_kind integrity_kind

0 (allow delete) 1 (restrict delete) 2 (cascade delete)

0 (parent to child) Deletion succeeds;child object is notdeleted.

Deletion fails Deletion succeeds;child object is alsodeleted.

1 (child to parent) Deletion succeeds;child object is notdeleted.

Deletion succeeds;child object is notdeleted.


2 (bidirectional-siblings)


Deletion fails Deletion succeeds;child object is alsodeleted.

Table 6, page 37, describes the behavior for all combinations of direction_kind andintegrity_kind when a child object is deleted from the repository.


Object Basics

Table 6. Deletion behavior when deleting a child object

direction_kind integrity_kind

0 (allow delete) 1 (restrict delete) 2 (cascade delete)

0 (parent to child) Deletion succeeds;parent object is notdeleted.

Deletion succeeds;parent object is notdeleted.


1 (child to parent) Deletion succeeds;parent object is notdeleted.

Deletion fails Deletion succeeds;parent object is alsodeleted.

2 (bidirectional-siblings)


Deletion fails Deletion succeeds;parent object is alsodeleted.

Destroying a relationship type

To remove a particular kind of relationship from your repository, you destroy the relationtype object that describes that relationship. Destroying a relation type object requireseither Superuser or Sysadmin privilege.

You cannot destroy a relation type object if there are relation objects that reference thatrelationship. You must first destroy the relation objects.

Destroying a relationship between objects

To destroy a user-defined relationship between two objects, destroy the relation objectrepresenting their relationship. Destroying a relation object does not remove theparticipating objects from the repository. It only removes the connection between theobjects that was established by the relation object.

The security level defined for a relationship (in the relation type object) determineswho can destroy the relation objects that represent instances of the relationship. (Forinformation about security levels, refer to Security and relationships, page 33.)

Use a destroy method to remove a relation object from the repository. Specify therelation object’s object ID.


Object Basics

Relationships and object operations

This section describes how relationships and common operations interact.

Checkin, Saveasnew, and Branch

How a relationship is handled when the parent object is checked in, saved as new, orbranched depends on the setting of the two attributes, permanent_link and copy_child,in the relationship’s definition (the dm_relation_type object defining the relationshiptype). For information about how the settings of these attributes are used, refer to Thepermanent_link and copy_child properties, page 34.

Note: In the DMCL and in a pre-5.3 DFC, the permanent_link attribute in the dm_relationobject itself determines how the relationship is handled when the parent is versioned orcopied. If permanent_link is set to T, when the parent object is versioned or copied, a newrelation object is created that associates the new copy or version with the child object.

Save

Saving an object does not change or remove any of its user-defined relationships.

However, saving an object does not automatically keep its annotations, a system-definedrelationship. Refer to Content Server Fundamentals for information about this.

Destroy

When you destroy an object, the server also destroys all the relation objects that referencethe destroyed object, regardless of whether the object participates in the relationshipas parent or child.

Content Server behavior when you attempt to destroy an object that participates ina user-defined relationship is determined by the settings of the direction_kind andintegrity_kind attributes in the relationship’s definition (the dm_relation_type object).For details, refer to Defining delete behavior, page 35.


Object Basics

Object replication

If a replicated object is a parent in any user-defined relationship in the source repository,the child object and the associated relation and relation type objects are replicated.

If the replicated object has annotations, the annotations are replicated.


Object Basics


Chapter 2Core Persistent Object Types

This chapter contains the reference information for object types that are either built in toContent Server or installed through a script when a repository is configured. Most of thetypes listed in this chapter are direct or indirect subtypes of the persistent object type.The persistent object type has three properties that it passes to all of its subtypes:• r_object_id

The r_object_id property contains a 16-character hexadecimal string that is assignedby the system when an object is created. This value uniquely identifies the objectin the repository.

• i_vstamp

The i_vstamp property contains an integer value that represents the numberof committed transactions that have changed an object. This value is used forversioning, as part of the locking mechanism, to ensure that one user does notoverwrite the changes made by another.

• i_is_replica

The i_is_replica property indicates whether the object is a local replica of an objectin a remote repository.

The non-persistent types described in this chapter are not stored in the repository.Consequently, they do not have object IDs or i_vstamp values, and they are neverreplicated. They are objects that are created and used during a session and vanish whenthe session is terminated.

This chapter lists the properties defined for the persistent and non-persistent typesin Content Server. For the persistent types, the information also includes the type’ssupertype, subtypes, and internal name.


ACL

ACL

Purpose An ACL object represents an Access Control List.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_aclObject type tag: 45

For SysObjects, the entries in the repeating properties control who can access the objectto which the ACL is attached. If the repository security mode is set to acl, Content Serverenforces the permissions granted by the ACL entries.

PropertiesTable 7, page 42, lists the properties defined for the type.

Table 7. Properties dened for the ACL type

Property Datatype Single orrepeating

Description

acl_class integer S Indicates whether the ACLis a regular ACL, a template,an instance of a template, ora public ACL. Valid valuesare:

0, Regular ACL1, Template ACL2, Template instance3, Public ACL

description string(128) S User-defined description ofthe ACL.


ACL


Description

globally_ managed Boolean S Indicates whether the aclobject is managed globallyor locally. The default isFALSE, meaning that it islocally managed.

i_has_access_restrictions

Boolean S Whether the ACL has oneor more entries with apermit_type value of 2.

i_has_required_groups


i_has_required_group_set


i_partition integer S reserved for future use


object_name string(32) S Names the ACL object. Thename, if provided, must beunique among the ACLs inthe repository. This propertycan be NULL.

owner_name string(32) S Identifies the owner of theACL. This will be the userwho created the ACL or, forsystem-level ACLs, the nameof the repository owner orthe alias dm_dbo.

r_accessor_name string(32) R List of those for whom accessto the ACL’s attached objectis defined. Valid entries inthe list are individual usernames, group names, andaliases.

This must be or resolveto a group name ifthe r_permit_type isRequiredGroup orRequiredGroupSet.


ACL


Description

r_accessor_permit integer R Identifies the access levelgranted to the user or groupat the corresponding indexlevel. Valid values are:

0, for NULL,1, for None2, for Browse3, for Read4, for Relate5, for Version6, for Write7, for Delete

Refer to the Content ServerAdministration Guide formore information aboutthese levels.

r_accessor_ xpermit integer R Identifies the extendedpermission level grantedto the user or group at thecorresponding index level.

Extended permissions are:

execute_procchange_locationchange_statechange_permitchange_ownerdelete_object

r_application_permit

string(128) R Specifies a permissionrecognized by anapplication. An applicationpermit is not recognizedor enforced by ContentServer. The application isresponsible for enforcing thepermission.

The permission defined ata particular index positionis applicable to the useror group identified in the


ACL


Description

corresponding position inr_accessor_name.

r_is_group Boolean R Indicates whether ther_accessor_names at thecorresponding index levelsare individual users orgroups.

r_has_events Boolean S Whether somone hasregistered the ACL forauditing.

r_is_internal Boolean S Indicates whether the ACLwas created explicitly bya user or implicitly by theserver.

r_permit_type integer R Identifies the permit type forthe entry. Valid values are:

0, meaning AccessPermit

1, meaning ExtendedPermit

2, meaning ApplicationPer-mit

3, meaningAccessRestriction

4, meaning ExtendedRestric-tion

5, meaning ApplicationRe-striction

6, meaning RequiredGroup

7, meaning Required-GroupSet

To set this to either 6 or 7, thevalue in r_accessor_nameat the corresponding indexposition must be a groupname.

The default value is 0.


ACS Cong

ACS Cong

Purpose Stores the configuration information for an ACS Server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_acs_configObject type tag: 08

An acs config object describes the configuration of an Accelerated Content Services(ACS) server. One ACS server is installed with each Content Server. The installationautomatically creates the associated acs config object. To change or modify the settings,use Documentum Administrator.


Table 8. Properties dened for the ACS cong type


Description

acs_base_url string(240) R Base URL to use whenaccessing the ACS usingthe protocol identifiedat the correspondingindex position inacs_supported_protocol.

acs_network_locations

string(80) R The network identifiersof the network locationsserved by the ACS.


ACS Cong


Description

acs_rw_capability integer S Defines whether the ACSis enabled and whether itcan use surrogate get. Validvalues are:

0, meaning the ACS isdisabled

1, meaning the ACS isenabled

3, meaning SurrogateGet isenabled

acs_supported_protocol

string(6) R Set of network protocolssupported by the ACS

Values in this propertymust be all lowercase. Forexample: http or https.

config_type integer S Whether the accessiblestorage areas and definedprojection targets areconfigured in the serverconfig object or this acsconfig object. Valid valuesare:

1, meaning use theconfiguration values inthe server config object(identified in srv_config_id)

2, meaning use theconfiguration values inthis acs config object(defined in the near_storesand projection-relatedproperties)


ACS Cong


Description

delivery_type string(4) S Whether the DMS servercan send messages to theACS server or must waitfor the ACS server to pullmessages from the DMSserver. Valid values are:

push, meaning the DMScan send messages to thisserver

pull, meaning DMS mustwait for the server to pullmessages

The default value is push.

is_cache_acs Boolean S The value is F (FALSE) forACS servers.

A value of T (TRUE) is notsupported for ACS servers.

near_stores string(32) R Storage areas that areaccessible for this ACSserver

The default is a singleblank.

projection_enable Boolean R Indicates whetherprojection to the connectionbroker specified atthe correspondingindex position inprojection_targets isenabled.

projection_netloc_enable

Boolean R Indicates whether theserver is allowed toservice users in thenetwork location specifiedat the correspondingindex position inprojection_netloc_ident.


ACS Cong


Description

projection_netloc_ident

string(80) R Names of the networklocations that this server canservice. The correspondingindex position inprojection_netloc_enablemust be set to T (TRUE) toallow the server to actuallyhandle requests from usersin a particular networklocation specified in thisproperty.

projection_ports integer R Identifies the port on whichthe connection broker islistening. The value ateach index position ismatched to the connectionbroker specified at thecorresponding level inprojection_targets. Thedefault is 1489.

projection_proxval integer R Proximity valuesrepresenting the ACSserver’s proximity to thenetwork locations identifiedat the correspondingindex position inprojection_netloc_ident.

projection_targets string(80) R Names of the host machineson which the connectionbrokers reside.

server_major_version

string(16) S Used internally. For ACSservers associated with aVersion 6 Content Server,this is set to 2.

server_minor_version

string(16) S Used internally. For ACSservers associated with aVersion 6 Content Server,this is set to 0.


ACS Cong


Description

supported_compression_mode

integer R Specifies whether the ACSsupports compression forthe storage type identifiedin the correspondingindex position ofsupported_store_types.Valid values are:

0, meaning compression isnot supported

1, meaning compression issupported

supported_crypto_mode

integer R Specifies whether the ACSsupports encryption forthe storage type identifiedin the correspondingindex position ofsupported_store_types.Valid values are:

0, meaning encryption isnot supported

1, meaning encryption issupported

supported_store_types

integer R Set of storage area typessupported by the ACS.Valid values are:

• 1, for file store• 3, for linked store

Note: Linked storageareas are deprecated inDocumentum 6 .

• 4, for distributed store• 5, for blob store• 7, for external store• 8, for external file store• 9, for external URL store• 10, for external free store


ACS Cong


Description

• 11, for ca store

srv_config_id ID S Object ID of the serverconfig object of the ACSserver’s associated ContentServer.


Activity

Activity

Purpose An activity object defines a workflow activity.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_activityObject type tag: 4c

The properties in an activity object define who performs the activity and the packagesand work items generated from the activity.

PropertiesTable 9, page 52, lists the properties defined for the activity type.

Table 9. Properties dened for the activity type


Description

activity_group_flag integer S reserved for future use

activity_group_id ID S reserved for future use

control_flag integer S Controls who receives a taskif automatic delegation fails.Valid values are:

0, meaning that the task isreassigned to the workflowsupervisor

1, meaning the task isreassigned to the original taskperformer.


Activity


Description

exec_err_handling integer S Indicates how to handleexecution failure for a runtimeinstance of this activity. Validvalues are:

0, meaning stop if the activityfails

1, meaning proceed with thetransition even if the activityfails

2, meaning terminate theworkflow

The default is 0.

exec_method_id ID S Contains the ID of thedm_method object thatrepresents the application.This is required if exec_typeis automatic.

exec_retry_interval integer S The length of time, inminutes,to wait between each attemptto execute an automaticactivity.

The default is 0, meaningretry immediately.

exec_retry_max integer S The maximum number oftimes to attempt to executean automatic activity beforetaking the failure actiondefined in exec_err_handling.

The default is 0, meaningdo not make any executionretries.


Activity


Description

exec_save_results Boolean S Indicates whether to saveresults generated by theapplication. The default is F(FALSE).

If set to T (TRUE), the serverdoes not verify the executionresults and assumes that themethod executed properly.Execution results are savedfor later verification in theobject whose ID is recorded inthe r_exec_result_id propertyof the work item.

exec_subtype integer S Indicates whether the activiitywaits for an inbound messageto proceed at runtime. Validvalues are:

0, meaning that is a Begin,Step or End activity and noinbound message is requiredto start the activity

1, meaning that this is notan Initiate activity but it istriggered by an inboundmessage

2, meaning that this isan Initiate activity that istriggered by an inboundmessage.

3, meaning that this isan Initiate activity butit is not triggered by aninbound message. Typically,these activities have formsassociated with them.


Activity


Description

exec_time_out integer S Defines how long anautomatic activity’s methodis allowed to execute beforetiming out.

You must set this to a positivenumber if the activity is anautomatic activity (exec_type= 1). The value is interpretedin seconds.

This is not used for manualactivities.

exec_type integer S Indicates the execution type.Valid values are:

0, for manual1, for automatic

is_private Boolean S Indicates whether thedefinition is private or public.The default is F (private).

performer_flag integer S Indicates whether delegationor extension is allowed. Validvalues are:

0, No delegation or extension1, Allow delegation2, Allow extension3, Allow both delegationand extension

The default is 0.


Activity


Description

performer_name string(66) R Identifies the activity’sperformer or performers.Valid values are a user name,a group name, the stringdm_world, representing allusers in the repository, a workqueue name, or an alias. Thealias format is

%[alias_set_name.]alias_name

Note: Do not specify a user orgroup name that begins with%. The server interprets thatas an alias.

performer_type integer S Identifies the category of theactivity performer. Validvalues are:

0, Workflow supervisor1, repository owner2, Last performer3, A user4, All members in a group5, Any user in a group6, The group memberwho is least loaded8, Some members of a groupor someusers in the repository9, Some members of a groupor some users in therepository sequentially10, A user from a work queue


Activity


Description

post_timer integer S Defines the length of time, inhours, in which the activitymust be completed after it isstarted.

The default value is 0, whichmeans the timer is not in use.

This property is only setwhen Workflow Manager isused to create a post-timer.Using Process Builder todefine a post-timer setsthe post_timer_incrementproperty instead.

post_timer_action ID R Object IDs of the moduleconfig objects that identifythe actions associated withthe timer’s firing. TheID at a particular indexposition represent theaction associated with thetriggering associated with thecorresponding index positionin post_timer_increment.

post_timer_calendar_flag

integer S reserved for future use

post_timer_calendar_id

ID S reserved for future use

post_timer_increment

integer R Value in the first indexposition defines a timeinterval after which the timeris triggered if the activityhas not been completed.The interval is expressed inminutes and is counted fromthe start of the activity.

Values in the following indexpositions define intervalsfor second and subsequenttriggerings of the timer ifthe activity has not been


Activity


Description

completed. The intervalsin these index positions arecounted from the end of theprevious interval.

post_timer_repeat_last

Boolean S Whether to repeat thelast action specified in thepost_timer_action property.

pre_timer integer S Defines the length of time, inhours, in which the activitymust be started after theworkflow starts.

The default value is 0, whichmeans the timer is not in use.

This property is only setwhen Workflow Manager isused to create a pre-timer.Using Process Builder todefine a pre-timer setsthe pre_timer_incrementproperty instead.

pre_timer_action ID R Object IDs of the moduleconfig objects that identifythe actions associated withthe timer’s firing. TheID at a particular indexposition represent theaction associated with thetriggering associated with thecorresponding index positionin pre_timer_increment.

pre_timer_calendar_flag


pre_timer_calendar_id

ID S reserved for future use


Activity


Description

pre_timer_increment

integer R Value in the first indexposition defines a timeinterval after which the timeris triggered if the activity hasnot been started. The intervalis expressed in minutes and iscounted from the start of theworkflow.

Values in the following indexpositions define intervalsfor second and subsequenttriggerings of the timer ifthe activity has not beenstarted. The intervals in theseindex positions are countedfrom the end of the previousinterval.

pre_timer_repeat_last

Boolean S Whether to repeat thelast action specified in thepre_timer_action property.

r_condition_id ID S Contains the object ID ofa compound condition (adm_cond_expr object).

r_condition_name string(16) R Contains the names of routecases.

r_condition_port string(16) R Contains the output portnames.

The ports are a particularindex position are theports associated with theroute case condition at thecorresponding index positionin r_condition_name.


Activity


Description

r_definition_state integer S Identifies the state of thisactivity definition. Validvalues are:

0, Draft1, Validated2, Installed

r_package_flag integer R Indicates whether the packageis visible and whether it isallowed to be empty. Validvalues are:

0, meaning the package isinvisible but cannot be empty

1, meaning the package isvisible and cannot be empty

2, meaning the package isinvisible but may be empty

3, meaning the package isvisible and may be empty

The default is 1.

r_package_id ID R Contains the ID of a singlepackage component. Notused if the package has morethan one component.

r_package_label string(32) R Contains a version label forthe package.

r_package_name string(128) R Contains the package name.The package name must beunique within the scope of thecontaining port.

r_package_oprtn string(64) R Contains the operation to beperformed by performers.

r_package_type string(40) R Contains the type name of thepackage object.


Activity


Description

r_performer_cond_id

ID S Object ID of dm_cond_exprobject that records theconditions used to resolve theperformer

r_performer_cond_name

string(16) R Names of the conditions usedto choose a performer

r_performer_cond_user

string(2000) R Contains a user or groupname, an alias that resolvesto a user or group name, ora select query that returns auser or group name.

The value at a particularindex position applies to thecondition specified at thecorresponding index positionin r_performer_condition_name.

r_port_name string(16) R Contains the unique identifierof a port.

r_port_type string(16) R Specifies the port type, one of:INPUT, OUTPUT, REVERT,or EXCEPTION.

r_predicate_id ID R Object ID of a persistentpredicate, to be evaluated forthe corresponding route case.

repeatable_invoke Boolean S Indicates whether this activitycan be included multipletimes or only once withina process definition. Thedefault value is T (TRUE),meaning the activity may beincluded multiple times.


Activity


Description

resolve_pkg_name string(128) S Contains the name of thepackage whose associatedalias set will be used to resolvethe activity’s performer alias.This property is used onlyif resolve_type is set to 1.If resolve_type is 1 andresolve_pkg_name is not set,then all incoming packagesare checked in the order inwhich they are defined.

resolve_type integer S Defines the resolutionalgorithm for the performeraliases. Valid values are:

0, Normal resolu-tion path (default)1, Use alias set associatedwith incoming package2, Use alias set associatedwith user or group

sd_element_flag integer R Indicates whether toreport the structured dataelement at runtime for thisactivity. The value at aparticular index positionapplies to the structureddata element identified insd_element_name propertyat the corresponding indexposition.

Valid values are:

0, do not report (default)

1, report


Activity


Description

sd_element_name string(255) R Names of the structured dataelements that are visible tothe activity.

The names must be a subsetof the structured dataelement names specifiedin dm_process.sd_element_name.

sign_off_required Boolean S Whether the activity requiresa signoff. If this is set to T,the user or application mustexecute a Signoff method tocomplete the activity.

The default is F (FALSE).

task_subject string(255) S A user-defined stringdescribing the task generatedfor this activity. The stringmay contain key phrases thatare interpreted at runtime.The key phrases have theformat:

$type.property

Type may be one of:dm_workflowdmi_workitemdmi_queue_itemdmi_packagedmi_package[x]

If type is dm_workflow,dmi_workitem or eitherpackage option, you canspecify any property of thetype.

If type is dmi_queue_item,you can specify any queueitem property excepttask_subject.


Activity


Description

transition_eval_cnt integer S Defines how many tasksmust be completed to triggeractivity completion.

This property is not valid foractivities with a performertype of 9, Some UsersSequentially.

Valid values are 0 and anypositive integer. Setting thisto 0 means that all tasksmust be completed before theactivity is completed. Thedefault value is 0.

transition_flag integer S Determines which outputlinks are actually triggeredwhen an activity completes.This value is used only iftransition_type is set to 1.

Valid values are:• 0, meaning trigger allselected ouptut links.

• 1, Trigger only revert linksif any are selected andignore forward links. Ifthere are no revert linksselected, trigger selectedforward links.

• 2, Trigger only forwardlinks if any are selectedand ignore any selectedrevert links. If there areno forward links selected,trigger revert links.

• 3, meaning trigger a revertlink immediately if one isselected

• 4, meaning trigger aforward link immediatelyif one is selected.


Activity


Description

transition_max_output_cnt

integer S Defines the maximumnumber of output ports that aperformer can select.

This property is valid onlywhen transition_type is set to1.

A valid value is 0 or anypositive integer. 0 meansthat there are no limits on thenumber of output ports theuser can select. The default is0.

transition_type integer S Specifies the type of thetransition condition. Validvalues are:

0, Prescribed (Packages areforwarded to output portswhen the post-condition ismet.)

1, Manual (Activityperformers specify the outputports with the Setoutputmethod.)

2, Automatic (Conditionalrouting logic computes theoutput ports.)



Activity


Description

trigger_event string(64) S Contains the expected eventtype that can trigger thisactivity instance.

trigger_threshold integer S Indicates the threshold of thetrigger condition; any numberbetween 1 and the totalnumber of input ports. Thedefault value is 0. 0 is onlyallowed for begin activities,which have no input ports.


Aggr Domain

Aggr Domain

Purpose An aggr domain object describes the set of properties in an object type for whichdata dictionary information is defined.

DescriptionSupertype: DomainSubtypes: NoneInternal name: dm_aggr_domainObject type tag: 51

Aggr domain objects are created and managed by the server. Users cannot create anaggr domain object.


Table 10. Properties dened for the aggr domain type


Description

attr_domain_id ID R Object IDs of the domainsthat describe the properties.

attr_domain_name string(32) R Currently unused.

attr_name string(32) R The names of propertiesthat have data dictionaryinformation in theirdefinitions.

code_objects ID R Object IDs of the expr codeobjects holding sourcecode that implements theexpressions associated withthe type, if any. Currently,only one value is allowed inthis property.


Aggr Domain


Description

i_dd_flags integer R Used internally.

type_name string(32) S Name of the object typeto which the propertiesbelong. This value is NULLfor lifecycle state or othernon-type overrides.


Alias Set

Alias Set

Purpose Records aliases and their actual values.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dm_alias_setObject type tag: 66

An alias set object contains one or more alias names that can be used as placeholders intemplate ACLs, in certain SysObject properties, in workflow definitions, and in Link andUnlink methods. Any user can create alias sets.


Table 11. Properties dened for the alias set type


Description

alias_category integer R Identifies the categoryof the value defined atthe corresponding indexposition in alias_value.Valid values and theirassociated categories are:

0, Unknown1, User 2Group3, User or Group4, Cabinet path5, Folder path6, ACL name

alias_description string(255) R User-defined descriptionof the alias name at thecorresponding indexposition in alias_name.


Alias Set


Description

alias_name string(32) R List of alias for the alias set.An alias_name value cannotcontain a period (.).

alias_usr_ category integer R User-defined categoryvalues for the values in thealias_value property.

alias_value string(255) R The actual user or groupname associated with thealias that appears at thecorresponding index levelin alias_name.

object_description string(128) S User-defined description ofthe alias set.

object_name string(32) S Name of the alias set. Thename must be uniqueamong all alias set objectsin the repository and cannotcontain a period (.) orbe composed entirely ofnumerical digits.

owner_name string(32) S Name of the user who ownsthe alias set.


App Ref

App Ref

Purpose An app ref object is used internally to reference an object used in an application.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_app_refObect type tag: 07

Objects of this type reference objects used in a DAR file. Users cannot create appref objects directly. They are created and managed by the server or DocumentumApplication Builder.

PropertiesTable 12, page 71, lists the only property defined for the type

Table 12. Property dened for the app ref type


Description

application_obj_id ID S Object ID of the objectreferenced by theapplication.


Application

Application

Purpose An application object represents a packaged application that can be installed bythe Documentum Application Builder.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_applicationObject type tag: 08

Application objects represent packaged DAR files. Users cannot create application objectsdirectly. They are created through the Documentum when a user creates a DAR file.

PropertiesTable 13, page 72, lists the property defined for the type.

Table 13. Property dened for the application type


Description

app_version string(16) S Application version label.

application_object_id

ID R Object IDs of the objects inthe application.

content_transfer_option

integer R Defines how to handlecabinets or folders whencopying them to a targetrepository.

Valid values are:

0, Copy all contained objects1, Copy only thehierarchy (the directlyor indirectly containedfolders, but not thedocuments in the folders)2, Copy just the cabinetor folder itself, but none


Application


Description

of its contained objects3, Copy only the cabinetor folder and its directlycontained documents.

The value at an indexposition applies to theobject at the correspondingindex position inapplication_object_id

copyright_string string(255) S User-defined.

def_alias_set_id ID S The object ID of thedefault alias set for theapplication. This is setthrough Developer Studio

post_install_proc_id

ID S Chronicle ID of thepost-installation procedure

post_install_proc_label

string(32) S Version label of thepost-installation procedure

pre_install_proc_id ID S Chronicle ID of thepre-installation procedure

pre-install_proc_label

string(32) S Version label of thepre-installation procedure

target_loc_alias string(64) R An alias that resolves tothe location to which tocopy the object in theapplication. The value at anindex position applies to theobject at the correspondingindex position inapplication_object_id.

target_perm_alias string(64) R An alias that resolves tothe name of a templateACL. The value at an indexposition applies to theobject at the correspondingindex position inapplication_object_id.


Application


Description

target_owner_alias string(64) R An alias that resolves tothe name of the owner ofthe object. The value at anindex position applies to theobject at the correspondingindex position inapplication_object_id.

upgrade_option integer S Defines how to handle theobject when the applicationis upgraded. The value at anindex position applies to theobject at the correspondingindex position inapplication_object_id.

Valid values are:

0, Overwrite the object1, Ignore the object2, Version the object

user_runnable Boolean S Reserved for future use.


Aspect Relation

Aspect Relation

Purpose Describes the compatibility of two aspects.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_aspect_relationObject type tag: 37

Caution: This object type is for internal use only. It is not currently supported forexternal use.

An aspect relation object type describes the compatibility of two aspects.


Table 14. Properties dened for the aspect relation type


Description

child_aspect_name string(64) S Reserved for internal use

parent_aspect_name

string(64) S Reserved for internal use

relation integer S Reserved for internal use


Aspect Type

Aspect Type

Purpose Stores the files that implement an aspect.

DescriptionSupertype: ModuleSubtypes: NoneInternal name: dmc_aspect_typeObject type tag: 0b

An aspect type object is a folder that contains the implementation classes and otherinformation about one aspect. (An aspect is a custom behavior implemented for aparticular object type class.) Aspect type folders are stored in the repository underSystem/Business Objects/Aspects.


Table 15. Properties dened for the aspect type object type


Description

aspect_category string(32) R Used internally

attaching_aspect_policy

string(128) R Used internally

copy_policy integer S Used internally

detaching_aspect_policy

string(128) R Used internally

i_attr_def string(27) S Used internally

is_data_shared Boolean S Used internally

target_object_type string(27) R Used internally

version_policy integer S Used internally


Assembly

Assembly

Purpose An assembly object describes a component of a virtual document.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_assemblyObject type tag: 0d

Assembly objects are created when a user creates an assembly, a snapshot of the virtualdocument at particular point in time. Users must have at least Version permission for theobject identified in the book_id property to modify an assembly object.


Table 16. Properties dened for the assembly type


Description

a_contain_desc string(255) S Used by Documentumclients to manage XMLdocuments in assemblies.For more information,refer to Content ServerFundamentals.

a_contain_type string(32) S Used by Documentumclients to manage XMLdocuments in assemblies.For more information,refer to Content ServerFundamentals.


Assembly


Description

book_id ID S Object ID of the topmostcontaining document inthe virtual documentstructure that contains thecomponent described bythis assembly object.

component_chron_id

ID S Chronicle ID of thecomponent representedby the assembly object.

component_id ID S Object ID of the componentof the virtual document

depth_no integer S Depth of the componentwithin the levels of thevirtual document identifiedby book_id.


order_no integer S The ordering of thecomponent within thevirtual document identifiedby the book_id.

parent_id ID S Object ID of the documentthat directly contains thevirtual document describedby this assembly object.

path_name Oracle:string(740)

SQLServer:string(765)

Sybasestring(600)

DB2:string(740)

S The path from thetop-most containingdocument (identified inthe book_id property)to the component. Pathnames are comprised of theobject names of the nodesdelimited by forwardslashes. If the path islonger than the property,the path is truncated fromthe end of the path.


Audit Trail

Audit Trail

Purpose An audit trail object stores information about one audited event.

DescriptionSupertype: Persistent ObjectSubtypes: Audittrail Acl, Audittrail GroupInternal Name: dm_audittrailObject type tag: 5f

Audit trail objects are created automatically by the server after a user initiates auditingfor a particular event. Automatic auditing is provided for system events, such as acheckin or checkout, workflow events, and lifecycle events.

Users and applications can also create audit trail objects to record the occurrence ofuser-defined events.

Audit trail objects have ten properties whose use is dependent on the event. Theseproperties are the id_n and string_n properties. The Content Server Administration Guideprovides a complete list of auditable events and describes the use of the id_n andstring_n properties for server-generated audit trail objects.


Table 17. Properties dened for the audit trail type


Description

acl_domain string(32) S Owner of the ACLassociated with the objectbeing audited. This is nullfor objects that are notSysObjects or SysObjectsubtypes.


Audit Trail


Description

acl_name string(32) S Name of the ACLassociated with the objectbeing audited. This is nullfor objects that are notSysObjects or SysObjectsubtypes.

application_code string(64) S The application code orcodes defined for thesession in which the eventoccurred. Multiple codesare separated by commas.

Note: The list of codes istruncated if necessary.

attribute_list For allexcept DB2:string(2000)

For DB2:string(1300)

S Comma-separated list ofaudited properties andtheir values at the time ofthe event.

If the list is longer thanthe length of the property,the overflow is stored inthe dmi_audittrail_attrsobject identified in theattribute_list_id property.

attribute_list_id ID S Object ID of thedmi_audittrail_attrsobject that contains theoverflow values from theattribute_list property.

attribute_list_old string(1000),if the RDBMS(Sybase or DB2)page size is 8Kor greater

string(1) ifRDBMS (Sybaseor DB2) pagesize is 4K

S Comma separated list ofaudited properties andtheir old values if thevalues changed.

If the list is longer thanthe length of the property,the overflow is stored inthe dmi_audittrail_attrsobject identified in theattribute_list_id property.


Audit Trail


Description

audit_signature string(255) S Signed hash of the audittrail entry.

audit_version integer S Indicates how thesignature was createdif the entry is signed.The only valid value is1, to indicate that 5.2Content Server created thevalue in audit_signature.Otherwise, this is not set.

audited_obj_id ID S Object ID of the objectbeing audited

For a checkin event, thisis the object ID of the newversion of the object.

For workflow events, thisis always the object ID ofthe process object.

For dm_move_contentevents, this is always theobject ID of the contentobject.

audited_obj_vstamp

integer S The i_vstamp value of theobject identified in theaudited_obj_id property.

chronicle_id ID S Chronicle ID of the objectbeing audited if the objectis a SysObject or SysObjectsubtype. Otherwise, this isthe object ID of the objectbeing audited.

controlling_app string(32) S The object’s controllingapplication. Thisis the value in thea_controlling_appproperty of the objectbeing audited.


Audit Trail


Description

current_state string(32) S Name of the currentlifecycle state of the objectbeing audited.

event_description string(64) S Name of the event beingaudited in a user-friendlyform.

event_name string(64) S Actual name of the eventbeing audited.

event_source string(64) S Source of the event. Somepossible values are:

lifecycleelectronic signaturesystemunspecificworkflow

host_name string(128) S Name of the host on whichthe Content Server thatgenerated the audit trailentry resides

i_audited_obj_class integer S Identifies what type ofobject is identified inaudited_obj_id. Valuesare:

-1, meaning the eventhas no audited object (forexample, dm_audit ordm_unaudit events)

0, dm_sysobject andsubtypes

1, for dm_acl

2, for dm_user andsubtypes

3, for dm_group

4, for dmr_content


Audit Trail


Description

i_is_archived Boolean S T means that the audit trailentry has been archived.

This is set to F, meaningthat the entry has notbeen archived, when theaudit trail entry is createdand reset to T when theMARK_AS_ARCHIVEDadministration method isexecuted against the entry.

id_1 ID S event-dependent object ID





object_name string(255) S Name of the object beingaudited. For SysObjectsand ACLs, this is theobject_name propertyvalue. For groups, this isthe group_name value.

object_type string(32) S Object type of the objectbeing audited.

owner_name string(32) S Name of the owner of theobject being audited. Thevaluemay be an individualuser or a group name.

policy_id ID S Object ID of the lifecycleassociated with the objectbeing audited.

r_gen_source integer S The source of the audittrail. Values are:

1, for a system-generated audit trail0, for a user-generatedaudit trail


Audit Trail


Description

registry_id ID S Object ID of the registryobject that stores theregistration for the eventthat generated this audittrail entry.

session_id ID S ID of the session in whichthe event occurred.

string_1 string(200) S event-dependent string





time_stamp date S The local time at which theaudit trail was generated

time_stamp_utc date S The UTC (or GMT) time atwhich the event occurred

user_id ID S Object ID of the dm_userobject representing theuser whose task causedthe event to occur.

user_name string(32) S Name of the user whosetask caused the event tooccur.

version_label string(16) S The implicit (numeric)version label of the objectbeing audited. This is nullfor objects that are notSysObjects or SysObjectsubtypes.

workflow_id ID S Object ID of thedm_workflow forworkflow events.


Audit Trail ACL

Audit Trail ACL

Purpose An audit trail acl object records information about one audited event for an ACL.

DescriptionSupertype: Audit TrailSubtypes: NoneInternal Name: dm_audittrail_aclObject type tag: 5f

Audit trail acl objects are created when a dm_save, dm_saveasnew, or dm_destroyregistered event occurs on an ACL. (The audited ACL is identified by the inheritedaudited_obj_id property.)


Table 18. Properties dened for the audit trail acl type


Description

accessor_name string(32) R The ACL user orgroup entry on whichthe operation atthe correspondingindex position inaccessor_operation wasperformed.

accessor _operation string(1) R The operation performedon the user or groupentry identified in thecorresponding positionin accessor_name. Validvalues are:

U, for updateI, for insertD, for delete


Audit Trail ACL


Description

accessor_permit integer R Value in the ACL’sr_accessor_permit propertyfor the ACL entry identifiedin the dm_audittrail_acl.accessor_name property atthe corresponding indexposition.

accessor _xpermit integer R Value in the ACL’sr_accessor_xpermitproperty for the ACLentry identified in thedm_audittrail_acl.accessor_name property at thecorresponding indexposition.

acl_class integer S Value in the audited ACL’sacl_class property.

application_permit string(128) R Value in the ACL’sapplication_permitproperty for the ACLentry identified in thedm_audittrail_acl.accessor_name property at thecorresponding indexposition.

description string(128) S Value in the audited ACL’sdescription property.

globally _managed Boolean S Value in the auditedACL’s globally_managedproperty.

is_group Boolean R Value in the ACL’sr_is_group property forthe ACL entry identifiedin the dm_audittrail_acl.accessor_name property atthe corresponding indexposition.


Audit Trail ACL


Description

is_internal Boolean S Value in the ACL’sr_is_internal property.

permit_type integer R Value in the ACL’sr_permit_type propertyfor the ACL entry identifiedin the dm_audittrail_acl.accessor_name property atthe corresponding indexposition.


Audit Trail Attrs

Audit Trail Attrs

Purpose An audit trail attrs object stores the overflow property name and value pairs fromthe attribute_list property of an audit trail object.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dmi_audittrail_attrsObject type tag: 00

Audit trail attr objects are created automatically, when needed, by Content Server. Theyrecord overflow property names and their values if the list of properties to be recorded istoo long to fit into the attribute_list property of the associated audit trail object.


Table 19. Properties dened for the audit trail attrs type


Description

attribute_list string(2000) R Comma-separated list ofaudited properties and theirvalues at the time of theevent.

attribute_list_old string(1000)if RDBMS(Sybase or DB2)page size is 8Kor greater

string(1)if RDBMS(Sybase or DB2)page size is 4K

R Comma separated list ofaudited properties and theirold values if the valueschanged.

audit_obj_id ID S Object ID of the associatedaudit trail object.


Audit Trail Group

Audit Trail Group

Purpose An audit trail group object records information about an audited event for a group.

DescriptionSupertype: Audit TrailSubtypes: NoneInternal Name: dm_audittrail_groupObject type tag: 5f

Audit trail group objects are created when a dm_save, saveasnew, or dm_destroyregistered event occurs on a group. (The audited group is identified in the inheritedaudited_obj_id property.)

PropertiesTable 20, page 89, lists the properties defined for the object type.

Table 20. Properties dened for the audit trail group type


Description

alias_set_id ID S Value in the audited group’salias_set_id property.

description string(128) S Value in the audited group’sdescription property.

globally _managed Boolean S Value in the auditedgroup’s globally_managedproperty.

group_admin string(32) S User or group allowed tomodify the audited group.

group_address string(80) S Value in the audited group’sgroup_address property.

group_class string(32) S Value in the audited group’sgroup_class property.


Audit Trail Group


Description

group_source string(16) S Identifies the source ofthe audited group. Theonly valid value is LDAP,meaning the group wascreated by importing anLDAP group.

groups_names string(32) R Names of groups thatare users in the auditedgroup on which anoperation occured. Theoperation is recorded in thegroups_names_operationproperty in thecorresponding indexposition.

groups_names_operation

string(1) R The operation that occurredon the group identified inthe groups_name propertyat the corresponding indexposition. Valid values are:


is_dynamic Boolean S T (TRUE)means the auditedgroup is a dynamic group.F (FALSE) means the groupis not a dynamic group.

is_dynamic_default Boolean S Controls whether usersin the audited group’slist of potential users areconsidered members of thegroup by default when theyconnect to the respository.

T (TRUE) means that usersare treated as membersof the group. F (FALSE)means that users are nottreated as group memberswhen they connect.


Audit Trail Group


Description

is_private Boolean S Value in the group’sis_private property .

users_names string(32) R Names of individualusers in the auditedgroup on which anoperation occured. Theoperation is recorded in thegroups_names_operationproperty in thecorresponding indexposition.

users_names_operation

string(1) R The operation that occurredon the user identified inthe users_name propertyat the corresponding indexposition. Valid values are:



Auth Cong

Auth Cong

Purpose An auth config object contains the names of the primary and backup domaincontrollers for a particular domain.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dm_auth_configObject type tag: 00

The values in an auth config object are used when you authenticate users in repositoryon a UNIX platform against a Windows domain. A repository can have only one authconfig object. It is created and its values set through Documentum Administrator, whenunix_domain_used is defined in the auth_protocol property of the docbase config object.


Table 21. Properties dened for the auth cong type


Description

domain_name string (32) R The name of a Windowsdomain

primary _controller string(32) R The name of the machinethat is the primarydomain controller forthe domain named atthe corresponding indexposition in domain_name.

backup _controller string(32) R The name of the machinethat is the backupdomain controller forthe domain named atthe corresponding indexposition in domain_name.


Blob Store

Blob Store

Purpose A blob store object represents a blob storage area.

DescriptionSupertype: StoreSubtypes: NoneInternal name: dm_blobstoreObject type tag: 40

Blob store objects represent blob store storage areas. Content stored in blob stores instored in tables in the repository. You can store a maximum of 64 Kbytes of data in ablob store storage area.


Table 22. Properties dened for the blob store type


Description

ascii Boolean S Indicates whether thecontents are ASCII stringsor arbitrary sequences of8-bit characters.

selectable Boolean S Not currently used.


BOCS cong

BOCS cong

Purpose Defines the configuration of a BOCS server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_bocs_configObject type tag: 08

A bocs config object defines the configuration of a BOCS (Branch Office CachingServices) server. All bocs config objects reside in the global registry, in the/System/NetworkLocation folder. The objects are created and managed usingDocumentum Administrator.


Table 23. Properties dened for the bocs cong type


Description

base_url string(240) R Base URL to use whenaccessing the BOCS serverusing the protocol identifiedat the correspondingindex position insupported_protocol.


BOCS cong


Description

delivery_type string(4) S Whether the DMS servercan send messages to theBOCS server or must waitfor the BOCS server to pullmessages from the DMSserver. Valid values are:

push, DMS can sendmessages

pull, DMS must wait forBOCS to pull messages

The default value is push.

docbase_names string(255) R List of repository names.

The list is either an inclusionlist or exclusion listdepending on the valueof is_inclusion_list.

is_inclusion_list Boolean S T (TRUE) means thatthe list of repositories indocbase_names is a list ofrepositories that the BOCSserver may service.

F (FALSE) means thatthe list of repositoriesin docbase_names is anexclusion list; that is, alist of repositories thatthis BOCS server may notservice.

network_locations string(80) R The network identifiersof the network locationsserved by the BOCS server.

The order of the identifiersin this property defines therelative closeness of thelocation to the BOCS server.


BOCS cong


Description

rw_capability integer S Indicates whether theBOCS server is enabled ordisabled and whether it iscapable of asynchronouswrite. Valid values are:

0, meaning disabled

1, meaning enabled but noasynchronous write

9, meaning enabledwith asynchronous writecapabilities


string(16) S Indicates the major versionof the BOCS server. For aBOCS 6.0 server, this mustbe set to 2.

server_minor_version

string(16) S Indicates the minor versionlevel of the BOCS server.For a BOCS 6.0 server, thismust be set to 0.

supported_protocol string(6) R Set of network protocolssupported by the BOCSserver

Values in this propertymustall lowercase. For example:http or https.


Builtin Expr

Builtin Expr

Purpose A builtin expr object stores information needed to execute built-in server functions.

DescriptionSupertype: ExpressionSubtypes: NoneInternal name: dm_builtin_exprObject type tag: 54

Builtin expr objects store information needed to execute built-in server functions.Content Server creates and manages builtin expr objects. Users cannot create them.


Table 24. Property dened for the builtin expr type


Description

builtin_tag integer S Specifies which serverfunction to invoke. Validvalues are:

1, for NULL2, for NOW3, for TODAY4, for TOMORROW5, for YESTERDAY6, for USER

None of the functionsrequire passed arguments.


CA Store

CA Store

Purpose A ca store object represents a content addressable storage system known to ContentServer.

DescriptionSupertype: StoreSubtypes: NoneInternal name: dm_ca_storeObject type tag: 6d

A ca store object represents a content-addressable storage system. A content addressablestorage system uses a content address instead of a directory path to locate content storedin the system.


Table 25. Properties dened for the CA store type


Description

a_content_attr_description

string(128) R User-defined description of theproperty named at the correspondingposition in a_content_attr_name

a_content_attr_name

string(64) R Names of the content metadata fieldswhose values will be set using aSetcontentattrs method.

The names may not contain spaces.

This property can have a maximumof 62 values. Do not includethe metadata field identified ina_retention_attr_name, if any.


CA Store


Description

a_default_retention_date

Date S The default retention value forcontent stored in this storage system.

The value is ignored ifa_retention_attr_required is setto T (TRUE), a_retention_attr_nameis set, or if default_retention_days isset.

Note: default_retention_days is aproperty inherited from dm_store.

a_plugin_id ID S Object ID of the plugin object whosecontent is the plugin library thatimplements this ca storage system.

a_retention_attr_name

string(64) S Identifies the content metadata fieldthat stores the retention value for thecontent.

The metadata field name may notcontain spaces. Do not use ametadatafield defined in a_content_attr_name.

The value of this property may notbe changed after the storage area iscreated.

a_retention_attr_required

Boolean S T (TRUE) means that the contentstored in this system must have aretention period. If set to T, you mustset a_retention_attr_name also.


a_storage_params

string(1024) R List of parameters specific to thecontent addressable storage system.

The first index position ([0])isreserved for the IP address oraddresses for the Centera hostmachine or machines. The value mayinclude the path to a Centera profile.

The second index position ([1])is reserved for embedded blobconfiguration. If set, the value is inthe format:

pool_option:embedded_blob:size_in_KB


CA Store


Description

This instructs the Centera systemto store all content files less thanor equal to the specified size asembedded blobs. (Refer to theContent Server Administration Guidefor a complete description of thisfeature.)


Cabinet

Cabinet

Purpose The cabinet object represents the highest level of organization visible to end usersin a repository.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dm_cabinetObject type tag: 0c

The cabinet object represents the highest level of organization visible to end users in arepository. All folders, documents, and other objects (except cabinets) that are subtypesof the SysObject type are stored in cabinets. A cabinet is basically a folder that cannotbe placed inside another folder or a cabinet. Users must have Superuser, Sysadmin, orCreate Cabinet user privilege to create or destroy a cabinet. However, users can change acabinet’s properties if they have Write permission for the cabinet.

PropertiesTable 26, page 101, lists the only property defined for the type.

Table 26. Properties dened for the cabinet type


Description

is_private Boolean S Indicates whether thecabinet is private or public.If set to TRUE, the cabinetis private. If set to FALSE,the cabinet is public. Thedefault is FALSE. Thisproperty is not used byContent Server for securityor any other use. It isintended for use by clientapplications.


Cache Cong

Cache Cong

Purpose A cache config object identifies a group of queries, objects, or both to be cached onthe client and refreshed at defined intervals.

DescriptionSupertype: SysObjectSubtypes: NoneInternal Name: dm_cache_configObject type tag: 08

A cache config object identifies a group of queries, objects, or both to be cached on theclient and refreshed at defined intervals.


Table 27. Properties dened for the cache cong type


Description

cache_element_query

string(1500) R The queries that return the queryresults, objects or both to be cached.The value can be any valid query.Each index position can contain onequery.

cache_element_type

string(32) R Indicates whether the value atthe corresponding position incache_element_query identifies aquery or object to be cached. Validvalues are:

queryobject


Cache Cong


Description

client_check_interval

integer S Defines how often the client calls theserver to obtain updated informationabout the cache config object.

The default value is 0, meaningthat the client requests updatedinformation every time an API callspecifies the cache config object.

The value is interpreted in seconds.

i_query_result_hash

string(100) S Last computed hash of the queryresults. This value is used to compareexecutions of the cached queries.

r_last_changed_date

Date S Time at which the server last validatedthe queries and found a change.

r_last_checked_date

Date S Time at which the server last validatedthe queries.

server_check_interval

integer S Interval, in seconds, at which theserver revalidates the queries in thecache configuration.

The default value is 0, meaning thatthe server reruns all the queriesevery time an API call specifiesthe cache config object and theclient_check_interval has expired.


Category

Category

Purpose Represents a taxonomy in a repository.

DescriptionSupertype: FolderSubtypes: TaxonomyInternal Name: dm_categoryObject type tag: 0b

A category object is a folder in the folder structure that represents a taxonomy in arepository. Every category object must be linked to at least one taxonomy object orother category object. (For more information about categories and taxonomies, refer theContent Intelligence Services documentation.)

PropertiesTable 28, page 104, lists the properties defined for the category type and the inheritedproperties whose use is specific to the category object type.

Table 28. Properties dened for the category type


Description

a_status string(16) S Describes the development anddeployment status of the category. Validvalues are:

offlineonline

allowed_operations

string(32) R List of allowed operations for the category.Valid values are:

user_browseuser_subscribeuser_subscribe_mandatory


Category


Description

candidate_threshold

integer S Relevence level at which a document isautomatically routed for approval to thecategory owner. Values are interpreted asa percentage, from 1 to 100.

category_evidence

string(255) R Identifies other categories whose evidencewill be considered as evidence for thiscategory.

Values for this property are set using theContent Intelligence Client.

category_owner string(32) R The owner of the category.

Note: Only one owner is currentlysupported.

child_count integer S Number of categories linked directly tothis category.

class_id ID S Object ID of the category class to whichthis category belongs.

Defaults to the value of the class_idproperty in the taxonomy.

description string(255) S User-defined description of the category.

definition_type string(32) S Identifies the type of the definition.The definition is comprised of thevalues in the category_evidence,keyword_evidence, candidate_threshold,and on_target_threshold properties. Thesevalues determine which documents can beautomatically assigned to the category.

Valid values are:none, which indicates that the categoryhas no definition or the definition is to beignored, meaning documents cannot beautomatically a ssigned to the categorysimple, which indicates that the categoryhas a simple definition


Category


Description

keyword_evidence

string(255) R List of keywords in document textconsidered to be evidence for the category.

The values in this property are set usingContent Intelligence Client.

object_name string(255) S The name of the category. The name mustbe unique among all categories within thecategory class.

on_target_threshold

integer S The relevance level at which a documentis automatically assigned to the category.The value is interpreted as a percentage,from 1 to 100.

qualifiers string(255) R List of initial conditions that a documentmust meet to qualify for testing againstthe evidence for the category.

The values in this property are set usingContent Intelligence Client.

supported_language

string(32) R List of language codes for all supportedlanguages. The entry at each positionmust have a category name in the specifiedlanguage at the matching index positionin translated_name.

translated_name

string(255) R List of the category name in all supportedlanguages. The name at each indexposition must be in the language specifiedby the language code in the matchingindex position in supported_language.


Category Assign

Category Assign

Purpose Records the assignment of an object to a particular category.

DescriptionSupertype: RelationSubtypes: NoneInternal Name: dm_category_assignObject type tag: 37

A category assign object records the assignment of an object to a particular category.Category assign objects are created automatically when an object is assigned or proposedfor assignment to a category folder.

Note: The data dictionary label for this type is Category Assignment.

PropertiesTable 29, page 107, lists the properties defined for the type and any inherited propertiesthat have a use specific to the object type.

Table 29. Properties dened for the category assign type


Description

active_assignment Boolean S Whether the object representedby this category assign objectis visible to users. T (TRUE)means the object is available toend users. The value is T whenassign_type value is active andthe assign_status value beginswith “assigned”.

F (FALSE) means the object is notavailable.


Category Assign


Description

assign_status string(32) S Describes the assignmentoperation. Valid values are:

assigned_autoassigned_manualassigned_approvedassigned_pending_removeassigned_finalpending_assignremoved_autoremoved_manualremoved_ approvedremoved_final

assign_type string(32) S Identifies whether the assignmenttook place during a test orproduction run. Valid values are:

textactive

child_id ID S The i_chronicle_id value of theassigned object.

document_id ID S Object ID of the assigned object.

modifier string(32) S Name of the user or process thatlast modified the assignment.For all automatic assignmentoperations, this value is CIS.

parent_id ID S Object ID of the category to whichthe object is assigned.

permanent_link Boolean S Whether to maintain theassignment across versionsof the assigned object. The defaultis F (FALSE).


Category Assign


Description

prev_assign_status string(32) S Describes the assigned object’sprevious assignment, if any. Validvalues are:

assigned_autoassigned_manualassigned_approvedassigned_pending_removeassigned_finalpending_assignremoved_autoremoved_manualremoved_ approvedremoved_final

prev_modifier string(32) S Name of the user or process thatperformed the object’s previousassignment. For all automaticassignments, this value is CIS.

relation_name string(32) S Name of the relationship betweenthe assigned object and thecategory. The only legal value isdm_category_assign.

relevance integer S The relevance number of theassigned object. Values rangefrom 1 to 100, with 100 meaningfully relevant.

run_id ID S The object ID of thedm_docset_run object thatidentifies the run that classifiedand assigned the object.

This property can be a NULLvalue.


Category Class

Category Class

Purpose Stores the definition of a class of categories and the default property values andbehaviors for the included categories.

DescriptionSupertype: SysObjectSubtypes: NoneInternal Name: dm_category_classObject type tag: 08

A category class object stores the definition of a class of categories and the defaultproperty values and behaviors for the included categories. Category class objects arecreated using Content Intelligence Client.

PropertiesTable 30, page 110, lists the properties defined for the type and those inherited propertiesthat have a use specific to the object type.

Table 30. Properties dened for the category class type


Description

cat_evidence_conf string(32) S Default confidence level for allexplicit (not propagated) categoryevidence for categories in thisclass. Valid values are:certainhighmediumlowauxilliarynegativeoffnumeric

numeric is any value from 0 to 100.


Category Class


Description

description string(255) S User-defined desrcription of thecategory class.

evidence_prop_conf

string(32) S Default confidence levelfor all propagated categoryevidence for categories inthis class. Valid values are:certainhighmediumlowauxilliarynegativenumeric

numeric is any value from 0 to 100.

evidence_prop_type

string(32) S Default value for all automatic(propagated) category evidencegeneration for categories in theclass. Valid values are:

off, which turns offevidence propagation@child, which propagatesevidence from any childto the parent category@parent, which propagatesany evidence for the parentcategory to immediate children

implied_keyword_conf

string(32) S Default keyword confidence levelfor all categories in this class.Valid values are:

certainhighmediumlowauxilliarynegativeoffnumeric

numeric is any number from 0 to100.


Category Class


Description

implied_keyword_style

string(64) S Default implied keyword stylefor categories in this class. Validvalues are combinations of thefollowing:

activestemphrase_order_exact

keyword_conf string(32) S Default keyword confidence levelfor all categories in the class.Valid values are:

certainhighmediumlowauxiliarynegativeoffnumeric

numeric is an integer from 0 to100.

keyword_style string(64) S Default keyword style forcategories in this class. Validvalues are combinations of:

activestemphrase_order_exact

object_name string(255) S Category class name. The namemust be unique among thecategories that belong to the class.


Category Class


Description

source string(32) S User-defined text identifyingthe source of the taxonomy andcategory objects in this class. Forexample: DCTM or Semio.

target_attribute string(32) S Name of the property in arepository object type to be usedfor storing all document categoryassignments. The property mustbe a repeating property.


Change Record

Change Record

Purpose Stores information used internally to ensure consistency of cached information.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dmi_change_recordObject type tag: 33

A change record object stores information used internally to ensure consistency ofcached information. There is one change record object for each repository.


Table 31. Properties dened for the change record type


Description

cache_change_count

integer S Number of changesaffecting the server’s globalcache.

dd_change _count integer S Number of times thedata dictionary has beenchanged.

group_change_count

integer S Number of times any groupobject has been changed.

reinit_change_count

integer S Number of times the mainserver thread (parent server)has been reinitialized.

sys_change _count integer S Number of changes madeto object types and formatobjects.


Change Record


Description

storage_change_count

integer S Number of times that astorage area has changedstate.

type_change _count integer S Number of times that a typein the global cache has beenchanged.

user_change_count integer S Number of times any userobject has been changed.


CI Cong

CI Cong

Purpose Stores Content Intelligence Services configuration options.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_ci_configObject type tag: 08

A CI config object stores Content Intelligence Services configuration options. CI configobjects are created when a repository is enabled for Content Intelligence Services.Enabling occurs when Content Intelligence Client is installed or the DAR file for WebPublisher is installed.


Table 32. Properties dened for the CI cong type


Description

assign_as_attribute Boolean S Whether reflecting the categoryassignments as documentproperties is enabled in therepository.

assign_as_link Boolean S Whether assigning objectsto folders is enabled in therepository.

auto_proc_enabled Boolean S Whether automatic assignment isenabled in the repository.

auto_user string(32) S User account that is usedto generate and process theautomatic document processingqueue.


CI Cong


Description

auto_workflow Boolean S Whether automated objectassignment initiates aconfirmation workflow.

cat_owner_suggest Boolean S Not currently used.

category_object_type

string(32) S Name of the object type used tomanage categories. This is set todm_category by default.

ci_client_enabled Boolean S Whether the Content IntelligenceClient is enabled on therepository.

ci_enabled Boolean S Whether Content Intelligencefunctionality is enabled on therepository.

ci_server_host_dev string(32) S Host on which the ContentIntelligence Services developmentserver resides.

ci_server_host_prod

string(32) S Host on which the ContentIntelligence Services productionserver resides.

impersonate_assign Boolean S T (TRUE) allows both automaticand manual documentassignments to be performedusing the designated superuseraccount.

Note: The superuser accountis identified using ContentIntelligence Client.

manual_proc_enabled

Boolean S Whether manual processing isenabled on the repository.

manual_user string(32) S User account that is used togenerate and process the manualdocument processing queue.

manual_workflow Boolean S Whether manual objectassignment requires aconfirmation workflow.


CI Cong


Description

root_admin_path string(255) S Folder path of the root folderfrom which all administrationinformation managed.

root_category_path string(255) S Folder path of the root folderfrom which all categories andtaxonomies are managed.

sync_mode string(32) S Identifies how datasynchronization with the ContentIntelligence server occurs. Theonly valid vaue is auto.

taxonomy_object_type

string(32) S Name of the object type usedto manage taxonomies inthe repository. This is set todm_taxonomy by default.


Class

Class

Purpose Represents a model for a Smart Container.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_classObject type tag: 08

A class object represents a model for a Smart Container. The content of the object isthe XML representation of the Smart Container model. Every object of this type hasan associated dm_logical_version aspect. This object type is installed with the SmartContainer DAR file during repository configuration.


Table 33. Properties dened for the class type


Description

class_category string(255) S Category of the model

class_description string(1024) S Description of the model

metamodel_id ID S Object ID of thedmc_metamodel objectfrom which the modelrepresented by this classobject was derived.

Table 34, page 120, lists the properties added by a system-defined default aspect forthe type.


Class

Table 34. Default aspect properties dened for the class type


Description

logical_version string(32) S Supports logical versioningof persistent objects

From the aspect nameddm_logical_aspect


Client Registration

Client Registration

Purpose Records registration information about client applications.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_client_registrationObject type tag: 08

A client registration object records the identity of a particular privileged DFC instance.Client registration objects are stored in the global registry, in the /System/ClientRegistration folder. They are protected by the dm_acl_registration ACL. This ACLgrants Browse permission to dm_world and Delete permission to dm_owner and theadmingroup group.


Table 35. Properties dened for the client registration type


Description

client_id string(40) S Unique identifier for theclient instance

host_name string(128) S Name of host on which theclient is installed

is_validated Boolean S Identifies whether theentry has been checked forauthenticity. T means thatthe entry has been checked.F means that the entry hasnot been checked.

public_key_identifier

string(40) S Points to the public keycertificate object that holdsthe public key for this client.


Client Rights

Client Rights

Purpose Records the roles that a particular instance of a privileged client is allowed to use.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_client_rightsObject type tag: 08

A client rights object records the roles that a particular instance of a client application isallowed to use within a repository. There must be a client rights object in each repositoryin which a privileged DFC instance will invoke the roles. Client rights objects are createdusing Documentum Administrator. You must have Superuser privileges to create aclient rights object. The objects are stored in the /System/Client Rights folder, and areassigned the dm_acl_superusers ACL.


Table 36. Properties dened for the client rights type


Description

allow_all_roles Boolean S T means the client may useany role.

Setting this to T is theequivalent of listing all rolesin allowed_roles.

allow_all_priv_modules

Boolean S T means the client mayuse any role invoked by aninstalled module.

allowed_roles string(32) R List of the roles that theclient is allowed to use

client_id string(40) S Unique identifier for theclient instance


Client Rights


Description

host_name string(128) S Name of host on which theclient is installed

principal_auth_priv

Boolean S T means that the client isallowed to create sessionsfor users without usercredentials.

This enables Principal Modesupport for a DFC instance.

public_key_identifier

string(40) S Points to the public keycertificate object that holdsthe public key for this client.


Completed Workow

Completed Workow

Purpose Records information about completed workflows

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_completed_workflowObject type tag: 00

A completed workflow object stores information from audit trail records about acompleted workflow. The objects are created by the dm_WfReporting job and used byWebtop’s aggregrate workflow reporting tool. To fully populate the properties in theseobjects, you must be auditing all workflow events.

The object type is created by a script when Content Server is installed.

PropertiesTable 37, page 124, lists the properties in the type.

Table 37. Properties dened for the completed workow type


Description

active_duration double S Length of time the workflowwas in the active state.

This value is computedfrom the audit trail entriesfor the dm_startworkflow,dm_changestateworkflow,dm_finishworkflow, anddm_abortworkflow events.


Completed Workow


Description

complete_date_utc Date S The date and time on whichthe workflow is finished oraborted.

This value is taken fromthe audit trail entries forthe dm_finishworkflow ordm_abortworkflow events.

complete_type integer S Whether the workflow wasfinished or aborted. Validvalues are:

0, meaning the workflowwas finished

1, meaning the workflowwas aborted

The value is taken fromthe audit trail entries forthe dm_finishworkflow ordm_abortworkflow events.

component_id ID S Object ID of the firstcomponent in the firstpackage.

The value is taken fromaudit trail entries for thedm_addpackage event.

component_name string(80) S Name of the first componentin the first package.

The value is taken fromaudit trail entries for thedm_addpackage event.

creator_name string(32) S Name of the workflow’screator.

The value is taken from theaudit trail entries for thedm_createworkflow event.


Completed Workow


Description

paused_duration double S Length of time the workflowwas in the paused state.

The value is computedby subtracting the valueof active_duration fromtotal_duration.

process_id ID S Object ID of the templateused to create the workflow.

The value is taken from theaudit trail entries for thedm_createworkflow event.

process_name string(255) S Name of the workflowtemplate used to generatethe workflow instance.

start_date_utc Date S Date and time of theworkflow’s start.

The value is taken from theaudit trail entries for thedm_startworkflow event.

supervisor_name string(32) S Name of the workflow’ssupervisor

The value is taken fromthe audit trail entries forthe dm_startworkflow anddm_changeworkflowsuper-visor events.

total_duration double S Total length of the time theworkflow existed.

The value is computed bysubtracting start_date_utcfrom complete_date_utc.


Completed Workow


Description

total_user_cost double S Sum of the user_cost valuesfor the completed workitems in the workflow.

The value is computedfrom the dmc_completed_workitem objects.

total_user_time integer S Sum of the user_time valuesfor the completed workitems in the workflow.

The value is computedfrom the dmc_completed_workitem objects.

workflow_id ID S Object ID of the completedworkflow.

The value is taken fromdm_createworkflow events.

workflow_name string(64) S Name of the workflow.

The value is taken from theaudit trail entries for thedm_createworfklow event.


Completed Workitem

Completed Workitem

Purpose Records information about completed work items in workflows.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_completed_workitemObject type tag: 00

A completed workitem object stores information from audit trail records about acompleted work item. The objects are created by the dm_WfReporting job and used byWebtop’s aggregrate workflow reporting tool. To fully populate the properties in theseobjects, you must be auditing all workflow events.

The object type is created by a script when Content Server is installed.

PropertiesTable 38, page 128, lists the properties of the type.

Table 38. Properties dened for the completed workitem type


Description

act_name string(128) S Name of the activity thatgenerated the work item

The value is taken fromthe audit trail entries fordmd_startedworkitemevents


Completed Workitem


Description

act_seqno integer S Sequence number of theactivity that generated thework item

The value is taken fromthe audit trail entries fordmd_startedworkitemevents

active_duration double S Length of time that thework item was in the activestate

The value is computed fromthe audit trail entries forthe dm_selectedworkitem,dm_completedworkitem,and dm_changestateactiv-ity events.

complete_action integer S Identifies the actionchosen by the user whencompleting the work item.Valid values are:

-1, meaning unknown

0, meaning forward

1, meaning reject

The value is derived fromthe audit trail entries for thedm_setoutput event..

complete_date_utc Date S Date and time at which thework item was completed

The value is taken fromthe audit trail entries fordm_completedworkitemevents.


Completed Workitem


Description

complete_state integer S State of the work item whenthe workflow was finishedor aborted. Valid values are:

0, meaning dormant

1, meaning acquired

2, meaning finished

creation_date_utc Date S Date and time when thework item was created

The value is taken fromthe audit trail entriesfor dm_startedworkitemevents.

dormant_duration double S Length of time, in seconds,that the work item was inthe dormant state.

The value is derived fromthe audit trail entries fordm_startedworkitem anddm_selectedworkitemevents.

paused_duration integer S Length of time, in seconds,that the work item was inthe paused state

The value is derivedfrom the valuesfor total_duration,dormant_duration, andactive_duration.

performer_name string(32) S Name of the task performer

The value is taken from theaudit trail entries for thedm_startedworkitem event.


Completed Workitem


Description

process_id ID S Object ID of the workflowtemplate used to create theworkflow that generatedthis work item.

The value is taken fromaudit trail entries for thedm_startedworkitem event.

process_name string(255) S Name of the workflowtemplate used to generatethe workflow instance thatcontained this work item.

The value is taken fromaudit trail entries for thedm_startedworkitem event.

task_priority integer S The final priority of thework item.

The value is taken fromthe audit trail entries forthe dm_startedworkitemand dm_changepriority-workitem events.

total_duration integer S Total length of time, inseconds, that the work itemexisted

This is computed usingstart_date_utc andcomplete_date_utc values.

user_cost double S The user cost argumentvalue specified in theComplete method.

The value is taken fromaudit trail entries for thedm_completedworkitemevent.


Completed Workitem


Description

user_time integer S Amount of time the userspent on the work item(specified as an argumentto the Complete method)

The value is taken fromaudit trail entries for thedm_completedworkitemevent.

workflow_id ID S Object ID of the workflowthat generated the workitem

The value is taken fromaudit trail entries forthe dm_startedworkitemevents.

workitem_id ID S Object ID of the work item

The value is taken fromaudit trail entries forthe dm_startedworkitemevents.

wq_doc_profile string(64) S Value of the a_wq_doc_profile property of the workitem.

The value is taken fromaudit trail entries for thedm_completedworkitemevents.


Completed Workitem


Description

wq_flag integer S Value of the a_wq_flagproperty of the work item


wq_name string(32) S Value of the a_wq_nameproperty of the work item



Component

Component

Purpose Represents a component, a set of related functionality that is used by clientapplications.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_componentObject type tag: 08

A component object represents a component, a set of related functionality that is used byclient applications.


Table 39. Properties dened for the component type


Description

build_technology integer S The build technology usedto create the component.Valid values are:

1, for ACX16, for WIN 32 Exes32, for Data module

com_class_id string(38) S The component’s COMclass ID. This is required fordesktop applications. It isnot required for Web-basedapplications.

component_version

string(16) S The component’s version.

uniq_cont_ticket string(128) S Used internally.


Composite Predicate

Composite Predicate

Purpose Represents one route case condition for a workflow activity.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_composite_predicateObject type tag: 00

A composite predicate object records a route case condition for an activity that has atransition type of automatic. Composite predicate objects are created internally whenthe addConditionRouteCase method is used to add route case definitions to an activity.You cannot create these objects directly.


Table 40. Properties dened for the composite predicate type


Description

predicate_id ID R Object IDs of transitioncondition objectsrepresenting the individualcomparison expressions thatmake up the route case.

r_aspect_name string(64) R Names of the TBOassociated with thepredicate.


Cond Expr

Cond Expr

Purpose Stores a list of one or more Boolean expressions that are called by IF conditionsin a routine or containing expression.

DescriptionSupertype: Func ExprSubtypes: Cond ID ExprInternal name: dm_cond_exprObject type tag: 56

A cond expr object stores a list of one or more Boolean expressions that are called by IFconditions in a routine or containing expression. Content Server creates and managescond expr objects. Users cannot create them.

PropertiesTable 41, page 136, lists the property defined for the cond expr type.

Table 41. Properties dened for the cond expr type


Description

expression_list ID R List of object IDsrepresenting dm_func_exprobjects for expressions thatreturn a Boolean result.


Cond ID Expr

Cond ID Expr

Purpose Stores a list of one or more Boolean expressions and a list of corresponding objectIDs.

DescriptionSupertype: Cond ExprSubtypes: NoneInternal name: dm_cond_id_exprObject type tag: 57

A cond id expr object stores a list of one or more Boolean expressions and a list ofcorresponding object IDs. (The list of expressions is stored in the inherited expression_listproperty.) The information stored in a cond ID expr object is part of the data dictionary.A cond id expr object is created when a routine or larger expression includes one ormore if conditions that return an object ID. Content Server creates and manages cond idexpr objects. Users cannot create them.


Table 42. Properties dened for the cond ID expr type


Description

default_id ID S Object ID to return if noneof the expressions evaluateto TRUE.

id_list ID R Object IDs to be returnedwhen the correspondingexpression evaluates toTRUE.

For example, if theexpression specified inexpression_list[3] evaluatesto TRUE, the object ID


Cond ID Expr


Description

specified in id_list[3] isreturned.


Cong Scope Relation

Cong Scope Relation

Purpose Describes a configuration scope and relates a preset package object to its scope.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_config_scope_relationObject type tag: 37

A config scope relation object is used to relate a preset package to the preset package’sscope. The properties of the config scope relation object record information about thescope. The name of the relationship represented by objects of type config scope relationis dmc_config_scope_rel_type. This object type is installed with the Preset DAR fileduring repository configuration.


Table 43. Properties dened for the cong scope relation type


Description

scope_name string(32) S Name of the scope

This value is defined by theapplication.

scope_values string(64) R Specifies the values towhich the related presetconfiguration applies


Constraint Set

Constraint Set

Purpose Records a collection of constraints applied to relationships.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_constraint_setObject type tag: 08

A constraint set object records one or more predicates that define constraints applied tothe parent or child in a relationship defined by a dmc_relationship_def object. Constraintset objects are created and managed internally. Users should not directly manipulatethese objects. The object type is installed with the Smart Container DAR file duringrepository configuration.


Table 44. Properties dened for the constraint set object type


Description

constraint_name string(255) R Name of the constraint

constraint_metadata

string(255) R Metadata with which toconfigure the moduleidentified in module_nameprior to invoking themodule.

module_name string(255) R Name of the BOF modulethat implements theconstraint


Cont Transfer Cong

Cont Transfer Cong

Purpose Controls the capabilities of the ACS servers that service the repository and whethercontent in the repository may be pre-cached on a BOCS server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_cont_transfer_configObject type tag: 08

A cont transfer config object defines a top-level of control for the read and writecapabilities of the ACS servers associated with the repository. In addition, it controlswhether content in the repository can be pre-cached on a BOCS server.

A cont transfer config object is created during repository installation. Although aSuperuser is allowed to create an object of this type, there should be only one conttransfer config object in a repository.


Table 45. Properties dened for the cont transfer cong type


Description

acs_read_mode integer S Whether ACS serversassociated with therepository can transfercontent to users for reading.Valid values are:

0, meaning disabled

1, meaning enabled

The default is 1.

The value in this propertyoverrides any capability


Cont Transfer Cong


Description

defined for individual ACSservers.

acs_write_mode integer S Whether ACS serversassociated with therepository can transfercontent from users to therepository. Valid values are:

0, meaning disabled

1, meaning enabled

3, meaning enabled andasynchronous write enabledalso

7, meaning enabled andasynchronous write withretention enabled also

The default is 0.

The value in this property isdisregarded for individualACS servers that aredisabled.

bocs_precaching_mode

integer S Indicates whether contentin the repository may bepre-cached on a BOCSserver or not. Valid valuesare:

0, pre-caching content is notallowed

1, pre-caching content isallowed

The default is 1.


Containment

Containment

Purpose Stores information about a component of a virtual document.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmr_containmentObject type tag: 05

A containment object stores information about a component of a virtual document. Eachtime a user adds a component to a virtual document, the server creates a containmentobject for that component. The properties for this type are set by the Appendpart,Insertpart, and Updatepart methods. Users can query these properties using DQL.


Table 46. Properties dened for the containment type


Description

a_contain_desc string(255) S User-defined. Used byDocumentum clients tomanage XML documents.For more information,refer to Content ServerFundamentals.

a_contain_type string(255) S User-defined. Used byDocumentum clients tomanage XML documents.For more information,refer to Content ServerFundamentals.


Containment


Description

component_id ID S Chronicle ID of thecomponent. (The chronicleID is the object ID of theoriginal version of an object.If the object has no versions,then its object ID andchronicle ID are the same.)

copy_child integer S Defines client behaviorwhen the documentcontaining the componentis copied. Valid values are:

0, meaning the decisionwhether to copy or referencethe component is left to theuser when the document iscopied.

1, meaning when thedocument is copied, thecomponent is referenced inthe new copy rather thanactually copied.

2, meaning when thedocument is copied, thecomponent is also copied.

follow_assembly Boolean S If set to TRUE, directsthe system to resolvea component using thecomponent’s assembly(if the component has anassembly).


order_no double S Number representingthe component’s positionwithin the componentsof the virtual documentidentified by parent_id.


Containment


Description

parent_id ID S Object ID of the objectthat directly contains thecomponent.

use_node_ver_label

Boolean S If set to TRUE forearly-bound components,the server uses theearly-bound symboliclabel to resolve late-bounddescendants of thecomponent duringassembly.

version_label string(32) S Version label for thecomponent.


Content

Content

Purpose Stores information about a content file.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmr_contentObject type tag: 06

A content object stores the information about the format and location of a content file.It also contains the information that links the content to an object. A content objectalso has five properties used by Content Transformation Services to store metadatavalues generated by a Content Transformation Services server. If the object is stored in acontent-addressed storage area, these properties are used to record metadata values tobe stored in the storage system with the content.


Table 47. Properties dened for the content type


Description

content_attr_data_type

integer R Data type of themedia property inthe correspondingindex position incontent_attr_name. Possiblevalues are:

2, for a string datatype4, for a date/time datatype5, for a double datatype


Content


Description

content_attr_date_value

date R The value of themetadata field identifiedin the correspondingindex position incontent_attr_name if theproperty is a date data type.For all other data types, thevalue in the correspondingindex position incontent_attr_date_valueis NULLDATE.

content_attr _name string(64) R Names of the metadatafields generated by aContent TransformationServices server or specifiedin a Setcontentattrs orSET_CONTENT_ATTRSmethod for the content.

content_attr_num_value

integer R The value of themetadata field identifiedin the correspondingindex position incontent_attr_name if theproperty is an integerdata type. For all otherdata types, the valuein the correspondingindex position incontent_attr_num_valueis NULLINT.


Content


Description

content_attr value string(255) R The value of themetadata field identifiedin the correspondingindex position incontent_attr_name if theproperty is an stringdata type. For all otherdata types, the valuein the correspondingindex position incontent_attr_value isNULLSTRING.

content_size integer S Size, in bytes, of the contentfile

This property cannot recorda size greater than 2GB. Ifthe file is large, examine thefull_content_size propertyto obtain the full size.

The property is not set if thecontent is stored in externalstorage.

data_ticket integer S Value used internally toretrieve the content.

An actual data ticket iscreated for content stored infile stores and blob stores.

If the content is stored inturbo storage, in the contentobject, data_ticket is 0.

If the content is stored inturbo storage and is toolarge for the i_contentsproperty in the contentobject, the content is storedin repeating values of thei_contents property of asubcontent object. Thedata_ticket value in thecontent object contains thenumber of values in that


Content


Description

properties used to store thecontent.

If the content is stored inexternal storage, data_ticketis 0.

If the content is storedin a distributed storagearea component, the dataticket value identifies admi_replica_record objectfor the content.

If the content is stored incontent-addressed storage,the data_ticket is a numberused internally only and hasno external meaning.

encoding string(10) S The encoding for the format,if any

format ID S Object ID of the formatobject describing thiscontent’s format

full_content _size double S Size, in bytes, of the contentfile

The property is not set if thecontent is stored in externalstorage.

full_format string(64) S Full format specification forthe content

fulltext_index ID R obsolete


Content


Description

i_parked_state integer S Identifies the inboundtransfer status of thecontent. Valid values are:

0, meaning the content is inthe storage area

1, meaning the content istemporarily residing on aBOCS server

2, meaning the content istemporarily residing on anACS server

3, meaning that the contentis not available becausethis content object wasreplicated from a repositorywhose content is not yetavailable. That is, the sourcecontent has a non-zero valuein i_parked_state.


index_format ID S obsolete

index_formats ID R obsolete

index _operations integer R obsolete

index_pages integer R obsolete

index_parent ID S obsolete

index_parents ID R obsolete

index_set_times DATE R obsolete

index_subtypes string(27) R obsolete

is_archived Boolean S Indicates whether thecontent has been archived.

is_offline Boolean S Indicates whether thecontent is in the storagearea.


Content


Description

i_contents For alldatabasesexcept Sybase:string(2000)

For Sybase:string(255)

S If the content is stored inturbo storage, this propertycontains the actual contentfile. If the content is toolarge for this property,the content is stored in admi_subcontent object andthis property is unused.

If the content is stored incontent-addressed storage,this property contains thecontent address.

If the content is storedin external storage, thisproperty contains the tokenused to retrieve the content.

The property cannot beselected using the API orDQL.

i_encoding string(10) R Contains formatinformation used internallyin the management ofdistributed repositories.

i_format ID R Contains the informationfrom the page and formatproperties

i_full_format string(64) R Contains formatinformation used internallyin the management ofdistributed repositories.

i_index_format ID R obsolete

i_px integer R Contains formatinformation used internallyin the management ofdistributed repositories.


Content


Description

i_py integer R Contains formatinformation used internallyin the management ofdistributed repositories.

i_pz integer R Contains formatinformation used internallyin the management ofdistributed repositories.

i_rendition integer R Contains the informationin the rendition property.Used internally in themanagement of distributedrepositories.

loss integer S The transformation loss forthe format, if any.

other_file_size double S Reserved for future use

other_ticket integer S Value used internally toretrieve the content

page integer R Position of the content ineach of the objects thatcontain it

page_modifier string(16) R User-defined string todisambiguate renditionshaving the same formatthat are associated with aparticular content page of adocument.

parent_count integer S Total number of objects thatcontain this content

parent_id ID R Object IDs of the objectsthat contain the contentrepresented by this contentobject


Content


Description

r_content_hash string(256) S Hashed value of theassociated content file.This is only set if contentis stored in a file storestorage area and the storagearea’s content_hash_modeproperty is set to 1.

rendition integer S Provides information abouta rendition. Valid valuesare:

0, for original content1, for a renditiongenerated by the server2, for a renditiongenerated by the client3, meaning keep therendition when the contentwith which it is associatedis updated or removed fromthe document or repository

resolution integer S The resolution specificationfor the content’s format.

set_client string(64) S Name of the client machineon which the setfile wasexecuted.

set_file string(255) S Source file on the clientmachine that contained thecontent.

set_time DATE S The initial value is the timeat which the Setfile wasexecuted. The time valueis the time on the servermachine.

storage_id ID S Object ID of the store objectrepresenting the storagearea that contains thecontent.


Content


Description

transform_path string(32) S The transformation path forthis format

update_count integer R Number of the updateoperation in which thiscontent will be indexed.

x_range integer S The format’s range along thex axis.

y_range integer S The format’s range along they axis.

z_range integer S The format’s range along thez axis.


Cryptographic Key

Cryptographic Key

Purpose Stores a private cryptographic key.

DescriptionSupertype: SysObjectSubtypes: NoneInternal Name: dm_cryptographic_keyObject type tag: 08

A cryptographic key object stores a private cryptographic key. The cryptographic keyobject is created automatically by Content Server. It is used by Content Server to encryptinstructions regarding content file availability for an ACS server or BOCS server. Thereis only one cryptographic key object in a repository. The permissions on this object giveDelete permission to the owner and the members of the dm_superusers group.

Caution: These objects are for internal use only. Do not modify, remove, or addthese objects.


Table 48. Properties dened for the cryptographic key type


Description

key_identifier string(40) S Base 64-encodedSHA1 digest of theDER private key

key_type integer S Identifies what thekey used for byContent Server. Theonly valid value is:

1, meaning used forACS encryption


Cryptographic Key


Description

key_value string(1000) S Base 64-encoded andDBK-encrypted DERkey

public_key_identifier string(40) S Base 64-encodedSHA1 digest of theDER public key valuein the dm_public_key_certificate.key_identifier property.


DD Attr Info

DD Attr Info

Purpose Contains the published data dictionary information for a property.

DescriptionSupertype: DD Common InfoSubtypes: NoneInternal Name: dmi_dd_attr_infoObject type tag: 6a

A dd attr info object contains the published data dictionary information for a property.You cannot create dd attr info objects directly. They are created or modified as neededwhen data dictionary information is published.

With one exception (attr_name), each property defined for the type has a correspondingproperty in the type named i_property_name. The i_ properties are used internally byContent Server.

PropertiesTable 49, page 157, lists the basic properties of a dd attr info object.

Table 49. Properties dened for the DD attr info type


Description

allowed_search_ops

integer R The search operatorsavailable for the property.Valid values depend on theproperty’s data type.

For string:1, meaning =2, meaning <>3, meaing >4, meaning <5, meaning >=6, meaning <=7, meaning begins with8, meaning contains9, meaning does not contain


DD Attr Info


Description

10, meaning ends with11, meaning in12, meaning not in14, meaning is null15, meaning is not null

allowed_search_ops

(continued)

For Integer:

1, meaning =2, meaning <>3, meaning >4, meaning <5, meaning >=6, meaning <=11, meaning in12, meaning not in13, meaning between14, meaning is null15, meaning is not null

For Date:

1, meaning =2, meaning <>3, meaning >4, meaning <5, meaning >=6, meaning <=13, meaning between14, meaning is null15, meaning is not null

For Boolean and ID:

1, meaning =2, meaning <>14, meaning is null15, meaning is not null


DD Attr Info


Description

attr_name string(32) S Name of the propertydescribed by the dd attr infoobject.

This property has nocorresponding i_ propertyin the type.

category_name string(64) S User-defined.

computed_dep _usr Boolean S Indicateswhether the valuesin computed_expr_depwere set by the user orcalculated. TRUE meansthe values are user defined;FALSE means they arecalculated.

computed_expr_dep

string(32) R List of properties onwhich the computedexpression referencedin cond_computed_exprdepends.

cond_computed_expr

ID R Object ID of thedm_cond_id_expr objectthat contains the conditionalcomputed expressions andthe associated object IDs.

cond_value_assist ID S Object ID of the cond IDexpr object that containsthe conditional expressionsfor the property’s valueassistance.

def_value_length integer S Length of the property’sdefault value. A zeroindicates that the value isunspecified.

default_expr_builtin

integer R Used internally.

default_expr_kind integer R Used internally.


DD Attr Info


Description

default_expr _value string(255) R Used internally to optimizedefault value handling.

default_search_arg integer S Default value to display inconjunction with the defaultsearch operator.

default_search_op string(255) S Default search operator todisplay to users when theysearch on the property.

default_value ID R Object ID of an expressionobject that resolves tothe default value for theproperty. For single-valuedproperties, only onevalue can be defined.For repeating properties,multiple values can bedefined.

domain_length integer S For string properties, themaximum length of a value.

domain_type integer S Identifies the datatype ofthe property. Valid valuesare:

0, Boolean1, Integer2, String3, ID4, Time/Date5, Double

format_pattern string(64) S For date properties, thepattern used to interpretvalues for the property.

format_pattern _tag integer S Currently unused.

(This value is always 1.)


DD Attr Info


Description

ignore_immutable Boolean S Indicates whether theproperty is changeable evenif the containing object isimmutable.

This setting is effectiveonly for objects of typedm_sysobject or itssubtypes.

is_hidden Boolean S For use by clientapplications.

is_required Boolean S Indicates whether usersmust provide a value for theproperty.

map_data_string string(128) R List of possible data valuesfor the property.

map_description string(255) R Descriptions of thedata values at thecorresponding index levelsin map_data_string.

map_display_string

string(128) R The character string todisplay for the data valueat the corresponding indexlevel in map_data_string.

not_null Boolean S Indicates whether theproperty has a NOT NULLconstraint defined for it.

not_null_enf integer S Indicates who is responsiblefor enforcing a NOTNULL constraint. Validvalues are the same as forforeign_key_enfs.

not_null_msg string(255) S Error message to displaywhen the NOT NULLconstraint is violated.

read_only Boolean S Indicates whether theproperty is read only.


DD Attr Info


Description

reference_kind integer S Used internally byCollaboration Services

super_domain_id ID S Object ID of the domainfrom which the domain ofthis property is derived, ifany.

super_domain_name

string(32) S Name of the domain fromwhich the domain of thisproperty is derived. Ifblank, the domain is thebuilt-in domain indicatedby domain_type.

value_assist_dep string(32) R Properties on which thevalue assistance expressionsdepend.

value_assist_dep_usr

Boolean S Indicates whether the userdefined the list of valuesin value_assist_dep. TRUEmeans the user defined thevalues; FALSE means thevalues were calculated.


DD Common Info

DD Common Info

Purpose Contains the published data dictionary information that an object type andproperty have in common.

DescriptionSupertype: Persistent ObjectObject Subtypes: DD Attr Info; DD Type InfoInternal Name: dmi_dd_common_infoObject type tag: 68

A dd common info object contains the published data dictionary information that anobject type and property have in common. You cannot create a dd common info objectdirectly. They are created as needed when data dictionary information is published.

With four exceptions, each property listed in Table 50, page 163 has a correspondingproperty named i_property_name in the object type definition. The i_ properties areused internally by Documentum products. The four exceptions are the properties thatidentify the object type or property with which the dd common info object is associated.These four properties are:• business_policy_id• nls_key• state_name• type_name


Table 50. Properties dened for the DD common info type


Description

business_policy_id ID S Object ID of a dm_policyobject

This property has a valueonly if the informationin the dd common infoobject is associated witha particular lifecycle andstate.


DD Common Info


Description


comment_text string(255) S User-defined.

constraint_dep _usr Boolean S TRUE indicatesthat the values inval_constraint_dep areuser-defined. FALSEmeans that the valuesare computed by ContentServer.

foreign_keys ID R Object IDs of any foreignkey objects associated withthe property.

foreign_key_enfs integer R Indicateswho is responsiblefor enforcing thecorresponding foreignkey. Valid values are:

1, Enforcement disabled2, Enforcement byapplication

foreign_key_msgs string(255) R Error message to displaywhen the correspondingforeign key constraint isviolated.

help_text string(255) S Help text to use for theproperty.

i_dd_flags integer R Reserved for future use.

ignore_constraints Boolean S TRUE indicates thatconstraints inherited fromparent types are ignored.FALSE means the inheritedconstraints are enforced.The default is FALSE.


DD Common Info


Description

is_searchable Boolean S Indicates whether theproperty is searchable.The default is TRUE,meaning the property canbe searched.

label_text string(64) S Label for the property orobject type.

Documentum providesdefault labels for allproperties and object types.For numerous properties,the default is defined in adata dictionary populationfile.

If no default is defined inthe data dictionary, thedefault for an object type isits name. For example, fordm_sysobject, the defaultis dm_sysobject. Thedefault for a property is theproperty’s name.

life_cycle integer S Indicates the current lifecycle status of the type orproperty. Valid values are:

1, Currently in use2, For future use3, Obsolete

The default is 1 (currentlyin use).

nls_key string(5) S Locale of the information inthe dd common info object.



DD Common Info


Description

primary_key ID S Object ID of dm_key objectthat contains primary keyconstraints for the type orproperty.

primary_key_enf integer S Identifies who isresponsible for enforcingthe corresponding primarykey. Valid values are:


primary_key_msg string(255) S Error message to displaywhen the primary key isviolated.

resync_needed Boolean S Indicates whether thereare unpublished changesto the object or property.TRUE indicates that thereare unpublished changes.

state_name string(32) S Name of the lifecyclestate in which this datadictionary informationapplies.

This property has a valueonly if the informationin the dd common infoobject is associated witha particular lifecycle andstate.



DD Common Info


Description

type_name string(32) S Name of the object typewith which the informationin the dd common infoobject is associated.


unique_keys ID R Object IDs of the key objectsrepresenting any uniquekeys that apply to the typeor property.

The unique keys definedfor the type or propertyare listed first, followed bythose inherited from thesupertype or super domain.

unique_key_enfs integer R Indicateswho is responsiblefor enforcing thecorresponding unique key.Valid values are the same asfor foreign_key_enfs.

unique_key_msgs string(255) R Error message to displaywhen the correspondingunique key is violated.

val_constraint ID R Object IDs of the expressionobjects representing anycheck constraints that applyto the property.

val_constraint _dep string(32) R Names of the propertiesreferenced by the constraintat the corresponding indexlevel in val_constraint.


DD Common Info


Description

val_constraint _enf integer R Indicateswho is responsiblefor enforcing thecorresponding validationconstraint. Valid valuesare the same as forforeign_key_enfs.

val_constraint _msg string(255) R Error message to displaywhen the correspondingvalidation constraint isviolated


DD Info

DD Info

Purpose Contains data dictionary information for an object type or property that is notdependent on locale.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_dd_infoObject type tag: 4e

A dd info object contains data dictionary information for an object type or that is notdependent on locale. Content Server creates and manages dd info objects. Properties indd info objects are set when users add or change data dictionary information.

PropertiesTable 51, page 169, lists the properties defined for dd info that are applicable to bothobject types and properties. Table 52, page 172, lists the properties that apply only toobject types. Table 53, page 172, lists the dd info properties that apply only to properties.

Table 51. Properties applicable to object types and properties


Description

auditable_appevents

string(64) R The application-definedevents that can be audited.

auditable_sysevents

string(64) R The system-defined eventsthat can be audited.

foreign_keys ID R Object IDs of the foreignkey objects for the type orproperty.


DD Info


Description

foreign_key_enfs integer R Indicates how thecorresponding foreignkeys are enforced. Validvalues are:


fulltext_support integer S Indicates how full-textindexing is supported forthe object type. Valid valuesare:

0, no support

1, light support

2, full support

Note: Currently, this is onlyused by lightweight objectsubtypes.

ignore_constraints integer S Indicates whether thevalidation, key, and NOTNULL constraints definedfor the type or are ignored.Valid values are:

0, Follow the constraints1, Ignore the constraints-1, Inherit the value from thecorresponding property inthe type or type’s supertype


DD Info


Description

is_searchable integer S For client use. Indicateswhether the or type shouldappear in pick lists for Finddialogs. Valid values are:

0, FALSE1, TRUE-1, Inherit the valuefrom the correspondingproperty in the type ortype’s supertype

life_cycle integer S Indicates the state ofthe object type or in therepository. Valid values are:

1, Currently in use2, For future use3, Obsolete

unique_keys ID R Objects IDs of the keyobjects that define uniquekeys for this type orproperty.

unique_key_enfs integer R Indicates how thecorresponding uniquekeys are enforced. Validvalues are the same as forforeign_key_enfs.

val_constraint ID R Object IDs of the expressionobjects corresponding to theconstraints applied to thetype or property.

val_constraint_dep string(32) R The properties on whichthe expression validationconstraints depend.

val_constraint _enf integer R Indicates how thecorresponding validationconstraints are enforced.Valid values are the same asfor foreign_key_enfs.


DD Info

Table 52. Properties applicable only to object types


Description

comp_classifier string(128) R Qualified components thatcan be called for this type.

default_policy_id ID S Chronicle ID of the defaultpolicy object for the type.

icon_index integer S The index that locatesthe type’s icon in the iconresource file.

policy_ver_label string(32) S Version label that identifieswhich version of the defaultpolicy object to use for thetype.

primary_key ID S Object ID of the primary keyfor the type.The primarykey must be one of theunique keys defined inunique_key.

primary_key_enf integer S Indicates how the primarykey is enforced. Validvalues are the same as forforeign_key_enfs.

qual_comp_id ID R Object IDs correspondingto the qualifiedcomponents identifiedin comp_classifier.

Table 53. DD info properties applicable to properties


Description

allowed_search_ops

integer R A list of integersrepresenting the validsearch operators for thisproperty. Valid values are:

1, for =2, for <>3, for >4, for <


DD Info


Description

5, for >=6, for <=7, for begins with8, for contains9, for does not contain10, for ends with11, for in12, for not in13, for between14, for is null15, for is not null16, for not

computed_expr_dep

string(32) R Currently unused.

cond_computed_expr

ID S Currently unused.

cond_value_assist ID S Object ID of the cond idexpr object that containsthe conditional valueassistance.

default_search _arg string(255) S The default value to use inconjunctionwith the defaultsearch operator (defined indefault_search_op)

default_search_op integer S The default search operatorfor the property. Theoperator specified must bein allowed_search_ops.

default_value ID R Object IDs of the expressionobjects representing theproperty’s default values.

For single-valuedproperties, default_value[0]must be the object ID ofa dm_expression objectcorresponding to a literalof the appropriate datatypefor the property or theNULL value appropriate


DD Info


Description

for the type (for example,NULLSTRING).

For repeating properties,multiple expressionobject IDs are allowed,representing multipledefault values for theproperty. However,object IDs representingexpressions that evaluate toNULL are not allowed.

ignore_immutable integer S Indicates whether thevalue in r_immutable_flagcontrols the property’schangeability. Thissetting affects onlyproperties of objects oftype dm_sysobject orSysObject subtypes.

If set to 1 (TRUE), the ischangeable regardless of theobject’s r_immutable_flagsetting. Valid values are:

0, FALSE1, TRUE-1, Inherit value fromsuper domain or type

is_hidden integer S Provided for use byclient applications. Validvalues are the same as forignore_immutable.


DD Info


Description

is_required integer S Indicates whether a value isrequired for the property.

If set to 1 (TRUE), themust have a value beforesaving the object. Validvalues are the same as forignore_immutable.

not_null integer S Indicates whether the hasthe NOT NULL constraintdefined for it.

If set to 1 (TRUE), theNOT NULL constraint isspecified for the property.Valid values are the same asfor ignore_immutable.

not_null_enf integer S Indicates how the NOTNULL constraint isenforced. Valid valuesare the same as for theforeign_key_enfs .

parent_id ID S Object ID of the aggrdomain object thatreferences the dd infoobject.

read_only integer S Indicates whether users canread and write the propertyor only read it.

If set to 1 (TRUE), userscan only read this property,they cannot write to it.Valid values are the same asfor ignore_immutable.

reference_kind integer S Used internally byCollaboration Services

value_assist_dep string(32) R Properties on which thevalue assistance depends.


DD Type Info

DD Type Info

Purpose Contains the published data dictionary information for an object type.

DescriptionSupertype: DD Common InfoSubtypes: NoneInternal Name: dmi_dd_type_infoObject type tag: 69

A dd type info object contains the published data dictionary information for an objecttype. You cannot create or modify dd type info objects directly. They are created ormodified as needed when data dictionary information is published.

PropertiesTable 54, page 176, lists the properties of the object type.

Table 54. Properties dened for the DD type info type


Description

attr_domain_name string(32) R Currently unused.

attr_domain_id ID R Currently unused.

auditable_appevents

string(64) R The application-definedevents that can be audited.

auditable_sysevents

string(64) R The system-defined eventsthat can be audited.

comp_classifier string(128) R The classifiers for thequalified components thatcan be executed againstinstances of the type.

default_policy_id ID S Object ID of the dm_policyobject representing thedefault lifecycle for thetype.


DD Type Info


Description

i_attr_domain _id integer S For internal use.

i_attr_domain_name

integer S For internal use.

i_comp_classifier integer S For internal use.

i_default_policy _id Boolean S For internal use.

i_icon_index Boolean S For internal use.

i_policy_version_label

Boolean S For internal use.

i_qual_comp_id integer S For internal use.

icon_index integer S The index that locates theicon for the type in the iconresource file.

map_data_string string(128) R List of possible data valuesfor the .


map_display_string

string(128) R The character string todisplay for the data valueat the corresponding indexlevel in map_data_string

policy_ver_label string(32) S Version label of theobject identified indefault_policy_id.

Note: This value isprovided by the user,not derived from the objectby Content Server

qual_comp_id ID R Object IDs of the qual compobjects representing thecomponent routines thatcan be executed againstinstances of the type.

r_has_check Boolean R For internal use


DD Type Info


Description

r_has_constraint Boolean R For internal use

r_has_default Boolean R For internal use

r_has_dependency Boolean R For internal use

r_has_foreign_key Boolean R For internal use

r_has_ignore_immutable

Boolean R For internal use

r_has_not_null Boolean R For internal use

r_has_primary _key Boolean R For internal use

r_has_unique_key Boolean R For internal use

r_has_value_assist Boolean R For internal use

scope_config ID R Object IDs of the scopeconfig object for the objecttype.


Display Cong

Display Cong

Purpose Defines the display configuration for a group of properties.

DescriptionSupertype: NoneSubtypes: NoneInternal name: dm_display_configObject type tag: 6b

A display config object defines the display configuration for a group of properties.Displayconfig objects are referenced by scope config objects, which define the context withinwhich the display configuration is used. Both display config objects and scope configobjects are used by client applications. Content Server does not use these objects.


Table 55. Properties dened for the display cong type

Property Datatype Singe/repeating

Description

attribute_display_hint

integer R Controls the display of properties inthe user interface. These values areinterpreted by client application, notContent Server.

Values used by Desktop Client andWebtop are:• 0, meaning do not display aseparator before a property

• 1, meaning display a separatorbefore a property

Values used by Webtop only are:• 2, meaning display the property ifthe user requests it and do not usea separator


Display Cong

Property Datatype Singe/repeating

Description

• 3, meaning display the propertyif the user requests it and use aseparator

The hint at a particular index positionis applied to the property named atthe corresponding index position inattribute_name.

attribute_name string(40) R List of properties names. Theproperties must be defined for theobject type identified in propertysource. The order in which theproperties are listed determines theorder in which they are displayed inthe client application.

attribute_source string(27) S The object type for which theproperties listed in attribute_nameare defined.

fixed_display Boolean S Indicates whether properties canbe added to attribute_name ordisplay_hints changed. T means thatthe property list and hint cannot bechanged. F means that the propertylist and hint can be changed.

The default is F.

i_config_identifier

string(20) S Uniquely identifies a display configobject across repositories. The formatof the value is dm_r_object_id, wherer_object_id is the object ID of thedisplay config object.

This is used internally to manage loadoperations.

object_name string(64) S Name of the display config object.This must be unique within the scopein which the display config object isused.

Note: Uniqueness is enforced by theclient, not Content Server.


Distributed Store

Distributed Store

Purpose Contains information about a storage area.

DescriptionSupertype: StoreSubtypes: NoneInternal name: dm_distributedstoreObject type tag: 2c

A distributed store object contains information about a storage area. A distributedstorage area points to component storage areas and is used to implement a repositorythat has distributed content. All but three of its properties are inherited from itssupertype, dm_store.

Note: For information about distributed storage areas, refer to the DocumentumDistributed Configuration Guide.

PropertiesTable 56, page 181, lists the properties defined for the distributed store type.

Table 56. Properties dened for the distributed store type


Description

change_record_id ID S Used internally to managestructural changes.

epoch_number integer S Records a count of howmany structural changes(adding or removingcomponent areas) havebeenmade to the distributedstorage area.

only_fetch_close Boolean S Indicates if a server canfetch files from componentstorage areas in thedistributed storage area


Distributed Store


Description

that are defined as far forthe server.


DMS Cong

DMS Cong

Purpose Records configuration information about a DMS server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_dms_configObject type tag: 08

A dms config object records the configuration of a DMS server. A dms config object isstored in the global registry repository. There can be only one dms config object ineach global registry in the installation. Use Documentum Administrator to create andmanage a dms config object.


Table 57. Properties dened for the dms cong type


Description

dms_capability integer S Defines the capabilitiesof the DMS server. Validvalues are:

0, meaning disabled

1, meaning enabled

The default is 1.

message_consume_url

string(240) S The URL used by a BOCSto retrieve messages from aDMS server.

message_post_url string(240) S The URL used by DFC topost messages to the DMS.


DMS Cong


Description


string(16) S Indicates the major versionof the DMS server. For aDMS 6.0 server, this mustbe set to 1.


string(16) S Indicates the minor versionlevel of the DMS server. Fora DMS 6.0 server, this mustbe set to 0.


Docbase Cong

Docbase Cong

Purpose Contains configuration information about a repository.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_docbase_configObject type tag: 3c

A docbase config object contains configuration information about a repository Eachrepository must have a single docbase config object whose object name matches thename of the repository.


Table 58. Properties dened for the docbase cong type


Description

a_bpaction_run_as string(32) S Defines which user accountis used to run lifecyle(business policy) actions.Valid values are:• session_user (default)• superuser• lifecycle_owner• user name

The first three values arekeywords that must beentered as shown. For thelast, user name, specify theuser name of a repositoryuser.


Docbase Cong


Description

approved_clients_only

Boolean S Indicates whether clientsconnecting to this repositorymust have an entry in theClient Rights database.

audit_old_values Boolean S Indicates whether to includeold as well as new valuesof audited properties inthe audit trail entry. TRUEmeans to include the oldvalues. FALSE means toexclude them. The defaultis TRUE.

For repositories created onDB2 or Sybase platformswith a page size of 4K, thisproperty value is alwaysFALSE.

auth_deactivation_interval

integer S Length of time between auser’s account deactivationand automatic re-activation.If this is 0, the account is notautomatically re-activated.

The value is specified inminutes.

The default is 0.

auth_failure_interval

integer S Length of time, in minutes,in which consecutive failedlogin authorizations willcause a user’s accountto be deactivated. Thenumber of failed attemptsthat must occur withinthe interval to triggerdeactivation is determinedby the max_auth_attemptsproperty.

The default is 0, meaningthat deactivation alwaysoccurs when the maximumnumber of consecutive


Docbase Cong


Description

failed login attempts isreached, regardless of howlong that takes.

auth_protocol string(32) S On Windows platforms, ifset to domain_required,it indicates that therepository is running indomain-required mode. Ifthe repository is not usingdomain-required mode, thisis blank.

On UNIX platforms, if youare authenticating usersagainst a Windows domain,set this to

unix_domain_used

Otherwise, this propertyis blank for repositoriesrunning on a UNIXplatform.

check_client_version

Boolean S T means that the repositoryservers will not acceptconnections from clientsolder than the versionlevel specified in theoldest_client_versionproperty.

F means that the serversaccept connections from anyclient version.

The default is F.

client_pcaching_change

integer S Controls persistentclient cache flushing.Incrementing this valueforces clients to flush allpersisent caches on start up.


Docbase Cong


Description

client_pcaching_disabled

Boolean S T (TRUE) disables persistentclient caching for sessionswith the repository. Thedefault is F (caching isallowed).

dd_locales string(5) R Data dictionary localesrecognized by the server.

Setting this propertyrequires you to executea Reinit method on theserver to make the changevisible.

default_app_permit

integer S Default user permissionlevel for application-controlled objects accessedthrough an application thatdoesn’t own the object.Values are:

2, Browse permission3, Read permission4, Relate permission5, Version permission6, Write permission7, Delete permission

The default value is 3, Readpermission.

dir_user_sync_on_demand

Boolean S Controls whether LDAPdirectory users can besynchronized on demandin the repository. T meansthat such users can besynchronized on demand. Fmeans that they cannot besynchronized on demand.

The default value is F.

docbase_roles string(32) R Used internally


Docbase Cong


Description

effective_date date S Obsolete in 5.2 repositories.In pre-5.2 repositories,this is used to forcepersistent client cacheflushes. The default value isNULLDATE.

folder_security Boolean S Indicates whether therepository is running withfolder security on or off.The default is T, meaningthat security is turned on.

fulltext_install_locs string(32) R Name of the location objectthat points to a fulltextinstallation.

i_crypto_key string(255) S The encryption key for therepository

i_ticket_crypto_key string(255) S The encrypted login ticketkey

index_store string(80) S Name of the RDBMStablespace where you wantto store type indexes.

login_ticket_cutoff Date S Defines the earliest possiblecreation date for validlogin tickets. Tickets issuedbefore this date are not validin this repository.

The default value isNULLDATE, meaningthere is no cutoff date forlogin tickets.


Docbase Cong


Description

mac_access_protocol

string(32) S Identifies the type of filesharing protocols in use forMacintosh clients.

Valid values are nt, double,ushare, or none.

This is set to nt when arepository is configured toenable “other file” use.

Use none only if you haveno Macintosh clients.

Double and ushare aremeaningful only toMacintosh clients.

macl_security_disabled

Boolean S If T (TRUE), ContentServer enforces onlythe AccessPermit andExtendedPermit entries inan ACL.

If the server is installedwith a Trusted ContentServices license, the defaultis F (FALSE), meaning theserver enforces all entries anACL

If the server is not installedwith a Trusted ContentServices license, the defaultis T.

max_auth_attempt integer S Maximum number ofunsuccessful login attemptsallowed.

The default is 0, whichmeans the feature isdisabled.


Docbase Cong


Description

object_name string(255) S Contains the name ofthe repository. (Thisproperty is inherited fromdm_sysobject.)

A repository name mustbe all ASCII characters and<=32 characters in length.The name docu is reservedby Documentum.

offline_checkin_flag

integer S Used by some Documentumclients to determinewhethera client dialog box is usedto check in content or theuser’s local check-in settingtakes precedence. Validvalues are:

0, meaning use a clientdialog box for check ins

1, meaning allow the user’slocal check-in setting to takeprecedence


offline_sync_level integer S Identifies the level ofrepository access for offlinesynchronization. This isused primarily by someDocumentum clients. Validvalues are:

0, meaning none

1, meaning one-way access

2, meaning role-basedaccess


Note: Refer to theclient documentation forinformation about the actualuse of this property androle-based synchronization.


Docbase Cong


Description

oldest_client_version

string(32) S Version number of the oldestDocumentum client thatwillaccess this repository.

This must be set manually.It is used by the DFC todetermine how to storechunked XML documents.If check_client_version is setto T, then this value is alsoused to identify the oldestclient version level that mayconnect to the repository.

r_address_partitions

integer S This is no longer used.

r_dbms_name string(32) S Name of the RDBMS.

Valid values on Windowsplatforms are: Oracle, SQLServer, and DB2.

Valid values on Unixplatforms are: Oracle,Sybase, and DB2.

r_docbase_id integer S The repository ID as adecimal value.

r_ending _partition integer S This is no longer used.

r_federation _name string(120) S Name of the federationto which the repositorybelongs, if any.

The name is takenfrom the value of theobject_name property in thedm_federation object.

r_module_mode integer R Used internally

r_module_name string(32) R Used internally


Docbase Cong


Description

r_normal_tz integer S Indicates the storage modeused for date values.

0 directs Content Server tostore all date values in UTCtime.

A value other than 0represents the time zoneoffset from UTC timeused by Content Server tonormalize all date values forstorage.

A time zone offset mustbe expressed as seconds.For example, if the offset isfor PST (Pacific StandardTime), the value is -28800(-8*60*60).

This defaults to 0 for a new6.0 or later repository andto an offset representingthe server local time for arepository that is upgradedfrom a pre-6.0 release.

r_starting_partition

integer S This is no longer used.

r_storage_mode integer S Used internally

richmedia _enabled Boolean S Indicates whether theContent Server for thisrepository can processrich-media content. Thisvalue is set to TRUE duringinstallation of a ContentTransformation Servicesproduct.

security_mode string(32) S Defines the security level forthe repository. Valid valuesare acl or none.


Docbase Cong


Description

trust_by_default Boolean S Whether the repositoryaccepts login ticketsand application accesscontrol tokens from otherrepositories that have thesame login ticket key (LTK)as this repository.

T (TRUE) means therepository accepts logintickets and tokens fromother repositories that shareits LTK.

F (FALSE) means that itonly accepts login ticketsand tokens from otherrepositories sharing itsLTK if they appear in thetrusted_docbases list.


trusted_docbases string(255) R Name of the repositoriesfromwhich login tickets andtokens are accepted. Therespositories must have thesame login ticket key as therepository represented bythis docbase config object.

wf_package_control_enabled

Boolean S Controls whether ContentServer exposes the objectnames of components inworkflow packages.

T allows Content Server toset the r_component_nameproperty in dmi_packageobjects. F disallows settingthe r_component_nameproperty in package objects.

If this property is F, thesetting at the workflowlevel, in the package_controlproperty of the dm_processobject is ignored.


Docbase Cong


Description



Docset

Docset

Purpose Represents a set of documents to be processed by Content Intelligence Services.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_docsetObject type tag: 09

A docset object represents a set of documents to be processed by Content IntelligenceServices. The documents are defined by a query recorded in the docset content. Thecontent’s format is crtext.


Table 59. Properties dened for the docset type


Description

description string(255) S User-defined description of thedocument set

last_run_id ID S Object ID of the docset run objectlast used to process this documentset.

object_name string(255) S Document set name

qualifiers string(255) R List of conditions that documentsmust meet for inclusion in thedocset.


Docset


Description

queue_bound Boolean S Controls whether documentsplaced on the processing queuecan be considered for inclusion inthis docset.

Setting this to T allows documentson the processing queue to beconsidered for inclusion in thisdocset.

query_type string(32) S Identifies the type of query. Theonly valid value is dql.


Docset Run

Docset Run

Purpose Represents an executable collection of documents.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_docset_runObject type tag: 09

A docset run object represents an executable collection of documents. Docset run objectsare used by Content Intelligence Services.

PropertiesTable 60, page 198, lists the properties defined for the type and those inherited propertiesthat have a meaning specific to this type.

Table 60. Properties dened for the docset run type


Description

docset_id ID S Object ID of the document setassociated with the processingrun

estimated_count integer S Estimated number of documentsto process in the run

object_name string(255) S Name of the docset run

processed_count integer S Actual number of documentsprocessed by the run

run_interval integer S Not currently used

run_mode integer S Not currently used

run_now Boolean S T (TRUE) invokes processingimmediately.



Docset Run


Description

run_owner string (32) S Name of the category managerwho started the processing.

run_status string(32) S Status of the processing run.Valid values are:

not_startedstartedscheduledcompletedfailed

run_type string(32) S Indicates whether this is a testrun or an actual run. Valid valuesare:

testactive

start_time Date S Not currently used

taxonomy_id ID R Object IDs of all taxonomiesincluded in the processing.

Currently, only one taxonomy ina run is supported.

title string(255) S Description of status state. Thedescription may be user orsystem-defined.


Document

Document

Purpose Contains information about a document.

DescriptionSupertype: SysObjectSubtypes: Email Message, Esign Template, XML Config, XMLCustom Code, XML Style Sheet, XML Zone, Notepage, TCFActivity, TCF Activity Template, XFM Form, XFM InstanceInternal name: dm_documentObject type tag: 09

Documents are the objects most commonly manipulated by users in the Documentumsystem. Documents can be simple documents or virtual documents. In a simpledocument, the content generally seen by a user is in one or more content files associatedwith the document. A virtual document is a document that is composed of componentsthat are either simple documents or other virtual documents, and the content that userssee is the content files associated with these components.

A virtual document can also have associated content files. That is, in addition to itscomponents, a virtual document can have an associated content file (or files). However,when you open a virtual document for viewing or editing through WorkSpace,WorkSpace opens the component.

All content files associated directly with a document must have the same file format. Thecomponents of virtual documents can have a mixture of formats.

PropertiesDocuments inherit all of their properties from their supertype, the SysObject type.


Domain

Domain

Purpose Describes the properties of a property’s domain.

DescriptionSupertype: Persistent ObjectSubtypes: Aggr DomainInternal name: dm_domainObject type tag: 50

A domain object describes the properties of a property’s domain. The informationcontained in a domain object is part of the data dictionary. The domain informationincludes the property’s datatype, length (if a string type), localized label text, and anyexpressions used to populate the property. Domain objects are created and managed bythe server and cannot be created by users.


Table 61. Properties dened for the domain type


Description

dd_info ID S Object ID of the dd infoobject containing thedomain’s information thatdoes not depend on locale.

domain_length integer S For string domains, themaximum length of thedomain.

domain_name string(32) S Currently unused.


Domain


Description

domain_type integer S Indicates the domain’sdatatype. Valid values are:

0, Boolean1, Integer2, String3, ID4, Time/Date5, Double

nls_dd_info ID R Object IDs of the nls ddinfo objects containing thedomain’s information thatis dependent on locale.

nls_default integer S Currently unused.

nls_keys string(64) R Identifies the locales forwhich localized informationis available. The values arethe standard locale codes;for example, en or ja.

The localized domaininformation for each localeis recorded in the nls ddinfo object identified inthe corresponding indexposition of the nls_dd_infoproperty.

This property is set when alocale is populated.

parent_id ID S Object ID of the aggrdomain object thatreferences this domain in itsattr_domain_id property.


Domain


Description

re_sync_dd Boolean S Indicates whether thedomain’s property valuesaccurately reflect the valuesin the associated typedefinition.

If TRUE, indicates that thedomain may not accuratelyreflect the information inthe type definition.

super_domain_id ID S Object ID of the domainobject from which thisdomain is derived, if any.

super_domain_name

string(32) S Currently unused.


Dump Object Record

Dump Object Record

Purpose Contains information about an object that has been copied from a repository intoan external file using the Dump utility.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_dump_object_recordObject type tag: 30

A dump object record object contains information about an object that has been copiedfrom a repository into an external file using the Dump utility. The information in adump object record object is primarily useful if the dump process is interrupted andmust be restarted.


Table 62. Properties dened for the dump object record type


Description

extra_data_dumped

Boolean S Used internally by thedmarchive utility.

dump_object ID S Object ID of the dumprecord object associatedwith the dump procedurethat generated this dumpobject record object.

object_id ID S Object ID of the objectthat was copied from therepository.

version integer S Version stamp of thedumped object.


Dump Record

Dump Record

Purpose Contains information about a specific dump execution.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_dump_recordObject type tag: 2f

A dump record object contains information about a specific dump execution. The serveruses this information to start a dump execution. Additionally, some of the propertiescontain recovery information if the dump process is interrupted and must be restarted.

Note: To start a dump process, you create a dump record object and save it. Saving adump record object automatically starts the dump process. You must have Sysadmin orSuperuser privileges to create and save a dump record object.


Table 63. Properties dened for the dump record type


Description

dump_operation

string(255) S Dumps the entire repository if setto full_docbase_dump. If NULL,dumps only the types specified bythe type property.


Dump Record


Description

dump_parameter

string(255) R Defines parameters for the dumpoperation, such as the cache size orcontent compression. Valid valuesare:

• compress_content=T|FT directs the operation tocompress the content. The defaultis F.

• cache_size=integerinteger defines the cache sizein megabytes

file_name string(255) S Name of the external file that thesystem is writing the dump into.

include_content Boolean S Indicates whether or not to includethe actual content files in the dumpfile. The default is false.

predicate string(255) R Predicate expression that specifieswhich objects of the specified typesare dumped.

predicate2 string(255) R Extends the predicate expressiondefined in the predicate propertyat corresponding index levels.For example, predicate2[0], ifdefined, is concatenated at the endof predicate[0] when the dump isexecuted.

r_current_object_count

integer S Number of objects dumped. This isupdated continuously throughoutthe process, as objects are copied tothe file.

r_current_pos integer S Position in the dump file at whichyou wrote the last entry, if file is lessthan 2 GB.


Dump Record


Description

r_current_root_count

integer S Indicates how many of the objectsqualified by the predicate have beendumped. This is constantly refreshedduring the dump process as thetypes specified in the predicate aredumped.

r_end_time TIME S Time at which the dump ended.

r_is_complete Boolean S Set at the completion of the dumpoperation. Values are:

T (TRUE), meaning the operationcompleted successfully

F (FALSE), meaning the operationterminated due to an error

Note: The value is NULL if the dumprecord object was created prior toupgrading to version 5.3.

r_is_more Boolean S This value is set when r_is_completeis set to T. Valid values are:

T (TRUE), meaning the dumpoperation completed because it hitthe objects_per_transfer limit, butthere are more objects to dump

F (FALSE), meaning that the dumpoperation completed and there areno more object to dump.

The value of this property isundefined if r_is_completed is set toF (FALSE).

r_root_count integer S Number of objects qualified by thepredicate.

r_start_time TIME S Time at which the dump was started.


Dump Record


Description

type string(33) R Identifies the types to be dumped.(Note that the predicate and typerepeating properties are associatedin that the predicate in position x isapplied to the type in position x, thepredicate in position y is applied tothe type in position y, and so forth.)

r_current_offset string(20) S Position in the dump file at which theserver wrote the last entry if file is 2GB or greater.


Email Message

Email Message

Purpose Stores the content of an email message.

DescriptionSupertype: DocumentSubtypes: NoneInternal Name: dm_email_messageObject type tag: 09

An email message object stores an electronic message as content. Any user can createan email message object.

Note: This is a deprecated object type.


Table 64. Properties dened for the email message type


Description

date_received Date S The date and time at whichthe message was received.

date_published Date S Date and time on which themessage was sent.

media_type string(32) S Identifies what kind ofmessage this is. Forexample, possible values areemail, IM (instant message),note, or calendar.

message_identifier string(32) S The unique messageidentifier provided bythe messaging system.

other_recipients string(48) R Message recipientsidentified in the CC list.


Email Message


Description

originating_org string(128) S The sender of the message

recipients string(48) R Message recipientsidentified in the To list.


Esign Template

Esign Template

Purpose Stores a signature page template as content

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_esign_templateObject type tag: 09

An esign template object is used to store a signature page template in the repository.A default signature page template is provided with Content Server, and you can createcustom signature page templates. Each template is represented in the repository byone esign template object.


Table 65. Properties dened for the esign template type


Description

append_to_body Boolean S Whether to append orpre-pend the signature pageto the content. T (TRUE)means to append thecontent. F (FALSE) means topre-pend the content. Thedefault is F.

begin_tag string(1) S Identifies the beginningdelimiter for tags on thesignature page template.The default is <.

document_type string(32) R Names of the object typesthat can be signed using thetemplate.


Esign Template


Description

end_tag string(1) R Identifies the endingdelimiter for tags on thesignature page template.The default is >.

max_signatures integer S Defines the maximumnumber of signatures thatmay added to a particularversion of the object. Thedefault is 0. There is noupper limit.


Expr Code

Expr Code

Purpose Stores generated expression source code and pcode.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmi_expr_codeObject type tag: 58

An expr code object stores generated expression source code and pcode. Content Servercreates and manages expr code objects. Users cannot create them.


Table 66. Properties dened for the expr code type


Description

i_type_name string(32) S Name of the type on whosebehalf the source code andpcode are collected.

parent_id ID S Object ID of an aggrdomainobject. Used internally bydump and load operations.


Expression

Expression

Purpose Stores information needed to execute expressions defined in the data dictionary.

DescriptionSupertype: PersistentObject Subtypes: Func Expr, Literal Expr, Builtin ExprInternal name: dm_expressionObject type tag: 52

An expression object stores information needed to execute expressions defined in thedata dictionary. Expression objects are created and managed by Content Server andcannot be created by users.


Table 67. Properties dened for the expression type


Description

expression_name string(32) S Currently unused.

For the current release, thisis always NULL.

expression_text string(255) R The text of the expression.If the expression text isgreater than 255 characters,the first 255 characters areput in expression_text[0],the second 255 inexpression_text[1] andso forth.


Expression


Description

expression_type integer S The data type of theexpression.

If the expression subtype isliteral expr or builtin expr,valid values are:

0, Boolean1, Integer2, String3, ID4, ,Time/Date5, Double

For the func expr subtype,valid values are:

0, Boolean1, Integer3, ID

parent_id ID S Object ID of the aggrdomain or policy object thatreferences the expressionobject.


External File Store

External File Store

Purpose Represents an external file store.

DescriptionSupertype: External StoreSubtypes: NoneInternal name: dm_extern_fileObject type tag: 61

An external file store object represents an external file store. The server uses external filestore objects to locate content stored in external file stores.

PropertiesTable 68, page 216, lists the properties defined for dm_extern_file.

Table 68. Properties dened for the external le store type


Description

a_config_name string(64) R Name of the serverconfig object to use fora_location[position].

a_location string(64) R Name of a location objectto be used as root_name fora_config_name[position].

def_client_root string(64) S Name of the client-specificlocation object. Default isNULL.

def_server _root string(64) S Name of the server-specificlocation object. Default isNULL.


External Free Store

External Free Store

Purpose Represents an external storage area accessed through a user-defined content token.

DescriptionSupertype: External StoreSubtypes: noneInternal name: dm_extern_freeObject type tag: 63

The external free store object type allows you to specify a token for content retrieval andstorage that does not follow the standard for external file store or external URL store.You define your own token standard and means of retrieving the content associatedwith the token.

Configuration of plug-in properties for the external free store type is fully under thediscretion of users. Depending on the accessibility of the content, users decide whetherto run the plug-in on the server or client.

PropertiesThe external free store object type inherits all its properties from its supertype. Noproperties are defined specifically for it.


External Store

External Store

Purpose Represents an external storage area accessible to the server but whose physicalcontents are stored outside the server.

DescriptionSupertype: StoreSubtypes: External File Store, External URL Store, External Free StoreInternal name: dm_extern_storeObject type tag: 60

An external store object represents an external storage area accessible to the serverbut whose physical contents are stored outside the server. An external store objecteliminates the need to transfer the content from client to server during a save operation.All subtypes of dm_extern_store operate in token mode.

PropertiesTable 69, page 218, lists the properties defined for the external store object type.

Table 69. Properties dened for the external store type


Description

a_content_static Boolean S Controls how getFilemethods behave whenfetching content if the storagearea is an external storagearea. For an explanation ofthe behavior, refer to theContent Server AdministrationGuide.

The default is F.


External Store


Description

a_exec_mode Boolean S Controls where to executethe plug-in. FALSE directsthe DFC to execute theplug-in on the server host.This must be set to FALSEif the DFC is at Version 6 orlater.

TRUE is a deprecated valuefor this property. It executesthe plug-in on the clienthost. DFC Version 6 doesnot support executing theplug-in on the client host.

The default is FALSE

a_plugin_id ID R ID of the document whosecontent is the plug-in DLL(Windows) or shared library(UNIX). The storage typefor this document must bedm_filestore.

a_platform integer R Identifies the client platform.Valid values are:

1, for Windows2, for Solaris3, for AIX4, for HP-UX5, for Macintosh6, for Linux7, for Itanium


External URL Store

External URL Store

Purpose Represents an external storage area whose content is accessed using a token thatfollows the URL standard.

DescriptionSupertype: External StoreSubtypes: NoneInternal name: dm_extern_urlObject type tag: 62

An external URL store object represents objects whose content is stored externally andaccessed using token-mode operation, in which the token follows the URL standard. Forthe external URL store object type, it is best to configure the plug-in for content retrievalto be executed on the client side. URLs are universal and can be accessed from anywhere.Content Server does not validate the URL.

PropertiesThe external URL store object type inherits all its properties from its supertype. Noproperties are defined specifically for it.


Federation

Federation

Purpose Contains the description of a federation.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_federationObject type tag: 5e

A federation object contains the description of a federation. Federation objects are createdand managed by Content Server when you create a federation using DocumentumAdministrator. Each repository belonging to a federation will have a federation objectthat describes the federation.


Table 70. Properties dened for the federation type


Description

r_govern_docbase string(120) S Name of the governingrepository in the federation.

This value serves as thedefault name of thefederation unless the object’sobject_name property isexplicitly set.

This property is set in thefederation objects for allmembers of the federation.


Federation


Description

r_govern_is_active Boolean S Indicates whether thegoverning repository isactive. If this is FALSE (thedefault), federation-relatedjobs cannot be executed.

This value is set only inthe federation object in thegoverning repository.

r_govern_suspended

Boolean S Indicates whethertransactions or changesto configuration objectscan occur in the governingrepository. The defaultis FALSE, meaningthat transactions areallowed. (This is usedto manage synchronizationand integrity betweenrepositories in thefederation while jobsare executing.)


r_member_docbases

string(120) R Names of the repositoriesthat belong to thefederation. Each namemust be unique within thelist.



Federation


Description

r_member_is_active

Boolean R Indicates whether themember repository isactive in the managementof configuration objects.The value at each indexlevel is associated withthe repository at thecorresponding index levelin r_member_docbases.

The default is TRUE,meaning that the repositoryparticipates.


r_member_refresh date R Indicates the last refreshdate of the configurationobjects in the memberrepositories. The dateat each index levelis associated withthe repository at thecorresponding index levelin r_member_docbases.


user_subtypes string(32) R dm_user subtypes topropagate.

The federation updatejob propagates usersrepresented by the userssubtypes listed in thisproperty (in additionto users represented bydm_user objects). Thesubtypes must exist on allmember repositories.


File Store

File Store

Purpose Contains information about a file store storage area.

DescriptionSupertype: StoreSubtypes: noneInternal name: dm_filestoreObject type tag: 28

A file store object contains information about a file store storage area. A storage areaof type dm_filestore is one of the most common types of file storage areas in a ContentServer installation. It is used to store files that have a wide variety of formats.


Table 71. Properties dened for the le store type


Description

is_public Boolean S Indicates if the area isaccessible to the publicwith no restrictions.Valid values are:1, for is accessible0, for is not accessible

root string(64) S Object name of the locationobject representing thisstorage area

use_extensions Boolean S Indicates whether servershould append a DOSextension to the file whenwriting it into the storagearea.


Folder

Folder

Purpose Used, in conjunction with cabinets, to organize the contents of your repository.

DescriptionSupertype: SysObjectSubtypes: Cabinet, Category, Room, Module, Topic,DSM Application, DSM Submission, XML ApplicationInternal name: dm_folderObject type tag: 0b

The folder object serves, in conjunction with cabinets, to organize the contents of yourrepository. All SysObjects and SysObject subtypes (except cabinets) must be storedeither directly in a cabinet or in a folder. Folders, in turn, are stored in cabinets or otherfolders. Ultimately, every SysObject or subtype is stored in a cabinet.

PropertiesTable 72, page 225, lists the properties defined for the folder type.

Table 72. Properties dened for the folder type


Description

i_ancestor_id ID R Object ID of the folders orcabinets that contain thisfolder directly or indirectly.

r_folder_path With Oracleand DB2:string(740)

With Sybase:string(600)

With SQLServer: seeDescription

R Folder paths for all locationsto which the folder is linked.

The length of this propertywill vary for SQL Servercustomers:

For a new SQL Serverrepository, the length is 450.

For an upgraded SQLServer repository not usingUnicode, the length is 765.


Foreign Key

Foreign Key

Purpose Describes the set of properties that define a foreign key.

DescriptionSupertype: Relation TypeSubtypes: NoneInternal name: dm_foreign_keyObject type tag: 65

A foreign key object describes the set of properties that define a foreign key. ContentServer creates foreign key objects when users define foreign keys for a type. Userscannot create foreign key objects.


Table 73. Properties dened for the foreign key type


Description

child_attributes string(32) R Names of the child keyproperties for the foreignkey.

parent_attributes string(32) R Names of the parent keyproperties for the foreignkey.


Format

Format

Purpose Records information about a file format recognized by Content Server.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_formatObject type tag: 27

A format object contains information about a file format recognized by Content Server.A predefined set of file formats is installed by default when a repository is configured.


Table 74. Properties dened for the format type


Description

a_page_plugin_name

string(255) S Name of the plug-in thatimplements the ability toretrieve designated pagesof content in this format.

Note: In this context,“pages” refers to thenumbered pages of thecontent, not the content’sposition within the filesassociated with an object.

asset_class string(32) S Identifies the kind of asset(video, audio, and so forth)represented by this format.This is used by applications.


Format


Description

can_index Boolean S Indicates whether thisformat can be full-textindexed. This propertyis set by an entry in aconfiguration file.

com_class_id string(38) S The class ID (CLSID)recognized by theWindowsregistry for a content type.

default_storage ID S Identifies the defaultstorage area for contentshaving this format.

description string(64) S User-defined description ofthe format.

dos_extension string(10) S The DOS extension to usewhen copying a file in theformat into the commonarea, client local area, orstorage.

filename _modifier string(16) S The modifier to append to afile name, to create a uniquefile name.

format_class string(32) R Content Server may set thisto either:• ft_always, meaningthat content files inthis format are alwaysindexed

• ft_preferred, meaningif there are multiplerenditions of the content,this format is thepreferred format forindexing

May be also be set toa user-defined value toidentify the class or classesof formats to which theformat belongs. Forexample, the xml, xsd, and


Format


Description

xsl formats belong to theXML and MSOffice classes.

icon_index integer S The index that locates theicon for the format in theicon resource file.

is_hidden Boolean S Used by someDocumentum clients.

mac_creator string(4) S Information used internallyfor managing Macintoshresource files.

mac_type string(4) S Information used internallyfor managing Macintoshresource files.

mime_type string(256) S The Multimedia InternetMail Extension (MIME) forthe content type.

name string(64) S Name of the format; forexample, doc or tiff.

richmedia _enabled Boolean S Indicates whetherthumbnails, proxies, andmetadata are generated forcontent in this format.

This is set to TRUE bydefault for the followingformats: jpeg, mpeg, pdf,gif, and avi.

It is FALSE for all otherformats by default.

topic_filter string(64) S Obsolete

topic_format ID S Obsolete

topic_format_name

string(64) S Obsolete


Format


Description

topic_transform Boolean S Indicates if it is necessary totransform the format beforeindexing

win31_app string(12) S Used by Documentumclients. It identifies theapplication to launch whenusers select a document inthe format represented bythe format object.


FT Index Agent Cong

FT Index Agent Cong

Purpose Stores information about an index agent.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_ftindex_agent_configObject type tag: 08

An ft index agent config object stores information about one index agent.

PropertiesTable 75, page 231, lists the property defined for the type plus two that are inheritedand used in a specific manner by this type.

Table 75. Properties dened for the ft index agent cong type


Description

active_connectors string(32) S Whether the index agentis running in normal ormigration mode. Validvalues are;

normal, indicating normalmode

reindex, indicatingmigration mode

If the property is not setor is blank, the default isnormal.

checkpoint_interval integer S Reserved for future use


FT Index Agent Cong


Description

connectors_batch_size

integer S Number of queue itemspicked up by the queuereader in each pollinginterval.

The default is 1000.

docbase_connector_wait_time

integer S Frequency, in seconds, atwhich the index agent pollsfor events

The default is 60.

exporter_queue_threshold

integer S Used to control additions tothe index agent’s internal,in-memory queue. If thenumber of objects in thequeue is equal to or exceedsthe value in this property,then no more objects maybe added to the queue.


exporter_thread_count

integer S Number of concurrentexporter threads being runby the index agent

The default is 3.

force_inactive integer S Indicates whether the agentis operating normally orshutdown and waiting for amanual start. Valid valuesare:

0, meaning the agent isoperating normally

1, meaning the server willnot start the agent untilthis property is set to 0manually.

The default is 0.


FT Index Agent Cong


Description

index_name string(64) S Name of the fulltext indexobject associated with thisindex agent.

indexer_queue_threshold

integer S Used to control additions tothe index agent’s internal,in-memory queue. If thenumber of objects in thequeue is equal to or exceedsthe value in this property,then no more objects maybe added to the queue.


object_name string(255) S This is an inheritedproperty. For ft index agentconfig objects, the valuemust be unique among allft index agent config objectsin the repository.

The default value forthe index agent installedwith Content Server ishostname_indexagentname.

queue_user string(64) S User name used by theindex agent to look forqueued items

The default isdm_fulltext_index_user.

r_fail_time Date S Reserved for future use

r_is_active integer S Whether the index agentis active or inactive. Validvalues are 0, meaning theagent is inactive, and 1,meaning the agent is active.

r_last_done_time Date S Reserved for future use

r_last_work_time Date S Reserved for future use


FT Index Agent Cong


Description

r_modify_date Date S This is an inheritedproperty. For ft indexagent config objects, thisis set to the last time theassociated index agentupdated the ft index agentconfig object.

r_start_time Date S Reserved for future use

r_stop_time Date S Reserved for future use

runaway_item_timeout

integer S How long a queueitem remains in theinternal queue before itis abandoned. The value isinterpreted in seconds.


save_queue_items integer S Whether successfullyprocessed queue itemsare saved or destroyed. 0means to mark successfullyprocessed queue items“done” and save them.1 means to destroysuccessfully processedqueue items.

The default is 1.

shut_down_requested

integer S Reserved for future use


FT Engine Cong

FT Engine Cong

Purpose Records configuration information for an index server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_ftengine_configObject type tag: 08

An ft engine config object stores the parameters necessary to use a particular index serverfor indexing or querying. There is one ft engine config associated with each fulltextindex object in a repository. Permissions to modify objects of this type are controlled bythe ACL named dm_fulltext_admin_acl.

Caution: Changing the values in the param_name or param_value propertiesmanually may result in undefined behavior during indexing or querying. It isrecommended that you do not change these properties unless told to do so bytechnical support.


Table 76. Properties dened for the FT engine cong type


Description

param_name string(64) R Names of the parameterspassed to the engine.

param_value string(255) R Values of the parameterspassed to the engine. Thevalue at each index positionis associated with the nameat the same index positionin param_name.


Fulltext Index

Fulltext Index

Purpose Represents a full-text index for the repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_fulltext_indexObject type tag: 3b

A fulltext index object represents the index associated with the repository. The object iscreated internally when a ’normal mode’ index agent is configured for the repository.Only the ft_engine_id property can be modified by a user. Superuser or Sysadmin userprivileges are required to change this property.


Table 77. Properties dened for the fulltext index type


Description

codepage string(64) S Identifies the code page inuse for strings sent to andreceived from the IndexAgent.

Typically, this is UTF-8.

ft_engine_id ID S Object ID of thedm_ftengine_config objectused for this index.

index_name string(64) S Name of the fulltext indexobject.

This must consist of ASCIIcharacters.


Fulltext Index


Description

install_loc string(32) S Name of the location objectthat identifies the locationof the fulltext installationfor this index.

The default nameis the value of thefulltext_location propertyin the server config object.

is_standby Boolean S Reserved for internal use.

r_content_count integer S Reserved for future use

r_index_type integer S Indicates the type of index.The default value is 4.

r_last_clean integer S Reserved for future use

r_last_update DATE S Time and date of the lastupdate for this index.


Func Expr

Func Expr

Purpose Stores the data dictionary information needed to execute expressions written in athird-party expression language.

DescriptionSupertype: ExpressionSubtypes: Cond ExprInternal name: dm_func_exprObject type tag: 55

A func expr object stores the data dictionary information needed to execute expressionswritten in a third-party expression language. Content Server creates and manages funcexpr objects. Users cannot create them directly.


Table 78. Properties dened for the func expr type


Description

attr_object_index integer R For each property inattribute_name, providesan index into the type_namelist that identifies the sourcetype of the property.

The value in attr_object_index[0] is theindex value to use forthe property specifiedin attribute_name[0].For example, ifattr_object_index[0] is 3,then the property specifiedin attribute_name[0]is taken from the typespecified in type_name[3}.


Func Expr


Description

attribute_name string(32) R List of property namesthat are passed to theexpression. The names arepassed in the order in whichthey are listed.

code_page integer R Content page numberin the object specified inroutine_id that contains thegenerated code.

Currently, this value isalways 1.

expression_kind integer S Indicates whether theexpression is a completeroutine or an expression.Valid values are:

1, Expression2, User routine

expression_lang integer S Identifies the language ofthe expression or routine.The only valid value is 1,meaning Docbasic.

object_alias string(128) R Identifies an alias foreach type named intype_name. The aliasesare used to map propertiesin the expression_text totheir associated types.The alias at each indexlevel is associated withthe type specified at thecorresponding index levelin type_name.


Func Expr


Description

repeat_attr_index integer R For each repeating propertyin attribute_name, thisprovides the index into theproperty’s list of values, toidentify the desired value.Valid values are:

0 or greater, Index intothe repeating property-2, Any valuein the property-3, All values in the property-4, First valuein the property-5, Last value in theproperty

For single-valuedproperties specifiedin attribute_name, thecorresponding value inrepeat_attr_index is always-1.

routine_id ID S Object ID of the SysObjectcontaining the source andpcode content pages.

routine_name string(255) S Name of the entry point inthe routine.

source_page integer S Content page numberin the object specified inroutine_id containing thesource code.

Currently, this value isalways 0.

type_name string(32) R Names of the object typesthat are the sources ofthe properties specified inattribute_name.


Group

Group

Purpose Contains information about a group in the repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_groupObject type tag: 12

A group object contains information about a group in the repository.

PropertiesTable 79, page 241, lists the properties defined for the group type.

Table 79. Properties dened for the group type


Description

alias_set_id ID S The object ID of an alias setassociated with the group.

description string (255) S User-defined description ofthe group.

globally_ managed Boolean S Indicates whether thegroup is globally or locallymanaged. The default isFALSE, meaning that it islocally managed.

Requires at least Sysadminprivileges to change.

group_address string(80) S Electronic mail address forthe group.

group_admin string(32) S Name of a user or groupwho can modify the group.


Group


Description

group_class string(32) S Indicates what kind ofgroup this group is. Validvalues are:• group• role• module role• privilege group• domain

group_directory_id ID S Object ID of the LDAPconfig object representingthe LDAP directory used tosynchronize this group.

group_display_name

string(255) S Name of the group as itappears in a room. Thename must be uniquewithin the room.

The default is thegroup_name.

group_global_unique_id

string(255) S Reserved for future use

group_name string(32) S Name of the group.

If group_class is set to role,then group_name is thename of the role.

If group_class is set todomain, then group_nameis set the name of thedomain.

The name must consist ofcharacters compatible withthe server os code pageof the Content Server andmust be unique among theuser and group names inthe repository.


Group


Description

group_native_room_id

ID S Object ID of the room thatcontains this private group.

group_source string(16) S Identifies the source of thegroup. The only valid valueis LDAP,meaning the groupwas created by importingan LDAP group.

groups_names string(32) R Names of any groups thatare users in this group.

i_all_users _names string(32) R List of all users in the group,including those users thatbelong to groups containedwithin the group.

This property value iscomputed when theproperty is first queriedin a session and cached onthe server and client.

i_nondyn_supergroups_names

string(32) R Names of the non-dynamicgroups to which this groupbelongs

i_supergroups_names

string(32) R Name of the group and allgroups that contain thisgroup.

is_dynamic Boolean S T (TRUE) means the groupis a dynamic group. F(FALSE) means the group isnot a dynamic group.

The default is F.


Group


Description

is_dynamic_default Boolean S Controls whether users inthe group’s list of potentialusers are consideredmembers of the group bydefault when they connectto the respository.

T (TRUE) means that usersare treated as membersof the group. F (FALSE)means that users are nottreated as group memberswhen they connect.


is_module_only Boolean S T means that this isa dynamic group towhich only privilegedBOF modules may addmembers.

is_protected Boolean S T means that this is adynamic group to whichonly authorized clientinstallations may addmembers.

Note: Client installationauthorizations are recordedin the client rights database.

is_private Boolean S Indicates whether the groupis private (T) or public (F).

owner_name string(32) S Name of the user or groupwho owns the group.

r_has_events Boolean S Whether someone hasregistered the group forauditing.

r_object_id ID S Object ID of the group.

users_names string(32) R Names of the directlycontained users in thegroup.


Index

Index

Purpose Stores information about an RDBMS index created in the repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_indexObject type tag: 1f

An index object stores information about an RDBMS index created in the repository.

PropertiesTable 80, page 245 lists the properties defined for the type.

Table 80. Properties dened for the index type


Description

attribute integer R Position of the propertiesbeing indexed in the type’sdefinition.

attr_count integer S Number of properties(columns) in the index

data_space string(64) S Name of the Oracletablespace or MS SQLServer or Sybase databasein which the index resides.

index_type ID S Object ID of the dm_typeobject that represents thetype being indexed.

is_unique Boolean S Indicates if the rows in theindex are unique

name string(64) S Name of the index. This isgenerated internally.


Index


Description

rebuilding Boolean S This is TRUE if the index iscurrently beingmoved fromone location to another.

repeating Boolean S Indicates whether theindex is built on the type’ssingle-valued propertytable or the repeatingproperty table. Values areF for the single-valuedproperty table and T for therepeating property table.

use_id_col Boolean S Used by server forserver-generated indexes.

use_pos_col Boolean S Used by server forserver-generated indexes.

use_tag integer R Used by server forserver-generated indexes.


Jar

Jar

Purpose Represents a jar file stored in the repository.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_jarObject type tag: 08

A jar object contains information about a jar file stored in the repository as the object’scontent. The object type is installed by a script when Content Server is installed.Instances of the type are created through Documentum Application Builder.


Table 81. Properties dened for the jar type


Description

jar_type integer S Identifies what type of jarfile this object represents.Valid values are:

1, meaning interface

2, meaning implementation

3, meaning both interfaceand implementation

minimum_vm_version

string(32) S Specifies the VM versionlevel required by this file.


Java Library

Java Library

Purpose Represents a third-party Java library stored in the repository.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_java_libraryObject type tag: 0b

Java library objects represent java libraries stored in the repository. Each objectrepresents one library. The object type is installed by a script when Content Server isinstalled. Instances of the type are created through Documentum Application Builder.


Table 82. Properties dened for the java library type


Description

sandbox_library Boolean S Indicates how the library isto be loaded

T (TRUE) means the libraryis loaded by the BusinessObject class loader.

F (FALSE) means the libraryloaded by the Shared classloader.


Job

Job

Purpose Used to run a program at regularly scheduled intervals.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_jobObject type tag: 08

A job object represents a program that you want to run at regularly scheduled intervals.A job object stores information about the program, such as the name of the methodobject for the program, how often or when to run it, the number of times the programhas been run, the date of its last execution, and so forth. Programs represented by jobobjects are launched by a special utility called the dm_agent_exec utility, which is itselfstarted by Content Server.


Table 83. Properties dened for the job type


Description

a_continuation_interval

integer S Indicates how often tore-invoke the job, inminutes. If set to a numbergreater than zero, the jobis automatically re-startedafter the specified interval.The default is 0.

a_current _status string(255) S Contains status informationprovided by the applicationor program run by the job.


Job


Description

a_is_continued Boolean S Indicates whether thecurrent execution of the jobis a result of an automaticre-invocation of the job.The default is FALSE.

a_iterations integer S Number of times the jobhas been invoked andcompleted.

a_last_completion date S Contains the date and timewhen the last invocation ofthe job was completed.

a_last_document_id

ID S Object ID of the statusdocument created for thelast invocation of the job.

a_last_invocation date S Contains the date and timewhen the last invocation ofthe job was started.

a_last_process_id ID S The process id of thelast-launched dm_method.

a_last_return_code integer S Return status of the lastdm_method executed.

a_next_continuation

date S Date of next automaticinvocation of the job. Thedefault is NULLDATE.

a_next_invocation date S Computed time of nextinvocation.

a_special_app string(32) S This property is inheritedfrom dm_sysobject. It isset by the server when thejob is checked out by thedm_agent_exec utility forexecution.

expiration_date date S Date and time on which thejob expires. The job willnot be executed after thespecified date and time.The default is NULLDATE.


Job


Description

inactivate_after_failure

Boolean S Indicates if the job isinactive due to failure. Thedefault is FALSE.

is_inactive Boolean S Indicates whether the job isunavailable for execution.The default is FALSE,which indicates that the jobcan be executed.

max_iterations integer S Maximum number of timesto execute the job. Thedefault is 1. A value of zero(0) indicates that there is nomaximum.

method_arguments

string(255) R Arguments to pass to themethod.

These arguments arepassed only if thepass_standard_argumentsproperty is set to F.

method_data string(255) R Used by procedureassociated with job. Thisproperty is available forthe program to write/readas needed during itsexecution.

method_name string(255) S Name of the method toinvoke when the job isexecuted. This is a requiredproperty.

method_trace_level

integer S Controls tracing for themethod.

Any value other than 0turns on tracing. 0, thedefault, turns off tracing.

object_name string(255) S Name of the job object.This is inherited fromdm_sysobject.


Job


Description

pass_standard_arguments

Boolean S T means that the standardarguments are passed to themethod and the argumentsin method_arguments arenot passed.

(The standard argumentsare: -docbase_name repos-itoryname.serverconfig-user_name username-job_id jobid-method_trace_levelmethodtracelevel)

F means that the standardarguments are not passedto the method, butthe arguments in themethod_arguments valueare passed instead.

The default is F.

run_interval integer S Used in conjunction withrun_mode to determinehow often to invoke the job.For example, if you enter3 for this property and 4for run_mode, the job isinvoked every three weeks.The default is zero (0).

run_mode integer S Used in conjunction withrun_interval to determinehow often to invoke thejob. Run_ mode specifiesthe unit of measure for thevalue in run_interval. Validvalues are:

1, for every x minutes2, for every x hours3, for every x days4, for every x weeks5, for every x months7, for every x day of week


Job


Description

8, for every x day of month9, for every x day of year

x is the value in run_interval

The default value is zero(NULL).

run_now Boolean S If set to T, the job isexecuted the next time theagent exec program pollsthe repository.

start_date date S Date and time of the firstrequired invocation. This isa required property.

target_server string(255) S Specifies a particular serverto run the job. Specifythe server name using theformat:

repository[.server_config_name] [@machine]

The default value isNULLSTRING.


Job Request

Job Request

Purpose Used internally by Documentum Administrator.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_job_requestObject type tag: 08

A job request object records information needed by Documentum Administrator toexecute certain jobs. Users cannot create these objects manually.

Caution: Users, or applications, must not modify these objects. However, theymay be deleted if request_completed is T, indicating that the associated job hasbeen invoked.


Table 84. Properties dened for the job request type

Property Datatype Single/rRepeating Description

arguments_keys string(255) R Internal keys usedin conjunction witharguments_values.The key at anyparticular indexposition is usedin conjunctionwith the value atthe correspondingindex position inarguments_values.

arguments_values string(255) R Argument valuespassed to the job.


Job Request

Property Datatype Single/rRepeating Description

job_name string(255) S Name of therequested job

method_name string(255) S Name of the methodinvoked by the job

priority integer S A priority valueinternally assignedby DocumentumAdministrator

request_completed Boolean S Whether the job hasbeen executed. Tmeans the job hasbeen invoked. Fmeans the job isawaiting execution.


Job Sequence

Job Sequence

Purpose Identifies a job that belongs to a set of jobs executed in a particular sequence.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_job_sequenceObject type tag: 08

A job sequence object stores information about a job that belongs to a set of jobs executedin a particular sequence. Sequenced jobs are executed using the dm_run_dependent_jobsmethod, which can be invoked by another, controlling job or on the command line. Jobsequence objects are created using Documentum Administrator.

PropertiesTable 85, page 256, lists the properties defined for the object type and the one inheritedproperty that has a specific use for job sequences.

Table 85. Properties dened for the job sequence type


Description

job_display_name string(255) S Reserved for useby DocumentumAdministrator

job_docbase_name string(255) S Identifies the respositoryin which the job resides.This string is used to matchan entry in the repositoryconnection file if that file isused.

Valid values for this stringare:

repository_name

repository_name.content_server_name

repository_name@host_name


Job Sequence


Description

repository.content_server_name@host_name

job_id ID S Object ID of the job

job_login_domain string(255) S Login domain of theuser identified injob_login_user_name

job_login_user_name

string(32) S Login name of the user aswhom the job identified injob_id will run

object_name string(255) S This inherited propertymust be set to the nameof the job sequence thatincludes the job identifiedin this job sequence object.

predecessor_id ID R Identifies the job or jobs thatmust complete successfullybefore the job specified injob_id is run.

The jobs are identified bytheir object IDs.

This property may beempty.


Key

Key

Purpose Contains information describing a key for an object type.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_keyObject type tag: 59

A key object contains information describing a key for an object type. Content Servercreates key objects when users define keys for a type. Users cannot create key objects.


Table 86. Properties dened for the key type


Description

is_unique Boolean S Indicates whether the key isa unique key.

key_attributes string(32) R Names of the properties inthe key definition.

type_name string(32) S Name of the objecttype containing the keyproperties.

parent_id ID S Object ID of an aggrdomainobject. Used internally bydump and load operations.


LDAP Cong

LDAP Cong

Purpose Stores the set-up values that configure a repository’s use of an LDAP-compliantdirectory server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_ldap_configObject type tag: 08

An ldap config object stores the set-up values that configure a repository’s use of anLDAP-compliant directory server. The set-up values are defined through DocumentumAdministrator when the repository is set up to use the LDAP directory server. Settingthe values in an ldap config object requires Superuser user privileges.

PropertiesTable 87, page 259, lists the properties defined for the ldap config type.

Table 87. Properties dened for the LDAP cong type


Description

a_last_run date S Used internally

a_last_no string(20) S Used internally

bind_dn string(255) S A distinguished name forbinding

This is a required property.

bind_pwd string(32) S Password for the bindingname



LDAP Cong


Description

bind_type string(16) S Defines the binding modeused to authenticate LDAPusers. Valid values are:

bind_search_dn, whichuses the user’s operatingsystem name to find theDistinguished name forauthentication.

bind_by_dn, which usesthe Distinguished namestored in the user’suser_ldap_dn propertyto perform authentication.

certdb_location string(255) S Name of the location objectthat points to the locationof the certificate databasedirectory.

deactivate_user_option

Boolean S TRUE causes thesynchronization job toset users to inactive inthe repository if they areinactivated in the DirectoryServer; FALSE disables therepository update. Thedefault is FALSE.

failover_ldap_config_ids

ID R Object IDs of the ldapconfig objects representingthe LDAP directory serversused as secondary (failover)servers for this LDAPdirectory server.


LDAP Cong


Description

failover_use_interval

time S Defines the length of timeduring which ContentServer uses a secondaryLDAP directory server foruser authentication beforeattempting to contact theprimary LDAP directoryserver.

The default is 5 minutes.

first_time_sync Boolean S Whether the LDAPdirectory must performa first-time synchronizationof the users and groups inthe respository that matchusers and groups in thedirectory.

T means to perform sucha synchronization. Fmeans not to performthe synchronization. Thedefault is F.

group_obj_class string(64) S Identifies the object classof groups, as defined inthe LDAP directory server.This is optional. The defaultis groupofuniquemembers.

grp_search_base string(256) S Defines the startingpoint in the directoryserver’s schema for groupsearches. (Refer to thedocumentation providedby the directory servervendor for informationabout search bases.)


LDAP Cong


Description

grp_search _filter string(256) S Defines a filter for groupsearches. (Refer to thedocumentation providedby the directory servervendor for informationabout the format of a filterspecification.)

import_mode string(7) S Controls whether LDAPsynchronization isperformed for users,groups, or both. Validvalues are: user, group, andall. The default is all.

ldap_host string(128) S The host name of themachine on which theLDAP directory server isrunning. This is required.

map_attr string(32) R Identifies object propertiesthat are set when the useror group is imported intothe repository.

The property at a particularindex position is set to thevalue identified at the sameindex position in map_val.

map_attr_type string(32) R Object type for whichthe property identified atthe corresponding indexposition in map_attr isdefined.

map_const_attr string(32) R currently unused

map_const_val string(32) R currently unused


LDAP Cong


Description

map_rejection integer R Define the rejection rulefor a mapped property. Ifthe value mapped to theproperty fails to satisfythe rule associated withthe property, the user orgroup entry is rejected andis not synchronized in therepository. Valid valuesare:• 0, meaningsynchronization alwaysoccurs even if an LDAPattribute referenced inthe mapping is missing,empty, or does not havesufficient characters.

• 1, meaning thatsynchronizationdoes not occur if anLDAP attribute in themapping is missingor empty. However,synchronization willoccur even if an LDAPattribute in the mappinghas fewer charactersthan specified in themapping.

• 2, meaning thatsynchronization doesnot occur if an LDAPattribute referenced inthe mapping is missing,empty, or has fewercharacters than specifiedin the mapping.

Note: For mandatoryproperties (both users andgroups), the map rejection


LDAP Cong


Description

value is automatically set to2 and cannot be changed.

map_val string(64) R The name of a Directoryserver property or ahard-coded value to whichthe property identified inthe corresponding indexposition in map_attr ismapped.

map_val_type string(1) R Indicates whether the valuein the corresponding indexposition in map_val is aDirectory Server attributename, an expression, or anactual value. Valid valuesare:

A, meaning the value is aDirectory Server property

E, meaning the value is anexpression

V, meaning the value anactual value

per_search_base string(256) S Defines the startingpoint in the directoryserver’s schema for usersearches. (Refer to thedocumentation providedby the directory servervendor for informationabout search bases.)

per_search _filter string(256) S Defines a filter for usersearches. (Refer to thedocumentation providedby the directory servervendor for informationabout the format of a filterspecification.)


LDAP Cong


Description

person_obj _class string(64) S Identifies the object classof users as defined in theLDAP directory server.This is optional. Thedefault is person.

port_number integer S The port number on theLDAP directory server’shost machine whichContent Server will useto communicate with thedirectory server.

rename_group_option

Boolean S TRUE updates groupnames in the repositoryduring synchronization ifthey have changed in theDirectory Server; FALSEdisables this option. Thedefault is FALSE.

rename_user_option

Boolean S TRUE updates user namesin the repository duringsynchronization if theyhave changed in theDirectory Server; FALSEdisables this option. Thedefault is FALSE.

retry_count integer S Defines the number oftimes Content Server willattempt to contact theLDAP directory serverbefore reporting that itcannot connect.

The default is 3.

retry_interval time S Defines the time intervalthat must elapse beforeContent Server tries tocontact the LDAP directoryserver again.

The default is 5 seconds.


LDAP Cong


Description

ssl_mode integer S Whether LDAP userauthentication takes placeover a secure socketlayer (SSL). Values are 0,meaning SSL is not usedand 1, meaning that SSLwith server authenticationis used.

The default is 0.

ssl_port integer S Port number of the LDAPSSL port. The default is 636.

use_ext_auth _prog Boolean S TRUE directs ContentServer to use an externalpassword checkingprogram to authenticateLDAP users. FALSE directsthe server to authenticateLDAP users itself. Thedefault is FALSE.

user_subtype string(64) S Identifies the user’s objecttype if the user is a subtypeof dm_user.


Linked Store — Deprecated

Linked Store — Deprecated

Purpose A linked store object represents a storage area that links a common directoryaccessible to all clients and an actual file directory.

DescriptionSupertype: StoreSubtypes: NoneInternal name: dm_linkedstoreObject type tag: 2a

A linked store object contains information about the link between a common directoryaccessible to all clients and an actual file directory.

Caution: The linked store object type is deprecated as of Version 6.0. DFC Version 6does not support linked store storage areas.


Table 88. Properties dened for the linked store type


Description

link_location string(64) S Name of the locationobject that represents thedirectory that contains thelogical link.

symbolic_links Boolean S Indicates if the linksdefined in the link directoryare symbolic or hard links.TRUE indicates symboliclinks; FALSE indicates hardlinks.


Link Record — Deprecated


Purpose Contains information about established links to content storage areas.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_linkrecordObject type tag: 2b

A link record object contains information about established links to content storage areas.

Note: The dmi_linkrecord object type is deprecated. DFC Version 6 does not supportlinked storage areas nor, consequently, does it support or manage link record objects.


Table 89. Properties dened for the link record type


Description

parent_id ID S Object ID of the objectwith which the content isassociated.

component_id ID S Object ID of the contentobject associated with thecontent.

format_id ID S Object ID of the formatobject representing theformat of the contentfor which the link wasestablished.

data_ticket integer S Used internally to fetch andsave the content.

other_ticket integer S Used internally to fetch andsave the content.




Description

session_count integer S Number of sessions thatare accessing the contentstorage area identified bythis link record object.

session_id ID R Session IDs of the sessionsaccessing the contentstorage area.


Literal Expr

Literal Expr

Purpose Describes a literal value that is an integer, string, Boolean, ID, or date datatype.

DescriptionSupertype: ExpressionSubtypes: NoneInternal name: dm_literal_exprObject type tag: 53

A literal expr object describes a literal value that is an integer, string, Boolean, ID, or datedatatype. Literal expr objects are created and managed by Content Server and cannotbe created by users.

Note: A date literal value specified in a literal expr object cannot require a patterndefinition.

PropertiesThe literal expr type has no defined properties. All of its properties are inherited from itssupertype, dm_expression.


Load Object Record

Load Object Record

Purpose Records information about objects that have been loaded from a dump file intoa repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_load_object_recordObject type tag: 32

A load object record object contains information about one object that has been loadedfrom a dump file into a repository.


Table 90. Properties dened for the load object record type


Description

extra_offset string(20) S Position in the dump file atwhich the server wrote thelast entry, if file is 2 GB orgreater.

extra_pos integer S Specifies the position in thedump file where you canfind additional informationabout the object. This isexpressed as the numberof characters from thebeginning of the file.

file_offset string(20) S Position in the dump file atwhich the server wrote thelast entry, if the file is lessthan 2 GB.


Load Object Record


Description

is_synonym Boolean S Indicates if the new_idalready exists in the newrepository. This is usedfor objects such as contentstorage areas and partitions,where you do not want tocopy the old object into thenew repository, but merelyuse a matching object in thenew repository.

load_object ID S Object ID of the load recordobject that contains theinformation about thedump file containing theloaded object.

new_id ID S Object ID of the loadedobject in the new repository.

old_id ID S Object ID of the loadedobject in the old repository.


Load Record

Load Record

Purpose Stores information about dump files that are being loaded into a new repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_load_recordObject type tag: 31

A load record object stores information about a dump file that is being loaded into a newrepository. You can use the information in a load record object, in conjunction with theinformation in the associated load object record objects, to restart the loading processif it is interrupted.


Table 91. Properties dened for the load record type


Description

file_name string(255) S Name of the dump file thatyou are loading.

load_operation string(255) S Used internally.

load_parameter string(255) R Defines parameters forthe load operation. Validparameters are:

preserve_replica=T|F

generate_event=T|F

generate_event is TRUEby default. Setting itto F (FALSE) turns offnotification to the fulltextindex user for the save event


Load Record


Description

when an object is loadedinto the target repository.

predicate string(255) R Used internally.

r_offset string(20) S Used internally to managethe load operation andobjects created during theload.

relocate Boolean S If set to TRUE, this directsthe server to assign newobject IDs to all the objectsin the dump file duringthe load process. If setto FALSE, this directs theserver to use the objects’previous IDs. The default isTRUE.

r_end_time date S Date and tBooleanime atwhich the load processended.

r_first_phase Boolean S Indicates whether the loadprocess has completed thefirst phase.

r_position integer S Indicates how far into thedump file the load processhas gone. This value isupdated continually as theload process proceeds.

r_start_time TIME S Time at which the loadprocess was started.

type string(33) R Used internally.


Location

Location

Purpose Records a file system location for a specific file or directory.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_locationObject type tag: 3a

A location object contains a file system location for a specific file or directory. The serveruses the information in location objects to find the files and directories that it needsfor successful operation.


Table 92. Properties dened for the location type


Description

file_system_path string(255) S Specifies the actual locationof the directory or filerepresented by the locationobject. The specification’ssyntax must be appropriatefor the machine on whichthe server resides.

For example, if the serveris on a Windows host,the specification must beexpressed as a Windowspath specification. If on aUNIX host, the specificationmust be a UNIX path.

The directory path andname must consist of ASCIIcharacters.


Location


Description

mount_point_name

string(32) S Identifies the mount pointunderneath which thislocation resides. Use thename of the mount pointobject that describes themount point.

no_validation Boolean S Identifies whetherapplications create a locationobject. If set to TRUE, theserver does not validate thedirectory path specified byfile_system_path and doesnot create the directory.

The default is FALSE.

object_name string(255) S Name of the location object.The name must be uniqueamong the location objectsin a repository.

This property is inheritedfrom its SysObjectsupertype, but is includedhere because its setting hasspecfiic requirements for thelocation type.

path_type string(16) S Indicates whether thelocation represents adirectory or a file. Legalvalues are directory and file.

security_type string(32) S Defines the security levelapplied to the directoryor file. Legal values are:public_open, public, andprivate. The default settingis private.


Locator

Locator

Purpose Stores a Documentum Resource Locator (DRL), which points to an object ina repository.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_locatorObject type tag: 08

A locator object stores a Documentum Resource Locator (DRL), which points to an objectin a repository. The DRL is stored in the one property defined for the type.

PropertiesTable 93, page 277, lists that property.

Table 93. Properties dened for the locator type


Description

resource_locator string(255) S Contains a text string thatresolves to an object in arepository.


Media Prole

Media Prole

Purpose Stores a transformation profile as content.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_media_profileObject type tag: 08

A media profile object stores a transformation profile as content. Transformation profilesare XML documents that describe the transformations that can be performed on content,to change one format to another. A default set of profiles is provided when a ContentTransformation Server product is configured for the repository. Additional profilescan be created by system administrators.


Table 94. Properties dened for the media prole type


Description

cmd_file_paths string(255) R Used internally byDocumentum ContentTransformation Services

filter_names string(32) R Identifies the filter usedinternally, within ContentTransformation Services.Valid values are:

CTSProduct

Public


Media Prole


Description

filter_values string(64) R Specifies whether thetransformation is viewablein the WDK transformationwizard. Valid values are:

An acronym representing aCTS product

System

Public

related_objects_only

Boolean S Indicates whether a specifictransformation can onlystore the target file as a newobject or whether it canstore the target as either anew object or as a rendition.

T means that the target mayonly be stored as a newobject.

F means that the target maybe stored as either a newobject or a rendition.

source_formats string(64) R Names of the sourceformats identified in thetransformation profile.

src_object_type string(32) R Object types of the sources

target_formats string(64) R Names of the targetformats identified in thetransformation profile.

The format named inany given index positionin source_formats canbe transformed to theformat identified in thecorresponding indexposition in target_formats.


Message Address

Message Address

Purpose Records all unique, full email addresses for an email message.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dm_message_addressObject type tag: 00

A message address object records a unique email address found in the header of an emailmessage. A unique address is an address not currently represented in the repositoryby another message address object. Each time a unique address is found in an archivedmessage, a message address object is created to record the address. Message addressobjects are primarily used by personal and compliance archiving applications.


Table 95. Properties dened for the message address type


Description

addr_id string(16) S Hash value of the emailaddress

addr_type string(2) S Identifies the kind of emailmessage. Valid values are:

0, meaning Exchange emailmessage

1, meaning SMTP emailmessage

2, Lotus Notes emailmessage

email_addr string(1024) S Fully qualified emailaddress of the user


Message Address


Description

friendly_name string(128) S User’s name as it appearsprepended to the fullemail address. This nametypically appears in doublequotes prior to the actualemail address in anglebrackets.

mail_user string(128) S User’s name as it appears inthe actual email address.

primary_domain string(512) S Primary domain of the emailaddress

sub_domain string(512) S Subdomains in the emailaddress


Message Archive

Message Archive

Purpose Stores an email message.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_message_archiveObject type tag: 09

A message archive object is used to store an email message. The header information inthe message is stored in the object’s properties and the actual content of the messageis stored as content. Message archive objects are primarily used by personal andcompliance archiving applications.


Table 96. Properties dened for the message archive type


Description

attachment_count integer S Total number of messageattachments in the emailmessage

datamodel_version string(6) S Used internally to managedata model changes


Message Archive


Description

is_archive_message string(1) S Identifies whether themessage is an “archive”message. Valid values are:

0, meaning the message isnot an archive message

1, meaning the message isan archive message, and themessage_id is deterministic.

Archive messages areimmutable. Non-archivemessages may be edited,and the message_id is setinternally and is unique tothis message.

message_class string(1) S Identifies the class ofmessage represented by themail message object. Validvalues are:

0, meaning email message

1, meaning contact

2, meaning appointment

message_doctype string(1) S Identifies the kind of emailmessage. Valid values are:

0, meaning MAPI mailmessage

1, meaning SMTP message

2, Lotus Notes emailmessage

message_id string(64) S Email message identifier


Message Archive


Description

message_importance

string(1) S The level of importance ofthe email message. Validvalues are:

0, normal

1, low

3, medium

5, high

message_link_count

integer S Link number in a SysObjectchain

message_sensitivity string(1) S Specifies the sensitivity ofthe message. Valid valuesare 1 to 255.

message_size integer S Size of the complete emailmessage, including headersand routing information, inbytes

message_subject string(256) S Subject line of the message

parent_message_id string (24) S Message identifier of theroot message if this messageis an embedded message.

receive_date Date S GMTdate and time at whichthe message was received

sent_date Date S GMTdate and time at whichteh message was sent.

tracking_id string(2000) S Used internally to trackmessage source


Message Attachment

Message Attachment

Purpose Records names of attachments on email messages.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_message_attachmentObject type tag: 00

Amessage attachment object records the names of attachments sent with email messages.The attachments represented by this object type are bound to the parent email messageby the value in the message_object_id property. Message attachment objects are createdwhen an email message that has an attachment is archived. Message attachment objectsare primarily used by personal and compliance archiving applications.


Table 97. Properties dened for the message attachment type


Description

attachment_name string(512) S Attachment file name

attachment_position

integer S Order of the attachmententry

format_name string(64) S Name of the attachment’sformat

message_object_id string(16) S Object ID of the messagearchive object representingthe email message towhich this attachment wasattached


Message Route

Message Route

Purpose Records routing information from an email message.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_message_routeObject type tag: 00

A message route object is created when an email message is archived. Message routeobjects store the routing information found in the To, From, bcc, and cc lists. Eachobject records one address in the message. Message route objects are primarily used bypersonal and compliance archiving applications.


Table 98. Properties dened for the message route type


Description

addr_id string(16) S Hash value of the emailaddress

message_object_id ID S Object ID of the messagearchive object representingthe email message thatcontains this email address

route_bit_flags string(1) S Used internally


Message Route


Description

route_type string(1) S Identifies the source of theemail address. Valid valuesare:

1, meaning To

2, meaning From

3, meaning cc

4, meaning bcc

5, meaning Distributed list

6, meaning any other source

route_user_data_hash_id

string(16) S Object ID of a dm_message_route_user_data object.

This property may beempty.


Message Route User Data

Message Route User Data

Purpose Stores route-specific user information for a particular email message.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_message_route_user_dataObject type tag: 00

A message route user data object records route-specific user information for an emailmessage. Message route user data objects are primarily used by personal and compliancearchiving applications.


Table 99. Properties dened for the message route user data type


Description

hash_id string(16) S Hash value generated forthe user_data and user_idpairs for a given route

user_data string(256) R Key name

user_tag string(256) R Key value

The value at a particularindex position is associatedwith the key name atthe corresponding indexposition in user_data.


Message User Data

Message User Data

Purpose Records application-specific information about a user referenced by an archivedmessage.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_message_user_dataObject type tag: 00

A message user data object records application-specific information about a userreferenced in an archived message. Message user data objects are created when anemail message is archived. The objects are primarily used by personal and compliancearchiving applications.


Table 100. Properties dened for the message user data type


Description

message_object_id string(16) S Object ID of the messagearchive object that containedthe email address.

user_data string(2000) S Application-specificinformation about theuser identified in user_tag.

user_tag string(64) S Tag name assigned to theuser by the application


Metamodel

Metamodel

Purpose

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_metamodelObject type tag: 08

A metamodel object records information about a Smart Container model. The contentof a metamodel object is the XML representation the metamodel. These objects are thebuilding blocks for Smart Container, and must never be deleted from a repository. Eachmetamodel object has an associated dm_logical_version aspect. Each also has an aspectnamed dm_metamodel_version where version is the version number of the metamodelcontained as content.

This object type is installed with the Smart Container DAR file during repositoryconfiguration.

PropertiesThere are no properties defined for the type. It inherits all properties from its supertype.


Method

Method

Purpose Represents an external procedure that is invoked through the DO_METHODfunction using either the DQL EXECUTE statement or the Apply method.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_methodObject type tag: 10

A method object represents an external procedure that is invoked through theDO_METHOD function using either the DQL EXECUTE statement or the Apply method.


Table 101. Properties dened for the method type


Description

launch_async Boolean S Indicates whether theprocedure is to runasynchronously or not.

If this is set to TRUE and themethod is launched on theapplication server, settingSAVE_RESPONSE on toTRUE on the command lineis ignored.

This property setting isignored if the method islaunched on the methodserver or Content Serverand SAVE_RESULTS is setto TRUE on the commandline. The method is alwayslaunched synchronously.


Method


Description

launch_direct Boolean S Used by Content Server.This is ignored whenthe method executed onthe application server ormethod server.

Controls whether theprogram is executed by theoperating system’s systemor exec API call. If set toTRUE, the server uses theexec call to execute theprocedure. In such cases,the method_verb must be afully qualified path name. Ifset to FALSE, the server usesthe system call to executethe procedure.

Note: If SAVE_RESULTSis set to TRUE on thecommand line, the serverignores the setting oflaunch_direct and alwaysuses the system call toexecute the procedure.

method_args string(255) R List of command linearguments for theprocedure. Not currentlyused.

method_type string(32) S If you are executing themethod using ContentServer or the method serverand the executable is storedas content for the method,then setting this to dmawkor dmbasic, directs theserver to add -f in front ofthe file name and to pass allarguments specified on theDO_METHOD commandline to the program.


Method


Description

If you are executing themethod on an applicationserver, set this to java.

method_verb string(255) S Command-line nameof the procedure or thename of the interpretivelanguage that will executethe program file.

Use dmbasic if the programis written in Docbasic.

OnWindows, use dmawk32if the program is writtenin dmawk. On UNIX, usedmawk if the program iswritten in dmawk.

Use the namespace in whichto launch the method ifthe method is executing onthe application server. Forexample:

com.foo.<package_name>.<class>

or

fooPayMethod

run_as_server Boolean S If set to TRUE, it indicatesthat you want the methodto run as the server account.The default is FALSE.

run_as_server must beTRUE to execute a methodon the method server orapplication server.


Method


Description

success_return_codes

integer R Valid values for thea_last_return_codeproperty of the job.

If this is set, thea_last_return_codeproperty must be set toone of these values or thedm_run_dependent_jobsmethod assumes that thejob failed.

The property is set to 0 forreplication jobs.

The property is ignored if itis not set.

success_status string(255) S Defines the valid valuefor a_current_status in thecompleted job.

If set, the job’sa_current_status propertyvalue must match thesuccess_status valueafter the job completes.If it does not, thedm_run_dependent_jobsmethod considers the job tohave failed.

For replication jobs, thevalue is set to “ReplicateOperation Complete.”

The property is ignored if itis not set.

timeout_default integer S The default time-out for thisprocedure. Used if no othertime-out is specified on thecommand line. The defaultis 60 seconds.


Method


Description

timeout_max integer S The maximum time-outthat you can specify onthe command line for thisprocedure. The default is300 seconds.

timeout_min integer S The minimum time-outthat you can specify onthe command line for thisprocedure. The default is 30seconds.

trace_launch Boolean S Controls whether internaltrace messages generatedby the executing programare logged.

If set to TRUE, the messagesare put in the session log. Ifset to FALSE, the messagesare not logged. This isFALSE by default.

Notes:

If trace_launch is TRUEand SAVE_RESULT is setto TRUE on the commandline, the trace output is putinto the result document.

If the method is executingon the applicationserver, the trace recordsinformation about themethod launch. Internaltrace messages are storedin a result document ifSAVE_RESULTS is set toTRUE.


Method


Description

use_method_content

Boolean S Indicates whether theprogram that you want torun is stored as contentin the method object or asan external file. Set this toTRUE if you have specifiedan interpretive languagefor method_verb and theprogram you want to runis stored as the method’scontent. Set this to FALSEif method_verb contains afull file path to a programor script.

The value is ignored if themethod is executing on anapplication server.

use_method_server

Boolean S Whether to use the MethodServer or Application Serverto execute Dmbasic or Javamethods. TRUE means touse the Method Server orapplication server. FALSEmeans to use the ContentServer.

If this is TRUE, the valueis used in conjunction withthe value of method_type todetermine which server touse.

Setting this propertyrequires Superuserprivileges.


Module

Module

Purpose Represents a business object module.

DescriptionSupertype: FolderSubtypes: Aspect Type, Validation ModuleInternal name: dmc_moduleObject type tag: 0b

A module object stores information about one business object module. The name of themodule is recorded in the object_name property of the module object. The name must beunique. Module objects are stored in the repository in /System/Modules/module_type,where module_type is the value also found in the a_module_type property of themodule.

The object type is installed by a script when Content Server is installed. Instances of thetype are created and managed through Documentum Application Builder.


Table 102. Properties dened for the module type


Description

a_bof_version string(32) S Version level of the BOFmodule. This is defined bythe module’s creator.

a_interfaces string(255) R Fully qualified classnames of the interfacesimplemented by the BOFmodule


Module


Description

a_is_privileged Boolean S Indicates whether themodule is a privilegedmodule. T means that themodule is privileged. Fmeans that the module isnot a privileged module.

a_module_type string(32) S Identifies the typeof the module. Foruser-defined modules,the a_module_type valueis also user defined.Modules provided by EMCDocumentum typicallyhave one of the followingvalues:

TBO

SBO

Aspect

Note: Module objects thathave Aspect as the moduletype are created and usedinternally only.

a_privilege_roles string(32) R List of the roles that can usethis module.

a_req_module_interfaces

string(255) R Object IDs of the dmc_jarobjects associated withthe modules identifiedin req_module_names.The IDs at a particularindex position areassociated with the moduleat the correspondingindex position inreq_module_names.

Multiple object IDs at oneindex position are separatedby commas.


Module


Description

contact_info string(256) S Contact information abouta party who can provideinformation about thismodule. This value isuser-defined.

implementation_technology

string(32) S Identifies the technologyused to create the module.

min_dfc_version string(32) S Identifies the minimumDFC version level requiredto implement this module.

The minimum value is 5.3.

module_description

string(255) S User-defined description ofthe module’s functionality

primary_class string(255) S The main implementationclass. For .NETimplementations, the valuemay consist of multiplecomma-separated values.

req_module_names string(64) R Names of modules onwhich this module depends


Module Cong

Module Cong

Purpose Identifies a business object module to the workflow Timer servlet.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_module_configObject type tag: 00

A module config object identifies a business object module to a workflow Timer servletand stores argument values used by the servlet. The object type is installed using ascript when Content Server is installed.

ProperitesTable 103, page 300, lists the properties defined for the type.

Table 103. Properties dened for the module cong type


Description

id_attr_name string(40) R Names of properties havingobject ID values to be usedby the servlet.

id_attr_value ID R Object IDs stored inthe properties in thecorresponding indexposition in id_attr_name.

r_aspect_name string(64) R List of BOF module names


Module Cong


Description

string_attr_name string(40) R Names of properties havingstring values to be used bythe servlet

string_attr_value string(2000) R Values of theproperties identified instring_attr_name. Thevalue in a particular indexposition is the vaue ofthe property identifiedin the correspondingindex position instring_attr_name.


Mount Point

Mount Point

Purpose Amount point object describes a mounted directory in a Content Server installation.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_mount_pointObject type tag: 3e

A mount point object describes a mounted directory in a Content Server installation.


Table 104. Properties dened for the mount point type


Description

file_system_path string(255) S Specifies the full pathlocation of the mount point.The specification’s syntaxmust be appropriate forthe machine on whichthe location resides. Forexample, if the locationis on a Windows host,the specification must be aWindowspath specification.

host_name string(128) S Identifies the machine onwhich this location resides.Use the machine’s hostname.


Mount Point


Description

mac_preferred_alias

string(32) S Defines the alias that youprefer the system to usewhen a Macintosh clientreferences the mount point.For example, a valid valuemight be Documentum.

object_name string(255) S Names the mount pointobject. This property isactually inherited fromits sysobject supertype.However, it is included herebecause you are required toset this property when youcreate a mount point object.

security_type string(32) S Specifies the security levelapplied to this directorylocation. Legal values are:public_open, public, andprivate. Defaults to privateif not explicitly set.

unix_preferred_alias

string(32) S Defines the alias that youprefer the system to usewhen the client referencesthe mount point.

When the server is a UNIXserver, you are not requiredto set this property.

win_preferred_alias

string(32) S Defines the alias that youprefer the system to usewhen a Windows clientreferences the mount point.For example, valid valuesmight be t:\ or k:\.


Network Location Map


Purpose Records information about network locations of client hosts.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_network_location_mapObject type tag: 08

A network location object describes the network location of client sites. Instances of theobject type are used to determine a user’s location relative to the Content Servers thatmight provide them with content.


Table 105. Properties dened for the network location map type


Description

begin_near_ip_address

string(80) R The beginning of the IPaddress range representingIP addresses near to thisnetwork location

Each index positionrepresents the beginning ofone range. The end of thatparticular range is recordedin the correspondingindex position inend_near_ip_address.




Description

default_netloc Boolean S Whether this networklocation can serve as adefault network locationfor a client, to be used whenno other mapping for auser’s IP address exists.

end_near_ip_address

string(80) R The end of the IP addressrange representing IPaddresses near to thisnetwork location

Each index positionrepresents the endof one range. Thebeginning of that particularrange is recorded inthe correspondingindex position inbegin_near_ip_address.

netloc_display_name

string(80) S User-defined display nameor description of thisnetwork location.

netloc_ident string(80) S User-defined uniqueidentifier for this networklocation.


NLS DD Info

NLS DD Info

Purpose Records locale-dependent data dictionary information for an object type orproperty.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_nls_dd_infoObject type tag: 4f

An nls dd info object holds locale-dependent data dictionary information for an objecttype or property. NLS DD info objects are created and managed by the server. Propertiesin nls dd info objects are set when users add or change data dictionary information. Eachnls dd info object contains the data dictionary information specific to one locale.

Not all nls dd info properties apply to both object types and properties. Some applyonly to properties.

PropertiesTable 106, page 306, lists the properties that are applicable to both object types andproperties. Table 107, page 307, lists the nls dd info properties that are applicable onlyto properties.

Table 106. Properties applicable to object type and properties


Description

comment_text string(255) S User defined.

foreign_key_msgs string(255) R The error message forforeign key constraintviolations.

help_text string(255) S User-defined help text forthe property or type.

label_text string(64) S User-defined label for theproperty or type.


NLS DD Info


Description



map_display_string


primary_key_msg string(255) S The error message forprimary key constraintviolations.

unique_key_msgs string(255) R The error message forunique key constraintviolations. The messageat any one index levelis displayed whenthe constraint at thecorresponding index levelis violated.

val_constraint _msg string(255) R The error message forvalue constraint violations.The message at any oneindex level is displayedwhen the constraint at thecorresponding index levelis violated.

Table 107. Properties applicable only to properties


Description

category_name string(64) S User defined.

def_value_length integer S Length, in characters, ofa typical value for theproperty. Zero indicates anunspecified (NULL) length.


NLS DD Info


Description

format_pattern string(64) S For date properties, thepattern to use for dateinterpretation.

format_pattern _tag integer S Currently unused.

(Currently, this is always 1.)



map_display_string


not_null_msg string(255) S The error message for NOTNULL constraint violations.

parent_id ID S Object ID of the aggrdomain object thatreferences the nls ddinfo object.


Note

Note

Purpose Represents an annotation for a document or other SysObject.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_noteObject type tag: 41

A note object represents an annotation for a document or other SysObject. The content ofthe annotation is stored in a content file associated with the note object.

PropertiesNote objects inherit all of their properties from their supertype, SysObject.


Other File

Other File

Purpose Contains information about resource fork files for Macintosh.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmi_otherfileObject type tag: 23

An other file object contains information about resource fork files for Macintosh.


Table 108. Properties dened for the other le type


Description

data_ticket integer S Value that tells the serverhow to access the file.


protocol integer S Value indicating theMacintosh access protocol


Output Device

Output Device

Purpose Contains a description of a printer that is accessible to users of the repository.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_outputdeviceObject type tag: 17

An output device object contains a description of a printer that is accessible to users ofthe repository.


Table 109. Properties dened for the output device type


Description

image_format string(64) S Specifies the format that theprinter uses to print images

os_name string(32) S Name of the printer asdefined in the /etc/printcapfile.

output_command string(128) S Contains the Unix printcommand sent to the printer

output_formats string(128) R Contains the formatssupported by the device.

output_mask string(64) S Contains the job numberof a queued print job, in aplatform-dependent mask.


Output Device


Description

remove_command string(128) S Contains the commandthat the server sends to theprinter to cancel a print job

status_command string(128) S Contains the commandthat the server sends whenthe user issues a Unix lpqcommand


Package

Package

Purpose Serves as a container for one or more documents (or other SysObjects) movingthrough a workflow.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_packageObject type tag: 49

A package object is used within workflows to deliver one or more documents (or otherSysObjects) from the output port of a source activity to the input port of a destinationactivity. Packages are generated by the server from the properties of the activitydefinition. Users cannot create or modify package objects.


Table 110. Properties dened for the package type


Description

i_acceptance_date date S Records the date and timewhen a package arrived andwas accepted by an inputport.

i_package_oprtn string(64) S Contains a value copiedfrom the package definitionupon creation of a package.

i_package_order integer S Represents the orderof where its associatedpackage definition appearsin the containing portdefinition.


Package


Description

r_act_seqno integer S Contains the sequencenumber (r_act_seqno) ofthe activity in which thepackage is being handled.

r_component_chron_id

ID R Chronicle ID of theobject identified at thecorresponding indexposition in r_component_id.

r_component_id ID R Object IDs of the boundobjects.

r_component_name

string(80) R Object names of thebound objects. Thename at a particular indexposition is the name ofthe object identified inr_component_id at the sameindex position.

Whether this property isset is configurable. It isnot set by default. Refer toContent Server Fundamentalsfor more information.

r_note_flag integer R Identifies when a note wasadded to the package andhow to handle the note inactivity transitions. Validvalues are:

0, Note added prior toactivity; discard at nexttransition

1, Note added prior toactivity; retain in nexttransition

2, Note added duringthis activity; send to nextactivity and then discardduring transition fromthatactivity


Package


Description

3, Note added duringthis activity; retain insubsequent transitions

r_note_id ID R Contains the ID of adm_note object.

r_note_writer string(32) R Contains the name of theuser who made notes.

r_package_flag integer S Indicates whether thepackage is visible to theactivity and whether it isallowed to be empty. Thevalue is copied from ther_package_flag property inthe activity object.

Valid values are:

0, meaning the packageis invisible but cannot beempty

1, meaning the package isvisible and cannot be empty

2, meaning the package isinvisible but may be empty

3, meaning the package isvisible and may be empty

r_package_label string(32) R Contains a version label, ifany.

r_package_name string(16) S Contains the package name.

r_package_type string(40) S Contains the real type nameof the bound components.


Package


Description

r_port_name string(16) S Contains the name(port_name) of the portof the activity run-timeinstance in which thepackage is being handled.

r_workflow_id ID S Contains the object ID of thecontaining workflow.


Plugin

Plugin

Purpose A plugin object represents a plugin library used by Content Server.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_pluginObject type tag: 67

Content Server uses plug-in libraries to access external storage areas, includingcontent-addressed storage, and for some forms of user authentication.


Table 111. Properties dened for the plugin type


Description

a_hw_platform string(255) R Hardware architecture onwhich the plugin is running.

The value is user defined.For example, a value mightbe Intel x86 or Sun SPARCPower PC

a_op_sys string(255) R Identifies the operatingsystem on which the pluginis running.


Plugin


Description

a_usage string(255) S Description of the plugin’suse.

a_plugin_type string(255) S Indicates the type of plugin.

The value is user-defined.Some example values are:

batch fileBourne shell scriptC-shell scriptDLLdocbasic executablejavajava scriptslso


Policy

Policy

Purpose A policy object contains the definition of a lifecycle.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_policyObject type tag: 46

Policy objects record lifecycle definitions.


Table 112. Properties dened for the policy type


Description

action_object_id ID R Object ID of thedm_procedure thatimplements state actions.All properties specifiedin the procedure must bedefined in the primary type.

This is unused ifjava_methods is T.

alias_set_ids ID R List of the object IDs of thealias set objects representingacceptable alias sets for thelifecycle.

allow_attach Boolean R Indicates whether adocument can be attachedto this state.The defaultvalue is false.


Policy


Description

allow_demote Boolean R Indicates whether the objectcan be demoted from thisstate. The default value isFalse.

allow_schedule Boolean R Indicates whether a statetransition event (such aspromote, demote, suspend,or resume event) can bescheduled when this stateis the current state of thesysobject. The default valueis true.

app_validation_id ID S Identifies the procedureobject that validatesthe lifecycle. Ifapp_validation_ver isset, then app_validation_idcontains the chronicle ID ofthe produre object.


app_validation_ver string(32) S Version of theobject identified inapp_validation_id.


entry_criteria_id ID R Object ID of thedm_func_expr thatimplements the entrycriteria. All propertiesspecified in the expressionmust be defined in theprimary type of this policyobject. The source code forall expressions defined forthis policy object are storedon page 0 of the policy’scontent, and all p-code isstored on page 1.


Policy


Description

exception_state string(32) R Name of the exception state,if any. Optional for normalpolicy states. Ignored forexception states.

extension_type string(32) S Name of the extension typeused for the lifecycle.

i_state_no integer R A 0-base internal integernumber which uniquelyidentifies a state. Everytime a new state is added,the highest number in thestate chain plus one is used.This value, not the statename, is used in sysobjectto record current state andresume state.

include_subtypes Boolean R Indicates whetherall subtypes of thetype specified in thecorresponding position ofincluded_type are included.Possible values are:• false (all subtypes areNOT included)

• true (all subtypes areincluded)

The property is always truewhen the object is created.

included_type string(27) R The acceptable object types.The first position stores theprimary type associatedwith this policy object. Thelater positions are validsubtypes of the primarytype. At least one value isrequired.


Policy


Description

java_methods Boolean S Whether the entry criteria,actions, and validationmethods are implementedin Java. T means they arewritten in Java. F meansthey arewritten inDocbasic.

r_definition_state integer S Status of the policy object.Possible values are:

0, meaning draft1, meaning validated2, meaning installed

The property is always 0when the object is created.

return_condition integer R Used when return_to_baseis TRUE to identify whichoperations return an objectto the policy’s base state.Valid values are:• 0, return to base state onCheckin or Save

• 1, return to base state oncheckin

• 2, return to base state onSave

• 4, return to base state onSaveasnew

• 8, return to base state onBranch


To identify multipleoperations, sum theintegers. For example,if you want to return to thebase state on Checkin orSaveasnew, set the propertyto 5.


Policy


Description

return_to_base Boolean R TRUE returns an object tothe base state when theoperations identified inthe corresponding indexposition in return_conditionare performed.

The setting in each indexposition applies to the statein the corresponding indexposition in state_name.

For a Checkin or Branchmethod, the affected objectis the new version. For aSaveasnew, the affectedobject is the new copy. Fora Save, the affected object isthe saved object.

The base state’s entrycriteria and actions areapplied to the object whenit is returned to base. Ifthe entry criteria are notmet, the method fails. Ifthe actions fail, the objectremains in the base state.

FALSE means to leave theobject in the current state.

The default value is FALSE.

state_class integer R Indicates whether the stateis a normal state (with value0), or an exception state(with value 1). The defaultvalue is 0.

state_description string(128) R Purpose of the state.


Policy


Description

state_name string(32) R Name of the state. Uniquewithin the policy definitionto which the state belongs.A state name must startwith a letter and cannotcontain colons, periods, orcommas.

state_type string(32) R Name of the state typedescribing the state atthe corresponding indexposition in state_name.

system_actions ID R Object ID of tcf activityobject describing asequence of actions throughmodules implementing theIDfLifecycleAction interface

This is only set ifjava_methods is T.

type_override_id ID R Object ID of dm_aggr_domain which contains thetype override informationprepared bydata dictionary.This property controlsproperties of the document(whether properties areread-only, or hidden, and soon) when the document isin this state.

user_action_id ID R Object ID of thedm_procedurethat implementsuser-defined actions, ifthe user_action_ver isunspecified; chronicle ID,otherwise. All propertiesspecified in the proceduremust be defined in theprimary type.



Policy


Description

user_action_service string(128) R Names of the moduleobjects implementing theuser actions


user_action_ver string(32) R The version labelof user_action_id.If unspecified, theuser_action_id is the idof the dm_procedure thatcontains user-definedactions. Otherwise, theuser_action_id is thechronicle id. Togetherwith user_action_id, thisproperty allows users toassociate a late bound useraction object with a lifecycle.


user_criteria_id ID R Object ID of thedm_procedure thatimplements theuser-defined entry criteriafor the state identified atthe corresponding indexposition in state_name. Allproperties specified in theprocedure must be definedin the primary type.


user_criteria_service

string(128) R Names of the moduleobjects implementing theentry criteria



Policy


Description

user_criteria_ver string(32) R The version label ofuser_criteria_id. Ifspecified, the specifiedversion of the procedureidentied in user_criteria_idis used. If a versionlable is not specified,the version identifiedin user_criteria_id isused. Together withuser_criteria_id, thisproperty allows users to latebind an entry procedurewith a lifecycle.


user_postproc_id ID R Object ID of thedm_procedure thatimplements theuser-defined procedureexecuted after entry intothe state identified inthe corresponding indexposition in state_name.

This property may beused in conjunction withuser_postproc_ver, tolate-bind a particularversion of the procedureto the lifecycle state.For information aboutlate-binding, refer toContent Server Fundamentals.



Policy


Description

user_postprocessing_service

string(128) R Names of the moduleobjects implementing thepost-processing actions


user_postproc_ver string(32) R Version labels identifyingwhich versions of theprocedures specified inuser_postproc_id are to beexecuted.

The label at a particularindex position is appliedto the procedure identifiedat the correspondingindex position inuser_postproc_id.

Setting this property for aparticular procedure allowsyou to late-bind a particularversion of a procedure tothe lifecycle state. For moreinformation, refer to ContentServer Fundamentals.


user_validation_service

string(128) R Names of the moduleobjects implementing uservalidation



Preset Info

Preset Info

Purpose Relates a preset to a folder.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_preset_infoObject type tag: 37

A preset info object relates a preset to a folder and records information about how andwhen the preset should be updated when changes occur to the folder. This object type isinstalled with the Preset DAR file during repository configuration.


Table 113. Properties dened for the preset info type


Description

copy_source_id ID S If the related folder wascreated by a copy operation,this property records theobject ID of the sourcefolder

is_dirty Boolean S Indicates that a change wasmade to the folder thatrequires a change to thepreset of the folder

preset_package_id ID S Object ID of the preset forthe folder

preset_repository_path

string(255) S Specifies the location of thepresets for this folder


Preset Package

Preset Package

Purpose

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmc_preset_packageObject type tag: 09

A preset package object records the preset configurations for a particular scopecombination. This object type is installed with the Preset DAR file during repositoryconfiguration.


Table 114. Properties dened for the preset package type


Description

last_modifier string(32) S User name of the user wholast modified the object.This is the name of theactual user who initiatedthe change through thePresetService.

last_modifier_repository

string(32) S Name of the repositoryto which the user wasconnected when the presetwas modified


Preset Package


Description

locked_by string(32) S If a preset is checkedout, this property recordsthe name of the userwho initiated the changeto the preset throughPresetService.

scope_key string(32) S Key that represents theunique scope combinationto which the presetconfiguration applies


Procedure

Procedure

Purpose Procedure objects store Docbasic procedures that extend the behavior of theDocumentum clients.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_procedureObject type tag: 08

Docbasic is an interpretive language that you can use to write applications to extend orcustomize the behavior of Documentum clients or Content Server. Depending on wherethey are stored in the repository, procedures can be executed automatically, when a userconnects to a repository, or on demand, when users select a menu item. Users must haveat least Read permission on the procedure object to execute it.


Table 115. Properties dened for the procedure type


Description

user_runnable Boolean S Indicates whether theprocedure is ready for use.


Process

Process

Purpose A process object contains the definition of a workflow process.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_processObject type tag: 4b

A process object is created when a user creates a workflow definition in either WorkflowManager or Process Builder. There are three inherited properties that are reserved forinternal use for process objects: a_special_app, a_status, and a_application_type.

PropertiesTable 116, page 332, describes the properties of the process type.

Table 116. Properties dened for the process type


Description

act_choose_by string(128) R Identifies by name theactivity whose performerwill choose the performerfor the activity in thecorresponding index positionin act_choose_for.

act_choose_for string(128) R Identifies by name theactivity whose performer willbe chosen by the performerof the activity named at thecorresponding index positionin act_choose_by.


Process


Description

act_choose_name string(128) R A user-defined namethat links the performerschosen by the performerof the activity in thecorresponding index positionin act_choose_by to otheractivities.

act_performer_from

string(128) R Name of the activity fromwhich the performer orperformers of the activityin act_performer_to areselected.

act_performer_rule integer R Indicates whether theactivity identified inact_performer_to isperformed by the lastperformer or all performersof the activity identified inact_performer_from. Validvalues are:

0, meaning the activitynamed in act_performer_tois performed by thelast performer of theactivity identified inact_performer_from.

1, meaing the activitynamed in act_performer_tois performed by allthe performers of theactivity identified inact_performer_from.

act_performer_to string(128) R Name of the activity whoseperformers are selectedaccording to the rule definedin act_performer_rule.

calendar_id ID S reserved for future use

execution_flag integer S reserved for future use


Process


Description

is_private Boolean S Indicates whether thedefinition is private or public.The default is private.

package_control integer S Controls whetherContent Server sets ther_component_name propertyof a package object when thecomponent name is identifiedin the Addpackage method.

Valid values are:• 0, to allow the server to setthe r_component_nameproperty to the componentname

• 1, to require the server toset the property to a blank


The value in package_controlis only effective if the docbaseconfig property namedwf_package_control_enabledis set to T.

perf_alias_set_id ID S Contains the object ID ofthe alias set object used toresolve performer aliaseswhen a workflow based onthis process definition iscreated.

r_act_def_id ID R Contains the object IDs ofthe activities (dm_activityobjects) defined for thisprocess.


Process


Description

r_act_name string(128) R Contains the activity names.The name at each indexposition corresponds to theactivity identified at thecorresponding index positionin r_act_def_id.

r_act_priority integer R Indicates the importanceof the activity comparedto other activities in thisprocess. The priority ateach index position isassigned to the activitydefined in r_act_def_id atthe corresponding indexposition.


r_act_type integer R Indicates the type of theactivity identified at thecorresponding index positionin r_act_def_id. Valid valuesare:

0, for step (default)1, for begin2, for end3, for exception4, for initiate

r_definition_state integer S Indicates the state of theprocess definition. Validvalues are:

0, for draft1, for validated2, for installed

r_link_dest_act string(128) R Identifies the destinationactivity for the link.

r_link_dest_port string(16) R Indicates the input port ofthe destination activity.

r_link_name string(16) R Uniquely identifies the link.


Process


Description

r_link_src_act string(128) R Identifies the source activityfor the link.

r_link_src_port string(16) R Indicates the output port ofthe source activity.

sd_element_acl ID R Object IDs of the ACLsassociated with thestructured data elementobjects for this process. TheACL identified at each indexposition is associated withthe structured data elementinstance identified at thecorresponding index positionin sd_element_name.

sd_element_default_acl

ID S The default ACL used foran structured data elementwhen there is no ACLspecified in sd_element_idfor the element.

sd_element_default_value

string(2000) R Default value for simplestructured date elementtypes. The value in thisproperty at a particularindex position correspondsthe type identified in thecorresponding position in thesd_element_type property.

If the type is a simple typebut is not a string datatype,the value is converted to astring before being stored inthis property.

If the type is not a simpletype, the value in thisproperty is an empty string.


Process


Description

sd_element_name string(255) R Names of the structureddata elements. Each namemust be unique among thenames of other structureddata elements and packageswithin the process.

sd_element_options

integer R Indicates whether to removethe runtime instance of thestructured data elementwhen the workflow isfinished. Valid values are:

0, remove the structured dataelement instance (default)

1, keep the instance

The value at each indexposition is associated withthe structured data elementinstance identified at thecorresponding index positionin sd_element_name.

sd_element_parent_id

ID R List of the object IDs of thewfsd element parent objectsthat serve as the parents ofstructured data elements forthis process.

The object ID at each indexposition is the parent for thestructured data element at thecorresponding index positionin workflow definition.

sd_element_type ID R Object IDs of the wfsd typeinfo objects that identify thedatatypes of the structureddata element.

The ID at each index positionis associated with thestructured data elementinstance identified at thecorresponding index positionin sd_element_name.


Process Correlation Set


Purpose Stores information about a correlation set.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_process_correlation_setObject type tag: 37

A process correlation set object records information about a correlation set defined for aworkflow definition. A correlation set defines what data will be used to communicatebetween the Process engine and external applications at runtime. The object type isinstalled by a script when Content Server is installed.


Table 117. Properties dened for the process correlation set type


Description

correlation_set_alias

string(255) R Alias names used for thiscorrelation set.

The name can be either avalid package name or astructured data elementdefined for the process.

correlation_set_attr string(2000) R Names of the propertiesreferenced in the correlationset.

The property specified ata particular index positionmust be referenced by thecorrelation set identifiedin the corresponding




Description

index position incorrelation_set_alias.


Public Key Certicate


Purpose Used to decrypt instructions encrypted using a private cryptographic key.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_public_key_certificateObject type tag: 08

A public key certificate object stores a public key certificate. A public key certificate isused by ACS and BOCS servers to decrypt the instructions sent by Content Server inresponse to a request for content from an ACS or BOCS server. A public key certificate isalso used to authenticate DFC instances.

Public key certificate instances are created automatically by Content Server. Public keycertificate objects are stored in the /System/Cryptographic/Keys folder, and are protectedby the dm_acl_superusers ACL.

Caution: Public key certificate objects are for internal use only. Do not modify,remove, or add these objects.


Table 118. Atributes dened for the public key certifcate type


Description

certificate_value string(1900) S Base 64-encoded DERcertificate

key_identifier string(40) S Base 64-encodedSHA1 digest of theDER public key




Description

key_type integer S Identifies what thekey is used for byContent Server. Thevalid values are:

1, meaning used forACS encryption

2, meaning used forDFC authentication

3, meaning used forBOCS authentication

private_key_identifier string(40) S Base 64-encodedSHA1 digest ofthe DER publickey value in thedm_cryptographic_key.key_identifierproperty.

This propertyis empty if thekey_value is 2.


Qual Comp

Qual Comp

Purpose A qual comp object represents a component routine.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_qual_compObject type tag: 08

Component routines are written in a language compatible with the platform on whichthey will be executed. They are used by client applications.


Table 119. Properties dened for the qual comp type


Description

available_offline Boolean S Currently unused.

class_name string(64) S Specifies the functionalityprovided by thecomponent; for example,checkin or checkout.

client_capability integer S Indicates who can use thecomponent. Valid valuesare:

0, meaning no one can use1, for consumer2, for contributor3, for consumerand contributor4, for coordinator5, for coordina-tor and consumer6, for coordina-


Qual Comp


Description

tor and contributor7, for consumer, contrib-utor, and coordinator8, for administrator9, for administra-tor and consumer10, for administra-tor and contributor11, for administrator, con-tributor, and consumer12, for administra-tor and coordinator13, for administrator,coordinator, and consumer14, for contributor, coordi-nator, and administrator15, for all users

If there is no value specifiedfor this property, then anyuser can use the component.

component_obj_id ID S Object ID of the componentobject associated with thequal comp object.

is_global Boolean S TRUE indicates that thecomponent is executableat all times. The user isnot required to select anobject before executing thecomponent.

FALSE indicates thatthere must be a currentlyselected object to executethe component.


Qual Comp


Description

nls_label string(255) S Currently unused.

valid_groups string(32) R Names of groups whoseusers can use thiscomponent.

If there are no values,any user may use thiscomponent. If there areone or more groups named,users must belong to oneof the groups to use thecomponent.


Query

Query

Purpose A query object stores a DQL query as content.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_queryObject type tag: 0a

Query objects are used by Desktop Client™. Their content files are saved DQL queriesthat a user can execute by selecting them from a menu. Users can create query objectsin Desktop Client or through the API. To execute a saved query, a user must have atleast Read permission on the query object.

PropertiesThe Query type has no defined properties. It inherits all of its properties from itssupertype, SysObject.


Queue Item

Queue Item

Purpose A queue item object stores information about an object placed on a user’s queue.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_queue_itemObject type tag: 1b

A queue item object records information about tasks and other objects queued to aspecific user’s Inbox. Tasks are typically queued to a user when that user is selected asthe performer of a workflow task. Users and applications can query queue item objectsdirectly.


Table 120. Properties dened for the queue item type


Description

a_content_type string(32) S File format to use whenopening the objectassociated with the taskfrom the inbox.

a_operations string(16) S User-defined

actual_start_date Date S Actual date that the task isstarted. This is set when thetask is acquired.

content_type string(32) S Not used for work items.

date_sent Date S The date the object was sent.


Queue Item


Description

delete_flag Boolean S Indicates whether thepeer work item has beencompleted or if the eventhas been delivered orprocessed.

0 (false) if not completedor delivered or 1 (true) ifcompleted or processed.

dependency_type string(10) S Records the circumstancesof the work item’s creation.Valid values are:

0, meaning Normal.Standardwork item creation(default)

1, meaning Revert. Itemcreated by reverting aprevious task

2, meaning a resolutionerror occurred while tryingto resolve an alias for anormal activity.

3, meaning Revert andresolution error. Item wasreverted and resolutionerror occurred for revertactivity.

4, meaning Delegated. Theitem was created whenperformer of previoustask delegated the taskor when Content Serverautomatically delegatesthe task to the useridentified in the performer’sdelegated_user property.

5, meaning Repeated. Itemwas created when activityperformer chose to repeatthe activity, with anotherperformer.


Queue Item


Description

6, meaing Failedauto_delegation: Performerdoesn’t exist; performer isnot available and has noindicated replacement; theindicated replacement doesnot exist; or the replacementavailability turned off.

dequeued_by string(32) S Contains the name of theuser who completes thepeer work item or the nameof the user who dequeuedthe item, either explicitly orimplicitly.

dequeued_date Date S Contains the date and timethat the item was dequeuedor when an event wasdelivered and processed.

due_date Date S Date by which the taskor work item should becompleted.

event string(64) S A system- or user-definedevent

If dependency_type is 4 andthe task was delegated bythe performer, this is setto dm_delegatedworkitem.If the dependency_typeis 4 and the task wasautomatically delegatedby the server, the event is“dm_startedworkitem.

i_event_flags integer S Used internally


instruction_page integer S Not used for work items


Queue Item


Description

item_id ID S For a workflow task, theobject ID of the peer workitem.

For events, the object ID ofthe object that generated theevent. For checkin events,this is the object ID of thenew version. For eventsqueued to workflows, thisis the workflow ID.

If the queue item wasgenerated by an Archivemethod, this is set to theobject ID of the objectselected by the method’spredicate. If the predicateselects multiple objects,item_id is set to NULL.

item_name string(255) S For a non-workflow event,the object name of the objectthat generated the event.

For a workflow event, theobject name of the processor workflow object thatgenerated the event.

Unused For workflow tasksor workflow-related events.

item_type string(32) S For a workflow task, theobject type of the peer workitem.

For an event, the object typeof the object that generatedthe event.

message string(255) S Message from the task’ssender to the personreceiving the queued item.


Queue Item


Description

name string(32) S Contains the name of theuser to whom the queueditem was sent.

next_tasks_type string(10) S Obsolete. Not used forwork items.

plan_start_date Date S Obsolete. Not used forwork items.

position integer S If the queue item representsa work item for a workqueue and the packageassociated with the workitem has a defined skilllevel, this property is setto the integer value of thatskill level.

priority integer S User or application-interpreted value thatdefines the item’s priority.

read_flag Boolean S Not used for work items.

remote_pending Boolean S Indicates whether the queueitem must be distributed toother repositories. TRUEmeans that the objectassociated with the queueitem must be sent to therepository defined intarget_docbase.

router_id ID S Object ID of the workflowthat contains the queuedtask.

sent_by string(32) S Name of the user that sentthe queued item. This is theuser’s Content Server username.

sign_off_date Date S Not used for work items.


Queue Item


Description

sign_off_required Boolean S Indicates if the task’s usermust sign off the task beforeforwarding the task.

sign_off_user string(32) S Not used for work items.

source_docbase string(120) S Name of the repositoryin which the queue itemoriginated.

This property has no valueif the queue item is not adistributed item.

source_event ID S Object ID of the queue itemin the source repository.

source_stamp integer S The i_vstamp value of thesource queue item object.

stamp ID S Object ID of the queue itemobject

If the queue item object is areplica, this is the object IDof the replica.

supervisor_name string(32) S Name of the workflow’ssupervisor.

target_docbase string(120) S Name of the repository towhich the queue item issent.

This property has no valueif the queue item is not adistributed item.

task_name string(128) S Contains the string event, ifthis is an event, or containsthe activity identifier if thisis a work item.


Queue Item


Description

task_number string(10) S For work items, thesequence number withinthe workflow of the activitythat generated the workitem.

task_state string(10) S Indicates the status of theevent, work item, or objectqueued for indexing.

The status of the eventor work item. One of:acquired, paused, orfinished.

If the queue item representsan object queued forindexing, the possiblevalues are:• blank, meaning the itemhas been queued butnot yet picked up by theindex agent

• acquired, meaning theindex agent has pickedup the object but not yetcompleted processing

• failed, meaning the itemfailed indexing andwill not be available forsearching

• warning, meaningcontent indexing failed,but metadata wasindexed

• done, meaning indexingof content and metadatawas successful.


Queue Item


Description

task_subject string(512) S For workflow events,constructed from the valuein dm_activity.task_subject.

For dm_save events, thisrecords the object IDs of theold and new storage areasif the object is saved with achange to a_storage_type.

For dm_move_contentevents, this records theobject IDs of the object andthe old and new storageareas.

For dm_destroy events, thisrecords the object ID of theobject’s storage area.

task_type string(10) S Not used for work items.


Reference

Reference

Purpose A reference object contains the information that links an object in a remoterepository to the local object that mirrors the remote object.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_referenceObject type tag: 47

Users never work directly with reference objects. Content Server or client applicationscreate them when users perform operations on remote objects.


Table 121. Properties dened for the reference type


Description

binding_condition string(32) S Identifies which version ofthe remote object to fetchwhen the object is accessedthrough its reference object.Valid values are:• EXACT_ID, whichdirects the server to fetchthe version that has theobject ID specified inreference_by_id.

• VERSION_LABEL,which directs the serverto fetch the versioncarrying the version labeldefined in binding_label.


Reference


Description

VERSION_LABEL is thedefault.

binding_label string(32) S Identifies the version tofetch for operations on theremote object when thevalue of binding_conditionis VERSION_LABEL.

The default version label isCURRENT.

i_external_rep Boolean S Indicates whether thereplication mode wasexternal. TRUE indicatesthat external replicationwas used.

i_global_vstamp integer S Version stamp of the remoteobject.

i_null_ref_flag integer S Indicates the status of theremote object. Valid valuesare:

0, meaning the object exists1, meaning theobject does not exist2, the object exists butno version matches thebinding condition

i_ref_acl_domain string(32) S Owner of the remoteobject’s ACL.

i_ref_acl_name string(32) S Name of the remote object’sACL.

i_ref_acl_vstsamp integer S Version stamp of the remoteobject’s ACL.


Reference


Description

i_replica_job_id ID S Object ID of the replicationjob that created the replica.

This only has a value if thereference object is the resultof a replication job.

i_replica_master ID S Object ID of the original(non-replica) object.

i_replica_source ID S Object ID of the replicatedobject. This value willbe the same as that ini_replica_master unless thereplicated object was itself areplica.

i_usage_count integer S The number ofsystem-created referenceobjects.

local_folder_link string(200) S Identifies the local folderto which the mirror objectis linked. If unspecified,this defaults to the user’sdefault folder.

r_last_refresh DATE S The time of the mirrorobject’s last refresh.

r_mirror_object_id ID S Object ID of the mirrorobject associated with thereference object.

r_next_refresh DATE S Next scheduled refreshtime for the mirror object.

r_ref_creator string(32) S Name of the referenceobject’s creator.

r_ref_object_id ID S Object ID of the actualremote object to which thereference object points.

r_ref_version_id ID S Object ID of the exactobject that last satisfied thebinding condition.


Reference


Description

r_reference_info string(32) S Indicates how the referenceis used. Valid values are:

LINK_REFERENCECHECKOUT_REFERENCEWORKFLOW_REFERENCEASSEMBLY_REFERENCEANNOTATION_REFERENCEREPLICA

r_refresh_status string(255) S Status of the last mirrorobject refresh.

reference_db_name

string(120) S Name of the repository thatcontains the remote object.

This propertymust be defined ifreference_by_name isused to define the versiontree containing the remoteobject. The property isoptional if reference_by_idis used to define the object’sversion tree.

reference_by_id ID S Object ID of the remoteobject.

This is used to identify theversion tree containing theremote object.

If the binding_condition’svalue is EXACT_ID, thenthis identifies the exactobject on the tree to whichthe reference points.

If binding_condition isVERSION_LABEL, thenthis value only identifiesthe version tree containingthe version specified inbinding_label.


Reference


Description

If reference_by_id isset, you cannot setreference_by_name.

reference_by_name

string(255) S Full folder path of theremote object.

If you set reference_by_name, you must also setreference_db_name.

Reference_by_nameand reference_by_id aremutually exclusive. Youcannot set both.

refresh_interval integer S Defines how often to pollthe repository to determineif the mirror object needs tobe refreshed. The value isspecified in minutes.

The default is one day.


Registered

Registered

Purpose A registered object contains information about an underlying RDBMS table that hasbeen registered with Content Server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_registeredObject type tag: 19

The information includes the names and datatypes of some or all of the columns in thetable and a list of those columns belonging to indexes. To create a registered object, youuse the DQL REGISTER statement. To destroy a registered object, use the UNREGISTERstatement.

Note: Registered objects are not updated automatically if the definition of theircorresponding RDBMS table changes.


Table 122. Properties dened for the registered type


Description

column_count integer S Number of columns in thetable.

column_datatype string(64) R List of the datatypes of thecolumns.

column_length integer R Lengths of the columns thathave a string data type.

column_name string(64) R List of the names of thecolumns in the table.

The names must consist ofASCII characters.


Registered


Description

group_table_permit

integer S Defines the RDBMS tablepermit level assigned to theregistered table’s group.

is_key Boolean R Indicates if an index is builton the column.

owner_table_permit

integer S Defines the RDBMS tablepermit level assigned to theregistered table’s owner.

synonym_for string(254) S Name of the table in theunderlying RDBMS (can bean Oracle table synonym, oran MS SQL Server or Sybasetable alias)

table_name string(64) S Name of the table.

The name must consist ofASCII characters.

table_owner string(64) S Name of the owner of theRDBMS table (the personwho created the RDBMStable).

world_table_permit

integer S Defines the RDBMS tablepermit level assigned to theworld.


Registry

Registry

Purpose A registry object contains information about a registered event.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_registryObject type tag: 26

Users can register to receive notification of an event’s occurrence. Users can also initiateauditing of events. Both actions generate registry objects.


Table 123. Properties dened for the registry type


Description

a_authentication integer S Defines whether anapplication shouldauthenticate the user beforethe event. Valid values are:• 0, meaning do notauthenticate

• 1, meaningauthentication required

This setting must beenforced by the application.Content Server ignores thisproperty value.


Registry


Description

a_esignature_required

integer S Whether the event requiresan electronic signaturecreatedwith Addesignature.The default value is 0,meaning FALSE, a signatureis not required. A value of1 means TRUE, a signatureis required.

This property value is notused by Content Server.It is for use by clientapplications.

audit_attr_names string(40) R Names of the properties tostore in the attribute_listproperty of the audit trailentry.

audit_subtypes Boolean S Whether to audit subtypesof the audited object type.

The audit_subtyes settingis used only if theregistered_id propertyidentifies an object type.

controlling_app string(32) S Identifies a particularapplication.

If set, only objects controlledby that application areaudited.

event string(64) S Name of the event.

message string(255) S For notifications, defines amessage to be sent to theuser with the notification.

For events, defines auser-friendly event name.

oneshot Boolean S Currently unused.


Registry


Description

policy_id ID S Chronicle ID of a lifecycle.

If set, only objects attachedto the lifecycle are audited.

policy_state string(32) S Name of a particular statein the lifecycle identified inpolicy_id.

If set, only objects in thatstate are audited.

priority integer S The event priority level.This is user-defined.

is_audittrail Boolean S Defines whether this is anotification or audit trailevent. Valid values are 0, fora notification event, and 1,for an audit event.

registered_id ID S Identifies the object or objecttype being audited or forwhich a user has registeredinterest.

For individual objects, thisis the chronicle ID of theobject.

For object types, this isthe object ID of the type’sdm_type object.

sendmail Boolean S Indicates whether to sendemail notification of theevent.

sign_audit Boolean S Whether Content Servermust sign entries generatedfrom this registration.

user_name string(32) S Name of the user thatregistered for the event orinitiated auditing.


Relation

Relation

Purpose Describes a relationship between two objects.

DescriptionSupertype: Persistent ObjectSubtypes: Category Assign, Aspect Relation, State Extension, Validation Relation,DSM Sect Doc Attributes, DSM Doc Properties, DSM Study ReportInternal name: dm_relationObject type tag: 37

A relation object describes a relationship between two objects. The properties identifythe objects and some behaviorial characteristics of the relationship.


Table 124. Properties dened for the relation type


Description

child_id ID S Identifies the object that isthe child in the relationship.

child_label string(32) S Version label of the specifiedchild_id. This is optional. Ifset, the child_id must be thechronicle ID for the child.

description string(255) S Not system defined.Provided for the user’sconvenience.

effective_date date S Not system defined.Provided for the user’sconvenience.

expiration_date date S Not system defined.Provided for the user’sconvenience.


Relation


Description


order_no integer S Not system defined. Thisis provided for the user’sconvenience. For example,this could be used to ordera set of relationships.

parent_id ID S Identifies the objectwhich is the parent inthe relationship.

permanent_link Boolean S Indicates if you want tomaintain the relationshipacross versions of the parentobject.

If the relation is created bya 5.3 DFC, this defaults tothe value of dm_relation_type.permanent_link. If therelation is created by theDMCL or a pre-5.3 DFC, thedefault is FALSE.

Note: This property isdeprecated in version 5.3.For more information, referto The permanent_link andcopy_child properties, page34.

relation_name string(32) S Identifies a valid relationtype object, which definesthe type of relationshipexisting between the twoobjects.


Relation SSA Policy

Relation SSA Policy

Purpose Describes the relationship between a SysObject object and a storage policy.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dm_relation_ssa_policyObject type tag: 37

A relation ssa policy object associates an ssa policy object, representing a contentassignment policy, with an object type. The object type must be a SysObject or SysObjectsubtype. Relationships between object types and ssa policy objects are created throughDocumentum Administrator.


Table 125. Properties dened for the relation SSA policy type


Description

target_object_type string(32) S Identifies the object type ofthe related object.

ssa_policy_id ID S Object ID of the ssa policyobject enforced for therelated object.


Relation Type

Relation Type

Purpose Describes a relationship that can exist between two objects in the repository.

DescriptionSupertype: Persistent ObjectSubtypes: dm_foreign_keyInternal name: dm_relation_typeObject type tag: 38

A relation type object describes a relationship that can exist between two objects inthe repository.

When a user sets up a relationship between two objects, for example, by creatingan annotation and attaching it to a document, the server creates an object of typedm_relation. The relation object links the annotation (child) to the document (parent) anddescribes the relationship between them by referring to the associated dm_relation_typeobject.

A user must have Sysadmin or Superuser privileges to create or destroy a relation typeobject.

For information about defining relationships or relationships between two objects, referto Relationships, page 30.


Table 126. Properties dened for the relation type object type


Description

a_controlling_kind string(32) S Set to a value to indicatewhether relationships of thistype are created by usersor internally. The setting isused by EMC Documentumclients to determine whetherto allow users to create and


Relation Type


Description

destroy instances of therelation type.

child_parent_label string(255) R User-defined label for achild-to-parent relationship.

child_type string(32) S The object type of valid childobjects in the relationship.

copy_child integer S Specifies whether to copy thechild in a relationship whenpermanent_link is T andthe parent is copied. Validvalues are:

0, meaning do not copy thechild

1, meaning copy the child

This property is used only byDFC when copying a parentobject in a relationshipand dm_relation_type.permanent_link is T. TheDMCL and pre-5.3 versionsof DFC do not use thisproperty.

description string(250) S User-defined description ofthe relationship.

direction_kind integer S The direction of therelationship. Valid valuesare:• 0, meaning from parent tochild

• 1, meaning from child toparent

• 2, meaning bidirectional— objects are treated assiblings

The default is 0.


Relation Type


Description


integrity_kind integer S Indicates how referentialintegrity is enforced. Validvalues are:• 0, meaning allow delete• 1, meaning restrict delete• 2, meaning cascade delete

The default is 0.

parent_child_label string(255) R User-defined label for aparent-to-child relationship.

parent_type string(32) S Defines the object type ofa valid parent object in therelationship.

permanent_link Boolean S Whether the relationship ismaintained when the parentis copied or versioned. Tmeans that the relationshipis maintained with the newparent object. F meansthat the relationship is notmaintained. The defaultvalue is F.

This property is used onlyby DFC 5.3 when copying orversioning a parent object ina relationship. The DMCLand pre-5.3 versions of DFCdo not use this property.

Note: When an instance ofthe relationship is createdusing a 5.3 DFC-basedapplication, this value is thedefault value assigned todm_relation.permanent_linkif that property is not setexplicitly.


Relation Type


Description

relation_name string(32) S The name of the relationship.Names must be unique. Thenames of system-definedrelationships begin withdm_.

Defines the security appliedto objects of type dm_relationwhose relation_nameproperty value matchesthe relation_name propertyfor the dm_relation_typeobject. Valid values are:

SYSTEM

Only users with Superuseror Sysadmin privileges cancreate, modify, or dropdm_relation objects havingthis relation_name

PARENT

Security is determined bythe object type of the parentobject participating in thiskind of relationship.

CHILD

Security is determined bythe object type of the childobject participating in thisrelationship.

security_type string(10) S

NONE

No security is applied tothe dm_relation objectsrepresenting instances of thisrelationship.


Relationship Def

Relationship Def

Purpose

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_relationship_defObject type tag: 08

A relationship def object records the definition of a relationship. These objects arecreated using the IDfRelationshipInfo interface in DFC. Each relationship def objectmust have a binding aspect attached that describes the specific physical binding thatcharacterizes the relationship.

The object type is installed with the Smart Container DAR file when a repository isconfigured.


Table 127. Properties dened for the relationship def type


Description

is_composition Boolean S Indicates whether therelationship is a strictcomposition, meaningthe related children havea single parent and thatdestroying the parent alsodestroys the children.

T means that therelationship is a strictcomposition. F means thatit is not a strict composition.

The default is F.


Relationship Def


Description

is_private Boolean S Indicates whether therelationship is availablefor external use. T meansthat the relationship isprivate, not available forpublic use. F means that therelationship may be usedby external applications.

operation_name string(255) R Name of an operationto be applied after sometriggering event. The nameat any particular indexposition is associated withthe module and metadatain the correspondingindex positions inoperation_moduleand operation_modulemetadata.

The name should be a fullyqualified name, such asa Java package name, toguarantee uniqueness.

operation_module string(255) R Module that implementsthe operation identifiedin operation_name. Themodule at a particularindex position is themodule that implementsthe operation identified atthe same index position inoperation_name.


Relationship Def


Description

operation_module_metadata

string(1024) R Metadata used to configurethe operation module. Themetadata at a particularindex position is themetadata used to configurethe module identified atthe same index position inoperation_module.

rel_description string(1024) S User-defined description ofthe relationship.

rel_degree integer S Indicates the degree of therelationship from parent tochild. Valid values are:

0, meaning a one-to-onerelationship

1, meaning a many-to-onerelationship

2, meaning amany-to-manyrelationship

required_source_aspects

string(64) R List of aspects that will beassociated with an instanceof the source (parent) typewhen participating in thisrelationship.

required_target_aspects

string(64) R List of aspects that will beassociated with an instanceof the target (child) typewhen participating in thisrelationship.

source_constraint_set_id

ID S Object ID of thedmc_constraint_set objectthat records the set ofconstraints applied tothe source object in therelationship.


Relationship Def


Description

source_role string(255) S Name for the role playedby the source object in therelationship. For example,if the relationship relatesa customer with a vendor,the role for the customermay ’buyer’.

source_type string(27) S Identifies the top-most typein the hierarchy of typesthat may participate asparent in this relationship.This type or any of itssubtypes may be a parentin the relationship.

target_constraint_set_id

ID S Object ID of thedmc_constraint_set objectthat records the set ofconstraints applied tothe target object in therelationship.

target_role string(255) S Name for the role playedby the target object in therelationship. For example,if the relationship relatesa customer with a vendor,the role for the vendor may’seller’.

target_type string(27) S Identifies the top-most typein the hierarchy of typesthat may participate aschild in this relationship.This type or any of itssubtypes may be a child inthe relationship.

Table 128, page 375, lists the properties added by a system-defined default aspect forthe type.


Relationship Def

Table 128. Default aspect properties dened for the relationship def type


Description

logical_version string(32) S Supports logical versioningof persistent objects

From the aspect nameddm_logical_aspect

annotation_name string(255) R A non-qualifiable propertythat stores the names of theannotation

From the aspect nameddm_annotable

module_name string(255) R A non-qualifiable propertythat stores module names


annotation_namemetatdata

string(1054) R A non-qualifiable propertythat stores annotationmetadata values



Replica Record

Replica Record

Purpose Contains information about replicated content in distributed storage areas.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_replica_recordObject type tag: 2d

A replica record object contains information about replicated content in distributedstorage areas. The object is created and used by Content Server to manage distributedcontent storage areas.


Table 129. Properties dened for the replica record type


Description

component_id ID R Object IDs of thecomponents storage areasthat contain replicas of thecontent file

data_ticket integer R Information used internallyto fetch and save thecontent.

epoch_number integer S Used internally to managedistributed storage areas.

format_id ID S Object ID of the formatobject representing theformat of the content fileassociated with the replicarecord.



Replica Record


Description

other_ticket integer R Information used internallyto fetch and save thecontent.

owner_id ID S Object ID of the distributedstorage area that containsthe content file.

r_storage_ticket integer S Used internally to managethe content


Retainer

Retainer

Purpose Describes a retention policy.

DescriptionSupertype: SysObjectSubtypes: dmc_rps_retainerInternal name: dm_retainerObject type tag: 08

A retainer object records information about one retention policy. Retention policiesare created through Retention Policy Services (accessed through DocumentumAdministrator) and require a Retention Policy Services license to create and use. Retainerobjects are owned by a member of the dm_retention_managers group or by the groupitself. Retainer objects must be uniquely named within the repository and cannot beversioned.

PropertiesTable 130, page 378, lists the properties defined for a retainer object.

Table 130. Properties dened for the retainer type


Description

aging_method integer S Identifies the type of theretainer. Valid values are:

0, meaning under fixedretention value

1, meaning under conditional(event-based) retention

2, meaning under retentionhold


Retainer


Description

disposition_rule integer S Defines how RPS disposes ofan object. Valid values are:

0, meaning DESTROYCHILDREN

1, meaning DESTROY_VDM

2, meaning DESTROY_ROOT

enforcement_rule integer S Defines how objects underthis policy are managed whenthe retention period expires.Valid values are:

0, meaning objects areretained until the retentionrule is removed using RPS.

1, meaning Content Serverdisallows deletion if theobjects are linked to an activeretainer.

2, meaning objects areretained until their associatedstructural retainer or retainersare removed

Note: Disposition of objectsassociated with an activeretainer is controlled by theretention policy’s dispositionrules definedwithin RetentionPolicy Services.


Retainer


Description

immutability_rule integer S Defines whether to markdocuments under the controlof the policy immutable.Valid values are:

0, meaning objects are notmarked immutable

1, meaning objects are markedimmutable

The default is 0.

Notes on use:

• When the retaineris container-based(dm_retainer.retainer_strategy=1), the container isnot affected by this setting.

• When an object that ismarked immutable dueto its retention policyor policies is detachedfrom all retainers, itsr_immutable_flag propertyis not reset to F unless theobject is the CURRENTversion and is not a cabinetor folder.

r_retention_status integer S Identifies the status of theretainer. Valid values are:

0, meaning active—objectsunder the control of theretainer may not be deletedand new objects may beadded to the retainer

1, meaning locked—theretainer is active but no newobjects may be placed underits control

2, meaning inactive—objectsunder the control of the


Retainer


Description

retainer may be deleted fromthe repository

The default is 0.

rendition_rule integer S Defines how multiple contentfiles for one document arehandled. Valid values are:

0, meaning all content filesassociated with a documentunder the control of the policyare under retention

1, meaning only the primarycontent files of a documentunder the control of the policyare under retention

retainer_root_id ID S Identifies the object to whichthis retainer is applied.

If dm_retainer.retainer_strategy is set to 0(object-based retention),retainer_root_id is the objectID of the individual objectunder retention.

If retainer_strategy is set to 1(container-based retention),retainer_root_id is the objectID of the folder containing theobjects under retention.


Retainer


Description

retainer_strategy integer S Defines whether the retainercontrols a single object ormultiple objects placed in acontainer. Valid values are:

0, meaning the retainercontrols a single object

1, meaning the retainercontrols multiple objects in acontainer

The default is 0.

retention_date date S Retention value whendm_retainer.retention_rule_type is set to 1, meaningdate.

retention_interval integer S Retention value whendm_retainer.retention_rule_type is set to 2, meaninginterval.

The value is interpreted inseconds.

retention_rule_type integer S Specifies how the retentionperiod is defined. Validvalues are:

0, meaning there is nospecified retention period

1, meaning the retentionperiod is defined as a specificdate

2, meaning the retentionperiod is defined as aninterval

The default is 0.


Retainer


Description

retention_storage_class


version_rule integer S Defines how retention isapplied to new versions ofdocuments under the controlof the retainer. The onlyvalid value is 0, meaning thatthe retention period appliesonly to the specific versionto which the retainer wasattached.


Routecase Condition

Routecase Condition

Purpose Records a route case condition expression for an automatic transition of a workflowactivity.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_routecase_conditionObject type tag: 00

A routecase condition object records a conditional expression in a route casecondition. You cannot create these objects directly. They are created when anaddConditionRouteCase method (defined for the IDfActivity interface) is executedfrom Process Builder to save an activity’s route case conditions when one or more of theroute cases contains an XPath expression.


Table 131. Properties dened for the routecase condition type


Description

a_attribute_name string(32) S Name of the propertyreferenced in the expression,if any

a_boolean_value Boolean S Value to be used in thecomparison if the datatypeidentified in a_value_typeis Boolean.

This is not set if unless thedatatype is Boolean.


Routecase Condition


Description

a_double_value double S Value to be used in thecomparison if the datatypeidentified in a_value_typeis double.

This is not set if unless thedatatype is double.

a_id_value ID S Value to be used in thecomparison if the datatypeidentified in r_value_type isID.

This is not set if unless thedatatype is ID.

a_int_value integer S Value to be used in thecomparison if the datatypeidentified in a_value_typeis integer.

This is not set if unless thedatatype is integer.

a_object_alias string(128) S Name of the package, ormanifest values referring tothe workflow or work item

a_relational_op integer S The relation operator in thecondition. Valid values are:

0, meaning =1, meaning <>2, meaning <3,meaning >4, meaning <=5, meaning >=


Routecase Condition


Description

a_repeating_attr_flag

integer S Indicates whether theproperty named ina_attribute_name is arepeating property and ifit is a repeating property,which values to examinewhen evaluating thecondition. Valid valuesare:

-1, meaning theproperty is not arepeating property0, meaning ANY1, meaning ALL3, meaning LAST2, meaning FIRST

a_string_value string(1024) S Value to be used in thecomparison if the datatypeidentified in a_value_typeis string.

This is not set if unless thedatatype is string.

a_time_value date S Value to be used in thecomparison if the datatypeidentified in a_value_typeis Date.

This is not set if unless thedatatype is Date.

a_value_type integer S Data type of the value in therelational expression. Thedata type is expressed as anIDfValue constant.

a_xpath_datatype string(64) S The xschema’s built-indatatype name.

This is set only if thecondition includes an XPathexpression.


Routecase Condition


Description

a_xpath_def_namespace_uri

string(255) S The schema URI for thedefault XPath namesapce


a_xpath_expression string(1024) S An XPath expression.


a_xpath_namespace_prefix

string(64) R The prefixes that alias thenamespace URIs within theXPath expression


a_xpath_namespace_uri

string(255) R Namespace URIs ofthe XPath expressioncomponents


a_xpath_value string(1024) S Literal value used in theXPath transition conditionevaluation. The value isin the format in whichit is found in the XMLdocument.


r_aspect_name string(64) R Used internally


Scope Cong

Scope Cong

Purpose Defines the context for the referenced display config objects.

DescriptionSupertype: NoneSubtypes: NoneInternal name: dm_scope_configObject type tag: 6c

A scope config object defines the context for the referenced display config objects. Eachdisplay config object defines a set of properties and display hint for the properties. Eachscope config object identifies one or more display config objects and one or more contextsin which the display config is used. Both scope config and display config objects are usedby client applications. Content Server does not use these objects.


Table 132. Properties dened for the scope cong type


Description

display_config ID R Object IDs of the displayconfig objects used in thescopes defined in the scopeconfig object.

scope_class string(32) R The category of the scope. Theonly valid value is application.

scope_value string(32) R The specific scope within thescope class. For example, ifscope_class is application,scope_value might be Webtopor a DAR file name.

The scope at a particularindex position is the specificinstance of the class at the


Scope Cong


Description

corresponding index positionin scope_class.


Script

Script

Purpose Stores a script as content.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_scriptObject type tag: 08

A script object stores a script as content. Script objects are used by Documentum clients.Their content files contain the scripts. Depending on where the script object is stored, thescript is executed automatically when users connect to a repository or on demand, whenusers select the script from a menu. Users must have at least Read permission for thescript object to execute its associated script.

PropertiesThe script type has no defined properties. It inherits all of its properties from itssupertype, SysObject.


Sequence

Sequence

Purpose Used by Content Server to generate object IDs.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_sequenceObject type tag: 20

A sequence object is used by Content Server to generate object IDs. There is one sequenceobject for each object type in a repository, up to a maximum of 255.


Table 133. Properties dened for the sequence type


Description

i_current_mask integer S Used internally to manageobject IDs

i_high_mask integer S Used internally to manageobject IDs

i_high_water_mark

integer S The highest number thatcan be assigned

i_in_use Boolean S Indicates if any of thenumbers in the allowedrange have been assigned.

i_last_no integer S Contains the last numberassigned

i_low_mask integer S Used internally to manageobject IDs

i_low_water _mark integer S The first or lowest numberthat can be assigned


Server Cong

Server Cong

Purpose Describes a Content Server.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_server_configObject type tag: 3d

A server config object contains information that the server uses to define its operationand operating environment, such as the number of allowed concurrent sessions,maximum cache sizes, and the storage area locations, and the locations of executablesthat the server calls.


Table 134. Properties dened for the server cong type


Description

a_silent_login Boolean S Used internally

agent_launcher string(32) S The name of the method object thatlaunches the agent exec process. Thedefault is agent_exec_method.

alias_set_id ID S The object ID of the alias set objectrepresenting the system-level defaultalias set.

app_server_name

string(32) R Name of a Java servlet.

The name do_method identifiesthe servlet to which DO_METHODfunctions are directed.


Server Cong


Description

app_server_uri string(255) R URI for the servlet at thecorresponding index position inapp_server_name. Contains the host,port, and servlet_path in the followingformat:

http://host:port/servlet_path

host is the IP address or name ofthe machine hosting the applicationserver.

port is the port number on which theapplication server is listening.

servlet_path is the path to the servletto which an HTTP_POST request isdirected.

The URI can contain only ASCIIcharacters.

application_access_control

Boolean S T (TRUE) means users withoutSuperuser privileges must use anapplication access token to connect tothe server.

F (FALSE) means any user can connectwithout an access token.

The default is F.

assume_user_location

string(32) S Name of the location object for thedirectory containing the assume userprogram. The default is assume_user.

auth_plugin_location

string(32) S Name of the location object thatidentifies the directory location ofauthentication plugins. This is set toauth_plugin by default.

cached_types string(32) R Names of the user-defined objecttypes that you want to cache on serverstartup. The default is a single blank.


Server Cong


Description

certdb_location string(32) S Name of the location object pointing tothe location of the certificate database.The default is ldapcertdb_loc.

change_password_location

string(32) S Name of the location object for thedirectory containing the changepassword program. The default ischange_password.

checkpoint_interval

integer S Defines how often the serverbroadcasts its service information.The default is 300 (seconds).

client_cache_size

integer S Maximum allowed size of the clientcache, expressed as the number ofobjects. The default is 50.

The number of objects may exceed thespecified maximum size if an objectmust be added to the cache and nocandidate for deletion is found. Also,persistently cached objects are notcounted towards the maximum.

common_location

string(32) S Name of the location object for thecommon directory. The default iscommon.

compound_integrity

Boolean S Indicates if the server is enforcingreferential integrity for virtualdocuments. The default is TRUE.

concurrent_sessions

integer S Number of concurrent sessions. Thedefault is 100.

dba_location string(32) S Name of the location object thatidentifies the location of the dbadirectory in the Documentuminstallation. The default is dm_dba.


Server Cong


Description

default_acl integer S Specifies which ACL the server willuse as the default ACL when creatinga new object if an ACL is not explicitlyassociated with the object. Validvalues are:• 1, to specify the ACL associatedwith the object’s primary folder

• 2, to specify the ACL associatedwith the object’s type

• 3, to specify the ACL associatedwith the user who created theobject

• 4, meaning no default ACL isspecified

The default is 3.

default_client_codepage

string(64) S Identifies the default code page forclients. Legal values are:

US-ASCIIUTF-8ISO_8859-1Shift_JISEUC-JPEUC-KRISO-10646-UCS-2

The value is determinedprogrammatically and set duringContent Server installation.

events_location string(32) S Name of the location object thatidentifies the events directory. Thedefault is events.

extra_directory_config_id

ID R Object IDs of the ldap config objectsrepresenting LDAP directoriesfrom which users and groups aresynchronized.


Server Cong


Description

far_stores string(32) R Names of the storage areas that areconsidered far for the server. Thedefault is a single blank.

fulltext_location

string(64) S Name of the location object thatidentifies the location of the fulltextconfiguration file (dmfulltext.ini).

ignore_pre_processing

Boolean S Not currently used

keep_entry_interval

integer S Defines how long a connection brokerkeeps a server entry in the absence ofa checkpoint message from the server.The default is 1440 minutes (24 hours).

ldap_config_id ID S Object ID of the ldap config objectrepresenting the default LDAPdirectory used by Content Server.

locale_name string(32) S Content Server’s locale. Legal valuesare:

en, for Englishes, for Spanishfr, for Frenchde, for Germanit, for Italiansv, for Swedishja, for Japaneseko, for Koreanzh, for Chinese


log_location string(32) S Name of the location object for thelogs directory. The default is log.

login_ticket_timeout

integer S Defines the length of time for whicha login ticket is valid. The value isinterpreted in minutes. The minimumaccepted value is 1 minute. Thedefault is 5 minutes.


Server Cong


Description

mail_method string(32) S Name of the method that ContentServer uses to send email messages.

Valid values are dm_event_sender,an empty string, or dm_event_template_sender. The default value isdm_event_sender.

“dm_event_sender_template” is avalid value only if you have BusinessProcess Designer installed and areusing the workflow email templatefeature.

Note: Setting this to an empty stringdoes not disable server email. If youwant to disable server email, youmust set the mail_notification key inthe server.ini file.

max_login_ticket_timeout

integer S Maximum length of time, in minutes,that a login ticket can remain valid.

The minimum value is 1 minute. Thedefault value is 43200 minutes (30days).

nfs_enabled Boolean S Indicates if the server is using NFS forfile sharing. The default is FALSE.

nls_location string(32) S Name of the location object for thenls directory. The default is a singleblank.

object_name string(255) S Identifies the server config object. Thedefault is the name of the repositoryfor which the server was started.

Server config names for a ContentServer at a primary site is <=32characters in length.

Server config names for content-fileservers (remote Content Servers) are25 characters or less.

Server config names are createdautomatically when the server isinstalled.


Server Cong


Description

operator_name string(32) S Identifies the operator for therepository (for archiving and restoreoperations). The default is the value inthe server config object’s owner_nameproperty.

projection_enable

Boolean R Indicates whether projection to theconnection broker specified at thecorresponding index position inprojection_targets is enabled.

projection_netloc_enable

Boolean R Indicates whether projection to thenetwork location specified at thecorresponding index position inprojection_netloc_id is enabled.

projection_netloc_id

string(80) R User-defined identifiers of networklocations.

projection_notes

string(80) R User-defined

projection_ports

integer R Identifies the port on which theconnection broker is listening.The value at each index level ismatched to the connection brokerspecified at the corresponding levelin projection_targets. The default is1489.

projection_proxval

integer R Proximity values projected to theconnection brokers, the networklocations, or both.

The value at each index position isprojected to the connection brokerspecified at the correspondingposition in projection_targets ifprojection_enable is TRUE in thecorresponding index position.

Similarly, the value at each indexposition is projected to the networklocation specified at the correspondingindex position in projection_netloc_idif projection_netloc_enable is TRUE inthe corresponding index position.


Server Cong


Description

projection_targets

string(80) R Names of the host machines on whichthe connection brokers reside.

r_castore_enabled

Boolean S Whether the server was installed witha Content Services for EMC Centeralicense. Valid values are:

1, meaning the server was installedwith a Content Services for EMCCentera license

2, meaning the server was notinstalled with a Centera license.

r_host_name string(64) S Name of the host machine on whichthe server resides.

r_install_domain

string(16) S Name of the Windows domain

r_install_owner string(32) S Name of the installation owner

r_process_id integer S Contains the process id of the mainserver thread (parent server).

r_server_version

string(32) S Version number of the server.

r_trusted_mode integer S Whether the server is a trusted server.0 means that the server is not a trustedserver. 1 means the server is a trustedserver.

This property is set during serverinstallation, depending on whetherthe user provides a trusted serverlicense key.

rend_backing_store

string(32) S obsolete


Server Cong


Description

restrict_su_ticket_login

Boolean S T (TRUE)means a userwith Superuserprivileges cannot connect to the serverusing a global login ticket.

F (FALSE) allows users withSuperuser privileges to connect to theserver using a global login ticket.

The default is F.

rightsite_image string(255) S Used to construct the URL when auser is sending a document to a mailrecipient. Valid values are:• webtop• a RightSite imageRightSite imagesare found in the Windows registry.An example of a Rightsite image is/rs-bin/RightSite.dll

The default is webtop.

secure_connect_mode

string(16) S The type of port on which the serveris listening. Valid values are:

native, meaning an unsecure port

secure, meaning a secure port (usingSSL)

dual, meaning both a native and asecure port

Non-trusted servers do not use thisproperty. They accept only nativeconnections.

secure_writer_location

string(32) S Name of the location object forthe directory containing the securewriter program. The default issecure_common_area_writer.

server_cache_size

integer S Maximum allowed size, expressed asthe number of objects. The default is200.


Server Cong


Description

server_os_codepage

string(64) S The code page used by the operatingsystem of the Content Server host.Legal values vary by operatingsytsem. Valid options are:

US-ASCIIUTF-8ISO_8859-1Shift_JISEUC-JPEUC-KRISO-10646-UCS-2


sibling_checkpoint_interval

integer S Defines how often the serverbroadcasts sibling information (Notcurrently used)

sibling_export_enabled

Boolean S Indicates if the server can broadcastinformation about its sibling servers.(Not currently used)

signature_chk_loc

string(32) S Name of the location object for thedirectory containing the signaturevalidation program. The default isvalidate_signature.

smtp_server string(64) S Name of the SMTP server host.

This is used only on Windowsplatforms, by the email notificationsystem.

stage_destroyer_location

string(32) S Not currently used

system_converter_location

string(32) S Name of the location object for thedirectory containing the convert.tblfile and the system-suppliedtransformation scripts. The default isconvert.


Server Cong


Description

temp_location string(32) S Name of the location object for thetemp directory. The default is temp.

turbo_backing_store

string(32) S Contains the name of the file storeobject for the file store storage areawhere the server puts renditionsgenerated by indexing blob and turbocontent. The default is filestore_01.

user_converter_location

string(32) S Name of the location object thatidentifies the directory containing theuser-defined transformation scripts.The default is a single blank.

user_validation_location

string(32) S Name of the location object forthe directory containing the uservalidation program. The default isvalidate_user.

verity_location string(32) S Obsolete

web_server_loc string(255) S Name of the Web server’s hostmachine, and optionally, its domainand protocol. Examples:

cinderella cinderella.mycompany.com http://cinderella.mycompany.com

The default protocol is http.

web_server_port

integer S Identifies the port which the Webserver is using. The default value is80.

wf_agent_worker_threads

integer S Number of workflow agent workersessions. The maximum value is 1000.The default value is 3. Setting this to 0disables the workflow agent.

wf_sleep_interval

integer S Length of time, in seconds, that themaster workflow agent master sessionwaits before querying the repositoryfor activities awaiting execution in theabsence of a notification of an activitywaiting for execution.

The default is 5 seconds. There is nomaximum value.


Session

Session

Purpose Not currently used.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_sessionObject type tag: 01

The session object type is constructed by the server during server start-up. It is notcurrently used by Content Server, and there are no objects of that type stored in therepository. However, you can execute a describe command through IDQL to view itsproperties, and it is visible as a dm_type object.


Smart List

Smart List

Purpose Represents the set of objects determined by the SELECT query defined for theSmart List.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_smart_listObject type tag: 08

A Smart List object represents the set of objects determined by the SELECT querydefined for the Smart List. When a user opens a Smart List, the query is executedand the retrieved items are displayed to the user in a window that allows the users tomanipulate the objects.

A Smart List object can only be created using Desktop Client or Webtop. On Webtop,the Smart List object contains the saved search object created by the search service. Thisobject contains the search definition and search results. The Smart List object created byDesktop Client can be executed in Webtop but not edited nor listed as a saved search.

If the Smart List is created from Desktop Client, the query is saved as DQL. If the SmartList is created from Webtop, the query is saved as an XML file. Smart Lists created inDesktop Client can be read by Webtop. However, Smart Lists created in Webtop cannotbe read by Desktop Client.


Table 135. Properties dened for the Smart List type


Description

has_results Boolean S TRUE if the saved searchwas saved with results


Smart List


Description

query_type string(32) S Identifies the search type.Valid values are:

passthrough_query

query_builder

or blank when query typeis unknown

results_count integer S Number of results thesearch had when the searchwas saved

selected_sources string(256) R List of the sources searchedby the search. These canbe repositories or externalsources.


State Extension

State Extension

Purpose Identifies the lifecycle state with which a state extension object is associated.

DescriptionSupertype: RelationSubtypes: RPS Phase Rel, RPS Retainer Event RelInternal name: dm_state_extensionObject type tag: 37

A state extension object identifies the lifecycle state with which the state extension objectis associated. The state extension object type is the base object type for state extensionobject subtypes. Typically, the state extension object type is subtyped to add propertiesto store the application-specific information needed for particular lifecycle states.


Table 136. Properties dened for the state extension type


Description

state_no integer S Number of the state withwhich the state extensionobject is associated. Thenumber is the value in thedm_policy object’s state_noproperty.


State Type

State Type

Purpose Identifies a particular lifecycle state type name and application pair.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_state_typeObject type tag: 00

A state type object identifies a particular lifecycle state type name and applicationpair. State type objects can be used to associate a state type name with a particularapplication. Some Documentum client applications require specific state type names beassigned to lifecycle states. User applications may also make use of state types. (Formore information, refer to Content Server Fundamentals.)


Table 137. Properties dened for the state type object type


Description

application_code string(32) S Name of the applicationthat recognizes the statetype.

state_type_name string(32) S Name of a lifecycle statetype.


SSA Policy

SSA Policy

Purpose Defines a content assignment policy for new content files.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_ssa_policyObject type tag: 08

An ssa policy object defines storage rules for content files. The rules are stored as contentof the object. A policy is associated with one or more object types through a relationship,recorded in an relation ssa policy object.

SSA policy objects are created using Documentum Administrator. Existing policies canbe copied or modified, but not versioned. You must have installed Content Server with aContent Storage Services license to create and use assignment policies.


Table 138. Properties dened for the SSA policy type


Description

is_activated Boolean S Whether the policy isactive (being enforcedby the policy engine). T(TRUE) means the policy isenforced. F (FALSE) meansthe policy is inactive.

The default is T.


Store

Store

Purpose Represents a content storage area.

DescriptionSupertype: Persistent ObjectSubtypes: Distributed Store, File Store, Linked Store, Blob Store, External Store, CA StoreInternal name: dm_storeObject type tag: 0e

A store object represents a content storage area. The properties in store objects may bechanged only by users with Sysadmin or Superuser user privileges.


Table 139. Properties dened for the store type


Description

base_url string(255) S The basic URL used toretrieve contents directlyfrom a storage area.

capacity integer S Not currently used

component string(64) R The name of the storageobjects representingcomponent storage areas.(Used by linked store anddistributed stores.)


Store


Description

compression_mode integer S Applicable only to file storeand ca store storage areasand if the server is installedwith a Content StorageServices license, thisproperty indicates whethercontent written to thestorage area is compressed.Valid values are 0, meaningthe content in the storagearea is not compressed, and1, meaning the content iscompressed.

If not explicitly set whenthe storage area is created,the default value is 0.

The setting may not bechanged after the storagearea is created.

content_dupl_pref integer S Used only if the server isinstalled with a ContentStorage Services license,this property indicatesthe content duplicationpreference for the storagearea. Valid values are:

0, meaning Content Serverdoes not check the storagearea for duplicate contentfiles when saving contentfiles to the storage area

1, meaning Content Serverchecks the storage areafor duplicate content fileswhen saving content filesto the storage area

The default is 0.

Refer to the Content ServerAdministration Guide for


Store


Description

information about how thisproperty is used.

content_hash_mode

integer S Used only if the server isinstalled with a ContentStorage Services license,this property configureshash generation for contentfiles in the storage area.This property setting isapplicable only to file storestorage areas. Valid valuesare:

0, meaning do not generatehashes for the content filesin the storage area.

1, meaning generate aSHA1 hash for each contentfile in the storage area

If content_dupl_prefis set to a non-zerovalue, the value ofcontent_hash_mode mustbe 1. Content Server setsthe value to 1 automaticallyunder that condition.

If content_dupl_pref is0, the default value forcontent_hash_mode is 0.

Refer to the Content ServerAdministration Guide forinformation about how thisproperty is used.


Store


Description

crypto_key string(256) S Contains the symmetrickey used to encrypt thecontent files stored in thestorage area.

You cannot create indexeson this property.

crypto_mode integer S Whether the contents of thestorage area are encrypted.0 means the contents arenot encrypted. 1 means thecontents are encrypted.

This value is set whenthe storage area is createdand cannot be changedafterwards. You can onlyset this value for file storestorage areas.


current_use integer S For internal use

default_retention_days

integer S Number of days to retaincontent in the storage area.The count of days beginswhen the content is savedto the storage area.

This property is usedonly for ca store(content-addressed)storage areas.

If this property is set, itsvalue takes precedenceover a value set indm_ca_store.a_default_retention_date.


Store


Description

digital_shredding Boolean S Whether digital shreddingis enabled for the storagearea. Valid values are:

0, meaning shredding isdisabled

1, meaning shredding isenabled

The default is 0.

This property only affectsfile store storage areas andmay only be set to 1 if theserver is installed with aTrusted Content Serviceslicense.

get_method string(32) S Contains the nameof the dm_methodobject representing theuser-defined programthat retrieves a specifiedcontent.

i_use_mask _after integer S Used internally to managestorage ticket numbers forcontent files.

media_type integer S Identifies the media typeof content stored in thisstorage area. Valid valuesare:• 0, for any type other thanthumbnail or streaming

• 1, for thumbnail• 2, for streaming

The property cannot bechanged after the storagearea is created.


Store


Description

name string(64) S Contains the name of thestore object. This must bea unique name within therepository.

offline_get_method

Boolean S Indicates whether theapplication should regardthe retrieved content asimmediately available orawaiting restoration (fromarchiving).

r_component ID R The object IDs of anycomponent storage areas.

r_component_count

integer S The total number ofcomponent storage areas.

r_status integer S Records the stateof the storage area.Valid values are:0, for on-line1, for off-line2, for read-only

require_ticket Boolean S Indicates whether ContentServer generates a ticketwhen returning a URLto a content file. TRUEmeans a ticket is returned.FALSE means a ticket is notreturned. The default isFALSE.

store_type integer S Value indicating thesubtype of the storagearea. This can be one of thefollowing values:• 1, for file store• 3, for linked store• 4, for distributed store• 5, for blob store• 7, for external store• 8, for external file store


Store


Description

• 9, for external URL store• 10, for external free store• 11, for CA store

Note: 2 and 6 are currentlyunused values.


Subcontent

Subcontent

Purpose Stores a content file in turbo storage or the content addresses of content storedin content-addressed storage systems.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_subcontentObject type tag: 64

A subcontent object stores a content file in turbo storage or the content addresses ofcontent stored in content-addressed storage systems. When a content file in turbo storageis too big to store in a content object, the content is stored in subcontent object. If acontent file stored in a content-addressed system is modified or if its metadata propertiesin the storage system are modified, the storage system creates a new address for thecontent file. This address is stored in a subcontent object.

Subcontent objects are internal objects that users and applications cannot access directly.However, users and applications can query subcontent objects using DQL.

PropertiesTable 140, page 416, lists the properties defined for the subcontent object type.

Table 140. Properties dened for the subcontent type


Description

parent_id string(16) S Object ID of the dmr_content objectthat represents the content file orcontent address stored in this object.


Subcontent


Description

i_contents For alldatabasesexcept Sybase:string(2000)

For Sybase:string(255)

R For objects in turbo storage, thiscontains the object’s content file ifthe content is too big for i_contentsin the content object. This propertycannot be selected using eitherthe API or DQL when it used as astorage area for turbo content.

For objects in content-addressedstorage, this contains additionalcontent addresses generated byoperations on the object or itsstorage metadata values. Alladdresses point to the same content,however the metadata and retentionperiod information associated witha particular address typically differs.

i_contents_size integer R Actual size of the content, includingtrailing spaces, stored in thecorresponding index position ofi_contents.

Note: Subcontent objects created byserver versions prior to 5.0 will haveno value in this atribute.

This property is not used if thesubcontent object records a contentaddress.



SysObject

SysObject

Purpose Serves as the parent type of the most commonly used objects in the Documentumsystem.

DescriptionSupertype: Persistent ObjectSubtypes: Document, Folder, Output Device, Category Class, and so forthInternal name: dm_sysobjectObject type tag: 08

The SysObject type is the parent type of the most commonly used objects in theDocumentum system. The SysObject type has three important properties, representedby properties, that it passes on to all its subtypes. These properties are:• A SysObject accepts security permissions. Properties defined for the SysObject allow

you to set permissions on the object.• A SysObject, unless it is a cabinet, can belong to a folder.• A SysObject can own one or more content objects.

PropertiesTables Table 141, page 419, through Table 149, page 432, list the properties defined for thetype. The tables group the SysObject properties by use or function:• General properties, described in Table 141, page 419• Folder-related properties, described in Table 142, page 422• Virtual document-related properties, described in Table 143, page 423• Content-related properties, described in Table 144, page 425• Version-control properties, described in Table 147, page 430• Event-related property, described in Table 148, page 432• Lifecycle-related properties, described in Table 149, page 432• Properties added by an system-defined aspect, described in Table 150, page 433Table 150, page 433, lists the properties attached to the objects of the type throughsystem-defined aspects.

General propertiesThe general properties provide a general description of the object.


SysObject

Table 141. General properties of SysObjects


Description

a_application_type string(32) S Currently unused.

a_archive Boolean S Used internally.

a_extended_properties

string(32) R Values of the relation_nameproperty in a dm_relationobject or subtype of adm_relation. This is usedin conjunction with ther_object_id of the sysobjectto identify the relation objectthat contains the SysObject’sextended properties.

a_is_hidden Boolean S Indicates if this object isvisible to end users

a_is_template Boolean S Indicates whether the objectis a template

a_last_review_date Date S Date of the last review ofthe object.

This value is setautomatically by someDocumentum clientproducts.

a_retention_date date S Used internally.

a_special_app string(32) S Reserved for use byDocumentum products.

a_status string(16) S Not currently used.

authors string(48) R List of the authors for theobject. This is user-defined.

i_is_deleted Boolean S If the object is the rootversion of a version tree,deleting the object sets thisproperty to TRUE.


SysObject


Description

i_is_reference Boolean S Indicates whether the objectis a mirror object for areference link to a remoteobject. TRUE means thatthe object is a mirror object.

i_contents_size integer R Actual size of the content,including trailing spaces,stored in the correspondingindex position of i_contents.

Note: Subcontent objectscreated by server versionsprior to 5.0 will have novalue in this atribute.

This property is not usedif the subcontent objectrecords a content address.

i_contents_size integer R Actual size of the content,including trailing spaces,stored in the correspondingindex position of i_contents.

Note: Subcontent objectscreated by server versionsprior to 5.0 will have novalue in this atribute.

This property is not usedif the subcontent objectrecords a content address.


i_property_bag string(2000) S The property stores thenames and values ofnon-qualifiable properties.It is also used to store thenames and values of aspectproperties if the propertiesare added to the aspectwith the OPTIMIZEFETCHoption.


SysObject


Description

i_retainer_id ID R Object IDs of the retainerrepresenting the retentionpolicy that controls theobject.

keywords string(48) R List of user-definedkeywords for the object

language_code string(5) S Five-character code, in theformat xx_yy, indicatingthe language in whichthe document is writtenand the country of origin.The first two characters(xx) contain the languagecode and the final two(yy), the country code.Appendix A, Language andCountry Codes containsrecommended languageand country codes.

object_name string(255) S Name of the object. This isuser-defined.

Note: If you are using aDocumentum client, thisis the name that appearsunder the object’s icon.

r_access_date date S Contains the date and timewhen this object was lastaccessed by a Getfile orPrint method

r_alias_set_id ID S Object ID of the aliasset associated with thesysobject.

r_aspect_name string(64) R Reserved for internal use

Manipulation of thisproperty by users orexternal applications is notsupported.


SysObject


Description

r_creation_date date S Date the object was created.This is set by the server.

r_modifier string(32) S Name of the user who madethe last modification.

r_modify_date time S Date the object was lastmodified. This is set by theserver.

r_object_type string(32) S The object’s type, forexample, dm_sysobject ordm_document, set whenthe object is created.

r_property_bag string(2000) R This property storesoverflow from thei_property_bag property.

subject string(192) S Subject of the object. This isuser-defined.

title string(400) S Title of the object. This isuser-defined.

Folder-related propertiesThe folder properties provide information for managing folders.

Table 142. SysObject folder-related properties


Description

governing_room_id

ID S Object ID of the room that governsthis object.

i_folder_id ID R Object IDs of all folders linked tothe object.

i_has_folder Boolean S Flag indicating whether this objectis the CURRENT object in theversion tree. T means the objecthas the CURRENT version label. Fmeans it does not.


SysObject


Description

r_link_cnt integer S Number of objects linked to thefolder.

Note: This property has two usesin the SysObject object type. One,described here, for folders and one,described in Table 143, page 423 ,for virtual documents.

r_order_no integer R No longer used. Preserved forbackwards compatibility.

i_reference_cnt integer S Number of folder references madeto this object.

r_component_label

string(32) R No longer used. Preserved forbackwards compatibility.

r_composite_id ID R No longer used. Preserved forbackwards compatibility.

r_composite_label

string(32) R No longer used. Preserved forbackwards compatibility.

Virtual document-related propertiesThese properties provide information for the management of virtual documents.

Table 143. Virtual document-related properties


Description

a_compound_architecture

string(16) S Used by Virtual DocumentManager to determine if theobject can be structurallychanged through VDM. Anempty string indicates thatthe object can be changed.

a_link_resolved Boolean S Used internally.

resolution_label string(24) S Contains the defaultversion label used toresolve late-bound nodes ofa virtual document.


SysObject


Description

r_assembled_from_id

ID S Object ID of the virtualdocument that was thesource of the assemblyassociated with adocument.

r_frzn_assembly_cnt

integer S Contains a count ofthe number of frozenassemblies that contain thisobject.

r_has_frzn_assembly

Boolean S Indicates that thedocument’s assembly isfrozen.

r_is_virtual_doc integer S Indicates whether theSysObject is a virtualdocument. If the value is1, the object is a virtualdocument. If the valueis 0, the object is not avirtual document unlessthe r_link_cnt is greaterthan 0.

r_link_cnt integer S Number of components inthe virtual document.

r_link_high_cnt integer S Records the currentmaximum order numberassigned to a component.

Content-related propertiesThe content-related properties provide information about the content of sysobjects.


SysObject

Table 144. SysObject content-related properties


Description

a_content_type string(32) S File format of the object’scontent.

Note: For somesystem-created renditions,Content Server sets thisvalue to dm_internal.

a_full_text Boolean S Indicates whether thedocument is marked forfull-text indexing.

a_is_signed Boolean S Indicates whether the objecthas been digitally signed.The property is set to T bythe client application afterthe user signs the object.

a_storage_type string(32) S Identifies the storage areafor content files associatedwith the object. This is thename of the storage objectrepresenting the storagearea.

i_contents_id ID S Object ID of the contentobject for an object that hasonly one content. This is notused if an object has multiplecontent. In such cases, theContent Facility managesthe relationships betweenthe object and its multiplecontent.


SysObject


Description

r_content_size integer S Size, in bytes, of the firstcontent file associated withthe document.

This property cannotrecord content sizesgreater than 2GB. Examiner_full_content_size to obtainthe size of content largerthan 2GB.

i_retain_until date S Most restrictive retentiondate among all contentassociated with this object.

This property is only set ifthe content has a retentionperiod. Retention periodsare set by a retention policyor through storage in acontent-addressed storagearea with a retention period.

r_full_content _size double S Size, in bytes, of the firstcontent file added to theSysObject.

r_page_cnt integer S Number of content filesassociated with the object.

Web-content propertiesThe Web-content properties are used by the Documentum applications that manageSysObjects that are published on Web sites. These properties are not intended for use byuser applications.

Table 145. Web-content properties


Description

a_category string(64) S Used internally to managethe application.


SysObject


Description

a_effective_ date date R The date on which thedocument can be publishedto theWeb site. The value ata particular index positionapplies to the Web sitenamed at the correspondingindex position ina_effective_label.

a_effective_ flag Boolean R Indicates whether apending expiration noticewas sent to the document’sowner. The value at aparticular index positionapplies to the Web sitenamed at the correspondingindex position ina_effective_label.

a_effective_ label string(32) R User-defined, typically asymbolic label.

The WebCache exportoperation examinesthe values in thea_effective_date anda_expiration_dateproperties of all documentswhose a_effective_labelproperty value matches thewebc config effective_labelproperty.

If unspecified, effectivelabels are not enforced.


SysObject


Description

a_expiration_ date date R The date at which thedocument is to be removedfrom the Web site. Thevalue at a particularindex position appliesto the Web site namedat the correspondingindex position ina_effective_label.

a_publish_ formats string(32) R Lists the object’s renditionsthat are to be exported tothe WebCache repository.The system will exportthese renditions plusthose defined in thesource_formats property ofthe webc config object. Thisis an optional property. Ifunspecified, only renditionsdefined in the webc configobject are published.

Security-related propertiesThe security-related properties provide information that allows the server to enforcesecurity on the object. Changes to security-related properties may create a new ACLfor the object.

Table 146. SysObject security-related properties

Property Datatype Singlerepeating

Description

a_controlling _app string(32) S Identifies the applicationor applications that canmodify this object. IfNULL, then any applicationcan modify the object.


SysObject


Description

acl_domain string(32) S Identifies the domain of theACL associated with theobject. The value will beeither the user who createdthe ACL or, for system-levelACLs, the name of therepository owner.

acl_name string(32) S The object name of theassociated ACL.

group_name string(32) S Group to which this objectbelongs.

group_permit integer S Object-level permissionassigned to the object’sgroup for this object.

i_cabinet_id ID S Object ID of the cabinetthat is the object’s primarystorage location.

owner_name string(32) S Name of the object’s owner.This can be a user or groupname.

owner_permit integer S Object-level permissionassigned to the owner forthis object.

r_creator_name string(32) S Name of the object’s creator.

r_is_public Boolean S Value is computed based onthe object’s ACL.

TRUE means thatdm_world has at leastRead permission. FALSEindicates that dm_worlddoes not have Read orhigher permission.


SysObject


Description

r_lock_machine string(32) S Name of the client machineon which a user is workingwhen he or she locks anobject (by a checkout orbranch operation).

If the server is unableto resolve the name,r_lock_attribute is set tothe client machine’s IPaddress instead.

world_permit integer S Object-level permissionassigned to the world (allusers except owner andgroup members) for thisobject.

Version-related propertiesThe version-related properties provide information that lets the server manage andtrack the versions of an object.

Table 147. SysObject version-related properties


Description

i_antecedent_id ID S Object ID of the object’sparent version.

i_branch_cnt integer S Number of branches on theversion tree that containsthe object.

i_chronicle_id ID S Object ID of the root objectof the version tree thatcontains this object.

i_direct_dsc Boolean S Indicates whether the objecthas any direct descendants(versions derived directlyfrom this object). Thedefault is FALSE.


SysObject


Description

i_latest_flag Boolean S Indicates whether thisversion is the most recentversion of the object on aparticular branch in theversion tree.

log_entry string(120) S Comments specified by theuser.

r_frozen_flag Boolean S Indicates whether the objectis unchangeable because itwas specifically frozen. Thedefault is FALSE.

r_immutable_flag Boolean S Indicates whether the objectcan be changed. The defaultis FALSE.

r_lock_date date S Date that this object waslocked.

r_lock_owner string(32) S Name of the user wholocked the object.

r_version_label string(32) R List of the version labelsassociated with the object.The first position in thisproperty holds the object’simplicit version label. Theremaining rows contain theobject’s symbolic versionlabels.

Event-related propertiesThe SysObject type has the following event-related property.


SysObject

Table 148. SysObject event-related property


Description

r_has_events Boolean S Indicates whether any usershave registered to receiveevents for this object. Thedefault is FALSE.

Lifecycle-related propertiesThe lifecycle-related properties provide information about associated lifecycles (policyobjects).

Table 149. SysObject lifecycle-related properties


Description

r_policy_id ID S Object ID of the associatedpolicy object

r_current_state integer S State number of the currentstate of the object in thelifecycle.

r_resume_state integer S The state number to whichthe object is resumed ifr_current_state identifies anexception state.

Attributes added by system-dened aspectsThe properties in this table are added to Sysobject instances or the object type by asystem-defined aspect. Whether the properties are available for use and examinationwill depend on whether your environment has installed the EMC Documentum productthat adds the aspect and its attributes.


SysObject

Table 150. SysObject aspect-added properties


Description

a_gov_room_id ID S Object ID of the dmc_roominwhich this object is stored,and thereby governed by.


Taxonomy

Taxonomy

Purpose Records the default values for the properties in the categories of a taxomonystructure in the repository.

DescriptionSupertype: CategorySubtypes: NoneInternal name: dm_taxonomyObject type tag: 0b

A taxonomy object records the default values for the properties in the categories ofa taxomony structure in the repository.

PropertiesTable 151, page 434, lists the property defined for a taxonomy.

Table 151. Properties dened for the taxonomy type


Description

taxonomy_version

string(32) S Current version of the installedtaxonomy.


TCF Activity

TCF Activity

Purpose Records a sequence of actions to be executed on entry for a lifecycle state.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmc_tcf_activityObject type tag: 09

A tcf activity object represents a sequence of actions to execute when an object entersa particular state. TCF activity objects are created when a user identifies one or moreactions for a state when defining a lifecycle state in Lifecycle Editor. You cannot createthese objects manually. The actions and their parameters are recorded in an XML filethat is stored as the content of the tcf activity object.


Table 152. Properties dened for the TCF activity type


Description

act_identifier string(256) S Character string identifier that identifiesthis tcf activity object.

act_template_identifier

string(256) S Used internally


TCF Activity Template

TCF Activity Template

Purpose Represents one lifecylce state action.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmc_tcf_activity_templateObject type tag: 09

A tcf activity template object represents one action that may be executed when an objectenters a lifecycle state. A suite of TCF activity template objects is installed with theLifecycle Editor. The content files associated with the objects are XML files that containthe template’s string identifier and the parameters that must be supplied to execute theactions. You cannot create these objects manually.


Table 153. Properties dened for the TCF activity template type


Description

act_template_identifier

string(256) S Character string identifier that identifiesthis tcf activity template object.

template_groups



Transition Condition


Purpose Records a route case condition expression for an automatic transition of a workflowactivity.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_transition_conditionObject type tag: 00

A transition condition object records a conditional expression in a route casecondition. You cannot create these objects directly. They are created when anaddConditionRouteCase method (defined for the IDfActivity interface) is executed bya DFC at version level 5.3 FCS. This method is executed by Process Builder to save anactivity’s route case conditions when any one or more of the route cases contains anXPath expression.

Note: When the addConditionRouteCase method is called by a DFC 5.3 SP1 or later,the method creates routecase condition objects, instead of transition condition objects,to record the expression.


Table 154. Properties dened for the transition condition type


Description

r_aspect_name string(64) R Used internally

r_attribute_name string(32) S Name of the propertyreferenced in theexpression, if any




Description

r_boolean_value Boolean S Value to be used in thecomparison if the datatypeidentified in r_value_type isBoolean.

This is not set if unless thedatatype is Boolean.

r_double_value Double S Value to be used in thecomparison if the datatypeidentified in r_value_type isdouble.

This is not set if unless thedatatype is double.

r_id_value ID S Value to be used in thecomparison if the datatypeidentified in r_value_type isID.

This is not set if unless thedatatype is ID.

r_int_value integer S Value to be used in thecomparison if the datatypeidentified in r_value_type isinteger.

This is not set if unless thedatatype is integer.

r_object_alias string(128) S Name of the package, ormanifest values referring tothe workflow or work item




Description

r_relational_op integer S The relation operator in thecondition. Valid values are:

0, meaning =

1, meaning <>

2, meaning <

3,meaning >

4, meaning <=

5, meaning >=

r_repeating_attr_flag

integer S Indicates whether theproperty named inr_attribute_name is arepeating property and ifit is a repeating property,which values to examinewhen evaluating thecondition. Valid values are:

-1, meaning the property isnot a repeating property

0, meaning ANY

1, meaning ALL

2, meaning FIRST

3, meaning LAST

r_string_value string(1024) S Value to be used in thecomparison if the datatypeidentified in r_value_type isstring.

This is not set if unless thedatatype is string.




Description

r_time_value Date S Value to be used in thecomparison if the datatypeidentified in r_value_typeis Date.

This is not set if unless thedatatype is Date.

r_value_type integer S Data type of the value in therelational expression. Thedata type is expressed as anIDfValue constant.

r_xpath_datatype string(64) S The xschema’s built-indatatype name.


r_xpath_expression string(1024) S An XPath expression.


r_xpath_value string(1024) S Literal value used in theXPath transition conditionevaluation. The value isin the format in whichit is found in the XMLdocument.



Type

Type

Purpose Stores structural information about an object type in the repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_typeObject type tag: 03

A type object stores structural information about an object type in the repository. Theobject types in Content Server are themselves represented as types (that is, each type isan object of type dm_type). Content Server does not allow you to create new objects oftype dm_type directly. Instead, when you create a new type or subtype, Content Serverautomatically creates an object of type dm_type to describe your new type. (To create anew type, use the DQL CREATE TYPE statement.)

The values in the repeating properties across one index position represent one propertydefined for the object type.


Table 155. Properties dened for the type object type


Description

attr_count integer S Number of properties in thetype (includes defined andinherited)

attr_identifier integer R Uniquely identifies theproperty within the typehierarchy. Values start from1.

attr_length integer R Indicates the length ofthose properties that arestring-valued.


Type


Description

attr_name string(40) R Names of the type’sproperties

attr_repeating Boolean R Indicates if the propertiesare repeating

attr_restriction integer R Identifies any restrictions onthe property. Valid valuesare:

0, meaning no specialrestrictions

1, meaning the property is anon-qualifiable property

attr_type integer R Contains integer valuesrepresenting the datatype ofthe properties. Valid valuesare:

0, Boolean1, Integer2, String3, ID4, Date and Time5, Double

i_type integer S Used internally

info ID S Object ID of the type’sassociated type info object

name string(27) S Name of the type

next_attr_identifier integer S Next available propertyidentifier in the typehierarchy

owner string(40) S Name of the type’s owner(creator)

r_object_id ID S Object ID of the type

r_index_attr ID S Object ID of the index objectdescribing any indexesbuilt on the type’s repeatingproperties.


Type


Description

shared_parent_name

string(40) S For lightweight objecttypes, this is the nameof the parent object type.The parent is the typewith whose instances thelightweight type instancesare sharing properties.

For all other types, this isthe same as the value insuper_name.

start_pos integer S Position of the firstnon-inherited property

super_name string(40) S Name of the type’ssupertype

s_index_attr ID S Object ID of the index objectdescribing any indexes builton the type’s single-valuedproperties.

type_category integer S Identifies the category towhich the type belongs.Valid values are:

• 0, standard object type• 1, aspect property objecttype

• 2, shareable object type• 4, lightweight object type

views_valid Boolean S Indicates if the views for thetype are valid. This is usedinternally during recoveryoperations.


Type Info

Type Info

Purpose Sstores non-structural information about an object type.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_type_infoObject type tag: 2e

A type info object stores non-structural information about an object type. Storingnon-structural information separately from the type’s structure definition (the dm_typeobject) enhances the performance when a type is altered.


Table 156. Properties dened for the type info type


Description

acl_domain string(32) S The domain (owner) of theACL associated with thetype definition. The value iseither the name of the userwho created the ACL or, forsystem ACLs, the name ofthe repository owner.


default_aspects string(64) R List of aspects definedfor the object type. Theseare identified by thename of the aspect asdefined in the aspect’sobject_name property of itsdmc_aspect_type object.


Type Info


Description

default_group string(27) S Default group defined forthe type.

default_group_permit

integer S Default object-levelpermission defined atthe group level for the type.

default_owner_permit

integer S Default object-levelpermission defined atthe owner level for the type.

default_storage ID S Object ID of a storageobject of type dm_store.This identifies the defaultstorage type for the contentsassociated with any objectof this type.

default_world_permit

integer S Default object-levelpermission defined atthe world level for the type.

ftindex_attrs string(27) R For lightweight objecttypes, contains a listof properties that areindexed. The list does notcontain the basic SysObjectproperties that are indexedby default (acl_name,acl_domain, owner_name,and r_object_type) if theobject type has fulltextsupport.

This property is notcurrently used forany object type exceptlightweight object types.

i_type_features integer S The value in this property isa bitmask used internally byContent Server to identifyseveral characteristics of theobject type.


Type Info


Description

locally _managed Boolean R Indicates whether a givenproperty is locally orglobally managed if therepository is participatingin a federation.

The value at each indexlevel corresponds tothe property named inattr_names in the type’sdm_type object.

r_object_id ID S Object ID of the type infoobject

r_orig _declaration Boolean R Indicates whether a givenproperty is defined for thetype or inherited. TRUEmeans it is defined for thetype.

The value at each indexlevel corresponds tothe property named inattr_names in the type’sdm_type object.

r_supertype string(27) R List of all supertypes of thetype.

r_type_id ID S Object ID of the type objectthat contains the definitionof the type.

r_type_name string(27) S Name of the typerepresented by thetype object identified inr_type_id.


Type Info


Description

type_cache_vstamp integer S Records the value of thedm9_change_record.type_change_count when thetype was changed.

When a type is changed, thevalue of type_change_countis first incremented,and then the newvalue is written to thetype_cache_vstampproperty.

type_override ID S Object ID of thedm_aggr_domain object, ifany, for the object type.

type_version integer S Version number of theobject type. This isincremented when typeproperties are added,changed, or deleted.


User

User

Purpose Contains information about a user in the repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_userObject type tag: 11

A user object contains information about a user in the repository. The informationincludes the user’s default permissions, electronic mail address, default folder, and inboxobject identifier. You must have Sysadmin or Superuser user privileges to create or dropa user or to activate or deactivate a user.


Table 157. Properties dened for the user type


Description

acl_domain string(32) S Identifies the domain(owner) of the ACLassociated with the user.The value is either the userwho created the ACL or, forsystem ACLs, the name ofthe repository owner.


alias_set_id ID S Object ID of the alias setobject representing theuser-level default alias set.


User


Description

client_capability integer S Indicates what level of use isexpected of the user. Validvalues are:• 0 or 1, for consumer• 2, for contributor• 4, for coordinator• 8, for systemadministrator


deactivated_ip_addr


deactivated_utc_time

Date S Reserved for future use

default_folder string(200) S Identifies the user’s defaultfolder.

The default is Temp.

description string(255) S User-defined description ofthe user.

failed_auth_attempt

integer S Number of unsuccessfulauthentication attempts onbehalf of the user.

With the exception of theinstallation owner, this is setto 0 when a user is created.The default value for theinstallation owner is -1.

Setting this to -1 for any userdisables the feature for thatuser.

If the feature is enabled fora user, the value is resetto 0 whenever the user isauthenticated successfully.


User


Description

first_failed_auth_utc_time

Date S Reserved for future use

globally_ managed Boolean S Indicates whether the userobject is managed globallyor locally. The default isFALSE, meaning that it islocally managed.

Requires at least Sysadminprivileges to change.

group_def _permit integer S Default group permit. Thisis used to assign object-levelpermission at the group levelto any object the user createsif no permission at that levelis explicitly assigned.

home_docbase string(120) S The user’s home repository.

last_login_utc_time

Date S The time, in UTC format,of the user’s last login to arepository.

This property is not set if theuser is the dmadmin user orif the value in the propertyhas been set to NULLDATE .

Note: Only a superuser canset this to NULLDATE.

owner_def _permit integer S Default owner permit. Thisis used to assign object-levelpermission at the ownerlevel to any object the usercreates if no permissionat that level is explicitlyassigned.

r_has_events Boolean S Whether someone hasregistered the user forauditing.


User


Description

r_is_group Boolean S Indicates if the userrepresents a group or anindividual user.

r_modify_date date S Time and date of the lastchange to the user object.

r_object_id ID S Object ID of the user.

restricted_folder_ids

ID R Object IDs of the cabinetsor folders which the usercan access. The user canaccess these objects andtheir subfolders. If set, theuser may access only thesefolders.

This is a local property, not aglobal property.

user_address string(80) S User’s electronic mailaddress. This is a requiredproperty.

user_admin string(32) S Identifies who is allowed tomodify the user object. Validvalues are an individual username or a group name.

user_db_name string(32) S User’s user name in theunderlying RDBMS.

This must consist of ASCIIcharacters.

user_delegation string(32) S The name of a user to whomto delegate work items.

user_global_unique_id


user_group _name string(32) S The default group. This isused when the user createsan object as part of thedetermination of the object’sdefault group.

user_initials string(16) S Reserved for future use


User


Description

user_ldap_dn string(255) S User’s Distinguished Namein LDAP.

user_login_domain

string(255) S Name of the Windowsdomain against which thisuser is authenticated.

If the user is an LDAP user,the property stores theobject name of the LDAPconfig object representingthe LDAP directoryagainst which the useris authenticated.

This may be blank.

user_login_name string(80) S Name used to authenticatethe user. This property mustbe set.

If a domain is notrequired in the repository,user_login_name must beuniquewithin the repository.

If a domain is required,the combination ofuser_login_name anduser_login_domain must beunique.

user_name string(32) S Content Server user name.This can be an individualuser or a group name. Itmust be unique among theuser and group names in therepository.

The name must consist ofcharacters compatible withthe server_os_codepage ofthe Content Server.


user_os_domain string(15) S Windows domain nameassociated with user.


User


Description

user_os_name string(32) S The name of the user’soperating system account, ifany.

This must consist of ASCIIcharacters if specified.

user_password string(256) S Encrypted password for theuser. This is set only if theuser’s user_source is set to“inline password”.

When displayed, it displaysas 16 asterisks (*).

user_privileges integer S Identifies the user’s userprivileges. This valueis the sum of the valuescorresponding to the userprivileges defined for theuser. For example, if a userhas Create Type and CreateCabinet user privileges, thevalue is 3.

The privileges and theirvalues are:

None (0)Create Type (1)Create Cabinet (2)Create Group (4)Sysadmin (8)Superuser (16)

For more information aboutthese levels, refer to theContent Server AdministrationGuide.


User


Description

user_source string(16) S Indicates the source of theuser’s authentication. Validvalues are:

LDAP, meaning the user isauthenticated through theLDAP directory server.

unix only, meaning theuser is authenticated bystandard UNIX mechanism;the domain isn’t used.

domain only, meaning theuser is authenticated againstthe Windows domain; theUNIX password file isn’tused.

unix first, meaning the useris authenticated first by thestandard UNIX mechanism.If that fails, the user isauthenticated against theWindows domain.

domain first, meaningthe user is authenticatedfirst against the Windowsdomain. If that fails, the useris authenticated using thestandard UNIX mechanism.

inline password, meaningthat the user is authenticatedagainst the password storedin the user_passwordproperty.

plugin_identifier, meaning theuser is authenticated usingthe plug-in identified by theidentifier. The identifier forthe plug-ins provided withContent Server are dm_rsaand dm_netegrity.


User


Description

Note: The UNIX- anddomain-related values areeffective only if an authconfig object exists in therepository.

user_state integer S Indicates the user’sactivation state. Validvalues are:

0, indicating a user who canlog in

1, indicating a user whocannot log in

2, meaniing a user who islocked

3, meaning a user who islocked and inactive

user_web_page string(255) S Reserved for future use

user_xprivileges integer S The user’s extended userprivileges. The value isthe sum of the valuescorresponding to theextended user privilegesdefined for the user. Forexample, if a user has ConfigAudit and Purge Auditprivileges, the value is 24.

The privileges and theirvalues are:

8, Config Audit

16, Purge Audit

32, View Audit


User


Description

workflow_disabled

Boolean S Indicates the user’savailability for work itemassignment. Valid valuesare:

0, meaning available

1, meaning not available

The default is 0 (available).

world_def _permit integer S Default world permit. Thisis used to assign object-levelpermission at the world levelto any object the user createsif no permission at that levelis explicitly assigned.


Validation Descriptor

Validation Descriptor

Purpose Stores configuration information used by DFC and ACS or BOCS servers.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_validation_descriptorObject type tag: 08

Validation descriptor objects record configuration information that is shared betweenDFC and ACS or BOCS servers. These objects are created and managed internally byContent Server.

Caution: Do not modify this type or instances of this type.

PropertiesTable 158, page 457, lists the properties defined for this type.

Table 158. Properties dened for the validation descriptor type


Description

descriptor_version string(16) S Used internally

parameter_names string(255) R Used internally


Validation Module

Validation Module

Purpose Represents a business module that corresponds to a Docbasic expression defined ina func expr object.

DescriptionSupertype: ModuleSubtypes: NoneInternal name: dmc_validation_moduleObject type tag: 0b

A validation module represents the Java equivalent of the Docbasic expressionsidentified in func expr objects. Each validation module stores the Java equivalents for allDocbasic expressions defined for check constraints or for conditional value assistance fora particular object type. A validation module object is associated with the equivalentfunc expr objects by a relationship whose name is dmc_expr_to_module. The validationmodule is related to the dmc_jar object that contains the compiled code through arelationship named dmc_module_to_jar.

These objects are created only when a Docbasic expression is manually converted to aJava expression. Documentum 6 and later does not require manual conversion, as theconversion happens at runtime automatically. Manual conversion is required only forclients prior to Documentum 6.


Table 159. Properties dened for the validation module type


Description

expr_code_object_id

ID S Object ID of thedmi_expr_code objectthat contains the originalDocbasic expressions fileand P-code file for theexpressions.

(The expressions arecompiled into one file and


Validation Module


Description

the P-code file generatedfrom that file. Both thesource file and the P-codefile are stored as content ofthe expr code object.)

implementation_enabled

Boolean S Whether Java evaluation isenabled for the expressionsimplemented by thismodule.

Tmeans that Java evaluationis enabled; Fmeans that Javaevaluation is not enabled.

The value in this propertytakes precedence overthe expr_enabledsetting in the associateddmc_validation_relationobject.

referenced_type_name

string(27) R Name of the object typeto which the expression isbound. Currently, only onevalue in this property issupported.


Validation Relation

Validation Relation

Purpose Relates a func expr object to a validation module object.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_validation_relationObject type tag: 37

A validation relation object relates a func expr object to the validation module thatrepresents the Java equivalent of the Docbasic expression in the func expr object. Therelation_name value for all validation relation objects is dmc_expr_to_module.


Table 160. Properties dened for the validation relation type


Description

expr_enabled Boolean S Whether Java evaluation isenabled for the expressionrepresented by the relatedvalidation module. T meansJava evaluation is enabled; Fmeans that Java evaluationis not enabled.

The setting in this propertycan be overriddenby the setting of theimplementation_enabledproperty in thedmc_validation_moduleobject.

has_implementation

Boolean S Indicates whether actualJava code exists for theexpression.


Validation Relation


Description

This is set to F if theDocbasic expression wasnot successfully migrated toJava code for the validationmodule.

If this is F, thenexpr_enabled is F andcannot be reset to T.


Value Assist

Value Assist

Purpose Describes the value assistance provided through the data dictionary for an property.

DescriptionSupertype: Persistent ObjectSubtypes: Value List, Value Query, Value FuncInternal name: dm_value_assistObject type tag: 5a

A value assist object describes the value assistance provided through the data dictionaryfor an property. Value assist objects are created and managed by Content Server andcannot be created by users.


Table 161. Properties dened for the value assist type


Description

complete_list Boolean S Indicateswhether the valuesreturned by value assistanceare the only acceptablevalues for the property.

TRUE means that they arethe only acceptable values.FALSE means that othervalues are acceptable.


Value Assist


Description

domain_type integer S Indicates the datatype forthe values returned by valueassistance. Valid values are:

0, meaning Boolean1, meaning Integer2, meaning String3, meaning ID4, meaning Time/date5, meaning Double

object_name string(32) S Currently unused.

parent_id ID S Object ID of the aggrdomain object to which theproperty belongs.

use_as_constraint Boolean S Currently unused.

value_estimate integer S The number of valuesexpected to be returned byvalue assistance.


Value Func

Value Func

Purpose Describes the procedural form of value assistance.

DescriptionSupertype: Value AssistSubtypes: NoneInternal name: dm_value_funcObject type tag: 5d

A value func object describes the procedural form of value assistance. Value func objectsare created and managed by Content Server and cannot be created by users.


Table 162. Properties dened for the value func type


Description

func_expression ID S Object ID of the func exprobject representing the userfunction to call.

value_separator string(1) S Defines the character usedas a separator in the valuelist returned by the userfunction. The default is acomma (,).


Value List

Value List

Purpose Contains the valid values for the list form of value assistance.

DescriptionSupertype: Value AssistSubtypes: NoneInternal name: dm_value_listObject type tag: 5b

A value list object contains the valid values for the list form of value assistance. Value listobjects are created and managed by Content Server and cannot be created by users.


Table 163. Properties dened for the value list type


Description

valid_values string(255) R List of string valuesrepresenting literals ofthe appropriate data type.Each literal must be uniquewithin the list.

The list values are displayedto users in the order inwhich they appear in theproperty.


Value Query

Value Query

Purpose Contains information for the query form of value assistance.

DescriptionSupertype: Value AssistSubtypes: NoneInternal name: dm_value_queryObject type tag: 5c

A value query object contains information for the query form of value assistance. Valuequery objects are created and managed by Content Server and cannot be created by users.


Table 164. Properties dened for the value query type


Description

allow_caching Boolean S Indicates whether thequeries defined for valueassistance can be cached.

TRUE means that thequeries can be cached.FALSE means that thequery should be rerun eachtime it is needed.


Value Query


Description

query_attribute string(32) S The property from thequery’s selected values listthat will provide the data tobe displayed. The default isthe first selected value.

query_string string(255) R The DQL SELECTstatement that returnsthe value assistancevalues. If it is longerthan 255 characters, thefirst 255 characters appearin query_string[0], thesecond 255 characters inquery_string[1], and soforth. The continuationcharacter is an underscore(_).


Vstamp

Vstamp

Purpose Used internally by the system, at start-up, to validate the consistency of the serverand repository.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_vstampObject type tag: 1e

A vstamp object is used internally by the system, at start-up, to validate the consistencyof the server and repository.

PropertiesTable 165, page 468, lists the properties for the object type.

Table 165. Properties dened for the vstamp type


Description

i_application string(64) S Name of the client program

i_stamp integer S Value used internallyto validate repositoryconsistency


WF Attachment

WF Attachment

Purpose Describes an attachment to a workflow.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_wf_attachmentObject type tag: 00

A wf attachment object describes an object added at runtime to a workflow or workitemas an attachment.


Table 166. Properties dened for the WF attachment type


Description

r_component_id ID S Object Id of the objectattached to the workflow

r_component_name

string(80) S Name of the object attachedto the workflow

r_component_type string(40) S Object type (actual orsupertype) of the objectattached to the workflow

r_creation_date Date S Date and time theattachment was attached tothe workflow

r_creator_name string(32) S Name of the user whoattached the object to theworkflow

r_workflow_id ID S Object ID of the workflowto which the object isattached.


WF Package Schema

WF Package Schema

Purpose Stores the URI of a workflow package schema.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_wf_package_schemaObject type tag: 37

A wf package schema object stores the URI of a schema associated with a package whosecomponent is an XML file. It is used to validate any XPath expression referencing thatfile in a transition condition for an activity. WF package schema objects are createdwhen the package is defined using Process Builder. The object type is installed by ascript when Content Server is installed.


Table 167. Property dened for the WF package schema type


Description

schema_uri string(255) S URI of a schema


WF Package Skill

WF Package Skill

Purpose Associates a skill level required for a workflow package with a workflow.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_wf_package_skillObject type tag: 37

A wf package skill object identifies the skill level a user must have to acquire or beassigned the task associated with a particular package. This feature is effective onlywhen applied to tasks on workqueues. WF package skill objects are created at runtimeand associated with the workflow.

Caution: Do not modify this object type nor instances of the object. These objectsare created, maintained, and destroyed internally, as needed.

PropertiesTable 168, page 471, lists the properties defined for the type and the inherited propertieswhose settings are particular to instances of this type.

Table 168. Properties dened for the wf package skill type


Description

child_id ID S This is not set.

child_label string(32) S There is no label set forinstances of this type.

description string(250) S There is no descriptionprovided for instances ofthis type.

package_name string(128) S Name of the package thatrequires the skill levelidentified in skill_level.


WF Package Skill


Description

parent_id ID S Object ID of the workflowwith which the package isassociated

permanent_link Boolean S Set to T (TRUE).

relation_name string(32) S Set to dmc_wf_package_skill

skill_level integer S An integer value identifyingthe required skill level.

Refer to the ProcessBuilder documentationfor information about theskill levels.


WF Timer

WF Timer

Purpose Records the configuration of a timer for a workflow activity.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_wf_timerObject type tag: 00

A wf timer object describes a timer for a workflow activity. The wf timer objects arecreated automatically when the timer is instantiated. The object type is installed by ascript when Content Server is installed.


Table 169. Properties dened for the WF timer type


Description

i_calendar_status integer S reserved for future use

r_act_id ID S Object ID of the activity forwhich this timer is defined

r_act_name string(128) S Name of the activity forwhich this timer is defined

r_act_seqno integer S Sequence number of theactivity instance

r_action_id ID S Object ID of the moduleconfig object associatedwith the timer

r_action_index integer S The index to ther_pre_timer_action orr_post_timer_actionproperty of the activity


WF Timer


Description

r_calendar_id ID S reserved for future use

r_timer Date S Absolute date and time atwhich to trigger the timer

r_timer_type integer S Identifies what kind oftimer this is. Valid valuesare:

0, meaning a pre-timer

1, meaning a post-timer

2, meaning a suspend-timer

r_workflow_id ID S Object ID of the workflowthat contains the activityinstance.


Workow

Workow

Purpose Contains the runtime information about a workflow.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dm_workflowObject type tag: 4d

A workflow object contains the runtime information about a workflow.

PropertiesTable 170, page 475, describes the properties defined for the workflow type.

Table 170. Properties dened for the workow type


Description

correlation_identifer

string(128) S A string value that uniquelyidentifies the workflowinstance

i_next_seqno integer S Indicates the next sequencenumber of an activityinstance.

i_performer_flag integer R Indicates special run-timeconditions such asextension.

initiate_act string(128) S Name of the Initiate activity,if any, from which theworkflow was initiated


Workow


Description

instructions string(255) R User-defined stringdisplayed to users who areusing the sendToDistributedworkflow.

Applications can referencethis property. It must beset before the first Saveoperation on the workflowobject.

object_name string(32) S Contains the workflowname.

parent_act_name string(128) S Name of the activity inthe workflow identified inparent_id from which thisworkflow was started

parent_act_seqno integer S Sequence number ofthe activity identified inparent_act_name.

parent_id ID S Object ID of the workflowthat contains the activitythat started this workflow.

process_id ID S Contains the object IDof process definition (thedm_process object) onwhich this workflow isbased.

r_act_def_id ID R Contains the object ID ofthe activity definitions(dm_activity objects)included in the processdefinition identified inprocess_id.

r_act_errorno integer R Records the failingoperation, if any. Usedfor error recovery.


Workow


Description

r_act_name string(128) R Contains the activityidentifier as defined in thedm_process object.

r_act_seqno integer R Contains the uniquesequence number of anactivity instance.

r_act_state integer R Records the activity’scurrent state. Valid valuesand their correspondingstates are:

0, meaing dormant1, meaning active2, meaning finished3, meaning halted4, meaning failed

r_alias_set_id ID S Records the object ID ofthe alias set used to resolveperformer aliases when theworkflow is created.

This is a runtime copy ofthe alias set identified inperf_alias_set_id of thedm_process object.

r_complete_witem integer R Records the number ofcompleted work items.

r_creator_name string(32) S Indicates the creator.Automatically set by theserver.

r_last_performer string(32) R Contains the activityperformer who last markshis or her own work item ascomplete. Before any workitem of an activity instancecompletes, this may containthe last performer of theprevious activities.


Workow


Description

r_last_witem_id ID R Records the ID of the workitem that was most recentlymarked as complete.

r_perf_act_name string(128) R Contains the namesof activities whoseperformers were chosenat workflow initiationor upon completion ofanother activity. An activityname appears once foreach performer of theactivity. The activity’sperformer appears atthe corresponding indexposition in r_performers.

r_performers string(32) R Contains the name ofa user or group chosenat workflow initiationor upon completionof another activity as aperformer for the activityat the correspondingindex position inr_perf_act_name.

If there are multipleperformers for an activity,each performer appears at adifferent index position, andr_perf_act_name recordsthe name of the activity inthe corresponding indexpositions.

r_post_timer Date R This property is obsolete inversion 5.3. If the workflowand activity were startedprior to upgrading to 5.3,this value is the absolutedate and time when theactivity should finish.


Workow


Description

r_pre_timer Date R This property is obsoletein version 5.3. If theworkflow was started priorto upgrading to 5.3, thisvalue is the absolute dateand time when the activityshould start.

r_repeate_invoke Boolean R Indicates whether thisactivity can be triggeredmultiple times.

r_runtime_state integer S Indicates the current state ofthe workflow. Values are:

0, meaing dormant1, meaning running2, meaning finished3, meaning halted4, meaning terminated

r_start_date date S Represents the start timeof the instance, set by theserver when the workflowenters the running state.

r_target_act_seqno integer R For fault handling activities,this is the sequence numberof the activity of the failedautomatic activity for whichthis fault handling activitywas invoked.

For all other activity types,this is set to -1.

r_total_witem integer R Records the total number ofgenerated work items.

r_trigger_revert integer R Records the number ofrevert ports triggered(either 0 or 1).

r_trigger_input integer R Records the number ofinput ports triggered.


Workow


Description

r_trigger_thresh integer R Indicates the triggeringthreshold.

supervisor_name string(32) S Indicates the workflowsupervisor. The default isthe creator.


Work Item

Work Item

Purpose Stores information about a task for a human or automatic performer.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmi_workitemObject type tag: 4a

Work items are generated by Content Server from an activity object. Users cannotcreate work items. Users can modify only the following properties: a_held_by,a_wq_doc_profile, a_wq_flag, a_wq_name, and a_wq_policy_id.

PropertiesTable 171, page 481, lists the properties for the work item type.

Table 171. Properties dened for the work item type


Description

a_held_by string(32) S Name of the user who hasacquired the task.

This is only set if theworkflow tasks aremanaged using the workqueue feature availablethrough Process Builder.

a_wq_doc_profile string(64) S Name of the work queuedoc profile associated withthis task.

Note: This is only set ifthe workflow tasks aremanaged using the workqueue feature availablethrough Process Builder.


Work Item


Description

a_wq_flag integer S Indicates whether the task ispushed to a queue memberor pulled by a queuemember. Valid values are:

0, meaning the task is pulledby a queue member

1, meaning the task ispushed to a queue member

The default is 1.


a_wq_name string(32) S Name of the work queueto which this work itemis assigned if the task isassigned to a work queue.

For tasks generated byautomatic activities, thismay be set to an errormessage if Content Servercannot process the task.For details, refer to ContentServer Fundamentals.

a_wq_policy_id ID S Object ID of the work queuepolicy that controls how thework item is handled on thequeue.


r_act_def_id ID S Refers to the activitydefinition object.


Work Item


Description

r_act_seqno integer S Records the sequencenumber of the activity inwhich the package is beinghandled.

r_auto_method_id ID S Contains the object ID of anapplication to be invoked (adm_method instance).

r_creation_date datetime S Records date and timeof when a work item isgenerated.

r_due_date datetime S Indicates the date andtime when a work item isexpected to complete.

r_exec_launch Boolean S Indicates whether the workitem is currently executing.TRUE means the work itemis executing; FALSE meansit is not executing.

r_exec_os_error string S Contains the operatingsystem error string, if any.

r_exec_result_id ID S Contains the document IDof the saved results of theapplication execution.

r_exec_retried_count

integer S For automatic tasks, thenumber of times executionhas been attempted

r_exec_timed_out Boolean S Indicates if an executiontimes out.

r_ext_performer string(32) R Lists new performers torepeat the same activity. If agroup name, only one workitem is generated and anygroup member can acquirethe work item.


Work Item


Description

r_handling_instruction

integer S Used internally by theworkflow agent to handleautomatic tasks. Validvalues are:

0, meaning handle in theregular manner

1, meaning TBD

r_launch_timeout Date S Records the date and timeat which at work itemexecution times out. Thisis set when the work itembegins execution if thework item is generatedby an automatic activity.Otherwise, its value isNULLDATE.

r_next_retry_date Date S Time at which a failed taskwill be retried

r_output_port string(16) R Allows a performer tospecify a set of output portsby their unique names.

r_performer_name string(32) S Contains the name of anactivity performer, or theowner name of the methodif this is an automatic workitem.

r_priority integer S Represents the priorityassigned by a performer oran application. The defaultvalue comes from theactivity_priority property ofdm_process of the activityby which the work item isgenerated.

r_queue_item_id ID S Refers to a peerdmi_queue_item object.


Work Item


Description

r_runtime_state integer S Contains the current state ofthe work item. Valid valueare:

0, meaning dormant1, meaning acquired2, meaning finished3, meaning paused4, meaning Dpaused(a work item in thedormant state is paused)5, meaning Apaused(a work item in theacquired state is paused)6, meaning Ppaused(a work item in thepaused state is paused)7, meaning Faulted

Values 4-6 occur when aworkflow containing thework item is halted.

r_target_task_id ID S For fault-handling tasks,this is the object ID of theautomatic activity for whichthis fault-handling task wascreated.

r_workflow_id ID S Contains the object ID of theworkflow that generatedthis item.

return_value integer S Contains the returned valueset by a performer or anapplication.


Work Item


Description

user_cost double S Actual user cost spent tocomplete the work item.


user_time integer S Actual amount of time spentby the user to complete thework item.

The default is 0.


Work Queue

Work Queue

Purpose Represents a work queue for work items generated from a workflow.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_workqueueObject type tag: 00

A work queue object represents a work queue for workflow tasks. The workqueue objecttype is installed by a script when Content Server is installed. However, work queues(instances of the type) are created and managed using Webtop.


Table 172. Properties dened for the work queue type


Description

skill_info_ids ID R Object IDs of the wq skillinfo objects that identify theskills required to completethe tasks in this work queue

wq_category_id ID S Object ID of theworkqueue category objectrepresenting the categoryto which this work queuebelongs

wq_name string(32) S Name of the work queue

wq_policy_id ID S Object ID of the workqueuepolicy used to handle workitems in this queue


Work Queue Category

Work Queue Category

Purpose Defines a category for a work queue.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_workqueue_categoryObject type tag: 0b

A work queue category object represents a category of work queues.

The object type is installed by a script when Content Server is installed. However,instances of the type are created and managed through Webtop when work queuesare set up and managed.

PropertiesThe object type has no properties defined for it. It inherits all its properties fromits supertype, dm_folder. It uses only the object_name, acl_name, and acl_domainproperties. The object_name property stores the work queue category name. Theacl_name and acl_domain properties are set to specify the ACL named “Work QueueUser Default ACL” for all work queue category objects.


Work Queue Doc Prole


Purpose Stores information about a particular kind of document.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_workqueue_doc_profileObject type tag: 00

A work queue doc profile contains information that describes a particular kind ofdocument. The objects are used to manage work items placed on work queues. Workqueues, and consequently, work queue doc profiles, are created using Webtop. The objecttype is installed using a script at the time Content Server is installed.


Table 173. Properties dened for the work queue doc prole type


Description

doc_profile_name string(64) S Name of the doc profile.

owner_name string(32) S Name of the user who ownsthe work queue doc profileobject.

wq_name string(32) R Names of the work queuesto which documents thatuse this profile may beassigned.

wq_policy_id ID R Object IDs of workqueue policy objects.The work queue policyobject identified at aparticular index positionis associated with thework queue specified at




Description

the corresponding indexposition in wq_name.


Work Queue Policy

Work Queue Policy

Purpose Defines configuration information for a work queue.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_workqueue_policyObject type tag: 00

A work queue policy object defines configuration parameters for handling a task in aworkqueue. The parameters control how the items are handled. Each work queue hasone associated work queue policy. If a document associated with a task has a definedwork queue policy, that policy overrides the work queue’s policy.

The work queue policy object type is installed by a script when Content Server isinstalled. You must have installed Documentum Process Builder to use work queuesand their associated work queue policies.


Table 174. Properties dened for the work queue policy type


Description

calendar_id ID S reserved for future use

increment_priority integer S Value by which the taskpriority is incremented

increment_priority_method

string(256) S reserved for future use

increment_priority_mode


initial_priority integer S Initial priority value of tasksin the work queue


Work Queue Policy


Description

max_priority integer S Maximum allowed priorityvalue for an unfinished taskon the queue

max_threshold ID S Maximum number ofunfinished tasks allowed inthe queue

owner_name string(32) S Name of the user who ownsthis work queue policy object

percent_quality_check

integer S Value, interpreted aspercentage, that determineswhether the qualityassurance is performed onthe task when it is completed

policy_name string(255) S Name of the work queuepolicy

policy_type integer S Identifies whether the policydefines the policy of a workqueue or a document. Validvalues are:

0, meaning it is a work queuepolicy

1, meaning it is a documentpolicy


Work Queue User Prole


Purpose Records information about a work queue user.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_workqueue_user_profileObject type tag: 00

A work queue user profile describes a user who performs tasks taken from a work queue.The information includes the user’s skill level. The user profiles are created when thework queue is created.

The object type is installed by a script when Content Server is installed. You must haveinstalled Documentum Process Builder to use work queues and the associated userprofiles.


Table 175. Properties dened for the work queue user prole type


Description

doc_profile_name string(64) R Names of doc profile objects

owner_name string(32) S Name of the owner of thisworkqueue user profileobject




Description

skill_level integer R Defines skill levels for theuser.

The level identified at aparticular index positionapplies to the workqueueand doc profile identifiedin the correspondingindex positions inworkqueue_name anddoc_profile_name.

user_name string(32) S Name of the user

workqueue_name string(32) R Names of the work queues


Wq Skill Info

Wq Skill Info

Purpose Describes a skill required for the performance of a task on a workqueue.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dmc_wq_skill_infoObject Type Tag: 00

An object of type wq skill info records information about a skill required to completea workflow task. These skill descriptions are used in conjunction with user skilldescriptions to determine whether a user can perform a task on from a workqueue.

PropertiesTable 176, page 495, lists the properties defined for wq skill info.

Table 176. Properties dened for the wq skill info object type


Description

display_text string(255) R Text displayed for the skillvalue at the correspondingindex position in one ofthe valid_values_datatypeproperties.

multiple_select integer S Indicates whether a usercan have multiple valuesfor this skill. Valid valuesare:

0, the user may not havemultiple values for this skill(default)

1, the user may havemultiple values for this skill


Wq Skill Info


Description

skill_description string(2000) S Description of the skill

skill_name string(128) S Name of the skill

skill_operator integer S Operator to use whenchecking a user’s actual skilllevel meets the requiredskill for a workflow task.Valid values depend on thedatatype of the skill.

For skills of type inte-ger, valid values are:0, meaing !=1, meaning =2, meaning >3, meaning >=4, meaning <5, meaning <=6, meaning “bit and”7, meaning “bit or”

Note: The value 6 (bit and)is not supported on DB2.

For skills of typedouble, valid valuesare: 0, meaing !=1, meaning =2, meaning >3, meaning >=4, meaning <5, meaning <=

For skills of typestring, valid values are:0, meaning not equals1, meaning equals


Wq Skill Info


Description

skill_type integer S Datatype of the skill. Validvalues are:

0, integer (default)

1, double

2, string

valid_values_double

double R Valid values of the skill.This property is used onlywhen the skill_type is 1.

valid_values_int integer R Valid values of the skill.This property is used onlywhen the skill_type is 0.

valid_values_string string(255) R Valid values of the skill.This property is used onlywhen the skill_type is 2.


Wq Task Skill

Wq Task Skill

Purpose Associates a required skill with a workflow task.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dmc_wq_task_skillObject Type Tag: 00

A wq task skill object associates a skill with a workflow task on a workqueue.


Table 177. Properties dened for the wq task skill object type


Description

skill_info_id ID S Object ID of thedmc_wq_skill_info object.

skill_values_double double R The required skill valuesfor the task. This is set onlywhen the skill is a doubledatatype skill.

skill_values_int integer R The required skill valuesfor the task. This is set onlywhen the skill is a integerdatatype skill.

skill_values_string string(255) R The required skill valuesfor the task. This is set onlywhen the skill is a stringdatatype skill.

workitem_id ID S Object ID of the workitem


Wq User Skill

Wq User Skill

Purpose Records the skill values for a user for a specific skill.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal Name: dmc_wq_user_skillObject Type Tag: 00

A wq user skill object records the skill values for a particular user for a specific skill.


Table 178. Properties dened for the wq user skill object type


Description

skill_info_id ID S Object ID of thedmc_wq_skill_info object

skill_values_double double R The required skill valuesfor the task. This is set onlywhen the skill is a doubledatatype skill.

skill_values_int integer R The required skill valuesfor the task. This is set onlywhen the skill is a integerdatatype skill.

skill_values_string string(255) R The required skill valuesfor the task. This is set onlywhen the skill is a stringdatatype skill.

user_name string(32) S Name of the user


XML Application

XML Application

Purpose Stores the information that defines a particular kind of XML document.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dm_xml_applicationObject type tag: 0b

The information in an xml application object includes the document type definition(DTD) used by the document, the name space identified in the document’s header, andthe document’s root element.

PropertiesTable 179, page 500, lists the properties defined for the type .

Table 179. Properties dened for the xml application type


Description

dtd_public_id string(255) S The public ID of thedocument type definitionidentified in dtd_system_id.

dtd_system_id string(255) S The system ID of adocument type definition.

namespace string(80) S The name space identifiedin the XML document’sheader.


XML Application


Description

root_elements string(32) R Identifies the type of XMLdocument.

root_object _types string(32) R Names of the objecttypes used by the XMLapplication. These arethe formal names of theobject types; for example,dm_document. Customobject types may beincluded.

EMC DocumentumDesktop uses this propertyto determine whichobject types to displayin user interface fields foroperations on objectshandled by an XMLapplication.


XML Cong

XML Cong

Purpose Stores a document type definition file (DTD) as content.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_xml_configObject type tag: 09

An xml config object stores, as content, a document type definition file (DTD), the XMLfile that describes the rules for chunking an XML document in an XML application.

PropertiesTable 180, page 502, lists the property defined for the XML config object type.

Table 180. Properties dened for the xml cong type


Description

config_locator ID S Used internally to manageXML documents.


XML Custom Code

XML Custom Code

Purpose Stores the Java code that implements a custom Java interface as content.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_xml_custom_codeObject type tag: 09

An xml custom code object stores, as content, the Java code that implements a customJava interface.


Table 181. Properties dened for the xml custom code type


Description

class_path string(255) S Java class path of the code.

code_type integer S Identifies the Java interfaceimplemented by the code.Valid values are:

1, meaning code is aDfDTDHandler subclass2, meaning code isa DfDTDDocumentHandler subclass3, meaning Code im-plements IDfLinkDetector

com_class_id string(80) S Currently unused


XML Style Sheet

XML Style Sheet

Purpose Stores an XSL file as content.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_xml_style_sheetObject type tag: 09

An xml style sheet object stores an XSL file as content. An XSL file is a style sheet thatdefines how to format an XML document on output.


Table 182. Properties dened for the xml style sheet type


Description

transformed_format

string(80) S Defines the output fileformat of the XMLdocument.


XML Zone

XML Zone

Purpose Contains the information used to populate the Zone tab on a Find dialog.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_xml_zoneObject type tag: 09

An xml zone object contains the information used to populate the Zone tab on a Finddialog.


Table 183. Properties dened for the xml zone type


Description

description string(32) S User defined.

zone_name string(32) R Identifies one or more zonesthat can be searched in afulltext index search. Azone is the name of an XMLtag.


XML Zone


Chapter 3Lightweight Object Type and Propertiesfor Shareable Object Types and theProperty Bag

This chapter contains reference information for the core object type that implementslightweight objects. It also contains the reference information for the properties thatare only added to an object type that is declared shareable or that has non-qualifiableproperties.

The dm_lightweight type and the properties supporting shareable types are used byEMC Documentum client products. Users cannot create lightweight or shareable objecttypes. There are additional properties defined for dm_type and dmi_type_info that alsosupport these object types. Refer to the description of dm_type and dmi_type_infoobject types to learn about those properties.

The creation and use of non-qualifiable properties is supported for external use. Whenyou create an object type, you may define one or more of the type’s properties asnon-qualifiable. Content Server Fundamentals describes non-qualifiable properties and thesupporting property bag property. The Documentum DQL Reference Manual describeshow to create a type with a non-qualifiable property.


Lightweight

Lightweight

Purpose The supertype for any subtype created as a lightweight object typeNote: Lightweight object types cannot be created by users. They are only usedby EMC Documentum client products.

DescriptionSupertype: NoneSubtypes: User-definedInternal name: dm_lightweightObject type tag: 6E

This object type serves as the supertype of any lightweight object type. Like the persistentobject type, it serves only to pass on its properties to all of its subtypes. Lightweight objectsubtypes are created and used by some EMC Documentum client products and features.You cannot create instances of the lightweight object type or subtypes of this type.

PropertiesTable 184, page 508, lists the properties defined for this object type.

Table 184. Properties dened for the lightweight object type


Description

i_vstamp integer S Version stamp of the object

i_sharing_parent ID S Object ID of the parentobject with which thelightweight object is sharing

If the object is materialized,this value is the object ID ofthe lightweight object.

object_name string(255) S Name of the object

r_object_id ID S Object ID of the object

r_page_cnt integer S Number of primary contentfiles associated with theobject


Properties supporting lightweight and shareable object types and non-qualiable properties

Properties supporting lightweight and shareableobject types and non-qualiable properties

Purpose Provide support for lightweight subtypes andshareable types and non-qualifiable properties.Note: Lightweight and shareable object types cannot be created by users. They areonly used by EMC Documentum client products.

DescriptionThe properties listed here are added to an object type only under specific conditions.The description of each property explains the property’s use and the conditions underwhich it appears in a object type definition.

Table 185, page 509, lists the properties that are added to an object type only in specificcircumstances.

Table 185. Properties added to a type in specic circumstances


Description

i_shared_status integer S The property indicateswhether an instance of theobject type is shared by anylightweight object. Validvalues are:

0, the object is not shared

1, the object is shared

This property isautomatically addedto the definition of anobject type if that type iscreated as a shareable type.Only dm_sysobject or itssubtypes can be shareabletypes.




Description

i_sharing_type ID S This property is added toany object type defined as ashareable object type. Theproperty records the objectID of the dm_type objectrepresenting the top-mostlightweight object type inthe type hierarchy of thelightweight object instancethat shares the shareableinstance.

The property is NULL if nolightweight objects sharethe shareable instance.

i_orig_parent ID S This property is added toany object type definedas a shareable object type.The property records theobject ID of the shareableinstance of the sharing,parent object.

Consequently, for amaterialized lightweightobject, this value records theoriginal sharing instancewith which the lightweightobject shared values.

allow_propagating_changes

Boolean S Indicates whether anychanges applied tothe sharing instanceare propagated to thelightweight objects thatshare the instance.

The default is F.




Description

i_property_bag string(2000) S The property stores thenames and values ofnon-qualifiable properties.It is also used to store thenames and values of aspectproperties if the propertiesare added to the aspectwith the OPTIMIZEFETCHoption.

This property isautomatically addedto the definition of alightweight object type ifthe type definition containsa non-qualifiable property.The property can also beexplicitly added by alteringthe object type.

r_property_bag string(2000) R This property storesoverflow from thei_property_bag property.

This property is added toan object type definition ifthe definition includes thei_property_bag property.


Chapter 4Non-persistent Object Types

This chapter contains the reference information for the non-persistent object types. Theseobject types represent objects that are created as needed at runtime and are destroyedwhen the session is terminated.


Client Cong

Client Cong

Purpose An client config object describes the configuration parameters for sessions.

DescriptionThe client config object type is a non-persistent type.

A client config object is created when DFC is initialized. Its properties are the keys ofthe dfc.properties file. If a key is set in the file, its value is reflected in the client configobject. If a key is not specifically set, the client config object reflects the key’s defaultvalue. The values are applied to all sessions opened by that DFC. This object is intendedfor use by system administrators.

PropertiesTo access the object and retrieve the property values, use the IDfSession.getClientConfigmethod.


Connection Cong

Connection Cong

Purpose Describes a session’s connection to a single repository.

DescriptionThe connection config object type is a non-persistent type.

A connection config object describes a session’s connection to a single repository. Thisobject is intended for use by system administrators.


Table 186. Properties dened for the connection cong type


Description

client_cache_size integer S Defines the size of theclient cache size for thesubconnection. The valueis taken from the sessionconfig’s client_cache_sizeproperty setting

client_cache_write_interval

integer S Controls how often periodicrefreshes of the clientpersistent cache occurs. Thedefault value is 60 minutes.

connection_id ID S Object ID of the sessionobject for the connection.

connection_name string(5) S Connection identifier forthe connection


Connection Cong


Description

force_coherency_checks

Boolean S T disables the use ofconsistency check rules (forclient persistent caches)defined in queries or a cacheconfig object. The default isF (FALSE).

network_requests integer S Number of RPC calls sentby the client session tothe server. This updatesthroughout the session,whenever an RPC calloccurs.

r_date_format string(40) S The date format that will beused to return dates to theuser.

r_docbase_id ID S repository ID of therepository to which thesubconnection is connected.

r_docbase_name string(120) S Name of the repository towhich the subconnection isconnected.

r_events_location string(32) S Name of the location objectin the repository that pointsto the repository’s eventsdirectory.

r_mac_protocol string(32) S Identifies the Macintoshfile-sharing protocol usedby the repository.

r_persistent_caching

Boolean S Whether persistent clientcaching is enabled for thesession. T (TRUE) indicatesthat caching is enabled. F(FALSE) indicates that it isdisabled.

r_security_mode string(32) S Identifies the security modeunder which the repositoryis running.


Connection Cong


Description

r_user_name string(32) S Name of the current user.This value is always thesame as that found in thesession config object.

secure_channel Boolean S Whether the session is usinga secure connection forits repository connection.T (TRUE) means theconnection is secure. F(FALSE) means it is not.


Docbase Locator

Docbase Locator

Purpose Contains information about the repositories known to a connection broker.

DescriptionThe docbase locator type is a non-persistent type.

A docbase locator object is an object that is constructed and returned by a connectionbroker in response to a Getdocbasemap method call. The information for a singlerepository appears at corresponding index levels in the repeating properties. Forexample, the name of the repository whose ID appears in r_docbase_id[0] is found inr_docbase_name[0], and its description is found in r_docbase_description[0].


Table 187. Properties dened for the docbase locator type

Property Datatype Single or repeating Description

auth_protocol string(32) S On Windowsplatforns, if set todomain required,indicates thatthe repositoryis running indomain-requiredmode. If therepositoryis not usingdomain-requiredmode, this propertyis blank.

On UNIX platforms,if you areauthenticating usersagainst a Windowsdomain, this is set to

unix_domain_used


Docbase Locator


Otherwise, thisproperty is blank forrepositories runningon a UNIX platform.

i_docbroker_version

string(32) S Version numberof the respondingconnection broker.

i_host_addr string(32) S The IP address ofthe host on whichthe respondingconnection brokerresides.

i_host_name string(128) S Name of the hostmachine on whichthe respondingconnection brokerresides.

i_port_number integer S Port number ofthe respondingconnection broker.

r_docbase_description

string(128) R Verbose name ordescription of therepository.

r_docbase_id ID R The internal ID ofthe repository.

r_docbase _name string(32) R Name of therepository.

r_federation _name string(32) R Name of thefederation towhich this docbasebelongs, if any.

r_govern _docbase string(32) R For each repositoryparticipating in afederation, the nameof the governingrepository in thefederation.


Docbase Locator


r_object_id ID S Object ID of thedocbase locatorobject.

r_server_version string(32) R Version numbers ofthe servers.


Docbroker Locator

Docbroker Locator

Purpose Contains information about each connection broker that the client DMCL canaccess.

DescriptionThe docbroker locator type is a non-persistent type.

A docbroker locator object contains information about each connection broker that theclient DMCL can access. The object is constructed and returned by the client library inresponse to a Getdocbrokermap method call. The information for a single connectionbroker appears at corresponding index levels in the properties. For example, theprotocol for the connection broker whose host_name appears in host_name[0] is foundin network_protocol[0] and its port number is found in port_number[0].


Table 188. Properties dened for the docbroker locator type


Description

host_name stringstring((128) R Name of the host machineon which the connectionbroker resides

network_protocol string(12) R Protocol for a givenconnection broker

port_number integer R Number of the port onthe host machine that theconnection broker uses forcommunication

time_out integer R Time, in seconds, that aserver waits for a responsefrom the connection brokerbefore forwarding therequest to a backupconnection broker.


Server Locator

Server Locator

Purpose Contains information about the servers known to a connection broker.

DescriptionThe server locator type is a non-persistent type

A server locator object contains information about the servers known to a connectionbroker. A server locator object is constructed and returned by the connection broker inresponse to a Getservermap method call.


Table 189. Properties dened for the server locator type


Description

a_silent_login Boolean S Used internally by theDocumentum clients.

i_connection_protocol

string(12) R Used internally by thedmcl to establish a networkconnection.

i_docbase_id string S Decimal value of theDocBase identifier assignedduring installation.

i_docbroker_version

string(32) S Version number of theresponding connectionbroker.

i_host_addr string(32) S IP address of the hostmachine on which theresponding connectionbroker resides.

i_host_name string(128) S Name of the host machineon which the respondingconnection broker resides.


Server Locator


Description

i_port_number integer S Port number of the port onthe host machine that theconnection broker is usingfor communications.

i_server_connection_address

string(40) R Used internally by thedmcl to establish a networkconnection.

i_logon_support string(64) S Type of logon (Will beNT_Unified_logon forservers running underWindows)

r_client_proximity integer R Indicates how far the serveris from the client. The valuerises directly in relation tothe distance.

r_host_name string(128) R Name of the host machineon which the server resides.

r_keep_entry_interval

integer R How long the connectionbroker will keep the server’sentry in the absence of acheckpoint message fromthe server.

r_last_checkpoint TIME R The time that the server lastreported to the connectionbroker.

r_last_status string(24) R Status of the server process.The value is one of: starting,open, stopped, or presumeddown.

r_next_checkpoint TIME R The time that the server isnext expected to report tothe connection broker.

r_object_id string S Object ID of the serverlocator object.

r_process_id integer R Process ID of the server.


Server Locator


Description

r_server_name string(128) R Name of the server.

r_server_version string(32) R Version number of theserver.


Session Cong

Session Cong

Purpose Contains information about an open repository session.

DescriptionThe session config object type is a non-persistent type.

A session config object contains information about an open repository session. Eachrepository session has one associated session config object. Access to this object isthrough the IDfSessionManager interface.


Table 190. Properties dened for the session cong type


Description

alias_set string(32) S The session-level defaultalias set.

api_exec_count integer S Number of dmAPIExecfunction calls issued duringthe session.

api_get_count integer S Number of dmAPIGetfunction calls issued duringthe session.

api_set_count integer S Number of dmAPISetfunction calls issued duringthe session.


Session Cong


Description

application_code string(32) R Identifies, by application,the application-controlledobjects that this session canmodify. If this is NULL,the session cannot modifyany application-controlledobjects.

Application codes cancontain only alphanumericcharacters and theunderspace character.They cannot contain spacesnor can they start with thecharacters dm_. Codesbeginning with dm_are reserved for use byDocumentum.

batch_hint_size integer S Defines the number of rowsreturned to Content Serverby the RDBMS in a singlecall to the RDBMS. Thedefault is 20.

client_cache_size integer S obsolete

docbase_scope string(120) S obsolete

dynamic_groups string(32) R List of the dynamic groupsto which the sessionbelongs.

ignore_pre_processing

Boolean S Used for customizedworkflows. It directsthe server not to executeexternal applicationsdefined as pre-processing.The default is FALSE.


Session Cong


Description

ignore_post_processing

Boolean S Used for customizedworkflows. It directsthe server not to executeexternal applicationsdefined as post-processing.The default is FALSE.

local_clean_on _init Boolean S Indicates whether theserver should automaticallypurge the client local areawhenever the client isstarted. The default is T.

local_diskfull_check

integer S Defines how often the serverchecks the free space on thedisk containing the client’slocal area. The default is 1,meaning that the space ischecked with each getFile.Setting this to a numbergreater than 1, n, means thatthe space is checked everyn getFiles. Setting it to 0means the space is neverchecked.

local_diskfull _limit integer S Specifies the maximumamount of space that theclient local area may use.The value is interpreted inmegabytes. A value of 0means no limit.

local_purge_on_diskfull

Boolean S Indicates whether the servershould automatically purgethe client local area whenthe diskfull limit is reached.The default value is T.

local_path string(255) S Specifies the location of thelocal client area. Use a fullpath specification.


Session Cong


Description

network_requests integer S Number of RPC calls madeduring the session. Thisis a cumulative number,incrementing by one eachtime an RPC call is made inthe session.

r_cache_query Boolean S Indicates whether thesession is enabled for querycaching. The default valueis FALSE.

r_date_format string(40) S The date format the serverwill use to return datesto the client. The value isderived from the settingin the connectionconfigobject for the first repositoryconnection of the session.

r_events_location string(32) S Identifies the locationobject in the repositoryrepresenting the eventsdirectory. The value isderived from the settingin the connection configobject for the first repositoryconnection of the session.

r_host_name string(128) S Contains the host nameof the machine on whichthe current session wasinitiated.

r_mac_protocol string(32) S Specifies the file-sharingprotocol if this is aMacintosh client session.The value is derived fromthe setting in the connectionconfig object for the firstrepository connection of thesession.


Session Cong


Description

r_security_mode string(32) S Contains the security levelenforced for the repositoryyou are using. The valueis derived from the settingin the connection configobject for the first repositoryconnection of the session.

r_user_name string(32) S Contains the user nameof the currently logged-inuser.

r_working_directory

string(255) S Contains the path of theuser’s working directory.

ref_binding_label string(32) S Defines which documentversion to fetch whenaccessing a remotedocument.

If this property is defined,its value overrides thebinding specified in thedm_reference object thatpoints to the remote object.

session_alias string(12) S Contains the sessionidentifier, as a string literal.

session_codepage string(64) S The code page in use forthe repository session.By default, the valueis obtained from theclient_codepage property ofthe api config object.

If client_codepage is unset,the value is determinedprogrammatically based onthe value in session_locale.

For all session localesexcept ja (Japanese) and ko(Korean), the default settingis ISO-8859-1.

For Japanese, the defaultsetting is Shift_JIS.


Session Cong


Description

For Korean, the defaultsetting is EUC-KR.

session_id ID S Contains the ID of thesession.

session_locale string(32) S Locale of the repositorysession. By default, thevalue is obtained fromthe client_locale propertyof the api config object.If client_locale is unset,the setting is determinedprogrammatically based onthe locale of the client’s hostmachine.

Valid values are:

en, for Englishde, for Germanfr, for Frenchja, for Japaneseko, for Korean


Chapter 5Documentum Process Builder ObjectTypes

This chapter contains the reference information for the object types installed with theDocumentum Process Builder product.

Caution: Instances of these types are created and managed internally. Do notmodify or delete the instances. Additionally, do not modify, delete, or subtypethese object types.

In addition to the object types described in this chapter, there are several object typessupporting workflows that are installed with Content Server. Those object types,described in Chapter 2, Core Persistent Object Types, are:• Activity• Completed Workflow• Completed Work Item• Package• Routecase Condition• Process• WF Attachment• WF Package Schema• WF Package Skill• WF Timer• Workflow• Work Item• Work Queue• Work Queue Category• Work Queue Doc Profile• Work Queue Policy


Documentum Process Builder Object Types

• Work Queue User Profile• Wq Skill Info• Wq Task Skill• Wq User Skill


Wfsd Element

Wfsd Element

Purpose

DescriptionSupertype: dm_lightweightShares: dmc_wfsd_element_parentSubtypes: wfsd element boolean, wfsd element date, wfsdelement double, wfsd element integer, wfsd element stringInternal Name: dmc_wfsd_elementObject Type Tag: 00

The wfsd element object type serves as the supertype for all the object types used tomodel structured data elements for the business process data model functionality. Thewfsd element object type is a lightweight object type. Instances of wfsd element shareproperty values with an instance of dmc_wfsd_element_parent.


Table 191. Properties dened for the wfsd element object type


Description

object_name string(255) S Name of the structured dataelement. This is from itsshared wfsd element parentinstance.

process_id ID S Object ID of the workflowtemplate

sd_type_info_id ID S Object ID of the wfsd typeinfo object that identifies astructured data type.

workflow_id ID S Object ID of the workflowto which the structureddata element belongs


Wfsd Element Boolean

Wfsd Element Boolean

Purpose Represents structured data elements of the Boolean datatype.

DescriptionSupertype: Wfsd ElementSubtypes: NoneInternal Name: dmc_wfsd_element_booleanObject Type Tag: 00

An object of type wfsd element boolean represents a structured data element whosedatatype is Boolean.


Table 192. Properties dened for the wfsd element boolean object type


Description

boolean_value Boolean S Value of the structured datainstance


Wfsd Element Date

Wfsd Element Date

Purpose Represents structured data elements of the date datatype.

DescriptionSupertype: Wfsd ElementSubtypes: NoneInternal Name: dmc_wfsd_element_dateObject Type Tag: 00

An object of type wfsd element date represents a structured data element whosedatatype is date.


Table 193. Properties dened for the wfsd element date object type


Description

date_value Date S Value of the structured datainstance


Wfsd Element Double

Wfsd Element Double

Purpose Represents structured data elements of the double datatype.

DescriptionSupertype: Wfsd ElementSubtypes: NoneInternal Name: dmc_wfsd_element_doubleObject Type Tag: 00

An object of type wfsd element double represents a structured data element whosedatatype is double.


Table 194. Properties dened for the wfsd element double object type


Description

double_value Double S Value of the structured datainstance


Wfsd Element Integer

Wfsd Element Integer

Purpose Represents structured data elements of the integer datatype.

DescriptionSupertype: Wfsd ElementSubtypes: NoneInternal Name: dmc_wfsd_element_integerObject Type Tag: 00

An object of type wfsd element integer represents a structured data element whosedata type is integer.


Table 195. Properties dened for the wfsd element integer object type


Description

int_value integer S Value of the structured datainstance


Wfsd Element Parent

Wfsd Element Parent

Purpose Serves as the supertype for the wfsd element object type.

DescriptionSupertype: SysObjectSubtypes: Wfsd ElementInternal Name: dmc_wfsd_element_parentObject Type Tag: 08

The wfsd element parent object type is defined as shareable object type. If a workflowtemplate has structured data elements in the workflow, there is one wfsd element objectthat is the parent (shared instance) for all the workflow’s structured data elementinstances

PropertiesThis object type has no properties defined for it. It inherits all of its properties fromits supertype.


Wfsd Element String

Wfsd Element String

Purpose Represents structured data elements of the string datatype.

DescriptionSupertype: Wfsd ElementSubtypes: NoneInternal Name: dmc_wfsd_element_stringObject Type Tag: 00

An object of type wfsd element string represents a structured data element whose datatype is string.


Table 196. Properties dened for the wfsd element string object type


Description

string_value string(2000) S Value of the structured datainstance


Wfsd Type Info

Wfsd Type Info

Purpose Records the type definition of structured data types

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_wfsd_type_infoObject type tag: 08

A wfsd type info object records the type definition of a structured data element objecttype.


Table 197. Properties dened for the wfsd type info object type


Description

attr_default_value string(255) R Default value of theproperty identified inthe corresponding indexposition in attr_name.

Note: When accessing thisproperty for properties ofinteger, double, and datedatatypes, cast the value tothe appropriate type.

attr_description string(255) R Description of the property.The value at a particularindex position is associatedwith the property identifiedat the corresponding indexposition in attr_name.


Wfsd Type Info


Description

attr_display_name string(255) R Display name of theproperty. The name at aparticular index positionis associated with theproperty identified atthe corresponding indexposition in attr_name.

attr_element_type_name

string(40) R Name of the property in thewfsd element subtype thatmodels the structured dataelement.

The name at a particularindex position is associatedwith the property identifiedat the corresponding indexposition in attr_name.

attr_is_repeating integer R Indicates whether theproperty is repeatable.Valid values are:

0, the property is notrepeatable (default)

1, the property is repeatable

The value at a particularindex position is associatedwith the property identifiedat the corresponding indexposition in attr_name.


Wfsd Type Info


Description

attr_is_reportable integer R Indicates whether theproperty is reportable.The workflow enginemay report the values ofreportable properties whenan activity is completed.Valid values are:

0, the property is notreportable (default)

1, the property is reportable


attr_is_searchable integer R Indicates whether theproperty may be used insearch screens for searchingactive workflows. Validvalues are:

0, the property is notsearchable (default)

1, the property is searchable



Wfsd Type Info


Description

attr_sdt_name string(2000) R Name of the property inthe structured data elementobject type.

The name at a particularindex position is associatedwith the property identifiedat the corresponding indexposition in attr_name.

attr_type integer R Identifies the datatype ofthe property. Valid valuesare:

0, Boolean1, Integer2, String3, ID4, Time and Date5, Double


element_type_name

string(27) S Name of the wfsd elementsubtype that represents thestructured data element.

This name must be uniquewithin the repository.

object_name string(255) S Display name of thestructured data elementobject type. This isthe display name usedby Process Builder andWebtop.

The property is inheritedfrom dm_sysobject.


Wfsd Type Info


Description

report_type_name string(27) S Name of the object type thatmodels the report table forthe structured data element

This property is empty ifnone of the attributes of thestructured data table arereportable.

sdt_name string(255) S Name of the structureddata element type. Thisvalue is used to exchangedata between EMCDocumentum processesand other systems.

If the structured data typeis created by importinga structured data typeschema, the name is thename of the complexTypeor elementDeclaration ofthe schema element.

target_namespace_uri

string(2000) S Target namespace uri of theschema associated with thestructured data object type.

type_description string(1024) R Description of the property.

xml_config_id ID S Object ID of thedm_xml_config objectthat contains the storagemapping information forthis structured data objecttype.

xml_schema_id ID S Object ID of the xml schemaobject that contains theXML schema informationfor this structured dataobject type.


Wfsdrp Boolean

Wfsdrp Boolean

Purpose Represents the reporting table for structured data elements of type Boolean.

DescriptionSupertype: Wfsdrp ParentSubtypes: NoneInternal Name: dmc_wfsdrp_booleanObject Type Tag: 00

An object of type wfsdrp boolean records the values in the reporting table for onestructured data element of type Boolean.


Table 198. Properties dened for the wfsdrp boolean object type


Description

boolean_value Boolean S Value of the structured dataelement


Wfsdrp Date

Wfsdrp Date

Purpose Represents the reporting table for structured data elements of type Date.

DescriptionSupertype: Wfsdrp ParentSubtypes: NoneInternal Name: dmc_wfsdrp_dateObject Type Tag: 00

An object of type wfsdrp date records the values in the reporting table for one structureddata element of type date.


Table 199. Properties dened for the wfsdrp date object type


Description

date_value Date S Value of the structured dataelement


Wfdsrp Double

Wfdsrp Double

Purpose Represents the reporting table for structured data elements of type double.

DescriptionSupertype: Wfsdrp ParentSubtypes: NoneInternal Name: dmc_wfsdrp_doubleObject Type Tag: 00

An object of type wfsdrp double records the values in the reporting table for onestructured data element of type double.


Table 200. Properties dened for the wfsdrp double object type


Description

double_value double S Value of the structured dataelement


Wfsdrp Integer

Wfsdrp Integer

Purpose Represents the reporting table for structured data elements of type integer.

DescriptionSupertype: Wfsdrp ParentSubtypes: NoneInternal Name: dmc_wfsdrp_integerObject Type Tag: 00

An object of type wfsdrp integer records the values in the reporting table for onestructured data element of type integer.


Table 201. Properties dened for the wfsdrp integer object type


Description

in_value integer S Value of the structured dataelement


Wfsdrp Parent

Wfsdrp Parent

Purpose Serves as the supertype for all reporting subtypes for reportable attributes.

DescriptionSupertype: NoneSubtypes: Wfsdrp Boolean, Wfsdrp Date,Wfsdrp Double, Wfsdrp Integer, Wfsdrp String,Internal Name: dmc_wfsdrp_parentObject Type Tag: 00

This object type is used as the supertype for all subtypes created at runtime for structureddata types that have reportable attributes. These subtypes are used for reporting. Thesubtype inherits the properties of this type.


Table 202. Properties dened for the wfsdrp parent object type


Description

act_name string(128) S Name of the activityassociatedwith this element

act_seqno integer S Sequence number of theactivity associated with thiselement

performer_name string(32) S Name of the work item’sperformer

process_id ID S Object ID of the dm_processobject of the workflow’stemplate.

process_name string(255) S Name of the workflowtemplate

sd_element_name string(255) S Name of the Booleanstructured data element


Wfsdrp Parent


Description

time_stamp_utc Date S UTC time of the reporting

workflow_id ID S Object ID of the workflowinstance

workitem_id ID S Object ID of the work item.


Wfsdrp String

Wfsdrp String

Purpose Represents the reporting table for structured data elements of type string.

DescriptionSupertype: Wfsdrp ParentSubtypes: NoneInternal Name: dmc_wfsdrp_stringObject Type Tag: 00

An object of type wfsdrp string records the values in the reporting table for onestructured data element of type string.


Table 203. Properties dened for the wfsdrp string object type


Description

string_value string(2000) S Value of the structured dataelement


Wfsdrp String


Chapter 6Collaboration Object Types

This chapter contains the reference information for object types supporting DocumentumCollaborative Services. The object types are packaged in the Documentum CollaborativeServices DAR file. Instances of the types are created and managed internally when youuse features of Documentum Collaborative Services. You must have installed ContentServer with a Documentum Collaborative Services license to use the features these typessupport.


Calendar

Calendar

Purpose Serves as the base type for calendars.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_calendarObject type tag: 0b

A calendar object contains the calendar event objects that comprise the calendar. Anyobjects in the calendar folder that are not calendar events are considered attachmentsto the calendar. These objects are created and managed internally when users createcalendars.

PropertiesThe calendar object type has no properties defined for itself. All its properties areinherited from its supertype.


Calendar Event

Calendar Event

Purpose Records an individual event on a calendar.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_calendar_eventObject type tag: 08

A calendar event object stores the information about an event on a calendar. Theseobjects are created and managed internally when users create and modify calendars.Calendar event objects are stored in a calendar folder representing the calendar on whichthe event appears.


Table 204. Properties dened for the calendar event type


Description

change_number integer S Value that is incrementedwhenever a change is madethat invalidates attendeeresponses

end_date date S Event’s end date

event_attendees ID R Object ID of the dm_userobjects of the eventparticipants who have userobjects in the repository


Calendar Event


Description

event_description string

This is Non-qualifiableproperty,so it hasno definedlength.

S Rich text description of theevent.

event_location string(128) S Location of the event

event_organizer ID S Object ID of the repositoryuser who organized the event

event_priority integer S Represents the priority of thevent. Valid values are from 1(highest priority) through 9(lowest priority)

event_uid string(255) S Globally unique identifier forthe event

exception_dates date R For recurring events, thedate of an exception to therecurrence rule.

These are the dates on whichthe event did not occur asscheduled.

has_date_only Boolean S T means that the start andend dates of the event specifyonly the date, with no timecomponent. F means that thestart and end dates include atime component.

is_transparent Boolean S Whether the event appearsto consume time on thecalendar. T means that eventdoes appear to consume time.F means that the event doesnot appear to consume timeon the calendar.


Calendar Event


Description

other_attendees string(255) R List of email addresses ofthose participants who arenot users in the repository

recurrence_dates date R Dates of recurrence instances

recurrence_end date S The upper boundary of therecurrence pattern

recurrence_id date S Date of recurrence which thisevent overrides

recurrence_rule string

This is Non-qualifiableproperty,so it hasno definedlength.

S Recurrence rule

The recurrence rule isspecified in the iCal RRULEformat.

start_date date S The starting date of the event


Comment

Comment

Purpose Records a comment in a discussion

DescriptionSupertype: RichtextSubtypes: NoneInternal name: dmc_commentObject type tag: 08

A comment object represents a single comment in discussion. Comments are createdand managed through Webtop.


Table 205. Properties dened for the comment type


Description

comment_creation_date

date S Original date and timeat which a comment wascreated. This is only set if thecomment object representsa comment copied from theoriginal comment.

comment_creator string (128) S Name of the user whooriginally made the comment.This is only set if the commentobject represents a commentcopied from the originalcomment.

comment_id integer S Identifying value for thecomment within the topic.


Comment


Description

comment_modtag integer S Value of the topic’slast_update_modtagproperty after the mostrecent modification of thiscomment

comment_parentid integer S The identifiying value ofthe comment to whichthis comment is a reply orresponse.

If the comment is not a replyto another comment, this is 0.


Datatable

Datatable

Purpose Contains the objects that comprise a data table.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_datatableObject type tag: 0b

A datatable object contains all the row objects, the datatable schema object, and thefolders for row attachments that together define a data table. The properties of thedatatable record the basic metadata about the datatable, such as its name and owner.These objects are created internally when a user creates a database in CollaborationServices.


Table 206. Properties dened for the datatable type


Description

schema_id ID S Object ID of thedmc_datatable_schemaobject associated with thisdatatable


Datatable Row

Datatable Row

Purpose Serves as the supertype for the custom types created to record the definition of arow in a datatable.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_datatable_rowObject type tag: 08

The datatable row object type is the supertype of all custom object types created torepresent rows in a datatable. These custom types are created when a user creates adatatable. Each row has a custom object type that records the row’s characteristics.

PropertiesThere are no properties defined for this object type. It inherits all properties from itssupertype.


Datatable Schema

Datatable Schema

Purpose Records metadata about a datatable.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_datatable_schemaObject type tag: 08

A datatable schema object records metadata about a datatable in its defined propertiesand stores the XML schema that contains information about the table fields as content.These objects are created and managed internally, as users create, modify, and deletedatatables.


Table 207. Properties dened for the datatable schema type


Description

column_counter integer S Counter that provides aunique suffix to the row typeattribute name, in the format:column_x, where x is aninteger.

is_enterprise Boolean S Indicates whether a schemacan be shared among multipleinstances of a data table.

row_type string(32) S Name of the Content Servertype used for the row

title_column string(32) S Identifier of the columnwhichrepresents the name of therow.


Datatable Schema Ex

Datatable Schema Ex

Purpose Records information required to manage datatable schemas.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_datatable_schema_exObject type tag: 00

A datatable schema ex object is used internally to manage datatables. Do not modify,delete, or change this type or one of these objects directly.


Table 208. Properties dened for the datatable schema ex type


Description

a_column_id string(32) S Identifies the column towhichthe data belongs. The value isthe column_id.

a_next_autonumber

integer S Next automatically generatednumber to use for anauto-number field.

a_schema_id ID S Object ID of the schema


Datatable Settings

Datatable Settings

Purpose

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_datatable_settingsObject type tag: 37

A datatable settings object links a datatable and its datatable schema object or a datatableand a user object. The properties of the datatable settings object store basic informationabout the datatable’s settings.


Table 209. Properties dened for the datatable settings type


Description

fulltext_search_data

string(255) S Full-text search string datavalue

grouping_column string(32) S Id of the group column

grouping_columns string(32) R Ids of the columns that can begrouped

search_column string(32) R List of the columns that aresearchable

search_column_data

string(255) R Search parameters or dataused to build a search query

search_column_data2

string(255) R Additional search parametersor data used to build a searchquery

search_column_opcode

integer R Specifies the operation codeused to build the query


Datatable Settings


Description

sort_column string(32) S Search column identifier

summary_column string(32) R List of summary columns


Discussion

Discussion

Purpose Contains one or more topics or topic subtypes.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_discussionObject type tag: 0b

A discussion object serves as the container for topics relating to a particular discussion.Only objects of type dm_topic or its subtypes may be linked to a discussion.

PropertiesThe discussion object type has no properties defined for the type. It inherits all itsproperties from its supertype.


Notepage

Notepage

Purpose Represents richtext content that is authored and read online.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmc_notepageObject type tag: 09

A notepage object stores a content file in rich text format. You cannot create renditions ofnotepage objects. The content represented by notepage objects is created and used inthe context of collaboration in Webtop.


Table 210. Properties dened for the notepage type


Description

anchor_id ID R Object IDs of any repositoryobjects within the contentfile associated with theobject.


Readcomment

Readcomment

Purpose Used to manage unread comments in a discussion.

DescriptionSupertype: Persistent ObjectSubtypes: NoneInternal name: dmc_readcommentObject type tag: 00

A readcomment object contains information that allows the system to determine whichcomments in a particular discussion are unread by a particular viewer.

PropertiesTable 211, page 568, lists the properties defined for this type.

Table 211. Properties dened for the readcomment type


Description

topic_id ID S Object ID of topic object.

topic_viewed_modtag

integer S Date and time at which theuser in user_name last viewedthe discussion represented bythe topic.

The value is copiedfrom the topic object’slast_update_modtagproperty.

user_name string(32) S Name of user


Richtext

Richtext

Purpose Represents rich text content associated with a SysObject

DescriptionSupertype: SysObjectSubtypes: dmc_commentInternal name: dmc_richtextObject type tag: 08

A richtext object represents richtext content associated with a SysObject either directly,through a relationship, or indirectly as a comment in a topic thread. The actual contentis stored in either the content_value property or as an actual content file associatedwith the richtext object.


Table 212. Properties dened for the richtext type


Description

anchor_id ID R Object IDs of repositoryobjects found in the content

content_value string(2000) S Stores the first 2000 bytes ofthe content

has_content Boolean S Whether the content isfully contained in thecontent_value propertyor whether there is also acontent file attached to theobject.

T means that there is acontent file. F means that thecontent is fully contained incontent_value.


Room

Room

Purpose Provides an additional access management layer for SysObjects.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_roomObject type tag: 0b

A room is a special folder that provides additional, optional functionality to controlaccess to the objects in the folder when the objects are accessed through the room.


Table 213. Properties dened for the room type


Description

builtin_groups string(32) R Names of private groups inthe room.

The first four index positionsare reserved for thesystem-defined groups inroom:

[0]=Members[1]=Owners[2]=Contributors[3]=Visitors

default_contrib_permit

integer S Default base object-levelpermission for thecontributor’s group applied toobjects governed by this room


Room


Description

default_contrib_xpermit

string(32) S Default extended permissionfor the contributor’s groupapplied to objects governedby this room

default_owner_permit

integer S Default base object-levelpermission for the owner’sgroup applied to objectsgoverned by this room

default_owner_xpermit

string(32) S Default extended permissionfor the owner’s group appliedto objects governed by thisroom

is_public Boolean S Whether the room is a publicor private room.

T means the room is a publicroom.

F means the room is a privateroom and only membersof the Members group(builtin_groups[0]) can accessobjects in the room.

The only valid value iscurrently F.

only_owners_ungovern

Boolean S Whether membership inthe Owners groups is anadditional requirement forusers trying to remove anobject from the room.

T means that a user mustbe a member of the Ownersgroup in addition to havingWrite and Change_permitpermissions on an object toremove that object from theroom.

F means that any user inthe room with Write andChange_permit permissions


Room


Description

on the object can remove itfrom the room.

status_text string(maximum)

S Text description of the room’sstatus.

The length of this property isthe maximum allowed by theunderlying database.

status_value integer S Application-defined statusvalue of the room.


Topic

Topic

Purpose Used to manage a single discussion.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_topicObject type tag: 0b

A topic object is used to manage a discussion thread—the set of comments about a singletopic. Discussions are supported in Webtop if you have installed Content Server with aDocumentum Collaborative Services license.


Table 214. Properties dened for the topic type


Description

is_disabled Boolean S Whether the topic is disabled.T means the topic is disabled.F means the topic is notdisabled. The default is F.

Note: Users cannot create,view or edit comments indisabled topics.


Topic


Description

next_comment_id integer S Value to be used as the objectID of the next new comment.

last_update_modtag

integer S Value used internally to trackeach time a topic is modified


Chapter 7Document Submission Manager ObjectTypes

This chapter contains the reference information for the object types that supportDocument Submissions Manager. The object types are installed when you install theDSM DAR file in a repository.

Caution: These object types are used by EMC Documentum Submissions Manager.You must not modify the object types, nor can you create instances of the typesdirectly.


DSM Application

DSM Application

Purpose Contains a eCTD application.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_dsm_applicationObject type tag: 0b

A dsm application object contains all the objects that comprise an eCTD applicationsubmitted and managed by EMC Documentum Submissions Manager.


Table 215. Properties dened for the dmc dsm application type


last_published_name

string(255) S Name of thelast publishedsubmission


DSM Backbone

DSM Backbone

Purpose Represents the root document of the virtual document that represents a submission.

DescriptionSupertype: dsm sectionSubtypes: DSM Stf Backbone, DSM M1 BackboneInternal name: dmc_dsm_backboneObject type tag: 09

A dsm backbone object stores the index.xml file for a submission. This file is the rootdocument of the virtual document that represents the submission in the repository.


Table 216. Properties dened for the dmc dsm backbone type


document_id ID R Used internally

dsm_data_model_version

string(32) S Used internally

is_import_post_processed

Boolean S Used internally

is_published Boolean S Used internally

last_used_leaf_id string(128) S Used internally

leaf_id string(128) R Used internally


DSM Doc Properties

DSM Doc Properties

Purpose Stores the values of the eCTD properties for an eCTD content file.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_dsm_doc_propertiesObject type tag: 37

A dsm doc properties object records the eCTD properties of an eCTD content file. Thevalues are version-specific, so there is one dsm doc properties object for each version ofthe document that contains the file.


Table 217. Properties dened for the dmc dsm doc properties type


application_version string(128) S Version ofthe softwareapplication usedto create the file

checksum_type string(128) S Algorithm usedto generate thechecksum

checksum_value string(128) S Checksum value forthe file

document_keywords

string(4000) S Keywords specifiedfor the file

document_title string(128) S Title of thedocument


DSM Doc Properties


font_library string(128) S Commercial nameof the font or fontset used to createthe document

last_checksum_time

Date S Timestamp of thelast checksum forthis document

version_identifier string(128) S Submitter’sinternal versionnumber or versionidentification forthe report


DSM Drug Product

DSM Drug Product

Purpose Records information about a drug product specified in an eCTD section element.

DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_drug_productObject type tag: 09

A dsm drug product object records the property values specified in a<m2-3-drug-product> or <m3-2-p-drug-product> section element.


Table 218. Properties dened for the dmc dsm drug product type


dosage_form string(128) S The form in whichthe drug was givento study subjects.

manufacturer_name

string(128) S Name of the drug’smanufacturer

product_name string(128) S Name of theproduct


DSM Drug Substance

DSM Drug Substance

Purpose Records information about a drug substance specified in an eCTD section element.

DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_drug_substanceObject type tag: 09

A dsm drug substance object records the property values specified in a<m2–3–s-drug-substance> or <m3–2–s-drug-substance> section element.

PropertiesTable 219, page 581, lists the properties for the type.

Table 219. Properties dened for the dmc dsm drug substance type


manufacturer_name


substance_name string(128) S Name of thesubstance


DSM Excipient

DSM Excipient

Purpose Records information about an excipieint substance specified in an eCTD sectionelement.

DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_excipientObject type tag: 09

A dsm excipient object records the property values specified in a <m3-2-a-1-control-of-excipients> section element.


Table 220. Properties dened for the dmc dsm excipient type


excipient_substance

string(128) S Name of theexcipient substance


DSM Facilities Equip

DSM Facilities Equip

Purpose Records the property values specified in an eCTD section element.

DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_facilities_equipObject type tag: 09

A dsm facilities equip object records the property values in a <m3-2-a-1-facilities-and-equipment> eCTD section element.


Table 221. Properties dened for the dmc dsm facilities equip type



manufacturer_name





DSM Indication

DSM Indication


DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_indicationObject type tag: 09

A dsm indication object records the property values specified in a <m5-3-5-reports-of-efficacy-and-safety-studies> or <m2-7-3-summary-of-clinical-efficacy> eCTD sectionelement.


Table 222. Properties dened for the dmc dsm indication type


indication_name string(128) S Name of theindication


DSM M1 Backbone

DSM M1 Backbone

Purpose Represents as regional backbone.

DescriptionSupertype: DSM BackboneSubtypes: NoneInternal name: dmc_dsm_m1_backboneObject type tag: 09

A dsm m1 backbone object represents a regional backbone file.

PropertiesThis type has no defined properties. It inherits all its properties from its parent type.


DSM Safety Eval

DSM Safety Eval


DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_safety_evalObject type tag: 09

A dsm safety eval object records the property values in a <m3-2-a-2-adventitious-agents-safety-evaluation> eCTD section element.


Table 223. Properties dened for the dmc dsm safety eval type



manufacturer_name





DSM Sect Doc Attributes


Purpose Stores the values of attributes specific to a section-document relationship.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_dsm_sect_doc_attributesObject type tag: 37

A dsm sect doc attributes object stores the values of properties specific to asection-document relationship. The relation_name for objects of this type is alwaysdmc_dsm_section_to_doc.


Table 224. Properties dened for the dmc dsm sect doc attributes type


folder_path string(1024) S Repository locationof the document

leaf_id string(128) S Unique identifierfor this file in theXML instance.

modified_file string(128) S Identifies thelocation of thedocument beingmodified. Thevalue in thisproperty pointsthe the index.xmlfile and the leaf IDof the file beingaltered.




modified_file_id string(32) S Object ID of thedocument specifiedin modified_file

operation_name string(32) S Identifies theoperation to beperformed on thefile to be modified.Valid values are:

new

append

replace

delete

submission_id string(32) S Object ID of thesubmission folderto which thedocument belongs.


DSM Section

DSM Section

Purpose Records information used to display a submission in Virtual Document Manager.

DescriptionSupertype: DocumentSubtypes: DSM Backbone, DSM Drug Product, DSM DrugSubstance, DSM Excipient, DSM Facilities Equip, DSM SafetyEval, DSM Indication, DSM Section Extension, DSM Stf SectionInternal name: dmc_dsm_sectionObject type tag: 09

A dsm section object contains information used by EMC Documentum SubmissionsManager to manage the display of the submission in the Virtual Document Manager.


Table 225. Properties dened for the dmc dsm section type


ectd_profile string(32) S Identifies theassociated DSMconfigurationprofile governingDSM processing

This property maybe empty. If so,the value is derivedfrom the first parentin the virtualdocument thatcontains a valuefor this property.


DSM Section


section_id string(128) S Nameof the section.If the section hasproperties, theproperty valuesare concatenatedwith the sectionname.

section_name string(128) S The eCTD sectionname. The exactvalue depends onwhether the sectionhas properties.


DSM Section Extension

DSM Section Extension

Purpose Records eCTD element extensions.

DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_section_extensionObject type tag: 08

A dsm section extension object records eCTD element extensions. Each pair at the sameindex position in the properties represents a nested level of <node-extension>.


Table 226. Properties dened for the dmc dsm section extension type


extension_id string(128) R List of extensionidentifiers.

extension_title string(128) R Titles of theextensions. The titleat any particularindex position isassociated withthe identifier inthe correspondingposition inextension_id.


DSM Stf Backbone

DSM Stf Backbone

Purpose Represents the backbone of a study tagging (stf.xml) file.

DescriptionSupertype: DSM BackboneSubtypes: NoneInternal name: dmc_dsm_stf_backboneObject type tag: 09

A dsm stf backbone object represents the root document of the virtual document thatrepresents an stf.xml file in the repository. That virtual document is a component of thevirtual document whose root is represented by a dsm backbone object.

PropertiesTable 227, page 592, lists the properties defined for the type. For the repeating properties,the values recorded at a particular index position represent one category name attributeelement.

Table 227. Properties dened for the dmc dsm stf backbone type


category_name string(128) R Category namesidentified in the<category name>properties in a<study-identifier>element.

category_info_type string(32) R Information typeidentified in<category name>properties in a<study-identifier>element.


DSM Stf Backbone


category_value string(128) R The value specifiedin <category name>properties in a<study-identifier>element.

study_id string(128) S Value of the<study-id>attribute in a<study-identifier>element.

study_title string(128) S Value of the <title>attribute in a<study-identifier>element.


DSM Stf Section

DSM Stf Section

Purpose Records the attributes of an eCTD content block within an STF document.

DescriptionSupertype: DSM SectionSubtypes: NoneInternal name: dmc_dsm_stf_sectionObject type tag: 09

A dsm sft section object stores the values of attributes of an eCTD content block from ansft.xml document.


Table 228. Properties dened for the dmc dsm stf section type


block_title string(128) S The title value ofthe content block.

property_info_type string(32) R The informationtypes specified inproperty attributes.

property_name string(128) R The namesspecified inproperty attributes.

property_value string(128) R The values specifiedin propertyattributes.

subject_name string(128) R Name of the subject

subject_info_type string(32) R The informationtype for the subject.


DSM Study Attributes

DSM Study Attributes

Purpose Records the study-related attributes for an STF study report.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_dsm_study_attributesObject type tag: 08

A dsm study attributes object records the vaues of the study attribute for an STF studyreport. The objects are related to the document that stores the report. The relation nameis always dmc_dsm_doc_to_study_attri.


Table 229. Properties dened for the dmc dsm study attributes type


property_info_type string(32) R The informationtypes specified inproperty attributes

property_name string(128) R The namesspecified in nproperty attributes

property_value string(128) R The values specifiedin propertyattributes

study_title string(128) S The title of thestudy

subject_name string(128) R Names of thesubjects

subject_info_type string(32) R The informationtypes for thesubjects.


DSM Study Report

DSM Study Report

Purpose Relates a study report within an STF to a logical content file in the main backbone.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_dsm_study_reportObject type tag: 37b

A dsm study report object establishes a relationship between a study report withinan STF and a logical content fiel in the main backbone. The objects are related to thedocument that stores the report. The relation name is always dmc_dsm_doc_to_stf.


Table 230. Properties dened for the dmc dsm study report type


study_report_status

string(32) S Only valid value isDelete, to indicatethat the logicalcontent has beendeleted from theSTF.


DSM Submission

DSM Submission

Purpose

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_dsm_submissionObject type tag: 0b

A dsm submission object contains all the documents related to a particular submission.


Table 231. Properties dened for the dmc dsm submission type


previous_name string(32) S Previoussubmission namebefore “lock”


DSM Submission


Chapter 8Retention Policy Services Object Types

This chapter contains the reference information for the object types used by RetentionPolicy Services.

Caution: These types are installed with the Retention Policy Services product.Instances of these types are created and maintained through the Retention PolicyServices product. Neither the types nor instances of the types can be changed ormodified by users or client applications other than RPS.


RPS Action

RPS Action

Purpose Identifies the Java class used to execute an action.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_actionObject type tag: 08

An rps action object identifies the class and, optionally the interface within the class, thatis executed to perform an action.

PropertiesTable 232, page 600, lists the properties defined for the type and those inheritedproperties that are used for a specific purpose by the type.

Table 232. Properties dened for the rps action type


Description

action_type integer S Identifies what kind of actionis represented by the rpsaction object. The onlyvalid value is 0, meaning anotification.

class string(128) S Path to the Java class thatexecutes the action

interface string(128) S Path to the Java class interfacethat executes the action

object_name string(255) S Name of the action

subject string(192) S Description of the action


RPS Action Rel

RPS Action Rel

Purpose Relates an rps phase rel object to an rps action object.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_rps_action_relObject type tag: 37

An rps action rel object associates a particular rps phase with an action and identifiesthe execution rule for the action.


Table 233. Properties dened for the rps action rel type


Description

arg_object_id ID R Used internally. Valuedependent on the typeof action identified in theassociated rps action object.

child_id ID S Object ID of the rps actionobject

execution_rule_id ID S Object ID of the executionrule that is the criterion foraction

object_name string(255) S Name of the object

parent_id ID S Object ID of the rps phase relobject representing the phaseassociated with the action


RPS Authority

RPS Authority

Purpose Identifies the persons or agencies that are authorized to determine whether anobject has fulfilled its phase conditions.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_authorityObject type tag: 08

An rps authority object records information about the authorities authorized to determinewhether an object has fulfilled its phase conditions. The rps authority objects are relatedto objects of type dmc_rps_phase_rel objects (representing phases in a retention policylifecycle). The relationship is named dmc_rps_phase_authority_rel_type.


Table 234. Properties dened for the rps authority type


Description

authorizers_id ID R Object IDs of the rps contactobjects representing users oragencies.

is_authority_valid Boolean S Whether this authority isvalid.

T means that this authoritycan determine phasefulfillment; F means thatit cannot be used to determinephase fulfillment.


RPS Authority


Description

object_name string(255) S Name of the authorizing bodyor person. This property isrequired.

title string(400) S User-defined description ofthe authority.


RPS Base Date

RPS Base Date

Purpose Recordswhich property in an object type is used to populate the retention_base_dateproperty in the dmc_rps_retainer objects for instances of the type.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_base_dateObject type tag: 08

An rps base date object records the property in an object type whose value is used topopulate the retention_base_date property in the dmc_rps_retainer objects with whichinstances of object type are associated.


Table 235. Properties dened for the rps base date type


Description

object_type string(32) S Name of the object type.The object type must bedm_sysobject or one of itssubtypes. Use the type’sinternal name.



RPS Base Date


Description

base_date_name string(32) S Name of an property definedfor or inherited by the objecttype identified in object_type.The property must be ofdate/time datatype.


title string(32) S User-defined description ofthe property mapping.


RPS Child Strategy

RPS Child Strategy

Purpose Records the name of the class called to apply an rps retainer object to the objectsassociated with a dm_retainer object.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_child_strategyObject type tag: 08

An rps child strategy object defines the Java class called to attach an rps retainer toobjects that are stored in a container that is associated with an rps retainer object.

PropertiesTable 236, page 606, lists the properties defined for the type and those inheritedproperties that have a specific use in the type.

Table 236. Properties dened for the rps child strategy type


Description

class string(128) S Path to the Java class thatexecutes based on the selectedchild strategy.


interface string(128) S Path the interface for the classspecified in class.

is_container_aging Boolean S Whether the rps retainer ages.T means the container ages; Fmeans it does not.


RPS Child Strategy


Description

object_name string(255) S Name of the child strategy.Valid values are:

ONE_FOR_ALLONE_FOR_EACHRECORDS_STRATEGYEMAIL_STRATEGY

This inherited property isrequired.

retainer_strategy integer S Inherited from rps retainer,this indicates whether allobjects are to use the sameretainer or each object musthave its own retainer. Validvalues are:

0, meaning that each objectmust have its own retainer

1, meaning that all objects areto use the same retainer


RPS Condition

RPS Condition

Purpose Represents a template from which rps event objects are generated.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_conditionObject type tag: 08

An rps condition object defines a condition associated with a particular phase of retentionpolicy lifecycle. RPS condition objects are related to phases (dmc_rps_phase_rel objects)through a relationship named dmc_rps_phase_condition_rel_type.

PropertiesTable 237, page 608, lists the properties defined for the type and the inherited propertiesused for a specific purpose by the type.

Table 237. Properties dened for the rps condition type


Description

category string(32) S Identifies the category towhich the condition isassigned.


object_name string(255) S The name of the condition.For example: Project Closedor Employee Retired

This inherited property is arequired property.

title string(400) S User-defined description ofthe condition.


RPS Contact

RPS Contact

Purpose Records information about a person defined in Retention Policy Manager.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_contactObject type tag: 08

RPS contact objects contain information about persons defined in Retention PolicyManager. The objects are referenced by rps hold objects, rps authority objects, and rpsevent objects.

Note: The persons defined by rps contact objects are not necessarily repository users.

PropertiesTable 238, page 609, lists the properties defined for the type and those inheritedproperties used for a specific purpose by the type.

Table 238. Properties dened for the rps contact type


Description

email string(32) R Email addresses for thecontact

phone string(64) R Telephone numbers for thecontact

object_name string(255) S Name of the contact

title string(400) S User-defined description ofthe contact

user_id ID S Object ID of the contact’s userobject in the repository if thecontact is a repository user.


RPS Disposition Method


Purpose Records the name of the Java class called to dispose of a retained object.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_disposition_methodObject type tag: 08

An rps disposition method object identifies the Java class called to dispose of an object atthe end of retention. Which class is called is dependent on the selected disposition option.

PropertiesTable 239, page 610, lists the properties defined for the type and the inherited propertyused for a specific purpose by the type.

Table 239. Properties dened for the rps disposition method type


Description

class string(128) S Path to the Java class invokedto dispose of an object.

is_container_destroyed

Boolean S Whether the container wasdestroyed on disposition.T means the container isdestroyed; F means that itwas not.




Description

object_name string(255) S Name of the dispositionmethod. Valid values are:

UNKNOWN

REVIEW

TRANSFER/EXPORT

DESTROY

priority_no integer S Defines the action on aretained object when twoof its retainers qualify fordisposition during the samequalification period. Validvalues are:

10, undefined action

30, review

50, transfer or export

70, destroy


RPS Event

RPS Event

Purpose Represents one instance of a dmc_rps_condition object.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_eventObject type tag: 08

An rps event object is an instance of a condition defined in an rps condition object. Itcontains data specific to that instance of the condition. There is one rps event objectgenerated for each rps condition on each rps phase rel object. RPS event objects areassociated with the generating rps condition object through a relation object nameddmc_rps_condition_event_rel_type.


Table 240. Properties dened for the rps event type


Description

a_last_review_date Date S The most recent date and timeat which the condition wasfulfilled.

condition_id ID S Object ID of the rps conditionobject from which this eventwas generated


fulfilled_by ID R Object IDs of the rps contactobjects representing contactswho have indicated that theevent has been fulfilled.


RPS Event


Description

fulfillment_message

string(255) S User-defined message to bedisplayed when this event isfulfilled.

object_name string(255) S Name for the event.

This property is required.

title string(400) S User-defined description ofthe event.


RPS Execution Rule

RPS Execution Rule

Purpose Defines a criterion for execution of an action.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_execution_ruleObject type tag: 08

An rps execution rule object defines when a particular action is to be executed againstan obejct controlled by a retention policy. The definition is recorded in the object name.For example, if object_name is “Phase Entry”, the rule is executed only when the targetobject experiences phase entry.

The object type has no defined properties.

PropertiesTable 241, page 614, lists the inherited properties that it uses for a specific purpose.

Table 241. Properties dened for the rps execution rule type


Description

object_name string(255) S Identifies the criterion forexecution of the associatedaction

subject string(192) S Description of the executionrule


RPS Hold

RPS Hold

Purpose Records information about a hold defined in Retention Policy Services.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_holdObject type tag: 08

An rps hold object represents a hold defined in RPS. Holds prevent deletion of an objectwhen the object is available for disposition at the end of its retention. A hold is associatedwith the object through a relationship named dmc_rps_hold_object_rel_type.


Table 242. Properties dened for the rps hold type


Description

a_last_review_date Date S Date on which the status ofthe hold must be reviewed

a_retention_date Date S Date when the hold wasapplied to the object

approvers_id ID R Object IDs of the rps contactobjects representing userswho have approved the hold

object_name string(255) S Name of the hold



RPS Hold


Description

requestors_id ID R Object IDs of the rps contactobjects representing the userswho requested the hold


title string(400) S User-defined description ofthe hold


RPS Notication

RPS Notication

Purpose Identifies the recipients of notifications

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_notificationObject type tag: 08

An rps notification object records the contacts to be sent notifications for a particularaction and those contacts who acknowledge the notification.


Table 243. Properties dened for the rps notication type


Description

a_last_review_date Date S Date and time at which thenotification was sent

acknowledged_by_id

ID R Object IDs of the rps contactobjects representing contactswho have acknowledged thenotification

action_rel_id ID S Object ID of the rps actionrel object that identifies theaction for a given phase

contact_id ID R Objects IDs of the rps contactobjects representing contactsto be notified

number_sent integer S Number of times thenotification has been sent


RPS Notication


Description

object_name string(255) S Application-defined identifierfor the notification

subject string(192) S Description of the notification


RPS Phase Rel

RPS Phase Rel

Purpose Represents one phase of an RPS retention policy.

DescriptionSupertype: State ExtensionSubtypes: NoneInternal name: dmc_rps_phase_relObject type tag: 37

An rps phase rel object represents one phase in an rps retention policy. The objectassociates a lifecycle definition (dm_policy object) with the dmc_rps_retention_policy.The parent_id property identifies the dm_policy object on which the retention policyis based and the child_id property identifies the rps retention policy. The propertiesdefined for the rps phase rel object define the retention phase.

The relationship represented by the rps phase rel object is named dmc_rps_phase_rel_type.


Table 244. Properties dened for the rps phase rel type


Description

cutoff_day integer S The day in a month up towhich cutoff will be applied.The day is specified by itscalendar number.

cutoff_month integer S The month in the year inwhich cutoff will be applied.The month is specified by itsnumeric position in the year.


RPS Phase Rel


Description

cutoff_period string(32) S Defines an interval usedto round-up cutoff valuesduring processing. Valuesare:

MONTHLY

QUARTERLY

SEMI_ANNUALLY

ANNUALLY

DISABLED

duration_days integer S Number of days in theduration of this phase.

duration_months integer S Number of months in theduration of this phase

duration_years integer S Number of years in theduration of this phase

is_final_phase Boolean S Whether this phase is thefinal phase in the retentionlifecycle. T means that this isthe final phase; F means thatit is not.

phase_name string(32) S Name of the phase. Thisis a derived value, notuser-defined.

storage_id ID S Object ID of the storage areato which to move objectswhen they complete thisphase.


RPS Retainer

RPS Retainer

Purpose Records information about the state of an object’s retention.

DescriptionSupertype: RetainerSubtypes: NoneInternal name: dmc_rps_retainerObject type tag: 08

An rps retainer object mirrors an object’s association with a dm_retainer object andincludes additional information about the object’s status in the retention lifecycle.


Table 245. Properties dened for the rps retainer Type


Description

current_phase_id ID S Object ID of the rps phase relobject representing the phasewith which this rps retainer isassociated

entry_date Date S Date on which the currentphase was entered

event_date Date S The fulfillment date furthestin the future for the currentphase’s conditions.


RPS Retainer


Description

immutability_rule integer S Whether objects under controlof this retention policy areimmutable. Valid values are:

0, the object is changeable

1, the object is immutable

This value is copied from thedm_retainer object.

object_name string(255) S The object ID of the retainer.(An rps retainer’s name is itsobject ID.)

parent_ancestor_id ID S Reserved for future use

phase_name string(32) S Name of the phase identifiedin current_phase_id

qualification_date Date S Date on which objects inthe current phase may bequalified for promotion

r_policy_id ID S Object ID of the lifecycleapplied to this rps retainer.

retainer_root_id ID S Object ID of the objectattached to this rps retainerobject.

This is blank if the childstrategy for the retainer isONE_FOR_ALL.

This is an inherited property.

retention_base_date

Date S Date from which allqualifications, promotions,and dispositions arecalculated

This is as required property.


RPS Retainer


Description

retention_date Date S Earliest time at which theobject attached to this retainerceases to be retained. The dateis calculated by adding sumof all phase durations to thevalue in retention_base_date.

retention_policy_id ID S Object ID of the retainer objecton which this rps retainer isbased.

retention_rule_type integer S Inherited from dm_retainer.This valuemust be 1, meaningretention is specified as a date.

ultimate_ancestor_id

ID S Object ID of the retainer fromwhich all other rps retainerobjects were generated.

This value is applicablewhen the child strategy isONE_FOR_EACH.

vdm_retention_rule

integer S Defines how virtualdocuments and their elementsare retained. Valid values are:

0, meaning the policy maynot be applied to virtualdocuments

1, meaning apply the policyonly to the root document

2, meaning apply the policyto all virtual documentcomponents

The value is copied from theretention policy when theretainer is created.


RPS Retainer Event Rel

RPS Retainer Event Rel

Purpose Associates rps event objects with rps retainer objects.

DescriptionSupertype: State ExtensionSubtypes: NoneInternal name: dmc_rps_retainer_event_relObject type tag: 37

An rps retainer event rel object associates rps event objects with a rps retainerobject. The name of the relationship defined by rps retainer event rel objects isdmc_rps_retainer_event_rel_type.


Table 246. Properties dened for the rps retainer event rel type


Description

phase_id ID S Object ID of the rps phaserel object to which thisrelationship applies

state_no integer S Identifies the phase to whichthe event applies


RPS Retention Policy


Purpose Defines a rule set from which rps retainer objects are generated.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dmc_rps_retention_policyObject type tag: 08

An rps retention policy object defines the rules by which rps retainer objects aregenerated from the dm_retainer objects. The rules represent the influence of the retentionlifecycle definition on the retention policy.


Table 247. Properties dened for the rps retention policy type


Description

aging_method string(32) S Determines whether thepromotion out of phases isbased on conditions or dates.Valid values are:

CONDITIONAL, meaningthat fulfillment of conditionsis used to advance throughthe phases

CHRONOLOGICAL,meaning that dates areused to advance through thephases.

This must be set toCONDITIONAL to defineconditions for phases.

child_strategy_id ID S Object ID of the rps childstrategy object that defines




Description

the Java class invoked toapply retention.

child_strategy_class

string(128) S Java class that executes basedon the selected child strategy.The value is a fully specifiedclass name.

disposition_date Date S Date on which objectsassociated with retentionpolicy are eligible fordisposition

disposition_method_class

string(128) S Java class that executes basedon the selected dispositionmethod. The value is a fullyspecified class name.

disposition_method_id

ID S Object ID of the rpsdisposition method objectthat defines how to disposeof objects controlled by thisretention policy.

disposition_rule integer S Defines how RPS disposes ofan object. Valid values are:

0, meaning DESTROYCHILDREN

1, meaning DESTROY_VDM

2, meaning DESTROY_ROOT

immutability_rule integer S Whether objects controlledby rps retainers based on thispolicy are set to immutable.Valid values are:

0, do not set the objects toimmutable

1, set the objects immutable

is_enabled Boolean S Whether the policy may beapplied to objects.




Description

object_name string(255) S Name of the retention policy.This value is derived fromthe dm_policy on which theretention policy is based.

rendition_rule integer S Whether the retention policyapplies to all content (primaryand renditions) of the objector only to primary content.Valid values are:

0, applies to all content

1, applies only to primarycontent

retainer_lifecycle_id

ID S Object ID of the lifecycledefinition that is applied to allrps retainers generated fromthis retention policy object.

title string(400) S User-defined description ofthe retention policy.

vdm_retention_rule

integer S Defines how virtualdocuments and their elementsare retained. Valid values are:

0, meaning the retentionpolicy may not be applied toa virtual document

1, meaning the policy isapplied only to the rootdocument

2, meaning the policy isapplied to all the virtualdocument components


Chapter 9Site Caching Services Object Types

The object types in this chapter support Documentum Site Caching Services (SCS). Thesetypes are installed when the SCS DocApp archive file is installed in a repository.


SCS Admin Cong

SCS Admin Cong

Purpose Records the common properties for all SCS configurations in the repository and theJDBC connection information for the source repository

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: scs_admin_configObject type tag: 08


Table 248. Properties dened for the scs admin cong type


Description

content_caching_enabled

Boolean S Indicates whethersource-side caching ofcontent is enabled.

The default is F, meaningthat caching is not enabled.

database_connection

string(255) S The JDBC URL with whichto connect to the sourcedatabase.

extra_arguments string(255) R Additional argumentsto be applied to all SCSconfigurations. Thearguments are specifiedin a name and value pairformat. For example:

store_log TRUE


SCS Admin Cong


Description

object_name string(255) S This property is inheritedfrom dm_sysobject.However, because it isrequired for scs adminconfig objects, it is includedin this table.

For scs admin config objects,object_name is the name ofthe repository in which theobject resides.

jdbc_driver string(255) S The JDBC driver class namefor the source databaseconnection

method_trace_level integer S Specifies the methodtrace level for all SCSconfigurations in therepository. Valid valuesrange from 0 to 10.

product_verson string(64) S Version level of the SCSproduct


Webc Cong

Webc Cong

Purpose Describes the documents and properties that are to be exported to a Site CachingServices repository.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_webc_configObject type tag: 08

A webc config object describes the documents and properties that are to be exported to aSite Caching Services repository.


Table 249. Properties dened for the webc cong type


Description

a_event_number integer S Unique number generatedinternally for each publishoperation

a_increment_cnt integer S Number of successfulincremental refreshes sincethe initial publication or thelast full refresh

a_initial_publish date S Date of the initialpublication

a_last_increment date S Date of the last successfulincremental refresh

a_publish_status string(128) S Status of the last operation

a_refresh_date date S Date of the last successfulfull refresh


Webc Cong


Description

content_caching_enabled

Boolean S Indicates whethersource-side caching ofcontent is enabled.

The default is F, meaningthat caching is not enabled.

content_meta_tags Boolean S If TRUE , the system insertsthe document properties asmetatags into the HTMLfiles of the ContentDB. Thedefault is FALSE.

effective_label string(32) S Used to determinewhich documents arevalid for publishing.The export operationexamines the valuesin the a_effective_dateand a_expiration_dateproperties of all documentswhose a_effective_labelproperty value matches thewebc config effective_labelproperty.

If unspecified, effectivelabels are not enforced.

export_directory string(255) S Local directory whereexported files are placedfor pickup by the transferagent. This is a requiredproperty.

export_properties Boolean S If TRUE, the system createsthe PropertiesDB on thetarget site. If FALSE, thePropertiesDB is not created.The default is FALSE.


Webc Cong


Description

extra_arguments string(255) R Additional argumentsfor this specific SCSconfiguration. Thearguments are specifiedin a name and value pairformat. For example:

store_log TRUE

is_active Boolean S Indicates whether thesystem will publishdocuments describedby this webc config object.TRUE (the default) directsthe system to publishthe documents; FALSEsuspends publication.

method_trace_level integer S Controls the trace level foroperations. Valid valuesare the same as thosefor setServerTraceLevelmethod. The default is 0.

notification_user string(32) S Reserved for future use

object_name string(255) S This property is inheritedfrom dm_sysobject.However, because it isrequired for webc configobjects, it is included in thistable.

For webc config objects,object_name is the logicalname of the WebCacherepository.

owner_name string(32) S This property is inheritedfrom dm_sysobject. For thewebc config subtype, theuser defined as the ownermust have Superuser userprivileges.


Webc Cong


Description

publish_arguments string(255) S Specifies arguments to passto the publishing method.Currently, there is one validargument:

-system_validate

This is a Boolean argumentthat determines, inconjunction with thetarget_validate_requiredflag in agent.ini, howauthentication is conducted.-system_validate is set to T(TRUE) by default.

Refer to the WebCachedocumentation for details.

publish_contentless_props

Boolean S Indicateswhether to publishdocuments with no content.The default is F, meaningdocuments without contentare not published.

publish_folder_props

Boolean S Indicateswhether to publishfolder properties. Thedefault is F, meaning thatfolder properties are notpublished.

send_notification Boolean S Reserved for future use

source_attr_isrep Boolean R Indicates whether theproperty named in thecorresponding indexposition in source_attrsis a repeating property.TRUEmeans the property isrepeating. FALSEmeans theproperty is single-valued.


Webc Cong


Description

source_attr_length integer R Length of the propertynamed in the correspondingindex position insource_attrs.

source_attr_type integer R Identifies the datatype ofthe property named inthe corresponding indexposition in source_attrs.Valid values are:

0, for Boolean1, for Integer2, for String3, for ID4, for Date5, for Double

source_attrs string(80) R Identifies additionalproperties to export tothe PropertyDB. Thespecification syntax is:

type_name.property_name

If this property has novalues, then only the defaultproperties are exported.

source_folder_id ID S Object ID of the localfolder that is the root ofthe repository structurethat matches the WebCacherepository. This is arequired property.


Webc Cong


Description

source_formats string(64) R Document formats topublish.

If formats are specifiedin this property, onlydocuments in the specifiedformats are published. Ifa document has multipleformats (a primary formatand renditions), only thosethat are included in the listare published.

If this property isunspecified, all existingrenditions, including theone in the primary format,are published by default.

source_version string(32) S Version of the WebCachesoftware running on thesource. (Informational only)

target_id ID R Object ID of the webc targetobject that references thiswebc config object. This is arequired property.

Note: This is a repeatingproperty to allow for futureenhancements.

transfer_method string(32) S Reserved for future use.

version_labels string(32) R Identifies the repositoryversion youwant to publish.Only documents carryingthe specified version arepublished. Specify only oneversion label.

If you set this to ANYVERSION, the systempublishes whicheverversion is found in thesource folder (the sourcefolder is identified insource_folder_id). It is


Webc Cong


Description

assumed that only oneversion of any particulardocument will be in thesource folder at a giventime.

The default is CURRENT.

Note: This is a repeatingproperty to allow for futureenhancements.


Webc Target

Webc Target

Purpose Describes a Site Caching Services repository on a Site Caching Services target host.

DescriptionSupertype: SysObjectSubtypes: NoneInternal name: dm_webc_targetObject type tag: 08

A webc target object describes a Site Caching Services repository on a Site CachingServices target host.


Table 250. Properties dened for the webc target type


Description

app_server string(32) S Name of the Website delivery engine.(Informational only)

app_server_version

string(32) S Version level of the Website delivery engine.(Informational only)

extra_arguments string(255) R Reserved for future use

global_locales string(5) R Specifies the locales forglobal publishing.

This is only set ifglobal_publishing is setto T.


Webc Target


Description

global_publishing Boolean S Indicates whether globalpublishing is enabled. Thedefault is F, meaning globalpublishing is not enabled.

object_name string(255) S This property is inheritedfrom dm_sysobject.However, because it isrequired for webc targetobjects, it is included in thistable.

For webc target objects,object_name is the logicalname of the WebCacherepository.

online_sync Boolean S Indicates whether the datain the WebCache repositoryis accessible to usersduring the synchronizationoperation. If set to TRUE,the synchronizationagent minimizes thepossibility that users will beinterrupted by repositoryupdates.

The default is FALSE.

online_sync_dir string(255) S Remote directory usedfor the backup copy ofthe WebCache repositoryduring online updates. Thisis required if online_sync isTRUE.

owner_name string(32) S This property is inheritedfrom dm_sysobject. For thewebc target subtype, theuser defined as the ownermust have Superuser userprivileges.


Webc Target


Description

post_sync_script string(48) S Name of a script tobe executed aftersynchronization. Thescript must be stored in theWebCache bin directoryon the target machine.Refer to the WebCachedocumentation for details.

pre_sync_script string(48) S Name of a script tobe executed prior tosynchronization. Thescript must be stored in theWebCache bin directoryon the target machine.Refer to the WebCachedocumentation for details.

probdb_flags string(64) R Reserved for future use.

propdb_ tablename string(64) S Name to use when creatingthe PropertyDB tables.Three tables are createdusing the name in thisproperty:

propdb_tablename_spropdb_tablename_rprobdb_tablename_m

You must specify a nameif the export_propertiesproperty in the webc configobject is set to TRUE.

propdb_ dbversion string(32) S Version level of the targetRDBMS. (Informationalonly)


Webc Target


Description

secure_ connection string(16) S Identifies which agent portto use for the transfer. Validvalus are:• ssl, meaning use thetarget_ssl_port

• raw, meaning use thetarget_raw_port

• both, meaning usethe target_ssl_port ifavailable; if not, use thetarget_raw_port

Note: DocumentumAdministrator will notallow you to specify theboth option; it must be setthrough the API. If youpublish using the bothoption, you will receivewarning messages in thelog file.

sync_arguments string(128) R Reserved for future use

target_host string(128) S Host name or IP addressof the WebCache hostmachine.

target_is_active Boolean S Reserved for future use

target_raw_port integer S Port number at whichthe target Agent processresides. This port is used forunencrypted transmissions.

Either this property ortarget_ssl_port must be set.

target_root_directory

string(255) S The physical directory onthe Web server where thefiles will be placed. This isa required property.


Webc Target


Description

target_ssl_port integer S Port number at whichthe target Agent processresides. This port is used forencrypted transmissions.

Either this property ortarget_raw_port must beset.

target_version string(32) S Version level of theWebCache softwarerunning on the host server.(Informational only)

target_virtual_dir string(255) S The URL for the WebCacheinstallation.

This is a requiredproperty if you are usingWebPublisher™.

transfer_arguments

string(128) R Reserved for future use

transfer_ directory string(255) S Remote directory whereexported files are placedfor pickup by theSychronization agent.This property is requiredif the transfer_methodproperty in the webc configobject is set.

transfer_ domain string(16) S For Windows NT, thedomain of the useridentified in transfer_user.

For other platforms, this isunused.

transfer_ protocol string(16) S Reserved for future use


Webc Target


Description

transfer_user string(32) S User name to use toaccess the remote hostin the transfer operation.The default is the localrepository owner.

transfer_user_password

string(255) S Password for the useridentified in transfer_user.


Chapter 10Forms Builder Object Types

This chapter contains the reference information for the object types supporting EMCDocumentum Forms Builder. The object types are installed when the DAR file providedwith EMC Documentum Forms Builder is installed.


XFM Adaptor Cong

XFM Adaptor Cong

Purpose Records information about a forms adaptor.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmc_xfm_adaptor_configObject type tag: 09

An xfm adaptor config object stores information about a forms adaptors. An adaptor isexecutable Java code invoked by the Forms engine, which allows a form to interact withexternal data sources at runtime. Instances of the type are created internally when EMCDocumentum Forms Builder is used to create a form template.

DescriptionTable 251, page 646, lists the properties defined for the type.

Table 251. Properties dened for the xfm adaptor cong type


Description

adaptor_type string(16) S Identifies the type ofadaptor. Valid values are:• datasource• item-intializer• item-validator• doc-validator• doc-processor

impl_class string(255) S The implementaion class,with a fully qualifiednamespace

impl_type string(16) S Class name of the SBO

input_name string(64) R Name of an input


XFM Adaptor Cong


Description

input_required Boolean R Whether an input isrequired. T means an inputis required.

The value at a particularindex position is applied tothe input specified at thecorresponding position ininput_name.

input_type string(16) R Type of an input.

The type specified at aparticular index positiondefines the input specifiedat the corresponding indexposition in input_name.

is_public Boolean S Whether this adaptoris public. T means theadaptor is public. F meansthe adaptor is not public.

output_type string(64) S If the output is a primitivetype, it can be string,Boolean, integer, date, andso forth.

If the output is a complextype, the value is the nameof the complex type.

param_name string(64) R Names of the initializationparameters

param_value string(255) R Values of the initializationparameters. The valueat a particular indexposition is the valueof the initializationparameter identified atthe corresponding indexposition in param_name.


XFM Form

XFM Form

Purpose Contains information about a form template.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_xfm_formObject type tag: 09

An xfm form object stores information about a form template. Instances of the type arecreated internally when EMC Documentum Forms Builder is used to create a formtemplate.


Table 252. Properties dened for the xfm form type


Description

definition_state integer S Indicates the status of theform. Valid values are:

0, meaning draft

1, meaning validated

2, meaning installed

3, meaning obsolete

description string(300) S User-defined description ofthe form


XFM Form


Description

display_mode integer S Indicates the display modeof the form. Valid valuesare:

0, meaning dialog

1, meaning publish

relationship_to_base

integer S Identifies the relationshipbetween the current formand the base form. Validvalues are:

0, meaning the form is notrelated to the base form

1, meaning the form isrelated to the base form


XFM Instance

XFM Instance

Purpose Represents an instance of a form.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dm_xfm_instanceObject type tag: 09

A xfm instance object contains information about one form. Instances of the type arecreated internally when EMC Documentum Forms Builder is used to create a formtemplate.


Table 253. Properties dened for the xfm instance type


Description

is_default Boolean S Indicates the form is a formdefault instance.

T (TRUE) means the formis a default instance. F(FALSE) means the form isnot a default instance.


XFM Schema

XFM Schema

Purpose Stores information about an XML schema for a form.

DescriptionSupertype: dm_documentSubtypes: NoneInternal name: dm_xfm_schemaObject type tag: 09

An xfm schema object represents an XML schema used with a form. Instances of the typeare created internally when EMC Documentum Forms Builder is used to create a form.


Table 254. Properties dened for the xfm schema type


Description

data_model string(128) S Identifies the root elementof the schema.

storage_option integer S Specifies the storage modefor the schema. Valid valuesare:

0, meaning store as content

1, meaning store ascontent and use an XMLApplication to populateobject properties with thecontent.

storage_type string(32) S Name of the object type ofthe object with which the


XFM Schema


Description

content of the form instanceis associated


Chapter 11Editorial Publishing Services Types

The object types in this chapter are added when the EMC Documentum Content Servicesfor Woodwing product is installed. This product allows users of the Woodwing SmartConnection product to interact with a Documentum Content Server repository.

Some of these types are for internal use by the product only, and are not useful or visibleto users. These types are noted within their individual descriptions.


EPS Cong Cache

EPS Cong Cache

Purpose Records configuration caching information

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_config_cacheObject type tag: 00

An eps config cache object records configuration caching information. This information isused internally to manage cached information about specific object type configurations.

Caution: Do not modify or delete this type or instances of this type.


Table 255. Properties dened for the eps cong cache type

Property Datatype Single/repeating Description

eps_object_type string(32) S Name of the EPS object type

eps_time_stamp Time S Time stamp of the objecttype’s last modification


EPS Elem Type Mapping

EPS Elem Type Mapping

Purpose Records the object types to use with a particular element type

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_elem_type_mappingObject type tag: 0b

An object type eps elem type mapping records the object types that may be used with aparticular element type. Objects of this type are created and managed internally.


Table 256. Properties dened for the eps elem type mapping type


eps_elem_type string(32) S Element type to which theobject type is mapped

eps_object_type_name

string(32) S Object type mapped to theelement type identified ineps_elem_type


EPS Element

EPS Element

Purpose Serves as the base object type for all element subtypes.

DescriptionSupertype: DocumentSubtypes: NoneInternal name: dmc_eps_elementObject type tag: 09

This object type serves as the base object type for all element object types. All elementobject types are subtypes of eps element and inherit its properties. Those propertiesrecord basic information about an element.

Users may create subtypes of the object type through the Content Services for Woodwingobject type editor in the Publication Manager.


Table 257. Properties dened for the eps element type


eps_creation_action

string(32) S Creation action type usedto create the element

eps_ element_type string(32) S Type of element

eps_issue_id ID S Object ID of the issue thatcontains the element

eps_publication_id ID S Object ID of the publicationthat contains the element

eps_route_to_owners

string(2000) S Names of users who havethe element in their inbox

eps_section_id ID S Object ID of the section thatcontains the element

eps_state_name string(255) S Name of the workflow statethe element is in


EPS Element


eps_workflow_id ID S Object ID of the workflow

eps_workflow_template_id

ID S Object ID of the workflowtemplate that was thesource of the workflow ineps_workflow_id


EPS Issue

EPS Issue

Purpose Serves as the base object type for issue object types

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_eps_issueObject type tag: 0b

This object type serves as the base object type for all issue object types. All issue objecttypes are subtypes of eps issue and inherit its properties. Those properties record basicinformation about an issue.

Users may create subtypes of the object type through EMC Documentum ApplicationBuilder.


Table 258. Properties dened for the eps issue type


eps_archived Boolean S Whether the object isarchived

eps_issue_deadline Date S Date on which issue is to bereleased

eps_publication_id ID S Object ID of the publicationto which this issue belongs


EPS Mapping

EPS Mapping

Purpose Serves as the base object type for all mapping tables

DescriptionSupertype: NoneSubtypes: EPS Metadata Mapping, EPS State Perm Mapping, EPSPerformer Mapping, EPS Template Mapping, EPS Schedule MappingInternal name: dmc_eps_mappingObject type tag: 00

This object type records mapping information common to all publications. It serves asthe base type for all other mapping related object types.

Caution: Do not modify or delete this object type or instances of the type.


Table 259. Properties dened for the eps mapping type


eps_issue_id ID S Issue to which the mappingapplies

eps_publication_id ID S Publication to which themapping applies

eps_section_name string(255) S Name of the section towhich this mapping applies


EPS Metadata Mapping

EPS Metadata Mapping

Purpose Records the properties visible on each Woodwing dialog box

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_metadata_mappingObject type tag: 0b

An eps metadata mapping object records the properties of an element that are exposedon a Woodwing dialog box. Objects of this type are created and managed internally.


Table 260. Properties dened for the eps metadata mapping type


eps_attribute_names

string(255) R Names of the visibleproperties

eps_element_type string(32) S Element type to which thisobject applies

eps_woodwing_dialog

string(32) S Name of the Woodwingdialog box on which theseproperties are visible


EPS Page Detail

EPS Page Detail

Purpose Records information about a page in an element in a publication.

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_page_detailObject type tag: 00

An eps page detail object records information about a page within an element.



Table 261. Properties dened for the eps page detail type


eps_element_id ID S Object ID of the element forwhich this object recordspage details

eps_page_height string(32) S Page height

eps_page_number string(32) S Page number

eps_page_order string(32) S Page order

eps_page_width string(32) S Page width


EPS Performer Mapping

EPS Performer Mapping

Purpose Records performer information

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_performer_mappingObject type tag: 0b

An eps performer mapping object records information about a particular performer.Objects of this type are created and managed internally.


Table 262. Properties dened for the eps performer mapping type


eps_performer string(255) S Identifes the performer towhom this mapping applies

eps_performer_can_revert

Boolean S Whether the performer canrevert object states

eps_performer_group_name

string(255) S Name of the group thatrecords performer users


EPS Placement

EPS Placement

Purpose Records information about placed articles and the metadata associated with thelink.

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_placementObject type tag: 00

An eps placement object records information about placed articles and the metadataassociated with the link.



Table 263. Properties dened for the eps placement type


eps_child_id ID S Object ID of the child in theplacement

eps_parent_id ID S Object ID of the parent inthe placement

eps_placement_props

string(255) R Properties of the placement


EPS Pubinfo Cache

EPS Pubinfo Cache

Purpose Records the last modification date of a publication

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_pubinfo_cacheObject type tag: 00

An eps pubinfo cache object records the last modification time of a publication. Objectsof this type are used internally to manage publications.



Table 264. Properties dened for the eps pubinfo cache type


eps_publication_id ID S Object ID of the publication

eps_last_mod_time integer S The time of the publication’slast modification


EPS Publication

EPS Publication

Purpose Serves as the base object type for all publication object types.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_eps_publicationObject type tag: 0b

This object type serves as the base object type all publication object types. All publicationobject types are subtypes of eps publication and inherit its properties. Those propertiesrecord basic information about a publication.



Table 265. Properties dened for the eps publication type


eps_archived Boolean S Whether the publication isarchived

eps_section_names string(255) R Names of the sections in thepublication


EPS Relation

EPS Relation

Purpose Associates articles, layouts, and images.

DescriptionSupertype: RelationSubtypes: NoneInternal name: dmc_eps_relationObject type tag: 37

An eps relation object is used to establish the links between an article and any images itcontains and between the article and its layout. The objects are created automaticallyas needed.


Table 266. Properties dened for the eps relation type


eps_child_version string(32) S Version of the child objectused in the relationship

eps_parent_version string(32) S Version of the parent objectused in the relationship

eps_placement_type

string(255) S Whether this representsa native relationship or aplaceholder relationship.


EPS Schedule Mapping

EPS Schedule Mapping

Purpose Records calendar information

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_schedule_mappingObject type tag: 00

An eps schedule mapping object records calendar information, including workdays andholidays for each year.



Table 267. Properties dened for the eps schedule mapping type


eps_holidays string(32) R List of the holidays in theyear

eps_year integer S Calendar year to which theinformation applies

eps_weekend_days integer R List of the weekends in theyear

eps_workday_overrides

string(32) R Workday overrides


EPS Section

EPS Section

Purpose Serves as the base object type for all section object types.

DescriptionSupertype: FolderSubtypes: NoneInternal name: dmc_eps_sectionObject type tag: 0b

This object type serves as the base object type for all section object types. All sectionobject types are subtypes of eps section and inherit its properties. Those propertiesrecord basic information about a sections.



Table 268. Properties dened for the eps section type


eps_issue_id ID S Object ID of the issue thatcontains this section.

eps_publication_id ID S Object ID of the publicationthat contains this section.


EPS State

EPS State

Purpose Records information about states

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_stateObject type tag: 00

An eps state object records information about states in an editorial workflow process.



Table 269. Properties dened for the eps state type


eps_produce_pdf_flag

Boolean S Default value for theproduce PDF flag for thiselement

eps_required_permission

integer S Permission level required toperform the task associatedwith this state

eps_state_color string(32) S State color

eps_state_duration integer S Expected duration of thestate, in days

eps_state_name string(255) S Name of the state

eps_state_permissions

string(300) R List of performer types andtheir permissions


EPS State Mapping

EPS State Mapping

Purpose Records state configuration information for publications

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_state_mappingObject type tag: 0b

An eps state mapping object records configuration information about a state for aparticular element in a publication. Objects of this type are created and managedinternally.


Table 270. Properties dened for the eps state mapping type


eps_creation_action

string(32) S The creation action type towhich this state informationapplies

eps_element_type string(32) S The element type to whichthis state informationapplies

eps_produce_pdf Boolean S Whether to generate a PDFpreview of the elements inthis state

eps_state_color string(32) S Color to associate withelements in this state

eps_state_duration integer S Expected length of time,from start to finish, for thecompletion of the state

eps_state_name string(255) S Name of the state


EPS State Perm Mapping

EPS State Perm Mapping

Purpose Records the permissions held by performers for each state.

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_state_perm_mappingObject type tag: 0b

An eps state perm mapping object records the permission held by a performer for aparticular state in an editorial workflow process. Objects of this type are created andmanaged internally.


Table 271. Properties dened for the eps state perm mapping type


eps_creation_action

string(32) S The creation action typeto which the permissionapplies

eps_element_type string(32) S The element type to whichthe permission applies

eps_performer string(255) S Performer who holds thispermission

eps_performer_permission

integer S Permission level assignedto the performer identifiedin epss_performer

eps_state_name string(255) S Name of the state to whichthis permission applies


EPS State Transition

EPS State Transition

Purpose Records all state transitions

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_state_transitionObject type tag: 00

An eps state transition object records a state transition. These objects are used internally,for reporting on issue and element status.



Table 272. Properties dened for the eps state transition type


eps_element_id ID S Object ID of the elementparticipating in the statetransition

eps_end_state string(32) S Name of the end state in thetransition

eps_start_state string(32) S Name of the start state inthe transition

eps_time_stamp string(32) S Time stamp of the transition


EPS Template Mapping

EPS Template Mapping

Purpose Records the templates to use for element types

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_template_mappingObject type tag: 0b

An eps template mapping object records the template to be used for a particular elementtype. Objects of this type are created and managed internally.


Table 273. Properties dened for the eps template mapping type


eps_element_type string(32) S Name of the element type

eps_template_id ID S Object ID of the templateobect representing thetemplate to used withthe element identified ineps_element_type


EPS Transition Override

EPS Transition Override

Purpose Records scheduling changes to the master schedule configured for an issue

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_transition_overrideObject type tag: 00

An eps transition override object records a schedule change for an element within anissue.



Table 274. Properties dened for the eps transition override type


eps_element_id ID S Object ID of the elementparticipating in the statetransition

eps_state string(255) S Name of the state in thetransition

eps_start_duration integer S Duration of the state


ID S Object ID of the workflowtemplate


EPS WF Template Mapping

EPS WF Template Mapping

Purpose Identifies the workflow template to be used with an element and creation actiontype

DescriptionSupertype: EPS MappingSubtypes: NoneInternal name: dmc_eps_wf_template_mappingObject type tag: 0b

An eps wf template mapping object specifies which workflow template is to be usedwith a particular combination of element type and creation action type. Objects of thistype are created and managed internally.


Table 275. Properties dened for the eps wf template mapping type


eps_creation_action

string(32) S The creation action typewith which the workflowtemplate is associated

eps_element_type string(32) S Name of the element type


ID S Object ID of theworkflow template objectrepresenting the workflowtemplate to used withthe element identified ineps_element_type


EPS Workow Data

EPS Workow Data

Purpose Records information to be passed to the Java workflow method

DescriptionSupertype: NoneSubtypes: NoneInternal name: dmc_eps_workflow_dataObject type tag: 00

An eps workflow data object records information that is passed to a Java workflowmethod.



Table 276. Properties dened for the eps workow data type


eps_element_id ID S Object ID of the elementto which this informationapplies

eps_performer_name

string(255) S Name of the performer towhom the task is assignedor delegated


EPS Workow Data


eps_state_name string(255) S Name of the state to set theobject to

eps_workflow_id ID S Object ID of the workflowto which this information ispassed


EPS Workow Data


Appendix ALanguage and Country Codes

This appendix lists the recommended language codes and some of the recommended country codesfor use in the language_code property of SysObjects. The language codes are taken from ISO 639. Thecountry codes are taken from the larger set found in ISO 3116.

Table 277. Recommended language codes

Language Code Lanuage Code

Albanian sq Arabic ar

Armenian hy Azerbaijani az

Basque eu Bulgarian bg

Byelorussion be Cambodian km

Catalan ca Chinese zh

Croatian hr Czech cs

Danish da Dutch nl

English en Estonian et

Finnish fi French fr

Georgian ka German de

Greek el Hebrew he

Hungarian hu Icelandic is

Indonesian id Italian it

Japanese ja Kazakh kk

Korean ko Latvian, Lettish lv

Lithuanian lt Macedonian mk

Malay ms Moldavian mo


Language and Country Codes

Language Code Lanuage Code

Norwegian no Persian fa

Polish pl Portuguese pt

Romanian ro Russian ru

Serbian sr Serbo-Croatian sh

Slovak sk Slovenian sl

Spanish es Swedish sw

Thai th Turkish tr

Ukranian uk Uzbek uz

Vietnamese vi

Table 278. Recommended country codes

Country Code Country Code

Argentina AR Austria AT

Australia AU Azerbaijan AZ

Belarus BY Belgium BE

Belize BZ Bolivia BO

Brazil BR Bulgaria BG

Cambodia KH Cameroon CM

Canada DA Chile CL

China CN Colombia CO

Costa Rica CR Croatia HR

Czech Republic CZ Denmark DK

Ecuador EC Egypt EG

Estonia EE Finland FI

France FR Gabon GA

Gambia GM Georgia GE

Germany DE Great Britain (UK) GB

Greece GR Greenland GL

Guatemala GT Haiti HT

Honduras HN Hong Kong HK



Country Code Country Code

Hungary HU Iceland IS

India IN Indonesia ID

Iran IR Iraq IQ

Ireland IE Israel IL

Italy IT Japan JP

Jordan JO Kazachstan KZ

Kenya KE Korea (North) KP

Korea (South) KR Kyrgyz Republic KG

Laos LA Latvia LV

Lebanon LB Libya LY

Liechstenstein LI Lithuania LT

Luxemborg LU Mexico MX

Mozambique MZ Morocco MA

Netherlands NL New Zealand NZ

Nicaragua NI Norway NO

Pakistan PA Panama PK


Appendix BRDBMS Tables for Documentum Types

All the objects in Content Server, and their property values, are stored in a repository. This repositoryis part of a larger database, the relational database (RDBMS). This appendix contains an explanationand an example of the RDBMS tables that describe a Documentum type.

Note: The example tables assume that the underlying RDBMS is Oracle for the datatype descriptions.

OverviewWithin the relational database, each object type is represented by two tables and twoviews:• A table and a view for the object’s single-valued properties, and• A table and a view for the object’s repeating properties.

The tables

The name of the table describing an object’s single-valued properties has the format:typename_s

For example, the table that contains the single-valued properties for the document typeis the dm_document_s table.

The names of the tables describing the repeating properties have the following format:typename_r

For example, the table that contains the repeating properties of the document type isthe dm_document_r table.


RDBMS Tables for Documentum Types

The views

The views join the a type’s tables with the tables of its supertypes. For example, the viewof the single-valued properties for folders joins the dm_folder_s and dm_sysobject_stables. For cabinets, the view joins the dm_cabinet_s, dm_folder_s, and dm_sysobject_stables.

The names of the views that are built on the single-valued property tables have thefollowing format:typename_sp

For example, the single-valued property view associated for dm_document type isnamed dm_document_sp.

Returning database table information

To obtain a listing of a table’s columns and their datatypes in an Oracle database, you usethe SQL Describe statement. For example, the following statement returns a descriptionof the table that stores the SysObject type’s single-valued properties:sql> describe dm_sysobject_s;

The user type tables in the Oracle RDBMSThis section contains examples of the _s and _r tables, with the dm_user type as thedemonstrative type. The views are not shown as they do not differ for this type, as ithas no supertypes.

Table 279, page 684 lists the results of the following statement, which retrieves thecolumns of the dm_user_s table:sql>describe dm_user_s

Table 279. Columns of the dm_user_s table

Column Name Datatype Nullable (Yes/No)

R_OBJECT_ID CHAR(16) N

GROUP_NAME CHAR(32) N

GROUP_ADDRESS CHAR(80) N

I_VSTAMP NUMBER(10) N




I_ATTR_EXTRA2 CHAR(64) Y

I_ATTR_INT1 NUMBER(10) Y

I_ATTR_INT2 NUMBER(10) Y

I_VSTAMP NUMBER(10) Y

Table 280, page 685 shows the results of the following statement, which retrieves adescription of the dm_user_r table:sql>describe dm_user_r;

Table 280. Columns of the dm_user_r table


R_OBJECT_ID NUMBER(10) N

I_POSITION NUMBER(6) N

USER_NAMES CHAR(32) Y

GROUPS_NAMES CHAR(32) Y

I_ALL_USERS_NAMES CHAR(16) Y


Appendix CObsolete, Deprecated, or UnusedObject Types

This appendix lists object types that are obsolete, deprecated, or unused. An obsolete type was usedin prior releases to support some functionality. An unused object type was added to the hierarchy, butnever used by Content Server or any EMC Documentum client products.

The following object types are obsolete or unused:• dm_java• dm_staged• dm_routerThe following object types are supported but deprecated because they have been superceded byanother object type or are used by deprecated features or products:• dm_format_preferences

This object type is used by Desktop Client to record information about which rendition andapplication to use for editing and viewing a document in a particular format.

• dm_menu_system

This object type is used by Desktop Client to record the Explorer Integration menu configuration.• dm_email_message

The reference information for this type is still documented. It is found in Email Message, page 209.


Obsolete, Deprecated, or Unused Object Types


Index

_ (underbar)in table and column names, 29

_ (underscore), in type names, 28

A_accessor_app_permit (computed

property), 15_accessor_name (computed property), 16_accessor_permit (computed

property), 16_accessor_permit_type (computed

property), 16_accessor_xpermit (computed

property), 16_accessor_xpermit_names (computed

property), 17ACL object type, 42_acl_ref_valid (computed property), 17ACLs

aliases in, 69dm_audittrail_acl type, 85dmi_audittrail_attrs type, 88

acs config object type, 46ACS servers

cont transfer config object type, 141activity object type, 52agent exec process

dm_agent_exec utility, 249method name in server config

object, 392aggr domain object type, 67alias set object type, 69_alias_set (computed property), 17_alias_sets (computed property), 23_all_users_names (computed

property), 17_allow_change_folder_links (computed

property), 17_allow_change_location (computed

property), 17

_allow_change_owner (computedproperty), 17

_allow_change_permit (computedproperty), 17

_allow_change_state (computedproperty), 17

_allow_execute_proc (computedproperty), 17

annotationsnote object type, 309

app ref object type, 71application object type, 72aspect properties

referencing in DQL, 27aspect relation object type, 75aspect type object type, 76assembly object type, 77attachments

wf attachment object type, 469_attribute_list_values (computed

property), 18audit trail acl object type, 85audit trail attrs object type, 88audit trail entries

_sign_data computed property, 22audit trail group object type, 89audit trail object type, 79audit trail signatures

_sign_data computed property, 22auditing

audit trail objects, 79auth config object type, 92

Bbacking up

dumping repositories, 205blob storage areas

object type, 93renditions in, 402

blobstore object type, 93


Index

bocs config object type, 94BOCS servers

cont transfer config object type, 141dm_bocs_config type, 94

BOF modulesmodule object type, 297

Branch method, 38builtin expr object type, 97

CCA store object type, 98cabinet object type, 101cabinets

privileges to change, 101cache config object type, 102_cached (computed property), 18caches

client_cache_size property, 394dump process, 206query, 528size described in server config

object, 392calendar object type, 554case sensitivity

group names, 28table and column names, 29type and property names, 28user names, 28

category assign object type, 107category class object type, 110category object type, 104change record object type, 114_changed (computed property), 18Checkin method, 38child security for relationships, 33child_id attribute, 32child_label attribute, 32CI config object type, 116class object type, 119client applications

date formats, 528client cache

maximum size, defining, 394client caches

cache config object type, 102client config object type, 514client registration object type, 121client rights object type, 122client_cache_size property, 394

collection object identifiers, 29columns

naming rules, 29comment object type, 558completed workflow object type, 124completed workitem object type, 128component object type, 134component routine, 342_componentID (computed property), 18composite predicate object type, 135computed properties

_accessor_app_permit, 15_accessor_permit_type, 16_is_restricted_session, 20_istransactionopen, 21lifecycles, 23list of, 15referencing, 26_sign_data, 22

cond expr object type, 136cond ID expr object type, 137config scope relation object type, 139configuration objects

client config, 514connection config, 515docbase config, 185location, 275mount point, 302server config, 392session config, 525

connection brokersdocbase locator object type, 518docbroker locator object type, 521server locator object type, 522

connection config objects, 515constraint set object type, 140cont transfer config object type, 141_containID (computed property), 19containment object type, 143content assignment policies

dm_relation_ssa_policy type, 366dm_ssa_policy type, 408

content object type, 146Content Server

server config object type, 392server locator object type, 522

content-addressed storagedm_ca_store type, 98

_content_state (computed property), 19copy_child property, 34


Index

_count (computed property), 19country codes, 679_current_state (computed property), 19

Ddata dictionary

aggr domain object type, 67dd attr info object type, 157dd common info object type, 163dd info object type, 169dd type info object type, 176domain object type, 201expr code object type, 213nls dd info object type, 306value assist object type, 462value func object type, 464value list object type, 465value query object type, 466

datatable object type, 560datatable row object type, 561datatable schema ex object type, 563datatable schema object type, 562datatable settings object type, 564datatypes

default values, 25properties, 23, 25units of length for string, 26

datesformat for clients, 528

dd attr info object type, 157dd common info object type, 163dd info object type, 169dd type info object type, 176default values

datatypes, 25procedure timeout period, 294

destroyingrelationships, effect on, 38

DFCclient config objects and, 514

direction_kind property, 35discussion object type, 566discussions

dmc_comment type, 558dmc_readcomment type, 568dmc_topic type, 573

display config type, 179distributed store object type, 181dm_ prefix, 28

dm_acl type, 42dm_acs_config type, 46dm_activity type, 52dm_agent_exec utility, 249dm_aggr_domain type, 67dm_alias_set type, 69dm_app_ref type, 71dm_application type, 72dm_assembly type, 77dm_audittrail type, 79dm_audittrail_acl type, 85dm_audittrail_group type, 89dm_auth_config type, 92dm_blob_store type, 93dm_bocs_config type, 94dm_builtin_expr type, 97dm_ca_store type, 98dm_cabinet type, 101dm_cache_config type, 102dm_category type, 104dm_category_assign type, 107dm_category_class type, 110dm_ci_config type, 116dm_client_registration type, 121dm_client_rights type, 122dm_component type, 134dm_cond_expr type, 136dm_cond_id_expr type, 137dm_cont_transfer_config type, 141dm_dd_info type, 169dm_display_config type, 179dm_distributedstore type, 181dm_dms_config type, 183dm_docbase_config type, 185dm_docset type, 196dm_docset_run type, 198dm_document type, 200dm_domain type, 201dm_dump_record type, 205dm_email_message type, 209dm_esign_template type, 211dm_expression type, 214dm_extern_file type, 216dm_extern_free type, 217dm_extern_store type, 218dm_extern_url type, 220dm_federation type, 221dm_filestore type, 224dm_folder type, 225dm_foreign_key type, 226


Index

dm_format type, 227dm_format_preferences type, 687dm_ftengine_config type, 235dm_ftindex_agent_config type, 231dm_fulltext_index type, 236dm_func_expr type, 238dm_group type, 241dm_java type, 687dm_job type, 249dm_job_request type, 254dm_job_sequence type, 256dm_key type, 258dm_ldap_config type, 259dm_lightweight type, 508dm_linkedstore type, 267dm_literal_expr type, 270dm_load_record type, 273dm_location type, 275dm_locator type, 277dm_media_profile type, 278dm_menu_system type, 687dm_message_address type, 280dm_message_archive type, 282dm_message_attachment type, 285dm_message_route type, 286dm_message_route_user_data type, 288dm_message_user_data type, 289dm_method type, 291dm_mount_point type, 302dm_network_location_map type, 304dm_nls_dd_info type, 306dm_note type, 309dm_outputdevice type, 311dm_plugin type, 317dm_policy type, 319dm_procedure type, 331dm_process type, 332dm_public_key_certificate, 340dm_qual_comp type, 342dm_query type, 345dm_reference type, 354dm_registered type, 359dm_relation type, 364dm_relation_ssa_policy type, 366dm_relation_type type, 367dm_retainer type, 378dm_router type, 687dm_scope_config type, 388dm_script type, 390dm_server_config type, 392

dm_smart_list type, 404dm_ssa_policy type, 408dm_staged type, 687dm_state_extension type, 406dm_state_type type, 407dm_store type, 409dm_sysobject type, 418dm_taxonomy type, 434dm_type type, 441dm_user type, 448dm_validation_descriptor type, 457dm_value_assist type, 462dm_value_func type, 464dm_value_list type, 465dm_value_query type, 466dm_webc_config object type, 632dm_webc_target type, 639dm_WfReporting job

completed workflow object type, 124dm_workflow type, 475dm_xfm_form type, 648dm_xfm_instance, 650dm_xml_application type, 500dm_xml_config type, 502dm_xml_custom_code type, 503dm_xml_style_sheet type, 504dm_xml_zone type, 505dmc dsm application object type, 576dmc dsm backbone object type, 577dmc dsm doc propertie sobject type, 578dmc dsm drug product object type, 580dmc dsm drug substance object typte, 581dmc dsm excipient object type, 582dmc dsm facilities equip object type, 583dmc dsm indication object type, 584dmc dsm m1 backbone object type, 585dmc dsm safety eval object type, 586dmc dsm sect doc attributes object

type, 587dmc dsm section extension object

type, 591dmc dsm section object type, 589dmc dsm sft section object type, 594dmc dsm stf backbone object type, 592dmc dsm study attributes, 595dmc dsm study report object type, 596dmc dsm submission object type, 597dmc rps authority object type, 600dmc rps execution rule object type, 614dmc rps notification object type, 617


Index

dmc_aspect_relation type, 75dmc_aspect_type type, 76dmc_calendar type, 554dmc_class type, 119dmc_comment type, 558dmc_completed_workflow type, 124dmc_completed_workitem type, 128dmc_composite_predicate type, 135dmc_config_scope_relation type, 139dmc_constraint_set type, 140dmc_datatable type, 560dmc_datatable_row type, 561dmc_datatable_schema type, 562dmc_datatable_schema_ex type, 563dmc_datatable_settings type, 564dmc_discussion type, 566dmc_dsm_application type, 576dmc_dsm_backbone type, 577dmc_dsm_doc_properties type, 578dmc_dsm_drug_product type, 580dmc_dsm_drug_substance type, 581dmc_dsm_excipient type, 582dmc_dsm_facilities_equip, 583dmc_dsm_indication type, 584dmc_dsm_m1_backbone type, 585dmc_dsm_sect_doc_attributes type, 587dmc_dsm_section type, 589dmc_dsm_section_extension type, 591dmc_dsm_stf_backbone type, 592dmc_dsm_stf_section type, 594dmc_dsm_study_attributes, 595dmc_dsm_study_report type, 596dmc_dsm_submission type, 597dmc_eps_config_cache type, 654dmc_eps_elem_type_mapping type, 655dmc_eps_element type, 656dmc_eps_issue type, 658dmc_eps_mapping type, 659dmc_eps_metadata_mapping type, 660dmc_eps_performer_mapping type, 662dmc_eps_placement type, 663dmc_eps_pubinfo_cache type, 664dmc_eps_publication type, 665dmc_eps_relation type, 666dmc_eps_schedule_mapping type, 667dmc_eps_section type, 668dmc_eps_state type, 669dmc_eps_state_mapping type, 670dmc_eps_state_perm_mapping type, 671dmc_eps_state_transition type, 672

dmc_eps_template_mapping type, 673dmc_eps_transition_override type, 674dmc_eps_wf_template_mapping

type, 675dmc_eps_workflow_data type, 676dmc_jar type, 247dmc_java_library type, 248dmc_metamodel type, 290dmc_module type, 297dmc_module_config type, 300dmc_notepage type, 567dmc_page_detail type, 661dmc_preset_info type, 328dmc_preset_package type, 329dmc_process_correlation_set type, 338dmc_reaadcomment type, 568dmc_relationship_def type, 371dmc_richtext type, 569dmc_room type, 570dmc_routecase_condition type, 384dmc_rps_authority type, 600, 602dmc_rps_base_date type, 604dmc_rps_child_strategy type, 606dmc_rps_condition type, 608dmc_rps_contact type, 609dmc_rps_disposition_method type, 610dmc_rps_event type, 612dmc_rps_execution_rule type, 614dmc_rps_hold type, 615dmc_rps_notification type, 617dmc_rps_phase_rel, 619dmc_rps_retainer type, 621dmc_rps_retainer_event_rel type, 624dmc_rps_retention_policy type, 625dmc_tcf_activity type, 435dmc_tcf_activity_template type, 436dmc_topic type, 573dmc_transition_condition type, 437dmc_validation_module type, 458dmc_validation_relation type, 460dmc_wf_package_schema type, 470dmc_wf_package_skill type, 471dmc_wfsd_element type, 533dmc_wfsd_element_boolean type, 534dmc_wfsd_element_date type, 535dmc_wfsd_element_double type, 536dmc_wfsd_element_integer type, 537dmc_wfsd_element_parent type, 538dmc_wfsd_element_string type, 539dmc_wfsd_type_info type, 540


Index

dmc_wfsdrp_boolean type, 545dmc_wfsdrp_date type, 546dmc_wfsdrp_double type, 547dmc_wfsdrp_integer type, 548dmc_wfsdrp_string type, 551dmc_workqueue type, 487dmc_workqueue_category type, 488dmc_workqueue_doc_profile type, 489dmc_workqueue_policy type, 491dmc_workqueue_user_profile type, 493dmc_wq_skill_info type, 495dmc_wq_task_skill type, 498dmc_wq_user_skill type, 499dmc_xfm_adaptor_config type, 646DMCL (client library)

Docbroker locator object, 521server locator object, 522

dmi_audittrail_attrs type, 88dmi_change_record type, 114dmi_dd_attr_info type, 157dmi_dd_common_info type, 163dmi_dd_type_info type, 176dmi_dump_object_record type, 204dmi_expr_code type, 213dmi_index object type, 245dmi_linkrecord type, 268dmi_load_object_record type, 271dmi_otherfile type, 310dmi_package type, 313dmi_queue_item type, 346dmi_registry type, 361dmi_replica_record type, 376dmi_sequence type, 391dmi_session type, 403dmi_subcontent type, 416dmi_type_info type, 444dmi_vstamp type, 468dmi_wf_attachment type, 469dmi_wf_timer type, 473dmi_workitem type, 481dmr_containment type, 143dmr_content type, 146dms config object type, 183DO_METHOD procedures

object type for, 291docbase config object type, 185docbase locator object type, 518_docbase_id (computed property), 19Docbasic

method object and, 293

plugins and, 318procedure objects and, 331

docbroker locator object type, 521docset object type, 196docset run object type, 198document object type, 200Document Set, see docset object typedocuments

language and country codes, 679Documentum Collaborative Services

room object type, 570Documentum Resource Locator, object

type for, 277domain controllers

identifying, 92domain object type, 201domain-required mode, 187domains, 201DQL (Document Query Language)

names, 27naming rules, 28query objects and, 345referencing properties, 27reserved words in queries, 27

dsm_dmc_safety_eval type, 586_dump (computed property), 19dump object record object, 204dump record object type, 205

Eelectronic mail address

group, 241user, 451

electronic signaturesEsign template object type, 211

email message object type, 209EMC Documentum Forms Builder

xfm form object type, 648xfm instance object type, 650

_entry_criteria (computed property), 24eps config cache object type, 654eps elem type mapping object type, 655eps element object type, 656eps issue object type, 658eps mapping object type, 659eps metadata mapping object type, 660eps page detail, 661eps performer mapping type, 662eps placement object type, 663


Index

eps pubinfo cache object type, 664eps publication object type, 665eps relation object type, 666eps schedule mapping object type, 667eps section object type, 668eps state mapping object type, 670eps state perm mapping object type, 671eps state transition object type, 672eps state type object type, 669eps template mapping object type, 673eps transition override object type, 674eps wf template mapping object type, 675eps workflow data object type, 676error level in _status property, 22Esign template object type, 211events

registry object type, 361SysObject properties, 431

explicit transactions_isdeadlocked, 20_istransactionopen (computed

property), 21expr code object type, 213expression object type, 214extended permissions, computed

properties for, 23external applications

app ref object type, 71application object type, 72qual comp object type, 342

external file store object type, 216external free store object type, 217external procedures

method object type and, 291external storage

external free store object type, 217external store object type, 218external URL object type, 220plug-in libraries, 317

external store object type, 218external URL object type, 220

Ffederation object type, 221file store object type, 224folder object type, 225foreign key object type, 226format object type, 227ft index agent config object type, 231

ftengine config object type, 235full-text indexes

fulltext index object type, 236fulltext index object type, 236fulltext indexes

ftengine config object type, 235func expr object type, 238

Ggroup object type, 241groups

aliases, 69_all_users_names (computed

property), 17dm_audittrail_group type, 89group object type, 241names, case sensitivity, 28naming rules, 28

H_has_config_audit (computed

property), 19_has_create_cabinet (computed

property), 20_has_create_group (computed

property), 19_has_create_type (computed

property), 19_has_purge_audit (computed

property), 20_has_superuser (computed property), 20_has_sysadmin (computed property), 20_has_view_audit (computed property), 20

Ii_is_replica property, 41i_vstamp property, 41_id (computed property), 20identifiers

collection object, 29names, 27object, 29property, 29session, 30type, 30

_included_types (computed property), 24index agents

ft index agent config object type, 231


Index

index object type, 245integrity_kind property, 36_is_restricted_session (computed

property), 20_isdeadlocked (computed property), 20_isnew (computed property), 20_isreplica (computed property), 21_istransactionopen (computed

property), 21

Jjar files

jar object type, 247jar object type, 247Java

java library object type, 248java library object type, 248job object type, 249job request object type, 254job sequence object type, 256jobs

job object type, 249job sequence object type, 256

Kkey object type, 258keys

foreign key object type, 226key object type, 258

Llanguage codes, 679ldap config object type, 259LDAP directory server

ldap config object type, 259_lengths (computed property), 21lifecycle states

attachability, 319lifecycles

computed properties, 23object type for, 319_policy_name (computed

property), 21state extension object type, 406state type object type, 407

lightweight object type, 508link record object type, 268linked storage areas

link record object type, 268linked store object type, 267

linked store object type, 267links

reference object type, 354literal expr object type, 270load object record objects, 271load record object type, 273location object type, 275location objects

events directory, 516external file stores, 216file stores, 224linked stores, 267

locator object type, 277locking

SysObject property for, 430login ticket key

ticket_crypto_key property, 189login tickets

login_ticket_cutoff property, 189trust_by_default property, 194trusted_docbases property, 194

login_ticket_cutoff property, 189

M_masterdocbase (computed property), 21maximums

cache size in server config object, 392characters in table and column

names, 29characters in type and property

names, 28characters in user and group

names, 28sequence number, 391

media profile object type, 278message address object type, 280message archive object type, 282message attachment object type, 285message route object type, 286message route user data object type, 288message user data object type, 289metamodel object type, 290method object type, 291minimum values

login tickets, issuance date, 189module config object type, 300module object type, 297


Index

mount point object type, 302

Nnames

column, 29described, 27DQL reserved words as, 28group, 28property, 28repository, 191rules for, 28server config objects, 397table, 29type, 28user, 28

_names (computed property), 21network location map object type, 304_next_state (computed property), 24nls dd info object type, 306non-persistent types

client config, 514connection config, 515docbase locator, 518docbroker locator, 521server locator, 522session config, 525

none security for relationships, 34note object type, 309notepage object type, 567notes

note object type, 309notification in registry object type, 361

Oobject identifiers, 29object IDs

sequence numbers, 391object replication

relationships and, 39object types

dd type info, 176dm_type type, 441dmi_type_info type, 444naming rules, 28relation, 30relation type, 30

objects_cached (computed property), 18

_current_state (computedproperty), 19

_policy_name (computedproperty), 21

relation type objects, 37relationships

creating, 32destroying, 37

relationships between, 30other file object type, 310output device object type, 311

Ppackage object type, 313packages

dmi_package type, 313skill levels for, 471wf package schema object type, 470

parent security for relationships, 33parent_id attribute, 32permanent_link attribute, 38permanent_link property, 34_permit (computed property), 21persistent object type, 41plug-in libraries

plugin object type, 317plugin object type, 317policy object type, 319_policy_name (computed property), 21preset info object type, 328preset package object type, 329_previous_state (computed property), 24primary session identifiers, 30private

activities, 55cabinets, 101groups, 244mount point objects, 303process definitions, 334

procedure object type, 331procedures

timeout period, 294process correlation set object type, 338process object type, 332properties

aggr_domain object type, 67aspect properties, referencing, 27_attribute_list_values (computed

property), 18


Index

computed, 15computed, for lifecycles, 23datatypes, 25dd attr info object type, 157dd common info object type, 163dm_display_config type, 179domain object type, 201identifiers, 29naming rules, 28referencing, 26

publicactivities, 55cabinets, 101groups, 244mount point objects, 303process definitions, 334

public key certificate object type, 340

Qqual comp object type, 342queries

caching, 528query object type, 345queue item object type, 346quotes

enclosing reserved words in, 28

Rr_object_id property, 41RDBMS

datatypes, 25Documentum tables in, 683index storage areas, 189reserved words, 29user name, 451views, 684

readcomment object type, 568reference object type, 354registered object type, 359registered tables

dm_registered type, 359registry object type, 361relation object type, 364relation objects

creating, 32described, 30

relation SSA policy object type, 366relation type object type, 367

relation type objectscreating, 31described, 30destroying, 37

relation_name attribute, 32relationship def object type, 371relationships

Branch method, 38Checkin method, 38child security level, 33copy behavior, release

compatibility, 35copy_child property, 34creating instances, 32delete behavior, defining, 35described, 30direction_kind property, 35integrity_kind property, 36none security level, 34object removal, effect of, 38object replication and, 39parent security level, 33permanent_link property, 34relation object, 30relation type objects, 30relationship types, creating, 31Save method and, 38Saveasnew method and, 38security, 33system security level, 33user-defined, 31

remote repositoriesi_is_replica property, 41

renditionsstorage of, 402

_repeating (computed property), 22repeating properties

number of in _values property, 23replica record object type, 376repositories

docbase config object type, 185names, restrictions, 191RDBMS and, 683reference object type, 354ticket_crypto_key property, 189trust_by_default property, 194trusted_docbases property, 194underlying RDBMS table

descriptions, 683reserved words


Index

as property names, 27in queries, 27 to 28names and DQL, 28RDBMS, 28

_resume_state (computed property), 22retainer object type, 378retention policies

dm_retainer type, 378richtext content

dmc_notepage type, 567richtext object type, 569room object type, 570route cases

dmc_composite_predicate type, 135dmc_transition_condition type, 437

routecase condition object type, 384routines, component, 342rps authority object type, 602rps base date object type, 604rps child strategy object type, 606rps condition object type, 608rps contact object type, 609rps disposition method object type, 610rps event object type, 612rps hold object type, 615rps phase rel object type, 619rps retainer event rel object type, 624rps retainer object type, 621rps retention policy object type, 625

SSave method

effect on relationships, 38Saveasnew method, 38scope config object type, 388script object type, 390scs_admin_config type, 630security

ACL object type, 42client registration object type, 121client rights object type, 122directory in mount point object, 303directory or file in Location type

object, 276folder, 189level for repository, 193properties controlling, 428public key certificate object type, 340relationships, 33

sequence object type, 391server config object type, 392server config objects

names, restrictions, 397server locator object type, 522session config object type, 525session identifiers, 30session object type, 403sessions

client config type and, 514connection config objects and, 515identifiers, 30

_sign_data (computed property), 22Smart List object type, 404state extension object type, 406state type object type, 407_state_extension_obj (computed

property), 24_state_type (computed property), 24states

computed properties describing, 24_status (computed property), 22storage areas, 217 to 218, 408

See also content assignment policiesblob, 93distributed store object type, 181external URL object type, 220file store object type, 224linked store object type, 267store object type, 409

store object type, 409string datatypes

unit of length, 26subcontent object type, 416SysObject object type, 418SysObjects

_current_state (computedproperty), 19

event-related property, 431folder properties, 422general properties, 418lifecycle-related properties, 432security-related properties, 428version-related properties, 430virtual document properties, 423

system security for relationships, 33

Ttables


Index

naming rules, 29tablespaces

index location, 245type index storage, 189

taxonomy object type, 434TCF Activity object type, 435TCF activity template type, 436timeouts

automatic activities, 55procedure, 294

topic object type, 573tracing

error level in _status property, 22transactions

_isdeadlocked, 20transformation profiles

media profile object type, 278transition condition object type, 437translation relationships

language and country codes, 679trust_by_default property, 194trusted_docbases property, 194turbo storage

renditions in, 402subcontent object type, 416

type identifiers, 30type indexes

index object type, 245type info object type, 444type object type, 441_type_id (computed property), 22_type_name (computed property), 22types

naming rules, 28RDBMS table descriptions of, 683

_types (computed property), 23_typestring (computed property), 23

Uunderbar ( _ )

in table and column names, 29underscore (_), in type names, 28user authentication

UNIX users against domains, 92user object type, 448user privileges

user object, 453user-defined types

identifiers, 30

naming rules, 28users

aliases, 69naming rules, 28user_name, case sensitivity, 28workqueue user profile object

type, 493

Vvalidation descriptor object type, 457validation module object type, 458validation relation object type, 460value assist object type, 462value func object type, 464value list object type, 465value query object type, 466_values (computed property), 23versions

SysObject properties, 430views

Documentum, 684RDBMS, 683

virtual documentsassembly objects and, 77SysObject properties, 423

vstamp object type, 468

Wwebc config object type, 632webc target object type, 639wf attachment object type, 469wf package schema object type, 470WF package skill object type, 471wf timer object type, 473wfsd element booleanobject type, 534wfsd element date object type, 535wfsd element double object type, 536wfsd element integer object type, 537wfsd element object type, 533wfsd element parent object type, 538wfsd element string object type, 539wfsd type info object type, 540wfsdrp boolean object type, 545wfsdrp date object type, 546wfsdrp double object type, 547wfsdrp integer object type, 548wfsdrp string object type, 551work item object type, 481


Index

work itemscompleted workitem object type, 128workqueue object type, 487

work queuesworkqueue doc profile object

type, 489workqueue object type, 487workqueue policy object type, 491workqueue user profile object

type, 493workflow definitions

wf timer object type, 473workflow object type, 475workflow object types

wfsd element, 533wfsd element boolean, 534wfsd element date, 535wfsd element double, 536wfsd element integer, 537wfsd element string, 539wfsd type info, 540wq skill info, 495wq task skill, 498

workflowscompleted workflows object type, 124completed workitem object type, 128module config object type, 300process object type, 332wf attachment object type, 469wf package schema object type, 470

work item object type, 481workqueue object type, 487

workqueue category object type, 488workqueue doc profile object type, 489workqueue object type, 487workqueue policy object type, 491workqueue user profile object type, 493wq skill info object type, 495wq task skill object type, 498wq user skill object type, 499

Xxfm adaptor config object type, 646xfm form object type, 648xfm instance object type, 650XML (Extensible Markup Language)

xml application object type, 500xml config object type, 502xml custom code object type, 503xml style sheet object type, 504xml zone object type, 505

xml application object type, 500xml config object type, 502xml custom code object type, 503xml style sheet object type, 504xml zone object type, 505_xpermit (computed property), 23_xpermit_list (computed property), 23_xpermit_names (computed property), 23


system 6.0 object reference

Documents

nocorresponding i propertyin

trusted contentservices license

fromaudit trail entries

theaudit trail entries

withthe timers firing

thexpath transition conditionevaluation

contentstorage services license

correspondingindex position incontent attr name