21
EMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE EMC Documentum D2 Version 4.2 ABSTRACT This white paper provides a reference to the runtime objects created and consumed by the D2 application in the Documentum repository. March, 2014

EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

  • Upload
    buiminh

  • View
    471

  • Download
    21

Embed Size (px)

Citation preview

Page 1: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

EMC DOCUMENTUM D2 RUNTIME

OBJECT REFERENCE GUIDE

EMC Documentum D2 Version 4.2

ABSTRACT This white paper provides a reference to the runtime objects created and consumed

by the D2 application in the Documentum repository.

March, 2014

Page 2: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

Copyright © 2014 EMC Corporation. All Rights Reserved.

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

notice.

The information in this publication is provided “as is.” EMC Corporation makes no representations or warranties of any kind with

respect to the information in this publication, and specifically disclaims implied warranties of merchantability or fitness for a

particular purpose.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

Part Number H12944

Page 3: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

TABLE OF CONTENTS

EXECUTIVE SUMMARY 5

Audience 5

CONFIGURATIONS SET AT RUN-TIME 5

d2_dictionary 5

d2_dictionary_archive 6

d2_dictionary_value 6

d2_taxonomy 6

RUN-TIME OBJECT TYPES 7

d2_link 7

d2_link_checkout 8

d2_naming_counter 8

d2_template 9

d2c_cancelcheckout 9

d2c_delegation 9

d2c_distribution_tracker 10

d2c_followup_task_audit 11

d2c_mailing_audit 11

d2c_mass_create_queue 12

d2c_note 12

d2c_preferences 12

d2c_query 15

d2c_query_category 16

d2c_query_dql 16

d2c_query_dql_wizard 16

d2c_query_form 16

d2c_query_opensearch 17

d2c_query_wizard 17

d2c_snapshot 17

d2c_subscription 17

d2c_subscription_audit 18

d2c_subscription_queue 18

d2c_task_folder 18

Page 4: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

d2c_task_user_folder 19

d2c_wf_pop_history 19

d2c_workflow_tracker 19

x3_preferences 20

Page 5: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

5

EXECUTIVE SUMMARY This white paper provides a functional description of the object types installed by D2 into the Documentum repository that are used

to manage application state by the run-time client and libraries. It does not cover types used to store D2 configurations, except in

cases where the configuration is editable through the D2 client, because EMC does not support use or manipulation of stored

configurations from outside of D2 clients.

Audience

This white paper is intended for developers and administrators with a well-established understanding of D2 functionality and EMC

Documentum technologies. It should provide a useful reference for client interoperability and troubleshooting of application state.

CONFIGURATIONS SET AT RUN-TIME The object types in this section (prefixed by d2_) are configuration object types normally set by the D2-Configuration client. They are included in this white paper because they can also be set at run time in the D2 client using administration widgets.

d2_dictionary

D2 dictionaries are used to store label/value pairs used throughout the D2 product. This object type stores the metadata for the

dictionary, but not the actual values for the key/value pairs—those are stored in d2_dictionary_value objects.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

alias_name CHAR(32) REPEATING Names the alias sets associated to dictionary values (if any)

locale_name CHAR(5) REPEATING Locales defined for this dictionary

object_name CHAR(255) Name of the dictionary

security_group CHAR(32) User group that can administer the dictionary through the D2

client

title CHAR(255) The description of the dictionary

version INTEGER Version # of this dictionary (if is_versioned is set)

manual_order BOOLEAN If TRUE, allows manual ordering of dictionary entries.

label_locale CHAR(32) REPEATING Locales corresponding to the localized labels in label_value

label_value CHAR(255) REPEATING Localized labels for the dictionary for use in the D2 UI

search_group CHAR(32) User group that can search the dictionary through the D2 client

application_names CHAR(255) REPEATING Application names, used for filtering configuration in D2-Config

dql CHAR(2000) If is_dql is set, dql will contain the query used to fetch dictionary

values

is_dql BOOLEAN If TRUE, the dictionary entries are populated by a DQL query

is_dql_cache BOOLEAN If TRUE, the dictionary is populated by dql query once, at

application start-up

is_versioned BOOLEAN If TRUE, maintains a version history for the dictionary each time

it is saved

create_view_option BOOLEAN If TRUE, D2 creates an external table based on the values

Page 6: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

6

contained within the dictionary

lock_config BOOLEAN If TRUE, the configuration cannot be modified through the D2 or

D2-Config UI

parents_config CHAR(255) REPEATING Ancestor configuration names for configuration objects created

with “create from…” in D2-Config

d2_dictionary_archive

This object is used to archive dictionaries as serialized, versioned xml documents. Normally, the object_name for an archive will be

the same as the object_name of the source d2_dictionary object.

SuperType Name: dm_sysobject

ATTRIBUTE NAME TYPE DESCRIPTION

d2_dictionary_name CHAR(255) object_name of the source dictionary

d2_dictionary_value

This object stores the row data for non DQL dictionaries.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

alias_value CHAR(512) REPEATING Aliases corresponding to alias names in

d2_dictionary.alias_name

locale_value CHAR(512) REPEATING Localized labels corresponding to locales in

d2_dictionary.locale_name

object_name CHAR(255) Value

is_enabled BOOLEAN If true, this value is active in the UI.

dictionary_name CHAR(255) Object name of parent d2_dictionary object.

order_no INTEGER Sequence number for manually ordered dictionaries (only used

when manual_order=TRUE on the associated d2_dictionary)

d2_taxonomy

This object stores top level metadata for a d2 taxonomy. Note that apart from the dictionaries used for different taxonomy levels,

the structure of the taxonomy is not stored in d2_taxonomy objects. Taxonomy structures are stored instead in dm_relation objects

having relation_name=’D2_TAXONOMY’. These relations link the taxonomy to the d2_dictionary value objects representing the top

level of the taxonomy, and subsequently link those d2_dictionary_value objects to the next level of d2_dictionary value objects, and

so forth.

SuperType Name:

Page 7: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

7

ATTRIBUTE NAME TYPE DESCRIPTION

levels CHAR(255) REPEATING Object_names for the d2_dictionaries that make up the levels

of the taxonomy

object_name CHAR(255) The taxonomy name

security_group CHAR(32) User group that can access and modify the taxonomy via the

D2 user interface

title CHAR(255) The taxonomy description

version INTEGER The taxonomy version

application_names CHAR(255) REPEATING Application names, used for filtering configuration in D2-Config

is_versioned BOOLEAN If TRUE, maintains a version history for the dictionary each

time it is saved

lock_config BOOLEAN If TRUE, the configuration cannot be modified through the D2

or D2-Config UI

parents_config CHAR(255) REPEATING Ancestor configuration names for configuration objects created

with “create from…” in D2-Config

RUN-TIME OBJECT TYPES Types in this section (primarily prefixed by d2c_) are run-time objects, created dynamically by the D2 client or D2 methods running

on the JMS.

d2_link

This object represents a D2 hyperlink. Hyperlinks are supported in D2 3.1, and will be supported again in a post 4.2 version.

Hyperlinks are not available in versions 4.0-4.2.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

action_type CHAR(32) URL, GotoR, Goto, GotoNamed or Launch

dest_doc_chron_id ID Chronicle id of the destination document

dest_doc_version CHAR(32) Chronicle id of the source document

dest_file_system CHAR(260) External file destination

dest_page CHAR(128) Page number destination

dest_zone_view CHAR(128) PDF zone

quad_points CHAR(2000) PDF complex position

src_doc_chron_id ID Chronicle id of the source document

border_color CHAR(32) PDF border color

border_style CHAR(32) PDF border style

Page 8: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

8

border_width CHAR(32) PDF border width

src_doc_version CHAR(32) Version label of the source document

src_llx DOUBLE PDF left position

src_lly DOUBLE PDF bottom position

src_page INTEGER Page number inside the PDF

src_urx DOUBLE PDF right position

src_ury DOUBLE PDF top position

validity CHAR(32) d2_link_valid

d2_link_invalid_version

d2_link_dead

d2_link_deleted

d2_link_not_in_application

high_light CHAR(32) PDF highlight link

link_type INTEGER 0 : To Office

1 : To PDF

2 : On PDF

qualification CHAR(2000) **UNUSED**

link_status INTEGER 0 : New

1 : Current

2 : Deleted

dest_bookmark CHAR(2000) Bookmark destination

old_ref CHAR(256) Legacy migration information

context_id ID Used to store context id for contextual links

d2_link_checkout

This object represents the checkout of a PDF or native rendition

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

local_machine CHAR(32) Hostname of the client holding the checkout.

user_name CHAR(32) User name holding the checkout

document_id ID ID of the document

d2_naming_counter

This object is used to keep track of the counters used in auto naming configurations, in the case where counters are dependent on

object properties, and therefore more than one counter must be maintained for a specific naming configuration.

Page 9: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

9

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

naming_config CHAR(255) The naming configuration name

counter_key CHAR(255) The distinct set of property value(s) used to distinguish this

counter

counter INTEGER Counter value

d2_template

This object represents a template in D2, which may be used during content creation. File content is stored as a content page on the

sysobject, just as it would be for a dm_document.

SuperType Name: dm_sysobject

(no type specific attributes)

d2c_cancelcheckout

This object type is used to manage rollback of virtual document children when a check out of a virtual document is cancelled. When

a virtual document is checked out, a set of d2c_cancelcheckout object will be created to record the state of the VD at the time of

checkout. These objects are either used to restore the VD in the event of a cancellation, or discarded in the event of a check-in.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

naming_config CHAR(255) The naming configuration name

parent_id ID R_object_id of the parent VD

child_id ID R_object_id of the child object

order_no INTEGER Position in the virtual document

version_label CHAR(32) Version label of the child object

d2c_delegation

This object represents a delegation for one or more workflows. Queued tasks in these workflows will be automatically delegated to

the named user.

SuperType Name:

Page 10: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

10

ATTRIBUTE NAME TYPE DESCRIPTION

date_begin TIME Date/time for the delegation to start, or nulldate if the delegation

starts immediately

date_end TIME Date/time for the delegation to end, or nulldate if the delegation

has no planned end

description CHAR(255) Description of the delegation

object_name CHAR(255) User_name of the source user

user_to CHAR(32) User_name of the destination user

workflows CHAR(255) REPEATING Object_names of the d2_workflow_config objects to which this

delegation applies

d2c_distribution_tracker

This object is used to track status for a distribution. The distribution tracker object is an xml document describing the intended

distribution list. Actual status for the distribution recipients is tracked in a dm_relation between the d2c_distribution_tracker and the

dm_user recipient. This relation will have relation_name = “D2_DIST_TRACKER_USER” and description set as follows, depending on

the status of the distribution for that user:

STATUS_REL_USER_INVALID_ADDRESS = "Invalid address"

STATUS_REL_USER_IN_PREPARATION = "0"

STATUS_REL_USER_SENT = "1"

STATUS_REL_USER_REJECTED = "2"

STATUS_REL_USER_ACCEPTED = "3"

STATUS_REL_USER_NO_ACCESS_PERMISSION = "4"

Additionally, D2 creates a dm_relation between the d2_distribution_tracker object and the document to be distributed, having

relation_name = “D2_DIST_TRACKER_DOCUMENT.” The description field of that dm_relation object captures the overall status of

the distribution as follows:

STATUS_REL_DOCUMENT_IN_PREPARATION = "10"

STATUS_REL_DOCUMENT_IN_PROGRESS = "11"

STATUS_REL_DOCUMENT_STOPPED = "12"

STATUS_REL_DOCUMENT_UPDATE_IN_PROGRESS = "13"

STATUS_REL_DOCUMENT_FINISHED = "Finished"

SuperType Name: dm_document

ATTRIBUTE NAME TYPE DESCRIPTION

config_name CHAR(260) Object_name of the d2_distribution_config configuration object

responsible for this distribution.

Page 11: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

11

d2c_followup_task_audit

This object serves as an audit record indicating that a task follow up notification was sent. It is displayed in the audit trail for the

workflow instance under which the notification was sent.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

config_name CHAR(255) Object_name of the d2_workflow_config for this workflow

instance

audit_date TIME Date of audit record creation

notification_hash_code CHAR(511) Hash code used to de-duplicate audit trail events.

queue_id ID R_object_id of the dmi_workitem object for this workflow

instance

task_name CHAR(255) Task name of follow up task

notif_supervisor BOOLEAN True if supervisor was notified

notif_task_owner BOOLEAN True if owner was notified

action CHAR(128) Followup action from workflow configuration (e.g. Validation,

Cancellation, Delegation, etc.)

action_option CHAR(128) Action options from workflow configuration

task_start_date TIME

notif_recipient_type CHAR(127) Type of recipient (“users” “alias” or “jocker”)

notif_recipient_value CHAR(127) Recipient name

notif_other CHAR(127) “other” recipient email address

d2c_mailing_audit

This object serves as a queue item for mailing configurations. Pending mails are queued as d2c_mailing_audit objects, and

dequeued and mailed out by D2JobMailing.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

audited_id ID R_object_id of audited document

document_set CHAR(255) Object_name of matching d2_documentset

mailing_config CHAR(255) Object_name of d2_mail_config object responsible for the

mailing

audit_date TIME Date of audit record creation

Page 12: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

12

d2c_mass_create_queue

This object type is used to coordinate D2JobImportMassCreate and the D2CoreMethod. When D2JobImportMassCreate is invoked to

import a set of documents, a d2c_mass_create_queue object is created for each imported document. Subsequently, the

D2JobCoreDeQueue job will invoke D2CoreMethod with a parameter of “-scan_queue” which will cause D2CoreMethod to dequeue

the documents and apply auto naming logic to them.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

doc_id ID R_object_id of the queued document

d2c_note

This object type is used to store a parallel copy of MS Word document content in the case where a user has applied native

annotations. It is associated to the parent document using a dm_relation having relation_name=”D2_ANNOTATE”. Although

d2c_note does not have any type specific attributes, the object name is overloaded to also include the user_name of the user who

has created the annotations. So for example, if user “Betsy Smith” annotates the document “Office Politics.docx” the resulting

d2c_note object would have object_name=”Office Politics.docx (Betsy Smith)”.

SuperType Name: dm_sysobject

(no type specific attributes)

d2c_preferences

This object is used to store individual & default user preferences, expressed by the user through the options dialog, or through other

UI gestures captured by the D2 client.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

object_name CHAR(32) User_name for user corresponding to this preference object, or

“Default” for the default preferences set

order_col_type CHAR(255) REPEATING Type of content this preference applies to (See col_type below

for options)

order_direction CHAR(4) REPEATING DQL Sort order direction (“ASC” or “DESC”)

order_attr_name CHAR(70) REPEATING Attribute name of column to sort results on

col_name CHAR(255) REPEATING Attribute name for displayed column

col_width INTEGER REPEATING Width of displayed column

col_type CHAR(255) REPEATING Type of content this column preference applies to. Should be one

of the following:

"node_root"

Page 13: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

13

"node_docbase"

"node_inbox_notifications”

"node_inbox_tasks"

"node_delegations"

"node_favorites"

"node_distributions"

"node_distribution"

"node_checkout"

"node_saved_searches"

"node_saved_public_searches"

"node_last_search"

"node_async_searches"

"node_async_search"

"node_search"

"node_admin"

"node_admin_dictionaries"

"node_admin_taxonomies"

"node_admin_register_tables"

"node_admin_templates"

"node_admin_groups"

"node_admin_users"

"node_admin_jobs"

"node_cabinets"

"default"

"search"

"opensearch"

"vd"

"publish"

"detail_audits"

"detail_audits_extended"

"detail_locations"

"detail_relations"

"detail_renditions"

"detail_versions"

"detail_workflows"

"detail_workflow_notes"

"detail_workflow_performers"

Page 14: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

14

"detail_workflow_manager"

"detail_workflow_overview"

"detail_workflow_relations"

"detail_snapshots"

"detail_sequences"

"detail_versions_config"

"detail_d2links"

vd_show_number BOOLEAN True if position numbers should be shown in the virtual

document widget

vd_show_version BOOLEAN True if document version numbers should be shown in the virtual

document widget

start_treenode CHAR(32) (3.x versions only) The starting selected node in the docbase

window.

edit_after_import BOOLEAN **UNUSED**

default_formats CHAR(32) REPEATING **UNUSED**

show_version BOOLEAN True if version numbers should be displayed on documents

order_folder_before BOOLEAN True if folders should be displayed before documents in contents

filter_name CHAR(255) Name of d2_filter_config to use when showing contents

hide_folder_main BOOLEAN (3.x only) True if folders should be hidden in the main window.

dateformat_locale CHAR(2) REPEATING Locale code for date preferences

dateformat_datetime CHAR(64) REPEATING Format for display when both date & time are showing

dateformat_date CHAR(64) REPEATING Format for display when only date is showing

view_mode CHAR(255) Contents widget view mode: “details” or “thumbnails”

thumbnails_size CHAR(32) “medium_jpeg_th” or “large_jpeg_th”

thumbnails_format CHAR(32) Format name for the rendition used in thumbnails view. (e.g.

“jpeg_th”)

last_notification_id ID (3.x only) The r_object_id of the last message received

messaging_enabled BOOLEAN (3.x only) True if message polling is enabled

messaging_refresh_time DOUBLE (3.x only) Time in minutes between checks for new messages

default_language CHAR(32) Default language to use in the UI

internal_version CHAR(255) Product version this object was last saved with (for data

upgrade)

animation_disabled BOOLEAN (3.x only) True if animations are disabled in the UI to improve

performance

pagination_enabled BOOLEAN (3.x only) True if pagination should be used in the UI

Page 15: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

15

pagination_number INTEGER Number of results per page

hide_vd_tree BOOLEAN (3.x only) True if virtual documents node should be hidden

d2c_query

This object stores the parameters of a saved search or filter. The owner of the saved search is persisted in the

dm_sysobject.owner_name field.

Note: although a number of the attributes of this type are defined as repeating attributes, the repeating values are stored as a

comma delimited list at index 0, and the remaining positions in the repeating attribute are unused. These attributes are described

below as “comma delimited.”

SuperType Name: dm_sysobject

ATTRIBUTE NAME TYPE DESCRIPTION

all_versions BOOLEAN True if the search includes non-current versions of documents.

condition CHAR(2000) DQL predicate

folder_descend BOOLEAN True if folder path clauses should use DQL DESCEND

fulltext_condition CHAR(255) FTDQL predicate

folder_path CHAR(2000) REPEATING Folder paths to include

searched_type CHAR(32) DEPRECATED-Current versions of D2 use the searched_types

repeating attribute instead.

is_filter BOOLEAN True if this query is used as a UI filter

is_public BOOLEAN True if this saved search is shared with other users

col_name CHAR(255) REPEATING Column names to return

order_by CHAR(255) Column name to sort on

order_by_direction CHAR(32) DQL sort order (ASC or DESC)

migrate_version INTEGER Internal object version used to manage upgrades. (As of D2 4.2,

the current alue for this field is 2)

searched_types CHAR(32) REPEATING Object types to search

logical CHAR(32) REPEATING Comma delimited list of logical operators

bracket_open CHAR(32) REPEATING Comma delimited list of open brackets. (If a row in advanced

search has open parentheses enabled, the corresponding slot in

the delimited list with contain a ‘(‘ character.

bracket_close CHAR(32) REPEATING Comma delimited list of closing brackets.

operator CHAR(32) REPEATING Comma delimited list of comparison operators, used in

conjunction with attr and attr_value

fulltext_operator CHAR(64) “all_words” “any_words” “exact_phrase” or “without_words”

Page 16: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

16

fulltext_words CHAR(512) Full text search terms

case_sensitive BOOLEAN True if query is case sensitive

hidden_objects BOOLEAN True if query should include hidden objects

attr CHAR(64) REPEATING Comma delimited list of attributes to compare

attr_value CHAR(2000) REPEATING Comma delimited list of values to compare attribute against,

using corresponding operator field

facets CHAR(32) REPEATING Attribute names to use as facets in search results

d2c_query_category

This folder subtype represents a “search category” in the saved searches widget tree hierarchy. Query objects and/or other

d2c_query_category objects are placed in the d2c_query_category folder in order to maintain the hierarchy.

SuperType Name: dm_folder

ATTRIBUTE NAME TYPE DESCRIPTION

reader_groups CHAR(32) REPEATING Group_names of dm_group objects that can read this category

d2c_query_dql

This object represents a saved “DQL search.” Although DQL searches are visible and executable in the 4.x clients, it is not possible

to create a d2c_query object from 4.x, so only queries previously created through 3.1 can be executed.

SuperType Name: d2c_query

ATTRIBUTE NAME TYPE DESCRIPTION

dql CHAR(2000) Dql query to execute

add_mandatory BOOLEAN If true, then expected attributes for displaying search results in

the doclist will be added to the query. (r_object_id,

r_object_type, a_content_type, r_is_virtual_doc, r_link_cnt,

r_lock_owner, r_immutable_flag, r_frozen_flag)

d2c_query_dql_wizard

This type is used to store saved DQL queries that have been configured to show the search UI prior to executing. As with the super

type, objects of this type are only created from the 3.x client.

SuperType Name: d2c_query_dql

(no type specific attributes)

d2c_query_form

Page 17: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

17

This type is used to store searches that launch a query form to the user to request query parameters. Query forms must be

configured in D2-Config.

SuperType Name: d2c_query

ATTRIBUTE NAME TYPE DESCRIPTION

config_name CHAR(255) Object_name of the d2_queryform_config object describing the

query form based search

d2c_query_opensearch

(3.x only) This type is used to store queries made against an OpenSearch server.

SuperType Name: d2c_query

ATTRIBUTE NAME TYPE DESCRIPTION

search_term CHAR(2000) Open search query

d2c_query_wizard

This type is used to store saved queries that have been configured to show the search UI prior to executing.

SuperType Name: d2c_query

(no type specific attributes)

d2c_snapshot

This type is used to store a virtual document snapshot. Snapshots in D2 are created by creating an assembly of the virtual

document including all of the VD contents labeled as CURRENT. (See IDfSysobject.assemble() in the DFC javadocs.)

SuperType Name: dm_sysobject

(no type specific attributes)

d2c_subscription

This object is used to store subscription information when a user subscribes to an object using a subscription configuration.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

user_name CHAR(32) User name of the subscribed user

Page 18: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

18

subscription_config CHAR(255) Object_name of the d2_subscription_config object describing the

subscription

for_object_id ID Object subscribed to

d2c_subscription_audit

This type is used to manage subscription events where “differ notifications” has been checked on the subscription configuration, and

a separate email must be sent to each recipient. In that case, D2JobSubscription dequeues the event from d2c_subscription_queue

and enqueues an object in d2c_subscription_audit for each recipient. This queue is consumed by D2JobSubscriptionSendMail.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

user_to CHAR(32) Email recipient

user_from CHAR(32) User triggering the event

doc_id ID R_object_id of the object the event happened on

subscription_config CHAR(255) Object_name of the d2_subscription_config

event_date TIME Date/time of the event

attr_type CHAR(255) REPEATING Attribute names for attributes used in message fields

attr_value CHAR(255) REPEATING Attribute values for attributes used in message fields

d2c_subscription_queue

This type is used to manage queued events for subscriptions that have not been mailed out yet. This queue is consumed by

D2JobSubscription

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

event_name CHAR(64) D2 event that triggered the subscription

item_id ID R_object_id of the document.

sent_by CHAR(64) User causing the event to trigger.

d2c_task_folder

This folder type is used to create the “Tasks” folder underneath /Resources/<user_name>.

SuperType Name: dm_folder

(no type specific attributes)

Page 19: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

19

d2c_task_user_folder

This folder type is used to create subfolders for tasks when the user organizes the task inbox through the D2 ui.

SuperType Name: d2c_task_folder

(no type specific attributes)

d2c_wf_pop_history

This type is used to maintain a history of accept & reject emails received through the workflow inbox.

The history table is populated by the D2JobWFReceiveTaskMail when external tasks are managed be emails.

It can be cleaned using the D2JobWFCleanPopHistory job.

SuperType Name:

ATTRIBUTE NAME TYPE DESCRIPTION

mail_address CHAR(512) Address the mail was sent to.

mail_already_received BOOLEAN True if the mail item was skipped because it was already

received.

mail_sent_date TIME Sent date of email.

mail_uid CHAR(512) UID for the message (composed of mail address, send date, and

task id)

work_item_id ID Object Id of the task.

d2c_workflow_tracker

This type is used by D2 to store additional information for D2 workflow. When a workflow is launched by D2, in addition to the

normal dm_workflow object, D2 will create a d2c_workflow_tracker object, and attach it to the dm_workflow using a dm_relation of

type D2_WF_TRACKER_WORKFLOW.

Additionally, the d2c_workflow_tracker is connected via relation to the dm_sysobject the workflow is launched on

(D2_WF_TRACKER_DOCUMENT) and the dm_process workflow template object for the workflow (D2_WF_TRACKER_TEMPLATE).

Workflow trackers are primarily maintained as XML content. In addition to the data stored as sysobject metadata, the following

elements are stored as nodes of the XML content:

<notes>: Notification messages

<aliases>: dictionary aliases used in workflow participants

<arguments>: **UNUSED**

<emails>: Mail messages sent by D2JobWFSendTaskMail

<activities>: Followup activities

Page 20: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

20

<properties>: Input properties (activity date and activity owner) normally set when a manual task property page is saved

SuperType Name: dm_document

ATTRIBUTE NAME TYPE DESCRIPTION

scheduled_start_date TIME Automatic launch date for the workflow (set in the UI)

tracker_state INTEGER STATE_SCHEDULED = 0

STATE_RUNNING = 1

STATE_TERMINATED = 2

STATE_ABORTED = 3

STATE_DUE_DATE_OVER = 4

workflow_config_name CHAR(255) Object_name of the d2_workflow_config object used to launch

the workflow

end_date TIME Actual end date for the workflow

scheduled_end_date TIME Planned end date for the workflow, (usually paired with

notifications if the workflow is not ended on time)

send_notif_on_start BOOLEAN TRUE if the workflow recipients should be notified at workflow

start

notif_frequency INTEGER **UNUSED**

start_date TIME Actual start date for workflow

send_notif_before_end BOOLEAN TRUE if the workflow has a planned end date

is_clean BOOLEAN TRUE if the workflow is finished or terminated, and

D2JobWFCleanerWorkflows has already cleaned up the

associated dynamic groups or aliases.

x3_preferences

This type is used by D2 to store user preferences specific to the 4.x user interface.

SuperType Name: dm_sysobject

ATTRIBUTE NAME TYPE DESCRIPTION

object_name CHAR(255) user_name of preferences owner

download_machine_name CHAR(2000) REPEATING Machine name corresponding to download location attributes

download_location_checkout CHAR(2000) REPEATING Location to store checked out files

download_location_view CHAR(2000) REPEATING Location to store viewed files.

portal_menu_position CHAR(32) "top" or "left"

Page 21: EMC Documentum D2 Runtime Object Reference Guide · PDF fileEMC DOCUMENTUM D2 RUNTIME OBJECT REFERENCE GUIDE ... dql CHAR(2000) If is_dql is set, dql will contain the query used to

21

portal_menu_width INTEGER Width in pixels for for left-side portal menu (ignored if

portal_menu_position="top")

portal_row_height CHAR(32) "small" or "large"