Documentum Web Development Kit and Webtop 6.7 Reference Guide

EMC ® Documentum ®
Web Development Kit and Webtop

Version 6.7
Reference Guide
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Legal Notice
Copyright © 2000-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. Adobe and Adobe PDF
Library are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarks
used herein are the property of their respective owners.
Documentation Feedback
Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we can
make our documentation better or easier to use, please send us your feedback directly at IIGDocumentationFeedback@emc.com
Table of Contents
Preface ................................................................................................................................ 11
Chapter 1 Controls Reference ..................................................................................... 13
Common control attributes ........................................................................... 13
Event attributes ............................................................................................ 14
Action attributes ........................................................................................... 15
Dynamic action attribute values .................................................................... 16
Runtime tag attribute override ...................................................................... 17
Actions ............................................................................................................ 17
Attributes ........................................................................................................ 33
Client browser detection ................................................................................... 56
Collaboration ................................................................................................... 59
Context ............................................................................................................ 86
Data display ..................................................................................................... 87
Data validation ............................................................................................... 122
Date/time ....................................................................................................... 143
Drag and drop................................................................................................ 151
Framework .................................................................................................... 154
Generating client and server events ................................................................. 156
Grouping user interface elements .................................................................... 160
HTML ........................................................................................................... 169
Document Image Services ............................................................................... 204
Including components .................................................................................... 213
Including other pages ..................................................................................... 215
Internal use only............................................................................................. 217
Links ............................................................................................................. 218
Media and transformation ............................................................................... 224
Menu grouping .............................................................................................. 228
Navigational aids ........................................................................................... 235
Object and file selection .................................................................................. 242
Output formatting .......................................................................................... 248
Passing arguments .......................................................................................... 259
Passwords ...................................................................................................... 261
Preferences..................................................................................................... 263
Repositories ................................................................................................... 271
Search ............................................................................................................ 283
Text display and input .................................................................................... 312
Trees .............................................................................................................. 318
EMC Documentum Web Development Kit and Webtop Version 6.7 Reference Guide 3
Table of Contents
User feedback................................................................................................. 324

Virtual documents .......................................................................................... 330
Web Workflow Manager ................................................................................. 333
Workflow ....................................................................................................... 335
xForms .......................................................................................................... 339
Chapter 2 Actions Reference ..................................................................................... 343

Overview ....................................................................................................... 343
Common elements .......................................................................................... 343
failoverenabled........................................................................................... 343
invocation .................................................................................................. 343
reverse-precondition ................................................................................... 344
Application connectors ................................................................................... 344
Application management ................................................................................ 349
Attributes ...................................................................................................... 355
Cabinets and folders ....................................................................................... 370
Categories ...................................................................................................... 373
Clipboard operations ...................................................................................... 374
Collaboration ................................................................................................. 381
Creating objects .............................................................................................. 415
Data export .................................................................................................... 416
Document Imaging Services ............................................................................ 417
Downloading and uploading content ............................................................... 419
Emailing links to objects.................................................................................. 455
Formats ......................................................................................................... 458
General user interface ..................................................................................... 459
Jobs ............................................................................................................... 462
Lifecycles ....................................................................................................... 464
Locating objects .............................................................................................. 468
Media and transformation ............................................................................... 474
Navigational aids ........................................................................................... 479
Notifications .................................................................................................. 480
Physical Records Manager .............................................................................. 483
Preferences..................................................................................................... 486
Presets ........................................................................................................... 489
Records Manager............................................................................................ 499
Relationships between objects ......................................................................... 503
Renditions...................................................................................................... 505
Replicas and References .................................................................................. 512
Repository ..................................................................................................... 513
Search ............................................................................................................ 516
Security ......................................................................................................... 541
Subscriptions ................................................................................................. 557
Testing ........................................................................................................... 559
4 EMC Documentum Web Development Kit and Webtop Version 6.7 Reference Guide
Table of Contents
User feedback................................................................................................. 565

Users, groups, and roles .................................................................................. 566
Virtual documents .......................................................................................... 590
Workflows ..................................................................................................... 621
Work queue management ............................................................................... 679
XForms .......................................................................................................... 720
Chapter 3 Components Reference ............................................................................. 725

Overview ....................................................................................................... 725
Common elements .......................................................................................... 725
actiontable ................................................................................................. 725
allversionsvisible ........................................................................................ 725
asynchronous ............................................................................................. 725
attributes ................................................................................................... 725
autogettaskdefault ...................................................................................... 726
base_type ................................................................................................... 726
bindingcomponentversion .......................................................................... 726
breadcrumbiconwellmode........................................................................... 726
cabinets...................................................................................................... 726
category ..................................................................................................... 726
clientevent ................................................................................................. 727
columns (for data columns) ......................................................................... 727
columns (for streamline view) ..................................................................... 727
columns_list ............................................................................................... 728
columns_all_saved_searches ....................................................................... 728
columns_my_saved_searches ...................................................................... 728
columns_saved_search ................................................................................ 729
comments .................................................................................................. 729
commitorder .............................................................................................. 730
containerselectable ..................................................................................... 730
contenttypepanelvisible .............................................................................. 730
cost_attribute_conditions ............................................................................ 730
default_binding_filter_values ...................................................................... 731
default_type ............................................................................................... 731
defaultaccounts .......................................................................................... 731
defaultsources ............................................................................................ 731
defaultview ................................................................................................ 732
displayresultspath ...................................................................................... 732
docbase-type-mappings .............................................................................. 732
document-docbase-base-type ...................................................................... 732
document-docbase-type .............................................................................. 732
document_filter .......................................................................................... 733
dragdrop ................................................................................................... 733
duration_attribute_conditions ..................................................................... 734
enableShowAll ........................................................................................... 734
entrypage................................................................................................... 734
failoverenabled........................................................................................... 734
filenamefiltervisible .................................................................................... 734
filter........................................................................................................... 735
flatlist ........................................................................................................ 735
folder-docbase-type .................................................................................... 735
folder_filter ................................................................................................ 735
formsavefolderpath .................................................................................... 735
header ....................................................................................................... 736
help-entries ................................................................................................ 736
helppath .................................................................................................... 736
Table of Contents
hideEvents ................................................................................................. 736

highlight_matching_terms .......................................................................... 736
homeURL .................................................................................................. 737
homecabinet ............................................................................................... 737
iconwell_icon ............................................................................................. 737
inbox ......................................................................................................... 737
includetypes............................................................................................... 737
includeunlisted .......................................................................................... 737
init-controls................................................................................................ 738
isIgnorePrefRenditions ............................................................................... 738
locator ....................................................................................................... 738
lockInstance ............................................................................................... 738
map ........................................................................................................... 738
maxidletime ............................................................................................... 739
menugrouptarget ....................................................................................... 739
modifiedwithindays ................................................................................... 739
multidocbasesupport .................................................................................. 739
myobjects ................................................................................................... 739
navigationlinks........................................................................................... 739
newcomponentname .................................................................................. 740
nodes ......................................................................................................... 740
nomaclsupport ........................................................................................... 740
nondocbasecolumns ................................................................................... 741
numberedtabs ............................................................................................ 741
objectfilters ................................................................................................ 741
pageTitle .................................................................................................... 741
permissionsservice ..................................................................................... 742
preferencedisplaygroups ............................................................................. 742
preferences................................................................................................. 742
preserve-file-extension ................................................................................ 743
preset_item ................................................................................................ 743
preset_item_definition ................................................................................ 744
preset_scope_definitions ............................................................................. 745
privatecabinet_visible ................................................................................. 745
privatecabinetvisible ................................................................................... 745
privategroupvisible .................................................................................... 745
readOnly.................................................................................................... 745
savedetailsreport ........................................................................................ 746
search_types .............................................................................................. 746
searchtypes ................................................................................................ 746
selectedattribute ......................................................................................... 747
serveroptionenabled ................................................................................... 747
service ....................................................................................................... 747
setrepositoryfromobjectid ........................................................................... 747
showattachmentinfo ................................................................................... 747
showautogettask ........................................................................................ 748
showbreadcrumb ....................................................................................... 748
showfilters ................................................................................................. 748
showfolderpath .......................................................................................... 748
showfolders ............................................................................................... 748
showheaderforsinglepackage ...................................................................... 748
showjobstatus ............................................................................................ 748
showoptions............................................................................................... 749
showpagesastabs ........................................................................................ 749
showusertimeandcost ................................................................................. 749
skipVersionCheck ....................................................................................... 749
startComp .................................................................................................. 749
startQueryString ......................................................................................... 749
subscriptions .............................................................................................. 749
Table of Contents
taskmgractionname .................................................................................... 750

taskmanagerid ........................................................................................... 750
transformation ........................................................................................... 750
type ........................................................................................................... 750
ucfrequired ................................................................................................ 750
updatereplicasource ................................................................................... 751
useronly..................................................................................................... 751
useroptions ................................................................................................ 751
views ......................................................................................................... 751
windowparams .......................................................................................... 753
workflowstatusactionname ......................................................................... 753
workqueuegroupvisible .............................................................................. 753
Actions .......................................................................................................... 753
Administration ............................................................................................... 754
Application connectors ................................................................................... 756
Application management ................................................................................ 787
Attributes ...................................................................................................... 814
Cabinets and folders ....................................................................................... 846
Categories ...................................................................................................... 854
Clipboard operations ...................................................................................... 869
Collaboration ................................................................................................. 872
Creating objects .............................................................................................. 941
Data import and export ................................................................................... 946
Displaying lists of objects ................................................................................ 948
Displaying lists of objects associated with an object........................................... 972
Document Imaging Services ............................................................................ 975
Downloading and uploading content ............................................................... 983
Emailing object links ..................................................................................... 1036
Formats ....................................................................................................... 1042
General user interface ................................................................................... 1046
Helpers ........................................................................................................ 1063
Home Cabinet .............................................................................................. 1065
Inbox ........................................................................................................... 1074
Jobs ............................................................................................................. 1077
Lifecycles ..................................................................................................... 1081
Locating objects ............................................................................................ 1090
Media and transformation ............................................................................. 1091
Menus ......................................................................................................... 1100
Message archives .......................................................................................... 1102
My Files ....................................................................................................... 1103
Physical Records Manager ............................................................................ 1109
Preferences................................................................................................... 1116
Presets ......................................................................................................... 1130
Records Manager.......................................................................................... 1153
Relationships between objects ....................................................................... 1181
Renditions.................................................................................................... 1184
Table of Contents
Repository ................................................................................................... 1186

Retention Policy Services............................................................................... 1191
Search .......................................................................................................... 1192
Security ....................................................................................................... 1230
Subscriptions ............................................................................................... 1248
Task manager ............................................................................................... 1257
Testing ......................................................................................................... 1259
Trees ............................................................................................................ 1298
User feedback............................................................................................... 1304
Users, groups, and roles ................................................................................ 1315
Virtual document assemblies ......................................................................... 1348
Virtual documents ........................................................................................ 1354
Workflow reporting ...................................................................................... 1376
Workflows ................................................................................................... 1404
Work queue management ............................................................................. 1483
XForms ........................................................................................................ 1540
Appendix A Version 6.7: New Controls, Actions, and Components ............................ 1555
Controls ....................................................................................................... 1555
Actions ........................................................................................................ 1555
Components................................................................................................. 1555
Appendix B Obsolete, Deprecated, or Unused functionality ....................................... 1557

Controls ....................................................................................................... 1557
Actions ........................................................................................................ 1557
Components................................................................................................. 1557
JSP files ........................................................................................................ 1558
Table of Contents
List of Figures
Figure 1. In-progress real-time search monitoring ............................................................. 1219

Figure 2. Completed real-time search monitoring ............................................................. 1220
Table of Contents
List of Tables
Table 1. Common control attributes ................................................................................... 13

Table 2. Event attributes .................................................................................................... 15
Table 3. Common action control attributes .......................................................................... 15
Table 4. Rich text configuration elements ............................................................................ 71
Table 5. Rich text configuration elements ............................................................................ 76
Table 6. Rich text editor configuration elements (<editor>) ................................................... 77
Table 7. Row selection settings ........................................................................................... 94
Table 8. Valid Mask Characters ........................................................................................ 132
Table 9. Global date input control configuration elements .................................................. 145
Table 10. Global datetime control configuration elements .................................................... 149
Table 11. Global datetime control configuration elements .................................................... 150
Table 12. Image Viewer Control Parameters ....................................................................... 210
Preface
This reference manual is part of the documentation set for the Documentum Web Development Kit
(WDK) and Webtop. Other materials related to WDK are:
• Web Development Kit Development Guide
• Web Development Kit and Webtop Deployment Guide
• Web Development Kit and Applications Tutorial
• Javadocs for WDK, Webtop, and Documentum Foundation Classes (DFC)
The Documentum developer Web site, developer.documentum.com, provides sample code, tips,
white papers, and a wealth of information to assist you in developing Documentum-enabled
applications.
This guide is intended for two tasks:
• Configuration
Changes to XML files or modifications of JSP pages to configure controls on the page. Does not
require a developer license.
• Customization
Extending WDK classes or modifying the JSP pages to include new functionality. Requires
a developer license.
Note: As newer versions of Documentum Webtop are released, all controls, actions, and components
including JSP and XML that belong to Streamline view and Portlets features are deprecated from
6.6 versions of WDK-based applications. EMC does not support these features any longer. The
Appendix B, Obsolete, Deprecated, or Unused functionality contains more information. However,
this document contains references and documentation on the deprecated/unsupported features for
the benefit of customers that are already using these features. Please note that the entire content on
the deprecated/unsupported features will be removed from all the Web Development Kit and Webtop
product documentation as part of future Webtop releases.
Revision history
The following changes have been made to this document:
Revision Date Description

August 2014 • Added a note on deprecated features.
• Added the Appendix B, Obsolete, Deprecated, or Unused functionality.
Preface
Revision Date Description

September 2012 Removed the information on using the Image Viewer Control tag in
viewercontrol, page 205. Updated viewercontrol attribute descriptions.
April 2011 Initial publication
Chapter 1
Controls Reference
Overview
Controls are grouped according to how they are used.
The configurable attributes for WDK controls are documented in this section. Control attributes are
configured in the JSP page. For examples of the usage and configuration of the individual WDK,
see the JSP pages in the WDK and WDK client products such as Webtop and Web Publisher. For
information about controls specific to a WDK client product, see the development guide for that
product.
The following topics describe attributes that are common to groups of controls:
• Common control attributes, page 13
• Event attributes, page 14
• Action attributes, page 15
• Dynamic action attribute values, page 16
• Runtime tag attribute override, page 17
Portlet component controls are documented in WDK for Portlets Development Guide.
Common control attributes

The following attributes are defined by the ControlTag class and can be set on any control. Some of
these attributes may not be used by the tag classes in the rendering of the control, however. For the
exact list of all attributes that are supported by a tag class, see the tag library.
Event attributes such as runatclient, onchange, onselect, or onclick, are documented in Event
attributes, page 14.
The table below describes attributes that are common to most controls. If a common attribute requires
a value for a particular control, that requirement is noted in the control description.
Table 1. Common control attributes
Attribute Description
cssclass Sets the CSS class that is applied to the control.
enabled Sets whether the control is enabled.
focus True to allow the control to accept focus.
Controls Reference
id ID for the control. The ID is generated by the
framework. You can also set the ID in the JSP
page.
label Contains a string value or <nlsid> element that
maps to a string label that is displayed in the
user interface.
name Sets the name for the control. Named controls
are cached on the server. Controls with the same
name are automatically indexed.
nlsid NLS lookup key. The string corresponding to

the NLS ID is substituted for another attribute
in the control. See the individual control
descriptions for the attribute whose value is
substituted by nlsid.
style A CSS rule enclosed in quotation marks, for
example:
style="{COLOR: darkmagenta; TEXT-
DECORATION: underline}"
tooltip String displayed when you place the mouse
pointer over this control.
tooltipnlsid NLS key to use when looking up a localized
tooltip string.
tooltipdatafield Datafield that overrides the value of tooltip and
tooltipnlsid.
visible (Boolean) Whether the control is rendered as
visible (True) or hidden (False). Some controls
do not implement visibility.
Event attributes
Many controls accept user input. The user input is submitted by a control event. The value of the
event attribute corresponds to the name of an event handler. The event is generally handled in
the calling component class unless the control has the runatclient attribute set to true. To find the
exact event attributes that are supported by a control, consult the tag library descriptor (*.tld file)
for that control.
Controls Reference
Table 2. Event attributes
onchange Event fired when the use changes the control.
The onchange event handler cannot run on the
client (that is, the runatclient attribute cannot
be true). The onchange event is not handled
immediately. It is handled on the server only
when the form is submitted (for example, by an
onclick event). Some controls do not implement
an onchange event.
onselect Event fired when the user selects the control,
such as an option in a list. This event is handled
immediately on the server (when the runatclient
attribute is false) or on the client (when the
runatclient attribute is true). Some controls do
not implement an onselect event.
runatclient Specifies that the event should run on the client
(True) or the server (False). The onchange event
cannot run on the client. Some controls do not
implement a runatclient attribute.
onclick Event fired when the user clicks the control, such
a button. This event is handled immediately on
the server (when the runatclient attribute is false)
or on the client (when the runatclient attribute
is true). Some controls do not implement an
onclick event.
Action attributes
The following attributes are common to most Documentum-enabled action controls. For the full list of
attributes that are valid for a control, see the tag library descriptor that contains the control definition.
Table 3. Common action control attributes
action ID of the action to be launched by the control.
This value matches the action id attribute in the
action definition.
Controls Reference
showifinvalid Indicates whether, when the configuration
service cannot resolve the action definition:
• (True) the control is displayed as disabled
(grayed out).
• (False) the control is not displayed.
Default is false. A value of true overrides a

visible attribute that is set to false.
To hide all invalid actions in the application, set

the value of <hideinvalidactions> to true in your
custom app.xml file.
showifdisabled Whether, when one or more of the action

preconditions returns false:
• (True) the control is displayed as disabled
(grayed out).
• (False) the control is not displayed.
disabledstyle Entire CSS-syntax style sheet rule (enclosed in

quotes) to apply to the disabled control.
disabledclass CSS class to apply to the disabled control.
oncomplete Event to be fired when an associated action has
completed. This attribute cannot be used when
the dynamic attribute is set to any value other
than false.
Dynamic action attribute values

The dynamic attribute is used to specify when the action should be launched based on
the conditions of other controls on the page. The JSP page must include the JavaScript file
/wdk/include/dynamicAction.js. The dynamic attribute can have one of the following values:
singleselect The action can apply to only one selection or
object.
multiselect The action can apply to more than one selection
or object (only in classic view or objectlist).
generic The action can be launched regardless of
selections by the user. The selections are
essentially ignored.
actionbutton
genericnoselect The action cannot be launched if any items on
the page are selected.
false (Default) The action is not dynamic.
Note: Dynamic action controls do not support the oncomplete attribute.
Runtime tag attribute override

Some attribute values can be overridden by another attribute. This allows the source of a value to
come from the JSP page, a localized set of strings, a datafield, or a value based on user context. For
example, the datafield attribute is commonly used to override a label or value attribute.
The tag value that will be displayed is evaluated at run time. If more than one of the following
attributes are available for a control, the hierarchy of overrides is as follows:
• value or label attribute sets the value
• nlsid overrides the value
• datafield overrides the value and nlsid
• contextvalue overrides the datafield, nlsid, and value
Actions
actionbutton
Purpose
Generates a button that has an associated action.
Attributes
action (Required) ID of the action to be launched by

this control.
align (Optional) Deprecated in 6.0.6.0: This attribute
is ignored.Pre-6.0: (Image label only) Alignment
of the label text.
actionbutton
cssclass (Optional) CSS class that is applied to this

control.
datafield (Optional) Overrides the label value with a value
from a data source.
disabledclass (Optional) Deprecated in 6.0. CSS class to apply
to the disabled control.
disabledstyle (Optional) Deprecated in 6.0. Entire CSS-syntax
style sheet rule (enclosed in quotes) to apply to
the disabled control..
dynamic (Optional) Specifies when the action is to be
launched based on the conditions of other
controls on the JSP. Only false can be specified
for this attribute, if an event is specified for the
oncomplete attribute. See .
height (Optional) Height of the image.
hotkeyid (Optional) Value of a <hotkey> id attribute in the
hotkeys configuration file (hotkeys.xml, located
in /webcomponent/config) that references the
keyboard shortcut command string for this
control.
id (Optional) ID for this control. The ID is
generated by the framework. You can also set
the ID in the JSP page.
imagefolder (Optional) Deprecated in 6.0.6.0: Sets the folder
that the button graphics are stored in. If the
graphics are not found in this folder or this
attribute is not specified, then an HTML button
is rendered.Pre-6.0: Sets the folder that the
button graphics are stored in. If graphics are
not found in this folder, an HTML button will
be drawn.
label (Optional) Button label text (string value or
<nlsid> element).
name (Optional) Name for this control. Named
controls are cached on the server. Controls with
the same name are automatically indexed.
nlsid (Optional) NLS lookup key. The string
corresponding to the NLS ID is substituted for
the label value (that is, it overrides the datafield
and label attributes).
oncomplete (Optional) Event to be fired when an associated
action has completed. This attribute cannot be
used when the dynamic attribute is set to any
value other than false.
actionbutton
oncompleteclient (Optional) For internal use only.

showifdisabled (Optional) Whether, when one or more of the
action preconditions returns false: (True) this
control is displayed as disabled (grayed out).
(False) this control is not displayed.
showifinvalid (Optional) Indicates whether, when the
configuration service cannot resolve the action
definition: (True) this control is displayed as
disabled (grayed out). (False) this control is
not displayed. Default is false. A value of true
overrides a visible attribute that is set to false.To
hide all invalid actions in the application, set
style (Optional) CSS rule (enclosed in quotation
marks) to apply to this control; for
example:style="{COLOR: darkmagenta;
TEXT-DECORATION: underline}"
tabindex (Optional) Value (a whole number from 0 to
32767, inclusive) that determines the order
in which this control is tabbed to (that is,
receives focus when the user presses the Tab
key) in relation to the other controls on the
page. Controls on the same JSP are tabbed to in
this sequence: Controls that specify a positive
number in this attribute are tabbed to starting
from the lowest number to the highest. Controls
that do not have this attribute, or specify a
value of 0 (zero) or no value for this attribute
are tabbed to in the order they appear in the
character stream. To prevent this control from
being tabbed to (in most browsers), specify a
value of -1 for this attribute. Since 6.0.
tooltip (Optional) String displayed when you place the
mouse pointer over this control.
tooltipdatafield (Optional) Datafield that overrides the value of
tooltip and tooltipnlsid.
tooltipnlsid (Optional) NLS key to use when looking up a
localized tooltip string.
visible (Optional) (Boolean) Whether the control is
rendered as visible (True) or hidden (False).
width (Optional) Width of the image.
actionbuttonlist
Description
Since
5.x
Tag library descriptor

dmfx (WEB-INF\tlds\dmformext_1_0.tld)
Usage
The button is not shown if the action cannot be resolved. The button is displayed as disabled if the
action cannot be executed. Use the <argument> tag to set context.
In pre-6.0, by default, this control rendered the <input type=button> HTML tag; if the imagefolder
attribute was specified, then the <table>...<td>xxxLABELxxx</td>...</table> HTML tags were
rendered; if the src attribute was specified then the <img src=...> HTML tag was rendered.
In 6.0, by default this control renders the <button> tag; using the imagefolder attribute and its
associated attributes (disabledstyle, disabledclass, align) are deprecated. Also, specifying the src
attribute renders the <button><img src=...>...</button> HTML tags.
actionbuttonlist
Purpose
Generates a type-based list of action buttons. The actions that will be displayed are configured in the
<actionlist> tag of action configuration files (dm_typename_action.xml).
Attributes
cssclass (Optional) CSS class to apply to this control.

datafield (Optional) Overrides the scope field. For
example, it can be used to display only a certain
type of object in the actionlist on a per row basis
in a datagrid.
id (Optional) ID of this control. The ID is generated
by the framework. You can also set the ID in
the JSP page.
listid (Optional) ID of the actionlist to use.
name (Required) Name of this control. Named
actionimage

separatorhtml (Optional) HTML string to be displayed between
each action control (for formatting purposes).
marks, for example: style="{COLOR:
darkmagenta; TEXT-DECORATION:
underline}") to apply to this control.

Description
Since
5.x

actionimage
Purpose
Generates an image that launches an action when selected.
Attributes

this control.
alttext (Optional) Text to display when holding the
border (Optional) Border in pixels around the image.
Default is 0 (zero) pixels (that is, no border).
from a data source; overrides the URL defined
in src attribute.
actionimage
datafielddisabled (Optional) Overrides srcdisabled value.

height (Optional) (Image action buttons only) Height
of the button.
control.
hspace (Optional) Horizontal margin (white space
padding to the left and right) around the image.
the JSP page.
label (Optional) String value or <nlsid> element
(which maps to a string label) to be rendered in
addition to the image.
name (Optional) Name of this control. Named controls
the datafield and label values.
actionimage
showimage (Optional) Whether to display the icon (True) or

not (False). Default is True.
showlabel (Optional) Whether to display a label (True) or
not (False). Default is False.
src (Optional) URL to the image.
srcdisabled (Optional) Image to be used when the action is
disabled.
value of -1 for this attribute.Since 6.0.
tooltip (Optional) String to display when you place the
vspace (Optional) Vertical margin (white space padding
to the top and bottom) around the image.
width (Optional) (Image action buttons only) Width
of the button.
Description
Since
5.x
actionlink

actionlink
Purpose
Generates an HTML link that has an associated action. The link is not shown if the action cannot
be resolved. The link is shown as disabled if the action cannot be executed. Use the <argument>
tag to set context.
Attributes

this control.
control.
datafield (Optional) Overrides label or NLS value with
string from a data source.
height (Optional) (Image action buttons only) Height
of the button.
control.
actionlink
id (Optional) ID for the control. The ID is generated

the JSP page.
label (Optional) Contains a string value or <nlsid>
element that maps to a string label that is
displayed in the user interface.
linkspacer (Optional) Width (in pixels) to display as space
between dynamic links. Space is collapsed when
this control is not visible.
the label value.
showimage (Optional) Whether an image is displayed with
the link (True) or not (False). Default is False.
showlabel (Optional) Whether the label is displayed (true)
or not (false). Default is True.
srcdisabled (Optional) Image to be displayed when the
action is disabled.
underline}") that is applied to this control.
actionlink

tooltipnlsid (Optional) NLS lookup key to use when looking
up a localized tooltip string.
width (Optional) (Image action buttons only) Sets the
width of the button.
Description
Since
5.x

actionlinklist
actionlinklist
Purpose
Generates a list of action controls based on object type. The actions that are displayed are configured
in the <actionlist> element of action configuration files (dm_typename_action.xml). You can use more
than one actionlinklist control with the same scope in a JSP page, provided the listid attribute has
a different value. This allows you to display different actions for the same object type on different
screens.
Attributes
columns (Optional) Number of columns in which to

display the list in a table.
datafield (Optional) Overrides the scope field. For
example, it can be used to display only a certain
type of object in the actionlist on a per row basis
in a datagrid.
the JSP page.
listid (Optional) ID of the actionlist to use. The ID
of the list to use within the scope. If it is not
specified, then the value of "default is used.
separatorhtml (Optional) HTML string to be displayed between
each action control (for formatting purposes).
showimages (Optional) False to override images set in a
component XML definition.
showlabels (Optional) False to override labels set in
component XML definition.
actionmenuitem

underline}") applied to this control.
Description
Since
5.x

actionmenuitem
Purpose
Generates a menu item that launches an action.
Attributes

this control.
control.
datafield (Optional) Overrides menu item string or nlsid
from a data source.
control.
actionmenuitem
id (Optional) ID of the control. The ID is generated

the JSP page.
imageicon (Optional) URL to an image to be displayed as
a menu item.
the value attribute value.
underline}") that is applied to this control.
value (Optional) Menu item string.
Description
Since
5.x

actionmultiselect
Usage
Menu items do not pass arguments. Arguments are passed to the menu action through an
actionmultiselect control. This tag is also used to pass arguments to an action that does not
have a selected object, such as import. An action may use only some of the arguments in the
actionmultiselect tag, because it contains arguments for all possible multiselect actions on the page.
Arguments can also be passed within an actionmultiselectcheckbox tag, but those arguments will not
be passed to genericnoselect actions, that is, actions that ignore selected objects.
Note: You can pass arguments through the actionmultiselectcheckbox control even when row
selection is enabled and checkboxes are not used.
actionmultiselect
Purpose
Supports multiple selection with an associated action. Contains action controls with the dynamic
attribute, such as actionmultiselectcheckbox or actionlink. The action on multiply selected
items is specified by either the contained action control or by an actionmenuitem control. The
actionmultiselect control passes nested arguments (in <argument> tags) to the control that performs
the action. Multiple selection is supported only in classic or objectlist view.
Attributes
id (Optional) ID of the control. The ID is generated

the JSP page.
selectionargs (Optional) Comma-separated list of arguments
used to uniquely identify selected items.
selectiongroupargs (Optional) Comma-separated list of arguments
used to uniquely identify an item’s group.
Actions are disabled when the selected item’s
selectiongroup attribute(s) do not share the
same value.
Description
Since
5.x
actionmultiselectcheckall

Usage
Use the optional selectionargs attribute to identify each selected item in the datagrid. This will
ensure that the same items are selected when a component returns. The following example from
searchresultslist.jsp adds arguments for a selection group, which ensures that the action cannot be
performed unless the multiple objects that are selected share the same repository:
<dmfx:actionmultiselect name="multi" selectionargs="
objectId,<%=SearchInfo.ENTRYID_PARAM%>,<%=SearchInfo.
QUERYID_PARAM%>" selectiongroupargs="
<%=SearchResultSet.ATTR_DOCBASE_ID%>">
<dmfx:argument name='objectId' contextvalue='objectId'/>
...
</dmfx:actionmultiselect>
actionmultiselectcheckall
Purpose
Generates a checkbox that checks all objects in a list. When checked, an action can be performed on
all objects. In accessibility mode, this control generates a link to a global actions page, which displays
actions that do not require a selected object.
Attributes

actionmultiselectcheckbox

Description
Since
5.x

actionmultiselectcheckbox
Purpose
Generates a checkbox that has one or more associated actions. Must be contained within an
<actionmultiselect> tag in a datagrid header. All action controls on the page with the dynamic value
set to multiselect are associated with the checkbox. In accessibility mode, this control generates a
link to an actions page for the object.
Attributes

docbaseattribute

value (Optional) (Boolean) Checkbox is checked
(True); checkbox is unchecked (False). Default
is false.
Description
Since
5.x

Attributes
docbaseattribute
Purpose
Displays the label and value of an object specified in the associated <docbaseobject> tag. This
control generates the following controls: docbaseattributevalue (which validates against the data
dictionary), docbaseattributelabel, and some HTML table tags. This control is used within a table or
within a component class.
docbaseattribute
Attributes
attribute (Optional) Name of an object attribute.

col1 (Optional) HTML to be rendered between label
and value. Default is </td><td>. For example:
col1="</td><td><b>:</b></td><td>"
col2 (Optional) HTML to be rendered between
col1 and the value. Default is an empty cell:
</td><td>
datafield (Optional) Overrides attribute value.
docbaseattributevalueassistance (Optional) Name of the docbaseattributeval-
ueassistance control in which a list of value is
specified.
enabled (Optional) Whether this control is enabled (True)
or disabled (False).
focus (Optional) Whether this control accepts focus
(True) or not (False).
the JSP page.
lines (Optional) Number of lines to display for an
attribute. Use the lines and the size attributes
to display the attribute.
object (Required) Name of associated docbaseobject
control on the JSP. For example,
<dmfx:docbaseobject name="obj"/> sets
the object and <dmfx:docbaseattribute
object="obj" attribute="object_name"...> sets the
attribute for that object.
post (Optional) HTML to render after this control.
Default = </td></tr> (closes the row).
pre (Optional) HTML to render before this control.
Default = <tr><td> (opens the row).
docbaseattribute
readonly (Optional) Whether this control is read-only

(True) or read-write (False). This attribute does
not override or change the status of the object
attribute value in the repository; it only applies
to the rendering of the object attribute in the user
interface. You use the attributes component’s
readOnly parameter to override this attribute’s
value of false.
required (Optional) Whether the attribute is required
showobjectidasname (Optional) Whether to to display the name of the
object (False) or override it with the object ID
(True) . Default is true. You can use a formatter
in a docbaseobject configuration file to override
this value.
size (Optional) Size of this control.
validate (Optional) Whether to enable data dictionary
validation (True) or disable it (False). Default is
true.
Description
Since
5.x

Usage
To format the attributes that are displayed by this control, wrap the control in a formatter control. For
example, you can format a boolean value with booleanformatter, a date with datevalueformatter.
Other formatters include htmlsafetextformatter, numberformatter, stringlengthformatter,
multilinestringlengthformatter, docformatvalueformatter, docsizevalueformatter,
folderexclusionformatter, rankvalueformatter, and vdmbindingruleformatter.
If you wish to generate a list of attributes from the data dictionary rather than using individual
attribute controls, use a docbaseattributelist control.
If you need to do custom (not data dictionary) validation for the attribute, do not use this control. Use
the repositoryattributevalue tag with docbaseattributelabel. The docbaseattributevalue tag performs
data dictionary validation and accepts other validators.
If you need value assistance for the attribute, provide a name for your value assistance set as follows:
docbaseattributedelegate
<dmfx:docbaseattribute object="obj" attribute="keywords"

docbaseattributevalueassistance="my_resultset"
size="48" cssclass="defaultLabelStyle"/>
The values for the value assistance list are provided by docbaseattributevalueassistance value tags,
either in the JSP page or in the component class. See docbaseattributevalueassistancevalue, page 47
for details.
Purpose
Displays, in a datagrid, pseudoattributes and attributes for which there is a docbaseobjectconfiguration
file. If there is no custom configuration, this control works the same as the docbaseattribute control.
Attributes
attribute (Optional) Name of the object attribute to

display.
col1 (Optional) HTML to be rendered between
the label and value. Default = </td><td>. For
example: col1="</td><td><b>:</b></td><td>"
col2 (Optional) HTML to be rendered between the
HTML generated by the col1 attribute and the
value. Default = an empty cell: </td><td>
cssclass (Optional) the CSS class to apply to this control.
datafield (Optional) Name of the datafield to override the
attribute value.
specified.
the JSP page.
lines (Optional) Specifies the number of lines to
display for an attribute. Use the lines and the
size attributes to display the attribute.

post (Optional) HTML to render after this control.
Default = </td></tr> (that is, closes the row).
pre (Optional) HTML to render before this control.
Default = <tr><td> (that is, opens the row).
value of false.
(True) or optional (False)
this value.
validate (Optional) (Boolean) Indicates whether to
validate the control (True) or not (False). Default
is true.
Description
Since
5.x

docbaseattributelabel
Usage
To format the attributes that are displayed by this control, wrap the control in a formatter control. For
example, you can format a boolean value with booleanformatter, a date with datevalueformatter.
Other formatters include htmlsafetextformatter, numberformatter, stringlengthformatter,
multilinestringlengthformatter, docformatvalueformatter, docsizevalueformatter,
folderexclusionformatter, rankvalueformatter, and vdmbindingruleformatter.
If you need to do custom (not data dictionary) validation for the attribute, do not use this control. Use
the repositoryattributevalue tag with docbaseattributelabel. The docbaseattributevalue tag performs
data dictionary validation and accepts other validators.
If you need value assistance for the attribute, provide a name for your value assistance set as follows:
The values for the value assistance list are provided by docbaseattributevalueassistance value tags,
either in the JSP page or in the component class. See docbaseattributevalueassistancevalue, page
47for details.
docbaseattributelabel
Purpose
Displays the label for an attribute of an object specified in the associated <docbaseobject> tag.
Attributes
attribute (Optional) Name of the object attribute for

which to display a label.
datafield (Optional) Overrides the attribute value.
the JSP page.
control.
docbaseattributelist
Description
Since
5.x

Purpose
Displays all visible attributes of the Documentum object specified as the associated docbaseobject
control. Attributes are rendered by category as defined in the data dictionary or configuration file.
Each attribute is generated as a docbaseattribute control instance that encapsulates data dictionary
information.
Attributes
attrconfigid (Required) Configuration ID to identify which

control definition file to use. Must correspond to
the value for id in <attributelist id="attributes">
in the corresponding control definition file.
categorypost (Optional) HTML string to render after each
category. Scripts are not supported. Default is
</th></td></tr> (taht is, closes the row).
categorypre (Optional) HTML string to render before each
category. Scripts are not supported. Default
is <tr><td colspan=\3\><hr></td></tr><tr><th
align=\left\>
col1 (Optional) HTML string to render between the
label and value. Scripts are not supported.
Default is </th><td><b>:</b></td><td>
value and validator. Scripts are not supported.
Default is </td><td>
the JSP page.
inlinerefresh (Optional) Determines whether to perform an

inline refresh (true) or full page refresh (false)
when user clicks on the Show More/Hide More
(image or link) to display or hide the secondary
docbase attribute list. Default is true. You must
also set both the pre attribute and the separator
attributes to their defaults.
Since: 6.5
morelinkpost (Optional) HTML string to render after the Show
More link. Scripts are not supported. Default is
</td></tr>
morelinkpre (Optional) HTML string to render before the
Show More link. Scripts are not supported.
Default is <tr><td colspan=\4\>
name are automatically indexed. 6.0: Changed
from Required to Optional.
control on the JSP page.
post (Optional) HTML string to render after each
docbaseattribute control. Scripts are not
supported. Default is </td></tr> (closes the row)
pre (Optional) HTML string to render before
each docbasattribute control. Scripts are not
supported. Default is <tr><th align=\right\>
value of false.
separator (Optional) HTML to render as a separator
between attributes. Default = <tr><td colspan
= \3\><hr></td></tr>. Valid for 5.2 repositories
only.
showcategorynames (Optional) Whether to display category names
in the user interface (True) or not (False). If
there is only one category or the component
definition’s <showpagesastabs> element content
is true, the category name is not displayed.

this value.
size (Optional) Size (in pixels) of this control.
visiblecategory (Optional) Comma-separated string that
specifies the categories to display. Default is
null (that is, all categories are displayed).
Description
Since
5.x

Usage
A single docbaseattributelist control in the JSP eliminates the need for a separate docbaseattribute
control for each attribute to be listed. Attributes are displayed in categories, and categories are
displayed in the user interface as tabs. You can configure the attributes that are displayed in categories
using the data dictionary or an attributelist Configuration file. You can display a different set of
attributes for each component that displays attributes and for any context that is defined by a qualifier
in your application, for example, checkin, checkin by administrator, checkin of a custom type.
docbaseattributeproxy
To set a different docbaseattributelist configuration in your behavior class depending on business

rules, for example, to display a particular attribute only when a business condition is met, put two or
more docbaseattributelist controls within a panel control on the page. Show or hide each panel using
the panel setVisible method to use the proper attribute list, for example:
Panel attrlst1 = (Panel) getControl(ATTRLST1PANEL, Panel.class);
attrlst1.setVisible(true);
Panel attrlst2 = (Panel) getControl(ATTRLST2PANEL, Panel.class);
attrlst1.setVisible(false);
Docbaseattributelist controls are configured in a configuration file. For more information on

configuring attributelist controls, see "docbaseattributelist in Web Development Kit Development Guide.
docbaseattributeproxy
Purpose
Used to represent any control that is associated with a docbaseobject.
Attributes
attribute (Required) Attribute to represent.

controltorepresent (Required) Name of the input control to
represent.
the JSP page.
object (Required) Name of the docbaseobject tag on
the JSP page. In the following example, the
object being validated is named "obj, so the
value of the object parameter for this validator
would be "obj:<dmfx:docbaseobject name="obj"
configid="attributes"/>
Description
Since
6.0
docbaseattributeseparator

Usage
This control is used only to validate attributes that are listed as ignored attributes in a
docbaseattributelist configuration. For example, the list of available formats is displayed by the
datadropdownlist control named "formatList" in the Webtop import JSP page, and the user’s selection
should be validated against object constraints for the selected object type. The format attribute is
listed in the <ignore_attributes> element of import_docbaseattributelist.xml. In order for the selection
to be validated, use the validator to validate the control on the JSP page, similar to the following:
<dmf:docbaseattributeproxy
name="docbaseattributeproxy_attr1"
object="docbaseObj" controltovalidate="
formatlist" attribute="a_content_type"/>
docbaseattributeseparator
Purpose
Generates a separator. This control is rendered by the docbaseattributelist control.
Attributes

the JSP page.
= \3\><hr></td></tr>.
visible (Optional) (Boolean) Whether this control is
displayed (True) or hidden (False).
Description
Since
5.x
docbaseattributevalue

Purpose
Displays the value of an object that is specified in the associated <docbaseobject> tag.
Attributes
attribute (Optional) Name of the object attribute for

which to display its value.
datafield (Optional) Overrides attribute value.
specified.
the JSP page.
attribute value. Use the lines and the size
attributes to display the value returned for an
attribute.
object (Required) Name of the associated docbaseobject
control.
value of false.
required (Optional) Whether a value is required in the

user interface (True) or not (False). Does not
override data dictionary enforcement.
this value.
validate (Optional) Whether to enable data dictionary
validation (True) or disable it (False). Default is
true.
Description
Since
5.x

Usage
Use this tag and a docbaseattributelabel tag, if you need to use a custom validator for your attribute
value. This tag generates a docbaseattributevalidator control, so it will be automatically validated
against data dictionary constraints that have been set up for the attribute.
docbaseattributevalueassistance
For information on using the docbaseattributevalueassistance attribute to set up non-data dictionary

value assistance, see docbaseattribute, page 33.
docbaseattributevalueassistance
Purpose
Displays an open-ended or closed set of values for value assistance. The attribute must not have
value assistance set up in the DocApp.
Attributes

the JSP page.
islistcomplete (Optional) Whether the user can add values to
the set of values (False) or not (True).
Description
Since
5.x

Usage
Specify the name of your list as the value of the docbaseattributevalueassistance attribute on the
docbaseattribute control. In the following example, the value assistance list is named my_resultset:
Add the docbaseattributevalueassistance control. The values are specified

by docbaseattributevalueassistancevalue tags or by the component class. See
docbaseattributevalueassistancevalue, page 47for an example of providing values in the component
class. Values in the JSP page are shown in the following example. If the values are to be provided by
the component class, the docbaseattributevalueassistance control must be empty.
docbaseattributevalueassistancevalue
<dmfx:docbaseattributevalueassistance name="my_resultset"
islistcomplete="false">
<dmfx:docbaseattributevalueassistancevalue
label="Value A" value="valA"/>
label="Value B" value="valB"/>
</dmfx:docbaseattributevalueassistance>
Purpose
Displays a value for a non-data dictionary list of values for an attribute. The attribute must not
have data dictionary value assistance set up.
Attributes
datafield (Optional) Name of the datafield that provides

the value for the attribute.
the JSP page.
label (Optional) Label for the value.
labeldatafield (Optional) Name of the datafield that provides a
label for the value. Overrides the label and nlsid
attributes.
locale (Optional) Locale for which the value is valid.
If no locale attribute is specified, the value is
displayed for all locales.
the label attribute value.
value (Optional) Valid value for the attribute.
Description
Since
5.x

Usage
Specify the name of your value assistance list as the value of the docbaseattributevalueassistance
attribute on the docbaseattribute control. In the following example, the value assistance list is
named my_resultset:
Add the docbaseattributevalueassistance control. The values are specified by

docbaseattributevalueassistancevalue tags or by the component class. Values in the JSP page are
shown in the following example.
label="Value A" value="valA"/>
label="Value B" value="valB"/>
If the values are to be provided by the component class, the docbaseattributevalueassistance control
must be empty, for example:
The values are set in the component class similar to the following example:
DocbaseAttributeValueAssistance attributeVA =
(DocbaseAttributeValueAssistance) getControl(
"my_resultset", DocbaseAttributeValueAssistance.class);
attributeVA.setMutable(true);
DocbaseAttributeValueAssistanceValue attributeVAValue =
new DocbaseAttributeValueAssistanceValue();
attributeVAValue.setLabel("Value A");
attributeVAValue.setValue("valA");
attributeVA.addValue(attributeVAValue);
DocbaseAttributeValueAssistanceValue attributeVAValue2 =
new DocbaseAttributeValueAssistanceValue();
attributeVAValue2.setLabel("Value B");
attributeVAValue2.setValue("valB");
attributeVA.addValue(attributeVAValue2);
docbasemultiobjects
docbasemultiobjects
Purpose
Retrieves information about multiple, selected objects and refreshes the dependent value assistance
cache.
Attributes
configid (Required) ID of a repositoryobject

configuration file whose root element is
<docbaseobjectconfiguration>. Default is
attributes.
the JSP page.
objectids (Optional) IDs of the selected objects.
validate (Optional) (Boolean) Whether to validate the
control (True) or not (False).
Description
Since
5.x

docbaseobject
Purpose
Hidden control that specifies a Documentum object. Reference this control in docbaseattribute,
docbaseattributevalue, and docbaseattributelist controls to display attributes of the object. Validation
and data dictionary values are read for the object type. If you specify the type attribute.
docbaseobject
Attributes
configid (Optional) ID of a repositoryobject

configuration file whose root element is
<docbaseobjectconfiguration>.
datafield (Optional) Overrides the objectid attribute value.
the JSP page.
istype (Optional) Indicates that the object should be
used as a type object, valid only if src or datafield
is specified. If src returns a list of object IDs, you
must set istype to false.
lifecycleid (Optional) ID of a lifecycle, if a lifecycle type is
specified or istype equals true.
lifecyclestate (Optional) Name of a lifecycle if a lifecycle type
is specified or istype equals true.
modifyonversion (Optional) True, if the object will be checked
in. This will allow a user to modify attributes
during checkout.
objectid (Optional) Documentum object ID.
src (Optional) DQL query to get the object.
type (Optional) Name of an object type. Specify this
attribute only if the object is used as a type
object.
validate (Optional) (Boolean) Indicates whether to
validate the control (True) or not (False).
Description
Since
5.x

Usage
You can modify how certain attributes or attribute types are displayed by using a formatter class.
You can modify how the attribute is saved by using a value handler class. These classes are used to
display or handle data in a docbaseattribute, docbaseattributevalue, or docbaseattributelist control.
multiobjectsdocbaseattribute
You can modify which control is used to render an attribute by specifying a tag class that extends
DocbaseAttributeValueTag. You can add configuration elements that are used by the formatter,
handler, or tag class.
Note: Docbaseobject configuration files are read only for docbaseobject controls on a JSP page.
Custom rendering is not performed in a listing view such as the doclist component in which multiple
objects are displayed.
Custom formatters, handlers, and custom tag classes for objects must be registered in a docbaseobject
configuration file whose root element is <docbaseobjectconfiguration>. A JSP page references this
configuration by setting the configid attribute of <dmfx:docbaseobject> to the same value as the id of
the <docbaseobjectconfiguration> element. If this attribute is not specified on the docbaseobject tag,
the default configuration is used. This default configuration has an id of "attributes and is found in
/webcomponent/config/library/docbaseobjectconfiguration_dm_sysobject.xml.
The DocbaseObject methods setType() and setObjectId() cannot be used together. An
IllegalArgumentException will be thrown.
To get all of the docbaseattributevalue controls that use a particular docbaseobject in the page, use
code in similar to the following your component class:
DocbaseObject docbaseObj = (DocbaseObject) getControl("obj",
DocbaseObject.class);
FindValidAttributeValue v = new FindValidAttributeValue(
docbaseObj.getName());
this.visitDepthFirst(v);
Iterator it = v.getAttributeValues();
while (it.hasNext() == true)
{
DocbaseAttributeValue value = (DocbaseAttributeValue) it.
next();
System.out.println(value.getAttribute() + ":" + value.
getValue());
}
Purpose
Displays the label and value of an attribute by creating the MultiObjectsDocbaseAttributeLabel and
MultiObjectsDocbaseAttributeValue controls.
Attributes
attribute (Optional) Name of the attribute to display.

Default = </th><td><b>:</b></td><td>

Default = </td><td>
the JSP page.
attribute. Use the lines and the size attributes to
display this attribute.
objects (Required) Name of the DocbaseMultiObjects
control to associate with this control.
supported. Default = </td></tr> (closes the row).
supported. Default = <tr><th align=\right\>.
value of false.
required (Optional) Whether the attribute is required.
style (Optional) CSS rule enclosed in quotation marks;
for example:style="{COLOR: darkmagenta;
Description
Since
5.x
multiobjectsdocbaseattributelabel

multiobjectsdocbaseattributelabel
Purpose
Displays the label of a common attribute for multiple, selected objects.
Attributes
attribute (Optional) Name of the attribute of the label to

display.
the JSP page.
control to associate with this control..
for example: style="{COLOR: darkmagenta;
Description
Since
5.x

multiobjectsdocbaseattributelist
multiobjectsdocbaseattributelist
Purpose
Displays all visible attributes of the selected objects associated with the DocbaseMultiObjects control.
Attributes
attrconfigid (Required) Configuration ID to identify the

control definition file to use. Must correspond to
the value for id in <attributelist id="attributes">
in the corresponding control definition file.
Default = </th><td><b>:</b></td><td>
Default = </td><td>
the JSP page.
supported. Default = </td></tr> (closes the row).
supported. Default = <tr><th align=\right\>.
= \3\><hr></td></tr>. Valid for 5.2 repositories
only.
multiobjectsdocbaseattributevalue
showcategorynames (Optional) Whether to display category names

in the user interface (True) or not (False). If
there is only one category or the component
definition’s <showpagesastabs> element content
is true, the category name is not displayed.
TEXT-DECORATION: underline}"Since 6.0.
Description
Since
5.x

multiobjectsdocbaseattributevalue
Purpose
Displays the value of a common attribute for multiple, selected objects.
Attributes
attribute (Optional) Name of the attribute of the value to

display.
hidden (Optional) (Boolean) Whether this control is
hidden (True) or not (False). Default is False.
the JSP page.
attribute. Use the lines and the size attributes to
display this attribute.
browserrequirements

value of false.
(True) or optional (False).
Description
Since
5.x

Client browser detection
browserrequirements
Purpose
Looks up the supported IE and Netscape versions as defined in the <browserrequirements> element
of app.xml. If the browser is not supported, is on an unsupported platform, or has no JVM, an
error message is displayed.
checkjvmapplet
Attributes
None.
Description
Since
5.x

dmf (WEB-INF\tlds\dmform_1_0.tld)
checkjvmapplet
Purpose
Generates an applet that checks the client browser JVM and offers the option of installing the Sun VM
if it is not installed. This control is used by applications or components that must use the Sun VM.
The applet is used by the Web Workflow Manager component.
Attributes
align (Optional) Horizontal alignment of applet text.

Possible values are the same as those for the
HTML IMG tag: left, right, top, texttop, middle,
absmiddle, baseline, bottom, absbottom.
alt (Optional) Text to be displayed when the
browser understands the applet tag, but cannot
run Java applets.
height (Required) Applet height in the browser. 0 to
hide the applet.
hspace (Optional) Horizontal space between applet and
surrounding text.
successhandler (Optional) Server-side event handler that
handles the applet return.
macclientdetect
vspace (Optional) Vertical space between applet and

surrounding text.
width (Required) Applet width in the browser.
Description
Since
5.x

macclientdetect
Purpose
Places a Macintosh client detector applet on the page. The applet detects the browser version number
and stores the OS name in the session.
Attributes
None.
Description
Since
5.x

Usage
The tag class has a public static method, MacClientDetector.getMacOsName(), that makes the Mac
OS version available. This method returns one of three values: MacClientDetector.MAC_OSX,
MacClientDetector.MAC_OS9, or null (the client is not Mac).
attachmenticon
Collaboration
attachmenticon
Purpose
Displays an icon that indicates whether an attachment exists for this event or not.
Attributes
alttext (Optional) Alternate text to be displayed as a

tooltip and when the icon image fails to load.
datafield (Optional) Overrides the value of src attribute
with a URL from a data source.
height (Optional) Height of this control.
the JSP page.
label (Optional) Overrides the alttext and nlsid
attribute values.
the alttext attribute value.
onclick (Optional) Event fired when the user clicks this
control. This event is handled immediately
on the server (when the runatclient attribute
is false) or on the client (when the runatclient
attribute is true). When onclick is used, the
image is turned into a link.
runatclient (Optional) Specifies that the onclick event is to
run on the client (True) or the server (False).
src (Optional) URL to the icon image on
the server. Can be a path on the
server or in the repository, for example:
src="/webtop/component/getcontent?
objectId=0900303980005172" The repository icon
may affect performance.
actionattachmenticon

width (Optional) Width of this control.
Description
Since
6.0

Usage
This control is used within the datagrid control and is displayed as a preference column that can be
turned on or off.
actionattachmenticon
Purpose
Displays the attachment icon. The datatable summary view component use this control to display the
attachment icon if the row has an attachment associated with it.
Since
6.5
bannerbox
Purpose
Generates a box containing the Documentum Collaborative Services room banner. (Contains a
roombanner tag on the JSP page.)
commentimage
Attributes

Description
Since
5.x

commentimage
Purpose
Render a comment Edit, Replyor Delete button.
Attributes

border (Optional) Border (in pixels) around the image.
datafield (Optional) Overrides label or nlsid with data
from a data source.
height (Optional) (Image buttons only) Height of the
button.
the JSP page.
label (Optional) Value stored in the control and
displayed as text on the button.
commentimage

the label value.
attribute is true).
runatclient (Optional) Specifies that the event is to run on
the client (True) or the server (False).
src (Optional) Image to be used for the button.
type (Required) Edit mode: edit, reply, or delete.
width (Optional) (Image buttons only) Specifies the
width of the button.
Description
Since
5.x

commentrow
Usage
The control takes two arguments that are passed in using argument controls. The control must be
contained within the commentrow control. Use the argument list to pass values to the onclick event.
<dmfx:topic name="<%=TopicPageView.CONTROL_TOPIC%>">
<dmfx:comment name="comment_row" cssclass="defaultCommentStyle"
indentamount="32"> . . .
...
</dmfx:comment>
</dmfx:topic>
commentrow
Purpose
Renders the individual comments for a topic. Must be contained within a topic control.
Attributes
cssclass (Optional) CSS class to be used for previously

read comments.
indentamount (Optional) Indent amount (in pixels) for child
comments. Default is 32.
unreadstyle (Optional) CSS style to be used for unread com-
ments. Default is defaultUnreadCommentStyle.
Description
Since
5.x
datatablefield

datatablefield
Purpose
Renders fields in a data table.
Attributes
datafield (Optional) Overrides the visible attribute value.

the JSP page.
mode (Optional) Whether the datafield attribute value
is a string or boolean. Default is string. If this
attribute value is string and the datafield value’s
string length is greater than 0, then the datafield
attribute value is true. If this attribute value is
boolean and the datafield attribute value is 1, T,
or true, then the datafield attribute value is true.
reversevisible (Optional) Whether the visible attribute is the
boolean complement of the datafield attribute
value (True) or not (False). Default is false. For
example, when this attribute is set to true and
the datafield value (in boolean mode) is true,
then the visible attribute value is false.
Description
Since
6.0
datatablefieldPanel

datatablefieldPanel
Purpose
Determines the set of controls to be rendered for each datatablefield, page 64 control.
Attributes
fields (Optional) List of fields that correspond to object

attribute names. This list is overridden by a list
of columns in the component definition.
hascustomattr (Optional) Whether the fields contain custom
attributes and the fields are used within a
datasortlink tag (True) or not (False). Setting
this attribute to true ensures that the link is
displayed correctly for sorting.
the JSP page.
labels (Optional) Comma-separated string of fields
to be displayed as labels. The values are
overridden by labels set on columns in the
component definition.
nlsids (Optional) Comma-separated string of NLS IDs
to display. The values are overridden by labels
set on columns in the component definition.
Description
Since
6.0

governedicon
governedicon
Purpose
Generates an icon indicating governance. Requires Documentum Collaborative Services enabled for
the repository.
Attributes

this control.
height (Optional) Height of the button.
id (Optional) ID of this control.
label (Optional) Link text.
the label value.
governedicon

showimage (Optional) Whether to display the icon (True)
or not (False).
not (False).
srcdisabled (Optional) Image to display when the action is
disabled
width (Optional) (Image action buttons only) Width
of the button.
Description
Since
5.x
messageimportanceformatter

messageimportanceformatter
Purpose
Displays a string or icon for the message_importance attribute value of a dm_message_archive object.
Attributes
hinlsid (Optional) NLS lookup key. The string (or icon)

corresponding to the NLS ID is substituted for a
high importance value.
lownlsid (Optional) NLS lookup key. The string (or icon)
low importance value.
normalnlsid (Optional) NLS lookup key. The string (or icon)
normal importance value.
Description
Since
6.0

msgattachmenticon
Purpose
Icon that indicates whether a dm_message_archive object has attachments or not.
recurrexceptionicon
Attributes
None.
Description
Since
6.0

recurrexceptionicon
Purpose
Displays an icon that indicates the kind of event (standalone exceptions or recurring events with
exceptions).
Attributes

tooltip and when the icon image fails to load.
the JSP page.
attribute values.
richtextdisplay

src (Optional) URL to the icon image on
the server. Can be a path on the
server or in the repository, for example:
src="/webtop/component/getcontent?
objectId=0900303980005172" The repository icon
Description
Since
6.0

Usage
This control is used within the datagrid control and is displayed as a preference column that can be
turned on or off.
richtextdisplay
Purpose
Displays rich text attributes as read-only. Requires Documentum Collaborative Services on the
Content Server.
richtextdisplay
Attributes
datafield (Optional) Name of pseudo-attribute to be

displayed; for example, content_value.
the JSP page.
Description
Since
5.x

Usage
You can configure the behavior of the rich text display control by extending the control configuration
file /wdk/config/richtext.xml, which defines the following elements:
Table 4. Rich text configuration elements
<inputfilter> Remove the comments from this element to use

the RichTextInputFilter class, which processes
images and links that are entered by the user.
<outputfilter> Remove the comments from this element to use
the RichTextOutputFilter class, which processes
image URLs for display in IE and Mozilla.
<html_input> Contains elements that govern HTML input.
<allowed_tags> Contains all HTML tags that are allowed within
rich text input. Must include start and closing
tag, for example, <td></td>.
<allowed_attributes> Contains all attributes that are allowed within
HTML tags. Attributes are represented as
though they were HTML tags, for example,
<href></href>.
richtextdocbaseattribute
<allowed_protocols> Contains protocols that are permitted in links

within rich text. For example, to prevent ftp
URLs, remove <ftp></ftp> from the list.
<invalid_stylesheet_constructs> Contains stylesheet constructs that are not
permitted, such as those that contain external
links. For example:
<div style="background: url(
http://www.somewebsite.com/image/
someimage.jpg);>
</div>
richtextdocbaseattribute
Purpose
Displays the label and value of a rich text pseudoattribute of an object specified in the associated
docbaseobject control. tag. Pseudo attributes are described in the object type’s docbaseattributelist
xml file. The richtextdocbaseattribute control is only valid in the property sheet context. This control
generates the following controls: richtextdocbaseattributevalue, richtextdocbaseattributelabel, and
some HTML table tags. Requires Documentum Collaborative Services on the Content Server.
Attributes
attribute (Optional) Pseudo-attribute name.

the JSP page.
richtextdocbaseattributelabel
Description
Since
5.x

richtextdocbaseattributelabel
Purpose
Displays the label of a rich text pseudoattribute of an object specified in the associated docbaseobject
tag. Pseudo attributes are described in type’s docbaseattributelist xml file, so this tag is only valid in
the property sheet context. Requires Documentum Collaborative Services on the Content Server.
Attributes

datafield (Optional) Name of the datafield that provides
the label for the attribute.
the JSP page.
control.
control.
Description
Since
5.x

richtextdocbaseattributevalue
richtextdocbaseattributevalue
Purpose
Displays the value of a rich text pseudoattribute of an object specified in the associated docbaseobject
the property sheet context. Requires Documentum Collaborative Services on the Content Server.
Attributes

the JSP page.
control.
Description
Since
5.x

richtexteditor
richtexteditor
Purpose
Generates a rich text editing add-in. Requires Documentum Collaborative Services on the Content
Server.
Attributes
hasCharFormatting (Optional) (Boolean) Whether the character

formatting buttons are included in the toolbar
(bold, italic, underline, text color, highlight
color) (True) or not (False). Default is true.
hasClipboard (Optional) (Boolean) Whether the clipboard
button is included in the toolbar (True) or not
(False). Default is true.
hasFonts (Optional) (Boolean) Whether the font and
font-size menus are included in the RTE toolbar
hasImages (Optional) (Boolean) Whether the image button
is included in the toolbar (True) or not (False).
Default is true.
hasLinks (Optional) (Boolean) Whether the link button
is included in the toolbar (True) or not (False).
Default is true.
hasParaFormatting (Optional) (Boolean) Whether the paragraph
formatting buttons are included in the toolbar
(alignment, bullet list, numbered list, indent,
outdent) (True) or not (False). Default is true.
hasSpellcheck (Optional) (Boolean) Whether the spell check
button is included in the toolbar (True) or not
(False). (Windows only) Default is true.
the JSP page.
tooltipnlsid (Optional)
value (Optional) Text (in HTML format) that is being
edited. Can be inherited from StringInputContol
or re-implemented in the RTE control class if it
does not extend StringInputControl.
richtexteditor
Description
Since
5.x

Usage
You can configure the behavior of the rich text editor by extending the control configuration file
/wdk/config/richtext.xml, which defines the following elements:
Table 5. Rich text configuration elements
<inputfilter> Remove the comments from this element to use

the RichTextInputFilter class, which processes
images and links that are entered by the user
<outputfilter> Remove the comments from this element to use
the RichTextOutputFilter class, which processes
image URLs for display in IE and Mozilla
<html_input> Contains elements that govern HTML input
<allowed_tags> Contains all HTML tags that are allowed within
rich text input. Must include start and closing
tag, for example, <td></td>.
<allowed_attributes> Contains all attributes that are allowed within
HTML tags. Attributes are represented as
though they were HTML tags, for example,
<href></href>.
<allowed_protocols> Contains protocols that are permitted in links
within rich text. For example, to prevent ftp
URLs, remove <ftp></ftp> from the list.
<invalid_stylesheet_constructs> Contains stylesheet constructs that are not
permitted, such as those that contain external
links. For example:
<div style="background: url(
http://www.somewebsite.com/image/
someimage.jpg);>
</div>
Elements that configure the rich text editor are described in the table below. If no minimum version is
provided, the browser will not be allowed to use the rich text editor.
richtextpanel
Table 6. Rich text editor configuration elements (<editor>)
<ieminversion> Minimum version of IE supported by editor

<mozillaminversion> Minimum version of Mozilla supported by
editor
<netscapeminversion> Minimum version of Netscape supported by
editor
<safariminversion> Minimum version of Safari supported by editor
<iemaxversion> Maximum version of IE supported by editor
<mozillamaxversion> Maximum version of Mozilla supported by
editor
<netscapemaxversion> Maximum version of Netscape supported by
editor
<safarimaxversion> Maximum version of Safari supported by editor
richtextpanel
Purpose
Surrounds the rich text editor and the rest of the HTML, such as the field name, so it will not be
generated if rich text is not enabled. Rich text editing or display requires Documentum Collaborative
Services on the Content Server.
Attributes

the JSP page.
Description
Since
5.x

roombanner
Usage
To display an editable rich text attribute, add a richtextpanel similar to the following example (table
tags place this panel within a larger table in the component):
<dmfx:richtextpanel>
<tr>
<td scope="row" width="10%" align="right">
<b><dmf:label nlsid="MSG_DESCRIPTION_COLON"/><b></b>
</td>
<td width="90%" align="left">
<dmfx:richtexteditor name='<%=DocList.
FOLDER_DESCRIPTION%>' hasImages='true'/>
</td>
</tr>
</dmfx:richtextpanel>
roombanner
Purpose
Generates a room banner. Requires Documentum Collaborative Services to be enabled for the
repository.
Attributes
height (Optional) Height (in pixels) of the banner.

objectid (Optional) ID of a governed folder containing
the room banner.
Description
Since
5.x

showtopicdocbaseattribute
showtopicdocbaseattribute
Purpose
Displays the label and value of a rich text pseudoattribute of an object specified in the associated
docbaseobject control. tag. Pseudo attributes are described in the object type’s docbaseattributelist
xml file. The richtextdocbaseattribute control is only valid in the property sheet context. This control
generates the following controls: richtextdocbaseattributevalue, richtextdocbaseattributelabel, and
some HTML table tags. Requires Documentum Collaborative Services on the Content Server.
Attributes

the JSP page.
Description
Since
5.x

showtopicdocbaseattributelabel
showtopicdocbaseattributelabel
Purpose
Displays the label of show topic pseudoattribute of an object specified in the associated docbaseobject
the property sheet context.
Attributes

datafield (Optional) Datafield that provides the label for
the attribute.
the JSP page.
control.
Description
Since
5.x

showtopicdocbaseattributevalue
Purpose
Displays the value of a show topic pseudoattribute of an object specified in the associated
docbaseobject tag. Pseudo attributes are described in type’s docbaseattributelist xml file, so this
tag is only valid in the property sheet context.
topic
Attributes

the JSP page.
control.
Description
Since
5.x

topic
Purpose
Displays the threaded list of comments found for an object’s topic. The control should contain the
comment control.
topicpanel
Attributes

Description
Since
5.x

Usage
The control data is set at runtime from a component by setting its dataprovider with a TopicResultSet
of data that makes up the topic. For example:
public void setTopicControl(
ITopic topic, String[] attributes)
{
topicData = new TopicResultSet(attributes, topic);
Topic topicControl = (Topic)getControl(
CONTROL_TOPIC, Topic.class);
DataProvider dataProvider = topicControl.getDataProvider(
);
dataProvider.setScrollableResultSet(topicData);
}
topicpanel
Purpose
Hides a topic for repositories that do not have Documentum Collaborative Services enabled
Attributes

the JSP page.
topicstatus
Description
Since
5.x

Usage
To display a panel of topics, add the topicpanel and collaboration component similar to the following
example:
<dmfx:topicpanel>
<dmfx:componentinclude name='showtopic' component='
embeddedtopic'>
<dmfx:argument name="objectId" contextvalue='objectId'/>
</dmfx:componentinclude>
</dmfx:topicpanel>
topicstatus
Purpose
Generates an action icon that indicates the status of a discussion topic. A topic may be read, unread,
or nonexistent. If an indicator icon is present, then clicking it will bring user to the page containing
the topic. The control is used within the datagrid control and appears as a preference column that
can be turned on or off.
Attributes

this control.
from a data source. Overrides the URL defined
in src attribute
topicstatus

the JSP page.
label (Optional) String value or <nlsid> element
(which maps to a string label) to be rendered in
addition to the image.
the datafield and label values.
showimage (Optional) Whether to display the icon (True)
or not (False).
not (False).
srcdisabled (Optional) Image to be displayed when the
action is disabled.
topicstatus

width (Optional) Width of the image .
Description
Since
5.x

hidden
Context
hidden
Purpose
Generates a hidden control at the bottom of the page that stores serialized context information.
Attributes
datafield (Optional) Overrides value with data from a

data source.
encrypt (Optional) Whether data that is passed in the
hidden control cannot (True) or can (False) be
viewed by the browser "View Source" option.
This property can be used on named controls
only. Default is true.
the JSP page.
onchange (Optional) Event that is fired when this control
is changed by the user. This event is not handled
when the form is submitted (for example, by
an onclick event). The onchange event handler
cannot run on the client (that is, the runatclient
attribute cannot be true).
value (Optional) Value stored in the control.
Description
Since
5.x

celllist
Data display
celllist
Purpose
Used within a table row (<tr>) or <dmf:datagridrow> tag to wrap a list of celltemplate tags. The cell
templates will output columns of data dynamically.
Attributes

hascustomattr (Optional) Whether the celllist fields contain
custom attributes and the celllist tag is used
within a datasortlink tag (True) or not (False).
Setting this attribute to true ensures that the link
is displayed correctly for sorting.
the JSP page.
Description
Since
5.x

celltemplate
Usage
If you specify columns in the component definition, they will override the fields that are specified
To set the celllist fields programmatically, call the CellList method setFields() during
onControlInitialized.
celltemplate
Purpose
Within a cell list tag, specifies a template output for a single column of data. The data that is rendered
is supplied by the fields attribute. Template values are supplied by a field name, such as object_name,
object type, such as double, or generic (matches everything).
Attributes
field (Optional) Name of a field corresponding to

an object attribute name. If this attribute is
specified, the type attribute cannot be used.
the JSP page.
type (Optional) Object type. If this attribute is
specified, the field attribute cannot be used. If
neither field nor type attributes are set, then the
cell is generic. The number type matches either
an int or double datatype returned from DFC.
Description
Since
5.x

columnpanel
Usage
Use within a <dmf:celllist> tag. The fields for the template can be supplied as the value of the
fields attribute on the JSP page or programmatically from the component configuration using the
ComponentColumnDescriptorList object. WDK components that have a <columns> element in
the component XML definition get the list of fields from the configuration. (They get the columns
from ComponentColumnDescriptor.)
Fields, labels, and nlsids that are configured in the component definition file override tag attributes
in the JSP page.
You can configure dynamic sets of data for display using <dmf:celllist:> and <dmf:celltemplate>. If
you are displaying the data in columns, you can use a combination of celllist and celltemplate controls
within a table header row or within <dmf:datagridrow> to provide column headers, sorting, and
columns of data. See Web Development Kit Development Guidefor details.
columnpanel
Purpose
Wraps a set of column controls in a table row to allow display or hiding of column data.
Attributes
columnname (Required) Name of this column. All column

panels in a single row should use unique names.
the JSP page.
Description
Since
5.x

datacolumnbeginswith
Purpose
Enables displaying all column values that start with a user-entered string.
Attributes
autocompleteenabled (Optional) (Boolean) Enables (True) or disables

(False) autocompletion on the control. Default
is True.
autocompleteid (Optional) Key used to store the autocomplete
list in the user preferences. You can set the
same ID on two text controls, for example, if
they share the same set of suggestions. If the
control does not have an ID specified, the ID is
generated using this syntax: formid_controlid.
formid is the form id attribute and controlid
is the text control name. For docbaseattribute
controls that render a text control, an ID is
generated using the attribute name; for example,
"keyword or "title.
casesensitive (Optional)
column (Optional) Column name to which to bind. If
this control is within a celltemplate tag, you can
use the datafield attribute instead.
datafield (Optional) A value of CURRENT retrieves the
value from the data source.
defaultonenter (Optional) Whether pressing the Enter key calls
the JavaScript handleKeyPress() function (True)
or not (False). Must be used with a button (on
the same page) that has its default attribute
set to true. The button event is fired when the
user presses the Enter key in the defaultonenter
control.
focus (Optional) When this attribute is set to true, the
control gets the focus.
the JSP page.
maxautocompletesuggestionsize (Optional) Number of matching suggestions to

display to the user. Default is 10.
controls are cached on the server. Controls
with the same name are automatically indexed.
Required to bind to a filter item.
corresponding to the NLS ID is substituted
for the initial search value (for example, Starts
With).
onchange (Optional) Event fired when this control’s value
when the form is submitted.
onclick (Optional)
prompt (Optional)
runatclient (Optional) Whether the onchange event is to run
on the client (True) or the server (False).
tabindex (Optional)
width (Optional)
Description
Since
6.0

Usage
To format the value in this control, enclose it in a formatter control.
datagrid
datagrid
Purpose
Displays results of a query or recordset as a table, generating opening and closing <table> tags.
Attributes
bordersize (Optional) Size of the datagrid border.

cellpadding (Optional) Space between cell contents and cell
border.
cellspacing (Optional) Spacing between the cells in the grid.
fixedheaders (Optional) Boolean: Whether the datagrid
header rows are to scroll with the body
rows (False) or not (True). Default is
false. To set this attribute value for all
datagrid controls in your application, set the
following element value in the app.xml file:
<desktopui<.<datagrid>.<fixedheaders>. This
element’s default value is true.Since 6.0.
height (Optional) Height of the datagrid.Since 6.0:
When you specify a value for this attribute,
scroll bars are generated for the contents of
the datagrid that extend beyond the specified
value. If you do not specify a value for this
attribute on a datagrid control, the grid takes up
the remaining height in the frame. Remaining
elements on the page should be placed within
the footer (anywhere between the end of
datagridRow tag and the end of datagrid tag).
id (Optional) ID if this control. The ID is generated
the JSP page.
paged (Optional) Whether paging is turned on (True)
or off (False). All data is returned when paging
is turned off. Default is false.
datagrid
pagesize (Optional) Number of result items on a page

when paging is turned on.
preservesort (Optional) Whether the datagrid preserves
(True) the current sort settings between data
refresh events or not (False). Default is false.
query (Optional) DQL query passed to the data
provider; for example:select group_name,
r_modify_date from dm_group where
group_name like ’a%’
recordcachecount (Optional) Overrides the default number of
records retrieved by the query and sets the
number of records to be fetched.
rendertable (Optional) Whether to suppress (False) or render
(True) <table> tags by the datagrid control.
When the data rows are rendered within
separate panes within a paneset control, set this
value to false and insert <table> tags manually
within the pane control. Default is true.
rowselection (Optional) Boolean: Enables (True) or disables
(False) mouse or keyboard row selection
(selecting one or more objects) and right-click
context menus. Default is True. The app.xml
file’s desktopui/datagrid/rowselection element
must be set to true to enable this attribute.
sortcolumn (Optional) Name of column on which to sort.
sortdir (Optional) Sort direction: ascending (0) or
descending (1). Default is 0.
sortmode (Optional) Initial sort mode: text (0),
case-insensitive text (1), or numeric (2). Default
is 1.
width (Optional) Width of the datagrid.
Description
Since
5.x

datagrid
Usage
This control can contain datagridrow, nodatarow, row, or HTML table row (<tr>) tags. The data can
be paged by adding a datapaging control and sorted by adding a datasortimage or datasortlink
control into the grid control. To support row selection this control must be placed outside any HTML
table tags.
To generate scroll bars when the contents of the datagrid extend beyond datagrid’s height, specify a
value in the height attribute.
Examples
Row selection
Since 6.0.
To disable row selection for an individual datagrid row, set the rowselection attribute to false in
the datagrid tag on the JSP page, for example:
<dmf:datagrid ..rowselection="false">
Table 7, page 94 describes the interaction between the global row selection flag in app.xml and
the datagrid attribute.
Table 7. Row selection settings
app.xml dmf:datagrid Result

<rowselection> rowselection
false true or false Checkboxes rendered, no
mouse/keyboard row selection
or context menus on any
datagrid
true true No checkboxes rendered, row
selection and context menus
enabled for the datagrid
true attribute not specified No checkboxes rendered, row
(for example, migrated selection and context menus
customizations) enabled for the datagrid
true false Checkboxes rendered, no
mouse/keyboard row selection
or context menus on current
datagrid
With row selection enabled in app.xml, contained checkboxes within a datagrid on the JSP page are
rendered with a CSS rule of display:none. Rows can then be selected by mouse events or keyboard
combinations. Link and action controls inside selectable rows are disabled. To migrate links and
action controls within a datagrid row, move them to a context menu or a datagridrowevent tag.
datagridRow
datagridRow
Purpose
Generates rows of data inside a datagrid. Generates <tr> opening and closing tags within the <table>
tags generated by datagrid. Can contain <td>, <columnpanel>. Displays the contents of its databound
controls for all rows of data that are available or that are shown per page.
Attributes
align (Optional) Horizontal alignment of the cell.

altclass (Optional) Class for alternating lines
(if required); for example: altclass=
’databoundExampleDatagridRowAlt’
altstyle (Optional) CSS rule for alternating lines (if
required); for example: <dmf:datagridRow
style=’{BACKGROUND-COLOR: white}’
altstyle=’{BACKGROUND-COLOR: red}’>
columns (Optional) Number of columns in which to
display the data. If this value is greater than
zero, then the datagrid formats the data in the
specified number of columns.
columnsforaccessibility (Optional) This attribute is to provide datagrid
row-related information in the ’Actions’ link
itself so that the user does not have to read every
column in the row to understand the context
of the row. Now ‘Actions’ link will have object
name which describes the row and docbase icon.
height (Optional) Height of the datagrid.
the JSP page.
example: style="{COLOR: darkmagenta;
tooltip (Optional) String that displays as a title for each
row.
datagridRowBreak
tooltipdatafield (Optional) NLSID element that displays as a title

for each row.
tooltipnlsid (Optional) Datafield that displays as a title for
each row.
valign (Optional) Vertical alignment of the cell.
width (Optional) Width of the datagrid.
Description
Since
5.x

Usage
The number of rows displayed depends on data set size and paging options set on the parent
datagrid tag.
When the accessibility option is turned on in the user preferences, the datagridrow tag generates a title
for the row based on the tooltip. This allows reader programs to navigate the generated rows of data.
Use only one datagridRow tag within a datagrid.
datagridRowBreak
Purpose
Specifies a break in a DatagridRow control.
Attributes
align (Optional) Alignment of cells in the row (left,

right, center, justify, or char)
altclass (Optional) Sets the class for alternating
lines if required; for example: altclass=
’databoundExampleDatagridRowAlt’
altstyle (Optional) CSS rule for alternating lines,if
required; for example: <dmf:datagridRow
style=’{BACKGROUND-COLOR: white}’
altstyle=’{BACKGROUND-COLOR: red}’>
datagridRowBreak
bgcolor (Optional) Background color for the cells in the

row.
char (Optional) Specifies a single character within a
text fragment to act as an axis for alignment.
The default value for this attribute is the decimal
point character in HTML documents for the
current language as set by the lang attribute
(for example, the period (.) in English and the
comma (,) in French).
charoff (Optional) Specifies the offset to the first
occurrence of the alignment character on each
line. If a line does not include the alignment
character, it will be horizontally shifted to end at
the alignment position.
cssclass (Optional) Sets the cascading style sheet class
that is used to format the control.
dir (Optional) Specifies the direction for the text as
left-to-right (LTR) or right-to-left (RTL).
height (Optional) Not used.
the JSP.
lang (Optional) Language code, used to assist
third-party software (such as, spelling and
grammar checkers).
style (Optional) A cascading style sheet
rule enclosed in quotation marks; for
title (Optional) Title attribute for the row.
valign (Optional) Vertical alignment setting for cells in
the row.
Description
Since
6.0

datagridRowEvent
datagridRowEvent
Purpose
Specifies the event for which to register and the event handler in a DatagridRow control.
Attributes
action (Optional) ID of the action to be launched by

this control.
eventhandler (Optional) Name of the handler for the event.
eventname (Required) Name of the event for which to
register.
runatclient (Optional) Specifies for the event to run on the
client (True) or the server (False).
Description
Since
6.0

Usage
This control is disabled when its parent datagrid control’s rowselection attribute is true.
datagridRowModifier
Purpose
Hides or disables contained controls when its parent datagrid’s rowselection attribute is true.
Attributes
skipbody (Optional)
datagridRowTd
Description
Since
6.0

datagridRowTd
Purpose
Data cells in a datagrid control. Outputs <td> HTML tags with a marker class.
Attributes
abbr (Optional) HTML abbr attribute.

align (Optional) HTML align attribute.
axis (Optional) HTML axis attribute.
bgcolor (Optional) HTML bgcolor attribute.
char (Optional) HTML char attribute.
charoff (Optional) HTML charoff attribute.
colspan (Optional) HTML colspan attribute.
dir (Optional) HTML dir attribute.
headers (Optional) HTML headers attribute.
height (Optional) HTML height attribute.
the JSP page.
lang (Optional) HTML lang attribute.
nowrap (Optional) HTML nowrap attribute.
rowspan (Optional) HTML rowspan attribute.
scope (Optional) HTML scope attribute.
datagridTh
title (Optional) HTML title attribute.

valign (Optional) HTML valign attribute.
width (Optional) HTML width attribute.
Description
Since
6.0

Usage
Place inside of a datagridRow control in a datagrid control. At runtime, if the number of data
columns does not match the number of column head cells, an error is generated.
datagridTh
Purpose
Column heads in a datagrid control. Outputs <th> HTML tags with a marker class and <div> HTML
tags that constrain each cell’s content.
Attributes

dataoptionlist

the JSP page.
resizable (Optional) Boolean: Whether to enable the
ability to resize the column head (True) or not
(False). Default is false. Since 6.0.
Description
Since
6.0

Usage
Place this control inside of a datagrid control in the first <tr> element.
dataoptionlist
Purpose
Iterator that renders options as a HTML form option elements. Renders all of the data from the
enclosing datadropdownlist or datalistbox.
datapagesize
Attributes

the JSP page.
Description
Since
5.x

datapagesize
Purpose
Generates a page size control that allows the user to select the number of items in a page.
Attributes

the JSP page.
onselect (Optional) Event fired when the user selects
a page size value. This event is handled
runatclient attribute is true).
datapagesize
pagesizevalues (Optional) Comma-separated list of integer

page-size values for the user to select.
preference (Optional) Default value for the preferred
data page size (which the user can
override). The value can be read from a
configuration file, such as /custom/app.xml,
as the content of a dot-separated path
of elements in the file. For example,
preference=’application.display.streamline’
would be read from the following app.xml
element path:<application>... <display>
<streamline>10</streamline> </display>
</application>
runatclient (Optional) Specifies that the onselect event is to
showdisplayinginfo (Optional) Whether to show the total item count
(True) or not (False)
marks) to apply to this control. For
datapaging
Description
Since
5.x

Usage
Cache size for the number of objects returned by a query is configurable in Databound.properties,
in /WEB-INF/classes/com/documentum/web/form/control. Paging is configured on a JSP page that
contains a datagrid. You can limit the choices for page sizes by setting the pagesizevalues of the
datapagesize JSP tag. You can set a default value for page size as the value of the preference attribute
on the datapagesize tag.
datapaging
Purpose
Generates navigation links for a paged datagrid. Must be used within the datagrid control. Links will
be rendered only when multiple pages of data are returned from the query.
Attributes

gotopageclass (Optional) CSS class to apply to the optional
gotopage text box.
the JSP page.
showdisplayinginfo (Optional) Whether to show the displaying X of
Y items text (True) or not (False).
showfirstandlast (Optional) Whether to show the first and last
page links (True) or not (False).
datapaging
showgotopage (Optional) Whether to show the optional

go-to-page text box (True) or not (False). Setting
this attribute to true, enables the user to jump to
any page in the dataset by entering a page value
in the text box.
showimages (Optional) Whether images (True) instead of text
links (False) are displayed. The images must be
placed in: /wdk/ theme_folder /images/paging.
If the images are not found, text links are
displayed. Default is true.
Description
Since
5.x

datasortimage
datasortimage
Purpose
Generates a datasortimage control within the datagrid control. Provides an image that launches
a sort of the dataset.
Attributes

this control is within a celltemplate tag., you can
datafield (Optional) Overrides the label and nlsid with
data from the current celltemplate match. A
value of CURRENT retrieves the value from the
data source.
forwardicon (Optional) URL to the forward sort icon.
the JSP page.
image (Required) Image file name. The path to the
image is resolved by the branding service.
mode (Optional) Sort mode: text (0), case-insensitive
text (1), or numeric (2).
attribute is true).
reverseicon (Optional) URL to the reverse sort icon.
reversesort (Optional) Initial sort order of the displayed
column: reverse (True), normal (False). Default
is false.
datasortlink

Description
Since
5.x

datasortlink
Purpose
Generates a datasortlink control within the datagrid control. Provides a column header sort link that
allows the user to sort the results by column name.
datasortlink
Attributes

this control is within a celltemplate tag, you can
datafield (Optional) Overrides the label and nlsid with
data from the current template match. A value
of CURRENT retrieves the value from the data
source.
forwardicon (Optional) URL to the forward sort icon.
the JSP page.
label (Optional) Label for the data sort link.
mode (Optional) Sort mode: text (text), case-insensitive
text (caseinstext), or numeric (numeric).
the label value.
attribute is true).
reverseicon (Optional) URL to the reverse sort icon.
reversesort (Optional) Initial sort order of the displayed
column: reverse (True), normal (False). Default
is false.
datatablecelllist

Description
Since
5.x

Usage
If the datasortlink contains a celllist tag whose contents are resolved at runtime, make sure that the
celllist tag properly reflects the type of datafield providing the link. For example, if the datafield maps
to a custom attribute, set the hascustomattr attribute on the celllist tag to true.
datatablecelllist
Purpose
Used by datatable listing pages. Extends the celllist, page 87 control.
Since
6.5
datatablefieldpanel
datatablefieldpanel
Purpose
Determines the set of controls to be rendered for each datatablefield, page 64 control.
Attributes

hascustomattr (Optional) Whether the fields contain custom
attributes and the field is used within a
datasortlink tag (True) or not (False). Setting
this attribute to true ensures that the link is
displayed correctly for sorting.
the JSP page.

Description
Since
6.0

datatablePagefieldpanel
datatablePagefieldpanel
Purpose
Initializes, shows, or hides the different controls required to configure datatable fields. The values in
this control are based on the dmc_datatable_schema associated with a table.
Since
6.5
datatablerowattributelist
Purpose
Lists attributes in a datatable row.
Attributes
attrconfigid (Required) A configuration ID to identify which

control definition file should be used. Must
correspond to the value for id in <attributelist
id="attributes"> in the corresponding control
definition file.
categorypost (Optional) pecifies an HTML string to render
after each category. Scripts are not supported.
Default = </th></td></tr> (closes the row)
categorypre (Optional) Specifies an HTML string to
render before each category. Scripts
are not supported. Default = <tr><td
colspan=\"3\"><hr></td></tr><tr><th
align=\"left\">;
col1 (Optional) Specifies an HTML string
to render between the label and value.
Scripts are not supported. Default ==
</th><td><b></b> </td><td>
col2 (Optional) Specifies an HTML string to render
between the value and validator. Scripts are not
supported. Default == </td><td>
cssclass (Optional) Sets the cascading style sheet class
that is used to format the control.
datatablerowattributelist

the JSP.
morelinkpost (Optional) Specifies an HTML string to render
after the Show More link. Scripts are not
supported. Default == </td></tr>
morelinkpre (Optional) Specifies an HTML string to render
before the Show More link. Scripts are not
supported. Default == <tr><td colspan=\"4\">
name (Optional) Sets the name for the control. Named
control on the JSP page.
post (Optional) Specifies an HTML string to render
after each docbaseattribute control. Scripts are
not supported. Default == </td></tr> (closes the
row)
pre (Optional) Specifies an HTML string to
render before each docbasattribute control.
Scripts are not supported. Default == <tr><th
align=\"right\">
readonly (Optional) Set to true to display attributes
as read-only. This setting does not override
or change the status of the attributes in the
repository; it only applies to the rendering of
the attribute inthe UI. The value of readonly
== "false" can be overridden by the attributes
component readOnly parameter.
separator (Optional) Specifies HTML to render as a
separator between attributes. Default == <tr><td
colspan = \"3\"><hr></td></tr>. Valid for 5.2
repositories only.
showcategorynames (Optional) Set to true to display category names
in the UI. Category name is not shown if there
is only one category or if <showpagesastabs> in
the component definition equals true.
showobjectidasname (Optional) Set to true to display the object

ID as the name of the object. This value
can be overridden by a formatter in a
docbaseobjectConfiguration file. Default == true.
size (Optional) Sets the size of the control in pixels.
duedate
style (Optional) A cascading style sheet

rule enclosed in quotation marks; for
TEXT-DECORATION: underline}".
visiblecategory (Optional) Comma-separated string that
specifies the categories that are visible. Default
== null (all categories are visible)
Description
Since
6.0

duedate
Purpose
Since
6.5
listbox
listbox
Purpose
Holds option objects or a single dataoptionlist control holding a databound option.
Attributes

height (Optional) Vertical length of the drop down list
control.
the JSP page.
multiselect (Optional) Whether to enable (True) or disable
(False) multiple selection in the listbox.
onchange (Optional) Event that is fired when this control
when the form is submitted. The onchange
event handler cannot run on the client (that is,
the runatclient attribute cannot be true).
onselect (Optional) Event fired when the user clicks this
attribute is true). The form is not submitted until
the onselect event is fired.
size (Optional) Number of rows of selectable data
visible in the listbox (scrollbars are used if more
rows are available).
listbox

value (Optional) The selected value.
width (Optional) Horizontal length of the drop down
list control.
Description
Since
5.x

Usage
The multiselect attribute is only available if you retrieve the value in client-side JavaScript.
Multiple selections are not passed to the component, because no server event is fired. For an
example of a client-side implementation that retrieves multiple selections in the listbox, refer to
searchsources_preferences.jsp and changesearchsources.jsp.
multiselector
multiselector
Purpose
Displays two lists. User can select items from a list and order the selected items. Items are moved
between the unselected and selected list with Add and Remove buttons. Items are ordered on the
selected items list with Up and Down buttons.
Attributes
buttoncssclass (Optional) CSS class to apply to button

appearance.
buttoncssstyle (Optional) CSS rule to apply to button
appearance.
buttonheight (Optional) Height (in pixels) of the button.
buttonimagefolder (Optional) Location of the image folder, if
buttons are used to display items.
buttonwidth (Optional) Width (in pixels) of the button.
disabledclass (Optional) CSS class to apply to the disabled
control.
disabledstyle (Optional) Entire CSS-syntax style sheet rule
(enclosed in quotes) to apply to the disabled
control.
the JSP page.
items (Optional) Serialized list of items to display in
the available items listbox. The list must be a
String array with value and label pairs (value
must occur in the first position).
itemslabel (Optional) Label for the available items list.
itemsnlsid (Optional) NLS string for the available items list
label.
listboxcssclass (Optional) CSS class to apply to listboxes.
listboxcssstyle (Optional) CSS rule to apply to listboxes.
listboxwidth (Optional) Width (in pixels) of listboxes. Default
is 200.
(False) selection of multiple items for Add or
Remove. If a move operation is chosen, only the
first selection is moved. Default is false.
multiselector

orderingenabled (Optional) Whether to enable (True) or disable
(False) Up and Down buttons, which change the
order of the list. Default is true.
selecteditems (Optional) Serialized list of items to appear in
the selected items listbox.
selecteditemslabel (Optional) Label for the selected items list.
selecteditemsnlsid (Optional) NLS string for the selected items list
label.
size (Optional) Size of the listboxes. Default is 10.
Description
Since
5.x

Usage
The component can retrieve a list of selected items from the control by calling getSelectedItems() on
the control. The buttons trigger client side events so that the client doesn’t have to make a round trip
to the server every time a button is selected. When a trip to the server is made the control will update
its data on the server side via a hidden field that keeps an updated item list.
The List object that holds items has the following features:
• Each element in a List represents one item.
• The element can be a String, which is a value with no label.
• The element can be an array of one String
• A serialized list of items can be an array of one string (value) or two strings (value and label).
If you supply the lists of available and selected columns in the JSP page, then the list must be
serialized to a string before passing it in to the control. (You can create the serialized string from an
ArrayList using the MultiSelectorUtil class static method encodeItemList(). If you supply a list in
your component class, pass it in as ArrayList.
In the following example from the VisibleRepositoryPreferences class, the class gets the controls on
the JSP page, calls methods that get the ArrayList for each control, and initializes the items and
selected items lists:
public void onInit(ArgumentList args)
{
super.onInit(args);
...
MultiSelector mltRepositories = (MultiSelector)getControl(
REPOSITORY_SELECTOR, MultiSelector.class);
nodataRow
mltRepositories.setSize("10");
//Get selected connection broker and port

DataDropDownList docbrokerControl = (DataDropDownList) getControl(
CONTROL_DOCBROKER,DataDropDownList.class);
Label docbrokerPortNumberControl = (Label) getControl(
CONTROL_DOCBROKER_PORT,Label.class);
//Get all repositories for this connection broker

ArrayList arrDocbases = getInvisibleRepositories(
docbrokerControl.getValue(), docbrokerPortNumberControl.
getLabel());
//Write the list to the available repositories list
mltRepositories.setItems(arrDocbases);
//Get previously selected repositories, set to selected items list

mltRepositories.setSelectedItems(getVisibleRepositories());
}
nodataRow
Purpose
Supplies a row of static data that will be automatically displayed if the enclosing datagrid returns no
data rows from the query. Must be contained within the datagrid control. You must provide <td>
tags and content within the opening and closing nodatarow tags.
Attributes
align (Optional) Horizontal alignment of the cells.

height (Optional) Height of the row.
valign (Optional) Vertical alignment of the cells.
row
Description
Since
5.x

row
Purpose
Generates a static header or footer HTML table row inside the data grid control. Adds the static data
row above or below the dynamic datagridrows. Can be used in place of <tr>. Use only in pages where
your component needs to access controls in the row.
Attributes
align (Optional) Horizontal alignment of the cells.

height (Optional) Height of the row
the JSP page.

valign (Optional) Vertical alignment of the cells.
Description
Since
5.x
showhide

showhide
Purpose
Enables a user to show and hide object attributes.
Attributes

hidenlsid (Optional) NLS key for the localized Hidden
label string.
hidetooltipnlsid (Optional) NLS key for the localized Hide
tooltip string.
the JSP page.
imagehidecssclass (Optional) Sets the cascading style sheet
class that is used to format the Hide image.
Default is the disclosureTriangleOpen CSS
class, which is defined in the wdk\theme\
documentum\css\webforms.css file.
imageshowcssclass (Optional) Sets the cascading style sheet
class that is used to format the Show image.
Default is the disclosureTriangleClosed CSS
class, which is defined in the wdk\theme\
imagestyle (Optional) CSS rule for the Show/Hide
images. For example: style="(COLOR:
darkmagenta)”. The CSS rule must be
enclosed in quotation marks.
inlinerefresh (Optional) To perform an inline (True) or full

page (False) refresh on this control and on its
associated panel (specified in the panelname
attribute) when the user clicks on it. Default is
true.
trafficlighticon
labelcssclass (Optional) Sets the cascading style sheet

class used to format the Show/Hide label.
Default is showMoreHideMoreLink,
which is defined in the wdk\theme\
labelstyle (Optional) A cascading style sheet rule (enclosed
in quotation marks) for the Show/Hide label; for
panelname (Required) Name of the panel to show or hide as
specified by the show attribute.
show (Optional) To show (True) or hide (False) the
content of its associated panel (specified by the
panelname attribute). Default is false.
shownlsid (Optional) NLS key for the localized Show label
string.
showtooltipnlsid (Optional) NLS key for the localized Show
tooltip string.
tabindex (Optional) Sets the tab index.
Description
Since
6.5

trafficlighticon
Purpose
Represents an icon for a traffic light datatable field.
absolutefilepathvalidator
Since
6.5
Data validation
absolutefilepathvalidator
Purpose
Validates a string file path using DFC utilities.
Attributes
controltovalidate (Required) Name of the control to validate.

errormessage (Optional) Error message displayed when
validation fails.
the JSP page.
the errormessage attribute value.
comparevalidator
Description
Since
5.x

comparevalidator
Purpose
Validates an input control by comparing its value to a specified value or to another input control.
Attributes
comparecontrol (Optional) Name of the input control that

contains the value with which to compare the
current value. Overrides the comparevalue
attribute.
comparevalue (Optional) Value to compare with the current
value.
controltovalidate (Required) The control to validate.
errormessage (Optional) Error message to display when
validation returns false.
the JSP page.
operator (Optional) Comparison operator. Valid
values are: equal, notequal, greaterthan,
greaterthanequal, lessthan, lessthanequal.
datetimevalidator

type (Optional) Datatype of the value. Valid values
are: string, integer.
Description
Since
5.x

datetimevalidator
Purpose
Verifies that the date input for a control matches a valid pattern, such as "mm dd yyyy", or "mm dd
yyyy hh:mi:ss". This validator does not need to be used on datetime controls, because the input
control displays only valid choices for the user.
Attributes

validation fails.
the JSP page.
datevalidator

Description
Since
5.x

datevalidator
Purpose
Verifies that the dateinput control value is a valid date for the user’s locale. This validator does
not need to be used on dateinput controls, because the input control displays only valid choices
for the user. The name and controltovalidate attributes are required. This control cannot be used
to validate any control other than dateinput.
Attributes
controltovalidate (Required) Name of the control to validate

validation fails.
the JSP page.
docbaseattributevalidator

Description
Since
5.x

docbaseattributevalidator
Purpose
Renders several validators for attributes: inputmaskvalidator, multivaluesinputmaskvalidator,
requiredfieldvalidator, and varequiredfieldvalidator. This validator (and its included validators) is
generated by the docbaseattributevalue control, so that validation is performed automatically on
attributes.
Attributes
controltovalidate (Required) Name of the input control to validate.

the JSP page.
docbasemultiobjectsvalidator

Description
Since
5.x

Usage
If you use a docbaseattributevalue control to render an attribute value, you do not need to use this
validator.
docbasemultiobjectsvalidator
Purpose
Validates changes to all attributes that are common between multiple, selected objects.
Attributes

header (Optional) Summary header message.
the JSP page.
the header attribute value.
docbaseobjectattributevalidator
Description
Since
5.x

docbaseobjectattributevalidator
Purpose
Validator used to validate any control that is associated with a docbaseobject. Deprecated as of version
6. See docbaseattributeproxy, page 42.
Attributes
attribute (Required) Attribute against which the control’s

selected value is to be validated.
errormessage (Optional) Message displayed when validation
fails.
the JSP page.
object (Required) Name of the docbaseobject tag on
the JSP page. In the following example, the
object being validated is named "obj, so the
value of the object parameter for this validator
would be "obj:<dmfx:docbaseobject name="obj"
configid="attributes"/>
docbaseobjectvalidator

Description
Since
5.x

Usage
This control is used only to validate attributes that are listed as ignored attributes in a
docbaseattributelist configuration. For example, the list of available formats is displayed by the
datadropdownlist control named "formatList" in the Webtop import JSP page, and the user’s selection
should be validated against object constraints for the selected object type. The format attribute is
listed in the <ignore_attributes> element of import_docbaseattributelist.xml. In order for the selection
to be validated, use the validator to validate the control on the JSP page, similar to the following:
<dmf:docbaseobjectattributevalidator
name="docbaseobjectvalidator_attr1"
object="docbaseObj" controltovalidate="
formatlist" attribute="a_content_type"/>
docbaseobjectvalidator
Purpose
Validates all modified attribute control values against all rules that have been set up in the Content
server. Renders a list of error messages for all failed validators. This validator is embedded in the
docbaseobject control, so validation is performed automatically on attributes that have been modified
by the user.
Attributes
controltovalidate (Required) Input control name to validate

cssclass (Optional) Sets the CSS class that is applied to
this control.
inputmaskvalidator

header (Optional) Header for error message.
the JSP page.
corresponding to the NLS ID is the error
message for validation failure.
Description
Since
5.x

inputmaskvalidator
Purpose
Validates a control’s input values based on an input mask.
Attributes

inputmaskvalidator

validation fails.
the JSP page.
inputmask (Optional) Pattern of valid ASCII characters that
the user can enter. This control verifies that the
length of the input string is the same number of
characters specified in this attribute.
validatechangeonly (Optional) Since: 6.0.Indicates whether to
validate only when the control changes. True, to
validate only when the control changes; False
(default), otherwise.
Description
Since
5.x

Usage
An input mask is a pattern of mask characters and literals. A mask character specifies the kind of
character allowed at that position in the pattern. A literal is an ASCII character that must appear
in the pattern at that position. To convert a mask character to a literal, precede the mask character
with a double backslash (\\) .
multiobjectsdocbaseattributevalidator
Table 8. Valid Mask Characters
Character Meaning
# Numeric (0-9)
A Alphanumeric (0-9, a-z, A-Z)
& Any ASCII character
? Alphabetic (a-z, A-Z)
U Alphabetic, and converts to uppercase
L Alphabetic, and converts to lowercase
Masks
This table shows a mask in the first column, an example of valid user input in the second column,
and a description of the mask in the last column. The last mask example limits the number of
characters to thirteen.
Mask User Input Description

##/##/#### 12/25/1999 Date
##:## UU 12:35 AM Time
###-##-#### 123-45-6789 US social security number (SSN)
(###)###-#### (999)555-1212 US phone number
#####-#### 12345-6789 US zip code
????????????? John Name (limited to thirteen
characters)
multiobjectsdocbaseattributevalidator
Purpose
Renders a valildator corresponding to the type of the common attribute of the selected, multiple
objects.
multivaluesinputmaskvalidator
Attributes

the JSP page.
Description
Since
5.x

multivaluesinputmaskvalidator
Purpose
Validates multiple values in a label using an input mask.
Attributes
controltovalidate (Required) Name of the control to validate

validation fails.
the JSP page.
multivaluesrequiredfieldvalidator
inputmask (Optional) Pattern of valid ASCII characters that

the user can enter. This control verifies that the
length of the input string is the same number of
characters specified in this attribute. For more
information, see .
separator (Optional) Character to separate input values.
Description
Since
5.x

Purpose
Validates that all of the required values in a list box have been set
Attributes


the JSP page.
indicator (Optional) String to display next to a required
field. If this attribute is empty (that is, indicator
= ""), an asterisk (*) is displayed. Default is an
asterisk (*).
indicatorcssclass (Optional) Class in a stylesheet to apply to the
indicator.
indicatornlsid (Optional) NLSID that resolves to a string to
display as a required field indicator.
indicatorstyle (Optional) CSS style rule to apply to the
indicator.
Description
Since
5.x

quotevalidator
quotevalidator
Purpose
Tests the string contents of an input control for single ( ’ ) or double quotation marks ( " ). Returns
true, if the string does not contain a quotation mark or the string is empty; returns false, if the string
contains a quotation mark.
Attributes
controltovalidate (Optional) Name of the control to validate.

errormessage (Optional) The error message to display when
validation fails.
the JSP page.
ignore (Optional) Whether to ignore a single quote
or double quotes in the string. Valid values:
singlequote, doublequote, or an empty string
(default). For example, if you want to test for
double quotes only, set the value of this attribute
to singlequote. An empty string means that
neither double quotes nor single quotes are
ignored.
rangevalidator
Description
Since
5.x

rangevalidator
Purpose
Validates an input control by ensuring that its value is within a specified range.
Attributes
controltovalidate (Required) Control to validate.

the JSP page.
maxvalue (Optional) The range’s maximum value.
maxvaluecontrol (Optional) Input control containing the range’s
maximum value.
minvalue (Optional) The range’s minimum value.
minvaluecontrol (Optional) Input control containing the range’s
minimum value.
regexpvalidator

type (Optional) Datatype of the value. Valid values
are: string, integer, double.
Description
Since
5.x

regexpvalidator
Purpose
Verifies that the input control value matches the specified Apache regular expression pattern. For
information about Apache expression syntax, see the Apache Web site.
Attributes

expression (Required) Regular expression to match.
the JSP page.
requiredfieldvalidator

Description
Since
5.x

requiredfieldvalidator
Purpose
Validates an input control by ensuring that its value has been set.
Attributes

the JSP page.
indicator (Optional) String to display next to a required
field. If this attribute is empty (that is, indicator
= ""), an asterisk (*) is displayed. Default is an
asterisk (*).
symbolicversionlabelvalidator
indicatorcssclass (Optional) Class in a stylesheet to apply to the

indicator.
indicatornlsid (Optional) NLSID that resolves to a string to
display as a required field indicator.
indicatorstyle (Optional) CSS style rule to apply to the
indicator.
Description
Since
5.x

symbolicversionlabelvalidator
Purpose
Ensures that the symbolic version label entered by the user is not an implicit version label.
Attributes

utf8stringlengthvalidator

the JSP page.
corresponding to the NLS ID is the error
message for validation failure.
Description
Since
5.x

Purpose
Verifies that the string in its UTF8 representation does not exceed the field limit, to prevent data loss
when accented or double-byte characters are entered. Converts the user input string value to its
corresponding UTF-8 byte array before comparing it with the specified maximum byte length value.
Attributes


the JSP page.
maxbytelength (Required) Maximum length (in byles) of the
UTF-8 byte array corresponding to the user
input string.
Description
Since
5.x

Usage
This validator can be used to replace the regexpvalidator to validate that string character length
confirms to the field size constraint in the data dictionary. For multi-byte and accented characters, the
regexpvalidator cannot do this validation and can result in data loss.
For example, the checkin page allows the user to enter a version label that, according to the data
dictionary, must be no longer than 32 single-byte characters. This validator will not allow a version
label that exceeds 32 bytes.
validationsummary
validationsummary
Purpose
Displays a summary list of failed validation messages for all validated input controls.
Attributes

header (Optional) Summary header message.
the JSP page.
corresponding to the NLS ID for the summary
header message string.
Description
Since
5.x

Date/time
dateinput
Purpose
Generates a date input control. The order (day and month) will be determined by the user’s locale.
The months and days will be listed as integers and their labels are looked up in the localization
bundle form.control.DateInputNlsProp.
dateinput
Attributes

dateformat (Optional) Format of the date displayed in
the user interface. Valid values are: short (for
example, 1/2/02), medium (for example, 2 Jan,
2002), long (for example, 2 January, 2002).
dateselector (Optional) Date selection user interface item.
Valid values are: fields (dropdown fields),
calendar (a popup calendar). Default is calendar.
day (Optional) Default day to display. Default is 1.
fromyear (Optional) Year to begin the available date range.
Default is 1997.
the JSP page.
month (Optional) Default month to display. Default is
1.
attribute is true).
runatclient (Optional) Specifies for the onselect event to run
dateinput

toyear (Optional) Year to end the available date range.
Default = 2005.
width (Optional) Width (in pixels) of the control.
Default is 200.
year (Optional) Default year to display. By default,
the fromyear attribute value is displayed.
Description
Since
5.x

Usage
In addition to the configuration available on individual date controls, global date input display can
be configured by extending /wdk/config/datetimecontrol_config.xml. The following table describes
date input control configuration in this file:0
Table 9. Global date input control configuration elements
<dateinput> Configures all instances of dateinput

tag including those generated by the
docbaseattributelist control. Can be
overridden on an individual tag. Contains
<default-year-from>, <default-year-to>, and
<default_type>.
.<default-year-from> Sets the default beginning year in the date input
dropdown list
.<default-year-to> Sets the default end year in the date input
dropdown list
Editable attributes are rendered as dateinput controls. To configure the rendered control, set the
beginning and end year in the <dateproperties> element of /wdk/app.xml.
datetime
When you want to set a date programmatically in your component class, clear the dateinput control
by calling clear(), which clears day, month, and year. For example:
private void resetDateInputControl(DateInput date)
{
if (date != null)
{
date.clear();
}
}
datetime
Purpose
Generates a date/time control that allows the user to select month, day, year, hour, minute, and second.
The date and time labels are looked up in the localization bundle form.control.DateTimeNlsProp.
Attributes

datafield (Optional) Overrides all of the date and time
values with data from a data source.
dateformat (Optional) Format of the date displayed in
the user interface. Valid values are: short (for
example, 1/2/02), medium (for example, 2 Jan,
2002), long (for example, 2 January, 2002).
dateselector (Optional) Date selection user interface item.
Valid values are: fields (dropdown fields),
calendar (a popup calendar). Default is calendar.
day (Optional) Default day to display. Default is 1.
fromtime (Optional) Time to begin a range when the
timeselector value is list; for example: hh:mm:ss
fromyear (Optional) Year to begin the available date range.
Default is 1997.
hour (Optional) Default hour to display. Default is
the current time.
datetime

the JSP page.
minute (Optional) Default minute to display. Default is
the current time.
month (Optional) Default month to display. Default is
1.
attribute is true).
runatclient (Optional) Specifies for the onselect event to run
second (Optional) Default second to display. Default is
the current time.
timeformat (Optional) Specifies how the time is formatted
in the user interface and the control value (in
locale-specific format). Valid values: short (for
example, rendered as 2:40 PM in English locale),
medium (for example, 2:40:23 PM), long (for
example, 2.40:23 PM PST)
datetime
timeselector (Optional) Time selection user interface item.

Valid values are: fields (Default) Dropdown lists
that display hour, minute, and day. Increments
are set by the value of the timestep attribute. list
Single dropdown list of discrete times displayed
as the values for timeformat, fromtime, totime,
and timestep. text Text box that accepts text
input of any kind.
timestep (Optional) Iincrement (in seconds) between
times that are displayed when the timeselector
attribute value is list or fields. If the timeselector
value is fields and the timestep value is a
multiple of 60 or 3600, the seconds and minutes
fields are not hidden. Default is 1800.
totime (Optional) Time to end a range when the
timeselector attribute value is list; for example,
hh:mm:ss.
toyear (Optional) Year to end the available date range.
Default is 2005.
width (Optional) Width (in pixels) of the control.
Default is 200.
year (Optional) Default year to display. By default,
the fromyear attribute value is displayed.
Description
Since
5.x

Usage
In addition to the configuration available on individual date controls, global date display can be
configured by extending /wdk/config/datetimecontrol_config.xml. The following table describes
datetime control configuration in this file:
datetime
Table 10. Global datetime control configuration elements
<datetime> Sets the default date format type for all

instances of the datetime control, including
those generated by docbaseattributelist control.
Overridden by the dateformat and timeformat
attributes on the datetime control.
.<default_type> Specifies the type of Java DateFormat to apply
(examples in parentheses). Valid values: short
(12.13.52 or 3:30 pm) medium (Jan 12, 1952 3:30
pm) long (January 12, 1952 3:30:32 pm) full
(Tuesday, April 12, 1952 AD 3:30:42 pm PST)
When you want to set a date and time programmatically in your component class, clear the datetime
control by calling clear(), which clears day, month, and year. For example:
private void resetDateTimeControl(DateTime dt)
{
if (dt != null)
{
dt.clear();
}
}
Not all fields must be set for the control to be valid. The following table shows the state of each field
and whether the combined state returns true for isValid(), isValidDate(), isValidTime(), and the
value that will be displayed:
Yr/Mo/ Hour Min Sec isValid isValid isValid Value

Day Date Time
not set F F F blank
all set null set set F T F blank
all set null null set F T F blank
all set set null set F T F blank
all set null null null T T F date,00:
00:00
all set set null null T T T date, hr:
00:00
all set set set null T T T date, hr:
min:00
all set set set set T T T date, hr:
min:sec
datevalueformatter
datevalueformatter
Purpose
Datevalueformatter control. Wraps a raw date value in milliseconds since 1970 and replaces the
value with a formatted date value.
Attributes

the JSP page.
type (Optional) Format of the date to display. Maps
to the Java DateFormat types; such as "short,
"medium, "long, "full.
Description
Since
5.x

Usage
Table 11. Global datetime control configuration elements
<datevalueformatter> Sets the default date format for all instances of

the datevalueformatter control. Overridden by
the type attribute on the datevalueformatter
control.
.<default_type> Specifies the type of Java DateFormat to apply
(examples in parentheses). Valid values: short
(12.13.52 or 3:30 pm) medium (Jan 12, 1952 3:30
pm) long (January 12, 1952 3:30:32 pm) full
(Tuesday, April 12, 1952 AD 3:30:42 pm PST)
dragdrop
Drag and drop
dragdrop
Purpose
Indicates that one or more dragdropregion tags, or controls that implement drag and drop interfaces,
are defined on the page
Attributes
None.
Description
Since
5.x

Usage
To support drag and drop on the page, add the dragdrop tag to the page and a dragdropregion tag
that contains controls to support a drag or drop (or both) operation. If you have a browsertree in your
page, you do not need a dragdrop region tag: the browsertree control has an ondrop attribute.
For more information about drag and drop, see Web Development Kit Development Guide.
dragdropregion
Purpose
Specifies that the contained control or controls support drag and/or drop operations. The specific
operations are named in the control attributes.
dragdropregion
Attributes

string from a data source
dragenabled (Optional) Whether dragging the control is
supported (True) or not (False).
dragenableddatafield (Optional) Alternative method of specifying
whether the control supports dragging. The
value of the attribute is used as a key to retrieve
whether dragging of the control is supported.
enableddroppositions (Optional) Drop positions that are supported by
the control. Valid values is a comma separated
combination of above, below, and over.
enableddroppositionsdatafield (Optional) Alternative method of specifying the
type of drop positions that is supported. The
value of the attribute is used as a key to retrieve
the action drop positions.
the JSP page.
isbackground (Optional) Whether the dragdrop region is the
page background (True) or not (False).
label (Optional) Label for dragdrop region.
ondrop (Optional) Specifies the name of a method
that handles the ondrop event. You must
enter a value here and set a value for
enableddroppositions to enable drop operations.
ondropdatafield (Optional) Alternative method of specifying the
name of the drop handler function. The value
of the attribute is used as a key to retrieve the
actual drop handler function
dragdropregion
runatclient (Optional) Whether the ondrop event is to run

Description
Since
5.x

Usage
To support drag and drop on the page, add the dragdrop tag to the page and a dragdropregion tag
that contains controls to support a drag or drop (or both) operation. If you have a browsertree in your
page, you do not need a dragdrop region tag: the browsertree control has an ondrop attribute.
To enable drop operations, set an ondrop event handler for the ondrop attribute and specific one or
more supported drop positions for the enableddroppositions attribute. To enabled drag operations,
set the dragenabled attribute to true. You can enable both operations for a region.
Following are some examples of drag and drop regions:
• label in clipboard.jsp
dragenabled=’true’
• datagrid in /rooms/doclist_body.jsp
enableddroppositions="<%=IDropTarget.DROP_POSITION_OVER%>"
ondrop=’onDrop’
Note: This dragdropregion tag contains another nested dragdropregion tag that enabled drag
• link in vdmlist_streamline.jsp
ondrop=’onDrop’ enableddroppositions=’above,over,below’ dragenabled=’true’
For more information about drag and drop, see Web Development Kit Development Guide.
form
Framework
form
Purpose
Generates an HTML form on a Web page.
Attributes
autofocusneeded (Optional) When this attribute is set to true,

it will cause the first focusable control to be
focused. By default this feature is not enabled,
as we cannot have all the forms to have focus in
multi-framed classic view screen.
enctype (Optional) Form data encoding type.
Valid values are: multipart/form-data |
application/x-www-form-urlencoded |
text/plain. Set to "multipart/form-data on pages
that upload file content such as check in, import
and import rendition.
the JSP page.
keepfresh (Optional) Whether to keep the form refreshed
(True) or not (False). If the browser loads the
form without sending a request back to the
server (for example, when the user hits the Back
button) a server post-back event is generated to
render the component again. If the component
is within a container, the container URL is
refreshed.
onkeepfresh (Optional) JavaScript (client-side) event handler
for the keepfresh event that is triggered when
the user hits the Back button. In the Form class
implementation, this method provides a URL
for the refresh event. Your handler can override
this implementation.
webform
Description
Since
5.x

webform
Purpose
Outermost tag containing all other taglib tags on a page. This represents the entire HTML page.
Generates included JavaScript file references.
Attributes
formclass (Optional) Java class containing the event

handler functions that are called when events
are fired. If the JSP page is in a component, do
not specify this attribute, because the component
class handles events.
nlsbundle (Optional) NLS bundle that is used by all the
controls in the form. If the JSP page is in a
component, the component class specifies the
nlsbundle attribute value.
nlsclass (Optional) Java NLS class that is used by all
the controls in this form. If the JSP page is in a
component, the component class specifies the
nlsclass attribute value.
validation (Optional) Whether to prevent (False) validation
of controls on the form or not (True). Default is
true. Only set to false when in development.
Description
Since
5.x

fireclientevent
Generating client and server events
fireclientevent
Purpose
Fires a client JavaScript event when the JSP page is loaded. Can contain one or more <dmf:argument>
controls to pass values to the event handler. Used by the application integrations framework.
Attributes

event (Required) Name of an event handler on the
client.
the JSP page.
includeargname (Optional) Whether to pass event argument
names and values to the handler (True) or only
the value to the handler (False). Default is false.
Description
Since
5.x

firepresubmitclientevent
firepresubmitclientevent
Purpose
Fires a client JavaScript event before submitting the control event to the server. Can contain one
or more <dmf:argument> controls to pass values to the event handler. Used by the application
integrations framework.
Attributes
controlid (Optional) Name of the control for which to fire

the event. The event is fired for any control
onclick event. If this attribute’s value is not
specified (default), then the client event is fired
before form submission.
event (Required) Name of an event handler on the
client. If a controlid is specified, the event fires
only for the named control.
includeargname (Optional) Whether to pass event argument
names and values to the handler (True) or only
the value to the handler (False). Default is false.
Description
Since
5.x

postserverevent
postserverevent
Purpose
Renders a postServerEvent() JavaScript call to a method in a class on the J2EE application server.
This tag is used within a JavaScript function.
Attributes
clientsidehandlermethod (Optional) (WDK for Portlets only) Name of the

client side JavaScript handler function.
controlid (Optional) ID of the control that fires the event.
eventargname (Optional) Name of an argument to be passed
to the method specified in the handlermethod
attribute. The argument value to be passed is
specified in the eventargvalue attribute.
eventargname2 (Optional) Name of an argument to be passed
specified in the eventargvalue2 attribute.
eventargvalue (Optional) Value of an argument to be passed
attribute. The argument name is specified in the
eventargname attribute.
eventargvalue2 (Optional) Value of an argument to be passed
eventargname2 attribute.
postserverevent

formid (Optional) ID of the current form, for example,
’<%=form.getElementName()%>’
handlerid (Optional) ID of the control that handles the
event.
handlermethod (Optional) Server method to be called. Required
for standalone Web application; optional for
WDK for Portlets.
Description
Since
5.x

Usage
The following example from advsearchex.jsp renders a JavaScript function call to postServerEvent(),
which in turns calls the event handler executeSavedSearch() in the AdvSearchEx class. The class
containing the event handler must be imported in the JSP page::
<%@ page import="com.documentum.webcomponent.library.advsearch.AdvSearchEx" %>
...
function executeSavedSearch()
{
<dmf:postserverevent formid='<%=strPostToForm%>' handlerid='
<%=advsearch.getElementName()%>' handlermethod='
executeSavedSearch'/>
}
clientenvpanel
Grouping user interface elements
clientenvpanel
Purpose
Generates a panel that is displayed or hidden depending on the client environment. For example, the
WDK login JSP page has one panel for the Application Connectors environment and another one
for the non-connector environment.
Attributes
environment (Optional) String that specifies the client

environment, which is specified in the
application/environment/clientenv element of
the app.xml.
the JSP page.
reversevisible (Optional) Whether the panel is visible (False) or
the reverse of the current visibility state (True) of
the environment specified by the environment
attribute. You can usually set this attribute to
true to hide the panel. Default is false.
Description
Since
5.x

Usage
Your application can display different content depending on whether the client is using a Application
Connector within a Microsoft Office application. For example, the WDK login page contains two
pane
login buttons. The button for the non-connector environment specifies a server-side event handler
as follows:
<dmfx:clientenvpanel environment="appintg" reversevisible="
true">
<dmf:button ...onclick="onLogin"/>
</dmfx:clientenvpanel>
The button for the connector environment specifies an event handler on the client opens a browser
window for the application connector:
<dmfx:clientenvpanel environment="appintg">
<script>
function onLogin()
{
try
{
window.external.AppIntgProcessEvent("event=OnLogin");
}
...
postServerEvent(null, null, null, "onLogin");
}
</script>
...
<dmfx:clientenvpanel environment="appintg">
<dmf:button ...onclick="onLogin" runatclient="true"/>
pane
Purpose
Pane control contained within a paneset control. Displays content that can be fixed or scrolled. For
information about general scrollable paneset design, see Web Development Kit Development Guide.
Attributes

the JSP page.
name (Required) Name for this control. Named
panel
overflow (Optional) Whether to generate a scroll bar

(auto) or clip excessive content (hidden), if the
content exceeds the scrolling area. Default is
auto. Specify hidden for fixed panes, such as
headers and footers.
printable (Optional)
Description
Since
5.x

panel
Purpose
Panel control that wraps a group of controls as a mechanism for hiding or displaying the group.
Attributes
datafield (Optional) Overrides the visible attribute value.

the JSP page.
mode (Optional) Whether the datafield attribute value
is a string or boolean. Default is string. If this
attribute value is string and the datafield value’s
string length is greater than 0, then the datafield
attribute value is true. If this attribute value is
boolean and the datafield attribute value is 1, T,
or true, then the datafield attribute value is true.
panel
renderifinvisible (Optional) True: render the panel content and

hide it even if the panel’s visible attribute is
set to "false". False: do not render the panel
content when the visible attribute is set to "false".
Default is "false".
This feature supports inline refresh functionality

for panel content. For inline refresh to work
when the panel is in a table, the cssclass attribute
of the HTML elements, which are enclosed by
the panel, must be set to the panel name.
Since: 6.5
reversevisible (Optional) Whether the visible attribute is the
boolean complement of the datafield attribute
value (True) or not (False). Default is false. For
example, when this attribute is set to true and
the datafield value (in boolean mode) is true,
then the visible attribute value is false.
Description
Since
5.x

Usage
Panels can be used to display or hide elements within the JSP. For example, the newnotepage
component hides a panel in onInit():
Panel panel = (Panel) getControl("optionspanel", Panel.class);
panel.setVisible(false);
The panel is then displayed in onClickShowHideOptions(), which is called when the user clicks the
Show/Hide options checkbox:
Panel panel = (Panel) getControl("optionspanel", Panel.class);
if (m_bShowOptions == true)
{
panel.setVisible(true);
linkShowHideOptions.setLabel(getString("MSG_HIDE_OPTIONS"));
}
else
{
panel.setVisible(false);
linkShowHideOptions.setLabel(getString("MSG_SHOW_OPTIONS"));
}
paneset
The options panel and link that makes it visible are coded in the JSP page is as follows:
<table border="0" cellpadding="2" cellspacing="0" width="100%">
<% /* Options */ %>
<tr>
<td colspan="2" nowrap>
<dmf:link name="showhideoptions" nlsid="
MSG_SHOW_OPTIONS" onclick="onClickShowHideOptions"/>
</td>
</tr>
<dmf:panel name="optionspanel">
<tr>
<td>
<dmf:checkbox name="subscribe" nlsid="
MSG_SUBSCRIBE_TO_CABINET"/>
</td></tr></dmf:panel></table>
paneset
Purpose
Contains pane controls to allow scrolling, so that buttons stay in view and content within a pane is
scrolled. One outermost paneset to a JSP page, which can contain nested panesets. For information
about general scrollable paneset design, see Web Development Kit Development Guide.
Attributes
bottompadding (Optional) Bottom padding (in pixels) of the

paneset control. Applies only to the outermost
paneset control in a page.
cols (Optional) Width for the contained panes;
for example, cols=’110, *, 40’. The asterisk
(*) indicates that the middle pane uses the
remaining browser space. You must specify
either rows or columns, but not both.
the JSP page.
leftpadding (Optional) Left padding (in pixels) of the paneset
control. Only valid for the outermost paneset
control in a page.
paneset
minheight (Optional) Minimum height (in pixels) of the

paneset control. Only valid for the outermost
minwidth (Optional) Minimum width (in pixels) of the
rightpadding (Optional) Right padding (in pixels) of the
rows (Optional) Height (in pixels) for the contained
panes; for example, rows=’110, *, 40’. The
asterisk (*) indicates that the middle pane uses
the remaining browser space. You must specify
either rows or columns, but not both.
toppadding (Optional) Top padding (in pixels) of the paneset
control. Only valid for the outermost paneset
control in a page.
Description
Since
5.x

Usage
Controls on the JSP page that are outside the dmf:paneset control may not be visible.
If you are displaying data from a datagrid in multiple panes, set the rendertable attribute to false so
that the datagrid does not render <table> markup. Instead, manually add <table> start and close tags
within your <dmf:pane> tags.
You can globally configure all paneset controls in your application by extending the paneset
configuration file /wdk/config/panesetcontrol_config.xml. The following attributes can be globally
configured for the outermost paneset and the inner panesets independently: toppadding,
bottompadding, leftpadding, and rightpadding.
tab
tab
Purpose
Generates a tab control within a tabbar control.
Attributes
datafield (Optional) Overrides value and NLS ID with

data from a data source.
height (Optional) Height of the tab and overrides the
tabheight property in the tabbar control.
the JSP page.
onchange (Optional) Event that is fired after the user
changes the tab. This event is not handled
attribute is true).
runatclient (Optional) Whether the onclick event is to run
value (Optional) Text that is displayed on the tab.
tabbar

width (Optional) Width of the tab and overrides the
tabwidth property in tabbar.
Description
Since
5.x

tabbar
Purpose
Generates a tab bar control (non-graphical).
Attributes
align (Optional) Alignment of the text on all of the

tabs. Valid values are: left, right, center. Default
is center.
disabledclass (Optional) CSS class to apply to the text of
disabled tabs.
(enclosed in quotes) to apply to the text of the
disabled control.
the JSP page.
imagefolder (Optional) Folder in which the tab bar graphics
are stored. If the graphics are not found in this
folder, a non-graphical tab bar is displayed.
tabbar

normalclass (Optional) Class to apply to text of normal tabs.
normalstyle (Optional) Style to apply to text of normal tabs.
onchange (Optional) Event fired when a user selects a
tab. This event is not handled immediately. It
is handled on the server only when the form is
submitted.
attribute is true).
scrollable (Optional) Whether to enable scrolling through
tabs if all tabs are not visible within the
browser page (True) or not (False). Default is
false. Supported only when the tabposition
attribute value is top (for both graphical and
non-graphical tab bars). Container must define
a width (paneset, table). Scrolling arrow images
(chevrons) can be placed in tabbar image folder
for a theme.
selectedclass (Optional) Class to apply to text of selected tabs.
selectedstyle (Optional) Style to apply to text of selected tabs.
showtabs (Optional) Whether to display tabs (True) or
non-clickable, non-graphic roadmap for use in
wizard containers only (False). Default is true.
If this attribute is set to false, the values of these
attributes are ignored for rendering: tabposition,
imagefolder, and onclick.
tabheight (Optional) Height of all the tabs. Default is 10.
Use the height property on a tab to override this
attribute.
tabposition (Optional) Position of the tabs on the page. Valid
values are: top, bottom, left, right. Default is top.
tabwidth (Optional) Width of all the tabs. Default is 60.
Use the width property on a tab to override this
attribute.
body
value (Optional) Text displayed on the selected tab.

Sets the name of the initial tab.
Description
Since
5.x

Usage
You can add scolling arrows (chevrons) to a theme. The images must be in the folder
/theme_name/images/tabbar/top where theme_name is the name of your theme. The images must
have the following names: backward_enabled.gif, backward_disabled.gif, forward_enabled.gif, and
forward_disabled.gif.
Note: To have a scrollable tabbar, the containing HTML element must have a fixed width. For
example, the containing table cells in Webtop’s tabbar.jsp set fixed widths as follows:
<td align="left" valign="bottom" nowrap="">
<dmf:tabbar name="<%=TabBar.CONTROL_TABBAR%>"...>
</dmf:tabbar>
</td>
<td ...width="1%">

</td>
The Webtop streamline view has its own set of images. The images must be in the folder
/theme_name/imagesstreamline/tabbar/top where theme_nameis the name of your theme. The images
must have the following names: backward_enabled.gif, backward_disabled.gif, forward_enabled.gif,
and forward_disabled.gif.
HTML
body
Purpose
Generates an HTML <body> tag.
body
Attributes
alink (Optional) HTML alink attribute.

background (Optional) HTML background attribute.
bottommargin (Optional) Distance (in pixels) between the body
text and browser window bottom margin.
control.
the JSP page.
leftmargin (Optional) Distance (in pixels) between the body
text and browser window left margin.
link (Optional) HTML link attribute.
marginheight (Optional) HTML marginheight attribute.
marginwidth (Optional) HTML marginwidth attribute.
onload (Optional) JavaScript event handler for the
HTML body onload event.
onunload (Optional) JavaScript event handler for the
HTML body onunload event.
rightmargin (Optional) Distance (in pixels) between the body
text and browser window right margin.
showdialogevent (Optional) Whether to allow the page to be
rendered in an Application Connector dialog
window (True) or not (False).
sizepreference (Optional) Whether to save the user’s resize
preference for an Application Connector dialog
window (True) or not (False). Default is true.
text (Optional) HTML text attribute.
titlenlsid (Optional) NLS lookup key. The string
the title attribute value.
button
topmargin (Optional) Distance (in pixels) between the body

text and browser window top margin.
vlink (Optional) HTML vlink attribute.
Description
Since
5.x

button
Purpose
Generates an HTML button.
Attributes
accessible (Optional) Deprecated in 6.0.Whether accessible

mode is on (True) or off (False). (Only used with
the imagefolder attribute)
align (Optional) Deprecated in 6.0.6.0: This attribute
is ignored.Pre-6.0: (Image label only) Alignment
of the label text.
datafield (Optional) Overrides label or nlsid with data
from a data source.
default (Optional) Whether this button is the default
button on the page (True) or not (False). Must
be used with a text control or another control
that has the defaultonenter attribute set to true.
When the user presses the Enter key, the default
button event is fired.
disabledclass (Optional) Deprecated in 6.0. CSS class to apply
to the disabled control.
button
disabledstyle (Optional) Deprecated in 6.0. Entire CSS-syntax

style sheet rule (enclosed in quotes) to apply to
the disabled control.
control.
the JSP page.
imagefolder (Optional) Deprecated in 6.0.6.0: Sets the folder
that the button graphics are stored in. If the
graphics are not found in this folder or this
attribute is not specified, then an HTML button
is rendered.Pre-6.0: Sets the folder that the
button graphics are stored in. If graphics are
not found in this folder, an HTML button will
be drawn.
label (Optional) Value stored in the control and
displayed as text on the button.
onchange (Optional) Event fired when this control is
changed by the user. This event is not handled
onclick (Required) Event fired when the user clicks
this control. This event is handled immediately
attribute is true).
runatclient (Optional) Whether the event is to run on the
src (Optional) Image to be used for the button.
button
srcdisabled (Optional) Image to be used when the button

is disabled.
width (Optional) Width of the image.
Description
Since
5.x

Usage
In pre-6.0, by default, this control rendered the <input type=button> HTML tag; if the imagefolder
attribute was specified, then the <table>...<td>xxxLABELxxx</td>...</table> HTML tags were
rendered; if the src attribute was specified then the <img src=...> HTML tag was rendered.
checkbox
In 6.0, by default this control renders the <button> tag; using the imagefolder attribute and its
associated attributes (disabledstyle, disabledclass, align, accessible) are deprecated. Also, specifying
the src attribute renders the <button><img src=...>...</button> HTML tags.
checkbox
Purpose
Generates an HTML checkbox form control.
Attributes

data source
the JSP page.
label (Optional) Text label for the checkbox.
labelalign (Optional) Alignment of the checkbox label.
Valid values are: left, right
onchange (Optional) Event fired when this control is
changed by the user. This event is not handled
checkbox

attribute is true).
prefixassociatedlabelnlsid (Optional) Label NLS string added as a prefix
to the existing title of a control. This string
enables accessibility users to obtain contextual
information.
postfixassociatedlabelnlsid (Optional) Label NLS string added as a postfix
information.
value (Optional) Whether the control is checked (True)
or unchecked False). Default is false.
datadropdownlist
Description
Since
5.x

Usage
The checkbox supports the onclick event for which you must implement your own server side event
handler. Checkbox also supports an onchange event that is fired when the form is resubmitted.
datadropdownlist
Purpose
Generates an HTML drop down list control. Holds option tags or a single dataoptionlist control
that contains a databound option tag.
Attributes

is True.
autocompleteid (Optional) Key that is used to store the
autocomplete list in the user preferences.
You can set the same ID on two text controls,
for example, if they share the same set of
suggestions. If the control has no ID specified,
the ID will be generated based on the form id
and text control name, in the form consisting of
formid_controlid. For docbaseattribute controls
that render a text control, an ID is generated
using the attribute name, for example, keyword
or title.
editable (Optional) Whether the user can type in a value
Not available: since 6.5

datadropdownlist

id (Optional) ID ofthis control. The ID is generated
the JSP page.
query (Optional) Displays query or recordset as a
drop down list. Use dataoptionlist tag within
datadropdownlist for databound values. Use
the option tag within datadropdownlist for
static output. The DQL query that is passed
to the data provider has the following form:
query="select r_object_id, user_name from
dm_user where user_name like ’a%’ "
datalistbox

list control.
Description
Since
5.x

datalistbox
Purpose
Generates an HTML list box control. Use the dataoptionlist tag within dataoptionlist for databound
values. Use the option tag within dataoptionlist for static output.
datalistbox
Attributes

control.
the JSP page.
query (Optional) DQL query to retrieve data
for a dataoptionlist control, for example:
query="select r_object_id, user_name from
dm_user"
visible in the listbox. Scrollbars are used if more
rows are available.
div

list control.
Description
Since
5.x

div
Purpose
Generates HTML <div> open and close tags.
dropdownlist
Attributes

datafld (Optional) HTML datafld attribute.
dataformatas (Optional) HTML dataformatas attribute.
datasrc (Optional) HTML datasrc attribute.
the JSP page.
Description
Since
5.x

dropdownlist
Purpose
Generates an HTML drop-down list control. Contains option tags or a single dataoptionlist control
that contains a databound option tag.
dropdownlist
Attributes

is True.
or title.
datafield (Optional) Overrides the value attribute with
data from a data source.Since 6.0.

forceselection (Optional) Whether it is required (True) or
optional (False) for the user to select an entry
from the dropdown box. If true is specified, no
item is selected initially. If false is specified, the
first item in the list is selected initially.
control
the JSP page.
dropdownlist

runatclient (Optional) Specifies whether the onselect event
is to run on the client (True) or the server (False).
list control
dropdownorlabel
Description
Since
5.x

Usage
Options in the list can be set programmatically using the method addOption(). For example:
DropDownList dropdown = (DropDownList) get Control (
DOCBASE, DropDownList.class);
Option option1 = new Option();
option1.set Value(value1);
option1.set Label (value1);
dropdown.addOption(option1);
The onchange event does not submit the form, so you cannot use the onchange event to update other
lists or controls on the JSP page. If you need to update another control, handle the onselect event
in your component class with a method that does nothing, and handle the onchange event with a
method that performs the control update. For example:
public void onSelectTypeFilter(DropDownList control, ArgumentList args)
{
String strMode = control.getValue();
// Control update logic here
updateControls();
}
When the dropdown list is rendered for a required attribute value with value assistance, forceselection
is set to true and the default value is selected. If the required attribute does not have a default value,
no item will be selected and the user will be forced to select an item.
dropdownorlabel
Purpose
Displays a label if there is only one value to display; otherwise displays a drop-down list.
Attributes

frame

Description
Since
6.0

frame
Purpose
Generates HTML <frame> tags.
Attributes

frameborder (Optional) Whether to display a frame border
(True) or not (False)
marginheight (Optional) Height (in pixels) between the frame
and browser window margin.
marginwidth (Optional) Width (in pixels) of the spacing
between the frame and browser window margin.
the title attribute value.
noresize (Optional) Whether to make the frame resizeable
(False) or not (True).
frameset
scrolling (Optional) Whether to display scroll bars for the

frame (True) or not (False).
src (Optional) Source of the frame content.
Can be URL to component, HTML page,
or JSP page (HTML or JSP path must
be relative to application root). For
example: src=’/component/toolbar’ or
src=’/webtop/classic/workarea.jsp’
title (Optional) Title to display for the frame.
Description
Since
5.x

frameset
Purpose
Generates HTML <frameset> tags.
Attributes
border (Optional) Border (in pixels) around the image,

if the frameborder attribute is set to true. Default
is 0 (zero) pixels (that is, no border).
cols (Optional) Width (in pixels) of each column.
Cannot be used with the rows attribute. Use
an asterisk (*) to specify that the width is
determined by the browser. For example:
rows="24,*"
head
frameborder (Optional) Whether to display a frame border

framespacing (Optional) Width (in pixels) of the spacing
between frames.
the JSP page.
name (Optional) Sets the name for this control. Named
onload (Optional) Event to be fired in the frameset
onload event.
onunload (Optional) Event to be fired in the frameset
onunload event.
rows (Optional) Height (in pixels) of each row.
Cannot be used with the cols attribute. Use
an asterisk (*) to specify that the height is
determined by the browser. For example:
rows="24,*"
Description
Since
5.x

head
Purpose
Generates HTML <head> open and close tags.
helpimage
Attributes
None.
Description
Since
5.x

helpimage
Purpose
Renders an image that launches context-sensitive help.
Attributes

datafield (Optional) Overrides the value of the src
attribute with a URL from a data source.
the JSP page.
attribute values.
helpimage

attribute is true).
src (Optional) URL to the image on the server. Can
be a path on the server or in the repository, for
example:src="/webtop/component/getcontent?
objectId=0900303980005172"The repository icon
Description
Since
5.x

html
html
Purpose
Generates HTML <html> open and close tags.
Attributes
doctype (Optional) Whether the W3C//DTD HTML 4.01

doctype (strict) or the W3C//DTD HTML 4.01
Transitional doctype (empty string) is used.
Default is an empty string.
Description
Since
5.x

iconwell
Purpose
Generates an HTML icon well that displays icons either horizontally or vertically and associates an
onclick event with the icon. This control replaces the component tabs in the 5.2.x locator components.
Each component that uses an iconwell control must configure it in the component definition.
Attributes
align (Optional) Horizontal alignment (the HTML

align attribute for the TD element).
if it is a link. Default is 0 (zero) pixels (that is,
no border).
iconwell
disabledbgimage (Optional) Overrides the image specified for the

disabled icon background in the component
definition.
highlightedbgimage (Optional) Overrides the image specified for the
highlighted icon background in the component
definition.
the JSP page.
normalbgimage (Optional) Overrides the image specified for
the normal icon background in the component
definition.
renderorientation (Optional) Whether the well of icons is oriented
vertically (vertical) or horizontally (horizontal).
Default is horizontal.
selectedbgimage (Optional) Overrides the image specified for
the selected icon background in the component
definition.
Description
Since
5.x

iconwell
Usage
The iconwell control can be used to render a group of icons that launch actions or components. The
set of icons is configured in the definition file for the component that includes an iconwell tag. This
allows you to have a different set of icons for each component. The iconwell configuration elements
are described below:
<component>
...
1 <iconwell>
<iconwellicon>
2<id>component_or_action_id</id>
3<icon>path_to_icon</icon>
4<label>string_or_nlsid_element</label>
5<tooltip>string_or_nlsid_element</tooltip>
</iconwellicon>
6<normalbgimage>path_to_background_image</normalbgimage>
7<disabledbgimage>path_to_disabled_background_image</disabledbgimage>
8<selectedbgimage>path_to_selected_background_image</selectedbgimage>
9<highlightedbgimage>path_to_highlighted_background_image</highlightedbgimage>
10<defaultid>component_or_action_id</defaultid>
</component>
The locator and locatorcontainer classes, Locator and LocatorContainer respectively,

add a configuration value that can be read by locator components. Add the element
<breadcrumbiconwellmode> and set the value to true to display the component name instead of the
repository name as the breadcrumb in a locator.
1 Contains configuration for the component icons

2 ID of an action or component that will be launched by the icon. This value must match the value of
the action or component ID in its XML definition.
3 Path within a theme directory to the icon. For example, a path of /icons/perspective/inbox32.gif
would map to a file at /root_directory/custom/theme/mytheme/icons/perspective\inbox32.gif. See
Web Development Kit Development Guidefor information on how themes are located.
4 Specifies a string value or <nlsid> element whose key represents a label for the icon
5 Specifies a string value or <nlsid> element whose key represents a tooltip for the icon
6 Path within a theme directory to the image that supplies the background for icons in the normal
(unselected and enabled) state
7 Path within a theme directory to the image that supplies the background for icons in the disabled
state (action not valid for user or context)
8 Path within a theme directory to the image that supplies the background for icons in the selected
state
9 Path within a theme directory to the image that supplies the background for icons in the
highlighted state (mouseover)
10 ID of an action or component that will initially selected when the iconwell is rendered (default
action or component)
image
image
Purpose
Generates an HTML image tag (<img>).
Attributes

tooltip and when the image fails to load.
no border).
cssclass (Optional) A cascading style sheet rule
enclosed in quotation marks; for example:
style="visibility: hidden"
height (Optional) Height of the image control.
the JSP page.
attribute values.
image
src (Optional) URL to the image on the server. Can

be a path on the server or in the repository, for
example: src="/webtop/component/getcontent?
objectId=0900303980005172". The repository
icon may affect performance.
style (Optional) Sets the cascading style sheet class
that is used to format this control.
width (Optional) Width of the image control.
Description
Since
5.x

option
option
Purpose
Contains a single static name/value pair entry. Use this tag inside a dropdownlist, listbox,
datadropdownlist, or datalistbox control. The name attribute is required. The value can be set on
the tag, or it can be passed in from a result set.
Attributes

data source.
the JSP page.
label (Optional) Text to display to the user in the drop
down list or list box.
labeldatafield (Optional) Overrides label with data from a data
source.
value (Optional) Value that is displayed in a drop
down list or list box.
Description
Since
5.x

radio
radio
Purpose
Generates an HTML radio element.
Attributes
cssclass (Optional) Sets the CSS class that is applied to

this control.
data source
group (Required) Group of radio buttons of which the
radio button is a member. Only one radio button
in the group can be selected at any one time.
the JSP page.
label (Optional) Label text for the radio button.
labelalign (Optional) Alignment of the radio button label.
Uses HTML text alignment attributes.
attribute is true).
radio

information.
information.
value (Optional) Whether the radio element is
displayed as selected (True) or deselected
(False).
Description
Since
5.x
span

Usage
The user can select only one radio widget in the group. To check which radio has been selected by the
user in your component class, check the state of each radio, similar to the following:
if (((Radio)getControl("ctrl1", Radio.class)).getValue())
{
// do something for ctrl1
}
else if (((Radio)getControl("ctrl2", Radio.class)).getValue())
{
// do something for ctrl2
}
span
Purpose
Generates HTML <span> open and close tags.
Attributes

datafld (Optional) HTML datafld attribute.
dataformatas (Optional) HTML dataformatas attribute.
datasrc (Optional) HTML datasrc attribute.
the JSP page.
table
Description
Since
5.x

table
Purpose
Generates HTML <table> open and close tags.
Attributes

border (Optional) HTML border attribute.
cellpadding (Optional) HTML cellpadding attribute.
cellspacing (Optional) HTML cellspacing attribute.
control.
datapagesize (Optional) HTML dir attribute.
frame (Optional) HTML frame attribute.
rules (Optional) HTML rules attribute.
summary (Optional) HTML summary attribute.
td
Description
Since
5.x

td
Purpose
Generates HTML <td> (table cell) open and close tags.
Attributes

the JSP page.
th

Description
Since
5.x

th
Purpose
Generates HTML <th> (table head) open and close tags.
Attributes

the JSP page.
title

Description
Since
5.x

title
Purpose
Generates HTML <title> open and close tags.
Attributes
None.
Description
Since
5.x

tr
tr
Purpose
Generates HTML <tr> (table row) open and close tags.
Attributes

height (Optional)
the JSP page.
Description
Since
5.x

pagenav
Document Image Services
pagenav
Purpose
For internal use only.
Attributes
actiontype (Optional) For internal use only.

controlid (Optional) For internal use only.
controltype (Optional) For internal use only.
id (Optional) For internal use only.
name (Optional) For internal use only.
onclick (Optional) For internal use only.
value (Optional) For internal use only.
Description
Since
6.0

param
Purpose
viewercontrol
Attributes

Description
Since
6.0

viewercontrol
Purpose
The Image Viewer Control is a wrapper WDK control that must be associated with an Image Viewer
provider, such as Daeja ViewOne Pro or Adobe Acrobat Reader.
Attributes
activeXClsid (Optional) Sets the classid attribute for an

ActiveX viewer control.
activeXDownloadUrl (Optional) Sets the codebase attribute for an
activeXMayscript (Optional) Sets the mayscript attribute for an
activeXScriptable (Optional) Sets the scriptable attribute for an
align (Optional) Sets the horizontal alignment of
applet text. The possible values of this attribute
are the same as those for the HTML IMG tag:
left, right, texttop, middle, absmiddle, baseline,
bottom, absbottom.
alt (Optional) Specifies text that should be displayed
if the browser understands the applet tag but
cannot run Java applets.
viewercontrol
archive (Optional) Sets the archive attribute for a Java

applet viewer control.
code (Optional) Sets the code attribute for a Java
codebase (Optional) Sets the codebase attribute for a Java
height (Optional) Controls height in the browser.
Should be set to 0 for a hidden control.
hspace (Optional) Margin, in pixels, for the right and
left sides of the control in the browser window.
the JSP page.
mayscript (Optional) Sets the mayscript attribute on a Java
applet running on Internet Explorer.
object (Optional) Sets the object attribute for a Java
objectId (Optional) The object ID of the document to
view from the viewer control.
provider (Optional) The viewer provider name. Currently,
only PAS, High Fidelity Forms, Daeja, Brava!,
and Acrobat Reader are supported.
vspace (Optional) Margin, in pixels, above and below
the control in the browser window.
width (Optional) Width of the control as displayed in
the browser.
Description
Since
5.x

Usage
To associate the control with an Image Viewer provider, you only need to map its APIs and
parameters appropriately. The Daeja ViewOne Pro Viewer is provided as a reference implementation.
The Image Viewer Control is a WDK control as defined below.
viewercontrol
<dmimg:viewercontrol
Provider=ProviderName
height=nnnwidth=nnnhspace=nnnvspace=nnn>
<dmimg:param name=name1 value=value1/>
<dmimg:param name=name2 value=value2/>
...
</dmimg:viewercontrol>
The Image Viewer Control can be embedded into a WDK form in a JSP page as:
<%@page contentType="text/html"%>
<%@ taglib uri="/WEB-INF/tlds/dmform_1_0.tld" prefix="dmf" %>
<%@ taglib uri="/WEB-INF/tlds/dmimaging_1_0.tld" prefix="dmimg" %>
<dmf:html>
<dmf:head>
<dmf:webform/>
<dmf:title>Documentum Image Viewer/dmf:title>
</dmf:head>
<dmf:body>
<dmf:form>
<dmimg:viewercontrol
Provider=Daeja
name="viewONE" id="viewONE"
width="1024" height="800"
hspace="0" vspace="0" align="middle">
objectId=xxxxxx
<dmimg:param name="demo" value="document"/>
...
</dmimg:viewercontrol>
</dmf:form>
</dmf:body>
</dmf:html>
Depending on the object type of the viewer and the kind of the browser used, the control will render
the viewer into appropriate HTML tags at runtime. The browser and platform requirements on the
client side depend on the chosen viewer. The Control will be rendered into different HTML tags
depending on the viewer provider. In the case of an applet, it will be rendered into:
<applet id=viewer1codebase=xxx.xxx.xxx>
<param name=name1value=value1/>
<param name=name2value=value2/>
...
</applet>
If the viewer provider is an ActiveX plug-in such as Adobe Acrobat Reader, it will be rendered into:
<object id=viewer2 >
<param name=codebase value=xxx.xxx.xxx>
<param name=name1value=value1>
<param name=name2value=value2>
...
</object>
Other tag attributes are standard attributes for the control such as id, name, height, width, codebase,
archive, etc.
Multiple Image Viewer controls with different types can be embedded in the same page or
component. You should also be able to swap the viewers for different document types based on your
configuration. To support this scenario, besides the tag, the specific Image Viewer Provider should
viewercontrol
add the Javascript function mappings during configuration time and the file should be included in
the HTML <Javascript>. The functions may look like:
<Script language=Javascript1.2>
Function {providername}_ nextpage( viewerid ){
// call Image Viewer Provider specific functions
}
Function {providername}_prevpage( viewerid ){
}
Function {providername}_goto( viewerid ){
}
...
</Script>
The {providername}in the function is used so that more than two different image viewers can be
embedded in one JSP page. Here is a list of third-party viewers:
Provider Control Type Name in WDK Control

Brava, by IGC ActiveX only; applet is no Brava
longer supported
ViewOne Pro, by Daeja Applet Daeja
Acrobat Reader, by Adobe ActiveX AcrobatReader
To map the viewer provider Javascript functions to the Image Viewer Framework during
configuration, it is convenient to have a schema for mapping the functions. The following is one of
the suggested XML formats and the detail can be updated after the implementation:
<?xml version="1.0"?>
<mapping>
<function name=nextpage>
<param name=controlId/>
<param name=page />
<providerinfo name=Daeja function=Daeja_nextpage />
<providerinfo name=Brava function=Brava_nextpage />
</function>

...
</mapping>
Since the Image Viewer WDK control is a standard WDK control, which is essentially derived from
Control and ControlTag classes, it comes with a number of common properties that enable JSP
configuration of the controls to utilize the WDK infrastructure:
• cssclassis used in the branding framework
• nlsidand tooltipnlsidare used in the locale framework
• datafieldand tooltipdatafieldare used in the databinding framework
• enabledand visibleare used in the action framework
Other common properties include:
• style
• id
• name
• onchange
viewercontrol
• focus
• tooltippandrunatclient
The <dmimg:param />tag is used to specify parameters used by the customized control depending
on what provider is chosen. This parameter will be rendered into a different html parameter tag
depending on whether the control is an applet or an object and which browser is being used.
The Image Viewer Control should have its own control type and be available to use in the Forms
Builder. The control will show as a black box at design time but the properties should be configurable
through the Forms Builder. Those properties will show as parameters of the control at runtime.
The Image Viewer Control will provide the following interfaces:
• The configuration parameters or attributes for the control itself. This includes parameters such as
archive, code, ObjectId, cabbase, viewer provider name, width, and height. These parameters
can be set through Forms Builder or at design time when the WDK form is embedded in a WDK
component through <init-controls>.
• The entries for setting up the server side handlers such as configuration service, document or page
service, annotation service, and document/page manipulation service. It should also include
the server side error notification handler. The service information can be preconfigured at the
application level such as app.xml because it is shared by all the Image Viewer Controls regardless
of the image viewer provider chosen.
• The common Javascript APIs included (but not limited to) are:
— OpenDoc(), CloseDoc()
— NextPage(), PrevPage()
— FirstPage(), LastPage()
— GotoPage()
— ToggleAnnotation()
— SaveAnnotation()
Within each function call, it will call viewer-specific functions depending on the viewer
provider chosen. The definition of those functions can be preconfigured or mapped through the
configuration administrator.
To add a new viewer provider to the WDK application:
1. Set up the viewer-related attributes, such as the viewer file path containing JAR, OCX, and
any related files.
2. Provide the viewer Javascript API function mapping file. For example, the Daeja.js file contains
all the necessary function mappings needed for Document Image Services if using the Daeja
ViewOne Pro viewer.
To associate the control with an Image Viewer provider in a WDK form, you only need to:
1. Specify the provider name, e.g., Daeja or Brava.

2. Provide any custom parameters the viewer needs. The framework will provide some parameters
by default. Due to the diversity of the viewers, the new parameters must be added during
implementation when it is necessary.
viewercontrol
To configure the provider-specific attributes, which include codebase, main Java class name, archive,
code, cabbase, etc., the following code sample shows the proposed XML format. All the attributes can
be specified in a configuration XML file for all the viewer providers.
<IvfConfiguration>
<ViewerProviders>
<ViewerProvider name=Daeja>
<param>
<name>codebase</name>
<value>mycodebase path</value>
<description>xxxx</description>
</param>
<!-other parameters->
</ViewerProvider>
<ViewerProvider name="Brava">
... ...
</ViewerProvider>
</ViewerProviders>
</IvfConfiguration>
The Image Viewer Control will retrieve the information to populate the control at runtime. Those
parameters can always be overwritten by providing customized values in <viewercontrol>. For
more details on the Image Viewer Control parameters, see Table 12, page 210.
As with other WDK controls, the Image Viewer Control can be associated with a viewer component
in the typical manner. There are some default configuration setting that can be set through the
<init-controls>configuration element, as shown in the following code sample:
<component id=...>
...
<init-controls>
<control name=myimageviewer
type=com.documentum.imaging.control.ImageViewerControl>
<init-property>
<property-name>Provider</property-name>
<property-value>Daeja</property-value>
</init-property>
</control>
... ...
</init-controls>
</component>
Other configuration settings for the component should be set by following the existing WDK standard.
The Image Viewer Control parameters are defined in the ivf_config.xml file, as follows:
Table 12. Image Viewer Control Parameters
Parameter Value Description

_EnableThumbnails viewmode For Daeja, use viewmode,
but can also indicate position
choices for thumbnails such
as thumbsleft, right, or
top. For Brava, just use
_EnableThumbnails with a
value of True or False. One
mapping is sufficient.
_filename filename For Daeja, use filename.
xformsdatasortlink
Parameter Value Description

_ObjectId filename ObjectId will be converted
to filename if the _filename
parameter does not exist.
Otherwise, there is no effect.
_BaseURL baseUrl This is not needed by Daeja,
but it is used internally in the
control class.
_ReadOnly ReadOnly For Daeja, use helpURL.
_ImageSaveHandler ImageSavePost Save with type=image or
type=annotation. Daeja uses
imageSavePost.
_ConfigHandler ConfigHandler Retrieves the settings in XML
format, but none of the viewers
support it.
_EventHandler eventhandler For Daeja, use eventhandler.
_EventFilter eventInterest Returns interested events only.
Daeja uses eventInterest.
_AnnotationEncoding annotationEncoding Daeja uses UTF8.
_EnableAnnotation annotate Daeja uses annotate.
_EnableAnnotationEdit annotateEdit Daeja uses annotate.
_EnableCache ACMEnabled Daeja uses ACMEnabled.
_CachePath cachePath Daeja uses cachePath.
_BackgroundColor backcolor Daeja uses backcolor.
_EnablePrinting defaultprintdoc Daeja uses defaultprintdoc.
_EnableMagnifier externalMagnifier Daeja uses externalMagnifier.
_HelpURL helpURL Daeja uses helpURL.
xformsdatasortlink
Purpose
xformslistvalueformatter
Attributes
column (Optional) For internal use only.

cssclass (Optional) For internal use only.
datafield (Optional) For internal use only.
enabled (Optional)For internal use only.
forwardicon (Optional) For internal use only.
icon (Optional)For internal use only.
label (Optional) For internal use only.
mode (Optional) For internal use only.
name (Required) For internal use only.
nlsid (Optional) For internal use only.
onclick (Optional) For internal use only.
reverseicon (Optional) For internal use only.
reversesort (Optional) For internal use only.
runatclient (Optional) For internal use only.
style (Optional) For internal use only.
visible (Optional) For internal use only.
Description
Since
6.0

xformslistvalueformatter
Purpose
viewerframework
Attributes

Description
Since
6.0

viewerframework
Purpose
Since
6.5
Including components
componentinclude
Purpose
Includes a component within a form. If the component to be included is a container, you must use
containerinclude instead of componentinclude.
containerinclude
Attributes
component (Required) ID of component to include.

the JSP page.
page (Optional) Name of the component start page.
Description
Since
5.x

containerinclude
Purpose
Used in a container JSP as a placeholder for the contained components. The contained components
are specified in the container XML definition file.
Attributes

the JSP page.
forminclude
Description
Since
5.x

Including other pages
forminclude
Purpose
Includes the contents of another form at the point of the tag insertion.
Attributes
formclass (Required) Java class containing the event

handler functions called when events are fired
in the included JSP page.
the JSP page.
nlsbundle (Optional) NLS bundle used by all the controls
in the included form.
nlsclass (Optional) Java NLS class used by all the controls
in the included form.
src (Required) JSP file to be included.
fragment
Description
Since
5.x

fragment
Purpose
Includes a fragment of a JSP page in the current page. The actual fragment that is dispatched at
runtime is dependent on the client environment (clientenv).
Attributes

the JSP page.
src (Optional) Absolute or relative path to the
fragment: Absolute path Use an absolute
path to always include the same fragment
regardless of runtime context. An absolute path
begins with "/, such as src=/wdk/fragments/
modal/ModalContainerStart.jsp. Relative path
Use a relative path to dispatch a fragment
based on runtime context. For example,
src=modal/ModalContainerStart.jsp.
Description
Since
5.x
tagpooldetector

Usage
The user’s clientenv context and the fragment bundle lookup mechanism that is used for runtime
dispatching are described in detail in Web Development Kit Development Guide.
Internal use only
tagpooldetector
Purpose
Attributes
value (Required) For internal use only.
Description
Since
6.0

webcontainerrequirements
Purpose
componenturl
Attributes
None.
Description
Since
6.0

Links
componenturl
Purpose
Component navigation URL (link). Use the argument tag to pass arguments and set the context.
Attributes
component (Required) Target component to be displayed.

the JSP page.
label (Optional) String to display as the link.
page (Optional) Component page to display.
inlinewebform
target (Optional) Name of the target frame.

Description
Since
5.x

inlinewebform
Purpose
Forces the JSP engine to buffer the output stream for webform controls and clear the buffer before a
jump or nest to another component. This tag is required for portlets. Error messages are forwarded to
the portal’s registered error handler.
Attributes
None.
Description
Since
5.x

Usage
A wrapper JSP page, /wdk/inlinewebform.jsp, contains the <dmf:inlinewebform> tag, which redirects
to the actual target URL. The wrapper page is called by the <dmf:form> tag for portal environments.
You do not need to add this tag to every JSP pages that is used in your portal application. The
wrapper page will be called transparently for all pages containing a <dmf:form tag> in an application
uses a portal environment.
link
link
Purpose
Generates a hyperlink to an event handler.
Attributes

datafield (Optional) Overrides the label and nlsid
attributes with a string from a data source.
control.
the JSP page.
label (Optional) Label for the link.
attribute is true).
information.
information.
link

tooltipdatafield (Optional) Datafield that overrides the values of
the tooltip and tooltipnlsid attributes.
Description
Since
5.x

open
open
Purpose
Opens a URL with the specified URL and optional event. Can be an external HTML page.
Attributes

datafield (Optional) Overrides the label attribute to
display a label for the link. For example:
uridatafield=’<%=SearchResultSet.ATTR_
URL%>’
the JSP page.
label (Optional) String or NLSID to display as a label.
options (Optional) HTML options for the new browser
window.
sendcontext (Optional) Whether to add context to the URI
(True) or not (False). For external targets, set this
attribute to false.
open

target (Optional) Target window. Default is
_wdkChild.
tooltipdatafield (Optional) Datafield that overrides the values of
the tooltip and tooltipnlsid attributes.
uri (Optional) URI for the new window. This
URI can be supplied by a component class
or externalized to the component definition.
For example: uri;’http://localhost:8080/wdk/
component/inboxdrilldown’
uridatafield (Optional) Datafield that supplies the URI;
overrides the uri attribute.
Description
Since
5.x

colorpicker
Media and transformation
colorpicker
Purpose
Displays a colored bar that allows user to select a color value from 216 colors. The colorpicker GIF is
located in images/color/colorpicker.gif. This control’s attributes are set by the Media Transformation
Services component transformationdetails. The component has settings for the colorpicker control
attributes that override the defaults shown below.
Attributes
colorvalue (Optional) Initial RGB color value before

selection; for example, 76fa34. Default = null
height (Optional) Height of the colorpicker display.
Default is 20 pixels.
the JSP page.
numberofrows (Optional) Number of rows in the colorpicker.
Default is 12.
thumbnail

width (Optional) Width of the colorpicker display.
Default is 100 pixels.
Description
Since
5.x

thumbnail
Purpose
Displays a small (maximum 100x100 pixel) thumbnail image generated and stored on the thumbnail
server, which is integrated with a Content Server.
Attributes

no border).
datafield (Optional) Overrides the objectid attribute with
data from a data source.
height (Optional) Height of the image control.
the JSP page.
label (Optional) Overrides the alttext attribute.
thumbnail

objectid (Optional) ID of the object for which to find the
thumbnail image.
width (Optional) Width of the image control.
Description
Since
5.x

transformationparameter
transformationparameter
Purpose
Displays parameters for media profiles (dm_media_profile type) such as ike font size, color, width,
and height. Media profiles are located in /System/Media Server in repositories that have installed
Media Transformation Services.
Attributes

Description
Since
5.x

Usage
The control data is set at runtime from a component by setting its dataprovider with a TopicResultSet
of data that makes up the topic. For example:
public void setTopicControl(
ITopic topic, String[] attributes)
{
topicData = new TopicResultSet(attributes, topic);
Topic topicControl = (Topic)getControl(
CONTROL_TOPIC, Topic.class);
DataProvider dataProvider = topicControl.getDataProvider(
);
dataProvider.setScrollableResultSet(topicData);
}
menu
Menu grouping
menu
Purpose
Generates a JavaScript menu or sub-menu. This tag must be contained within a menugroup tag.
Menus can also be generated from <actionlist> elements within an action configuration file for an
object type.
Attributes
accessible (Optional) Whether to enable (True) or disable

(False) accessible mode. Menus are not
displayed in accessible mode.
configid (Optional) Will be deleted soon. Was to support
configurable menus.
height (Optional) Height of this control. This value is
ignored for graphic menus.
horizontal (Optional) Whether menu items are horizontal
(True) or vertical (False). If this attribute value is
empty or invalid, then the left.gif, right.gif and
bg.gif label graphics are displayed or, if they are
not found, a normal label is displayed instead of
an image label. Default is false.Since 6.0.
the JSP page.
value (Optional) Menu title.
menuconfig

width (Optional) Width of the control. Default is the
length of the value attribute’s string.
Description
Since
5.x

menuconfig
Purpose
Displays a menu defined in a menu configuration file (an XML file that contains a
config/scope/menuconfig element structure).
Attributes
id (Required) ID of the config/scope/menuconfig

element to display.
Description
Since
6.0

menugroup
menugroup
Purpose
Specifies the visual appearance of nested menu tags.
Attributes

imagefolder (Optional) Folder in which the label graphics
are stored. If left.gif, right.gif and bg.gif are not
found, a normal label is displayed instead of an
image label.
menubarclass (Optional) Class that defines the normal style of
a menu bar (menu button). The default class is
named menubar.
menubardisabledclass (Optional) Class that defines the style used
when the menu is disabled.
menubarhighlightclass (Optional) Class that defines the highlighted
menu bar.
menuclass (Optional) Class that defines the normal style
of a popup menu. The default class is named
menu.
menudisabledclass (Optional) Class that defines the style used
when the menu is disabled.
menuhighlightclass (Optional) Class that defines the highlight style
of the selected menu item. The default class is
named menuHighlight.
menuseparatorclass (Optional) Class that defines the separator style.
The BACKGROUND-COLOR specifies the
separator color.
menugroupactionmap
render (Optional) Kind of HTML element to render.

Valid value is: button. A value of button causes
the menu bar to be rendered as an HTML
button. If this attribute’s value is invalid, the
default behavior is applied. Default is .Since 6.0.
target (Optional) Name of the frame in which the
popup is to be displayed. By default, the popup
is displayed in the same frame.
Description
Since
5.x

menugroupactionmap
Purpose
Used by components in the Application Connectors (appintg) environment to create an action map
and return it to the authoring application in the form of an event argument.
Attributes

the JSP page.
menugroupid (Required) Menu that is defined in the
<menugroupid> element of the appintgcontroller
menugroupconfig
Description
Since
5.x

menugroupconfig
Purpose
Generates the initial menu map that is passed to the Application Connector authoring application.
Attributes

the JSP page.
menugroupid (Required) Menu that is defined in the
<menugroupid> element of the appintgcontroller
Description
Since
5.x

menuitem
menuitem
Purpose
Renders a menu item. Must be used within a menu tag.
Attributes

control.
the JSP page.
imageicon (Optional) URL to an image to display on the
left-hand side of the menu item. Do not include
the custom folder in the URL.
attribute is true).
value (Optional) Menu item text.
menuseparator
Description
Since
5.x

menuseparator
Purpose
A menu separator control used within menu.
Attributes

the JSP page.
Description
Since
5.x

bookmarklink
Navigational aids
bookmarklink
Purpose
Generates an icon that the user can click to create an Internet Explorer or Firefox favorite to a DRL for
an object.
Attributes

datafield (Optional) Link text; overrides the nlsid and
label attributes.
href (Optional) Target of the link. Default is the drl
component.
the JSP page.
label (Optional) Link text.
name are automatically indexed..
runatclient (Optional) Behavior unknown.
bookmarklink

localized tooltip string.Since 6.0: In Internet
Explorer, Drag to desktop, email or document
to create link, or click to Add to Favorites is
displayed;. In FireFox, Click to Add to Favorites
is displayed.
Description
Since
5.x

Usage
Because this control requires JavaScript, it is only available in Internet Explorer and Firefox.
In FireFox, the bookmark is initially created to load in the sidebar. If user wants the bookmark to
open on the main page, the user must uncheck the Load this bookmark in the sidebar checkbox in
the bookmark’s properties.
breadcrumb
breadcrumb
Purpose
Displays a web-style navigation path (breadcrumb) that a user can click to navigate.
Attributes

displayleaf (Optional) Whether to display leaf cells when
they are selected (True) or not (False).
the JSP page.
leafcssclass (Optional) CSS class to display for a breadcrumb
leaf.
onchange (Optional) Event that is fired when the user
clicks on the breadcrumb. This event is not
handled immediately. It is handled on the server
only when the form is submitted. The onchange
attribute is true).
onclickroot (Optional) Event to be fired when the user
clicks the first link in the breadcrumb control.
This event is handled only if a relative path is
displayed.Since 6.0.
separator (Optional) Character to separate each path
element.
breadcrumb

value (Optional) Current path displayed by the
breadcrumb.
Description
Since
5.x

Usage
These topics are included:
• Navigation path changes from absolute to relative, page 239
• Global configuration, page 238
Global configuration
You specify global configuration for all instances of the breadcrumb control in the
wdk/config/breadcrumbcontrol_config.xml file. You can configure these elements:
Element Description
breadcrumbcontrolconfig Contains configuration elements.
displayleaf Whether a breadcrumb control should show its
leaf (current folder).
formurl
Element Description
leafcssclass CSS class to be used to display the leaf. If
<displayleaf> is set to true and no value is
supplied for <leafcssclass>, the breadcrumb class
is used to display the leaf.
breadcrumbserviceconfig This XML structure is used to configure the
BreadcrumbService class.
Parent: scope
Children:enablerelativepath
Since 6.0.
enablerelativepath Boolean: Whether to enable relative and absolute

paths (True) or only absolute paths (False).
Parent: breadcrumbserviceconfig
Children: None.
Since 6.0.
Navigation path changes from absolute to relative

Since 6.0.
By default, the navigation path starts from a top-level node in the browser tree (that is, an absolute
path). When a user jumps to a location from a component specified in the relativepathcomponents
element structure in the wdk/config/breadcrumbcontrol_config.xml file, the path changes to start
from the component (that is, relative to the componentnot absolute from a top-level node).
For example, when a user clicks Folder A on the Search Results page, Search/Folder A is displayed
for the navigation path. Then, the user clicks Folder B in Folder A, the navigation path is displayed
as Search/Folder A/Folder B.
The navigation path changes from a relative path to an absolute path when the user performs one
of these actions:
• Clicks a node in the browser tree (when the browser tree is not the virtual document manager)
• Clicks an object in the Versions, Relationships, Renditions, Locations views
• Clicks a container in the Search Results page (when row selection is off).
formurl
Purpose
Generates a form navigation link (URL). The argument tag can be used to pass arguments to the form.
primaryfolderpathlink
Attributes
cssclass (Optional) CSS class fo apply to this control.

the JSP page.
label (Optional) Text displayed as the link.
target (Optional) Target frame to display the form.
Default is the current frame.
url (Required) Form JSP file. For example,
url=’<%=strContextPath + "/wdk/samples/
control_pen/formurlPen.jsp"%>’
Description
Since
5.x

Purpose
Displays for a given sysobject the first full primary folder path on which the user has full browse
permissions on all parts of the path. If the sysobject id refers to a cabinet, the rendered parent folder
path is ’/’.
Attributes

datafield (Optional) Datafield that supplies the folder
path.
label (Optional) Folder path (truncated or full) to
display for the link.
clicks the folder path link. This event is handled
showfullpath (Optional) Whether to render the whole path
(True) or to truncate it (False) when the path
exceeds four folders. When the path is truncated,
an ellipses (...) is displayed to represent the
truncated folder names and only the first two
folder names (including the cabinet) and the last
two folder names are displayed. For example:
/cabinet/folder1/.../folder4/folder5.
filebrowse

Description
Since
5.x

Object and file selection
filebrowse
Purpose
Launches a file browser on the user’s system.
Attributes

is True.
"keyword or "title.
filebrowse
datafield (Optional) Overrides the label or nlsid attribute

on the browse button with data from the data
dictionary.
control.
fileupload (Optional) Whether to upload the file when a file
path is specified and a form submitted (True)
(also called, upload mode), or to upload the file
name only and not the file contents (False) (also
called, default filename only mode).
the JSP page.
the label on the browse button.
onchange (Optional) Server-side event handler.
onselect (Optional) Event fired when the user selects a
file. This event is handled immediately on the
server (when the runatclient attribute is false)
is true).
runatclient (Optional) Whether the onselect event is to run
size (Optional) Size of file browser control.
filebrowseapplet

value (Optional) File name, including path, selected in
the browser.
Description
Since
5.x

filebrowseapplet
Purpose
Launches a file selector applet for selecting a file on the user’s local system.
fileselectorapplet
Attributes

the JSP.
name (Optional) Sets the name for the control. Named
onselect (Optional) Specifies the event to fire when a file
has been selected.
runatclient (Optional) Specifies that the event should run on
the client, not the server. The onchange event
cannot run on the client.
Description
Since
6.6

fileselectorapplet
Purpose
Generates a file selector for browsing to a file on the user’s local system. The user can drag files or
directories onto the browser when the applet is loaded, and the files will be imported. This applet is
used in the importcontainer component.
Attributes
align (Optional) Horizontal alignment of applet

text. Valid values are the same as those for the
alt (Optional) Text to be displayed when the
browser understands the applet tag, but cannot
run Java applets.
fileselectorapplet
fileselect (Optional) Whether to enable selecting files

folderselect (Optional) Whether to enable adding directories
(True) or not (False). Must be true to enable drag
and drop of folders.
folderselectmode (Optional) Specifies how folder contents are
selected. Valid values are: root Only the current
folder node is selected; descendants are not
selected. tree The root folder and all its children
are selected, including their folder structure.
contents (Default) Only the files contained in the
folder are selected.
height (Required) Height of the applet.
hspace (Optional) Margin (n pixels) for the right and
left sides of the applet in the browser window.
the JSP page.
launchonstart (Optional) Dialog box to display when the
applet is started. Valid values are: selectFolders
Select Folders dialog box. selectFiles Select Files
dialog box. null No dialog box is launched. If
the attribute value collides with the fileselect or
folderselect attributes, then no action is taken.
multiselect (Optional) Whether to enable multiple file
selection (True) or not (False).
object (Optional) Object to be serialized and encoded
as a string.
onfileselect (Optional) Event to fire when a file has been
selected.
showbuttonpanel (Optional) Whether to show the Change button
for HTTP import (True) or not (False).
vspace (Optional) Margin (in pixels) above and below
the applet in the browser window.
width (Required) Width of the applet.
Description
Since
5.x
folderselectionvalidator

Usage
The file selector applet look and feel is configured in the fileSelectorAppletStyle.properties file
located in the /theme/css directories of each application layer. The image paths for the file
selector are specified in /WEB-INF/classes/com/documentum/web/form/control/fileselector/
FileSelectorImageProp.properties.
folderselectionvalidator
Purpose
Ensures that the user has sufficient permission to select the folder and to import into it. Checks
user permission and folder security. For example, in the import component, this control validates
the multidocbasetree control.
Attributes

the JSP page.
Description
Since
5.x
booleanformatter

Output formatting
booleanformatter
Purpose
Wraps a boolean value with a formatted ouput, such as True, T, False, or F.
Attributes
falsenlsid (Optional) ID of the NLS key to look up the

string for false.
truenlsid (Optional) ID of the NLS key to look up the
string for true.
Description
Since
5.x

docformatvalueformatter
Purpose
Wraps a raw Documentum format code, such as msw97, with a full description of the format from the
data dictionary (in this example, Microsoft Word 97).
docsizevalueformatter
Attributes

the JSP page.
Description
Since
5.x

docsizevalueformatter
Purpose
Wraps a raw Documentum object size value, such as 12500.0, with a formatted value in KB or MB as
appropriate (in this example, 12.5 KB).
Attributes
datafield (Optional) Overrides the type attribute.

type (Optional) Object type. If set to a value of
dm_folder or one of its subtypes, the formatter
displays a blank value instead of 0 KB for objects
of the specified object type.
Description
Since
5.x
folderexclusionformatter

folderexclusionformatter
Purpose
Excludes the contents if the object type is folder. Can be used to hide inappropriate attributes for
folders, such as version or authors.
Attributes
datafield (Optional) Datafield that supplies the folder

object type.
the JSP page.
type (Optional) Folder object type.
Description
Since
5.x

htmlsafetextformatter
Purpose
Formats text into HTML safe form by replacing strings that may be misinterpreted by the browser,
such as <, >, &, newline characters, and single and double quotes.
messageaddressformatter
Attributes

the JSP page.
Description
Since
5.x

messageaddressformatter
Purpose
Formats the addresses in dm_message_route objects related to a dm_message_archive object.
Attributes
datafield (Required) Attribute to be formatted; for

example, to_addr, cc_addr, bcc_addr.
Description
Since
6.0

multilinestringlengthformatter
multilinestringlengthformatter
Purpose
Formats strings that span multiple lines.
Attributes

the JSP page.
lineseparator (Optional) Line separator in the string to be
formatted.
lineseparatoroutput (Optional) Line separator to be used in the
output string.
maxlen (Optional) Maximum length of the string after
which it is truncated.
maxlennlsid (Optional) Localized value of maxlen (integer).
You can have a different maximum length for
strings depending on locale.
postfix (Optional) Postfix string appended to the
truncated string, for example, ’’.
postfixnlsid (Optional) Localized value of postfix string.
showastooltip (Optional) Whether the untruncated value is to
be shown as a mousever tooltip when the string
gets truncated (True) or not (False). Default is
true.
wrapped (Optional) Whether the maxlen attribute applies
to the entire string (False) or to each word in the
string (True). For example, if maxlen=’5’ and
wrapped=’true’, the string "hello world" would
not be truncated, because the string can wrap
between words and no word exceeds the length
of 5. If wrapped=’false’, the string would be
truncated after "hello".
noopformatter
Description
Since
5.x

noopformatter
Purpose
Prevents the label string of this control’s child tag from being escaped.
Attributes

the JSP page.
Description
Since
6.0

numberformatter
Purpose
Formats numeric data that is returned in result sets as doubles, including integer and float values.
objectidformatter
Attributes
blankifzero (Optional) Boolean: Whether a 0 (zero) is to

be formatted as an empty space (True) or not
(False).
format (Optional) Format mask for the display, for
example, format="$###.##"
the JSP page.
type (Required) Type of number. Valid values
are: integer, percent, or float (currency is not
implemented).
Description
Since
6.0

objectidformatter
Purpose
Formats attributes stored as r_object_id to names (for example, user_name, object_name,
group_name).
policystatenameformatter
Attributes
datafield (Required) Column to be used as the value for

the control.
the JSP page.
Description
Since
6.0

policystatenameformatter
Purpose
Displays the state name using the policy ID.
Attributes
datafield (Required) Datafield that provides the state

name.
the JSP page.
rankvalueformatter
Description
Since
5.x

rankvalueformatter
Purpose
Wraps a raw score (from 0.0 to 1.0) of a Verity search (pre-5.3 repository only) with a formatted
HTML table containing a score bar graph. The ranking is based upon the number of occurrences
of the search string in a given object’s content or attributes and indicates the relevance of objects
returned by a search.
Attributes

the JSP page.
Description
Since
5.x

stringlengthformatter
stringlengthformatter
Purpose
Truncates a string and provides a mouseover popup that contains the untruncated string.
Attributes

the JSP page.
maxlen (Optional) Maximum length of the string after
which it is truncated.
maxlennlsid (Optional) Localized value of maxlen (integer).
You can have a different maximum length for
strings depending on locale.
postfix (Optional) Postfix string appended to the
truncated string, for example, ’’.
postfixnlsid (Optional) Localized value of postfix string.
showastooltip (Optional) Whether the untruncated value is to
be shown as a mousever tooltip when the string
gets truncated (True) or not (False). Default is
true.
wrapped (Optional) Whether maxlen applies to the
entire string (False) or to each word in the
string (True). For example, if maxlen=’5’ and
wrapped=’true’, the string "hello world" would
not be truncated, because the string can wrap
between words and no word exceeds the length
of 5. If wrapped=’false’, the string would be
truncated after "hello".
Description
Since
5.x

termshighlightingformatter
termshighlightingformatter
Purpose
Formats a document by highlighting matching terms (exact matching and case insensitive). Ignores
text between "< > characters.
Attributes

datafield (Optional) Overrides the values of the terms
attribute
the JSP page.
separator (Optional) String to be used between two
matching terms
terms (Optional) List of terms to be highlighted
visible (Optional) Boolean: Whether this control is
Description
Since
5.x

yesnovalueformatter
Purpose
Formats Yes/No values. Provides the facility to add a locale specific textual description to a Yes/No
value.
argument
Since
6.5
Passing arguments
argument
Purpose
Generates arguments that are passed to a control’s event handler.
Attributes

data from a data source. If the data source is
not available, a null value is used.(Optional)
Overrides the value attribute with data from a
data source. If the data source is not available, a
null value is used.
the JSP page.
name (Required) Name of this control. Named controls
name are automatically indexed.(Required)
Name of this control. Named controls are
cached on the server. Controls with the same
the value attribute value.(Optional) NLS lookup
key. The string corresponding to the NLS ID is
substituted for the value attribute value.
value (Optional) Argument value.(Optional)
Argument value.
argument
Description
Since
5.x

argument
Purpose
Generates arguments that are passed to a control’s event handler.
Attributes
contextvalue (Optional) Overrides the datafield attribute.

data from a data source. If the data source is
not available, a null value is used.(Optional)
Overrides the value attribute with data from a
data source. If the data source is not available, a
null value is used.
name are automatically indexed.(Required)
Name of this control. Named controls are
cached on the server. Controls with the same
the value attribute value.(Optional) NLS lookup
key. The string corresponding to the NLS ID is
substituted for the value attribute value.
value (Optional) Argument value.
Description
Since
5.x
password

Passwords
password
Purpose
Text control whose characters are displayed as * in the browser.
Attributes

control.
forcereenter (Optional) Whether, when the password control
is re-drawn, the text in it is deleted (True) or not
(False). Deleting the text in the password control
forces the user to re-enter a password.
the JSP page.
onchange (Optional) Server-side event handler. This event
is fired after the form is submitted.
password
required (Optional) Whether to force the user to provide

input to the password control on login before
the authentication service is invoked (True) or
not (False). Default is true. If this attribute
is set to false, you must also remove the
requiredfieldvalidator tag for the password
control on the login JSP page.
size (Optional) Length of the password control.
value (Optional) Value stored in the control and
displayed in the password control.
Description
Since
5.x
attributeselector

Preferences
attributeselector
Purpose
Displays a list of attributes from which the user can compose and order items. The items are either a
list passed into the control or the attributes of a selected object type. Control state is manipulated on
the client and passed to the server via a hidden field when the page is submitted. This control is used
in the columnselector component to select attribute columns for display.
Attributes
buttoncssclass (Optional) CSS class to apply to button

appearance.
buttoncssstyle (Optional) CSS rule to apply to button
appearance.
buttonheight (Optional) Height (in pixels) of the button.
buttonimagefolder (Optional) Location of the image folder, if
buttons are used to display items.
buttonwidth (Optional) Width (in pixels) of the button.
disabledclass (Optional) CSS class to apply to the disabled
control.
(enclosed in quotes) to apply to a disabled item.
docbasetypes (Optional) Comma-delimited list of the object
type names to display in the Docbase types
dropdown list.
docbasetypeslabel (Optional) Label to be displayed for the Docbase
type dropdown list.
docbasetypesnlsid (Optional) NLS string to be displayed as label
for the Docbase type dropdown list.
the JSP page.
attributeselector
items (Optional) Serialized list of items to be displayed

in the available items listbox. This list is
supplied when the user selects an object type
or by the component class. The default list
before selection is provided by the component
definition, in the <columns> element.
itemslabel (Optional) Label for the available items list.
itemsnlsid (Optional) NLS string for the available items list
label.
listboxcssclass (Optional) CSS class to apply to lisboxes.
listboxcssstyle (Optional) CSS rule to apply to listboxes.
listboxwidth (Optional) Width of the listboxes.
orderingenabled (Optional) Whether to enable up and down
buttons that change the order of the list (True) or
not (False). Default is true.
selecteditems (Optional) Serialized list of items to be displayed
in the selected items listbox.
selecteditemslabel (Optional) Label for the selected items list.
selecteditemsnlsid (Optional) NLS string for the selected items list
label.
showlabels (Optional) Whether to display data dictionary
labels (True) or the actual names (False) of object
types and attributes.
showrepeatingattributes (Optional) Whether to display repeating
attributes when displaying all the attributes for
a given type (True) or not (False).
size (Optional) Size of the listboxes. Default is 10.
Description
Since
5.x

Usage
A serialized list of items can be an array of one string (value) or two strings (value and label). By
default, the list of items to be displayed is provided by the component definition, in the columns
authoringapplicationformatter
element. For example, the drilldown component definition specifies that the object_name attribute
will be displayed but the title attribute will not, in the following excerpt:
<columns>

<column>
<attribute>object_name</attribute>
<label><nlsid>MSG_NAME</nlsid></label>
<visible>true</visible>
</column>
<column>
<attribute>title</attribute>
<label><nlsid>MSG_TITLE</nlsid></label>
<visible>false</visible>
</column>
...
</columns>
authoringapplicationformatter
Purpose
Displays the string, "Web Browser", if the authoring application opens in a browser (that is, a
system inline application), the string, "Default Application" if it opens in a desktop application
(that is, a system default application), otherwise, it displays the path to the authoring application
on the user’s local machine.
Attributes

Description
Since
6.0

columnlist
columnlist
Purpose
Attributes
columnlabel (Optional) For internal use only.

columnnlsid (Optional) For internal use only.
columns (Optional) For internal use only.
columnsparamname (Optional) For internal use only.
defaultselectedcolumns (Optional) For internal use only.
defaultselectedcolumnsparamname (Optional) For internal use only.
docbasetypes (Optional) For internal use only.
editcomponent (Optional) For internal use only.
editcontainer (Optional) For internal use only.
enabled (Optional) For internal use only.
inheritinglabel (Optional) For internal use only.
inheritingpreference (Optional) For internal use only.
inherits (Optional) For internal use only.
namelabel (Optional) For internal use only.
namenlsid (Optional) For internal use only.
selectedcolumns (Optional) For internal use only.
selectedcolumnsparamname (Optional) For internal use only.
showrepeatingattributes (Optional) For internal use only.
preference
Description
Since
5.x

preference
Purpose
Displays a preference for a component and saves user entries. This control embeds a columnlist
control that generates a label and value in each row and, optionally, a description label below this row.
Attributes

datafield (Optional) Datafield that provides a preference
to be displayed. Overrides the value and
preferenceid attributes.
the JSP page.
preferenceid (Optional) ID of the preference to be retrieved.
One of the following attributes must have a
value: preferenceid, datafield, or value.
scopeid (Required) Name of the preferencescope control.
value (Optional) Preference to be displayed; overrides
the preferenceid attribute.
preferencedisplaygroups
Description
Since
5.x

Usage
The preference control instantiates the columnlist control and provides the label to display the current
column selection and a link that nest to the Column Selector component to modify the list of columns.
Preferences for a component, and default preference values, must be defined in the component
Configuration file, within a <preferences> element. See Web Development Kit Development Guidefor
more information on defining component preferences. User preferences that apply across
components are defined in the general preferences component.
Purpose
Renders preferences that have display group configuration definitions in the
<preferencedisplaygroups> element of a component definition (for example, the display_preferences
component definition). This control loops around the preference groups defined in
<preferencedisplaygroups> element and renders the enclosed body content for each iteration.
Attributes

the JSP page.
prefidattrname (Required) Value of this attribute defines the
name of the page context attribute in which the
current preference id is stored.
scopeid (Required) Value of this attribute is used

to bind the preferencedisplaygroup to the
preferencescope control and has essentially
the same role as the scopeid on the preference
control (which defines the scope for the
preferencedisplaygroup configuration lookup).
scopeidattrname (Required) Value of this attribute defines the
name of the page context attribute in which the
scopeid for the preferencedisplaygroup tag is
stored.
Description
Since
5.x

Usage
Preference can be displayed in groups. The following elements can be added to the component
definition to display groups:
<preferencedisplaygroups>
<group id=xxx>
<members>
<preference-ref id=a1 />
...
</members>
<label><nlsid>MSG_FOO</nlsid></label>
</group>
<group id=yyy>
...
</group>
...
</preferencedisplaygroups>
The order of groups and the order of preferences inside a group controls the display of preference
groups. The preference-ref element must have an ID that matches an existing preference id in the
<preferences> element of the component definition. The group <label> is used for rendering the
group title.
preferencescope
preferencescope
Purpose
Used internally by the preference control to retrieve preference data. This control is hidden on the
JSP page, which must contain one or more preference controls.
Attributes
componentid (Optional) For internal use only.

context (Optional) For internal use only.
defaultscope (Optional) For internal use only.
enabled (Optional) For internal use only.
focus (Optional) For internal use only.
height (Optional) For internal use only.
onchange (Optional) For internal use only.
onselect (Optional) For internal use only.
runatclient (Optional) For internal use only.
tabindex (Optional) For internal use only.
tooltip (Optional) For internal use only.
tooltipnlsid (Optional) For internal use only.
userlevelprefscomponent (Optional) For internal use only.
width (Optional) For internal use only.
Description
Since
5.x

docbasefoldertree
Usage
This control should not be used independently. It is called by the WDK preferences framework.
Repositories
docbasefoldertree
Purpose
Generates a folder tree hierarchy of the cabinets and folders in a repository. Set the limit
for number of folders to be displayed in the tree in the Environment.properties file (in
/WEB-INF/classes/com/documentum/web/formext). Larger numbers are replaced with a More
Folders link.
Attributes
cachechildren (Optional) Whether children are cached when

nodes are collapsed. Default is true.
disabled rows.
(enclosed in quotes) to apply to a disabled tree
item.
dragenabled (Optional) Whether to enable (True) or disable
(False) drag and drop to and from the tree.
frameborder (Optional) Whether a frame border is required
(True) or not (False). Default is true. Valid
only when the width and height attributes are
specified.
height (Optional) Height of the entire tree control. Use
with the width attribute. The tree is placed in an
IE Iframe of the specified width and height.
the JSP page.
docbasefoldertree
includeassemblydocuments (Optional) Whether to include virtual document

snapshots in the tree (True) or not (False).
includevirtualdocuments (Optional) Whether to include virtual documents
in the tree (True) or not (False).
multiselect (Optional) Whether to enable multiple expansion
of tree nodes (True) or not (False). Setting this
attribute to true might have a negative impact
performance.
multiselectdepth (Optional) Level at which multiple expansion is
supported. For example, a level of 2 prevents
multiple repositories (level 1) from being
expanded in the tree.
nodeheight (Optional) Height of an individual node graphic.
Default is 17. If node images exist, the default is
the height of Tplus.gif.
nodewidth (Optional) Width of an individual node graphic.
Default is 17. If node images exist, the default is
the width of Tplus.gif.
normalclass (Optional) CSS class to apply to text of normal
rows.
normalstyle (Optional) Entire CSS-syntax style sheet rule
enclosed in quotes to apply to a normal tree
item.
onclick (Optional) Event fired when the user clicks clicks
attribute is true).
oncollapse (Optional) Event fired when the user attempts
to collapse a node. If you override this node,
then you need to write code to collapse the
appropriate node.
ondrop (Optional) Name of an event handler for the
drop event in the component class
onexpand (Optional) Fired when the user attempts to
expand a node. If you override this node,
then you need to write code to expand the
appropriate node.
rootpath (Optional) Repository path to the root folder of
the tree. Default is the repository root itself.
docbasefoldertree

selectedclass (Optional) Class to apply to the text of selected
rows.
selectedstyle (Optional) Entire CSS-syntax style sheet rule
enclosed in quotes to apply to a selected tree
item.
showicons (Optional) Whether icons for each tree item are
displayed (True) or not (False). Default is false.
showlines (Optional) Whether lines between each tree item
are displayed (True) or not (False). Default is
true.
showlockedicon (Optional) Whether lock icons are displayed
next to locked objects in the tree (True) or not
(False).
showroot (Optional) Whether the root node is displayed
(True) or not (False). Default is true.
value (Optional) Selected node ID. Stores the name of
the selected tree item. This attribute is generally
managed programmatically.
width (Optional) Width of the entire tree control. Use
with the height attribute. The tree is placed in an
docbaseicon
Description
Since
5.x

docbaseicon
Purpose
Generates a Documentum icon for the type and format of the object. The tag will resolve the icon
based on format first, then type. Both format attributes override type attributes if both are resolved to
icons. You can set the format or type programmatically using setFormat() or setType(), respectively,
on the DocbaseIconTag class.
Attributes
assembledfromdatafield (Optional) Datafield that identifies an

object as a snapshot; for example,
assembledfromdatafield=’r_assembled_
from_id’.
folderiddatafield (Optional) Datafield that supplies the folder ID.
format (Optional) Format code; for example, msw97’.
formatdatafield (Optional) Overrides format attribute value. For
example, formatdatafield=’a_content_type’.
the JSP page.
isfrozenassemblydatafield (Optional) Datafield that identifies a
frozen snapshot object; for example,
isfrozenassemblydatafield=’r_has_frzn_
assembly’.
isreferencedatafield (Optional) Datafield that identifies whether the
object is a reference object.
isreplicadatafield (Optional) Datafield that identifies whether the
object is a replica object.
docbaselockicon
isvirtualdocdatafield (Optional) Datafield that identifies

virtual documents. For example:
isvirtualdocdatafield=’r_is_virtual_doc’.
linkcntdatafield (Optional) Datafield that determines whether
the document is a virtual document in a 4.1
repository.
size (Optional) Size (in pixels) of the icon. Valid
values are: 16 or 32.
type (Optional) Name of the object type; for example,
dm_folder.
typedatafield (Optional) Overrides the type attribute value.
For example: typedatafield=’r_object_type’.
Description
Since
5.x

docbaselockicon
Purpose
Displays an icon for locked repository objects.
docbasepriorityicon
Attributes

datafield (Optional) Datafield that supplies the lock
owner name and overrides lockowner attribute
value. For example: datafield=’r_lock_owner’.
You can set the datafield programmatically
using the setLockOwner() method on the
DocbaseLockIconTag class.
the JSP page.
lockowner (Optional) Name of the owner of the lock.
Description
Since
5.x

docbasepriorityicon
Purpose
Displays an icon that represents the priority of a repository object.
docbaseselector
Attributes

the JSP page.
priority (Optional) Priority of the object
prioritydatafield (Optional) Overrides the priority attribute.
Datafield that supplies the priority for the
object; for example, prioritydatafield=’priority’.
You can set the priority programmatically
using the setPriority() method on the
DocbasePriorityIconTag class.
Description
Since
5.x

docbaseselector
Purpose
Generates a dropdown list of available Docbases
Attributes

docbaseselector

the JSP page.
repository. This event is handled immediately
attribute is true).Specifies the event to be fired
when the user selects a DocbaseSpecifies the
event to be fired when the user selects a Docbase
Description
Since
5.x
docbaseselector (Webtop)

docbaseselector (Webtop)
Purpose
Generates a dropdown list of available repositories.
Attributes

the JSP page.
onselect (Optional) Specifies the event to be fired when
the user selects a repository.
multidocbasetree

Description
Since
5.x

dmwt (WEB-INF\tlds\dmwebtop_1_0.tld)
multidocbasetree
Purpose
Generates the display of browser tree nodes including custom nodes. Set the limit for
the number of folders to be displayed in the tree in the Environment.properties file (in
/WEB-INF/classes/com/documentum/web/formext). Larger numbers of folders are replaced with a
More Folders link for better performance.
Attributes

nodes are collapsed (True) or not (False). Default
is true.
disabled rows.
enclosed in quotes to apply to a disabled tree
item.
dragenabled (Optional) Whether to enable (True) or disable
(False) drag and drop to and from the tree.
multidocbasetree

specified.
the JSP page.
includeassemblydocuments (Optional) Whether to include virtual document
assemblies in the tree (True) or not (False).
includevirtualdocuments (Optional) Whether to include virtual documents
in the tree (True) or not (False).
performance.
Default is 17. If the node images exist, default is
normalclass (Optional) CSS class to apply to the text of
normal rows
item.
onclick (Optional) Event fired when the user clicks
the folder path link. This event is handled
multidocbasetree

appropriate node.
drop event in the component class.
onexpand (Optional) Event fired when the user attempts
to expand a node. If you override this node,
appropriate node.
rows
item.
showicons (Optional) Whether to display icons for each tree
item (True) or not (False). Default is false.
showlines (Optional) Whether to display lines between
trees (True) or not (False). Default is true.
showlockedicon (Optional) To display lock icons next to locked
objects in the tree (True) or not (False).
value (Optional) Selected node ID. Stores the name of
the selected tree item. This attribute is generally
managed programmatically.
with the height attribute. The tree is placed in an
Description
Since
5.x

clustergroup
Search
clustergroup
Purpose
Displays a search cluster group as a list of clustertree, page 285 controls.
Attributes

disabled nested trees.
(enclosed in quotes) to apply to the text of
disabled nested trees.
specified.
headerclass (Optional) CSS class to apply to the text of the
headers of normal trees.
the JSP page.
isVertical (Optional) Boolean: Whether to display
contained trees in cells from a single column
(True) or in a single row (False). Default is true.
clustergroup

normalclass (Optional) CSS class to apply to the text of
nested normal trees.
item.
attribute is true).
tree item.
item.
showheaders (Optional) Whether a header for each tree is
displayed (True) or not (False).
true.
showroots (Optional) Boolean: Whether to display (True)
the contained tree roots or not (False). Default is
true.
value (Optional) Value stored in the control. Stores the
name of the selected tree item.
Description
Since
6.0

dmfxs (WEB-INF\tlds\dmfxsearch_1_0.tld)
clustertree
clustertree
Purpose
Displays a search cluster tree.
Attributes

is true.
clustericonpath (Optional) Specifies the icons displayed for the
tree nodes (by level). Paths are resolved within
the current user’s theme.
clusterrange (Optional) Specifies the degree to which results
within the same cluster are related. Valid values
are: ClusterTree.HIGH_CLUSTER_RANGE
= "HIGH" ClusterTree.MEDIUM_
CLUSTER_RANGE = "MEDIUM"
ClusterTree.LOW_CLUSTER_RANGE =
"LOW"
clusterstrategy (Optional) Specifies the cluster strategies
that define the meaningful data used to
compute cluters. You must declare the cluster
strategies in the strategies configuration file
(wdk\config\clusterstrategies_config.xml).
disabled rows.
(enclosed in quotes) to apply to disabled tree
items.
specified.
clustertree

the JSP page.
misccluster (Optional) Specifies a label for the node
containing all results that are not included in
any real cluster. This node is hidden, if a value
is not specified.
multiselect (Optional) Whether to enable multiple
expansion of tree nodes (True) or not (False).To
add or remove a node to or from the current
selection, use Ctrl+click. To select all the nodes
from the first node selected to the current one,
use Shift+click. A parent and child cannot be
selected at the same time.
normalclass (Optional) CSS class to apply to the text of a
normal tree item.
item.
attribute is true).
appropriate node.
onexpand (Optional) Client event fired when the user
attempts to expand a node. If you override this
node, then you need to write code to expand the
appropriate node.
clustertree
rootlabel (Optional) String to display as the label for the

root node.
tree items.
item.
true.
subclustericonpath (Optional) Specifies the icons displayed for the
tree nodes (by level). Paths are resolved within
the current user’s theme.
subclusterstrategy (Optional) Specifies the sub-cluster strategies
that define the meaningful data used to compute
sub-clusters. You must declare the cluster
strategies in the strategies configuration file
(wdk\config\clusterstrategies_config.xml).
Description
Since
6.0

repositorysearch
repositorysearch
Purpose
Top level container control that uses the other search controls to form a search query. All search
controls on the JSP page must be contained within this control.
Attributes

the JSP page.
Description
Since
5.x

searchattribute
Purpose
Displays a repository object attribute for search criterion.
Attributes
andorvisible (Optional) For internal use only. Whether the

AND/OR selector is displayed (True) or not
(False). Default is true.6.0: Deprecated.
attribute (Optional) Attribute of objects in a repository
that can be searched.
searchattribute
casevisible (Optional) Removes the checkbox Match

case in advanced search. By default, the
search is case sensitive for faster performance.
The default match case is set in the
/wdk/config/advsearchex.xml file. Applies only
to non-indexed repositories.
height (Optional) Height of this control as an input
control.
the JSP page.
label (Optional) String to be displayed for the
attribute.
removable (Optional) For internal use only. To enable
(True) or disable (False) removing the attribute
from the containing group.6.0: Deprecated.
size (Optional) Size (in pixels) of this control as a
text-input control.
searchattributegroup
valuewidth (Optional) Width of the value field. Specify

this attribute when you want the width of the
value field to be different from the width of the
other fields (such as the attribute and operator
drop-down lists). Default is the value of the
width attribute.
Since 6.5.

width (Optional) Width of this control as in input
control.
Description
Since
5.x

Usage
Since 6.0: Conditional value assistance is supported. To enable conditional value assistance, place the
searchattribute controls in the same order on the JSP as the value assistance dependencies.
Data dictionary value assistance is supported. To add non-data dictionary value assistance,
you configure custom classes to perform the assistance. The assistance is configured in
/wdk/config/advsearchex.xml. For information on setting up non-data dictionary value assistance for
search, see "Programmatic Search Value Assistance in Web Development Kit Development Guide.
Purpose
Container of other attribute-related search controls. It creates the child controls when the user
clicks Add. It contains tags for specific types of attributes and can exclude other, specified types of
attributes. For information on how to display specific attributes for search, refer to "Configuring
advanced search in Web Development Kit Development Guide.
Attributes
addvisible (Optional) Whether the Add and Remove

buttons are displayed (True) or not (False).
Default is true.
casevisible (Optional) Removes the checkbox Match case in
advanced search. The search is by default case
sensitive for faster performance. Default match
case is set in /wdk/config/advsearchex.xml.
Applies only to non-indexed repositories.
defaultattribute (Optional) Default attribute to be selected.
Cannot be an attribute specified in the
excludenames attribute.
excludenames (Optional) A comma-separated list of attribute
names to be excluded from the auto-populated
dropdown for attribute names.
excludetypes (Optional) A comma-separated list of
attribute datatypes to be excluded from the
auto-populated dropdown for attribute names.
Valid attribute datatypes are: Boolean (or bool),
id, double, integer (or int, date, time, string,
number (DM_DOUBLE or DM_INTEGER).
height (Optional) Height of fields.
the JSP page.
initialattributes (Optional) Comma-separated list of attribute
names that are displayed and selected by default
in the group without having to click Add
Property. A property line (that is, an AND/OR
DropDown, Attribute Name Dropdown,
Operator DropDown, Value Box, and Remove
link) is displayed for each specified attribute
name. Since 5.3 SP4.
logicaloperatorpos (Optional) Whether to display logical operators
on the same line (sameline) as the rest of the
property line or on a newline (newline) when
the Add Property link is clicked. Default is
sameline.Since 6.0.
opened (Optional) Whether to display the attribute

group as expanded (True) or collapsed (False).
Default is false.
size (Optional) Size (in pixels) of any text field.
valuewidth (Optional) Width of the value field. Specify
this attribute when you want the width of the
value field to be different from the width of the
other fields (such as the attribute and operator
drop-down lists). Default is the value of the
width attribute.
Since 6.5.

width (Optional) Width of fields.
Description
Since
5.x

Usage
By default, when the user clicks Add Property, the default operator is AND. Your component class
can call setLogicalOr on the searchattributegroup control to change the default to OR.
The precedence of constraints is given to the last constraint added. For example:
A
searchdateattribute
OR B
AND C
is equivalent to ((A OR B) AND C)
A
AND B
OR C
AND D
is equivalent to (((A AND B) OR C) and D)
searchdateattribute
Purpose
Subclass of SearchAttribute control. It can be used to input search values on date attributes.
Attributes
andorvisible (Optional) Whether the AND/OR selector is

displayed (True) or not (False). Default is true.
attribute (Optional) Date attribute of objects in a
repository that can be searched.
the JSP page.
attribute.
removable (Optional) For internal use only. To enable
(True) or disable (False) removing the attribute
from the containing group.
size (Optional) Size (in pixels) of the control if it is
rendered as a text control.
searchdateattribute

valuespos (Optional) Whether to display values to the right
(right) or at the bottom (bottom) of this control.
Default is bottom.Since 6.0.
Description
Since
5.x

Usage
This control by default does not have a dropdown item to allow the user to select a date value that is
"In the next day/week/month/year" for effective date and expiration date attributes. The visibility of
the dropdown items is configured in /wdk/config/advsearchex.xml as follows:
<scope type="dm_sysobject">
<inthenextdate>
<a_effective_date>true</a_effective_date>
<a_expiration_date>true</a_expiration_date>
</inthenextdate>
</scope>
searchfulltext
searchfulltext
Purpose
Accepts keywords for a full-text query. Searches indexed documents and indexed attributes. You can
use AND, OR, and NOT operators, and you can search on exact strings within quotation marks; for
example, "this string”. Since 6.0 SP1: NOT operater is supported.
Attributes

is True.
or title.
datafield (Optional) Datafield that supplies the keyword
and overrides the value and nlsid attributes.
control.
the JSP page.
searchfulltext

value (Optional) Keyword for full-text search.
searchicon
Description
Since
5.x

searchicon
Purpose
Displays a search template or a saved search icon according to the search type. It also differentiates
private from public searches. If the object type is not a saved search (dm_smart_list) or a search
template (dmc_search_template), then no icon is displayed.
Since
6.5
searchlocation
Purpose
Extends the label control and displays the current search source and folder path as a static string. The
location is expressed as a semi-comma separated list in this format: soucename[:]/cabinet/folder.
Attributes
align (Optional) (Image label only) Alignment of the

label text.
datafield (Optional) Datafield that supplies the label and
overrides the label and nlsid attributes.
encodelabel (Optional) Whether the label is to be encoded
(True) or not (False). Specify true if the label can
contain HTML. Default is false.
searchobjecttypedropdownlist

the JSP page.
image label.
label (Optional) String to be displayed for the location
display.
Description
Since
5.x

Purpose
Generates a dropdown list from which the user can select the object type on which to search.
Attributes

(False) autocompletion on the control. Default is
true.
or title.
editable (Optional) Whether the user can type a value in
the control (True) or not (False).
forceselection (Optional) Whether to force the user to select
an item from the dropdown list (True) or not
(False). If true is specified, no item is selected
initially. If false is specified, the first item in the
list is selected initially.
the JSP page.
includetypes (Optional) Comma-delimited list of object type
names that are displayed in the dropdown list;
for example, "mytype,yourtype. If a listed type
is selected, subtypes of that type are also queried
and displayed. Names of object types that do
not exist in the repository are not displayed.

repository. This event is handled immediately
attribute is true).
value (Optional) ??
searchscopecheckbox
Description
Since
5.x

Usage
The options in this list can be set programmatically. See dropdownlist, page 181for an example. This
control has also a method setOptionFromScrollableResultSet().
If multiple search locations are set in the user preferences, a reference repository is used to present
the list of types. This repository is either the first one selected by the end user or the repository that is
used as a BOF registry if the user has not selected a repository. If a selected type is not known to the
reference repository that is used to drive the composition of the advanced search, it will be ignored.
searchscopecheckbox
Purpose
Checkbox that enables a user to set a value for a search setting or capability. Currently, it is used to
enable finding all versions or hidden objects.
Attributes
checkedvalue (Optional) Valid value for the scopename

attribute. Set to true or false for findAllVersions
or findHidden. Set to a specific object type to set
the base type for search.
the JSP page.
label (Optional) Label for the checkbox.
labelalign (Optional) Vertical alignment of the checkbox
label. Valid values are: left, right.
searchscopecheckbox

attribute is true).
scopename (Required) Name of the global setting. Valid
values are: type, findAllVersions, findHidden,
DatabaseSearch.
searchsizeattribute
uncheckedvalue (Optional) Specifies a valid value for

the scopename. Set to true or false for
findAllVersions or findHidden. Set to a specific
object type to set the base type for search.
value (Optional) ??
Description
Since
5.x

searchsizeattribute
Purpose
Subclass of SearchAttribute control. It can be used to input search values on size attributes.
You can configure the global size values that are displayed, and their labels, by extending
/wdk/config/advsearchex.xml and copying the <searchsizeattributerange> element and its contents.
Attributes
andorvisible (Optional) Whether the AND/OR selector is

displayed (True) or not (False). Default is true.
attribute (Optional) Size attribute of an object type in a
repository that can be searched.
the JSP page.
attribute.
searchsizeattribute

removable (Optional) To enable (True) or disable (False)
removing the attribute from the containing
group.
Description
Since
5.x

Usage
Size options can be configured for all instances of this control by extending the control configuration
file /wdk/config/advsearchex.xml. The following control attributes can be configured to add a search
size option:
searchtemplatefreelist
Element Description
<option> Size option for display. Contains <label>,
<value>, <operator>, and <unit> elements.
<label> String or <nlsid>. The NLS ID key
is resolved by the NLS resource file
SearchControlNlsProp.properties.
<operator> Size operator. Valid operators are: LT (less
than), GT (greater than).
<value> Default value to be displayed.
<unit> Units for value. Valid units: MB, KB.
searchtemplatefreelist
Purpose
Displays the list of search template constraints (based on the selected search template) to specify
for a new search.
Attributes
cssclassinputtext (Optional) CSS class to apply to this control

for the input-text (attribute value). Default
value set to SearchTemplateFreeListTag.
DEFAULT_CSSCLASS_INPUT_TEXT
(defaultDocbaseAttributeStyle)
cssclasslabel (Optional) CSS class to apply to this control
for the label (attribute name to display).
Default value set to SearchTemplateFreeListTag.
DEFAULT_CSSCLASS_LABEL (fieldlabel).
by the framework. You can also set the ID in the
JSP page.
objectId (Optional) Object ID of the search template to
display.
searchtemplatehiddenfixedlist
style (Optional) CSS rule (enclosed inmarks) to apply

to this control; for example: style="{COLOR:
darkmagenta;DECORATION: underline}"
width (Optional) Width of this control as an input
control (text-input or dropdownlist).
Description
Since
6.0

searchtemplatehiddenfixedlist
Purpose
Displays a search template’s sources and fixed expressions.
Attributes
cssclasslabel (Optional) CSS class to apply to this control

for the label (attribute name to display).
Default value set to SearchTemplateFreeListTag.
DEFAULT_CSSCLASS_LABEL (fieldlabel).
cssclasstext (Optional) CSS class to apply to this control
for the text (attribute value). Default value set
to SearchTemplateHiddenFixedListTag.DE-
FAULT_CSSCLASS_TEXT (defaultDocbaseAt-
tributeStyle)
the JSP page.
objectId (Optional) Object ID of the search template
to display when displaying a saved search
template.
sortableclustertreelist
showfixedconstraints (Optional) Set to true to also display the fixed

expressions with the hidden expressions.
Default is false.
showsources (Optional) Set to ’true’ to display the sources
(locations) of the search template. Default is
true.
style (Optional) CSS rule (enclosed inmarks) to apply
to this control; for example: style="{COLOR:
darkmagenta;DECORATION: underline}"
Description
Since
6.0

Purpose
Displays a search cluster tree (that is, ClusterTreeDefinition objects) that users can sort.
Attributes

the JSP page.
(False) selection of multiple items for Add or
Remove. If a move operation is chosen, only the
first selection is moved. Default is false.

tooltipnlsid (Optional) (Boolean) Whether this control is
Description
Since
6.0

sortablelistbox
sortablelistbox
Purpose
Displays a listbox of values that the user can reorder and delete values.
Attributes

height (Optional) Vertical length of this control.
the JSP page.
(False) multiple selection in the listbox. When
multiselect is enables, the you can select multiple
items in the list and perform these actions: To
delete all selected items, click Remove. To move
only the first item of the selection, click the up
or down arrows. You cannot move all the items
in a selection.
onchange (Optional) Not used. Will be deleted.
onselect (Optional) Not used. Will be deleted.
visible in this control.
strategyselector
value (Optional) Not used. Will be deleted.

width (Optional) Horizontal length of this control.
Description
Since
6.0

Usage
When this control is initialized, the first item is selected. You can initialize this control with values
using a Java class. You can add values to this control after initialization by using another control.
strategyselector
Purpose
Selector for selecting a search cluster strategy.
Attributes

forceselection (Optional) Boolean: Whether to require a cluster
strategy to be selected (True) or not (False).
the JSP page.
strategyselector

value (Optional) The ID of the cluster strategy
that is initially selected. This value
must match the the corresponding
clusterStrategy element’s id attribute in
the WDK\config\clusterstrategies_config.xml
file.
Description
Since
6.0

label
Usage
This control is populated with the list of cluster strategies specified in the
WDK\config\clusterstrategies_config.xml file. Each list item is composed of a cluster strategy
localized label and ID.
Each cluster strategy’s localized label is displayed in the
list. The cluster strategy localized labels are specified in the
wdk\strings\com\documentum\web\formext\control\cluster\ClusterStrategiesNlsProp.
properties file.
The ID is the clusterStrategy element’s id attribute specified in the clusterstrategies_config.xml file.
An example of a cluster strategy defined in the clusterstrategies_config.xml file is:
<clusterStrategy id='subject' nlsid='MSG_SUBJECT' icon='taxmgmt.gif'>
<criterion>object_name</criterion>
<criterion>subject</criterion>
<criterion>title</criterion>
</clusterStrategy>
Text display and input
label
Purpose
Text label control that can be used to label an image, user input control, or other user interface element.
Attributes
align (Optional) (Image label only) HTML horizontal

alignment attribute. Default is center.
associatedcontrolid (Optional) Label tags can be associated
with control using ’associatedcontrolid=
"<CONTROL_ID>”’ to render context-specific
information, when the focus is on the control,
LabelTag’s label is read instead of the control’s
title. But, be careful when doing this change for
Checkboxes, Radio controls and controls with
validators, as Label tags overrides any other
tooltip and tooltipnlsid set for the control.
datafield (Optional) Overrides label with data from a data
source.
label

height (Optional) (Image label only) Height of the label.
Set this to the height of the graphic, so that it
lines up correctly.
the JSP page.
image label.
label (Optional) String displayed as the label.
width (Optional) (Image label only) Width of the label.
Default is the width of the label text.
Description
Since
5.x

text
text
Purpose
Renders an HTML text box.
Attributes

is True.
or title.
datafield (Optional) Overrides value and nlsid with a
control. The disableenter attribute overrides this
attribute.
disableenter (Optional) Set to true to prevent a form from
being submitted when a user presses the Enter
key while editing the title (that is, when the text
input field has the focus) in the comment editor.
Overrides the defaultonenter attribute.
Since 6.0.

text

the JSP page.
size (Optional) Length of the text control.
value (Optional) String displayed in the text box.
textarea
Description
Since
5.x

textarea
Purpose
Generates an HTML multi-line text box.
Attributes
cols (Optional) Number of columns in the text area

control.
datafield (Optional) Overrides the value and nlsid
attributes with a value from a data source.
the JSP page.
textarea
rows (Optional) Number of rows in the text area

control.
value (Optional) Value displayed in the text area box.
wrap (Optional) Whether to turn word-wrapping on
for displaying and submitted data from the
textarea field (True) or not (False).
Description
Since
5.x

browsertree (Webtop)
Trees
Purpose
Generates the display of browser tree nodes including custom nodes. All attributes are the
same as those for the Docbase-enabled control docbasefoldertree. You can set the limit for
number of folders to be displayed in the tree in the file Environment.properties, located in
/WEB-INF/classes/com/documentum/web/formext. Larger numbers will be replaced with a More
Folders link for better performance.
Attributes
cachechildren (Optional) Determines whether children are

cached when nodes are collapsed (default = true)
disabledclass (Optional) Class to apply to text of disabled
rows.
disabledstyle (Optional) An entire CSS-syntax style sheet rule
enclosed in quotes and applied to a disabled
tree item
frameborder (Optional) When width and height are specified
to put the tree in an iFrame, specifies whether a
frame border is required (default = true).
height (Optional) The height of the entire tree control.
Use with width to put the tree in an IE Iframe of
the specified width and height.
the JSP page.
includeassemblydocuments (Optional) Set to true to include virtual
document assemblies (snapshots) in the tree
includevirtualdocuments (Optional) Set to true to show virtual documents
in the tree

performance.
nodeheight (Optional) The height of an individual node
graphic (default = 17). If node images exist,
default height = height of Tplus.gif.
nodewidth (Optional) The width of an individual node
graphic (default = 17). If node images exist,
default width = width of Tplus.gif.
normalclass (Optional) CSS class to apply to text of normal
rows.
normalstyle (Optional) An entire CSS-syntax style sheet rule
enclosed in quotes and applied to a normal tree
item
onchange (Optional) Event fired when the control has been
modified (fired when an onclick occurs).
attribute is true).
oncollapse (Optional) Fire when the user attempts to
collapse a node. If you override this node,
appropriate node.
drop event in the component class.
onexpand (Optional) Fired when the user attempts to
expand a node. If you override this node,
appropriate node.
rootpath (Optional) Repository path to the root folder for
the tree (default = the repository root itself).
runatclient (Optional) Specifies that the event is to run on

the client, instead of the server. The onchange
event cannot run on the client.
Since: 6.5
selectedclass (Optional) Class to apply to text of selected rows.
selectedstyle (Optional) An entire CSS-syntax style sheet rule
enclosed in quotes and applied to a selected tree
item.
showicons (Optional) Determines visibility of icons for each
tree item (default = false).
showlines (Optional) Determines visibility of tree lines
(default = true).
showroot (Optional) Determines visibility of the root node
(default = true).
value (Optional) Sets the selected node ID. Stores the
name of the selected tree item. This attribute is
generally managed programmatically.
width (Optional) The width of the entire tree control.
Use with height to put the tree in an IE Iframe of
Description
Since
5.x
tree

dmwt (WEB-INF\tlds\dmwebtop_1_0.tld)
tree
Purpose
Generates a tree control.
Attributes

is true.
cssclass (Optional) the CSS class to apply to this control.
disabled rows.
(enclosed in quotes) to apply to the disabled
control.
dragenabled (Optional) Unsupported.
specified.
the JSP page.
inlinerefresh (Optional) Whether to cause partial refresh of
the tree (True) rather than the full tree (False)
when user expands or collapses a node.
tree
multiselect (Optional) Whether to enable multiple

expansion of tree nodes (True) or not (False).To
add or remove a node to or from the current
selection, use Ctrl+click. To select all the nodes
from the first node selected to the current one,
use Shift+click. A parent and child cannot be
selected at the same time.
normalclass (Optional) Class to apply to the text of normal
rows.
item.
onclick (Optional) Event fired when the user clicks a tree
item. This event is handled immediately on the
is true).
appropriate node.
ondrop (Optional) Unsupported.
onexpand (Optional) Client event fired when the user
attempts to expand a node. If you override this
node, then you need to write code to expand the
appropriate node.
rows.
tree

item
showicons (Optional) Whether icons associated with each
tree item are displayed (True) or not (False).
Default is false.
showlines (Optional)Whether to display lines between
trees (True) or not (False). Default is true.
with the height attribute. The tree is placed in
an IE Iframe of the specified width and height.
If no Iframe is used, the tree is rendered inline.
Description
Since
5.x

combocontainerpanel
User feedback
combocontainerpanel
Purpose
Generates a panel to display progress.
Attributes
progressbarid (Optional) ID of the assoicated progressbar

control on the page.
Description
Since
5.x

Usage
This control should be used to wrap a <dmfx:containerinclude/> control in order to display a progress
bar. The JSP page must also contain a progressbar control.
formatmessageparams
Purpose
Formats a message by inserting parameters into the message at runtime.
Attributes
align (Optional) HTML horizontal alignment

attribute. Default is center.
formatmessageparams
datafield (Optional) Overrides the nlsid attribute.

height (Optional) Height (in pixels) of the message
field.
the JSP page.
nlsid (Required) NLS lookup key. ID of an NLS string
that provides the fixed portion of the message,
with dynamic placeholder within numbered
brackets ({})
width (Optional) Width (in pixels) of the message field.
Description
Since
5.x

Usage
The parameters are contained within the body of the control using argument controls. The
place holders in an nlsid string are filled in at runtime with the argument values. For example:
"MSG_CHECKED_IN_BY =Checked in by {0} has a placeholder for 1 parameter, {0}. During runtime,
the placeholder {0} gets filled in with first argument in control body. For example:
<dmfx:formatmessageparams nlsid="MSG_CHECKED_IN_BY">
<dmfx:argument name="vm_owner" datafield="owner_name"/>
</dmfx:formatmessageparams>
The NLS string in the properties file is as follows:

MSG_CHECKED_IN_BY=checked in by {0},
progressbar
progressbar
Purpose
Displays a progress bar. Should be used with a progressbarupdater or a combocontainerpanel control
for which the progressbarid attribute value is set to the same value as the progressbar id.
Attributes
height (Optional) Height of the progress bar control.

the JSP page.
maximum (Optional) Maximum percent value on progress
bar scale. Default is 100.
message (Optional) String message to be displayed with
the progress bar.
minimum (Optional) Minimum percent value on progress
bar scale. Default is 0.
the message attribute value.
value (Optional) Current percent complete.
width (Optional) Width (in pixels) of the progress bar.
Description
Since
5.x

progressbarupdater
progressbarupdater
Purpose
Updates a progress bar at specified steps. Should be used with a progressbar control.
Attributes

progressbarid (Optional) ID of the progressbar control with
which this control is associated. Must matche
the ID attribute on the progressbar control in
the JSP page.
stepbarid (Optional) ID of a step bar.
steplabelid (Optional) Current percent complete.
Description
Since
5.x

promptedtext
Purpose
Text for a prompt.
promptedtext
Attributes

is True.
"keyword or "title.
datafield (Optional) Overrides the nlsid attribute.
control.
enabled (Optional) Sets whether the control is enabled.
the JSP page.
the message attribute value.
onchange (Optional) Event fired when the control has been
modified (fired when an onclick occurs).
promptedtext
onclick (Optional) Event fired when the user clicks a tree

item. This event is handled immediately on the
is true).
prompt (Optional) Text for the prompt.
size (Optional) Length of the text control.
value (Optional) Sets the selected node ID. Stores the
name of the selected tree item. This attribute is
generally managed programmatically.
width (Optional) The width of the entire tree control.
Use with height to put the tree in an IE Iframe of
vdmbindingruleformatter
Description
Since
6.0

Virtual documents
vdmbindingruleformatter
Purpose
Formats a virtual document binding rule.
Attributes

the JSP page.
vdmtreegridname (Required) Name of the vdmtreegrid control for
which the binding rule output is formatted.
Description
Since
5.x

vdmtreegrid
vdmtreegrid
Purpose
Generates a grid display of a virtual document tree or snapshot (assembly). The grid is a data
container similar to the data grid and must contain vdmtreegridrow tags to display the data.
Attributes
bordersize (Optional) Border (in pixels) around the

datagrid.
cellpadding (Optional) Spacing between the cell content and
cell border.
cellspacing (Optional) Spacing between the cells in the grid.
expanddepth (Optional) Number (integer) of node levels to
expand.
fixedheaders (Optional) Boolean: Whether the datagrid
header rows are to scroll with the body
rows (False) or not (True). Default is
false. To set this attribute value for all
datagrid controls in your application, set the
following element value in the app.xml file:
<desktopui<.<datagrid>.<fixedheaders>. This
element ’s default value is true.Since 6.0.
the JSP page.
paged (Optional) Whether data is displayed in pages
pagesize (Optional) Number of objects per page, if the
pagesize attribute is set to true.
vdmtreegridRow
rowselection (Optional) Boolean: Enables (True) or disables

(False) mouse or keyboard row selection
(selecting one or more objects) and right-click
context menus. Default is True. The app.xml
file’s desktopui/datagrid/rowselection element
must be set to true to enable this attribute.
showroot (Optional) Determines whether the root node is
displayed (default = true).
vdmid (Optional) ID of the virtual document root node.
with the height attribute. The tree is placed in
an IE Iframe of the specified width and height.
If no Iframe is used, the tree is rendered inline.
Description
Since
5.x

vdmtreegridRow
Purpose
Generates a table row for each node in a virtual document.
Attributes
align (Optional) Horizontal alignment of the row.

altclass (Optional) CSS class for alternating rows.
altstyle (Optional) Inline CSS rule for alternating rows.
height (Optional) Height of the row.
workfloweditorapplet

the JSP page.
showindent (Optional) Whether to indent the nodes by node
level in an outline style (True) or not (False).
Default is false.
showplusminus (Optional) Whether to display +/- symbols for
nodes that can be expanded or collapsed (True)
or not (False). Default is false.
valign (Optional) Vertical alignment of the row.
Description
Since
5.x

Web Workflow Manager
Purpose
Generates an applet that displays the workflow editor.
Attributes
align (Optional) Horizontal alignment of applet text.

Possible values are the same as those for the
height (Optional) Height of the applet.
hspace (Optional) Horizontal space between applet and
surrounding text.
the JSP page.
successhandler (Optional) Server-side event handler that
handles the applet return.
tracelevel (Optional) Whether to turn on (1) or off (0)
tracing.
viewonly (Optional) Whether to disable (True) or enable
(False) all editing controls. When this attribute
value is true, only File > New, File > Open, and
File > Save As menu items are enabled.
vspace (Optional) Vertical space between applet and
surrounding text.
width (Optional) Width of the applet.
Description
Since
5.x

workflowcompletetypeformatter
Workflow
workflowcompletetypeformatter
Purpose
Wraps a value for the integer that signifies the type of workflow completion.
Attributes

the JSP page.
Description
Since
5.x

workflowdisabledformatter
Purpose
Wraps the integer that signifies the workflow in or out.
workflowdurationformatter
Attributes

the JSP page.
Description
Since
5.x

workflowdurationformatter
Purpose
Wraps the integer that signifies the workflow duration.
Attributes

the JSP page.
Description
Since
5.x

workflowstateicon
workflowstateicon
Purpose
Obtains an icon that represents the workflow state of a repository object.
Attributes

size (Optional) Size (in pixels) of the icon.
state (Optional) Object state.
statedatafield (Optional) Datafield that overrides the state
attribute value. The datafield supplies
the state for the object, for example,
statedatafield=’w.r_runtime_state’.
Description
Since
5.x

workflowtaskstatusvalueformatter
Purpose
Wraps a workflow task status value.
workqueueflagvalueformatter
Attributes

the JSP page.
Description
Since
5.x

workqueueflagvalueformatter
Purpose
Wraps a work queue flag value (isAssigned).
Attributes

the JSP page.
Description
Since
5.x

workqueuetaskstatusvalueformatter
workqueuetaskstatusvalueformatter
Purpose
Wraps a work queue task status value.
Attributes

the JSP page.
performerName (Required) User name of the work queue
performer.
wqname (Required) Name of the work queue.
Description
Since
5.x

xForms
xforms
Purpose
Renders a form for viewing or editing using the Chiba open source xforms engine. The application
server must have Java 1.4.x to display forms. The user must have the role form_user to view or edit a
form. Forms are designed through the Documentum Forms Builder product.
xforms
Attributes
formstemplate (Optional)ID of the template.

the JSP page.
objectid (Optional) Object ID for the form.
readonly (Optional) Whether to render the form for
viewing only (True) or editing (False).
tabindex (Optional)
xformsconfigid (Optional) ID that corresponds to an xforms
configuration.
Description
Since
5.x

Usage
When a form is saved, the control passes the form content to the Chiba engine for validation. Errors
are passed to the form. Each button on the form has a configurable event that is fired when the
button is clicked. The events are configured in an XML Configuration file whose ID is specified in
the control xformsconfigid attribute.
If a component must respond to a button event, the component should register an
XFormsControlListener and set the control event handler. The listener is required if the component
would like to listen to events that the control fires. The events are named onTriggerIdwhere TriggerId
is the trigger name.
Your component should add the listener in the onControlInitialized() method of the component class.
For example, if the Xforms Configuration file specifies a trigger listener for the Submit button with
the ID submit-trigger, the component can register an event that responds to this trigger as follows:
public void onControlInitialized(Form form, Control control)
{
if (control instanceof XForms)
{
XForms value = (XForms)control;
value.setEventHandler("onsubmit-trigger", "onSubmitTrigger", form);
addControlListener(new XFormsControlListener());
}
}
public void onSubmitTrigger(Control control, ArgumentList arg)
xforms
{
//handle event here
}
The XForms Configuration file is a Chiba Configuration file. For more information on Chiba
configuration, see the Chiba Web site.
xforms
Chapter 2
Actions Reference
Overview
Actions are grouped according to how they are used.
Common elements
This topic describes the elements that can be specified in more than one action configuration file.
Elements that can only be specified in one action configuration file are described in that action’s entry.
failoverenabled
<failoverenabled>true</failoverenabled>
Boolean: Whether to enable (true) failover for this action or not (false). Failover means that user
session data is persisted, and the load balancer routes the last HTTP request before failover to a
secondary server. Make sure that application-level failover is specified in the app.xml file. You
must implement failover in your custom action.
invocation
Use this element structure to display the component that an action calls in a modal dialog box.
<invocation>
<modalpopup>
1 <windowsize>small</windowsize>
2 <refreshparentwindow>never</refreshparentwindow>
</modalpopup>
</invocation>
1 Specifies the size of the modal dialog box. Valid values are small, medium, large and properties.
Default is medium. These default sizes are defined in the <themes> element in the wdk/app.xml file;
you can define your own sizes in this location.
appintginsertobject
2 Specify one of these values to determine whether the parent window is refreshed when the modal
dialog box is closed:
• always — (default) The parent window is always refreshed.
• onok — The parent window is refreshed only if the modal dialog box is closed and the return
value is not null. If a user cancels out of the modal dialog box, no refresh occurs. Since the
framework checks for the return value of the component to determine whether to refresh the
parent window, you must ensure that the proper return values are set for components that are
configured for modal dialog box display.
• never — The parent window is never refreshed.
reverse-precondition
Set to true to turn off the action for components within a precondition. Specify this element within
a <precondition> element preceding the <component> elements that specify the components for
which to turn off the action. In the following definition for the move action, the action is disabled in
the search component:
<precondition class="com.documentum.web.formext.action.ComponentPrecondition">
<reverse-precondition>true</reverse-precondition>
<component>search</component>
</precondition>
Application connectors
appintginsertobject
Purpose
Downloads object content to the client and sends the InsertObject event; called from within a
Windows application (Application Connectors).
Parameters
folderId (Optional) Location of the current document.

User can then choose a new file name to import
to that folder or an existing document to check
in to the folder, or navigate from the folder.
locatorcomponent (Optional) Locates the destination folder for
import. Specify the component to start with (for
example, myfiles_streamline).
appintginsertweblink
Description
Since
5.x
Configuration File
webcomponent\config\actions\appintg_actions.xml
Scope
All.
Usage
With Application Connectors, the repository object is inserted into the active document at the current
cursor position.
Elements
None.
Purpose
Downloads a virtual link or DRL to the client and sends the InsertWebLink event; called from within
a Windows application (Application Connectors).
Parameters

Description
Since
5.x
appintgnewfromtemplate
Configuration File
Scope
All.
Usage
With Application Connectors, a link to the repository object is inserted into the active document at
the current cursor position.
Elements
None.
Purpose
Creates a new document from a template, called from within a Windows application (Application
Connectors)
Parameters
contentType (Optional) File format
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
appintgopenfrom
appintgopenfrom
Purpose
Locates a document in a repository to open within a Windows application (Application Connectors).
Parameters
contentType (Optional) Type of document.

folderId (Optional) ID of folder in which the document
is located.
launchViewer (Optional) Boolean flag that indicates whether
to launch a viewing application.
locatorcomponent (Optional) ID of the locator component to
use for locating the document, for example,
myfiles_streamline.
showViewEdit (Optional) Boolean: Whether to display the
View/Edit prompt to the user (True) or not
(False). Default is true.Since 6.0.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
appintgsaveas
appintgsaveas
Purpose
Performs an import or checkin of current document from within a Windows application (Application
Connectors)
Parameters
contentType (Optional) Type of document

doCheckout (Optional)
filenamewithpath (Required) Name and path of the file to be
checked in.
The user can then choose a new file name to
import to that folder or an existing document to
check in to the folder, or navigate from the folder
example, myfiles_streamline)
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
about (Webtop)
Application management
about (Webtop)
Purpose
Calls the component about (Webtop), page 787 to display information about the Webtop application
and to optionally display tools.
Parameters
enableTools (Optional) alias ctrlKeyPressed. Set to true to

display buttons to launch the API and DQL
editors.
Description
Since
5.x
Configuration File
webtop\config\generic_actions.xml
Scope
All.
Elements
None.
configuredocbroker
Purpose
Launches the configuredocbroker component in the dialogcontainer.
launchauthenticate
Parameters
None.
Description
Since
5.x
Configuration File
wdk\config\preferences_actions.xml
Scope
All.
Elements
None.
launchauthenticate
Purpose
Launches the authenticate component
Parameters
docbase (Required) Repository for which to display the

login dialog
docbroker (Optional) Name of the connection broker to
which the specified repository is projected
docbrokerPort (Optional) Port that needs to be used for the
specified connection broker
suppressLoginEvent (Optional) Specifies whether to fire the
"loginSuccess" or "loginCancel" client events
after the login dialog has been dismissed
Description
Since
5.x
launchauthenticateexternalsource
Configuration File
wdk\config\session_actions.xml
Scope
All.
Elements
None.
launchauthenticateexternalsource
Purpose
Displayed when a user is required to provide credential to an external source
Parameters
externalSource (Required) Source that is set up in the ECI

server. It is an internal name for the source,
and is used to obtain a suitable source name.
For example, for an internal source name
’general/GoogleBackends/Google-French,’ it
returns ’Google-French.’
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
logout
logout
Purpose
Logs the user out of the application
Parameters
The parameters are inherited from /wdk/config/session_actions.xml. See logout, page 352.
Description
Since
5.x
Configuration File
webcomponent\config\session_actions.xml
Parent Definition
/wdk/config/session_actions.xml
Scope
All.
Elements
execution/homeurl
<execution>
<homeurl></homeurl>
</execution>
URL to a JSP page or component that will be displayed when the user logs out of the application.
logout
Purpose
Logs the user out of the application
logout (Webtop)
Parameters
homeurl (Optional) URL to a JSP page or component

that will be displayed when the user logs out of
the application or when a DRL action has been
completed by a default account (anonymous)
user
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
logout (Webtop)
Purpose
Extends the WDK logout action and sets the value of the homeurl attribute to the component.
Parameters
The parameters are inherited from /wdk/config/session_actions.xml. See logout, page 352.
Description
Since
5.x
Configuration File
webtop\config\session_actions.xml
newwindow
Parent Definition
/webcomponent/config/session_actions.xml
Scope
All.
Elements
None.
newwindow
Purpose
Launches the newwindow component to open a second WDK application browser window
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\actions\generic_actions.xml
Scope
All.
Elements
None.
attributes (type dm_acl)
Attributes
attributes (type dm_acl)
Purpose
Displays the attributes of an ACL
Parameters
objectId (Required) ID of the ACL.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\acl_actions.xml
Scope
type dm_acl
Elements
None.
attributes (type dm_externalresult)
Purpose
Displays the attributes page for an external result object.
attributes (type dm_group)
Parameters
entryId (Required) ID of the result entry.

queryId (Required) ID of the query used for searching
the external source.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_externalresult_actions.xml
Scope
type dm_externalresult
Elements
None.
attributes (type dm_group)
Purpose
Displays the attributes for a repository group or creates a new group.
Parameters
objectId (Required) ID of the selected group. Set to

newobject to create a new group.
objectname (Required) Name of the group.
Description
Since
5.x
attributes (type dm_member_group)
Configuration File
webcomponent\config\admin\group\dm_group_actions.xml
Scope
type dm_group
Elements
None.
attributes (type dm_member_group)
Purpose
Displays the attributes for an object.
Parameters
objectId (Required) ID of the selected object.

objectname (Required) Name of the selected object.
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\dm_member_actions.xml
Scope
type dm_member_group
Elements
None.
attributes (type dm_member_user, entitlement collaboration6)
attributes (type dm_member_user, entitlement

collaboration6)
Purpose
Displays the attributes for a dm_member_user object. Requires a Documentum Collaborative
Services license.
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_member_user
entitlement collaboration6
Elements
None.
attributes (type dm_message_archive)
Purpose
Displays the attributes for a dm_message_archive object.
Since
6.5
attributes (type dm_sysobject)
Purpose
Displays the attributes for an object.
Parameters
enableShowAll (Optional) Determines whether the Show All

checkbox is displayed.(true|false)
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
failoverenabled
See failoverenabled, page 343.
attributes (type dm_user, entitlement collaboration6)
Purpose
Displays the attributes for a dm_user object. Requires a Documentum Collaborative Services license.
Parameters

attributes (type dm_user)
Description
Since
6.0
Configuration File
webcomponent\config\admin\user\dm_user_actions.xml
Scope
type dm_user
Elements
None.
attributes (type dm_user)
Purpose
Displays attributes for the selected user.
Parameters
objectId (Required) ID of the selected user. Set to

newobject to create a new user.
objectname (Required) Name of the user.
Description
Since
5.x
Configuration File
Scope
type dm_user
attributes (type workflow_calendar)
Elements
None.
Purpose
Displays the attributes page for an workflow calendar object.
Since
6.5
attributes (type dmc_workqueue_category)
Purpose
Displays the attributes of the selected object.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\actions\dmc_workqueue_category_actions.xml
Scope
type dmc_workqueue_category
attributes (type dmc_workqueue_doc_profile)
Elements
None.
attributes (type dmc_workqueue_doc_profile)
Purpose
Displays the attributes page for a work queue document profile object.
Parameters
objectId (Required) ID of the work queue document

profile object.
objectname (Required) Name of the work queue document
profile.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmc_workqueue_doc_profile_actions.xml
Scope
type dmc_workqueue_doc_profile
Elements
None.
attributes (type dmc_workqueue_policy)
Purpose
Displays the attributes page for a work queue policy
attributes (type dmc_workqueue)
Parameters
objectId (Required) ID of the work queue policy object.

objectname (Required) Name of the work queue policy
object.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmc_workqueue_policy_actions.xml
Scope
type dmc_workqueue_policy
Elements
None.
attributes (type dmc_workqueue)
Purpose
Displays the attributes of a dmc_workqueue object.
Parameters

Description
Since
5.x
history (type dm_sysobject)
Configuration File
webcomponent\config\actions\dmc_workqueue_actions.xml
Scope
type dmc_workqueue
Elements
None.
history (type dm_sysobject)
Purpose
Displays the audit trail for an object.
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
failoverenabled
modifyversionlabels (type dm_sysobject)
modifyversionlabels (type dm_sysobject)
Purpose
Modifies the version labels on an object or one or more nodes in a virtual document.
Parameters
nodeId (Optional) Node ID of the virtual document

node on which to change the version label.
objectId (Required) Object ID of the object on which to
change version labels.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
permissions (type dm_sysobject)
Purpose
Displays the permissions for a selected object.
Parameters
properties (type dm_message_archive)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
failoverenabled
properties (type dm_message_archive)
Purpose
Displays the properties of an object (dm_message_archive).
Since
6.5
properties (type dm_sysobject)
Purpose
Displays the properties of an object (dm_sysobject).
Parameters
enableShowAll (Optional) Determines whether the Show All

checkbox is displayed.(true|false)
relationships (type dm_sysobject)
preferForms (Optional) Set to true to launch the forms

properties component
templateId (Optional) ID of associated Xforms template, if
any
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
failoverenabled
relationships (type dm_sysobject)
Purpose
Shows relationships between objects.
Parameters
folderId (Optional) ID of the folder that contains the

selected object.
folderPath (Optional) Path to the folder that contains the
selected object. This path must be a complete
path from the repository root, for example,
/Documentation/Library/subfolder
objectNamePrefix (Optional)
rename (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
failoverenabled
rename (type dm_sysobject)
Purpose
Renames an object in the repository. The user must have a role of contributor or higher and
write_permit access to the parent folder or cabinet (valid values: DELETE_PERMIT | WRITE_PERMIT
|VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT | BROWSE_PERMIT | NONE_PERMIT).
Parameters
lockOwner (Optional) User who has checked out the object

objectId (Required) The ID of the object to be renamed.
ownerName (Optional) User who owns the checked in object
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
versions (type dm_sysobject)
Elements
None.
Purpose
Displays the versions of an object. Versions are disabled for folders and cabinets
Parameters

selected object.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
failoverenabled
folderbrowse (privilege sysadmin, type dm_user)
Cabinets and folders
folderbrowse (privilege sysadmin, type dm_user)
Purpose
Allows the administrator to browse a list of folders in a repository.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
newcabinet (type dm_docbase)
Purpose
Creates a new cabinet in a repository
newfolder (type dm_folder)
Parameters
ownerName (Optional) Name of the user having the rights

to create a new cabinet
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_cabinet_actions.xml
Scope
type dm_docbase
Elements
None.
newfolder (type dm_folder)
Purpose
Creates a new folder. The user must have a contributor role. The permit value folder_link_permit
performs a check for write permissions on the folder when the folder security is enabled.
Parameters
objectId (Required) ID of the folder or cabinet that will

contain the new object.
ownerName (Optional) Name of the owner of the folder or
cabinet. Used by the NewObjectPrecondition
class to determine whether the action can be
performed.
rename (type dm_folder)
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_folder_actions.xml
Scope
type dm_folder
Elements
None.
rename (type dm_folder)
Purpose
Renames a folder in the repository. The user must have a role of contributor or higher and
write_permit access to the parent folder or cabinet (valid values: DELETE_PERMIT | WRITE_PERMIT
Parameters
objectId (Required) The ID of the folder to be renamed.

ownerName (Optional) User who owns the folder
Description
Since
5.x
Configuration File
Scope
type dm_folder
submitforcategorization (type dm_document)
Elements
None.
Categories
submitforcategorization (type dm_document)
Purpose
Submits a document for categorization by the CI Server. The repository must have Content
Intelligence Services installed and configured.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_document_actions.xml
Scope
type dm_document
Elements
None.
addtoclipboard (type dm_sysobject)
Clipboard operations
addtoclipboard (type dm_sysobject)
Purpose
Adds an object to the clipboard.
Parameters
isReference (Optional) Boolean flag that indicates whether

the object is a reference object
objectId (Required) ID of the object to be added to the
clipboard.
ownerName (Optional) Name of owner of the object to be
added to the clipboard
type (Optional) The content type of the object.
Description
Since
5.x
Configuration File
webcomponent\config\environment\clipboard\dm_sysobject_clipboard_actions.xml
Scope
type dm_sysobject
Elements
None.
addtoclipboard (type dmc_workqueue_category)
addtoclipboard (type dmc_workqueue_category)
Purpose
Adds a dmc_workqueue_category object to the queue management clipboard.
Parameters
objectId (Required) ID of the dmc_workqueue_category

object to add to the clipboard.
ownerName (Optional) Name of the user who owns the
dmc_workqueue_category to be added to the
clipboard.
type (Optional) Content type of the object to be added
to the clipboard
Description
Since
5.x
Configuration File
Scope
Elements
None.
addtoclipboard (type dmc_workqueue)
Purpose
Adds a dmc_workqueue object to the clipboard.
copy (type dm_sysobject)
Parameters

clipboard.
object.
type (Optional) Content type of the object to be added
to the clipboard.
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
Elements
None.
copy (type dm_sysobject)
Purpose
Copies a clipboard object to a new location
Parameters
None.
Description
Since
5.x
copyhere (type dm_folder)
Configuration File
Scope
type dm_sysobject
Usage
Copy behavior can be configured in the <copy_operation> element of app.xml. Set the value of the
child element <retainstorageareas> to true to retain storage areas.
The abstract clipboard class ignores auxiliary files for the linked or copied object if they are not in the
clipboard. The link or copy operation proceeds without the auxiliary files. Whether a linked file is
auxiliary can be determined by calling isAuxiliaryObject(objectId).
Elements
None.
copyhere (type dm_folder)
Purpose
Copies a clipboard object to the target folder.
Parameters
objectId (Required) Object ID of the target folder to

which the clipboard contents are to be copied.
Description
Since
6.0
Configuration File
Scope
type dm_folder
link (type dm_sysobject)
Elements
None.
link (type dm_sysobject)
Purpose
Links a clipboard object to a new location
Parameters
None.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
linkhere (type dm_folder)
Purpose
Links a clipboard object to the target folder.
move (type dm_sysobject)
Parameters

which the clipboard contents are to be linked.
Description
Since
6.0
Configuration File
Scope
type dm_folder
Elements
None.
move (type dm_sysobject)
Purpose
Moves a clipboard object to a new location
Parameters
None.
Description
Since
5.x
Configuration File
movehere (type dm_folder)
Scope
type dm_sysobject
Usage
The move operation can be globally configured as the value of <move_operations>.<all_versions>
in app.xml to move the selected version (false) or to move all versions of the selected object (true).
With the value of true, if the object has versions linked to other folders, only the versions linked to the
folder containing the current version will be moved. When a virtual document is selected and move,
only the root document is moved with all its versions, not the descendants.
Elements
None.
movehere (type dm_folder)
Purpose
Moves a clipboard object to the target folder.
Parameters

which the clipboard contents are to be moved.
Description
Since
6.0
Configuration File
Scope
type dm_folder
Elements
None.
viewclipboard
viewclipboard
Purpose
Displays the clipboard
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
Collaboration
accessiblefolderbrowser (entitlement collaboration6,

role dce_user_manager)
Purpose
Enables a Documentum Collaborative Services manager to locate dm_user objects.
delete (entitlement collaboration, type dmc_notepage)
Parameters
flatlist (Optional) Boolean: Set to true to list all objects

in a flat list, set to false to display objects in a
drop-down list.
multiselect (Optional) Boolean: Set to true to support
multiple object selection.
objecttype (Optional) Type of the selected object.
selectedobjectids (Optional) Comma-delimited or semicolon-
delimited list of object IDs that are initially
selected.
Description
Since
5.x
Configuration File
Scope
role dce_user_manager
Elements
None.
delete (entitlement collaboration, type

dmc_notepage)
Purpose
Deletes a dmc_notepage object. Requires a Documentum Collaborative Services license.
delete (type dmc_datatable)
Parameters
folderId (Optional) ID of the folder in which the

dmc_notepage object to delete resides.
lockOwner (Optional) Lock owner of the dmc_notepage
object to delete.
objectId (Required) Object ID of the dmc_notepage object
to delete.
ownerName (Optional) Owner name of the dmc_notepage
object to delete.
Description
Since
5.x
Configuration File
webcomponent\config\library\notepage\dmc_notepage_actions.xml
Scope
entitlement collaboration
type dmc_notepage
Elements
None.
Purpose
Deletes a dmc_datatable object. Requires a Documentum Collaborative Services license.
Parameters
objectId (Required) Object ID of the dmc_datatable object

to be deleted.
folderId (Optional) Folder ID of the folder that contains
the dmc_datatable object to be deleted.
drlview (entitlement collaboration, type dmc_notepage)
Description
Since
5.x
Configuration File
webcomponent/config/library/datatables/deletedatatable_component.xml
Scope
type dmc_notepage
Elements
None
drlview (entitlement collaboration, type

dmc_notepage)
Purpose
Navigates to the parent folder or object of the DRL and opens the dmc_notepage object for viewing.
Requires a Records Manager license.
Parameters

to be opened.
Description
Since
5.x
Configuration File
drlview (type dmc_datatable_row)
Scope
type dmc_notepage
Elements
None.
drlview (type dmc_datatable_row)
Purpose
Navigates to the parent folder or object of the DRL and opens the dmc_datatable_row object for
viewing. Requires a Documentum Collaborative Services license.
Parameters
The parameters are inherited from view:webcomponent/config/actions/dm_sysobject_actions.xml.
See view (type dm_sysobject), page 451.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\datatables\table_entry_actions.xml
Parent Definition
view:webcomponent/config/library/datatables/table_entry_actions.xml
Scope
type dmc_notepage
Elements
None.
editfile (entitlement collaboration, type dmc_notepage)
editfile (entitlement collaboration, type

dmc_notepage)
Purpose
Launches the editing application for dmc_notepage objects as recognized by the operating system for
the document extension. Requires a Records Manager license.
Parameters

to be opened.
ownerName (Optional) User name of owner of the
dmc_notepage object to be opened.
Description
Since
5.x
Configuration File
Scope
type dmc_notepage
Elements
None.
editfile (type dmc_calendar_event)
Purpose
Edits dmc_calendar_event objects.
editfile (type dmc_datatable_row)
Parameters
The parameters are inherited from editfile:webcomponent/config/actions/dm_sysobject_actions.xml.
See editfile (type dm_sysobject), page 438.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_event_actions.xml
Parent Definition
editfile:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dmc_calendar_event
Elements
None.
editfile (type dmc_datatable_row)
Purpose
Calls the properties (type dmc_datatable), page 925 container component to edit dmc_datatable_row
objects.
Parameters
Description
Since
6.0
editfile (type dmc_datatable)
Configuration File
Parent Definition
Scope
type dmc_datatable_row
Elements
None.
editfile (type dmc_datatable)
Purpose
Calls the properties (type dmc_datatable), page 925 container component to edit dmc_datatable
objects.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\table_actions.xml
Parent Definition
Scope
type dmc_datatable
Elements
None.
er_properties (Webtop)
Purpose
Parameters
enableShowAll (Optional) For internal use only.

er_objectId (Required) For internal use only.
newFile (Required) For internal use only.
Description
Since
5.x
Configuration File
webtop\config\eroom_properties_component.xml
Scope
All.
Elements
None.
er_search (Webtop)
Purpose
Parameters
component (Optional) For internal use only.
folderbrowse (entitlement collaboration6, role dce_user_manager)
Description
Since
5.x
Configuration File
webtop\config\eroom_search_action.xml
Scope
All.
Elements
None.
folderbrowse (entitlement collaboration6, role

dce_user_manager)
Purpose
Enables a Documentum Collaborative Services manager to browse a list of folders in a repository.
Parameters

drop-down list.
selected.
Description
Since
5.x
Configuration File
folderbrowse (type dm_member_user, entitlement collaboration6)
Scope
Elements
None.
folderbrowse (type dm_member_user, entitlement

collaboration6)
Purpose
Enables browsing a list of folders in a repository. Requires Documentum Collaborative Services
license.
Parameters
None.
Description
Since
6.0
Configuration File
Scope
type dm_member_user
Elements
None.
govern (entitlement collaboration)
govern (entitlement collaboration)
Purpose
Causes an object to become governed by a room. Requires Documentum Collaborative Services. The
object’s access is restricted to a rooms membership, and object can be governed by only one room.
Parameters
folderId (Required) ID of the governed folder that will

contain the selected object..
roomId (Required) ID of the room that will govern the
object.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\room_actions.xml
Scope
Elements
None.
governfolder (entitlement collaboration)
Purpose
Launches the govern component to govern a folder. The UI asks the user to specify whether child
objects should also become governed. Requires Documentum Collaborative Services.
groupbrowse (type dm_member_user, entitlement collaboration6)
Parameters
folderId (Required) ID of the governed folder that will

contain the new governed folder.
ownerName (Optional) Name of the folder owner
roomId (Required) ID of the room that will govern the
folder
sourceFolderId (Optional) ID of the folder that will be added to
the governed folder or room
Description
Since
5.x
Configuration File
Scope
Elements
None.
groupbrowse (type dm_member_user, entitlement

collaboration6)
Purpose
Allows the administrator to browse a list of groups for dm_member_user objects in a repository.
Requires a Documentum Collaborative Services license.
Parameters
None.
import (type dmc_datatable)
Description
Since
5.x
Configuration File
Scope
type dm_member_user
Elements
None.
import (type dmc_datatable)
Purpose
Imports dmc_datatable objects from the client file system to the repository.
Parameters
objectId (Required) ID of the target folder into which to

import the object.
Description
Since
6.0
Configuration File
Scope
type dmc_datatable
markread (entitlement collaboration, type dm_sysobject)
Elements
None.
markread (entitlement collaboration, type

dm_sysobject)
Purpose
Marks a topic as having been read. Requires Documentum Collaborative Services.
Parameters
objectId (Required) ID of the topic to mark as read.

topicStatus (Optional) Valid values of TopicStatusAttribute-
DataHandler: 0 (STATUS_DISABLED) | 1 (STA-
TUS_NONE) | 2 (STATUS_NO_COMMENTS) |
3 (STATUS_READ) | 4 (STATUS_UNREAD)
Description
Since
5.x
Configuration File
webcomponent\config\library\discussion\topic_actions.xml
Scope
type dm_sysobject
Elements
None.
markunread (entitlement collaboration, type dm_sysobject)
markunread (entitlement collaboration, type

dm_sysobject)
Purpose
Marks a selected topic as unread. Requires Documentum Collaborative Services.
Parameters
objectId (Required) ID of the topic to mark as unread.

Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
nativeroombrowse (type dm_group)
Purpose
Calls the nativeroomobjectlocatorcontainer, page 907 to browse a room.
newcalendar (type dm_folder, entitlement collaboration6)
Parameters
objectId (Optional) Object ID of the room to browse.
Description
Since
6.0
Configuration File
Scope
type dm_group
Elements
None.
newcalendar (type dm_folder, entitlement

collaboration6)
Purpose
Creates a new calendar, which is a dm_folder object.
Parameters
objectId (Required) ID of a dm_folder object.

ownerName (Optional) User name of the owner of the object.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_actions.xml
newcalendarevent (type dmc_calendar)
Scope
type dm_folder
Elements
None.
newcalendarevent (type dmc_calendar)
Purpose
Creates a new calendar event object (dmc_calendar).
Parameters
objectId (Required) ID of the dmc_calendar object to

create.
ownerName (Optional) User name of the owner of the
dmc_calendar object.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_actions.xml
Scope
type dmc_calendar
Elements
None.
newinvitewindow (entitlement collaboration6)
newinvitewindow (entitlement collaboration6)
Purpose
Calls the newinvitewindow (entitlement collaboration), page 911 component to send an invitation
to selected room members.
Parameters
objectId (Required) ID of the dmc_room object for which

to send an invitation.
Description
Since
6.0
Configuration File
Scope
Elements
None.
newnotepage (entitlement collaboration, type

dm_folder)
Purpose
Creates a new note object. A note is a content file that can be displayed directly in the browser.
Requires Documentum Collaborative Services.
newroom (entitlement collaboration, privilege creategroup, type dm_folder)
Parameters

performed.
Description
Since
5.x
Configuration File
Scope
type dm_folder
Elements
None.
newroom (entitlement collaboration, privilege

creategroup, type dm_folder)
Purpose
Creates a new room object (subtype of dm_folder). Requires Documentum Collaborative Services
Parameters
objectId (Required) ID of the cabinet in which to create

a room.
ownerName (Optional) Name of the object owner
newtable (type dm_folder, entitlement collaboration6)
Description
Since
5.x
Configuration File
Scope
privilege creategroup
type dm_folder
Elements
None.
newtable (type dm_folder, entitlement

collaboration6)
Purpose
Calls the newtable, page 917 component to create a new dmc_datatable object. Requires Documentum
Collaborative Services.
Parameters
objectId (Required) ID of the dm_folder object in which

to create the dmc_datatable object.
ownerName (Optional) User name of the owner of the new
dmc_datatable object.
Description
Since
6.0
Configuration File
newtableentry (type dmc_datatable)
Scope
type dm_folder
Elements
None.
newtableentry (type dmc_datatable)
Purpose
Calls the newtableentry, page 918 component to create a new entry in a dmc_datatable object.
Requires Documentum Collaborative Services.
Parameters
objectId (Required) ID of the dmc_datatable object in

which to create the new entry.
dmc_datatable object in which to create the new
entry.
Description
Since
6.0
Configuration File
Scope
type dmc_datatable
Elements
None.
newuser (entitlement collaboration6, privilege sysadmin, type dm_user)
newuser (entitlement collaboration6, privilege

sysadmin, type dm_user)
Purpose
Enables administrators to create users (dm_user objects). Requires a Documentum Collaborative
Services license.
Parameters

Description
Since
5.x
Configuration File
Scope
Since 6.0.
privilege sysadmin
type dm_user
Elements
None.
newuser (entitlement collaboration6, role dce_user_manager, type dm_user)
newuser (entitlement collaboration6, role

dce_user_manager, type dm_user)
Purpose
Enables a Documentum Collaborative Services manager to create a new user (dm_user object).
Requires Documentum Collaborative Services license.
Parameters
objectId (Required) ID of the selected user.

Description
Since
5.x
Configuration File
Scope
Since 6.0.
type dm_user
Elements
None.
options (type dmc_room)
Purpose
Launches the roomoptions component with room options such as setting a banner and default
permissions
properties (entitlement collaboration, type dm_folder)
Parameters
objectId (Required) Room ID
Description
Since
5.x
Configuration File
Scope
type dmc_room
Elements
failoverenabled
properties (entitlement collaboration, type

dm_folder)
Purpose
Displays the message archive properties of an object (dm_sysobject).
Since
6.5
properties (entitlement collaboration6, type

dm_user)
Purpose
Displays the properties of a user (dm_user object).
properties (type dmc_rm_formal_record, dmc_rm_formal_rec_folder, dmc_rm_formal_rec_cabinet)
Parameters

Description
Since
5.x
Configuration File
Scope
Since 6.0.
type dm_user
Elements
None.
properties (type dmc_rm_formal_record, dmc_rm_

formal_rec_folder, dmc_rm_formal_rec_cabinet)
Purpose
Displays the properties of a dmc_rm_formal_record, dmc_rm_formal_rec_folder,
dmc_rm_formal_rec_cabinet object.
Since
6.5
roommembers (type dmc_room)
roommembers (type dmc_room)
Purpose
Displays the members of a room. Requires Documentum Collaborative Services.
Parameters
enableShowAll (Optional) Not used

objectId (Required) ID of the room
Description
Since
5.x
Configuration File
Scope
type dmc_room
Elements
None.
showtopic (entitlement collaboration, type

dm_sysobject)
Purpose
Displays a discussion with threaded topics. Requires Documentum Collaborative Services.
Parameters
folderId (Optional) ID of folder containing a discussion

folderPath (Optional) Path to folder containing a discussion
showtopicaction (entitlement collaboration, type dm_sysobject)
objectId (Required) ID of the discussion.

type (Optional) Not used
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
showtopicaction (entitlement collaboration, type

dm_sysobject)
Purpose
Displays a topic. Requires Documentum Collaborative Services.
Parameters
folderId (Optional) ID of the current folder

objectId (Required) ID of the topic’s parent
type (Optional) Object type of the selected object
showtopicaction (entitlement collaboration, type dm_sysobject) (Webtop)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
showtopicaction (entitlement collaboration, type

dm_sysobject) (Webtop)
Purpose
Calls the WDK showtopic action to launch the showtopic component, which displays a topic.
Parameters
folderId (Optional) ID of the folder containing the note.

objectId (Required) ID of the topic.
topicStatus (Optional) Integer that denotes status of topic
(set by topicstatus control): 0 = disabled | 1 =
none | 2 = read | 3 = unread
type (Optional) Subtype of dm_sysobject. Must
be dmc_notepage or a subtype in order to be
viewed.
Description
Since
5.x
tablefields (type dmc_datatable)
Configuration File
webtop\config\dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
tablefields (type dmc_datatable)
Purpose
Displays the datatable fields. Calls the tablefields, page 939 component.
Parameters
objectId (Required) Object ID of the dmc_datatable_row

object.
Description
Since
6.0 SP1
Configuration File
Scope
Elements
None.
ungovern (entitlement collaboration)
ungovern (entitlement collaboration)
Purpose
Causes an object to become ungoverned by a room. Requires Documentum Collaborative Services.
Parameters

roomId (Required) ID of the room that governs the
object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
ungovernfolder (entitlement collaboration)
Purpose
Causes a folder to become ungoverned by a room. Requires Documentum Collaborative Services.
view (entitlement collaboration, type dmc_notepage)
Parameters
objectId (Required) ID of the selected folder.

ownerName (Optional) User who owns the selected folder.
roomId (Required) ID of the room that currently governs
the folder.
Description
Since
5.x
Configuration File
Scope
Elements
None.
view (entitlement collaboration, type dmc_notepage)
Purpose
Displays a note object. A note is a content file that can be displayed directly in the browser. Requires
Documentum Collaborative Services.
Parameters
folderPath (Optional) Path to the folder in which the

dmc_notepage object resides.
to view.
view (type dmc_calendar_event)
Description
Since
5.x
Configuration File
Scope
type dmc_notepage
Elements
None.
view (type dmc_calendar_event)
Purpose
Calls the attributes (type dmc_calendar_event), page 875 component.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_event_actions.xml
Parent Definition
Scope
view (type dmc_datatable_row)
Elements
None.
view (type dmc_datatable_row)
Purpose
Calls the properties (type dmc_datatable), page 925 container component.
Parameters
The parameters are inherited from view:webcomponent/config/actions/dm_sysobject_actions.xml.
See view (type dm_sysobject), page 451.
Description
Since
6.0
Configuration File
Parent Definition
view:webcomponent/config/actions/dm_sysobject_actions.xml
Since 6.0 SP1.
Scope
Elements
None.
newdocument (type dm_folder)
Creating objects
newdocument (type dm_folder)
Purpose
Creates a document within a folder. The user must have a contributor role. The permit value
folder_link_permit performs a check for write permissions on the folder when folder security
is enabled.
Parameters
contentType (Optional) Document format

editAfterCreate (Optional) Specifies whether the document can
be edited after creation
performed.
Description
Since
5.x
Configuration File
Scope
type dm_folder
Elements
None.
exporttocsv
Data export
exporttocsv
Purpose
Calls the exporttocsv, page 946 component to export a datagrid to a comma-separated value file.
Parameters
None.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
exportrowstocsv
Purpose
Calls the exporttocsv, page 946 component to export selected rows of a datagrid to a comma-separated
value file.
Parameters
selection (Optional) Specifies the index of the selected

rows.
auditimagingaction
Description
Since
6.6
Configuration file
Scope
All.
Elements
None.
Document Imaging Services
auditimagingaction
Purpose
Parameters
activity (Optional) For internal use only.

description (Optional) For internal use only.
objectId (Required) For internal use only.
printername (Optional) For internal use only.
Description
Since
6.0
Configuration File
webcomponent\config\actions\imaging_actions.xml
saveannotation (type dm_document)
Scope
All.
Elements
None.
saveannotation (type dm_document)
Purpose
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\actions\imaging_actions.xml
Scope
type dm_document
Elements
None.
cancelcheckout (type dm_sysobject)
Downloading and uploading content
Purpose
Cancels the checked out status of an object. The user must have version level permission (valid values:
DELETE_PERMIT | WRITE_PERMIT | VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT |
BROWSE_PERMIT | NONE_PERMIT).
Parameters

nodeId (Optional) Node ID of the object to check out,
when checking out part of a virtual document.
objectId (Required) ID of the object to be checked in.
vdmRootObjectId (Optional) Object ID of the root object of a
virtual document.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
checkin (type dm_sysobject)
Purpose
Checks in the selected object. The user must have version_permit access to the object (valid values:
DELETE_PERMIT | WRITE_PERMIT|VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT |
BROWSE_PERMIT | NONE_PERMIT). The user must be assigned to a contributor role defined in
the repository.
Parameters
filenamewithpath (Optional) Name and path of the file to be

checked in.
keepLocalFile (Optional) Whether to keep the local file on the
machine (True) or not (False).Since 6.0.
nodeId (Optional) ID of the repository node
objectId (Required) ID of the object to be checked in.
retainLock (Optional) Boolean: Whether to keep the lock on
the object (True) or not (False).Since 6.0.
silent (Optional) Boolean: Whether to check in the
object without displaying the checkin or checkin
from dialog box (True) or not (False). If you
specify true for this parameter, you must specify
a valid value for the version parameter.Since 6.0.
vdmRootObjectId (Optional) Object ID of the root for a virtual
document, when checking in a virtual document
version (Optional) Whether to check in the object as a
major, minor, branched, or the same version
when true is specified for the silent parameter.
Valid values are: major, minor, branch, same. If
this parameter is not specified, then the checkin
dialog box is displayed even when true is
specified for the silent parameter.Since 6.0.
Description
Since
5.x
checkout (type dm_sysobject)
Configuration File
Scope
type dm_sysobject
Elements
None.
Purpose
Checks out the selected object. The user must have version level permission (valid values:
DELETE_PERMIT | WRITE_PERMIT |VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT |
Parameters
compoundArchitecture (Optional)
isIgnoreDescendents (Optional) Boolean value that indicates whether
or not to check out descendants in a virtual
document.
isLockOnly (Optional) Boolean flag that indicates whether
the object should be locked but not copied to the
checkout location
nodeId (Optional) Node ID of the object to check out,
objectId (Required) ID of the object to be checked out.
vdmRootObjectId (Optional) Object ID of the root of a virtual
document.
delete (privilege sysadmin, type dm_user)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
delete (privilege sysadmin, type dm_user)
Purpose
Deletes a user from the repository.
Parameters

Description
Since
5.x
Configuration File
Scope
privilege sysadmin
type dm_user
delete (type dm_folder)
Elements
None.
Purpose
Deletes one or more folder objects. The user must have a role of contributor.
Parameters
folderId (Optional) The ID of the folder in which the

object is located
objectId (Required) The ID of the object to be deleted.
ownerName (Optional) The name of the user who owns the
object to be deleted
Description
Since
5.x
Configuration File
Scope
type dm_folder
Elements
None.
delete (type dm_group)
Purpose
Deletes a group from the repository.
delete (type dm_notification)
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
Purpose
Deletes a notification.
Parameters

objectName (Optional) The name of the notification object
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_notification_actions.xml
delete (type dm_sysobject)
Scope
type dm_notification
Elements
None.
Purpose
Deletes one or more objects. The user must have a role of contributor. In addition, the user
must have the DELETE_PERMIT access (valid values: DELETE_PERMIT | WRITE_PERMIT |
VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT | BROWSE_PERMIT | NONE_PERMIT).
Parameters

object is located
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
delete (type dmc_comment)
Purpose
Deletes one or more comment objects. The user must have a role of contributor.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\actions\dmc_comment_actions.xml
Scope
type dmc_comment
Elements
None.
delete (type dmr_content)
Purpose
Deletes the selected rendition. The user must have write permission on the base object.If the selected
object is a replica, it cannot be deleted.
Parameters
contentType (Required) Type of the selected rendition.

delete (type job_request)
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmr_content_actions.xml
Scope
type dmr_content
Elements
None.
delete (type job_request)
Purpose
Deletes a job request from the repository.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\admin\renamelog\renamelog_actions.xml
Scope
type job_request
Elements
None.
downloadcontent (type dm_sysobject)
downloadcontent (type dm_sysobject)
Purpose
Downloads the selected object to the disk.
Parameters
contentSize (Optional) Size of the object in bytes

contentType (Optional) File format to use when opening the
object (passed to the operating system)
or not to download descendants in a virtual
document.
nodeId (Optional) Node ID of the object to download,
objectId (Required) ID of the object to be viewed.
type (Optional) Object type
document (when operating on a child node).
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
drledit (type dm_sysobject)
drledit (type dm_sysobject)
Purpose
Extends the action editfile (type dm_sysobject), page 438 and opens a DRL for editing. This action is
not defined for folders.
Parameters
objectId (Required) ID of the object to be viewed. (This is

the only parameter defined for templates.)
(dm_query only)
document.
nodeId (Optional) Node ID of the object to open, when
opening part of a virtual document.
ownerName (Optional) Name of the user who owns the object
skipVersionCheck (Optional) Boolean: Whether to prompt the user
to choose the current version of an object when
the object is not the current version (False) or not
(True). Default is false.
chronicleId (Optional) Holds the same value across all
versions of an object. It is created for all objects
when the Automatic DRL Resolution setting is
enabled.
Description
Since
5.x
Configuration File
drledit (type dm_sysobject) (Webtop)
Parent Definition
Scope
type dm_sysobject
Elements
None.
drledit (type dm_sysobject) (Webtop)
Purpose
Navigates to myfiles component and performs editfile action on the object referenced by the DRL
(document resource locator).
Parameters
navigateOnComplete (Optional) Boolean: By default (true), navigates

to the main component after the edit action.
When this value is set to false, the component
does not navigate to the main component after
the edit action.
objectId (Required) ID of the object to open for editing.
enabled.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
drledit (type dmc_search_template)
Elements
None.
Purpose
Uses a DRL to open a search template for editing.
Parameters
The parameters are inherited from edittemplate:webcomponent/config/actions/dmc_search_
template_actions.xml. See edittemplate (type dmc_search_template), page 526.
Description
Since
6.0
Configuration File
webcomponent\config\actions\dmc_search_template_actions.xml
Parent Definition
edittemplate:webcomponent/config/actions/dmc_search_template_actions.xml
Scope
type search_template
Elements
None.
drlview (type dm_folder) (Webtop)
Purpose
Navigates to the parent folder or object and performs the view action on the object referenced by the
DRL. This action is scoped to dm_sysobject, dm_folder, and dmi_queue_item.
drlview (type dm_message_archive) (Webtop)
Parameters

object (passed to the operating system).
Description
Since
5.x
Configuration File
webtop\config\dm_folder_actions.xml
Scope
type dm_folder
Elements
None.
drlview (type dm_message_archive) (Webtop)
Purpose
Opens a DRL to a dm_message_archive object for viewing.
Parameters
folderPath (Optional) Path to the folder in which the

dm_message_archive object resides.
objectId (Required) ID of the dm_message_archive object
to be viewed.
Description
Since
6.0
drlview (type dm_sysobject)
Configuration File
webtop\config\dm_message_archive_action.xml
Scope
type dm_message_archive
Elements
None.
drlview (type dm_sysobject)
Purpose
Opens a DRL for viewing.
Parameters

vdmRootObjectId (Optional) Object ID of the root of the virtual
document.
node to view.
assembledFromId (Optional) ID of the virtual document from
which the assembly was assembled
isIgnorePrefRenditions (Optional) Boolean: Whether to ignore the user’s
preference for opening renditions (True) or not
(False). Default is false. Since 5.3 SP4.
enabled.
drlview (type dm_sysobject) (Webtop)
Description
Since
5.x
Configuration File
Parent Definition
view:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
drlview (type dm_sysobject) (Webtop)
Purpose
Parameters

which the assembly was created.
isVirtualDoc (Optional) Boolean: Whether the object is a
virtual document (True) or not (False)
navigateOnComplete (Optional) Boolean: By default (true), navigates
to the main component after the view action.
When this value is set to false, the component
does not navigate to the main component after
the edit action.
drlview (type dmi_queue_item) (Webtop)

to be viewed.
enabled.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
drlview (type dmi_queue_item) (Webtop)
Purpose
Parameters

dmi_queue_item object (passed to the operating
system).
objectId (Required) ID of the dmi_queue_item object to
view.
drlview (type dmc_search_template)
Description
Since
5.x
Configuration File
webtop\config\dmi_queue_item_actions.xml
Scope
type dmi_queue_item
Elements
None.
drlview (type dmc_search_template)
Purpose
Navigates to the parent folder or object and performs the view action on the search template object
referenced by the DRL.
Parameters
The parameters are inherited from runsearchtemplate:webcomponent/config/actions/dmc_search_
template_actions.xml. See runsearchtemplate (type dmc_search_template), page 531.
Description
Since
6.0
Configuration File
Parent Definition
view:webcomponent/config/actions/dmc_search_template_actions.xml
Scope
type search_template
editafternew (type dm_sysobject)
Elements
None.
editafternew (type dm_sysobject)
Purpose
Launches the editing application, as recognized by the operating system for the document extension,
when a new object is created. The user must have a contributor role.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
type dm_sysobject
Elements
None.
editfile (type dm_sysobject)
editfile (type dm_sysobject)
Purpose
Launches the editing application, as recognized by the operating system for the document extension.
The user must have version level permission (valid values: DELETE_PERMIT | WRITE_PERMIT
The user must also have a contributor role.
Parameters

(dm_query only)
nodeId (Optional) Node ID of the object to open, when
opening part of a virtual document.
objectId (Required) ID of the object to be viewed. (This is
document.
Description
Since
5.x
Configuration File
export (type dm_message_archive)
Scope
type dm_sysobject
Elements
None.
export (type dm_message_archive)
Purpose
Exports a dm_message_archive object to the local filesystem.
Since
6.5
export (type dm_sysobject)
Purpose
Exports the object to the local file system.
Parameters

contentType (Optional) File format of the object (passed to
the operating system)
nodeId (Optional) Node ID of the object to export, when
exporting part of a virtual document.
objectId (Required) ID of the object to be exported.
document.
exportrendition (type dmr_content)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
exportrendition (type dmr_content)
Purpose
Exports a rendition to the local file system and launches the viewing application for the selected
rendition
Parameters
contentType (Required) File format to use when opening the

pageModifier (Optional) A valid value for the page_modifier
attribute of the dmr_content object. Do not pass
in your own value for PDF renditions.
Description
Since
5.x
Configuration File
import (type dm_folder)
Scope
type dmr_content
Elements
None.
import (type dm_folder)
Purpose
Launches import of an object from the local file system to the repository. The user must have a
contributor role. The permit value folder_link_permit performs a check for write permissions on
the folder when the folder security is enabled.
Parameters
baseDocbaseType (Optional) Base object type for import

docbaseType (Optional) Object type of imported object
filePath (Optional) Path to the file on the local machine
format (Optional) Format of the object to be imported
isDirectory (Optional) Boolean that indicates whether the
object being imported is a directory
objectId (Required) ID of the destination folder.
objectName (Optional) Name of object to be imported
ownerName (Optional) Name of the owner of the destination
folder.
parentPath (Optional) Repository path into which the file
is imported
Description
Since
5.x
Configuration File
importrendition (type dm_sysobject)
Scope
type dm_folder
Elements
None.
importrendition (type dm_sysobject)
Purpose
Imports an HTML or PDF rendition of the selected object. The user must have version level
permission on the object. The user must have read_permit access to the object (valid values:
DELETE_PERMIT | WRITE_PERMIT |VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT |
Parameters
contentType (Optional) Type of rendition to import

fileNameWithPath (Optional) Path (including the file name) of the
file to import.Since 6.0.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
importrendition (type dmr_content)
Elements
None.
importrendition (type dmr_content)
Purpose
Imports a file to create a new rendition
Parameters
contentType (Optional) File format to use when importing

the object (passed to the operating system).
isReference (Optional) Boolean flag that specifies whether
the object is a reference
Description
Since
5.x
Configuration File
Scope
type dmr_content
Elements
None.
importrenditiongeneric (type dm_sysobject)
importrenditiongeneric (type dm_sysobject)
Purpose
Imports an HTML or PDF rendition of the selected object. The user must have version level
permission on the object.
Parameters
The parameters are inherited from webcomponent\config\actions\dm_sysobject_actions.xml. See
importrendition (type dm_sysobject), page 442
Description
Since
5.x
Configuration File
Parent Definition
importrendition:application=’webcomponent’ type=’dm_sysobject’
Scope
type dm_sysobject
Elements
None.
importrenditiongeneric (type dmr_content)
Purpose
Imports a file to create a new rendition
Parameters
importrendition (type dm_sysobject), page 442
messagearchiveattachviewproperties
Description
Since
5.x
Configuration File
Parent Definition
importrendition:application=’webcomponent’ type=’dm_sysobject’
Scope
type dmr_content
Elements
None.
messagearchiveattachviewproperties
Purpose
Views the properties of dm_message_archive object attachments.
Since
6.5
view_as_html_drilldown (type dm_message_

archive) (Webtop)
Purpose
Calls the drilldown (type dm_message_archive), page 953 component to open a dm_message_archive
object for viewing as HTML.
view_as_html (type dm_message_archive) (Webtop)
Parameters
folderPath (Optional) Specifies the path to the folder in

which to start browsing. This path must be
a complete path from the repository root, for
example: /Documentation/Library/subfolder.
objectId (Required) ID of the dm_message_archive
object.
Description
Since
6.0
Configuration File
Scope
Elements
None.
view_as_html (type dm_message_archive) (Webtop)
Purpose
Calls the doclist (type dm_message_archive), page 1051 component to open a dm_message_archive
object for viewing as HTML.
Parameters

object.
view_as_outlook_mail_msg (type dm_message_archive)
Description
Since
6.0
Configuration File
Scope
Elements
None.
view_as_outlook_mail_msg (type dm_message_

archive)
Purpose
Opens a dm_message_archive object for viewing in Microsoft Outlook.
Parameters

isReference (Optional) Set to true if the selected object is a
reference object.
to view.
Description
Since
6.5
view (type dm_folder) (Webtop)
Configuration File
webcomponent\config\actions\dm_message_archive_action.xml
Scope
Elements
None.
Purpose
Launches a viewing application.
Parameters
contentSize (Optional) Size of object to view, in bytes

isCurrentVDMNode (Optional) Boolean flag that specifies whether
the node is the root node of the current virtual
document. The menu item to remove a node is
disabled if the node is the root node.
the object is a reference
isVirtualDoc (Optional) Set to true to specify that the object to
be viewed is a virtual document
linkCount (Optional) Number of links (child nodes) in a
document. If greater than 0, the document is a
virtual document.
lockOwner (Optional) Name of object owner
objectId (Required) ID of the selected object
type (Optional) Type of the selected object
view (type dm_message_archive)
Description
Since
5.x
Configuration File
webtop\config\dm_folder_actions.xml
Scope
type dm_folder
Elements
None.
view (type dm_message_archive)
Purpose
Opens a dm_message_archive object for viewing as HTML in Microsoft Outlook.
Since
6.5
view (type dm_message_archive) (Webtop)
Purpose
Calls the drilldown (type dm_message_archive), page 953 component to open a dm_message_archive
object for viewing as HTML, the doclist (type dm_message_archive), page 1051 component
to open a dm_message_archive object for viewing as HTML, the exportviewcontainer (type
dm_message_archive), page 1003 or the httpview (Webtop), page 1024 component to open a
dm_message_archive object for viewing in Microsoft Outlook.
view (type dm_message_archive) (Webtop)
Parameters

which the assembly was created.
contentSize (Optional) Size of object to view, in bytes.
the object is a reference.
be viewed is a virtual document.
virtual document.
lockOwner (Optional) Name of the user who has the object
locked.
type (Optional) Object type of the selected object.
Description
Since
6.0
Configuration File
Scope
Elements
None.
view (type dm_sysobject)
Purpose
Launches the viewing application for the selected object. The user must have read_permit
access to the object (valid values: DELETE_PERMIT | WRITE_PERMIT |VERSION_PERMIT |
RELATE_PERMIT | READ_PERMIT | BROWSE_PERMIT | NONE_PERMIT).
Parameters

(False). Default is false. Since 5.3 SP4.
node to view.
document.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
view (type dm_sysobject) (Webtop)
Elements
None.
view (type dm_sysobject) (Webtop)
Purpose
Launches a viewing application.
Parameters

which the assembly was assembled.
contentSize (Optional) Size of object to view, in bytes.
(False). Default is true. Since 5.3 SP4.
the object is a reference.
be viewed is a virtual document.
virtual document.
locked.
type (Optional) Object type of the selected object.
view (type dmr_content)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
Purpose
Launches the viewing application for the selected rendition.
Parameters
contentType (Required) File format to use when opening the

(False). Default is true.Since 5.3 SP4.
attribute of the dmr_content object. You should
not pass in your own value for PDF renditions.
Description
Since
5.x
Configuration File
viewcontent (type dm_sysobject)
Scope
type dmr_content
Elements
None.
viewcontent (type dm_sysobject)
Purpose
Opens a virtual document for viewing. The user must have at least read permit on the virtual
document.
Parameters

node to view.
document.
Description
Since
5.x
Configuration File
sendlocator (type dm_queued)
Scope
type dm_sysobject
Elements
None.
Emailing links to objects
Purpose
Sends one or more object locators through email.
Parameters
objectId (Required) ID of the object to send.

type (Optional) Specifies the object type. If null, an
object fetch will determine the type.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_queued_actions.xml
Scope
type dm_queued
Elements
None.
sendlocator (type dm_sysobject)
sendlocator (type dm_sysobject)
Purpose
Sends one or more object locators through email
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
sendto (type dm_sysobject)
Purpose
Sends an object to a user or group
Parameters
sendtodistributionlist (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
sendtodistributionlist (type dm_sysobject)
Purpose
Sends an object to a distribution list
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
newformat (type dm_format)
Formats
newformat (type dm_format)
Purpose
Creates a new Documentum format
Parameters
objectId (Required) Set value to newobject to create new

format.
Description
Since
5.x
Configuration File
webcomponent\config\admin\format\dm_format_actions.xml
Scope
type dm_format
Elements
None.
properties (type dm_format)
Purpose
Displays the properties of a selected format.
accessibilityaction
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\admin\format\dm_format_actions.xml
Scope
type dm_format
Elements
None.
General user interface
accessibilityaction
Purpose
Handles accessibility option for buttons and menu items in a component.
Parameters
accessible (Optional) Set to true to call the menubar

component in accessible mode
Description
Since
5.x
accessibilityaction (type dm_acedm_requiredgroupdm_requiredgroupsetdm_restriction)
Configuration File
Scope
All.
Elements
None.
accessibilityaction (type dm_acedm_

requiredgroupdm_requiredgroupsetdm_restriction)
Purpose
Not used.
Parameters
accessible (Optional) Not used.

accessorName (Required) Not used.
aceavailableactions (Optional) Not used.
basicpermit (Optional) Not used.
extpermit (Optional) Not used.
extpermit_readonly (Optional) Not used.
objectId (Optional) Not used.
objectName (Optional) Not used.
permit (Optional) Not used.
permitType (Optional) Not used.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_accessor_actions.xml
accessiblefolderbrowser (privilege sysadmin, type dm_user)
Scope
type dm_ace, dm_requiredgroup, dm_required-

groupset, dm_restriction
Elements
None.
accessiblefolderbrowser (privilege sysadmin, type

dm_user)
Purpose
Locator for dm_user objects.
Parameters

drop-down list.
selected.
Description
Since
5.x
Configuration File
Scope
privilege sysadmin
type dm_user
abortjob
Jobs
abortjob
Purpose
Aborts an asynchronous action or component job.
Parameters
jobId (Required) ID of the job to abort.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
showjobstatus
Purpose
Displays the status of running asynchronous jobs.
Parameters
None.
showjobstatushistory
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
showjobstatushistory
Purpose
Displays the history of asynchronous jobs.
Parameters
jobId (Required) ID of the selected job.

jobName (Required) Name of the selected job.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
applylifecycle (type dm_sysobject)
Lifecycles
Purpose
Attaches a lifecycle (business policy) to an object
Parameters
isReplica (Optional) Boolean indicating whether the object

is a replica; the action is invalid for replicas
lockOwner (Optional) User who has checked out the
selected object
objectId (Required) The object to which a lifecycle will
be applied.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
demote (type dm_sysobject)
Purpose
Demotes an object to the previous lifecycle state.
detachlifecycle (type dm_sysobject)
Parameters

objectId (Required) ID of the object to be demoted.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
detachlifecycle (type dm_sysobject)
Purpose
Detaches a lifecycle from the selected object.
Parameters

objectId (Required) ID of the object to be demoted.
Description
Since
5.x
Configuration File
promote (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
promote (type dm_sysobject)
Purpose
Promotes an object to the next lifecycle state.
Parameters

objectId (Required) ID of the object to be promoted.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
restorelifecycle (type dm_sysobject)
restorelifecycle (type dm_sysobject)
Purpose
Restores an object from the suspended state to the active state (resumes previous state)
Parameters

objectId (Required) The ID of the object.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
suspendlifecycle (type dm_sysobject)
Purpose
Suspends the lifecycle state of the selected object
Parameters

findtarget (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
Locating objects
findtarget (type dm_sysobject)
Purpose
Allows the user to click on a reference object and navigate to the object or folder in the remote
repository
Parameters

reference object
objectId (Required) ID of the reference object.
openFolder (Optional) Set to true if the reference object is
a folder.
Description
Since
5.x
Configuration File
findtarget (type dm_sysobject) (Webtop)
Scope
type dm_sysobject
Elements
None.
findtarget (type dm_sysobject) (Webtop)
Purpose
repository.
Parameters

reference object.
a folder.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
locations (type dm_cabinet)
locations (type dm_cabinet)
Purpose
Specifies the locations in the repository of a given object (links). This action is disabled for dm_cabinet
objects.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_cabinet_actions.xml
Scope
type dm_cabinet
Elements
None.
locations (type dm_group)
Purpose
Allows an administrator to get locations where the group owns objects, ACLS, or workflows.
Parameters

locations (type dm_member_group)
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
locations (type dm_member_group)
Purpose
Specifies the locations in the repository of a given object (links).
Parameters

objectname (Required) The name of the selected object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
locations (type dm_member_user)
locations (type dm_member_user)
Purpose
Parameters
objectname (Required) The name of the selected object.
Description
Since
5.x
Configuration File
Scope
type dm_member_user
Elements
None.
locations (type dm_sysobject)
Purpose
Parameters

selected object.
locations (type dm_user)

Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
failoverenabled
locations (type dm_user)
Purpose
Allows the administrator to view all of the groups, ACLs, alias sets, objects, and workflows that
the specified user owns or belongs to.
Parameters
objectname (Required) The name of the selected user
Description
Since
5.x
Configuration File
rendition_transformation (type dmr_content)
Scope
type dm_user
Elements
None.
rendition_transformation (type dmr_content)
Purpose
Requires Media Transformation Services. Customization not supported.
Parameters
contentType (Optional) File format to use when transforming

the object (passed to the operating system)
folderId (Optional) ID of the folder from which the action
was called
transformableToRendition (Optional) The valid rendition to which the
object can be transformed
Description
Since
5.x
Configuration File
Scope
type dmr_content
transformation (type dm_sysobject)
Elements
None.
transformation (type dm_sysobject)
Purpose
Parameters
contentType (Optional) Customization not supported.

folderId (Optional) Customization not supported.
objectId (Required) Customization not supported.
ownerName (Optional) Customization not supported.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
transformationtonewrelation (type dm_sysobject)
Purpose
transformationtonewrelation (type dmr_content)
Parameters

transformableToRendition (Optional) Customization not supported.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
transformationtonewrelation (type dmr_content)
Purpose
Parameters

was called
transformableToRendition (Optional) Not used
transformationtonewrendition (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dmr_content
Elements
None.
transformationtonewrendition (type dm_sysobject)
Purpose
Parameters

transformableToRendition (Optional) Customization not supported.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
transformationtonewrendition (type dmr_content)
Elements
None.
transformationtonewrendition (type dmr_content)
Purpose
Transforms the object to the selected rendition. Requires Media Transformation Services.
Customization not supported.
Parameters
contentType (Optional) File format to use when transforming

the object (passed to the operating system)
was called
transformableToRendition (Optional) The valid rendition to which the
object can be transformed
Description
Since
5.x
Configuration File
Scope
type dmr_content
Elements
None.
addtobrowserfavorites
Navigational aids
addtobrowserfavorites
Purpose
Generates a bookmark to a DRL for a selected object.
Parameters
objectId (Required) Object ID of the selected object.

type (Optional) Type of the selected object.
Description
Since
6.0
Configuration File
Scope
All.
Usage
Returns the object name and DRL for each object.
Elements
None.
JumpToBrowserTreeLocationAction (Webtop)
Purpose
Makes a specific node in the browser tree control the current node.
registerevents (type dm_sysobject)
Since
6.5
Notifications
registerevents (type dm_sysobject)
Purpose
Registers for notification when certain events occur on an object. Replica and reference objects
cannot be registered.
Parameters
events (Optional) List of the specific events for which

to register.
notificationStatus (Optional) (Boolean) True, if the current user
is registered for events on the selected object;
False, if not.Since 6.0.
objectId (Required) Object ID of the object whose events
should be registered for notification
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
registerreadevent (type dm_sysobject)
registerreadevent (type dm_sysobject)
Purpose
Registers a user to receive notification when a specific object is read (that is, viewed, edited, exported,
or checked out).
Parameters
events (Required) Name of the event for which to

register. Valid value is: dm_getfile.
objectId (Required) ID of the object to which this event
(specified in the events attribute) applies.
Description
Since
6.0
Configuration File
Scope
type dm_sysobject
Elements
None.
unregisterevents (type dm_sysobject)
Purpose
Removes registration for notification when certain events occur on an object
unregisterreadevent (type dm_sysobject)
Parameters
events (Optional) List of specific events for which to

remove registration.
notificationStatus (Optional) (Boolean) True, if the current user
is registered for events on the selected object;
False, if not.Since 6.0.
objectId (Required) Object ID of the object from which to
remove event registration.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
unregisterreadevent (type dm_sysobject)
Purpose
De-registers a user from receiving notification when an object is read (that is, viewed, edited,
exported, or checked out).
Parameters
events (Required) Name of the event for which to

de-register. Valid value is: dm_getfile.
objectId (Required) ID of the object to which this event
(specified in the events attribute) applies.
dmc_prm_action_make_library_request (entitlement prm, role dmc_prm_library_user, type dmc_prm_physical_container)
Description
Since
6.0
Configuration File
Scope
type dm_sysobject
Elements
None.
Physical Records Manager

These actions require a Physical Records Manager license.
dmc_prm_action_make_library_request
(entitlement prm, role dmc_prm_library_user, type
dmc_prm_physical_container)
Purpose
Calls the makelibraryrequest, page 1112 component and the makelibraryrequestcontainer, page 1113
container to make a library request. Requires Physical Records Manager license.
Parameters
objectId (Required) Object ID of the object for which the

request is being made.
Description
Since
6.0
dmc_prm_action_make_library_request (entitlement prm, role dmc_prm_library_user, type dmc_prm_physical_document)
Configuration File
webcomponent\config\library\records\request\prm_physical_container_actions.xml
Scope
entitlement prm
role dmc_prm_library_user
type dmc_prm_physical_container
Elements
None.
dmc_prm_action_make_library_request
(entitlement prm, role dmc_prm_library_user, type
dmc_prm_physical_document)
Purpose
Calls the makelibraryrequest, page 1112 component and the makelibraryrequestcontainer, page 1113
container to make a library request. Requires Physical Records Manager license.
Parameters

request is being made.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\prm_physical_document_actions.xml
Scope
entitlement prm
type dmc_prm_physical_document
dmc_prm_cancel_request (entitlement prm, role dmc_prm_library_user, type dmc_prm_library_request)
Elements
None.
dmc_prm_cancel_request (entitlement
prm, role dmc_prm_library_user, type
dmc_prm_library_request)
Purpose
Cancels a library request. Requires Physical Records Manager license.
Parameters

locked.
cancellation is being made.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\prm_library_request_actions.xml
Scope
entitlement prm
type dmc_prm_library_request
Elements
None.
dmc_prm_user_request_list (entitlement prm, role dmc_prm_library_user)
dmc_prm_user_request_list (entitlement prm, role

dmc_prm_library_user)
Purpose
Calls the userrequestlist (entitlement prm, role dmc_prm_library_user), page 1116 to display a list of
Physical Records Manager library users. Requires Physical Records Manager license.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\prm_generic_actions.xml
Scope
entitlement prm
Elements
None.
Preferences
deleteformatpref
Purpose
Deletes a user’s format preferences and caches the changes until they are committed.
editformatpref
Parameters
primaryFormat (Optional) Name of the primary format.

type (Optional) Object type to which this format
preference applies.
Description
Since
6.0
Configuration File
Scope
All.
Caller
format_preferences_summary, page 1124
Usage
This action updates the format_preferences_summary, page 1124 component’s cached list of
format preferences and displays the updated list. When the user saves the changes in the
format_preferences_summary, page 1124 component, the format preference is committed to the
repository.
Elements
None.
editformatpref
Purpose
Edits a user’s format preferences and caches the changes until they are committed.
editformatpref
Parameters
editApp (Optional) Name of the application to edit

objects with the format specified in the
primaryFormat attribute.
isEditing (Optional) Boolean: Whether the format is
already being edited (True) or not (False).
preferredRenditionFormat (Optional) Name of the preferred format for
displaying renditions.
type (Optional) Object type to which this format
preference applies.
viewApp (Optional) Name of the application to view
objects with the format specified in the
preferredRenditionFormat attribute.
Description
Since
6.0
Configuration File
Scope
All.
Caller
format_preferences_summary, page 1124
Usage
Calls the format_pref_attr_selector component and passes in this action’s arguments.
Elements
None.
preferences
preferences
Purpose
Allows a user to set preferences.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
failoverenabled
Presets
createpreset (type dmc_preset_package)
Purpose
Calls the preseteditorcontainer, page 1136 container component to create a preset.
Parameters
None.
delete (type dmc_preset_package)
Description
Since
6.0
Configuration File
webcomponent\config\actions\dmc_preset_package_actions.xml
Scope
type dmc_preset_package
Elements
None.
delete (type dmc_preset_package)
Purpose
Calls the deletepreset (type dmc_preset_package), page 1130 component, which is contained in the
deletepresetcombocontainer (type dmc_preset_package), page 1131 container component, to delete a
dmc_preset_package object.
Parameters
objectName (Required) Name of the dm_preset_package

object to delete.
Description
Since
6.0
Configuration File
Scope
editpreset (type dmc_preset_package)
Elements
None.
editpreset (type dmc_preset_package)
Purpose
Calls the preseteditorcontainer, page 1136 container component to modify a preset.
Parameters
objectName (Required) Name of the object to edit.
Description
Since
6.0
Configuration File
Scope
Elements
None.
migratepresets (dmc_preset_package)
Purpose
Prepare preset objects to be deployed to a production repository.
presetdocbaseselector
Parameters
objectName (Optional) Object name of the preset to prepare

for migration.
Description
Since
6.0 SP1
Configuration File
Scope
All.
Elements
None.
presetdocbaseselector
Purpose
Enable selecting repositories from the multiselector.
Parameters
selections (Optional) Names of repositories to display.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\actions\preset_generic_actions.xml
Scope
All.
presetgrouplocator
Elements
None.
presetgrouplocator
Purpose
Enables selecting preset users, groups and roles.
Parameters

drop-down list.
multiselect (Required) Boolean: Set to true to support
selectedobjectids (Optional) Comma-separated list of IDs of the
objects to intially select.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
presetlocationlocator
presetlocationlocator
Purpose
Calls the presetlocationlocatorcontainer, page 1140 container component to navigate preset cabinets
and folders.
Parameters

drop-down list.
invalidpresetentries (Optional) Specifies the object IDs of folders that
do not exist or are from other repositories.
Since 6.0 SP1.

selected.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
presetobjectlocator
presetobjectlocator
Purpose
Calls the presetobjectlocatorcontainer, page 1144 container component to locate preset objects.
Parameters

drop-down list.
Since 6.0 SP1.

selected.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
presetobjecttypelocator
Purpose
Calls the presetobjecttypelocatorcontainer, page 1146 container component to locate preset object
types.
Parameters

drop-down list.
selectedobjectids (Optional) Comma- or semicolon-delimited list
of object IDs that are initially selected.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
presetpermissionlocator
Purpose
Calls the aclobjectlocatorcontainer, page 1236 to select ACLs.
presetuserorgrouplocator
Parameters

drop-down list.
selectedobjectids (Optional) Comma-delimited delimited list of
object IDs that are initially selected.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
presetuserorgrouplocator
Purpose
Calls the userorgrouplocator, page 1341 component, contained in the userorgrouplocatorcontainer,
page 1342 component container, to locate preset users, groups, and roles.
properties (type dmc_preset_package)
Parameters
flatlist (Optional) Boolean: Set to true to list users and

groups in a flat list, set to false to display users
and groups in a drop-down list.
multiple user/group selection.
selected.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
properties (type dmc_preset_package)
Purpose
Calls the presetwizardcontainer, page 1151 component container to display the properties of a
Parameters
objectName (Required) Name of the dmc_preset_package

object for which to display properties.
createrecordrelation (entitlement recordsmanager, type dm_sysobject not dm_folder)
Description
Since
6.0
Configuration File
Scope
Records Manager
createrecordrelation (entitlement recordsmanager,

type dm_sysobject not dm_folder)
Purpose
Creates a relationship between formal records.Requires a Records Manager license.
Parameters
objectId (Required) Object ID of the source formal record

object.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\relationships\dm_sysobject_actions.xml
Scope
entitlement recordsmanager
type dm_sysobject,not dm_folder
declareformalrecord (entitlement recordsmanager, role dmc_rm_recordscontributor, type dm_sysobjectnotdm_folder)
Elements
failoverenabled
declareformalrecord (entitlement recordsmanager,

role dmc_rm_recordscontributor, type
dm_sysobjectnotdm_folder)
Purpose
Creates formal records.Requires a Records Manager license.
Parameters
folderId (Optional) ID of the folder in which to create the

formal record object.
objectId (Required) Object ID of the formal record object
to create.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\dmc_rm_record_actions.xml
Scope
role dmc_rm_recordscontributor
type dm_sysobject, not dm_folder
Elements
None.
removerecordrelationships (entitlement recordsmanager)
removerecordrelationships (entitlement
recordsmanager)
Purpose
Deletes the relationship between formal records.Requires a Records Manager license.
Parameters
isRecordRelationship (Required) Boolean: True indicates that the

relationship is between formal records.
object.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\relationships\dm_relation_actions.xml
Scope
Elements
None.
viewformalrecordassociations (entitlement
recordsmanager, type dm_sysobjectnotdm_folder)
(Webtop)
Purpose
Calls the viewContainedInFormalRecords (entitlement recordsmanager) (Webtop), page 1177
component to view a list of formal record objects that contain a specified object. Requires a Records
Manager license.
viewrecordrelationships (entitlement recordsmanager, type dm_sysobjectnotdm_folder)
Parameters
objectId (Required) ID of the formal record object.
Description
Since
6.0
Configuration File
Scope
type dm_sysobject,not dm_folder
Elements
failoverenabled
viewrecordrelationships (entitlement
recordsmanager, type dm_sysobjectnotdm_folder)
Purpose
Calls the view_record_relationships (entitlement recordsmanager), page 1177 component view
relationships between records. Requires a Records Manager license.
Parameters
folderId (Optional) ID of the folder in which the source

formal record resides.
folderPath (Optional) Path to the folder in which the source
formal record resides.
object.
deleterelation (type dm_document)
Description
Since
5.x
Configuration File
webcomponent\config\library\records\relationships\dm_relation_actions.xml
Scope
type dm_sysobject, not dm_folder
Elements
failoverenabled
Relationships between objects
Purpose
Calls a component that deletes a relation object (dm_relation) for two dm_document objects.
Parameters
relationObjectId (Required) ID of the dm_relation object to delete.
Description
Since
6.0
Configuration File
newrelation (type dm_document)
Scope
type dm_document
Elements
None.
Purpose
Calls a component that creates a relation object (dm_relation) for two dm_document objects.
Parameters
childObjectId (Optional) ID of the child object.

objectId (Required) ID of the parent object.
Description
Since
6.0
Configuration File
Scope
type dm_document
Elements
None.
comment (type dm_sysobject)
Renditions
comment (type dm_sysobject)
Purpose
Checks for a rendition in the allowable formats and generates JavaScript to invoke Adobe
Acrobat 6 in a new browser window. The allowable formats for comments are specified in
/webcomponent/app.xml. The Adobe Comment Connector feature must be enabled for the
repository. This action does not check for the presence of Adobe Acrobat on the client machine.
Parameters
contentType (Required) Type of the selected object.

objectId (Required) ID of the template
format (Required) File format of the selected object.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
createhtmlrendition (type dm_sysobject)
Purpose
Creates an HTML rendition of the object.
createhtmlrendition (type dmr_content)
Parameters

objectId (Required) ID of the object.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
createhtmlrendition (type dmr_content)
Purpose
Creates an HTML rendition of a document
Parameters
contentType (Required) File format to use when creating the

createhtmlrenditiongeneric (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dmr_content
Elements
None.
createhtmlrenditiongeneric (type dm_sysobject)
Purpose
Creates an HTML rendition of the object
Parameters
createhtmlrendition (type dm_sysobject), page 505
Description
Since
5.x
Configuration File
Parent Definition
createhtmlrendition:application=’webcomponent’ type=’dm_sysobject’
Scope
type dm_sysobject
createhtmlrenditiongeneric (type dmr_content)
Elements
None.
createhtmlrenditiongeneric (type dmr_content)
Purpose
Creates an HTML rendition of a document
Parameters
The parameters are inherited from webcomponent\config\actions\dmr_content_actions.xml. See
createhtmlrendition (type dmr_content), page 506
Description
Since
5.x
Configuration File
Parent Definition
createhtmlrendition:application=’webcomponent’ type=’dm_sysobject’
Scope
type dmr_content
Elements
None.
createpdfrendition (type dm_sysobject)
Purpose
Creates a PDF rendition of the object.
createpdfrendition (type dmr_content)
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
createpdfrendition (type dmr_content)
Purpose
Creates a PDF rendition of a document.
Parameters
contentType (Required) File format to use when creating the

createpdfrenditiongeneric (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dmr_content
Elements
None.
createpdfrenditiongeneric (type dm_sysobject)
Purpose
Creates a PDF rendition of the object.
Parameters
createpdfrendition (type dm_sysobject), page 508
Description
Since
5.x
Configuration File
Parent Definition
createpdfrendition:application=’webcomponent’ type=’dm_sysobject’
Scope
type dm_sysobject
createpdfrenditiongeneric (type dmr_content)
Elements
None.
createpdfrenditiongeneric (type dmr_content)
Purpose
Creates a PDF rendition of a document
Parameters
The parameters are inherited from webcomponent\config\actions\dmr_content_actions.xml. See
createpdfrendition (type dmr_content), page 509
Description
Since
5.x
Configuration File
Parent Definition
createpdfrendition:application=’webcomponent’ type=’dm_sysobject’
Scope
type dmr_content
Elements
None.
renditions (type dm_sysobject)
Purpose
Displays the renditions for a selected object
refresh (type dm_sysobject)
Parameters
contentType (Required) The content type of the renditions

to display.
selected object.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
Replicas and References
refresh (type dm_sysobject)
Purpose
Refreshes a reference or replica object to reflect changes in the object source.
changehomedblog (type dm_user)
Parameters
isReplica (Optional) Boolean parameter that specifies

whether the object is a replica.
objectId (Required) ID of the object to refresh (not ID of
the source object.)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
Repository
changehomedblog (type dm_user)
Purpose
Displays user change home repository requests and their status.
Parameters
None.
Description
Since
5.x
changehomedocbase (privilege sysadmin, type dm_user)
Configuration File
Scope
type dm_user
Elements
None.
changehomedocbase (privilege sysadmin, type

dm_user)
Purpose
Changes the user’s home repository.
Parameters

Description
Since
5.x
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
changehomedocbase (type dm_member_user)
changehomedocbase (type dm_member_user)
Purpose
Changes the user’s home repository.
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_member_user
Elements
None.
selectrepository
Purpose
This action allows the user to select a repository from a list of preferred repositories. Displays visible
repositories for the list of connection brokers. The user can manually enter the name of a connection
broker to select a repository that connects to that broker.
Parameters
None.
addtoclipboard (type dm_smart_list)
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
Search
addtoclipboard (type dm_smart_list)
Purpose
Adds a dm_smart_list object to the clipboard.
Parameters

clipboard.
ownerName (Optional) Name of owner of the object to be
added to the clipboard
type (Optional) The content type of the object.
Description
Since
5.x
delete (type dm_smart_list)
Configuration File
webcomponent\config\environment\clipboard\dm_smart_list_clipboard_actions.xml
Scope
type dm_smart_list
Elements
None.
delete (type dm_smart_list)
Purpose
Deletes smart lists.
Parameters
folderId (Optional) ID of the dm_folder object that

contains the dm_smart_list object to delete..
lockOwner (Optional) Name of the user who has the
dm_smart_list object locked.
objectId (Required) ID of the dm_smart_list object to
delete.
dm_smart_list object.
Description
Since
6.0
Configuration File
webcomponent\config\actions\dm_smart_list_actions.xml
Scope
type dm_smart_list
delete (type dmc_search_template)
Elements
failoverenabled
Since 6.0 SP1.
delete (type dmc_search_template)
Purpose
Calls the delete, page 992 component and the combocontainer, page 1046 container to delete search
templates.
Parameters
folderId (Optional) Object ID of the folder in which the

search template resides.
lockOwner (Optional) Name of the user who has checked
out the search template.
objectId (Required) Object ID of the search template to
be viewed.
ownerName (Optional) Name of the owner of the search
template.
Description
Since
6.0
Configuration File
Scope
type dmc_search_template
Elements
failoverenabled
Since 6.0 SP1.
drledit (type dm_smart_list)
drledit (type dm_smart_list)
Purpose
Opens a DRL to a dm_smart_list object for editing.
Parameters
The parameters are inherited from edit:webcomponent/config/actions/dm_smart_list_actions.xml.
See edit (type dm_smart_list), page 522.
Description
Since
6.0
Configuration File
Parent Definition
edit:webcomponent/config/actions/dm_smart_list_actions.xml
Scope
type dm_smart_list
Elements
None.
Purpose
Opens a DRL to a dmc_search_template object for editing.
Parameters
drlview (type dm_smart_list)
Description
Since
6.0
Configuration File
Parent Definition
edit:webcomponent/config/actions/dmc_search_template_actions.xml
Scope
Elements
None.
Purpose
Opens a DRL to a dm_smart_list object for viewing.
Parameters
The parameters are inherited from view:webcomponent/config/actions/dm_smart_list_actions.xml.
See view (type dm_smart_list), page 538.
Description
Since
6.0
Configuration File
Parent Definition
view:webcomponent/config/actions/dm_smart_list_actions.xml
Scope
type dm_smart_list
Elements
None.
Purpose
Opens a DRL to a dm_smart_list object for viewing.
Parameters
The parameters are inherited from view:webcomponent/config/actions/dm_smart_list_actions.xml.
See view (type dm_smart_list), page 538.
Description
Since
6.0
Configuration File
Parent Definition
view:webcomponent/config/actions/dm_smart_list_actions.xml
Scope
type dm_smart_list
Elements
None.
editsearch
editsearch
Purpose
Calls the advsearch, page 1192 component, which is contained in the advsearchcontainer, page 1196
container component, to edit a saved search.
Parameters
queryId (Required) Internal ID assigned to the query.
Description
Since
6.0
Configuration File
Scope
All.
edit (type dm_smart_list)
Purpose
Calls the advsearch, page 1192 component to edit a saved search.
Parameters
contentSize (Optional) Size of the object in bytes.

isReference (Optional) Boolean: Indicates whether the object
is a reference object (True) or not (False).
out the object.
edit (type dm_smart_list)
navigation (Optional) Type of navigation upon execution.

ownerName (Optional) Name of the object owner.
querydeftype (Optional) Type of the saved search. Valid values
are: IDfSmartList.TYPE_QUERY_BUILDER
= "query_builder" IDfSmartList.TYPE_
PASSTHROUGH_QUERY = "passthrough_
query" IDfSmartList.TYPE_UNKNOW =
""IDfSmartList.TYPE_UNKNOW is only used
in version 5.3.x. If this parameter value is
not specified, it is retrieved from the object
specified by the objectId parameter.For
this action to be enabled (for example,
from the menu or right-click context
menu): The value of this parameter must
be IDfSmartList.TYPE_QUERY_BUILDER
or IDfSmartList.TYPE_UNKNOW, or The
value retrieved from the object must be
IDfSmartList.TYPE_QUERY_BUILDER.
Otherwise, this action is disabled.Since 6.0:
passthrough_query value.
type (Optional) Object type.
Description
Since
5.x
Configuration File
Scope
type dm_smart_list
Caller
searchstoreclassic, page 1224
searchstorestreamline, page 1225
Usage
The advanced search component is displayed when query_builder is specified for the querydeftype
parameter.
The user must have read_permit access to the object (valid values: DELETE_PERMIT |
WRITE_PERMIT |VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT | BROWSE_PERMIT |
NONE_PERMIT). The advanced search component is displayed when "query_builder is specified
editfile (type dm_smart_list)
for the querydeftype parameter. Also, a query that is too old or being edited by another component
when the query is executed cannot be edited.
Elements
failoverenabled
Since 6.0 SP1.
Purpose
Calls the advsearch, page 1192 component to edit a saved search.
Parameters

the object is a reference object (pointer to smart
list in another repository).
lockOwner (Optional) User who has checked out the smart
list.
objectId (Required) ID of the smart list.
ownerName (Optional) Name of the smart list owner.
in version 5.3.x. If this parameter value is
not specified, it is retrieved from the object
specified by the objectId parameter.For
this action to be enabled (for example,
from the menu or right-click context
menu): The value of this parameter must
be IDfSmartList.TYPE_QUERY_BUILDER
or IDfSmartList.TYPE_UNKNOW, or The
value retrieved from the object must be

IDfSmartList.TYPE_QUERY_BUILDER.
Otherwise, this action is disabled.
6.0: The passthrough_query value was added as

a valid value.
type (Optional) Object type of smartlist (dm_smartlist
or subtype).
Description
Since
5.x
Configuration File
Scope
type dm_smart_list
Caller
Usage
The advanced search component is displayed when query_builder is specified for the querydeftype
parameter.
NONE_PERMIT). The advanced search component is displayed when "query_builder is specified
for the querydeftype parameter. Also, a query that is too old or being edited by another component
when the query is executed cannot be edited.
Elements
failoverenabled
Since 6.0 SP1.
editfile (type dmc_search_template)
editfile (type dmc_search_template)
Purpose
Calls the advsearch, page 1192 component to edit a search template.
Parameters
Description
Since
6.0
Configuration File
Parent Definition
edittemplate:webcomponent/config/actions/dmc_search_template_actions.xml
Scope
Elements
None.
edittemplate (type dmc_search_template)
Purpose
Calls the savesearchtemplate, page 1208 to edit a search template to change the list of fixed and free
constraints of the template (without modifying the search).
edittemplatedefinition (type dmc_search_template)
Parameters
lockOwner (Optional) User who has checked out the search

template.
objectId (Required) Object ID of the search template to
be edited.
search template.
Description
Since
6.0
Configuration File
Scope
Usage
NONE_PERMIT).
Elements
failoverenabled
Since 6.0 SP1.
edittemplatedefinition (type dmc_search_template)
Purpose
Edit the template in the advanced search component to modify the search definition.
importexternalresult (type dm_externalresult)
Parameters
lockOwner (Optional) User who has checked out the search

template definition.
objectId (Required) Object ID of the search template
definition to edit.
search template definition.
Description
Since
6.0
Configuration File
Scope
Usage
NONE_PERMIT).
Elements
failoverenabled
Since 6.0 SP1.
importexternalresult (type dm_externalresult)
Purpose
Imports a file listed after searching an external source
properties (type dm_externalresult)
Parameters

queryId (Required) Internal ID of the query used for
searching the external source.
Description
Since
5.x
Configuration File
Scope
Elements
None.
Purpose
Displays the properties component for an external result object
Parameters

Description
Since
5.x
properties (type dm_smart_list)
Configuration File
Scope
Elements
failoverenabled
Since 6.0 SP1.
properties (type dm_smart_list)
Purpose
Displays the properties component for a dm_smart_list object
Parameters
entryId (Required) ID of the dm_smart_list object.

the dm_smart_list.
Description
Since
5.x
Configuration File
Scope
type dm_smart_list
Elements
failoverenabled
Since 6.0 SP1.
revisesearchtemplate
revisesearchtemplate
Purpose
Calls the searchtemplate component to revise a search with its original search template form instead
of the classical advanced search component.
Parameters
queryId (Required) Internal ID assigned to the search.
Description
Since
6.0
Configuration File
Scope
All.
Elements
failoverenabled
runsearchtemplate (type dmc_search_template)
Purpose
Displays a search form from a search template and create a search.
savesearch
Parameters
lockOwner (Optional) Name of the user who has the search

template checked out.
objectId (Required) Object ID of the search template.
search template.
Description
Since
6.0
Configuration File
Scope
Elements
failoverenabled
Since 6.0 SP1.
savesearch
Purpose
Saves a search as a search template if the search template service is available or create a template
from another search template.
Parameters
queryId (Optional) Internal ID assigned to the query
savesearchtemplate
Description
Since
5.x
Configuration File
Scope
All.
Elements
failoverenabled
savesearchtemplate
Purpose
Calls the savesearchtemplate component.
Parameters
Description
Since
6.0
Configuration File
Scope
All.
Elements
failoverenabled
search
search
Purpose
Performs a search based on a query.
Parameters
query (Required) The query string. The queryType

parameter specifies the kind of query.
queryType (Optional) Specifies the kind of query specified
in the query parameter. Valid values are:
• objectId — the object ID of the smartlist
• querydef — the XML content of a smartlist
• queryId — For internal use only.
• lastQuery — the results of the last executed

search
• savedResults — the saved search results
• dql — the DQL query
• string or null — keywords

ranking (Optional) Not used. (The 6.0 version of this
guide incorrectly stated this parameter as being
used.).
Description
Since
5.x
Configuration File
Scope
All.
Elements
failoverenabled
searchuser (type dm_user)
searchuser (type dm_user)
Purpose
Displays a list of users.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
type dm_user
Elements
None.
view (type dm_externalresult)
Purpose
Views the content of an external search result
Parameters

view (type dm_query)
Description
Since
5.x
Configuration File
Scope
Elements
None.
view (type dm_query)
Purpose
Launches the search component to run a query. The user must have the read_permit access to the
object (valid values: DELETE_PERMIT | WRITE_PERMIT |VERSION_PERMIT | RELATE_PERMIT
| READ_PERMIT | BROWSE_PERMIT | NONE_PERMIT).
Parameters

(dm_query only)
navigation (Optional) Type of navigation to perform after
the action
ownerName (Optional) Name of the object owner (dm_query
only)
type (Optional) Object type (dm_query only)
view (type dmc_search_template)
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_query_actions.xml
Scope
type dm_query
Elements
None.
view (type dmc_search_template)
Purpose
Launches a viewing application to view a search template.
Parameters
The parameters are inherited from runsearchtemplate:webcomponent/config/actions/dmc_search_
template_actions.xml. See runsearchtemplate (type dmc_search_template), page 531.
Description
Since
6.0
Configuration File
Parent Definition
runsearchtemplate:webcomponent/config/actions/dmc_search_template_actions.xml
Scope
view (type dm_smart_list)
Elements
None.
Purpose
Calls the search, page 1208 component to run the saved search.
Parameters

the object is a reference object.
out the object.
Default is returnJump.
ownerName (Optional) Name of the object owner.
query (Optional) Query in the format specified by the
queryType parameter. Default is r_object_id.
in version 5.3.x. If this parameter value is not
specified, it is retrieved from the object specified
by the objectId parameter. For this action to
be enabled (for example, from the menu or
right-click context menu), the value of this
parameter or the value retrieved from the object
must be a valid value; otherwise, this action is
disabled.
6.0: Added passthrough as a valid value.
queryType (Optional) Specifies the kind of the query that

is specified in the query parameter or specific
results to display. Valid values are: string or
null: Keywords. dql: DQL query. objectId:
Object ID of the smartlist. querydef: XML
content of a smartlist. queryId: (Internal use
only) An active query for editing. lastQuery:
Display the results of the last executed search.
savedResults: Display saved search results.
Default is objectId.
Description
Since
5.x
Configuration File
Scope
type dm_smart_list
Caller
search, page 1208
Usage
NONE_PERMIT). Launches the search component to run the saved search when "query_builder" or
"passthrough_query" is specified for the querydeftype
Elements
failoverenabled
Since 6.0 SP1.
viewsavedresults (type dm_smart_list)
viewsavedresults (type dm_smart_list)
Purpose
Calls the search, page 1208 component to view the saved search results of the saved search.
Parameters

hasresults (Optional) Boolean: Whether the dm_smart_list
object contains search results (True) or not
(False). To enable this action, set this parameter’s
value to true; otherwise, this parameter’s value
is retrieved from the object specified by the
objectId parameter.
isReference (Optional) Boolean: Whether the object is a
reference object (True) or not (False).
(dm_query only).
navigation (Optional) Type of navigation to perform after
the action.
objectId (Required) ID of the selected dm_smart_list
object.
ownerName (Optional) Name of the object owner (dm_query
only).
query (Optional) Query in the format specified by the
queryType parameter.
queryType (Optional) Type of the saved search. Valid values
""IDfSmartList.TYPE_UNKNOW is only used in
version 5.3.x.
Description
Since
6.0
aclbrowse (privilege sysadmin, type dm_user)
Configuration File
Scope
type dm_smart_list
Caller
Usage
NONE_PERMIT).
Elements
failoverenabled
Since 6.0 SP1.
Security
aclbrowse (privilege sysadmin, type dm_user)
Purpose
Allows the administrator to browse a list of ACLs in the repository
Parameters
None.
Description
Since
5.x
Configuration File
addaccessortorevoke (type dm_common_restriction)
Scope
privilege sysadmin
type dm_user
Elements
None.
addaccessortorevoke (type dm_common_

restriction)
Purpose
Adds an accessor to an in-memory list of accessors to revoke from the ACLs of more than one
selected object.
Parameters
flatlist (Optional) Boolean: To display all objects in a

flat list (True) or a drop-down list (False).
multiselect (Required) Boolean: Support multiple object
selection (True) or not (False).
permit (Optional) String that represents the permission
to be applied to the accessor.
roomId (Optional) ID of the room that currently governs
the folder.
Description
Since
6.0
Configuration File
Scope
type dm_common_restriction
addaceaction (type dm_ace)
Elements
None.
addaceaction (type dm_ace)
Purpose
Adds a user or group entry to an ACL
Parameters
flatlist (Optional) Boolean: True to list all objects in a

flat list, false to display a drop down list.
multiselect (Required) Boolean: True to support multiple
object selection
objecttype (Optional) Type of the selected object
permit (Optional) Set of working and new
permits. Valid values: DELETE_PERMIT
| WRITE_PERMIT | VERSION_PERMIT
| RELATE_PERMIT | READ_PERMIT |
BROWSE_PERMIT | NONE_PERMIT
roomId (Optional) ID of the room, in the case of a room
ACL
Description
Since
5.x
Configuration File
Scope
type dm_ace
addgroupmembership
addgroupmembership
Purpose
Adds a user or group to a group
Parameters
accessorName (Required) Name of user or group

objectId (Optional) ID of the ACL (permission set)
Description
Since
5.x
Configuration File
Scope
type dm_ace
addrestriction (type dm_restriction)
Purpose
Adds a restriction to the ACL. Trusted Content Services must be enabled in the repository.
Parameters
flatlist (Optional) Boolean: true to list all objects in a

multiselect (Required) Boolean: true to support multiple
object selection
aliassetbrowse (privilege sysadmin, type dm_user)

ACL
Description
Since
5.x
Configuration File
Scope
type dm_restriction
Elements
None.
aliassetbrowse (privilege sysadmin, type dm_user)
Purpose
Allows the administrator to browse a list of alias sets in the repository.
Parameters
None.
Description
Since
5.x
Configuration File
aliassetbrowse (type dm_group)
Scope
privilege sysadmin
type dm_user
Elements
None.
aliassetbrowse (type dm_group)
Purpose
Allows the administrator to browse a list of alias sets in the repository.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
delete (type dm_acl)
Purpose
Deletes an ACL.
editaceaction
Parameters

objectname (Required) Name of the ACL.
type (Required) Object type of the ACL.
Description
Since
5.x
Configuration File
Scope
type dm_acl
Elements
None.
editaceaction
Purpose
Edits an entry in an ACL.
Parameters
accessorName (Required) Name of user or group to add to

ACL.
basicpermit (Optional) The name of the basic permit for the
accessor. Valid values are 1 (none), 2 (browse), 3
(read), 4 (relate), 5 (version), 6 (write), 7 (delete).
Default = 3 (read)
editacepermitaction
extpermit (Optional) The extended permission for

the accessor. Valid values are EXECUTE_
PROCEDURE_BIT, CHANGE_LOCATION_BIT,
CHANGE_STATE_BIT, CHANGE_
PERMISSIONS_BIT, TAKE_OWNERSHIP_BIT.
Default = 0 (no extended permissions)
extpermit_readonly (Optional) Set to true to disable extended
permission controls
objectId (Optional) ID of the ACL
objectName (Optional) Name of ACL
permit (Optional) String representation of the
permission that is being applied to the accessor
permitType (Optional) Valid types of IDfPermit:
DF_ACCESS_PERMIT = 0 DF_EXTENDED_
PERMIT = 1 DF_APPLICATION_PERMIT
= 2 DF_ACCESS_RESTRICTION = 3
DF_EXTENDED_RESTRICTION = 4
DF_APPLICATION_RESTRICTION
= 5 DF_REQUIRED_GROUP = 6
DF_REQUIRED_GROUP_SET = 7
Description
Since
5.x
Configuration File
Scope
All.
editacepermitaction
Purpose
Sets extended permissions in an ACL including Trusted Content Services support if it is configured
for the repository
editacepermitaction
Parameters
accessorName (Required) Name of accessor (user or group)

Default = 3 (read)
permission controls
objectId (Optional) ID of the ACL
DF_ACCESS_PERMIT=0DF_EXTENDED_
PERMIT = 1DF_APPLICATION_PERMIT
= 2DF_ACCESS_RESTRICTION =
3DF_EXTENDED_RESTRICTION =
4DF_APPLICATION_RESTRICTION =
5DF_REQUIRED_GROUP = 6DF_REQUIRED_
GROUP_SET = 7
Description
Since
5.x
Configuration File
Scope
All.
editrestriction (type dm_restriction)
editrestriction (type dm_restriction)
Purpose
Edits the restricted access of selected users or groups. Trusted Content Services must be enabled in
the repository.
Parameters
accessorName (Required) Name of user or group to add to

ACL.
Default = 3 (read)
GROUP_SET = 7
Description
Since
5.x
Configuration File
getowner (type dm_acl)
Scope
type dm_restriction
Elements
None.
getowner (type dm_acl)
Purpose
Gets the ACL owner name
Parameters

multiselect (Optional) Boolean: true to support multiple
object selection
objectId (Required) ID of ACL object.
Description
Since
5.x
Configuration File
Scope
type dm_acl
Elements
None.
locations (type dm_acl)
locations (type dm_acl)
Purpose
Displays the locations where an ACL is used.
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_acl
Elements
None.
newacl (type dm_acl)
Purpose
Creates a new ACL
Parameters
objectId (Required) ID of the ACL.
properties (type dm_acl)
Description
Since
5.x
Configuration File
Scope
type dm_acl
Elements
None.
properties (type dm_acl)
Purpose
Displays the properties of an ACL.
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_acl
Elements
None.
removeaccessor
removeaccessor
Purpose
Removes an accessor from an ACL
Parameters
accessorName (Required) Name of accessor (user or group) to

be removed
GROUP_SET = 7
Description
Since
5.x
Configuration File
Scope
All.
removeaccessortorevoke (type dm_common_

restriction)
Purpose
Removes an accessor from an in-memory list of accessors to revoke from the ACLs of more than one
selected object.
removerestriction (type dm_restriction)
Parameters
accessorName (Required) Name of user or group to remove

from the in-memory list.
DF_ACCESS_PERMIT = 0 DF_EXTENDED_
PERMIT = 1 DF_APPLICATION_PERMIT
= 2 DF_ACCESS_RESTRICTION = 3
DF_EXTENDED_RESTRICTION = 4
= 5 DF_REQUIRED_GROUP = 6
Description
Since
6.0
Configuration File
Scope
type dm_common_restriction
Elements
None.
removerestriction (type dm_restriction)
Purpose
Removes an access restriction for selected users or group. Trusted Content Services must be enabled
in the repository.
rmaccessor
Parameters
accessorName (Required) Name of user or group for which to

remove the restriction
DF_ACCESS_PERMIT=0, DF_EXTENDED_
PERMIT = 1, DF_APPLICATION_PERMIT
= 2, DF_ACCESS_RESTRICTION = 3,
DF_EXTENDED_RESTRICTION = 4,
= 5, DF_REQUIRED_GROUP = 6,
Description
Since
5.x
Configuration File
Scope
type dm_restriction
Elements
None.
rmaccessor
Purpose
Removes an entry from an ACL.
Parameters
accessorName (Required) Name of user or group to remove

from the ACL.
subscribe (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
All.
Subscriptions
subscribe (type dm_sysobject)
Purpose
Subscribes the user to an object.
Parameters
folderPath (Optional) Path to object

Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
subscribeothers (type dm_sysobject)
subscribeothers (type dm_sysobject)
Purpose
Enables a user to subscribe other users to objects.
Parameters
folderPath (Optional) Path to the object.

Description
Since
6.0
Configuration File
Scope
type dm_sysobject
Elements
None.
unsubscribe (type dm_sysobject)
Purpose
Unsubscribes an object.
Parameters
events (Optional) List of the events for which to remove

subscriptions.
testcustomattrs (type wdk5_testtype_1)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
Testing
testcustomattrs (type wdk5_testtype_1)
Purpose
One of a set of components and actions that test controls and actions. This action can be used for
internal testing to display custom attributes.
Parameters
The parameters are inherited from versions:webcomponent/config/actions/dm_sysobject_actions.xml.
See versions (type dm_sysobject), page 369.
Description
Since
5.x
Configuration File
wdk\config\fxtest_component.xml
Parent Definition
versions:webcomponent/config/actions/dm_sysobject_actions.xml
testcustomrepeatingattrs (type wdk5_testtype_2)
Scope
type wdk5_testtype_1
Elements
None.
testcustomrepeatingattrs (type wdk5_testtype_2)
Purpose
internal testing of repeating attributes display.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
None.
testdocbasescope (docbase CS52ORABuild162wdkFormnotw2k52WDK_CustomTest01, type wdk5_testtype_3)
testdocbasescope (docbase
CS52ORABuild162wdkFormnotw2k52WDK_
CustomTest01, type wdk5_testtype_3)
Purpose
One of a set of components and actions that tests controls and actions. This action can be used for
internal testing of scope on repository and type values.
Parameters
The parameters are inherited from renditions:webcomponent/config/actions/dm_sysobject_actions.
xml. See renditions (type dm_sysobject), page 511.
Description
Since
5.x
Configuration File
Parent Definition
renditions:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
docbase CS52ORABuild162, wdkForm, not

w2k52WDK_CustomTest01
Elements
None.
testfilterattrs (type wdk5_testtype_3)
Purpose
internal testing to filter an action by a scope value.
testmultirole (role consumernotadministrator, type wdk5_testtype_4)
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
None.
testmultirole (role consumernotadministrator, type

wdk5_testtype_4)
Purpose
internal testing of roles.
Parameters
Description
Since
5.x
testmultiscope (type wdk5_testtype_1wdk5_testtype_2)
Configuration File
Parent Definition
Scope
role consumer, not administrator

Elements
None.
testmultiscope (type wdk5_testtype_1wdk5_

testtype_2)
Purpose
internal testing of multiple scope values.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
type wdk5_testtype_1, wdk5_testtype_2
testmultiscopeandnot (type wdk5_testtype_1notwdk5_testtype_2)
Elements
None.
testmultiscopeandnot (type wdk5_testtype_

1notwdk5_testtype_2)
Purpose
internal testing of multiple scopes and excluding values.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
type wdk5_testtype_1, not wdk5_testtype_2
Elements
None.
testnotkeyword (type notwdk5_testtype_1)
testnotkeyword (type notwdk5_testtype_1)
Purpose
internal testing of scope that excludes certain values.
Parameters
The parameters are inherited from history:webcomponent/config/actions/dm_sysobject_actions.xml.
See history (type dm_sysobject), page 364.
Description
Since
5.x
Configuration File
Parent Definition
history:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type not wdk5_testtype_1
Elements
None.
User feedback
showallmessages
Purpose
Calls the messages, page 1308 component to display a data grid of all the user’s messages for a session.
accessiblefolderbrowse (privilege sysadmin, type dm_user)
Parameters
None.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
Users, groups, and roles
accessiblefolderbrowse (privilege sysadmin, type

dm_user)
Purpose
Locates dm_user objects.
Parameters

drop-down list.
multiselect (Optional) Set to true to support multiple object
selection.
objecttype (Optional) Object type of the selected object.
accessiblefolderbrowse (type dm_member_user, entitlement collaboration6)
Description
Since
6.0
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
accessiblefolderbrowse (type dm_member_user,

entitlement collaboration6)
Purpose
Locates dm_member_user objects.
Parameters

drop-down list.
multiselect (Optional) Set to true to support multiple object
selection.
objecttype (Optional) Object type of the selected object.
Description
Since
6.0
addgroupmembership (type dm_restriction)
Configuration File
Scope
type dm_member_user
Elements
None.
addgroupmembership (type dm_restriction)
Purpose
Adds a user or group to a group that has restricted access. Trusted Content Services must be enabled
in the repository.
Parameters
accessorName (Required) Name of user or group

objectId (Optional) ID of the ACL (permission set)
Description
Since
5.x
Configuration File
Scope
type dm_restriction
Elements
None.
addprocessorauthentication
addprocessorauthentication
Purpose
Sets the skill level and authorized document profiles for a new work queue processor
Parameters
multiselect (Optional) Set to true to allow multiple selection
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\userprofile_actions.xml
Scope
All.
Elements
None.
addrequiredgroup
Purpose
Adds a group of users to an ACL. A user must belong to that group in order to satisfy any security
check with that ACL (Requires that Trusted Content Services be enabled in the repository.)
Parameters
flatlist (Optional) Boolean: True to list all objects in a

multiselect (Required) Boolean: True to support multiple
object selection
addrequiredgroupset

roomId (Optional) ID of a room, in the case of a room
ACL
Description
Since
5.x
Configuration File
addrequiredgroupset
Purpose
Creates a set of groups. A user must belong to one of the groups in order to satisfy any security check
with that ACL (Requires that Trusted Content Services be enabled in the repository.)
Parameters

multiselect (Required) Boolean: true to support multiple
object selection
ACL
adduserorgroup (type grouplist)
Description
Since
5.x
Configuration File
adduserorgroup (type grouplist)
Purpose
Adds a user or group to the repository
Parameters

object selection
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\grouplist_actions.xml
Scope
type grouplist
Elements
None.
adminbrowse (type dm_group)
adminbrowse (type dm_group)
Purpose
Allows the administrator to browse a list of group administrators in a repository.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
groupbrowse (privilege sysadmin, type dm_user)
Purpose
Allows the administrator to browse a list of groups in a repository.
Parameters
None.
Description
Since
5.x
groupbrowse (type dm_group)
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
groupbrowse (type dm_group)
Purpose
Allows the administrator to browse a list of groups in a repository.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
groupreassign (type dm_group)
groupreassign (type dm_group)
Purpose
Renames a group
Parameters
objectId (Required) ID of the selected group.

Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
groupreassign (type dm_member_group)
Purpose
Renames a group.
Parameters
objectId (Required) ID of the selected group.

grouprenamelog (type dm_group)
Description
Since
5.x
Configuration File
Scope
Elements
None.
grouprenamelog (type dm_group)
Purpose
Displays requests for renaming groups.
Parameters
renametarget (Optional) Type of objects requested for rename.

Valid values: USER | GROUP
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
newgroup (privilege creategroup, type dm_group)
newgroup (privilege creategroup, type dm_group)
Purpose
Creates a new group in the repository.
Parameters
objectId (Required) Must have a value of newobject to

create a new group.
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
newrole (privilege creategroup, type dm_role)
Purpose
Creates a new role in the repository (dm_group object with attributes group_class="role" and
group_name=" role_name").
newuser (privilege sysadmin, type dm_user)
Parameters
objectId (Required) ID of the selected role. Set to

newobject to create a new role.
objectname (Required) Name of the role.
Description
Since
5.x
Configuration File
webcomponent\config\admin\role\dm_role_actions.xml
Scope
type dm_role
Elements
None.
newuser (privilege sysadmin, type dm_user)
Purpose
Creates a new user in the repository
Parameters

Description
Since
5.x
ownerbrowse (type dm_group)
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
ownerbrowse (type dm_group)
Purpose
Allows the administrator to browse a list of group owners in the repository.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
properties (type dm_group)
properties (type dm_group)
Purpose
Displays the properties for the repository group or creates a new group.
Parameters
objectId (Required) ID of the selected group. Set to

newobject to create a new group.
Description
Since
5.x
Configuration File
Scope
type dm_group
Elements
None.
properties (type dm_member_group)
Purpose
Displays the properties of a dm_member_group object.
Parameters
objectId (Required) ID of the group for which to display

properties
objectname (Required) Name of group
properties (type dm_member_user, entitlement collaboration6)
Description
Since
5.x
Configuration File
Scope
Elements
None.
properties (type dm_member_user, entitlement

collaboration6)
Purpose
Displays the properties of a dm_member_user object. Requires a Documentum Collaborative
Services license.
Parameters
objectId (Required) ID of the user.

objectname (Required) Name of user
Description
Since
5.x
Configuration File
Scope
type dm_member_user
properties (type dm_user)
Elements
None.
properties (type dm_user)
Purpose
Displays properties for a selected user.
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_user
Elements
None.
reassignuser (privilege superuser, type dm_user)
Purpose
Renames a user.
reassignuser (type dm_member_user)
Parameters
objectId (Required) Object ID of the user to reassign.

objectname (Required) The name of the user.
Description
Since
5.x
Configuration File
Scope
privilege superuser
type dm_user
Elements
None.
reassignuser (type dm_member_user)
Purpose
Renames a user.
Parameters

Description
Since
5.x
removerequiredgroup
Configuration File
Scope
type dm_member_user
Elements
None.
removerequiredgroup
Purpose
Removes a group requirement from an ACL. (Requires that Trusted Content Services be enabled in
the repository.)
Parameters
accessorName (Required) Group to be removed from ACL

DF_ACCESS_PERMIT DF_EXTENDED_
PERMIT DF_APPLICATION_PERMIT
DF_ACCESS_RESTRICTION DF_EXTENDED_
RESTRICTION DF_APPLICATION_
RESTRICTION DF_REQUIRED_GROUP
DF_REQUIRED_GROUP_SET
Description
Since
5.x
Configuration File
Scope
All.
removerequiredgroupset
removerequiredgroupset
Purpose
Removes a set of required groups from an ACL. (Requires that Trusted Content Services be enabled
in the repository.)
Parameters
accessorName (Required) Name of group set to remove

Description
Since
5.x
Configuration File
Scope
All.
removeuserorgroup (type dm_member_group)
Purpose
Allows the administrator to remove a group from the repository
Parameters
groupId (Required) ID of the group to remove.
removeuserorgroup (type dm_member_user)
Description
Since
5.x
Configuration File
Scope
Elements
None.
removeuserorgroup (type dm_member_user)
Purpose
Allows the administrator to remove a user from the repository
Parameters
groupId (Required) ID of the user to remove.
Description
Since
5.x
Configuration File
Scope
type dm_member_user
Elements
None.
selectuser (type selectuser)
selectuser (type selectuser)
Purpose
Selects a user
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\selectuser_action.xml
Scope
type selectuser
Elements
None.
userbrowse (privilege sysadmin, type dm_user)
Purpose
Allows the administrator to browse a list of users in the repository
Parameters
None.
Description
Since
5.x
userimport (privilege sysadmin, type dm_user)
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
userimport (privilege sysadmin, type dm_user)
Purpose
Imports a user from another repository in the domain
Parameters
None.
Description
Since
5.x
Configuration File
Scope
privilege sysadmin
type dm_user
Elements
None.
userorgroupchooser
userorgroupchooser
Purpose
Displays a locator component for selecting users or groups for use with work queues
Parameters
groupName (Optional) Name of group from which to locate

a member user or group
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queue_actions.xml
Scope
All.
Elements
None.
userrenamelog (type dm_user)
Purpose
Displays job requests for renaming users.
Parameters

viewreport (type dm_rename_log)
Description
Since
5.x
Configuration File
Scope
type dm_user
Elements
None.
viewreport (type dm_rename_log)
Purpose
Displays a selected job report for a user or group rename or user change home repository job.
Parameters
objectId (Required) Job request ID.

oldname (Optional) Old name of user or group
Description
Since
5.x
Configuration File
webcomponent\config\admin\renamelog\renamelog_actions.xml
Scope
type dm_rename_log
Elements
None.
addcomponent (type dm_sysobject)
Virtual documents
addcomponent (type dm_sysobject)
Purpose
Adds a child node to a virtual document. The child object must be in the same repository.
Parameters
compoundArchitecture (Optional) Boolean specifying whether the

object is a compound virtual document
insertAfterNodeId (Optional) ID of the virtual document node after
which the new node is added
lockOwner (Optional) User who has checked out the root
object
newNodeIds (Optional)
newNodeObjectIds (Required) IDs of the objects to be added to the
virtual document.
newVDRootNodeIds (Optional)
nodeId (Optional) Node ID of the parent node for the
new object.
objectId (Required) Object ID of the parent node for the
new object.
preconditionShouldDisplayErrors (Optional) Set to true to display errors when the
precondition criteria are not met.
document.
Description
Since
5.x
Configuration File
addcomponentfromclipboard (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
addcomponentfromclipboard (type dm_sysobject)
Purpose
Adds a child node to a virtual document from the clipboard
Parameters

object
nodeId (Optional) ID of the object to be added as a child
node
objectId (Required) Parent node.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
addcomponentfromfileselector (type dm_sysobject)
addcomponentfromfileselector (type dm_sysobject)
Purpose
Adds a child node to a virtual document from the file selector.
Parameters

object
nodeId (Optional) ID of the object to be added as a child
node
objectId (Required) Parent node.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
addnewvirtualdocumentnode (type dm_sysobject)
Purpose
Create content and add it to a virtual document
assemblylist (type dm_sysobject)
Parameters

nodeId (Optional) Node ID of the parent for the new
content.
objectId (Required) Object ID of the parent for the new
content.
ownerName (Optional) Owner of the object, evaluated by the
role precondition
document.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
assemblylist (type dm_sysobject)
Purpose
Displays the structure of a virtual document snapshot.
Parameters
The parameters are inherited from viewassembly:webcomponent/config/actions/dm_sysobject_
actions.xml. See viewassembly (type dm_sysobject), page 618.
assemblylist (type dm_sysobject) (Webtop)
Description
Since
5.x
Configuration File
Parent Definition
viewassembly:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
assemblylist (type dm_sysobject) (Webtop)
Purpose
Calls the main (Webtop), page 805 or assemblylist (Webtop), page 1349 component to display the
structure of a virtual document snapshot.
Parameters
The parameters are inherited from viewassembly:webcomponent/config/actions/dm_sysobject_
actions.xml. See viewassembly (type dm_sysobject), page 618.
Description
Since
5.x
Configuration File
Parent Definition
assemblylist:webcomponent/config/actions/dm_sysobject_actions.xml
assemblyliststreamline (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
Purpose
Displays the structure of a virtual document snapshot in drilldown (streamline) view.
Parameters
The parameters are inherited from streamlineviewassembly:webcomponent/config/actions/dm_
sysobject_actions.xml. See streamlineviewassembly (type dm_sysobject), page 609.
Description
Since
5.x
Configuration File
Parent Definition
streamlineviewassembly:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
assemblyliststreamline (type dm_sysobject) (Webtop)

(Webtop)
Purpose
Calls the assemblyliststreamline, page 1349 component.
Parameters
The parameters are inherited from streamlineviewassembly:webcomponent/config/actions/dm_
sysobject_actions.xml. See streamlineviewassembly (type dm_sysobject), page 609.
Description
Since
5.x
Configuration File
Parent Definition
assemblyliststreamline:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
freezeassembly (type dm_sysobject)
Purpose
Freezes a virtual document snapshot. The user must have a contributor role.
makesimple (type dm_sysobject)
Parameters
assembledFromId (Optional) ID of the parent virtual document,

if any
isFrozenAssembly (Optional) Boolean parameter that specifies
whether the snapshot to be frozen is already
frozen
snapshot
objectId (Required) ID of the virtual document.
ownerName (Optional) User who owns the snapshot
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
makesimple (type dm_sysobject)
Purpose
Converts a virtual document to a simple document if the document has no child nodes.
makevirtual (type dm_sysobject)
Parameters

isVirtualDoc (Optional) Boolean flag that specifies whether
the object is a virtual document (required for
pre-4.1 repository virtual documents)
virtual document.
objectId (Required) ID of the object to be converted into a
virtual document.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
makevirtual (type dm_sysobject)
Purpose
Converts a simple object to a virtual document.
newassembly (type dm_sysobject)
Parameters

virtual document.
virtual document.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
newassembly (type dm_sysobject)
Purpose
Creates a new virtual document snapshot. The user must have a contributor role assigned in the
repository.
newvirtualdocumentnode (type dm_sysobject)
Parameters
folderId (Optional) ID of the folder in which to create

the assembly
virtual document.
ownerName (Optional) Owner of virtual document. Used
by role precondition to determine whether user
can create an assembly.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
newvirtualdocumentnode (type dm_sysobject)
Purpose
Adds content to a virtual document
openassembly (type dm_sysobject)
Parameters
editAfterCreate (Optional) Set to true to opening editing

application after creating the new node
objectId (Required) Object ID of the object to add to the
virtual document.
ownerName (Optional) Owner of virtual document. Used
by role precondition to determine whether user
can add a node.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
openassembly (type dm_sysobject)
Purpose
Opens a virtual document assembly (snapshot) in the virtual document editor
Parameters

openvirtualdocument (type dm_sysobject)

nodeId (Optional) ID of the node in a virtual document
pathInfo (Optional) Path to be displayed in the
breadcrumb
selectedNodeIds (Optional) Comma-separated list of nodeIds that
should be initially selected when the vdmlist
component is first displayed
structureComponent (Optional) Name of the component that displays
virtual document structure
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
openvirtualdocument (type dm_sysobject)
Purpose
Opens a virtual document in the virtual document structure viewing component.
Parameters

removecomponent (type dm_sysobject)

breadcrumb
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
removecomponent (type dm_sysobject)
Purpose
Removes a component document of dm_sysobject type from a virtual document.
removevirtualdocumentnode (type dm_sysobject)
Parameters
isCurrentVDMNode (Optional) Set to true if the object to be removed

is the current virtual document node (node
cannot delete itself).
nodeId (Optional) ID of the node to be removed from
the virtual document.
objectId (Required) ID of the object to be removed.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
removevirtualdocumentnode (type dm_sysobject)
Purpose
Removes a node from a virtual document
Parameters
isCurrentVDMNode (Optional) Set to true if the object to be removed

is the current virtual document node (node
cannot delete itself)
nodeId (Required) ID of the node to be removed
vdmRootObjectId (Required) ID of the virtual document root
reordercomponents (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
reordercomponents (type dm_sysobject)
Purpose
Changes the order of nodes in a virtual document
Parameters

virtual document.
nodeId (Optional) ID of the child node to be removed
virtual document.
Description
Since
5.x
reordervirtualdocumentnodes (type dm_sysobject)
Configuration File
Scope
type dm_sysobject
Elements
None.
reordervirtualdocumentnodes (type dm_sysobject)
Purpose
Changes the order of nodes in a virtual document
Parameters
nodeId (Required) ID of the node to be changed

vdmRootObjectId (Required) ID of the virtual document root node
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
repositioncomponent (type dm_sysobject)
repositioncomponent (type dm_sysobject)
Purpose
Rearranges the structure of a virtual document
Parameters
insertAfterNodeId (Optional) ID of the virtual document node after

which to move the object.
nodeId (Required) Node ID of the current parent node
for the object.
preconditionShouldDisplayErrors (Optional) Set to true to display errors on
evaluation of the precondition
targetParentNodeId (Required) Node ID of the new parent node for
the object.
vdmRootObjectId (Required) Object ID of the root of the virtual
document.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
savechanges
Purpose
Saves changes made to a virtual document structure
setbindingrule (type dm_sysobject)
Parameters
closeUponCompletion (Optional) Set to true to close virtual document

structure after saving
objectId (Optional) Object ID of the virtual document to
save.
ownerName (Optional) Owner of the virtual document
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
setbindingrule (type dm_sysobject)
Purpose
Allows a user to set a binding rule on a virtual document node. The setbindingrule precondition
determines that the selected object is a virtual document node. Also, the precondition checks that the
user has at least version permission on the virtual document parent node.
Parameters
nodeId (Required) ID of the document node on which

to set a binding rule.
vdmRootObjectId (Required) ID of virtual document root
streamlineviewassembly (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
streamlineviewassembly (type dm_sysobject)
Purpose
Displays in drilldown (streamline) view a list of virtual document snapshots for the selected object.
Parameters

isLaunchedFromDRL (Optional) Boolean: Whether the virtual
document was displayed from a DRL (True) or
not (False).Since 6.0.
objectId (Required) ID of the assembly
Description
Since
5.x
Configuration File
streamlineviewvirtualdoc (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
streamlineviewvirtualdoc (type dm_sysobject)
Purpose
Displays a virtual document in the drilldown view.
Parameters

virtual document.
Description
Since
5.x
Configuration File
unfreezeassembly (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
unfreezeassembly (type dm_sysobject)
Purpose
Unfreezes a frozen virtual document snapshot. The user must have a contributor role assigned in
the repository.
Parameters
isFrozenAssembly (Optional) Boolean parameter that specifies

whether the snapshot to be unfrozen is frozen
snapshot
objectId (Required) ID of the virtual document snapshot.
ownerName (Optional) User who owns the snapshot
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
vdmclickactionprompt (type dm_sysobject)
vdmclickactionprompt (type dm_sysobject)
Purpose
Displays a dialog box allowing the user to view a virtual document structure or edit the document.
Parameters

breadcrumb
structureComponent (Optional) Name of component to be used for
displaying the virtual document structure
useAssembly (Optional) Set to true to display a list of
assemblies.Set to false to display a list of virtual
documents.
Description
Since
5.x
Configuration File
vdmcopyoption (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
vdmcopyoption (type dm_sysobject)
Purpose
Presents the user with options for the type of copy operation on a virtual document
Parameters
objectName (Required) Name of the object that will be

copied.
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
vdmlist (type dm_sysobject)
Purpose
Displays a list of virtual documents in a list view
vdmlist (type dm_sysobject) (Webtop)
Parameters
The parameters are inherited from viewvirtualdoc:webcomponent/config/actions/dm_sysobject_
actions.xml. See viewvirtualdoc (type dm_sysobject), page 620.
Description
Since
5.x
Configuration File
Parent Definition
viewvirtualdoc:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
vdmlist (type dm_sysobject) (Webtop)
Purpose
Extends the WDK vdmlist component and adds support for the classic view. Displays the structure of
a virtual document. The user can navigate to the different parts of the virtual document by clicking
on the breadcrumb or the child node.
Parameters
The parameters are inherited from viewvirtualdoc:webcomponent/config/actions/dm_sysobject_
actions.xml. See viewvirtualdoc (type dm_sysobject), page 620.
Description
Since
5.x
vdmliststreamline (type dm_sysobject)
Configuration File
Parent Definition
vdmlist:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
vdmliststreamline (type dm_sysobject)
Purpose
Displays a list of virtual documents in a streamline (drilldown) view
Parameters
The parameters are inherited from streamlineviewvirtualdoc:webcomponent/config/actions/dm_
sysobject_actions.xml. See streamlineviewvirtualdoc (type dm_sysobject), page 610.
Description
Since
5.x
Configuration File
Parent Definition
streamlineviewvirtualdoc:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
vdmliststreamline (type dm_sysobject) (Webtop)
vdmliststreamline (type dm_sysobject) (Webtop)
Purpose
Provides a streamline view of virtual documents. Both the vdmlist components provide a UI
that displays the children and root in a virtual document, allows navigation through the virtual
document’s hierarchy, and displays menus to launch actions on selected items.
Parameters
The parameters are inherited from streamlineviewvirtualdoc:webcomponent/config/actions/dm_
sysobject_actions.xml. See streamlineviewvirtualdoc (type dm_sysobject), page 610.
Description
Since
5.x
Configuration File
Parent Definition
vdmliststreamline:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_sysobject
Elements
None.
vdmvalidate (type dm_sysobject)
Purpose
Calls the vdmvalidate, page 1375 component and the vdmvalidate_container, page 1376 container to
validate a virtual document.
viewassemblies (type dm_sysobject)
Parameters
compoundArchitecture (Optional) Compound document type of the

virtual document.
nodeId (Required) Node ID of the virtual document
node to validate.
objectId (Required) Object ID of the object to validate.
document.
Description
Since
6.0
Configuration File
Scope
type dm_sysobject
Elements
None.
viewassemblies (type dm_sysobject)
Purpose
View all assemblies generated from a virtual document
Parameters

folderId (Optional) ID of folder containing the virtual
document
folderPath (Optional) Path to folder containing the virtual
document
viewassembly (type dm_sysobject)

virtual document.
objectId (Required) ID of the virtual document for which
to display assemblies
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
viewassembly (type dm_sysobject)
Purpose
View an assembly object
Parameters

isLaunchedFromDRL (Optional) Boolean: Whether the assembly was
displayed from a DRL (True) or not (False).Since
6.0.
objectId (Required) Object ID of the selected object.
viewvdm (type dm_sysobject)
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
viewvdm (type dm_sysobject)
Purpose
Displays a virtual document tree
Parameters
isCurrentVDMNode (Optional) Set to true if user has selected the

current node for viewing
document.If greater than 0, the document is a
virtual document.
Description
Since
5.x
Configuration File
viewvirtualdoc (type dm_sysobject)
Scope
type dm_sysobject
Elements
None.
viewvirtualdoc (type dm_sysobject)
Purpose
Displays a virtual document in the objectlist view
Parameters

virtual document.
Description
Since
5.x
Configuration File
abortfailedautoworkflowtask (type dm_task)
Scope
type dm_sysobject
Elements
None.
Workflows
abortfailedautoworkflowtask (type dm_task)
Purpose
Aborts a failed automatic workflow task.
Parameters
canCompleteTask (Optional) Specifies that the task is active and

can be completed.
isFailedAutoTask (Optional) Specifies that an automatic task has
failed and can be re-run.
objectId (Required) ID of the task.
userCost (Optional) Customer-defined cost data, stored as
double in Server. Can be audited and summed
up for completed workflows.
userTime (Optional) Customer-defined time data, stored
as integer in Server. Can be audited and
summed up for completed workflows.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\taskmgr_actions.xml
abortworkflow (type dm_workflow)
Scope
type dm_task
Elements
None.
Purpose
Aborts a workflow.
Parameters
objectId (Required) ID of the workflow.

supervisor (Optional) User name of workflow supervisor
workflowRuntimeState (Required) State of the workflow. 0=dormant
| 1=running | 2=finished | 3=halted |
4=terminated
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_workflow_actions.xml
Scope
type dm_workflow
Elements
None.
acceptworkflowtask (type dm_task)
acceptworkflowtask (type dm_task)
Purpose
Accepts a workflow task for the user.
Parameters
canAcquireTask (Optional) Boolean flag that indicates that the

task is in a state such that it can be acquired (not
paused, already acquired, or finished)
isGroupOwned (Optional) Boolean flag that indicates that the
task is assigned to a group of which the user is
a member
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
addattachment (type dmi_package)
Purpose
Adds an attachment to a workflow package
addwfattachment
Parameters
formTemplateId (Optional) ID of the XForm template

objectId (Required) Task ID
objecttype (Optional) Type of the attachment object
packageName (Required) Name of the workflow package
runtimeState (Required) State of the workflow. 0=dormant
4=terminated. Only 0 or 1 can be suspended.
versionlabel (Optional) Version label for the attachment
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmi_package_actions.xml
Scope
type dmi_package
Elements
None.
addwfattachment
Purpose
Adds an ad hoc attachment to a workflow
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
Purpose
Attributes of a workflow business calendar.
Parameters
actiontype (Optional) Not used.
objectId (Required) ID of the workflow business

calendar.
objectName (Optional) Object name of the workflow business
calendar.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\workflow\calendar\workflow_calendar_actions.xml
cancelcheckout (type dm_process)
Scope
type workflow_calendar
Elements
None.
Purpose
Cancels the checked out status of an object. The user must have version level permission (valid values:
DELETE_PERMIT | WRITE_PERMIT | VERSION_PERMIT | RELATE_PERMIT | READ_PERMIT |
Parameters
The parameters are inherited from cancelcheckout:webcomponent/config/actions/dm_sysobject_
actions.xml. See cancelcheckout (type dm_sysobject), page 419.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_process_actions.xml
Parent Definition
cancelcheckout:webcomponent/config/actions/dm_sysobject_actions.xml
Scope
type dm_process
Elements
None.
changeperformer (type dm_task)
Purpose
Changes the performer of a future task in a workflow
Parameters
objectName (Required) Activity name of the future task.

supervisor (Optional) Workflow supervisor
taskRuntimeFlag (Required) State of the workflow task. Valid
values: 0=dormant | 1=acquired | 2=finished |
3-6 =paused | 7=ready
workflowId (Required) ID of the workflow.
workflowRuntimeState (Required) State of the workflow activity. Valid
values: 0=dormant | 1=running | 2=finished |
3=halted | 4=terminated
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_task_actions.xml
Scope
type dm_task
Elements
None.
changesupervisor (type dm_workflow)
Purpose
Changes the supervisor of a workflow.
comment (type dm_process)
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
comment (type dm_process)
Purpose
Adds a comment to a workflow template
Parameters

startworkflowId (Required) Component ID of the task manager
component to be displayed as the first tab in the
container.
Description
Since
5.x
comment (type dm_task)
Configuration File
Scope
type dm_process
Elements
None.
comment (type dm_task)
Purpose
Adds a comment to a workflow task.
Parameters
objectId (Required) ID of the task

taskmanagerId (Required) Component ID of the task manager
component.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
commitchanges (type dm_sysobject)
Purpose
Asks the user whether to save changes to a virtual document before displaying it. Called by the
vdmviewcomponent when a user views a virtual document that has been checked out.
Parameters

ownerName (Optional) Name of the person who created the
document
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
completefailedautoworkflowtask (type dm_task)
Purpose
Completes a failed automatic workflow task.
delegateworkflowtask (type dm_task)
Parameters

can be completed.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
delegateworkflowtask (type dm_task)
Purpose
Delegates a task in a workflow.
delete (type dm_activity)
Parameters

can be completed.
isDelegable (Optional) True to specify that the task can be
delegated
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
delete (type dm_activity)
Purpose
Deletes one or more activity objects. The user must have a role of contributor.
Parameters

object is located
delete (type dm_process)
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_activity_actions.xml
Scope
type dm_activity
Elements
None.
delete (type dm_process)
Purpose
Deletes one or more workflow templates. The user must have a role of contributor.
Parameters

workflow template is located
workflow template
objectId (Required) The ID of the workflow template to
be deleted.
ownerName (Optional) User who owns the workflow
template to be deleted
Description
Since
5.x
Configuration File
delete (type dm_workflow)
Scope
type dm_process
Elements
None.
delete (type dm_workflow)
Purpose
Deletes a workflow object.
Parameters

4=terminated
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
delete (type workflow_calendar)
delete (type workflow_calendar)
Purpose
Enables deleting workflow business calendars.
Parameters

calendar.
calendar.
Description
Since
6.0 SP1
Configuration File
Scope
Elements
None.
deletenotification (type dm_notification)
Purpose
Deletes a notification from a router.
Parameters
objectId (Required) The ID of the notification.

routerId (Required) ID of the router.
drlview (type dm_process)
Description
Since
5.x
Configuration File
Scope
Elements
None.
drlview (type dm_process)
Purpose
Navigates to the parent folder or object of the DRL and opens the workflow template for viewing.
Parameters
The parameters are inherited from view:webcomponent/config/actions/dm_process_actions.xml. See
view (type dm_process), page 672.
Description
Since
5.x
Configuration File
Parent Definition
view:webcomponent/config/actions/dm_process_actions.xml
Scope
type dm_process
editfile (type dm_process)
Elements
None.
editfile (type dm_process)
Purpose
Launches the Web Workflow Manager to allow editing of a workflow template. The user must have
version level permission (valid values: DELETE_PERMIT | WRITE_PERMIT |VERSION_PERMIT
| RELATE_PERMIT | READ_PERMIT | BROWSE_PERMIT | NONE_PERMIT). The user must
also have a contributor role.
Parameters
objectId (Required) ID of the workflow template. (This is

ownerName (Optional) User who owns the workflow
template
setError (Optional) Set to true to pass the precondition
error message to the WebcomponentErrorService
as a non-fatal message
Description
Since
5.x
Configuration File
Scope
type dm_process
Elements
None.
editstartwfnote (type dmi_package)
Purpose
Allows the user to add or edit a task note at the start of a workflow
Parameters
operationType (Required) Type of operations to perform on a

note. Valid values: add | edit | remove.
packageName (Required) Name of the workflow package.
processId (Required) ID of the workflow template
Description
Since
5.x
Configuration File
Scope
type dmi_package
Elements
None.
edittasknote (type dmi_package)
Purpose
Allows the user to add, remove, or edit a task note
emailperformers (type dm_workflow)
Parameters
operationType (Required) Type of edit operation: add | edit |

remove
queueItemId (Required) ID of the workflow task, which is
passed as the objectId value to the edittasknote
component.
queueItemState (Required) State of queue item. Valid values:
dormant | acquired | paused | ready | null.
Description
Since
5.x
Configuration File
Scope
type dmi_package
Elements
None.
emailperformers (type dm_workflow)
Purpose
Calls the sendemailcontainer, page 1036 container component to send an email to the dm_workflow
object performers.
Parameters
objectId (Required) ID of the dm_workflow object.

wfperformers (Required) User names of the workflow
performers.
emailsupervisor (type dm_workflow)
Description
Since
6.0
Configuration File
Scope
type dm_workflow
Elements
None.
emailsupervisor (type dm_workflow)
Purpose
Calls the sendemailcontainer, page 1036 container component to send an email to the supervisor
of the dm_workflow object.
Parameters

wfsupervisor (Required) User name of the supervisor of the
dm_workflow object.
Description
Since
6.0
Configuration File
Scope
type dm_workflow
finishworkflowtask (type dm_task)
Elements
None.
finishworkflowtask (type dm_task)
Purpose
Finishes a workflow task.
Parameters

can be completed.
hasEmptyMandatoryPkg (Optional) The task contains an empty package
that must be passed with the task
isManual (Optional) Specifies whether transition is
manual or automated.
Description
Since
5.x
Configuration File
Scope
type dm_task
forwardroutertask (type dm_router_task)
Elements
None.
forwardroutertask (type dm_router_task)
Purpose
Forwards a router task.
Parameters
canCompleteTask (Optional) True to specify that the user can

complete the task
objectId (Required) ID of the router task.
Description
Since
5.x
Configuration File
Scope
type dm_router_task
Elements
None.
forwardworkflowtask (type dm_task)
Purpose
Forwards a task in a workflow.
halttask (type dm_task)
Parameters

can be completed.
hasForwardPaths (Optional) Boolean flag that specifies whether
there are any remaining paths in the workflow
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
Purpose
Halts (pauses) a task in a workflow.
haltworkflow (type dm_workflow)
Parameters
objectName (Required) Task name.

values: 0=dormant |1=acquired | 2=finished |
3 6 =paused | 7=ready
workitemId (Required) ID of the work item.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
Purpose
Halts a workflow
Parameters

4=terminated
historicalprocessreport
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
Purpose
Creates a report showing historical workflow data.
Parameters
ownerName (Optional) Not used
Description
Since
5.x
Configuration File
Scope
All.
Elements
failoverenabled
historicaluserreport
Purpose
Creates a report showing historical workflow data organized by user
Parameters
ownerName (Optional) Not used
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
history (type dm_task)
Purpose
Displays the history of a workflow task.
Parameters

component.
newprocess (type dm_folder)
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
newprocess (type dm_folder)
Purpose
Creates a new workflow template by launching the Web workflow manager. The user must have
a contributor role. The permit value folder_link_permit performs a check for write permissions
on the folder when folder security is enabled.
Parameters
objectId (Required) ID of the folder in which to create

the template.
performed.
Description
Since
5.x
Configuration File
newWorkflowCalendar (type workflow_calendar)
Scope
type dm_folder
Elements
None.
newWorkflowCalendar (type workflow_calendar)
Purpose
Creates a new workflow business calendar.
Parameters
actiontype (Optional) Name of the action to be performed.

calendar.
calendar.
Description
Since
6.0 SP1
Configuration File
Scope
Elements
None.
rejectroutertask (type dm_router_task)
rejectroutertask (type dm_router_task)
Purpose
Rejects a router.
Parameters
canCompleteTask (Optional) True to specify that the user can

complete the task
objectId (Required) ID of the router task.
Description
Since
5.x
Configuration File
Scope
type dm_router_task
Elements
None.
rejectworkflowtask (type dm_task)
Purpose
Rejects a task in a workflow
removeattachment (type dmi_package)
Parameters

can be completed.
hasRejectPaths (Optional) Boolean flag that specifies whether
there are any reject paths in the workflow
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
removeattachment (type dmi_package)
Purpose
Removes an attachment from a workflow package
removestartwfattachment (type dmi_package)
Parameters
attachmentName (Optional) Name of the attachment

isPackageManufactured (Optional) Boolean flag that specifies whether
the package was added in this task or previously
objectId (Required) ID of the workflow task.
Description
Since
5.x
Configuration File
Scope
type dmi_package
Elements
None.
removestartwfattachment (type dmi_package)
Purpose
Removes an attachment before the workflow has started
Parameters
attachmentName (Optional) Name of the attachment

objectId (Required) ID of the workflow task.
removestartwfwfattachment (type dmi_wf_attachment)
Description
Since
5.x
Configuration File
Scope
type dmi_package
Elements
None.
removestartwfwfattachment (type dmi_wf_

attachment)
Purpose
Removes an attachment before the workflow has started
Parameters
attachmentName (Optional) Name of the attachment to be

removed from the workflow.
docId (Required) ID of the attachment.
objectId (Required) ID of the workflow process.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmi_wf_attachment_actions.xml
Scope
type dmi_wf_attachment
removewfattachment (type dmi_wf_attachment)
Elements
None.
removewfattachment (type dmi_wf_attachment)
Purpose
Removes an attachment from a workflow
Parameters

removed from the workflow
objectId (Required) ID of the queue item.
packageName (Optional) Name of the workflow package
wf_attachment_id (Required) ID of the attachment to be removed
from the workflow.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmi_wf_attachment_actions.xml
Scope
type dmi_wf_attachment
Elements
None.
repeatworkflowtask (type dm_task)
repeatworkflowtask (type dm_task)
Purpose
Repeats a task in a workflow
Parameters

can be completed.
isRepeatable (Optional) Boolean flag that specifies whether
a task can be repeated
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
reportdetailsauditclassic (type dm_workflow) (Webtop)
reportdetailsauditclassic (type dm_workflow)

(Webtop)
Purpose
Launches the reportdetailscontainerclassic (type dm_workflow) (Webtop), page 1387 component
, which displays several workflow report components. This action is called by a link in the
reportmainclassic (Webtop), page 1396 component.
Parameters
objectId (Required) ID of the selected workflow.
Description
Since
5.x
Configuration File
webtop\config\dm_workflow_actions.xml
Scope
type dm_workflow
Elements
None.
reportdetailsauditdrilldown (type dm_workflow)
Purpose
Displays several workflow report components.
Parameters
reportdetailsauditlist (type dm_workflow)
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
reportdetailsauditlist (type dm_workflow)
Purpose
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
reportdetailsauditstreamline (type dm_workflow) (Webtop)
reportdetailsauditstreamline (type dm_workflow)

(Webtop)
Purpose
Launches the component reportdetailscontainerstreamline (type dm_workflow) (Webtop), page
1390, which displays several workflow report components. This action is called by a link in the
reportmainstreamline (Webtop), page 1400 component.
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
reportdetailsmap (type dm_workflow)
Purpose
Displays several workflow report components
Parameters
reportdetailssummarydrilldown (type dm_workflow)
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
Purpose
Displays several workflow report components
Parameters
objectId (Required) Object ID of the dm_workflow object

to report on.
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
reportdetailssummarydrilldown (type dm_workflow) (Webtop)

(Webtop)
Purpose
Launches the component reportdetailscontainerstreamline (type dm_workflow) (Webtop), page 1390,
which displays several workflow report components. This action is called by a link in the component
reportmainstreamline (Webtop), page 1400.
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
reportdetailssummarylist (type dm_workflow)
Purpose
Parameters
reportdetailssummarylist (type dm_workflow) (Webtop)
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
reportdetailssummarylist (type dm_workflow)

(Webtop)
Purpose
Displays several workflow report components. This action is called by a link in the component
reportmain_list.
Parameters
Description
Since
5.x
Configuration File
Scope
type dm_workflow
reportmainclassic (Webtop)
Elements
None.
Purpose
Calls the component reportmainclassic (Webtop), page 1396 and displays a list of workflow instances
and its attributes.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
reportmaindrilldown
Purpose
Displays a list of workflow instances and their attributes.
Parameters
None.
reportmainsettings
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
reportmainsettings
Purpose
Displays report settings.
Parameters
documentId (Optional) Specifies a document for which

workflows will be reported
filter (Required) Sets the selected filter. Valid values:
0 = all | 1 = completed | 2 = running
overdueDays (Optional) Specifies the number of days overdue
for which to display a report
overdueOnly (Required) True to filter for overdue task status.
templateId (Optional) Specifies a template for which
userName (Required) Name of the user for which to
display workflows.
Description
Since
5.x
reportmainstreamline (Webtop)
Configuration File
Scope
All.
Elements
None.
Purpose
Calls the reportmainstreamline (Webtop), page 1400 component and displays a list of workflow
instances and its attributes.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
rerunfailedautoworkflowtask (type dm_task)
rerunfailedautoworkflowtask (type dm_task)
Purpose
Reruns a failed automatic workflow task
Parameters

can be completed.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
resumetask (type dm_task)
Purpose
Resumes a task in a workflow that was previously halted
Parameters

values: 0=dormant |1=acquired | 2=finished |
workitemId (Required) Object ID of the work item to resume.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
resumeworkflow (type dm_workflow)
Purpose
Resumes a halted workflow
sendlocator (type dm_notification)
Parameters

4=terminated
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
Purpose
Parameters

sendlocator (type dm_router_task)
Description
Since
5.x
Configuration File
Scope
Elements
None.
Purpose
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_router_task_actions.xml
Scope
type dm_router_task
sendlocator (type dm_task)
Elements
None.
Purpose
Parameters

Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
startworkflow (type dm_process)
Purpose
Starts a workflow using a selected template. The user starts the workflow by selecting a document.
The startworkflow component is added to the container dynamically. The user must have a
contributor level of client capability.
startworkflowfromdoc (type dm_sysobject)
Parameters
attachmentIds (Optional) IDs of the objects attached to the

workflow
objectId (Required) ID of the workflow template.
ownerName (Optional) Name of the user who starts the
workflow
startworkflowId (Required) Component ID of the task manager
container.
Description
Since
5.x
Configuration File
Scope
type dm_process
Elements
None.
startworkflowfromdoc (type dm_sysobject)
Purpose
Starts a workflow with the selected document. The user starts the workflow by selecting a workflow
template. The user must have a contributor level of client capability.
startworkflownotemplate
Parameters
objectId (Required) ID of the object to route through the

workflow
ownerName (Optional) Name of the user who starts the
workflow
startworkflowId (Optional) Component ID of the task manager
component to be displayed as the first tab in
the container
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
startworkflownotemplate
Purpose
Starts a workflow without a workflow template
Parameters
ownerName (Optional) Owner of the object for which to start

a workflow
startworkflowId (Optional) Component ID of the taskmanager
container.
view (type dm_notification)
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
view (type dm_notification)
Purpose
Displays a notification.
Parameters
objectId (Required) ID of the notification object.

component.
Description
Since
5.x
Configuration File
Scope
Elements
None.
view (type dm_process)
view (type dm_process)
Purpose
Launches the Web Workflow Manager for viewing a workflow template. The user must
have read_permit access to the object (valid values: DELETE_PERMIT | WRITE_PERMIT
Parameters
objectId (Required) ID of the workflow template.

object to be viewed.
setError (Optional) Set to true to pass the precondition
error message to the WebcomponentErrorService
as a non-fatal message
Description
Since
5.x
Configuration File
Scope
type dm_process
Elements
None.
view (type dm_router_task)
Purpose
view (type dm_task)
Parameters

component.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_router_task_actions.xml
Scope
type dm_router_task
Elements
None.
view (type dm_task)
Purpose
Launches the task manager for viewing a task.
Parameters
objectId (Required) dm_queue_id of the object to be

viewed.
component.
Description
Since
5.x
view (type dm_workflow)
Configuration File
Scope
type dm_task
Elements
None.
view (type dm_workflow)
Purpose
Launches the Web Workflow Manager to display the selected workflow.
Parameters

workflowRuntimeState (Required) (Required) Integer that specifies
whether the workflow runtime state is Dormant
(0), Running (1), Terminated (2), Halted (3), or
Finished (4).
Description
Since
5.x
Configuration File
Scope
type dm_workflow
Elements
None.
workflowavailability
Purpose
Sets the user’s availability to receive workflow tasks
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
workflowcalendarlist (type workflow_calendar)
Purpose
Enables displaying a list of workflow business calendars.
Parameters
None.
Description
Since
6.0 SP1
workflowstatusclassic (Webtop)
Configuration File
Scope
Elements
None.
Purpose
Launches the workflowstatusclassic (Webtop), page 1479 component.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
workflowstatusdrilldown
Purpose
Displays in a drilldown view the workflows initiated by the user and the status of the workflows
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
workflowstatuslist
Purpose
Displays in an object list view the workflows initiated by the user and the status of the workflows
Parameters
None.
Description
Since
5.x
workflowstatusstreamline (Webtop)
Configuration File
Scope
All.
Elements
None.
Purpose
Launches the workflowstatusstreamline (Webtop), page 1482 component.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
addprocessorworkqueue
Work queue management
addprocessorworkqueue
Purpose
Adds a work queue processor to a work queue.
Parameters
None.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
addworkqueuemember
Purpose
Adds a user as a valid processor for a work queue.
assign_queued_task (type dm_task)
Parameters
addQueueMemberContext (Required) Boolean that must have a value of

true to perform action
groupName (Optional) Must have a value of queue_processor
to perform action
multiselect (Optional) Set to true to allow multiple selection
objectId (Optional) ID of work queue
queueName (Required) Name of work queue
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queueusersandgroups_actions.xml
Scope
All.
Elements
None.
assign_queued_task (type dm_task)
Purpose
Assigns a task from a work queue to a particular performer.
Parameters
objectId (Required) ID of the dm_task object.

ownerName (Optional) Name of the user who owns the task.
performer (Required) User name of the owner to whom to
assign the task.
queueName (Required) Name of the work queue.
attributes (type dm_queuegroup)
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_queued_task_actions.xml
Scope
type dm_task
Elements
None.
attributes (type dm_queuegroup)
Purpose
Displays the attributes of dm_queuegroup objects.
Parameters
objectId (Required) ID of the dm_queuegroup object.

objectname (Required) Name of the dm_queuegroup object.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_queuegroup_actions.xml
Scope
type dm_queuegroup
Elements
None.
attributes (type dm_queueprocessor)
attributes (type dm_queueprocessor)
Purpose
Displays the attributes of work queue processors.
Parameters
objectId (Required) ID of the dm_user object that

represents a work queue processor.
objectname (Required) Name of the dm_user object that
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_queueprocessor_actions.xml
Scope
type dm_queueprocessor
Elements
None.
attributes (type dmc_wq_skill_info)
Purpose
Displays the attributes of dmc_wq_skill_info objects.
changeprocessorworkqueuemember
Parameters
objectId (Required) ID of the dmc_wq_skill_info object.

objectname (Required) Name of the dmc_wq_skill_info
object.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmc_wq_skill_info_actions.xml
Scope
type dmc_wq_skill_info
Elements
None.
changeprocessorworkqueuemember
Purpose
Edit the user profile for a work queue member in a work queue.
Parameters
direct_member (Required) (Boolean) True, if the processor was

added as a user to the work queue; False, if
the processor is a member of a group that was
added to the work queue.
member (Required) (Boolean) True, if the processor is a
member of a group that was added to the work
queue; False, if the processor was added as a
user to the work queue.
name (Required) Name of the work queue.
delete (type dm_queued)
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
Purpose
Deletes a queue item in the inbox.
Parameters

objectName (Optional) The name of the queue item.
Description
Since
5.x
Configuration File
Scope
type dm_queued
Elements
None.
delete (type dmc_workqueue_category)
Purpose
Deletes one or more objects.
Parameters
objectId (Required) ID of the object to be deleted.

objectname (Optional) Name of the selected object.
object to be deleted.
Description
Since
5.x
Configuration File
Scope
Elements
None.
delete (type dmc_workqueue_doc_profile)
Purpose
Deletes a work queue document profile object. This action is available only when the document
profile is not used.
delete (type dmc_workqueue_policy)
Parameters

profile object.
objectname (Optional) Name of the work queue document
profile.
ownerName (Optional) Name of the user who owns the work
queue document profile object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
Purpose
Deletes a work queue policy. This action is available only when the policy is not being used.
Parameters

objectname (Optional) Name of the work queue policy
object.
queue policy object.
delete (type dmc_workqueue)
Description
Since
5.x
Configuration File
Scope
Elements
None.
Purpose
Deletes one or more workqueue objects. The user must have a role of contributor.
Parameters

objectname (Optional) Name of the selected object to be
deleted
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
delete (type dmc_wq_skill_info)
Elements
None.
Purpose
Deletes dmc_wq_skill_info objects.
Parameters

objectname (Optional) Name of the dmc_wq_skill_info
object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
deletenotification (type dm_queued)
Purpose
Deletes a notification from a router.
docprofileadd
Parameters
objectId (Required) The ID of the notification.

routerId (Required) ID of the router.
Description
Since
5.x
Configuration File
Scope
type dm_queued
Elements
None.
docprofileadd
Purpose
Adds a work queue document profile object
Parameters
objectId (Optional) Work queue ID
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\docprofileadd_actions.xml
docprofileremove
Scope
All.
Elements
None.
docprofileremove
Purpose
Removes a work queue document profile object. This action is available only if the document profile
is not being used.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\docprofileadd_actions.xml
Scope
All.
Elements
None.
editprocessorauthentication
Purpose
Sets the skill level and authorized document profiles for an existing work queue processor.
editwquserskill (type dmc_wq_user_skill)
Parameters
docprofile_enable (Optional) Set to true to enable setting a profile

for the user
docprofile_name (Optional) Name to assign to the profile
skill (Optional) Adds a value to the dropdown list of
skills in the form of an NLS ID
username (Required) Sets a label for the User Name, in the
form of an NLS ID
wq_name (Required) Work queue name
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
editwquserskill (type dmc_wq_user_skill)
Purpose
Enables editing of dmc_wq_user_skill objects.
Parameters
skill_info_id (Optional) ID of the dmc_wq_skill_info object.

skill_values (Optional) For the specified skill, the actual skill
values (String) of the user.
user_name (Required) Name of the user.
get_work
Description
Since
5.x
Configuration File
webcomponent\config\actions\dmc_wq_user_skill_actions.xml
Scope
type dmc_wq_user_skill
Elements
None.
get_work
Purpose
Retrieves the highest priority unassigned task from a work queue
Parameters
allowPullEmptyOnly (Optional) Set to false to allow the user to get

the next task even if the user’s inbox contains
other active tasks.
getWorkContext (Required) Set to true to allow this action within
the context of the calling component (set by
inboxdrilldown and inboxlist). The action will
be disabled within components that do not set
the value to true.
ownerName (Optional) Owner of the task
userName (Optional) Current user
Description
Since
5.x
managequeueinbox (type dmc_workqueue)
Configuration File
Scope
All.
Elements
None.
managequeueinbox (type dmc_workqueue)
Purpose
Manages the work queue inbox containing the tasks of the selected queue.
Parameters
categoryPath (Optional) Navigation path through work queue

categories used to reach the current queue; used
for setting the breadcrumbs.
queuename (Required) Name of the selected queue.
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
Elements
None.
move_queued_task (type dm_task)
move_queued_task (type dm_task)
Purpose
Moves a task from one work queue to another.
Parameters

dm_task object.
performer (Required) Name of the performer.
queueName (Required) Name of work queue.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
move (type dmc_workqueue_category)
Purpose
Moves a work queue or work queue category to a new location.
move (type dmc_workqueue)
Parameters

queue to be moved.
Description
Since
5.x
Configuration File
Scope
Elements
None.
move (type dmc_workqueue)
Purpose
Moves a clipboard object to a new location.
Parameters
None.
Description
Since
5.x
Configuration File
myworkqueuecategories
Scope
type dmc_workqueue
Elements
None.
myworkqueuecategories
Purpose
Displays a list of the work queue categories of which the current user is a manager.
Parameters
arrangeselect (Optional) Boolean: true to allow rearrangement

of order.
object selection.
selected.
Description
Since
5.x
Configuration File
webcomponent\config\actions\queue_management_actions.xml
Scope
All.
Elements
None.
newWorkQueue (type dmc_workqueue)
newWorkQueue (type dmc_workqueue)
Purpose
Creates a new work queue object.
Parameters
categoryPath (Required) Navigation path through work queue

objectId (Required) ID of the work queue object.
objectname (Required) Name of the work queue object.
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
Elements
None.
newWorkQueueCategory
Purpose
Creates a new work queue category object.
newWorkQueueDocProfile (type dmc_workqueue_doc_profile)
Parameters
categoryPath (Required) Navigation path through work queue

objectId (Required) ID of the work queue category object.
objectname (Required) Name of the work queue category
object.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
newWorkQueueDocProfile (type dmc_workqueue_

doc_profile)
Purpose
Creates a new work queue document profile object.
Parameters

profile object.
profile.
newWorkQueuePolicy (type dmc_workqueue_policy)
Description
Since
5.x
Configuration File
Scope
Elements
None.
newWorkQueuePolicy (type dmc_workqueue_

policy)
Purpose
Creates a new work queue policy object.
Parameters

object.
Description
Since
5.x
Configuration File
Scope
newWQSkillInfo (type dmc_wq_skill_info)
Elements
None.
newWQSkillInfo (type dmc_wq_skill_info)
Purpose
Creates dmc_wq_skill_info objects.
Parameters

object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
processorqueueinbox (type dmc_workqueue)
Purpose
Displys the inbox for a work queue processor.
processorskillattributes
Parameters

queuename (Required) Name of the work queue to display
in the work queue inbox.
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
Elements
None.
Purpose
Modify a work queue processor’s skill attributes.
Parameters
skill_info_id (Optional) skill_info_id attribute to modify.

skill_values (Optional) Values to change to in the specified
skill_info_id parameter.
user_name (Required) Name of the work queue processor.
processorworkloadinbox
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
Purpose
Displays the work queue items assigned to a particular work queue processor.
Parameters

objectname (Required) Name of group to which user or
group must belong to process inbox queue
items.
ownerName (Optional) Owner of group
queueName (Required) Name of the workload queue
Description
Since
5.x
Configuration File
webcomponent\config\actions\queue_member_actions.xml
properties (type dm_queuegroup)
Scope
All.
Elements
None.
properties (type dm_queuegroup)
Purpose
Displays the properties of dm_queuegroup objects.
Parameters
objectId (Required) ID of the dm_queuegroup object.

objectname (Required) Name of the dm_queuegroup object.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_queuegroup_actions.xml
Scope
type dm_queuegroup
Elements
None.
properties (type dm_queueprocessor)
Purpose
Displays the properties of work queue processors.
properties (type dmc_workqueue_category)
Parameters
objectId (Required) ID of the dm_user object that

objectname (Required) The user_name attribute value in the
dm_user object that represents a work queue
processor.
Description
Since
5.x
Configuration File
webcomponent\config\actions\dm_queueprocessor_actions.xml
Scope
type dm_queueprocessor
Elements
None.
properties (type dmc_workqueue_category)
Purpose
Displays the properties of an object (dmc_workqueue_category).
Parameters

Description
Since
5.x
properties (type dmc_workqueue_doc_profile)
Configuration File
Scope
Elements
None.
properties (type dmc_workqueue_doc_profile)
Purpose
Displays the properties of a dmc_workqueue_doc_profile object.
Parameters
objectId (Required) ID of the dmc_workqueue_doc_

profile object.
objectname (Required) Name of the dmc_workqueue_doc_
profile object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
properties (type dmc_workqueue_policy)
properties (type dmc_workqueue_policy)
Purpose
Displays the properties component for a work queue policy.
Parameters

object.
Description
Since
5.x
Configuration File
Scope
Elements
None.
properties (type dmc_workqueue)
Purpose
Displays the properties of a dmc_workqueue object
Parameters

objectname (Required) Name of the selected object
properties (type dmc_wq_skill_info)
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
Elements
None.
properties (type dmc_wq_skill_info)
Purpose
Displays properites for dmc_wq_skill_info objects.
Parameters

object.
Description
Since
5.x
Configuration File
Scope
pull_queued_task (type dm_task)
Elements
None.
pull_queued_task (type dm_task)
Purpose
Calls the pullqueuedtask, page 1509 component in the pullqueuedtaskcontainer, page 1509 container
component.
Parameters
objectId (Required) Queue item ID of the dm_task object

to be selected.
performer (Required) Name of the user to whom to assign
the dm_task object
queueName (Required) Name of the work queue from which
to select the the dm_task objects.
Description
Since
6.0
Configuration File
Scope
type dm_task
Elements
None.
queuelist (Webtop)
queuelist (Webtop)
Purpose
Calls queuelist (Webtop), page 1515 to display a list of the available work queues and work queue
categories.
Parameters
category_path (Optional) Navigation path through work queue

nodeIds (Optional) IDs of queue management nodes in
the browsertree.
object_name (Optional) Not used.
objectId (Optional) Queue ID.
Description
Since
6.0
Configuration File
webtop\config\queuelistclassic_actions.xml
Scope
All.
Elements
None.
queuelist
Purpose
Displays a list of the available work queues and work queue categories.
queuemonitorlist
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\queuelist_actions.xml
Scope
All.
Elements
None.
queuemonitorlist
Purpose
Displays an overview screen showing the status of a manager’s work queues.
Parameters
ownerName (Optional) Not used.
Description
Since
5.x
queueusersandgroups (type dmc_workqueue)
Configuration File
Scope
All.
Elements
None.
queueusersandgroups (type dmc_workqueue)
Purpose
Displays a list of the users and groups assigned to a work queue.
Parameters

objectId (Required) ID of the work queue.
queuename (Required) Name of the work queue.
Description
Since
5.x
Configuration File
Scope
type dmc_workqueue
Elements
None.
reassign_queued_task (type dm_task)
reassign_queued_task (type dm_task)
Purpose
Changes the user assigned to work on a work queue task.
Parameters

ownerName (Optional) Not used.
performer (Required) Name of the performer to which to
reassign the task.
queueName (Required) Name of the work queue for which
to assign a task.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
reassignworkflowtask (type dm_task)
Purpose
Delegate task in a workflow’s ReportDetailsSummary page.
Since
6.5
removeprocessorauthentication
removeprocessorauthentication
Purpose
Removes the skill level and authorized document profile settings for a work queue processor.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
removeworkqueuemember
Purpose
Removes a user from the list of valid processors for a work queue.
Parameters
addQueueMemberContext (Required) Boolean that must have a value of

true to perform action.
queueName (Required) Name of queue from which to
remove a user.
suspend_queued_task (type dm_task)
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queueusersandgroups_actions.xml
Scope
All.
Elements
None.
suspend_queued_task (type dm_task)
Purpose
Suspends a task from a work queue.
Parameters

runtimeState (Required) State of the workflow. Valid values
are: 0 = dormant 1 = running 2 = finished 3
= halted 4 = terminated Only 0 and 1 can be
suspended.
Description
Since
5.x
Configuration File
Scope
type dm_task
unassign_queued_task (type dm_task)
Elements
None.
unassign_queued_task (type dm_task)
Purpose
Removes a work queue task from an individual processor’s task list and returns it to the work queue.
Parameters

dm_task object.
performer (Required) Performer to whom the task was
assigned.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
unhold_queued_task (type dm_task)
unhold_queued_task (type dm_task)
Purpose
Releases a hold on a work queue task.
Since
6.5
unsuspend_queued_task (type dm_task)
Purpose
Returns a suspended queue task to active state.
Parameters

runtimeState (Required) State of the workflow. Valid values
are: 0 = dormant 1 = running 2 = finished 3
= halted 4 = terminated Only 0 and 1 can be
suspended.
Description
Since
5.x
Configuration File
Scope
type dm_task
Elements
None.
updateprocessorauthentication
Purpose
Updates the skill level and authorized document profiles for a work queue processor
Parameters
docprofile_name (Optional) Name to assign to the profile

skill (Optional) Adds a value to the dropdown list of
skills in the form of an NLS ID
username (Required) Sets a label for the User Name, in the
form of an NLS ID
wq_name (Required) Work queue name
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
updateprocessorskill
Purpose
Updates the skill level for a work queue processor.
view (type dm_queued)
Parameters
objectname (Required) Name of the work queue processor

(dm_queueprocessor) object.
requiredSkillIds (Required) Ids of the dmc_wq_skill_info objects
the work queue requires.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
view (type dm_queued)
Purpose
Parameters

component.
Description
Since
5.x
viewqueuemanagementclipboard
Configuration File
Scope
type dm_queued
Elements
None.
viewqueuemanagementclipboard
Purpose
Displays the contents of the queue management clipboard.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
newprintforms (type dm_folder)
XForms
newprintforms (type dm_folder)
Purpose
Creates a new form. The user must have the role form_user and folder_link_permit permission.
Customization is not supported.
Since
6.5
Usage
This edit component is same as the edit component, but its processor extends from the print form
check out processor.
newxforms (type dm_folder)
Purpose
Creates a new form. The user must have the role form_user and folder_link_permit permission.
Customization is not supported.
Parameters
objectId (Required) Object ID of the current folder in

which the form will be created.
performed.
saveasxforms (type dm_folder)
Description
Since
5.x
Configuration File
Scope
type dm_folder
Elements
None.
saveasxforms (type dm_folder)
Purpose
Creates a new form from a current form. The user must have the role form_user. Launched as a menu
item for a selected object in the list view. Customization is not supported.
Parameters

ownerName (Optional) Not implemented
Description
Since
5.x
Configuration File
saveasxforms (type dm_sysobject)
Scope
type dm_folder
Elements
None.
Purpose
Creates a new form from a current form. The user must have the role form_user.
Parameters

ownerName (Optional) Owner of object
Description
Since
5.x
Configuration File
Scope
type dm_sysobject
Elements
None.
Chapter 3
Components Reference
Overview
Components are grouped according to how they are used.
Common elements
This topic describes the elements that can be specified in more than one component configuration
file. Elements that can only be specified in one component configuration file are described in that
component’s entry.
actiontable
<actiontable>/webcomponent/testbed/wdklinks.jsp</actiontable>
allversionsvisible
<allversionsvisible>false</allversionsvisible>
Boolean: Whether to display all versions (true) or only the current version (false).
asynchronous
<asynchronous>true</asynchronous>
Boolean: Whether to enable (true) or disable (false) asynchronous execution of a component job. The
default is false.
attributes
1 <attributes>
2<attribute column="1">
3<name>name</name>
4<columnheader>MSG_OBJECT_NAME</columnheader>
</attribute>
...
</attributes>
1 Contains attribute definitions for columns to display.

2 Specifies a mapping for an attribute to a column. Specify an integer that represents the position
of the column in relation to the other columns.
3 Specifies the name of the attribute.
4 Specifies the name of the column header.
autogettaskdefault
<autogettaskdefault>false</autogettaskdefault>
Default value for auto get next task checkbox (default = unchecked).
base_type
<base_type>dm_cabinet</base_type>
Specifies the base type (which includes subtypes) for the component.
bindingcomponentversion
<bindingcomponentversion>latest</bindingcomponentversion>
Specifies the version of components that are supported by the container component. Default: latest.
breadcrumbiconwellmode
<breadcrumbiconwellmode>true</breadcrumbiconwellmode>
Whether to use the iconwell node (true) or the repository node (false) as the root of the breadcrumb.
See also iconwell, page 190.
cabinets
<cabinets>objectlist</cabinets>
Link to a component for a cabinet.
category
<category>categoryclassic</category>
Link to a component for a category.
clientevent
1 <clientevent>aiEvent</clientevent>
1 Specifies the client event to be fired on page rendering that is handled on the client. For events that
are handled by Application Connectors, an aiEvent is fired and passed to the Application Connectors.
columns (for data columns)

1 <columns>
2<column attribute="r_object_type">false</column>
...
</columns>
1 Root element of the element structure that configures data columns. Use with the celltemplate,
page 88 control.
2 Specifies whether the column is displayed (true) or not (false) for an object type attribute specified
in this element’s attribute attribute.
columns (for streamline view)

1 <columns>
<loadinvisibleattributes>true</loadinvisibleattributes>
2<column>
3<attribute>r_version_label</attribute>
4<label>
5<nlsid>MSG_VERSION_LABEL</nlsid>
</label>
6<visible>true</visible>
</column>
...
</columns>
1 Specifies the order of columns and whether they are displayed in streamline view. Contains
<column> elements.
2 Root element for the element structure that configures a column.
3 Attribute to be displayed in the column.
4 Label for the column. Valid value is a string. Can specify an <nlsid> child element instead of a
string.
5 NLS lookup key. The string corresponding to the NLS ID is displayed.
6 Whether to show the column (true) or not (false).
columns_list
1 <columns_list>
2<loadinvisibleattribute>true</loadinvisibleattributes>
3<column>
4<attribute>r_version_label</attribute>
5<label>
<nlsid>MSG_VERSION_LABEL</nlsid>
</label>
</column>
...
</columns_list>
1 Specifies the order of columns and whether they are displayed in classic view. Contains <column>
elements.
2 Whether to load and calculate hidden columns (true) or not (false).
3 Contains the configurable elements for a column.
string.
columns_all_saved_searches
1 <columns_all_saved_searches>
2<loadinvisibleattribute>true</loadinvisibleattribute>
3<column>
4<attribute>object_name</attribute>
5<label>
6<nlsid>MSG_NAME</nlsid>
</label>
</column>
...
</columns_all_saved_searches>
1 Specifies the attributes to load in columns for all saved searches.

3 Specifies a mapping for an attribute to a column.
4 Specifies the name of the attribute.
5 Specifies the name of the column header.
6 Specifies the NLS ID specified in the NLS file for the component.
7 Specifies whether the column is to be displayed (true) or hidden (false).
columns_my_saved_searches
1 <columns_my_saved_searches>
3<column>
5<label>
</label>
</column>
...
</columns_my_saved_searches>
1 Specifies the order and visibility of attribute columns for a user’s saved searches.
3 Corresponds to a column in saved searches. Contains <attribute>, <label>, and <visible> elements.
4 Corresponds to an attribute of the saved searches.
5 Label for the column in the saved searches. Contains string or <nlsid>.
7 Boolean flag that sets the visibility of the column in the saved searches.
columns_saved_search
1 <columns_saved_search>
3<column>
5<label>
</label>
</column>
...
</columns_saved_search>
1 Specifies the order and visibility of attribute columns for a saved search.
3 Corresponds to a column in a saved search. Contains <attribute>, <label>, and <visible> elements.
4 Corresponds to an attribute of a saved search.
5 Label for the column in a saved search. Contains string or <nlsid>.
7 Boolean flag that sets the visibility of the column in a saved search.
comments
1 <comments>
2<comment>
</comment>
...
</comments>
1 Contains one or more <comment> elements.

2 Specifies comment attributes to include in the TopicResultSet. Contains <attribute> and <visible>
elements.
3 Sets the name of the attribute to be included in the result set.
4 Set to true to make the attribute visible.
commitorder
1 <commitorder>
2<component>multiobjectspermissions</component>
<component>multiobjectsattributes</component>
</commitorder>
1 Contains <component> elements that specify the order in which properties changes will be saved.
2 Value specifies one or more contained component for which changes will be saved in the order the
components are listed within <commitorder>.
containerselectable
<containerselectable>true</containerselectable>
Boolean: Whether the container type is selectable when the container is a subtype of the objecttype.
contenttypepanelvisible
<contenttypepanelvisible>true</contenttypepanelvisible>
Boolean: Whether to show the content type panel (true) or not (false).
cost_attribute_conditions
1 <cost_attribute_conditions>
2<number>
3<condition>
4<nlsid>MSG_EQUAL_TO</nlsid>
</condition>
...
</number>
</cost_attribute_conditions>
1 Specifies the operators that can be used to define a range of user-specified task costs for the business
process historical report. The unit for task cost is not defined. To enable users to specify a cost for a
task, you must enable the showusertimeandcost element in the taskmanager, page 1451 component.
2 Container for <condition> elements.
3 Container for <nlsid> elements.
4 Specifies the NLS ID for an operator.
default_binding_filter_values
1 <default_binding_filter_values>
2<version_label>Approved</version_label>
...
</default_binding_filter_values>
1 List of version labels to include in the default child version dropdown. These values are in addition
to "CURRENT" and existing version labels on the virtual document root node.
2 Additional label to display, for example, Approved.
default_type
<default_type>dm_cabinet</default_type>
Specifies the default object type selection for the component. Must be the same as the one (or one of
its subtypes) specified in the <base_type> element.
defaultaccounts
1 <defaultaccounts>
2<filter docbase=repository-name>
3<defaultaccount>
4<username>username</username>
5<password>encrypted_password</password>
6<domain>domain_name</domain>
</defaultaccount>
</filter>
...
7<logoffoncomplete>true</logoffoncomplete>
</defaultaccounts>
1 Contains anonymous access login information in one or more <defaultaccount> elements.

2 Optional filter to specify the account for a single repository. Set the repository attribute on this
element to the repository name.
3 Sets up anonymous access for virtual links.
4 Name of a user in the target repository.
5 Password for the anonymous user. Can be encrypted with the Trusted Authenticator Tool. Refer to
Web Development Kit Development Guide for instructions.
6 Optional network domain name for login to the repository.
7 Set to true to log the default account off and close the window after the DRL action is performed.
defaultsources
<defaultsources>preferred_sources</defaultsources>
Sets the default search locations to be displayed for a search. Valid values: current_docbase
(current repository) | visibile_docbases (all visible repositories) | preferred_sources (all
visible repositories and external sources set in the user’s preferences) | all_sources (all visible
repositories and external sources).
defaultview
<defaultview>my</defaultview>
Default display when the end user preference is not set. Valid values are:
my
all
For search templates, the default is all, which displays all search templates; for saved searches,
the default is my.
displayresultspath
<displayresultspath>true</displayresultspath>
Set to true to query and display the folder path to each result object. A value of false will speed
performance.
docbase-type-mappings
1 <docbase-type-mappings>
2<docbase-type-mapping>
3<format>msg</format>
4<type>dm_email_message</type>
</docbase-type-mapping>
...
</docbase-type-mappings>
1 Contains file format to object type mappings.

2 Contains <format> and <type> elements.
3 File format.
4 Object type.
document-docbase-base-type
<document-docbase-base-type>dmc_calendar_event</document-docbase-base-type>
Default base for retrieving a type list to be displayed on import.
document-docbase-type
<document-docbase-type>dmc_calendar_event</document-docbase-type>
Default selected object type of an object to be imported. Must be the type or subtype of
<document-docbase-base-type>.
document_filter
1 <document_filter>
2<preset_item id="type_filter">
3<selection>
4<entries>
5<entry></entry>
</entries>
</selection>
</preset_item>
</document_filter>
1 Preset filter for documents.

2 Specifies the kind of preset item; in this case, an object type filter.
3 Contains the <entries> element.
4 Contains <entry> elements.
5 An <entry> element.
dragdrop
1 <dragdrop>
2<sourceactions></sourceactions>
3<targetactions></targetactions>
4<dataproviders>
5<dataprovider>
6<format>com.documentum.web.formext.control.dragdrop.ObjectIdData</format>
7<provider>com.documentum.web.formext.control.dragdrop.ObjectIdDataProvider</provider>
</dataprovider>
...
</dataproviders>
</dragdrop>
1 Supports the drag and drop feature.

2 Contains zero or more <sourceaction> classes that support drag and drop actions on sources in
the component.
3 Contains zero or more <targetaction> classes that support drag and drop actions on targets in
the component.
4 Contains one or more <dataprovider> elements.
5 Contains a <format> element and a <provider> element.
6 Fully qualified class name for the class that provides data for the format. Built-in formats include
object ID, tree node, and external files.
7 Fully qualified class name for the class that implements IDragDropDataProvider and provides
data for the associated format.
duration_attribute_conditions
1 <duration_attribute_conditions>
2<number>
3<condition>
4<nlsid>MSG_EQUAL_TO</nlsid>
</condition>
...
</number>
</duration_attribute_conditions>
1 Specifies the operators that can be used to define a range of user-specified task durations for the
business process historical report. The unit for task duration is not defined. To enable users to
specify a duration for a task, you must enable the showusertimeandcost element in the taskmanager,
page 1451 component.
2 Container for <condition> elements.
3 Container for <nlsid> elements.
4 Specifies the NLS ID for an operator.
enableShowAll
<enableShowAll>true</enableShowAll>
Whether to display (true) or hide (false) the Show All Properties link.
entrypage
<entrypage>classic</entrypage>
Default entry view when the entryPage parameter is not specified in the request.
failoverenabled
<failoverenabled>true</failoverenabled>
Boolean: Whether to enable (true) failover for this component or not (false).
filenamefiltervisible
<filenamefiltervisible>false</filenamefiltervisible>
Whether to display the file name filter (true) or not (false).
filter
<filter role="administrator, dce_user_manager">
...
</filter>
Standard WDK filter that applies a scope qualifier such as type or role, which limits the application of
contained elements to user contexts that match the scope value.
flatlist
<flatlist>false</flatlist>
Boolean: Whether to display a flat list (true) or a drop-down list (false) of all selectable objects.
folder-docbase-type
<folder-docbase-type>dmc_calendar</folder-docbase-type>
Default folder type of a folder to be imported.
folder_filter
1 <folder_filter>
<selection>
<entries>
<entry></entry>
...
</entries>
...
</selection>
</preset_item>
</folder_filter>
1 Specifies a preset filter for folders.

2 Standard preset_item structure that specifies an object type filter. See preset_item, page 743.
formsavefolderpath
<formsavefolderpath>/System/Workflow/Processing Form</formsavefolderpath>
Path in the repository to associated XForm, if any. For example, /System/Workflow/Processing Form.
header
1 <header visible="true">
2<showpagingcontrol>true</showpagingcontrol>
3<showclosebutton>true</showclosebutton>
</header>
1 Contains header settings <showpagingcontrol> and <showclosebutton>. Set the visible attribute to
true to display a header when the objectgrid component is used as standalone. Sub-components can
override this element to configure the header.
2 True to display a paging control within the header
3 True to display a close button within the header
help-entries
1 <help-entries>
2<entry id="default">default.htm</entry>
...
</help-entries>
Specifies the relative paths to help files in the application.
helppath
<helppath>Web Workflow Manager</helppath>
Subdirectory of the help folder that contains online help for the Web workflow manager. For
example, a path of webwfmhelp could be resolved to C:\Program Files\Apache Group\Tomcat
4.1\webapps\webtop\help\en\webwfmhelp and a similar path for each installed language pack
(replacing "en)
hideEvents
<hideEvents>dm_changestateactivity</hideEvents>
Specifies one or more events to hide from the report. See the Content Server Administration Guide for
a list of events.
highlight_matching_terms
<highlight_matching_terms>true</highlight_matching_terms>
Set to true to highlight matches for search terms in the results.
homeURL
<homeURL>/component/testbed</homeURL>
Specifies the URL that should be displayed when the logout action is invoked. The default value
ensures that the testbed component is loaded again after the session is released.
homecabinet
<homecabinet>homecabinet_classic</homecabinet>
Specifies the component that displays a user’s home cabinet.
iconwell_icon
1 <iconwell_icon>icons/iconwell/iconwell_cabinets.gif</iconwell_icon>
1 Path within a theme directory to the icon. For example, a path of /icons/perspective/inbox32.gif
would map to a file at /root_directory/custom/theme/mytheme/icons/perspective\inbox32.gif. See
Web Development Kit Development Guidefor information on how themes are located.
inbox
<inbox>inboxclassic</inbox>
Specifies a component that displays a user’s inbox.
includetypes
<includetypes>dm_sysobject</includetypes>
Optional element (cannot be more than one instance of this element) that specifies a comma-separated
list of Documentum types to be included in the view. The container must be listed along with the
subtypes within the container; for example, dm_folder, dm_document.
<includetypes descend="true">dm_sysobject</includetypes>
Comma-delimited list of object types to display for search. Set the descend attribute to true to search
subtypes of the selected type; set to false to search only the selected type..
includeunlisted
<includeunlisted>true</includeunlisted>
Boolean: Whether to display (true) hidden users or not (false).
init-controls
1 <init-controls>
2<control name="downloadDescCheckbox" type="com.documentum.web.form.control.Checkbox">
3<init-property>
4<property-name>value</property-name>
<property-value>false</property-value>
</init-property>
...
</control>
...
</init-controls>
1 Initializes values for controls.

2 Names a control and sets its initial value. The value of the name attribute must match the name of
a control in the component JSP page. The value of the type attribute must be a fully qualified class
name for a display control. For example, when the Name attribute value is branchrevision, the type
attribute value is com.documentum.web.form.control.Radio.
3 Specifies an attribute on the control. Value is value.
4 Specifies an attribute on the control. Value is true.
isIgnorePrefRenditions
<isIgnorePrefRenditions>false</isIgnorePrefRenditions>
(Optional) Boolean: Whether to ignore the user’s preference for opening renditions (True) or not
(False).
locator
<locator></locator>
Locator component to be launched for selecting the attribute value. For example, the
selectuserattributevalue component sets the value to useronlylocatorcontainer.
lockInstance
<lockInstance>true</lockInstance>
(Optional) Boolean: Whether the component is to lock the form instance automatically when the form
is edited and release the lock when the component is exited (by submitting or canceling) (True) or
not (False).
map
1 <map>
2<height>480</height>
</map>
1 Contains elements that configure the report map view.

2 Default height in pixels for report map view for applets that cannot resize with the browser (for
example, Netscape).
maxidletime
<maxidletime>20</maxidletime>
Specifies how often (in minutes) the Web workflow manager sends event to the server to keep the
session alive.
menugrouptarget
<menugrouptarget>content</menugrouptarget>
Specifies the name of the frame that receives the content generated by a menu selection. If null or
empty, the name of the form that is submitted is used. In Webtop, the content frame name is used.
modifiedwithindays
<modifiedwithindays>7</modifiedwithindays>
Integer: Search for user’s objects that have been modified within the specified number of days.
multidocbasesupport
<multidocbasesupport>false</multidocbasesupport>
Boolean: Whether to enable (true) or disable (false) this locator to search for objects in more than
one repository.
myobjects
<myobjects>myfiles_classic</myobjects>
Specifies component that displays a user’s My Files node.
navigationlinks
<navigationlinks>/webcomponent/testbed/navigationMenu.jsp</navigationlinks>
Displays links to a specified JSP. Used in the WDK Automated Test Framework.
newcomponentname
<newcomponentname>newcabinet</newcomponentname>
Specifies the name of the component that will be launched to create the new object.
nodes
1 <nodes>
2<filter role="administrator, dce_user_manager">
3<node componentid="usermanagement">
4<icon>usermgmt.gif</icon>
5<handlerclass>com.documentum.webtop.webcomponent.administration.
UserManagementNavigationNode</handlerclass>
6<label>
7<nlsid>MSG_USER_MANAGEMENT</nlsid>
</label>
8<streamlinecomponent/>
9<description>
<nlsid>MSG_USER_MANAGEMENT</nlsid>
</description>
</node>
...
</filter>
...
10<docbase_nodes>
<node/>
...
</docbase_nodes>
</nodes>
1 Root element of an element structure that specifies the nodes in a tree. Contains <node> elements.
2 See filter, page 735.
3 Defines a node and its handler. In this element’s componentid attribute, specify the component
to be launched from a tree node in the administration branch of the tree. Contains <icon>, <label>,
<handlerclass>, and <description> elements.
4 File name of the icon to be used for the node.
5 Specifies the class to handle navigation within the node.
6 Specifies the label to be used for the node. May contain the <nlsid> element.
7 NLS lookup key. The string corresponding to the NLS ID is displayed as the label.
8 Specifies the name of the component to be used to display the node when the user switches to the
streamline view
9 String: Description that is displayed in the Description column for the node. May contain the
<nlsid> element.
10 Supports custom Docbase navigation nodes for individual Docbases (contains <node> elements)
nomaclsupport
<nomaclsupport>nomaclsupport_permissions</nomaclsupport>
Specifies the name of the component to use when Trusted Content Services is not enabled for the
repository. Default: permissions component.
nondocbasecolumns
1 <nondocbasecolumns>
2<column>
3<attribute>path</attribute>
4<label>
<nlsid>MSG_PATH</nlsid>
</label>
</column>
</nondocbasecolumns>
1 Contains <column> elements that are databound or otherwise provided by the component class
but are not included in the query.
2 Root element for the element structure that configures a column.
string.
numberedtabs
<numberedtabs>true</numberedtabs>
Boolean: To display each tab’s title with a sequential number (true) or not (false).
objectfilters
1 <objectfilters>
2<objectfilter>
3<label>
<nlsid>MSG_FILTER_FILES</nlsid>
</label>
4<type>dm_document</type>
</objectfilter>
...
</objectfilters>
1 Contains filters that define which objects should be shown in the objects selection list.
2 Specifies a filter for the items that are displayed. Contains <label>, <showfolders>, <type>.
3 Displays a label such as Folders or All. Can contain a string or <nlsid>.
4 To show folders only, set <showfolders> to true and <type> to null (no value). To show objects only,
set <showfolders> to false and <type> to dm_sysobject. To show all, set <showfolders> to true and
<type> to dm_sysobject. <type> can take any value that is a valid Docbase type.
pageTitle
<pageTitle>Webtop Test Bed</pageTitle>
Title displayed for the testbed component. This title can be used to distinguish different versions of
the testbed component used by other WDK-based applications.
permissionsservice
<permissionsservice>com.documentum.webcomponent.library.permissions.
PermissionsService</permissionsservice>
Specifies the package and class name of the permissions service.
<preferencedisplaygroups>
<group id=xxx>
<members>
...
</members>
<label><nlsid>MSG_FOO</nlsid></label>
</group>
<group id=yyy>
...
</group>
...
</preferencedisplaygroups>
The order of groups and the order of preferences inside a group controls the display of preference
groups. The preference-ref element must have an ID that matches an existing preference id in the
<preferences> element of the component definition. The group <label> is used for rendering the
group title.
preferences
1 <preferences>
2<display_docbase_types>
3<docbase_type>
4<value>dm_document</value>
5<label>
6<nlsid>LBL_DOCUMENT</nlsid>
</label>
</docbase_type>
...
</display_docbase_types>
7<show_repeating_attributes>true</show_repeating_attributes>
8<preference id="application.display.classic_cabinets_columns">
9<label>
10<nlsid>CLASSIC_CABINETS_COLUMNS_LABEL</nlsid>
</label>
11<columnlabel>
12<nlsid>CLASSIC_COLUMNS</nlsid>
</columnlabel>
13<type>columnlist</type>
14<display_hint>hidden</display_hint>
15<value>component[id=doclist].columns</value>
16<editcomponent>columnselector</editcomponent>
17<editcontainer>columnselectorcontainer</editcontainer>
</preference>
...
</preferences>
1 Container for preferences.

2 Container for specifying the object types for which column display preferences can be set. Only
used in the display_preferences component.
3 Container to specify an object type.
4 Object type name.
5 The string name to display for the object type.
6 Specifies an NLS key that is resolved to a string in the <nlsbundle> class referenced in the
component definition file.
7 Set to false to not display repeating attributes. Will not affect attributes in the default list or
attributes already in the selected list.
8 Defines the preference and its required ID attribute. Disabled attribute is optional and defaults to
false.
9 (Required) Sets the display name of the preference.
10 (Optional) Specifies an NLS key that is resolved to a string in the <nlsbundle> class referenced in
the component definition file. Use this element inside <label> and <description>.
13 (Required) Specifies the data type of the preference value. Valid value are: int | string |boolean |
columnlist.
14 Forces the control to use a type of display. Valid values are: password (for strings or integers) |
dropdownlist | listbox | hidden. A <constraints> element containing one or more <element> elements
must be present for drop-down list or list box.
15 Specifies the default value for the preference.
16 Specifies the component to launch for editing the preference. Configures column lists only
(<type> columnlist</type>).
17 Specifies the container to launch for editing the preference. Configures column lists only (<type>
columnlist</type>).
preserve-file-extension
<preserve-file-extension>true</preserve-file-extension>
Whether to keep (true) or strip out (false) the file extension as part of the object name when imported
into the repository.
preset_item
1 <preset_item id="format_filter">
2<selection>
3<entries>
4<entry></entry>
</entries>
</selection>
</preset_item>
1 Preset item. The id attribute specifies the kind of filter that this preset represents.
2 Defines a selection for the preset item.
4 An entry.
1 <preset_item id="group_filter">
2<selection>
3<entries>
4<entry></entry>
</entries>
</selection>
</preset_item
1 Preset item. The id attribute specifies the kind of filter that this preset represents; in this case, a
filter for groups.
4 An entry.
1 <preset_item id="format_filter">
2<selection>
3<entries>
4<entry></entry>
</entries>
</selection>
5<allow_nocontent_entry></allow_nocontent_entry>
</preset_item>
1 Preset item. The id attribute specifies the kind of filter that this preset represents; in this case, a
filter for file formats.
4 An entry.
5 Enables allowing a blank entry.
preset_item_definition
1 <preset_item_definition>
2<id>format_filter</id>
3<package_definition_name>webcomponent</package_definition_name>
4<itemdata_binding_definitions>
5<definition>
6<id>sole_itemdata</id>
7<target_definition_ids>
8<id>checkin_format_filter</id>
...
</target_definition_ids>
</definition>
...
</itemdata_binding_definitions>
</preset_item_definition>
1 Defines a kind of preset item.

2 ID of the kind of preset item; specified in the id attribute of the <preset_item> element.
3 Specifies the preset package name for the definition.

4 Specifies definitions for each item in the preset item definition.
5 Contains <id>, <target_definition> elements.
6 Specifies an ID for the <definition> element.
7 Contains <id> elements.
8 Specifies strings that identify different preset filters.
preset_scope_definitions
1 <preset_scope_definitions>
2<definition>
3<name>docbase</name>
4<package_definition_name>wdk</package_definition_name>
</definition>
...
</preset_scope_definitions>
1 Defines scopes for presets.

2 Defines a single scope.
3 Specifies the name of a scope.
4 Specifies the name of the package definition.
privatecabinet_visible
<privatecabinet_visible>true</privatecabinet_visible>
Boolean: Whether to show (true) or hide (false) private cabinets that are not owned by the session user.
privatecabinetvisible
<privatecabinetvisible>false</privatecabinetvisible>
Boolean: Whether to make private cabinets visible (true) or not (false).
privategroupvisible
<privategroupvisible>false</privategroupvisible>
Boolean: Whether private groups are displayed (true) or not (false).
readOnly
<readOnly>false</readOnly>
Boolean: Whether to display the attributes as read-only (true) or write (false). Applies to all types.
The readOnly parameter overrides this element.
savedetailsreport
<savedetailsreport>false</savedetailsreport>
Set to true to save the workflow details report in CSV format. Default is false.
search_types
1 <search_types>
2<type id="dm_document">
3<name>
<nlsid>MSG_DOCUMENT</nlsid>
</name>
4<attributes>
5<attribute>
6<name>
<nlsid>MSG_NAME</nlsid>
</name>
7<docbase_attribute>object_name</docbase_attribute>
8<attribute_type>string</attribute_type>
</attribute>
...
</attributes>
</type>
...
</search_types>
1 Contains the types of objects (<type> that are searched for. The first type is the default.
2 The type attribute specifies the object type that is searched for. Value must be a valid object type in
the repository. Contains <name>, <attributes>.
3 Name that will be displayed for the object type. Contains string or <nlsid>.
4 Contains the attributes to be displayed.
5 Specifies an attribute to be displayed.
6 Name that will be displayed for the attribute. Contains string or <nlsid>.
7 Specifies the name of the attribute to be displayed.
8 Specifies the data type of the attribute.
searchtypes
1 <searchtypes>
2<searchtype>
3<displayname>
4<nlsid>MSG_DOCUMENT_BYFULLTEXT</nlsid>
</displayname>
5<docbasetype>dm_document</docbasetype>
6<fulltextsearch showranking="true">true</fulltextsearch>
7<column></column>
</searchtype>
...
</searchtypes>
1 Contains the types of objects (<searchtype> that are searched for. The first type is the default.
2 Contains <displayname>, <docbasetype>, and <fulltextsearch>.
3 Name that will be displayed for the object type. Contains string or <nlsid>.
5 Type that is searched for. Value must be a valid object type in the repository.
6 True to perform full-text search on the type, false to search on properties only. By default, full-text
search is performed on dm_document and subtypes only. Set the showranking attribute to true to
show the Verity ranking of results.
7 Set to false to hide a column for the attribute that is specified. For example, a value of false and
<column attribute=’r_full_content_size’> hides the size column for the object type.
selectedattribute
<selectedattribute>object_name</selectedattribute>
Selected attribute value. Set this value in the derived component. For example, the
selectuserattributevalue component sets the value to object_name.
serveroptionenabled
<serveroptionenabled>false</serveroptionenabled>
Whether to display an additional login option for any running content servers (true) or not (false).
service
1 <service>
2<service-class>com.documentum.web.contentxfer.impl.ViewService</service-class>
3<transport-class>com.documentum.web.contentxfer.ucf.UcfContentTransport</transport-class>
4<post-processor-class>com.documentum.webcomponent.library.contenttransfer.view.
LaunchViewer</post-processor-class>
</service>
1 Specifies service classes for content transfer.

2 Specifies the fully qualified class name for the class that implements the service.
3 Specifies the fully qualified class name for the class that implements the transport.
4 Specifies the fully qualified class name for the class that implements any post-processing.
setrepositoryfromobjectid
<setrepositoryfromobjectid>true</setrepositoryfromobjectid>
Set to true to execute the query against the source repository. Affects reference and foreign objects.
showattachmentinfo
<showattachmentinfo>false</showattachmentinfo>
Boolean: true to show the attachment info.
showautogettask
<showautogettask>true</showautogettask>
Set to true to display a checkbox to get next task automatically.
showbreadcrumb
<showbreadcrumb>true</showbreadcrumb>
Boolean: Whether to display (true) breadcrumbs or not (false).
showfilters
<showfilters>false</showfilters>
True to show object type filters.
showfolderpath
<showfolderpath>true</showfolderpath>
Whether to display (true) the folder path to each result or not (false).
showfolders
<showfolders>false</showfolders>
Sets the user preference for whether to display folders. See type, page 750.
showheaderforsinglepackage
<showheaderforsinglepackage>true</showheaderforsinglepackage>
True to display the attached document header information when there is only one attached document.
showjobstatus
<showjobstatus>true</showjobstatus>
Boolean: Whether to display (true) the current status of a job or not (false).
showoptions
<showoptions>false</showoptions>
Set to true to display the additional options panel on the login page.
showpagesastabs
<showpagesastabs>true</showpagesastabs>
Whether to display attribute categories as tabs (true).
showusertimeandcost
<showusertimeandcost>true</showusertimeandcost>
Whether to enable (true) or disable (false) task duration and cost.
skipVersionCheck
<skipVersionCheck>false</skipVersionCheck>
Boolean: Whether to prompt the user to choose the current version of an object when the object
is not the current version (False) or not (True).
startComp
<startComp>objectlist</startComp>
Specifies the component that will be loaded in the content frame initially.
startQueryString
<startQueryString></startQueryString>
Specifies additional query string parameters to pass to the component loaded in the content frame,
for example, folderPath.
subscriptions
<subscriptions>subscriptions_classic</subscriptions>
Specifies the component that displays the Subscriptions node.
taskmgractionname
<filter clientenv="not portal">
<taskmgractionname>taskmgrstreamline</taskmgractionname>
</filter>
Specifies the name of the taskmanager component.
taskmanagerid
<taskmanagerid>taskmanager</taskmanagerid>
ID of the task manager component accessible from inbox.
transformation
1 <transformation>
2<rendition value="transformationcontainerrendition"></rendition>
3<relation value="transformationcontainernewobject"></relation>
4<choose value="transformationcontainer"></choose>
</transformation>
1 Specifies the components for different transformations.

2 Specifies the component to execute for renditions in the value attribute.
3 Specifies the component to execute for relations in the value attribute.
4 Specifies the component to execute for a choice in the value attribute.
type
<type>dm_sysobject</type>
Default object type for which to search.
ucfrequired
1 <ucfrequired>
2<events>
3<event name="onInit" enabled="false"></event>
...
</events>
4<pages>
5<page name="start" enabled="false"></page>
<page name="invokeucf" enabled="true"></page>
...
</pages>
</ucfrequired>
1 If this element is present, then the component requires UCF to be installed. Contains zero or more
<events> and/or <pages> elements.
2 Contains one or more <event> elements that correspond to events in the component class, for
example, onInit. If the <ucfrequired> element is present and UCF is disabled for events, one or
more pages must have UCF enabled.
3 The component class method must be the value of the <event> name attribute, and the enabled
attribute must be set to false to bypass UCF for the event.
4 Contains one or more <page> elements that correspond to JSP pages in the component definition,
for example, start.
5 The page element in the component definition must be the value of the <page> name attribute, and
the enabled attribute must be set to false to bypass UCF for the page.
updatereplicasource
<updatereplicasource>true</updatereplicasource>
Set to true to add a rendition to both the source and replica document. Set to false to add the rendition
to the selected document only (either a source or replica).
useronly
<useronly>false</useronly>
Boolean: Whether to display users only (true) or not (false) in a recently used or modified list.
useroptions
1 <useroptions>
2<filteroption>
3<label>
4<nlsid>MSG_ALL_QUEUE_TASKS</nlsid>
</label>
</filteroption>
...
</useroptions>
1 Container for filter options to display.

2 Container for a filter option.
3 Filter option name to display.
views
1 <views>
2<view applyto="root">
3<queryfiltersets>
4<queryfilterset>
5<queryfilter>
6<displayname>
<nlsid>TAXONOMY</nslid>
</displayname>
7<containertypes>dm_taxonomy</containertypes>
8<includetypes>dm_taxonomy</includetypes>
9<excludetypes>dm_document</excludetypes>
10<attributefilters>
11<attributefilter>
12<and>true</and>
13<attribute>a_status</attribute>
14<predicate>eq</predicate>
15<value dqlformatted="false" casesensitive="true">online</value>
</attributefilter>
...
</attributefilters>
</queryfilter>
</queryfilterset>
</queryfiltersets>
</view>
...
</views>
1 Root element for an element structure that defines the following views:
• root
Displays a hierarchical list of root containers of the selectable objects, for example, cabinets or
folders
• flatlist
Displays all the selectable objects that meet the criteria. By default, myobject and recently used
object locators display results in a flatlist.
• container
Displays a hierarchical list of objects within the selected root container. By default, subscriptions
locators display results in a container (hierarchical) list.
Contains <view> elements.
2 Defines a configuration for a specific view that is specified by the applyto attribute. Each
view element configures root (cabinet view), container, and flatlist views. The applyto
attribute must specify one or more of the views in a comma-separated list, for example,
applyto=’root,container,flatlist’.
3 Element that contains <queryfilterset> elements that display drop-down lists if there is more than
one filter (<queryfilterset>) defined.
4 Element that contains a set of queries contained in <queryfilter> elements that filter the selection list;
for example, folders only. Defines one dropdown item. Each view can contain up to three filter sets.
5 Defines one DQL query: select <includetypes> from <containertypes> not <excludetypes> where
<attribute> <predicate> <value> <and> <attribute> <predicate> <value>...
6 Specifies the name to be displayed for the queryfilter. Can contain a <nlsid> element or text string.
7 Comma-separated list of navigable object types, such as dm_cabinet, dm_folder.
8 Optional element (cannot be more than one instance of this element) that specifies a
comma-separated list of object types to be included in the view. The container must be listed along
with the subtypes within the container; for example, dm_folder, dm_document.
9 Optional element (cannot be more than one instance of this element) that specifies the type of
object to be excluded from the view. if a container type is not one of the subtypes listed in this tag, the
actiondispatcher
containers are not listed. If a container type is listed, the objects of the container type will be hidden,
for example, dm_folder, dm_document hides all folders or documents.
10 Cannot be more than one instance of this element. Contains <attributefilter> sets that filter objects
based on their attributes.
11 Contains <and>, <attribute>, <predicate>, and <value> to compose an attribute filter.
12 Boolean: true to combine attribute filters, false to perform OR filter (single tag only)
13 (Required) String attribute name, for example, a_content_type (single tag only)
14 Contains a logical operation such as equals. Valid values: sw (starts with), ew (ends with), co
(contains), nc (not contains), eq (equal), ne (not equal), gt (greater than), ge (greater than or equal),
lt (less than), le (less than or equal).
15 Use the attribute dqlformatted=’false’ to quote and escape a value. Use the attribute
casesensitive=’true’ to require a case-sensitive comparison (must be true for integer attributes on
Content Server/DB2 environment).
windowparams
<windowparams>height=600,width=800</windowparams>
Configuration for the new window. The parameters specified for this element are used when opening
a new window using JavaScript.
workflowstatusactionname
<workflowstatusactionname>workflowstatusdrilldown</workflowstatusactionname>
Specifies the action that calls the workflow status page.
workqueuegroupvisible
<workqueuegroupvisible>false</workqueuegroupvisible>
Boolean: Whether to display (true) work queue groups or not (false).
Actions
actiondispatcher
Purpose
Executes the passed action and, if necessary, displays the login, page 798 component. Any additional
arguments are passed through to the action.
administration (Webtop)
Parameters
action (Required) The action that is called by the

dispatcher
Description
Since
5.x
Configuration File
wdk\config\actiondispatcher_component.xml
Scope
All.
Elements
None.
Administration
administration (Webtop)
Purpose
The administration component contains a list of links that launch installed Docbase administration
tools.
Parameters
nodeIds (Optional) IDs of the administration nodes.
Description
Since
5.x
adminpropertycontainer
Configuration File
webtop\config\administration_component.xml
Scope
All.
Elements
nodes
See nodes, page 740.
adminpropertycontainer
Purpose
Creates administration objects, such as IDfUser, IDfGroup, and IDfACL, based on the object ID or on
the type specified as the value of the element, <objecttype>.<object>. When necessary, this component
handles saving and reverting these objects.
Parameters
objectId (Required) ID of the object for which properties

are displayed
Description
Since
5.x
Configuration File
webcomponent\config\admin\container\adminpropertycontainer_component.xml
Parent Definition
propertysheetwizardcontainer:webcomponent/config/library/propertysheetwizardcontainer/
propertysheetwizardcontainer_component.xml
Scope
All.
Elements
numberedtabs
See numberedtabs, page 741.
nodemanagement
objecttype
<objecttype></objecttype>
Specifies the object type of the objects to create.
nodemanagement
Purpose
Handles nodes on the tree that have subnodes. It reproduces the nodes as a list in the content area.
Parameters
nodeIds (Optional) Target nodes in the tree
Description
Since
5.x
Configuration File
webcomponent\config\admin\nodemanagement\nodemanagement_component.xml
Scope
All.
Elements
None.
Application connectors
appintgcontroller
Purpose
This component launches an action or component and sets up a return listener to load a success
or failure page.
appintgcontroller
Parameters
disconnect (Optional) Boolean: Set to true to disconnect all

sessions before execution
dispatchargs (Optional) Argument list to be passed to the
dispatch item.
dispatchitem (Required) Item to be dispatched.
dispatchtype (Required) The action or component.
docbase (Optional) ID of the Docbase to connect to.
locale (Optional) ID of the Locale to use (default is
"en_US).
theme (Optional) ID of the Theme to use (default is
"windowsxpsilver).
view (Optional) ID of the view to use(Classic or
Streamline view).
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgcontroller\appintgcontroller_component.xml
Scope
All.
Elements
clientevent
See clientevent, page 727.
dispatchitems
1 <dispatchitems>
2<item>
3<name>appintgnewfromtemplate</name>
4<type>action</type>
5<successpage>opendocumentevent</successpage>
</item>
...
</dispatchitems>
1 Root element for a structure that defines the action or component to launch and the success page to
load on successful execution. Contains <item> elements.
2 Containing element for a structure that defines an action or component. Contains <name>, <type>,
and <successpage> elements.
3 Specifies the name (that is, the <action> or <component> element’s id attribute) of the action or
component.
appintgcontroller (Webtop)
4 Specifies whether this <item> is an action or component.

5 Specifies the success page to be displayed for the action or component.
locale
<locale>en_US</locale>
Specifies the ISO locale in which to display the text of the success or failure page.
menugroupid
1 <menugroupid>appintgmenubar</menugroupid>
1 ID attribute value of a <menugroup> element in the /webcomponent/config/library/

appintgmenubar/appintgmenubar_menugroup.xml file.
theme
<theme>windowsxpsilver</theme>
Webtop user interface theme that includes a set of colors, patterns and fonts.
appintgcontroller (Webtop)
Purpose
This component launches an action or component and sets up a return listener to load a success
or failure page.
Parameters
The parameters are inherited from appintgcontroller:webcomponent/config/library/appintgcontroller/
appintgcontroller_component.xml. See appintgcontroller, page 756.
Description
Since
5.x
Configuration File
webtop\config\appintgcontroller_component.xml
Parent Definition
appintgcontroller:webcomponent/config/library/appintgcontroller/appintgcontroller_component.xml
Scope
All.
appintgcontrollerlogin
Elements
clientevent
This element structure is inherited from appintgcontroller:webcomponent/config/library/
appintgcontroller/appintgcontroller_component.xml. See appintgcontroller, page 756.
dispatchitems
locale
menugroupid
<menugroupid>appintgmenubar</menugroupid>
theme
view
<view>classic</view>
Default Webtop view to display after user logs in.
appintgcontrollerlogin
Purpose
This component is called when a user attempts to open a repository file from a Windows application
but does not have an active repository session. It extends appintgcontroller, page 756 to fire the
loginsuccess event.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgcontroller\appintgcontroller_component.xml
appintgcontrollerlogin (Webtop)
Parent Definition
appintgcontroller:webcomponent/config/library/appintgcontroller/appintgcontroller_component.xml
Scope
All.
Elements
These element structures are inherited from appintgcontroller:webcomponent/config/library/
appintgcontrollerlogin (Webtop)
Purpose
This component is called when a user attempts to open a repository file from a Windows application
but does not have an active repository session. It extends appintgcontroller, page 756 to fire the
loginsuccess event.
Parameters
Description
Since
5.x
Configuration File
webtop\config\appintgcontroller_component.xml
Parent Definition
appintgcontroller:webtop/config/appintgcontroller_component.xml
Scope
All.
Elements
view
This element structure is inherited from appintgcontroller:webtop/config/appintgcontroller_
component.xml. See appintgcontroller (Webtop), page 758.
appintghelp
appintghelp
Purpose
This component is used to display help for Application Connector components.
Parameters
helpcontextid (Optional) Used by the WDK framework to

launch a URL to a help file for Application
Connectors
Description
Since
5.x
Configuration File
webcomponent\config\library\appintghelp\appintghelp_component.xml
Scope
All.
Elements
None.
appintginsertcabinetslocator
Purpose
Enables inserting repository files when starting from cabinets; called from within a Windows
application (Application Connectors).
Parameters
The parameters are inherited from appintgopenfromcabinetslocator:webcomponent/
config/library/appintgopenfrom/appintgopenfromcabinetslocator_component.xml. See
appintgopenfromcabinetslocator, page 770.
appintginsertcategorieslocator
Description
Since
6.0
Configuration File
webcomponent\config\library\appintginsert\appintginsertcabinetslocator_component.xml
Parent Definition
appintgopenfromcabinetslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromcabinetslocator_component.xml
Scope
All.
Elements
The element structures are inherited from appintgopenfromcabinetslocator:webcomponent/
appintginsertcategorieslocator
Purpose
Enables inserting repository files when starting from categories; called from within a Windows
Parameters
The parameters are inherited from appintgopenfromcategorieslocator:webcomponent/
config/library/appintgopenfrom/appintgopenfromcategorieslocator_component.xml. See
appintgopenfromcategorieslocator, page 771.
Description
Since
5.x
Configuration File
webcomponent\config\library\appintginsert\appintginsertcategorieslocator_component.xml
appintginsertlocatorcontainer
Parent Definition
appintgopenfromcategorieslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromcategorieslocator_component.xml
Scope
All.
Elements
appintginsertlocatorcontainer
Purpose
Enables inserting repository files from within Windows applications. It displays a specific component
for one of several different contexts.
Parameters
The parameters are inherited from appintgopenfromlocatorcontainer:webcomponent/
config/library/appintgopenfrom/appintgopenfromlocatorcontainer_component.xml. See
appintgopenfromlocatorcontainer, page 773.
Description
Since
5.x
Configuration File
webcomponent\config\library\appintginsert\appintginsertlocatorcontainer_component.xml
Parent Definition
appintgopenfromlocatorcontainer:webcomponent/config/library/appintgopenfrom/
appintgopenfromlocatorcontainer_component.xml
Scope
All.
appintginsertmyfileslocator
Elements
The element structures are inherited from appintgopenfromlocatorcontainer:webcomponent/
config/library/appintgopenfrom/appintgopenfromlocatorcontainer_component.xml. See
appintgopenfromlocatorcontainer, page 773.
appintginsertmyfileslocator
Purpose
Enables inserting repository files when starting in My Files; called from within a Windows
Parameters
The parameters are inherited from appintgopenfrommyfileslocator:webcomponent/
config/library/appintgopenfrom/appintgopenfrommyfileslocator_component.xml. See
appintgopenfrommyfileslocator, page 774.
Description
Since
5.x
Configuration File
webcomponent\config\library\appintginsert\appintginsertmyfileslocator_component.xml
Parent Definition
appintgopenfrommyfileslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfrommyfileslocator_component.xml
Scope
All.
Elements
All element structures are inherited from appintgopenfrommyfileslocator:webcomponent/
appintginsertobject
appintginsertobject
Purpose
Downloads object content to the client and sends the InsertObject event; called from within a
Windows application (Application Connectors).
Parameters
contentType (Optional) Content type for filetype filter.

folderId (Optional) Object ID of the folder in which the
locator component initially opens. This folder
is one in which the open document (that is,
the document into which the object is being
inserted) is located.
locatorcomponent (Optional) Name of the locator component to
call.
Description
Since
5.x
Configuration File
webcomponent\config\library\appintginsert\appintginsertobject_component.xml
Scope
All.
Elements
None.
appintginsertsubscriptionslocator
Purpose
Enables inserting repository files when starting in Subscriptions; called from within a Windows
Parameters
The parameters are inherited from appintgopenfromsubscriptionslocator:webcomponent/
config/library/appintgopenfrom/appintgopenfromsubscriptionslocator_component.xml. See
appintgopenfromsubscriptionslocator, page 776.
Description
Since
5.x
Configuration File
webcomponent\config\library\appintginsert\appintginsertsubscriptionslocator_component.xml
Parent Definition
appintgopenfromsubscriptionslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromsubscriptionslocator_component.xml
Scope
All.
Elements
All element structures are inherited from appintgopenfromsubscriptionslocator:webcomponent/
Purpose
Downloads a virtual link or DRL to the client and sends the InsertWebLink event; called from within
a Windows application (Application Connectors).
Parameters


Description
Since
5.x
Configuration File
webcomponent\config\library\appintginsert\appintginsertweblink_component.xml
Scope
All.
Elements
None.
Purpose
This component is used to create a new repository object from a template. This component is called
from within a Microsoft Windows application.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgnewfromtemplate\appintgnewfromtemplate_component.
xml
appintgopen
Scope
All.
Elements
None.
appintgopen
Purpose
This component is used to download content for view or edit a file when opened from within a
Windows application. It verifies a user’s permissions, presents a view/edit prompt if necessary, then
performs the view or checkout action as necessary.
Parameters
launchViewer (Optional) Boolean: When true, this component

will load the finish page when called from
Search, Versions, Locations, and Renditions.
objectId (Required) ID of object to view
openDocument (Optional) Set to true to open the document
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopen_component.xml
Scope
All.
Elements
ucfrequired
See ucfrequired, page 750.
appintgopenfrom
appintgopenfrom
Purpose
This is the base component used to display locator containers when a file is opened from within a
Windows application.
Parameters
contentType (Optional) Content type for filetype filter

folderId (Optional) ID of folder in which to begin
navigation
locatorcomponent (Optional) ID of the locator component
displayed
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfrom_component.xml
Scope
All.
Elements
None.
appintgopenfromcabinetslocator
appintgopenfromcabinetslocator
Purpose
Enables opening files when starting from Cabinets; called from Windows applications (Application
Connectors).
Parameters

flatlist (Optional) Boolean: Set to true to display a flat
list of all selectable objects.
objecttype (Optional) The type of object to open
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfromcabinetslocator_component.xml
Parent Definition
sysobjectlocator:webcomponent/config/library/locator/sysobjectlocator_component.xml
Scope
All.
Elements
allversionsvisible
This element structure is inherited from sysobjectlocator:webcomponent/config/library/locator/
sysobjectlocator_component.xml. See sysobjectlocator, page 969.
See breadcrumbiconwellmode, page 726.
columns
See columns (for data columns), page 727.
containerselectable
appintgopenfromcategorieslocator
See contenttypepanelvisible, page 730.
filter
filter
iconwell_icon
See iconwell_icon, page 737.
objecttype
views
Purpose
Enables opening files when starting from Categories; called from Windows applications (Application
Connectors).
Parameters

objecttype (Optional) The type of file selected
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfromcategorieslocator_component.
xml
Parent Definition
categorylocator:webcomponent/config/library/locator/categorylocator_component.xml
Scope
All.
Elements
allversionsvisible
This element structure is inherited from categorylocator:webcomponent/config/library/locator/
categorylocator_component.xml. See categorylocator, page 860.
columns
containerselectable
iconwell_icon
objecttype
views
See views, page 751.
appintgopenfromlocatorcontainer
appintgopenfromlocatorcontainer
Purpose
Enables opening files from the repository; called from Windows applications (Application
Connectors). It displays a specific component for one of several different contexts.
Parameters
component (Optional) ID of the component to be displayed

folderId (Optional) ID of the folder in which to begin
the search

objecttype (Optional) Type of object to select
repository (Optional) ID of the repository to be searched.

selectedobjectids (Optional) Comma- or semicolon-separated list
of objects to be selected when the component is
displayed
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfromlocatorcontainer_component.
xml
Parent Definition
locatorcontainer:webcomponent/config/library/locator/locatorcontainer_component.xml
Scope
All.
appintgopenfrommyfileslocator
Elements
containerselectable
See containerselectable, page 730.
flatlist
See flatlist, page 735.
multidocbasesupport
See multidocbasesupport, page 739.
appintgopenfrommyfileslocator
Purpose
This component is used to open a file from a Windows application when the user is navigating
the repository via my files.
Parameters

objecttype (Optional) The type of object to be selected
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfrommyfileslocator_component.xml
Parent Definition
myobjectlocator:webcomponent/config/library/locator/myobjectlocator_component.xml
Scope
All.
appintgopenfromrecentfileslocator
Elements
allversionsvisible
See allversionsvisible, page 725.
columns
containerselectable
flatlist
iconwell_icon
modifiedwithindays
See modifiedwithindays, page 739.
objecttype
1 <objecttype>dm_sysobject</objecttype>
1 Specifies the object type of the objects to select.
See privatecabinetvisible, page 745.
views
appintgopenfromrecentfileslocator
Purpose
This component is used to open files from within a Windows application when the user is navigating
the repository via recent files.
Parameters

appintgopenfromsubscriptionslocator

Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfromrecentfileslocator_component.
xml
Parent Definition
recentsysobjectlocator:webcomponent/config/library/locator/recentsysobjectlocator_component.xml
Scope
All.
Elements
columns
containerselectable
iconwell_icon
objecttype
1 Specifies the object type of the objects to be selected.
views
Purpose
This component is used to open a file from within a Windows application when the user is navigating
the repository via subscriptions.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\appintgopenfrom\appintgopenfromsubscriptionslocator_
component.xml
Parent Definition
subscriptionlocator:webcomponent/config/library/locator/subscriptionlocator_component.xml
Scope
All.
Elements
allversionsvisible
See allversionsvisible, page 725.
columns
containerselectable
flatlist
iconwell_icon
objecttype
1 Specifies the object type of the objects to be selected.
appintgsaveascabinets
See privatecabinet_visible, page 745.
views
appintgsaveascabinets
Purpose
This component is used by the save ascommand when the user is navigating the repository via
cabinets. This component is displayed in the container appintgsaveascontainer.
Parameters
The parameters are inherited from appintgopenfromcabinetslocator:webcomponent/
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgsaveas\appintgsaveascabinets_component.xml
Parent Definition
appintgopenfromcabinetslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromcabinetslocator_component.xml
Scope
All.
Elements
columns
appintgsaveascategories
See filenamefiltervisible, page 734.
iconwell_icon
appintgsaveascategories
Purpose
This component is used by the save ascommand when the user is navigating the repository via
categories. This component is displayed in the container appintgsaveascontainer.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgsaveas\appintgsaveascategories_component.xml
Parent Definition
appintgopenfromcategorieslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromcategorieslocator_component.xml
Scope
All.
Elements
1 <breadcrumbiconwellmode>true</breadcrumbiconwellmode>
1 See breadcrumbiconwellmode, page 726.
columns
appintgsaveascontainer
1 <contenttypepanelvisible>true</contenttypepanelvisible>
1 See contenttypepanelvisible, page 730.
iconwell_icon
views
appintgsaveascontainer
Purpose
This component is used to display components used to perform save as transactions in integrated
applications.
Parameters
component (Optional) The component to be displayed

doCheckout (Optional)
filenamewithpath (Required) Name and path of the file to be
checked in
folderId (Optional) ID of the folder in which to save the
object
objecttype (Optional) The type of object to be created
repository (Optional) ID of the repository in which to save
the object.
of objects to be selected when the component is
displayed
appintgsaveasmyfiles
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgsaveas\appintgsaveascontainer_component.xml
Parent Definition
appintgopenfromlocatorcontainer:webcomponent/config/library/appintgopenfrom/
appintgopenfromlocatorcontainer_component.xml
Scope
All.
Elements
containerselectable
1 <containerselectable>true</containerselectable>
1 See containerselectable, page 730.
flatlist
1 <flatlist>false</flatlist>
1 See flatlist, page 735.
multidocbasesupport
Purpose
This component is used to perform the save ascommand when the user is navigating the repository
via the myfiles file list.
Parameters
The parameters are inherited from appintgopenfrommyfileslocator:webcomponent/
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgsaveas\appintgsaveasmyfiles_component.xml
Parent Definition
appintgopenfrommyfileslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfrommyfileslocator_component.xml
Scope
All.
Elements
columns
iconwell_icon
appintgsaveasrecentfiles
appintgsaveasrecentfiles
Purpose
via a list of recently viewed or edited files.
Parameters
The parameters are inherited from appintgopenfromrecentfileslocator:webcomponent/
config/library/appintgopenfrom/appintgopenfromrecentfileslocator_component.xml. See
appintgopenfromrecentfileslocator, page 775.
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgsaveas\appintgsaveasrecentfiles_component.xml
Parent Definition
appintgopenfromrecentfileslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromrecentfileslocator_component.xml
Scope
All.
Elements
columns
iconwell_icon
appintgsaveassubscriptions
appintgsaveassubscriptions
Purpose
via a list of subscriptions.
Parameters
The parameters are inherited from appintgopenfromsubscriptionslocator:webcomponent/
Description
Since
5.x
Configuration File
webcomponent\config\library\appintgsaveas\appintgsaveassubscriptions_component.xml
Parent Definition
appintgopenfromsubscriptionslocator:webcomponent/config/library/appintgopenfrom/
appintgopenfromsubscriptionslocator_component.xml
Scope
All.
Elements
columns
iconwell_icon
appintgxdql
appintgxdql
Purpose
Returns the results (in XML) of a Documentum Query Language (DQL) query statement.
Parameters
query (Required) DQL query statement.
Description
Since
6.0
Configuration File
webcomponent\config\library\appintgxdql\appintgxdql_component.xml
Scope
All.
Elements
None.
clientapplicationinstaller
Purpose
Lists the Application Connector installers that can be accessed from the current application server.
Supports command line arguments for the installers and does not require authentication.
Parameters
application (Optional) Specifies a comma-delimited list of

applications to display
clientapplicationinstaller
Description
Since
5.x
Configuration File
webcomponent\config\library\clientapplicationinstaller\clientapplicationinstaller_component.xml
Scope
All.
Elements
applicationinstallers
The application installer is constructed by concatenating current application server URL, client
application installer, and installer parameters in the following element structure.
1 <applicationinstallers>
2<applicationinstaller>
3<application>appconnectors</application>
4<label>
5<nlsid>MSG_APPCONNECTORS_LABEL</nlsid>
</label>
6<description>
<nlsid>MSG_APPCONNECTORS_DESCRIPTION</nlsid>
</description>
7<installer>/webcomponent/install/appconnector/
Documentum-AppConnectors-Client-5.3.exe</installer>
8<cmdargs>/v"webtopUrl=$APP_SERVER"</cmdargs>
</applicationinstaller>
</applicationinstallers>
1 Contains one or more <applicationinstaller> elements that define the installers.

2 Defines an application installer. Contains <application>, <label>, <description>, <installer>, and
<cmdargs>.
4 Contains a string label or NLS ID key to be displayed.
5 NLS ID key to be displayed.
6 Contains a string description or NLS ID key to be displayed that describes the application.
7 Path to the installer program relative to the Web application root, for example,
/webcomponent/install/appconnector/installer.exe.
8 Supports the following system variables as command line arguments: $PROTOCOL, $PORT,
APPLICATION, $APP_SERVER, $ROOT_PATH, $APP_SERVER dynamically passes the application
server URL to the installer, for example, /vwebtopUrl=$APP_SERVERhttp://myserver/webtop.
ucfrequired
about
Application management
about
Purpose
Displays information about the version of the application.
Parameters
enableTools (Optional) True to enable the display of DQL

editor and API tester tools
Description
Since
5.x
Configuration File
webcomponent\config\library\about\about_component.xml
Scope
All.
Elements
None.
about (Webtop)
Purpose
Extends the WDK about component and adds information about the Webtop application.
Parameters
The parameters are inherited from about:webcomponent/config/library/about/about_component.xml.
See about, page 787.
api
Description
Since
5.x
Configuration File
webtop\config\about_component.xml
Parent Definition
about:webcomponent/config/library/about/about_component.xml
Scope
All.
Elements
None.
api
Purpose
Tests and executes Content Server API calls.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\utilities\api_component.xml
Scope
All.
Elements
None.
authenticate
authenticate
Purpose
Enables a user to log in to an additional content repository. Verifies the user’s name and password.
Parameters
docbase (Required) Name of the content repository

docbroker (Optional) Name of the connection broker
docbrokerPort (Optional) Port number of the connection broker
suppressLoginEvent (Optional) Boolean: Prevents or enables the
login event. Set to true to suppress the client
events loginCancel and loginSuccess used by
Application Connectors.
Description
Since
5.x
Configuration File
wdk\config\authenticate_component.xml
Parent Definition
login:wdk/config/login_component.xml
Scope
All.
Elements
failoverenabled
This element structure is inherited from login:wdk/config/login_component.xml. See login, page 798.
serveroptionenabled
1 <serveroptionenabled>false</serveroptionenabled>
See serveroptionenabled, page 747.
showoptions
See showoptions, page 749.
authenticate (Webtop)
authenticate (Webtop)
Purpose
Extends the WDK login component and adds a required parameter for the repository to log into. This
component is displayed when the user requests to log in to an additional repository after the initial
login. Called from browsertree (Webtop), page 1299.
Parameters
The parameters are inherited from authenticate:wdk/config/authenticate_component.xml. See
authenticate, page 789.
Description
Since
5.x
Configuration File
webtop\config\authenticate_component.xml
Parent Definition
authenticate:wdk/config/authenticate_component.xml
Scope
All.
Elements
None.
authenticateexternalsource
Purpose
Enables a user to provide credentials to an external source.
Parameters
externalSource (Required) Path to the external source
backdetector
Description
Since
5.x
Configuration File
wdk\config\authenticateexternalsource_component.xml
Scope
All.
Elements
None.
backdetector
Purpose
Detects the browser’s back button event during nested navigation to another component and prevents
re-execution of operation unintentionally for operations that execute on component initialization,
for example, UCF content transfer.
Parameters
ticket (Required) Ticket is generated by a call

to BackDetector.setComponentNested() in
ContentTransferServiceContainer. The caller can
override BackDetector.setComponentNested()
to generate a ticket internally and perform the
redirection accordingly.
Description
Since
5.x
Configuration File
wdk\config\backdetector_component.xml
Scope
All.
dql
Usage
To handle the Back button event from a nested component in your custom component, add a call to
BackDetector in your event handler that handles the return from nesting:
if (BackDetector.clickBackButton(map))
{
//abort the operation
}
Elements
None.
dql
Purpose
The dql component edits and executes queries to a repository. This component is nested to from the
Webtop about component.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\utilities\dql_component.xml
Scope
All.
Elements
None.
dqleditor
dqleditor
Purpose
The dqleditor component edits and executes queries to a repository.
Parameters
query (Optional) DQL query
Description
Since
5.x
Configuration File
webcomponent\config\library\dqleditor\dqleditor_component.xml
Scope
All.
Elements
None.
drl
Purpose
Opens a DRL object (document resource locator) and prompts the user to view or edit it. You can
also send an inbox item as a DRL. If the DRL is to an inbox item, the DRL will open the user’s inbox,
and the task manager will open the inbox item. The login component is invoked unless the user
has a session or a default account is configured for anonymous access. The appropriate repository
is derived from the object ID. If the DRL for a deleted version of an object is created after the
Automatic DRL Resolution setting is enabled, and the object version is deleted, the DRL to the deleted
object version will resolve to the current version of the object. For more information, see the Web
Development Kit Development Guide. The appropriate object version is derived from the chronicleId
parameter. The user is prompted to view or edit the current version of the object.
drl
Parameters
format (Optional) If the user can edit and view the

passed object, a user interface is presented to
allow the user to choose the action. If no format
is specified for the action, the object’s native
format is used.
objectId (Required) ID of the object identified by the
DRL.
versionLabel (Optional) Any labelled version can be passed,
such as CURRENT. If no value is set for
versionLabel and the object’s version is not
current, an open current checkbox is shown.
enabled.
Description
Since
5.x
Configuration File
wdk\config\drl_component.xml
Scope
All.
Usage
The DRL component displays View and Edit buttons. The event handlers for these buttons call the
drlview (type dm_sysobject), page 433 and drledit (type dm_sysobject), page 429 actions, respectively.
Requires the Nautilus File Manager on Mozilla clients.
DRLs have the following syntax: http:// host_name:port/ app_name/component/drl?objectId=xxx. For
example, the following DRL specifies an object and the format:
http://localhost:8080/webtop/component/drl?
objectId=090056ce8002d6ef&format=msw8
Note: The format argument should not be supplied if the object has no content.
You can enable Automatic DRL Resolution of a deleted document by setting the
<resolve-deleted-DRL> parameter to true in WDK/app.xml. For instructions, see the Web Development
Kit Development Guide.
The syntax of the DRL after enabling the <resolve-deleted-DRL> parameter in WDK/app.xml is
as follows:
drlauthenticate
http:// host_name:port/app_name/component/drl/objectId/xxx/chronicleId/xxx
For example, the following DRL specifies an objectId and the chronicleId:
http://localhost:8080/webtop/component/drl/objectId/090056ce8002d6ef/chronicleId/
0906c81c80006d26
Although 5.3 encryption is supported, this component uses triple DES encryption. So, you should
use the password encryption tool, which uses triple DES encryption. The encrypted password is
specified in this component’s configuration file.
The DRL component supports the following anonymous access functionality:
• Virtual links and DRLs have independent sets of stored credentials for anonymous access.
• If the anonymous user account user does not have permission to perform the requested DRL
operation (view or edit), a login dialog is presented.
• Anonymous credentials are used only for content DRLs, not DRLs to folders or inbox.
• User is logged out of the application after the anonymous DRL operation has been performed.
(Configurable as the <logoffoncomplete> element in the drl component definition.)
You can construct a DRL in your component class by importing the DRLComponent class and calling
constructDRL(String strObjectId, String strVersionLabel, String strFormat, Component component).
The version label and format parameters are optional. The following example initializes a bookmark
control in component JSP page:
BookmarkLink bookmark = (BookmarkLink)getControl(
"bookmark", BookmarkLink.class);
bookmark.setHREF(DRLComponent.constructDRL(
strObjectId, null, null, this));
Elements
defaultaccounts
See defaultaccounts, page 731.
new-pw
Triple DES encrypted password for the anonymous user. Can be encrypted with the Trusted
Authenticator Tool. Refer to Web Development Kit Development Guide for instructions.
password
Password for the anonymous user. If new-pw is specified, then this element is ignored.
drlauthenticate
Purpose
This component opens an object, prompting the user to select view or edit mode. Note that the
opened object may differ if a version label is passed (for example, CURRENT). The login component
is invoked if necessary.
index
Parameters
The parameters are inherited from drl:wdk/config/drl_component.xml. See drl, page 793.
Description
Since
5.x
Configuration File
wdk\config\drlauthenticate_component.xml
Parent Definition
drl:wdk/config/drl_component.xml
Scope
All.
Usage
Elements
defaultaccounts
This element structure is inherited from drl:wdk/config/drl_component.xml. See drl, page 793.
new-pw
password
index
Purpose
Not used.
Parameters
None.
kerberos_sso_login
Description
Since
5.x
Configuration File
webcomponent\config\navigation\index\index.xml
Scope
All.
Elements
None.
kerberos_sso_login
Purpose
Enables a user to log in to a content respository using the Kerberos single sign-on (SSO) feature. The
component dispatcher invokes this component to authenticate the user against a particular repository.
Parameters
The parameters are inherited from app/wdk/config/loginex_component.xml. See login, page 798.
Description
Since
6.6
Configuration File
wdk\config\kerberos_sso_login_component.xml
Scope
All.
Elements
None.
kerberos_sso_login (Webtop)
kerberos_sso_login (Webtop)
Purpose
Enables a user to log in to a content repository using the Kerberos single sign-on (SSO) feature. The
component dispatcher invokes this component to authenticate the user against a particular repository.
Parameters
The parameters are inherited from kerberos_sso_login: wdk/config/ kerberos_sso_login_component.
xml. See kerberos_sso_login, page 797.
Description
Since
6.6
Configuration file
webtop\config\kerberos_sso_login_component.xml
Scope
All.
Elements
None.
login
Purpose
Performs an explicit login to a single repository or a trusted login to a J2EE application server. The
trusted login will log in to the repositories accessible to the application.
Parameters
docbase (Optional) Specifies the repository to log into

startComponent (Optional) If an entry component name is
specified, the login component will forward to
that component after successful login.
login
startPage (Optional) This parameter sets the component

page that will be displayed on forward.
startUrl (Optional) URL to forward to. If a startURL is
specified, the login component will forward to
that URL after successful login. This value takes
precedence over startComponent. The URL
must be relative to the root context, not relative
to the directory location of the current JSP page.
Description
Since
6.5
Configuration File
wdk\config\loginex_component.xml
Scope
All.
Usage
For more information on the types of application login, see the section on application login and
authentication inWeb Development Kit Development Guide.
In addition to the showoptions element in the login component definition, the Web application’s
definition file (app.xml) contains an <authentication> element whose child elements <domain> and
<docbase> specify the default domain and repository, respectively. You can configure these values
in the app.xml file in your custom directory (/custom/app.xml).
These values for default domain and repository are used to initialize the login dialog. The user can
change the domain and repository in the login screen, and the user’s selections will be stored in
a cookie for the next login.
Several types of login connections are provided in the WDK authentication framework:
• Login dialog
• Skip authentication (for example, to the login or password component)
• J2EE principal user login
Each Documentum component requires a Documentum connection unless skip authentication is
configured (for example, for the login component). If a Documentum connection is not available when
the component is called, the component dispatcher calls the authentication service to obtain a session.
If the authentication service does not obtain a session, the dispatcher calls the login component to
create one. The login component then forwards to the original request after authentication.
Elements
failoverenabled
login (Webtop)
serveroptionenabled
showoptions
login (Webtop)
Purpose
Extends the WDK login component and displays a login page, adding a Webtop application
identification string in the login screen. The login component is called by the component dispatcher if
a component is called without a valid session.
Parameters
The parameters are inherited from login: wdk/config/loginex_component.xml. See login, page 798.
Description
Since
6.5
Configuration File
webtop\config\loginex_component.xml
Parent Definition
login:wdk/config/loginex_component.xml
Scope
All.
Elements
centered
1 <centered>true</centered>
1 Whether to display the login dialog centered in the frame (true) or left-aligned (false).
failoverenabled
serveroptionenabled
logoff
showoptions
logoff
Purpose
The logoff component is one of the components specified in the file Environment.properties (located
in /WEB-INF/classes/com/documentum/web/formext) as a non_docbase_component, which means
that it does not require a Documentum session.
Parameters
afterLogoff (Optional) Accepts as a value the following

JavaScript functions on the Window object:
closeWindow | forward
forwardUrl (Optional) URL to which to forward the browser
Description
Since
5.x
Configuration File
wdk\config\logoff_component.xml
Scope
All.
Elements
failoverenabled
1 <failoverenabled>true</failoverenabled>
1 See failoverenabled, page 734.
logoff (Webtop)
logoff (Webtop)
Purpose
Extends the WDK logoff component and displays a Login Again link. The logoff component
invalidates the user’s session.
Parameters
The parameters are inherited from logoff:wdk/config/logoff_component.xml. See logoff, page 801.
Description
Since
5.x
Configuration File
webtop\config\logoff_component.xml
Parent Definition
logoff:wdk/config/logoff_component.xml
Scope
All.
Elements
failoverenabled
This element structure is inherited from logoff:wdk/config/logoff_component.xml. See logoff,
page 801.
main
Purpose
The main component is an abstract application entry point. The default Web page in the application
virtual root should redirect to this component. Override the main component to handle all timeouts
and history releases, which by default are redirected to this component.
Parameters
None.
main (version 5.3) (Webtop)
Description
Since
5.x
Configuration File
wdk\config\main_component.xml
Scope
All.
Usage
The default URL for Webtop is http:// server:port/webtop. This URL redirects to the main component.
To redirect your default application page to the main component, use the following JavaScript
function in your default.html or index.html page:
<script>
function redirect()
{
//Get the virtual dir via the window.location.pathname
var strPath = window.location.pathname;
var nIndex1 = strPath.indexOf("/");
var nIndex2 = strPath.indexOf("/", nIndex1 + 1);
var strVirtualDir = strPath.substring(
nIndex1 + 1, nIndex2);
window.location.replace("/"
+ strVirtualDir + "/component/main");
}
</script>
Elements
failoverenabled
Purpose
Extends the WDK main component and establishes the streamline or classic view for Webtop. This
component is the entry point for the Webtop application. It is called from the index.html and
default.html pages (identical content).
Parameters
callerClientId (Optional) Internally generated ID for the client

browser.
entryPage (Optional) Specifies the entry view. Supported
values: classic and streamline. If entryPage is
not specified, the user’s preference is used. If
no preference, the default view specified in the
<entrypage> element is used.
entrySection (Optional) Determines the browsertree node
(classic view) or tab (streamline view) to start
in. If entrySection is not specified, the cabinets
view is displayed by default for both classic
and streamline views. The section values are
described below: Classic viewThe section
is the Docbase tree node. Valid values are
homecabinet_classic, cabinets, inboxclassic,
subscriptions_classic, myfiles_classic, and
administration. These values correspond
to node IDs in the browsertree component
definition file. Streamline viewThe section
determines the start tab. Valid values are
homecabinet_drilldown, streamlineview,
inboxstreamline, myfiles_streamline, and
subscriptions_streamline. These values are
specified as tab component IDs in the tab bar
component definition file.
objectId (Optional) Determines the object of the
bookmark (a folder or an object). If the ID
is a folder or cabinet, the folder or cabinet is
displayed. If the ID is an object, the contents of
the containing folder are displayed. The objectId
argument cannot be used with an entrySection
argument.
Description
Since
6.0
Configuration File
webtop\config\main_component.xml
Parent Definition
main:wdk/config/main_component.xml
main (Webtop)
Scope
version 5.3
As of 6.5, changed from “5.3.0” to “5.3”.
Usage
For backward compatibility with version 5.3.
Elements
entrypage
See entrypage, page 734.
failoverenabled
This element structure is inherited from login:wdk/config/main_component.xml. See main, page 802.
main (Webtop)
Purpose
Extends the WDK main component and establishes the streamline or classic view for Webtop. This
component is the entry point for the Webtop application. It is called from the index.html and
default.html pages (identical content).
Parameters
callerClientId (Optional) Internally generated ID for the client

browser.
entryPage (Optional) Specifies the entry view. Supported
values: classic and streamline. If entryPage is
not specified, the user’s preference is used. If
no preference, the default view specified in the
<entrypage> element is used.
entrySection (Optional) Determines the browsertree node
(classic view) or tab (streamline view) to start
in. If entrySection is not specified, the cabinets
view is displayed by default for both classic
and streamline views. The section values are
described below: Classic viewThe section
is the Docbase tree node. Valid values are
homecabinet_classic, cabinets, inboxclassic,
subscriptions_classic, myfiles_classic, and
administration. These values correspond
to node IDs in the browsertree component
newwindow
definition file. Streamline viewThe section

determines the start tab. Valid values are
homecabinet_drilldown, streamlineview,
inboxstreamline, myfiles_streamline, and
subscriptions_streamline. These values are
specified as tab component IDs in the tab bar
component definition file
objectId (Optional) Determines the object of the
bookmark (a folder or an object). If the ID
is a folder or cabinet, the folder or cabinet is
displayed. If the ID is an object, the contents of
the containing folder are displayed. The objectId
argument cannot be used with an entrySection
argument.
Description
Since
5.x
Configuration File
webtop\config\mainex_component.xml
Parent Definition
main:wdk/config/main_component.xml
Scope
All.
Elements
entrypage
See entrypage, page 734.
failoverenabled
This element structure is inherited from login:wdk/config/main_component.xml. See main, page 802.
newwindow
Purpose
Opens a second WDK application browser window.
newwindow (Webtop)
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\newwindow\newwindow_component.xml
Scope
All.
Elements
windowparams
See windowparams, page 753.
newwindow (Webtop)
Purpose
Launched by the newwindow action to open a second WDK application browser window.
Description
Since
5.x
Configuration File
webtop\config\newwindow_component.xml
Parent Definition
newwindow:webcomponent/config/library/newwindow/newwindow_component.xml
Scope
All.
Elements
windowparams
portal_login
portal_login
Purpose
Enables logging in to a portal.
Parameters
docbase (Optional) For internal use only.

startComponent (Optional) For internal use only.
startPage (Optional) For internal use only.
startUrl (Optional) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\library\portallogin\portallogin_component.xml
Scope
All.
Elements
showoptions
removecredential
Purpose
Removes the user credentials (login name, password, repository, domain) for the specified repository
by deleting the cookie. Saved credentials are turned on by default in /wdk/app.xml. Saved credentials
are used for HTTP session timeout, DRLs, switching repositories, and accessing the application
with a new browser session.
removecredential
Parameters
docbase (Required) Name of the repository for which the

user credentials will be removed.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\credential\removecredential_component.xml
Scope
All.
Usage
Username and password are encrypted and saved as browser cookies. This means that credentials
saved with one browser, such as IE, will not be available if the user switches to another browser,
such as Netscape.
To turn off the save credentials feature, add the following section to your /custom/app.xml file, within
the <application> element:
<save_credential>
<enabled>false</enabled>
<encryption_key>encryption key here</encryption_key>
<disabled_docbases>
<docbase></docbase>
</disabled_docbases>
</save_credential>
To enable saved credentials in certain repositories, you must enable the credentials and then name the
repositories that will not support saved credentials. In the following example from a /custom/app.xml
file, all repositories except admin support saved credentials:
<save_credential>
<enabled>true</enabled>
<encrypted_key>encryption key here</encrypted_key>
<disabled_docbases>
<docbase>admin</docbase>
</disabled_docbases>
</save_credential>
Note: The encryption key must be identical across all WDK application instances on the application
server. If the key is changed by an administrator, users will be prompted for login. You can use the
trusted authenticator tool (com.documentum.web.formext.session.TrustedAuthenticatorTool). See
Web Development Kit Development Guide for details on this tool.
Elements
None.
savecredential
savecredential
Purpose
Saves the user credentials (login name, password, repository, domain) as a cookie. This feature is
turned on by default in /wdk/app.xml.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\credential\savecredential_component.xml
Scope
All.
Usage
Although 5.3 encryption is supported, this component uses triple DES encryption. This component
automatically performs encryption for each user who saves credentials. You should use the password
encryption tool, which uses triple DES encryption.
Elements
None.
sso_login
Purpose
Enables a user to log in to a content repository using the single sign-on (SSO) feature.
Parameters
The parameters are inherited from login:wdk/config/login_component.xml. See login, page 798.
ucfinvoker
Description
Since
5.x
Configuration File
wdk\config\sso_login_component.xml
Parent Definition
login:wdk/config/login_component.xml
Scope
All.
Usage
The component dispatcher must invoke this component to authenticate the user against a particular
repository.
Elements
failoverenabled
serveroptionenabled
showoptions
ucfinvoker
Purpose
Enables invoking a component using the unified client facilities feature.
Parameters
targetComponent (Optional) ID of the component to invoke.

targetComponentPage (Optional) Name of the component page to
render as named in the component definition
virtuallinkconnect
Description
Since
5.x
Configuration File
wdk\config\ucfinvoker_component.xml
Scope
All.
Elements
ucfrequired
virtuallinkconnect
Purpose
Supports virtual links (URL to a single document) by providing authentication and a list of root paths
that are used to resolve the path in the URL.
Parameters
redirectUrl (Required) URL to be displayed when the object

cannot be located in the repository.
virtualLinkPath (Required) URL to the feature that provides
anonymous access, which allows the use of
predefined login credentials (per repository)
instead of requiring a user to log in using their
credentials.
Description
Since
5.x
Configuration File
wdk\config\virtuallinkconnect_component.xml
virtuallinkconnect
Scope
All.
Usage
This component is part of the virtual link service. It has no user interface. The component is called
by the browser after the virtual link servlet determines that the URL may contain a virtual link. A
virtual link has this syntax:
http://host[/docbase:path]/document
This component reads the configuration information from its component definition file and provides
authentication details to the virtual link handler based on the user’s current session. If the user
does not have a session, the virtual link service presents a login page or is automatically logged
in using anonymous login.
To support virtual links for anonymous login to multiple repositories, extend the virtuallinkconnect
component’s configuration file in /wdk/virtuallinkconnect_component.xml and add the following
elements with the repository-specific credentials for the anonymous user and default account
credentials for all other repositories.
<defaultaccounts>
<filter docbase='repository_1">

<account>
<username>anonymous_username</username>
<password>encrypted_password</password>
<domain>domain_if_UNIX</domain>
</account>
</filter>

<defaultaccount>
<username>anonymous_user2</username>
<password>encrypted_password2</password>
<domain></domain>
</defaultaccount>
</defaultaccounts>
See Web Development Kit Development Guide for more details about the virtual link service.
Elements
defaultaccounts
1 <defaultaccounts></defaultaccounts>
1 See defaultaccounts, page 731.
failoverenabled
new-pw
Triple DES encrypted password for the anonymous user. Can be encrypted with the Trusted
Authenticator Tool. Refer to Web Development Kit Development Guide for instructions.
password
Password for the anonymous user. If new-pw is specified, then this element is ignored.
attributes (type dm_document)
rootpaths
1 <rootpaths>
2<rootpath>/</rootpath>
</rootpaths>
1 Contains one or more <rootpath> elements, which can optionally be enclosed within a <filter>
element.
2 An absolute path to a repository.
Attributes
attributes (type dm_document)
Purpose
Displays the primary attributes of the selected document and includes a link to expand the attributes
list or to display all attributes. The attributes component is designed to run within the container
component properties, page 828.
Parameters
The parameters are inherited from attributes:webcomponent/config/library/attributes/attributes_dm_
sysobject_component.xml. See attributes (type dm_sysobject), page 815.
Description
Since
5.x
Configuration File
webcomponent\config\library\attributes\attributes_dm_document_component.xml
Parent Definition
attributes:webcomponent/config/library/attributes/attributes_dm_sysobject_component.xml
Scope
type dm_document
Usage
You can configure the layout of the attributes display using the docbaseattributelist control (see
). See the control description for details. Each category of attributes that is defined in the list
layout Configuration file can be shown as tabs or inline in the properties UI. Set the value of
showpagesastabs in the Configuration file to true to display category tabs.
The Show All attributes functionality is provided by an alternative layout to the base attributes
layout. The layout is switched when the user clicks a link. The link is displayed if the enableshowall
parameter is set to true.
How Attributes are Saved
The OK button in the properties component has an event handler in the parent class DialogContainer,
which calls canCommitChanges() and onCommitChanges(). The latter method is implemented in
the Properties class to save the object.
Using filters
You can configure the attributes definition to display a different UI based on the user role. The
following example allows administrators to see all attributes and allows the attributes to be editable if
they are editable in the repository:
<filter role='administrator'>
</filter>
Elements
enableShowAll
<filter role="administrator">
</filter>
See enableShowAll, page 734.
failoverenabled
This element structure is inherited from attributes:webcomponent/config/library/attributes/
attributes_dm_sysobject_component.xml. See attributes (type dm_sysobject), page 815.
readOnly
See readOnly, page 745.
showpagesastabs
See showpagesastabs, page 749.
Purpose
The attributes component displays the primary attributes of the selected object and includes a link to
expand the attributes list or to display all attributes. The attributes component is designed to run
within the container component properties, page 828.
Parameters
enableShowAll (Optional) Boolean: Displays the Show all

attributes link (true) or hides it (false). The
default depends on the user’s role: true for
administrators, false for all non-administrator
users.
objectId (Required) The ID of the object for which
attributes are to be shown.
readOnly (Optional) Boolean: Displays the attributes as
read-only (true) or in edit mode (false). This
value does not override the state of the attributes
in the repository. The value of this parameter
does override individual readonly attributes
that are set to false on the docbaseattribute
controls in the UI.
Description
Since
5.x
Configuration File
webcomponent\config\library\attributes\attributes_dm_sysobject_component.xml
Scope
type dm_sysobject
Usage
Using filters
docbaserepeatingattribute
</filter>
Elements
enableShowAll
failoverenabled
readOnly
showpagesastabs
docbaserepeatingattribute
Purpose
Component called by the docbaseattributevalue, page 44 control to display an editing page for
a repeating attribute.
Parameters
control (Required) ID of the docbaseattributevalue

control.
Description
Since
5.x
Configuration File
wdk\config\docbaserepeatingattribute_component.xml
Scope
All.
Usage
When a docbaseattributevalue, page 44 control is used to display an attribute, an Edit link
is displayed if the attribute is repeating, that is, if the attribute allows multiple values. The
docbaserepeatingattribute component is called by an onClick event handler internal to the
docbasesingleattribute
docbaseattributevalue control when the user clicks the Edit link. The event handler nests to the
docbaserepeatingattribute component, which means that the docbaserepeatingattribute component is
nested within the component that contains the docbaseattributevalue control.
By default, the docbaserepeatingattribute component opens the repeatingAttributes.jsp page, which
displays an editing screen that allows the user to construct a list of values with an Add/Remove
button. For repeating attributes without value assistance, a text box is displayed to for entry of values.
For repeating attributes with closed-end value assistance, the user adds values by selecting values
from a list. For repeating attributes with open-ended value assistance, there is both a text box and a list
of values to select from. The JSP page can be customized by modifying the component definition file.
Note: The docbaserepeatingattribute component can only be called from the docbaseattributevalue
control.
Elements
failoverenabled
docbasesingleattribute
Purpose
Component called by the docbaseattributevalue, page 44 control to display an editing page for a
single-value attribute.
Parameters

control.
Description
Since
5.x
Configuration File
wdk\config\docbasesingleattribute_component.xml
Scope
All.
history
Usage
When the docbaseattributevalue, page 44 control is used to display an attribute, an Edit
link is displayed if the attribute is single-valued with open-ended value assistance. The
docbasesingleattribute component is called by an onClick event handler internal to the
docbaseattributevalue control when the user clicks the Edit link. The event handler nests to the
docbasesingleattribute component, which means that the docbasesingleattribute component is nested
within the component that contains the docbaseattributevalue control.
By default, the docbasesingleattribute component opens the singleAttribute.jsp page, which displays
an editing screen that allows the user to either select a value from a list or enter a value in a text box.
The JSP page can be customized by modifying the component definition file.
Note: The docbasesingleattribute component can only be called from the docbaseattributevalue
control.
Elements
None.
history
Purpose
Extends the component objectgrid, page 1056 and displays an object history (audit trail) including
events, users, event source, and time stamp.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\history\history_component.xml
Parent Definition
objectgrid:/webcomponent/config/navigation/objectgrid/objectgrid_component.xml
Scope
All.
modifyversionlabels
Elements
columns
failoverenabled
header
See header, page 736.
lookuptable
1 <lookuptable>
2<lookup key="dm_archive" nlsid="MSG_ARCHIVE"></lookup>
...
</lookuptable>
1 Contains <lookup> elements that supply user-friendly textual descriptions for system and user
defined events. NLS mappings are provided in the <nlsbundle> file.
2 Has two configurable attributes: key specifies the attribute name, and nlsid specifies the NLS key
to match to a localized string for the attribute.
nondocbasecolumns
See nondocbasecolumns, page 741.
queryconditionstring
1 <queryconditionstring>audited_obj_id={r_object_id} or (id_5={r_object_
id} and event_name in ('dm_addpackage', 'dm_completedworkitem', 'dm_
removepackage', 'dm_signoff'))</queryconditionstring>
1 Specify the query for events to be shown. The DQL query format will be of the form "select... from
FROM dm_audittrail WHERE queryconditionstring. By default, the following histories will be
displayed: dm_addpackage, dm_completedworkitem, dm_removepackage, and dm_signoff.
modifyversionlabels
Purpose
This component provides the UI and functionality to allow users to modify version labels on objects.
Parameters
nodeId (Optional) ID of the node if it is part of a virtual

document
objectId (Required) ID of the object being modified
multiobjectsattributes (type dm_sysobject)
Description
Since
5.x
Configuration File
webcomponent\config\library\modifyversionlabels\modifyversionlabels_component.xml
Scope
All.
Elements
None.
multiobjectsattributes (type dm_sysobject)
Purpose
Displays the attribute values that are common between more than one selected object.
Parameters
objectId (Required) IDs of the selected objects.
Description
Since
5.x
Configuration File
webcomponent\config\library\attributes\multiobjectsattributes_component.xml
Scope
type dm_sysobject
Usage
This component is not valid for Application Connectors.
multiobjectsdocbaserepeatingattribute
Elements
failoverenabled
readOnly
showpagesastabs
multiobjectsdocbaserepeatingattribute
Purpose
Enables updating repeating-value attributes that are common between more than one selected object.
Parameters
The parameters are inherited from docbaserepeatingattribute:wdk/config/docbaserepeatingattribute_
component.xml. See docbaserepeatingattribute, page 817.
Description
Since
5.x
Configuration File
wdk\config\multiobjectsdocbaserepeatingattribute_component.xml
Parent Definition
docbaserepeatingattribute:wdk/config/docbaserepeatingattribute_component.xml
Scope
All.
Elements
failoverenabled
multiobjectsdocbasesingleattribute
multiobjectsdocbasesingleattribute
Purpose
Displays single-value attributes that are common between more than one selected object.
Parameters
The parameters are inherited from docbasesingleattribute:wdk/config/docbasesingleattribute_
component.xml. See docbasesingleattribute, page 818.
Description
Since
5.x
Configuration File
wdk\config\multiobjectsdocbasesingleattribute_component.xml
Parent Definition
docbasesingleattribute:wdk/config/docbasesingleattribute_component.xml
Scope
All.
Elements
failoverenabled
multiobjectsproperties
Purpose
Displays the properties common between more than one selected object.
multiobjectsselectsingleattributevalue
Parameters
component (Required) Supplied by the LaunchComponent

action execution class.) The name of the
component to contain.
componentArgs (Required) Supplied by the LaunchComponent
action execution class.) List of arguments and
values to pass to each contained component.
Description
Since
5.x
Configuration File
webcomponent\config\library\properties\multiobjectsproperties_component.xml
Parent Definition
propertysheetcontainer:wdk/config/propertysheetcontainer_component.xml
Scope
All.
Elements
commitorder
See commitorder, page 730.
failoverenabled
multiobjectsservice
1 <multiobjectsservice>com.documentum.web.formext.control.docbase.
MultiObjectsService</multiobjectsservice>
1 Specifies the multiobject service.
multiobjectsselectsingleattributevalue
Purpose
Provides UI and behavior for selecting a value for a single (not repeating) attribute that is common
between more than one selected object.
multiobjectsselectuserattributevalue
Parameters

control.
locator (Optional) Specifies a selector component to
select a single attribute value
selectedAttribute (Optional) Attribute to be passed to the locator
Description
Since
5.x
Configuration File
webcomponent\config\library\selectsingleattributevalue\multiobjectsselectsingleattributevalue_
component.xml
Parent Definition
selectsingleattributevalue:webcomponent/config/library/selectsingleattributevalue/
selectsingleattributevalue_component.xml
Scope
All.
Elements
locator
See locator, page 738.
selectedattribute
See selectedattribute, page 747.
multiobjectsselectuserattributevalue
Purpose
Provides user interface and behavior for selecting a user to supply a value for an attribute that is
common between more than one object.
multiobjectsselectuserorgroupattributevalue
Parameters
The parameters are inherited from multiobjectsselectsingleattributevalue:webcomponent/config/
library/selectsingleattributevalue/multiobjectsselectsingleattributevalue_component.xml. See
multiobjectsselectsingleattributevalue, page 824.
Description
Since
5.x
Configuration File
webcomponent\config\library\selectsingleattributevalue\multiobjectsselectuserattributevalue_
component.xml
Parent Definition
multiobjectsselectsingleattributevalue:webcomponent/config/library/selectsingleattributevalue/
multiobjectsselectsingleattributevalue_component.xml
Scope
All.
Elements
locator
selectedattribute
multiobjectsselectuserorgroupattributevalue
Purpose
Provides user interface and behavior for selecting a user or group to supply a value for an attribute
that is common between more than one object.
Since
6.5
multiobjectsselectuserorgroupidattributevalue
multiobjectsselectuserorgroupidattributevalue
Purpose
Provides user interface and behavior for selecting a user or group to supply a value for the ID
attribute that is common between more than one object.
Since
6.5
multiobjectsversionlabels
Purpose
Displays the version label attribute values of more than one selected object.
Parameters
Description
Since
5.x
Configuration File
wdk\config\multiobjectsversionlabels_component.xml
Parent Definition
versionlabels:wdk/config/versionlabels_component.xml
Scope
All.
Elements
failoverenabled
properties
properties
Purpose
Extends the container propertysheetcontainer, page 830 and displays property sheets that show
general information about the selected object, such as name, type, format and owner. The properties
component contains attributes, history, and permissions. The properties component for dm_category
objects extends this properties component.
Parameters
component (Required) The ID of the first contained

component to be shown
objectId (Required) The ID of the object for which
properties are to be shown
Description
Since
5.x
Configuration File
webcomponent\config\library\properties\properties_component.xml
Parent Definition
Scope
All.
Usage
The following example adds the locations component to the list of properties for an object. Copy
the properties component configuration file from /webcomponent/config/library/properties to your
custom config directory. Add the locations component to the list of contained components:
<contains>
<component>attributes</component>
<component>permissions</component>
<component>history</component>
<component>locations</component>
</contains>
Elements
commitorder
failoverenabled
See setrepositoryfromobjectid, page 747.
Purpose
This component is used to display attributes components.
Parameters
component (Required) ID of the component displayed

entryId (Required) Internal key to the query results.
queryId (Required) Internally used to identify the current
search context
Description
Since
5.x
Configuration File
webcomponent\config\library\properties\dm_externalresult_properties_component.xml
Parent Definition
Scope
Elements
failoverenabled
This element structure is inherited from propertysheetcontainer:wdk/config/propertysheetcontainer_
component.xml. See propertysheetcontainer, page 830.
propertysheetcontainer
propertysheetcontainer
Purpose
Extends wizardcontainer, page 1062 and contains attributes, history, and permissions.
Parameters
component (Required) The contained component. Set the

requiresVisit attribute to true to require the
component to be visited before an OK button
is displayed.
Description
Since
5.x
Configuration File
wdk\config\propertysheetcontainer_component.xml
Parent Definition
wizardcontainer:wdk/config/wizardcontainer_component.xml
Scope
All.
Usage
The property sheet wizard container extends the propertysheetcontainer container and adds support
for wizard-type navigation through the pages of a component (Previous and Next buttons) and
through components in the container (tabs).
Some examples of containers that extend the propertysheetwizardcontainer include
adminpropertysheetcontainer, newcabinet, newdoc, and newfolder containers.
Set requiresVisit attribute to true to declare that a particular component must be visited before the
container can commit changes. In the following example, the attributes component must be viewed
before the user can commit changes:
<contains>
<component>newFolder</component>
<component requiresVisit='true'>attributes</component>
</contains>
You can also declare the visit requirement in the individual component definition. Add the following
tag to a component definition:
propertysheetwizardcontainer
<requiresVisitBeforeCommit>true</requiresVisitBeforeCommit>
Elements
failoverenabled
propertysheetwizardcontainer
Purpose
Extends the container propertysheetcontainer, page 830 and contains propertysheetcontainer, page
830 and wizardcontainer, page 1062. This container has Previous and Next buttons that move
through pages in the currently selected components and another set of buttons that move through the
contained components. The contained components are presented as horizontal tabs.
Parameters

is displayed.
Description
Since
5.x
Configuration File
webcomponent\config\library\propertysheetwizardcontainer\propertysheetwizardcontainer_
component.xml
Parent Definition
Scope
All.
Usage
If your component extends propertysheetwizardcontainer and you wish to show the contained
components as vertical tabs, call setcomponentpage("vertical_tabs") in your component class.
rename
Elements
failoverenabled
numberedtabs
rename
Purpose
Provides a simple UI for users to rename objects by entering a new name in a single text-edit field on
a form. Webtop does not provide a menu to access this component.
Parameters
objectId (Required) ID of the object to rename
Description
Since
5.x
Configuration File
webcomponent\config\library\rename\rename_component.xml
Scope
All.
Elements
None.
selectmultipleuserattributevalue
Purpose
Provides UI and behavior for selecting multiple users for which to supply a common attribute value.
selectmultipleuserattributevalue
Parameters
Since 6.0 SP1.

control.
objectId (Optional) Object ID of the object on which the
component was invoked to select users. If the
object is governed by a room, then a RoomUser
locator component is invoked; otherwise, a
UserLocator component is invoked.
selectedobjectids (Optional) Object IDs of the user objects that are
selected on the right side of the page.
Description
Since
5.x
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectmultipleuserattributevalue_
component.xml
Parent Definition
selectrepeatingattributevalue:webcomponent/config/library/selectsingleattributevalue/
selectrepeatingattributevalue_component.xml
Scope
All.
Elements
locator
roomlocator
<roomlocator></roomlocator>
Room locator component to be launched for selecting the attribute value.
Since 6.0 SP1.
selectedattribute
selectmultipleuseridattributevalue
selectmultipleuseridattributevalue
Purpose
Enables selection of multiple users to supply repeating-value attribute values.
Parameters
The parameters are inherited from selectrepeatingattributevalue:webcomponent/config/
library/selectsingleattributevalue/selectrepeatingattributevalue_component.xml. See
selectrepeatingattributevalue, page 835.
Description
Since
6.0
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectmultipleuserattributevalue_
component.xml
Parent Definition
selectmultipleuserattributevalue:webcomponent/config/library/selectsingleattributevalue/
selectmultipleuserattributevalue_component.xml
Scope
All.
Elements
locator
selectedattribute
<selectedattribute>r_object_id</selectedattribute>
selectmultipleuserorgroupattributevalue
Purpose
Provides UI and behavior for selecting multiple users or groups for which to supply a common
attribute value.
selectrepeatingattributevalue
Parameters
Since 6.0 SP1.
The parameters are inherited from selectmultipleuserattributevalue:webcomponent/config/
library/selectrepeatingattributevalue/selectmultipleuserattributevalue_component.xml. See
selectmultipleuserattributevalue, page 832.
Description
Since
6.0
Configuration File
webcomponent\config\library\selectrepeatingattributevalue\selectmultipleuserorgroupattributevalue_
component.xml
Parent Definition
Since 6.0 SP1.
selectmultipleuserattributevalue:webcomponent/config/library/selectrepeatingattributevalue/
selectmultipleuserattributevalue_component.xml
Scope
All.
Elements
locator
roomlocator
Since 6.0 SP1.
selectedattribute
selectrepeatingattributevalue
Purpose
Component called by the docbaseattributevalue, page 44 control to display an editing page for
a repeating-value attribute.
selectsingleattributevalue
Parameters

control.
select a repeating-value attribute value.
selectedAttribute (Optional) Attribute to be passed to the locator.
Description
Since
5.x
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectrepeatingattributevalue_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
This element structure is inherited from docbaserepeatingattribute:wdk/config/
docbaserepeatingattribute_component.xml. See docbaserepeatingattribute, page 817.
locator
selectedattribute
<selectedattribute>object_name</selectedattribute>
selectsingleattributevalue
Purpose
Provides UI and behavior for selecting a single (not repeating) attribute value.
selectuserattributevalue
Parameters

control.
Description
Since
5.x
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectsingleattributevalue_component.
xml
Parent Definition
docbasesingleattribute:wdk/config/docbasesingleattribute_component.xml
Scope
All.
Usage
Extend this component to provide a locator for an open-ended attribute value of a single-value
attribute. Register your component as the value of the <editcomponent> element for the desired
attribute in a docbaseobjectconfiguration file. For more information on docbaseobject configuration,
refer to docbaseobject, page 49.
Elements
failoverenabled
Purpose
Attribute value selector that provides a user interface and behavior for selecting a user.
Parameters
Since 6.0 SP1.

control.
objectId (Optional) Object ID of the object on which the
component was invoked to select users. If the
object is governed by a room, then a RoomUser
locator component is invoked; otherwise, a
UserLocator component is invoked.
selectedobjectids (Optional) Object IDs of the user objects that are
selected on the right side of the page.
Description
Since
5.x
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectuserattributevalue_component.xml
Parent Definition
selectsingleattributevalue:webcomponent/config/library/selectsingleattributevalue/
selectsingleattributevalue_component.xml
Scope
All.
Elements
locator
roomlocator
Since 6.0 SP1.
selectedattribute
selectuseridattributevalue
selectuseridattributevalue
Purpose
Enables selection of a user to supply single-value attribute values.
Parameters
The parameters are inherited from selectsingleattributevalue:webcomponent/config/library/
selectsingleattributevalue/selectsingleattributevalue_component.xml. See selectsingleattributevalue,
page 836.
Description
Since
6.0
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectuserattributevalue_component.xml
Parent Definition
selectuserattributevalue:webcomponent/config/library/selectsingleattributevalue/
selectuserattributevalue_component.xml
Scope
All.
Elements
locator
selectedattribute
selectuserorgroupattributevalue
Purpose
Attribute value selector that provides a user interface and behavior for selecting a user or group.
versionlabels
Parameters
The parameters are inherited from selectsingleattributevalue:webcomponent/config/library/
selectsingleattributevalue/selectsingleattributevalue_component.xml. See selectsingleattributevalue,
page 836.
Description
Since
6.0
Configuration File
webcomponent\config\library\selectsingleattributevalue\selectuseror groupattributevalue_
component.xml
Parent Definition
selectuserattributevalue:webcomponent/config/library/selectsingleattributevalue/
selectuserattributevalue_component.xml
Scope
All.
Elements
locator
roomlocator
Since 6.0 SP1.
selectedattribute
versionlabels
Purpose
Allows editing of version labels
Parameters
Description
Since
5.x
Configuration File
wdk\config\versionlabels_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
This element structure is inherited from docbaserepeatingattribute:wdk/config/
docbaserepeatingattribute_component.xml. See docbaserepeatingattribute, page 817.
Purpose
Extends objectgrid, page 1056, displays and allows users to edit version information on an object.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\versions\versions_component.xml
Parent Definition
versions (type dm_sysobject) (Webtop)
Scope
type dm_sysobject
Elements
columns
See columns (for streamline view), page 727.
dragdrop
See dragdrop, page 733.
header
nondocbasecolumns
versions (type dm_sysobject) (Webtop)
Purpose
Extends the WDK versions component component and displays the versions for the selected object.
Parameters
The parameters are inherited from versions:webcomponent/config/library/versions/versions_
component.xml. See versions (type dm_sysobject), page 841.
Description
Since
5.x
Configuration File
webtop\config\versions_component.xml
Parent Definition
versions:webcomponent/config/library/versions/versions_component.xml
Scope
type dm_sysobject
versions (type wdk5_testtype_1)
Elements
columns
columns_list
See columns_list, page 728.
dragdrop
This element structure is inherited from versions:webcomponent/config/library/versions/versions_
nondocbasecolumns
Purpose
Extendsobjectgrid, page 1056, displays, and edits version information on an object.
Parameters
The parameters are inherited from versions:/webcomponent/config/library/versions/versions_
Description
Since
5.x
Configuration File
Parent Definition
versions:/webcomponent/config/library/versions/versions_component.xml
Scope
Elements
columns
dragdrop
nondocbasecolumns
Purpose
Extends objectgrid, page 1056 and displays and edits version information on an object.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
columns
dragdrop
nondocbasecolumns
Purpose
Extends objectgrid, page 1056 and displays and edits version information on an object.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
columns
dragdrop
nondocbasecolumns
allfolderlocator
Cabinets and folders
allfolderlocator
Purpose
Locates dm_folder objects in a repository and displays them in a hierarchical view. Users can
navigate from the root cabinets to locate an object.
Parameters
The parameters are inherited from sysobjectlocator:webcomponent/config/library/locator/
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\folderlocators_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
objecttype
<objecttype>dm_folder</objecttype>
Specifies the object type of the objects to locate.

containerselectable
attributes (type dm_folder)
1 <privatecabinetvisible>false</privatecabinetvisible>
1 See privatecabinetvisible, page 745.
allversionsvisible
1 <allversionsvisible>false</allversionsvisible>
1 See allversionsvisible, page 725.
views
columns
attributes (type dm_folder)
Purpose
Displays the primary attributes of the selected folder and includes a link to expand the attributes list
or to display all attributes.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\attributes\attributes_dm_folder_component.xml
cabinetslocator
Parent Definition
Scope
type dm_folder
Usage
Using filters
</filter>
Elements
showpagesastabs
failoverenabled
enableShowAll
readOnly
cabinetslocator
Purpose
The cabinetslocator component is a basic sysobject locator that displays folders and the content type.
cabinetslocator
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\cabinetslocator_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
filter
filter
columns
objecttype
containerselectable
allversionsvisible
views
Purpose
The delete component deletes dm_folders and other dm_sysobjects, deletes inbox notifications
(dm_notification and dm_queued), and deletes folders (queries the user whether all objects should be
deleted from a folder selected for deletion). This component must be used within the deletecontainer
component.
Parameters
folderId (Optional) ID of the parent folder of the file

or folder that is to be deleted. Applies only to
dm_folder and dm_sysobject types.
objectId (Required) ID of the object to be deleted. Applies
to all types.
Description
Since
5.x
Configuration File
webcomponent\config\library\delete\deletefolder_component.xml
Scope
type dm_folder
Elements
None.
newcabinet
newcabinet
Purpose
Creates a new cabinet. This component must run within the component newcabinetcontainer,
page 852.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\create\newcabinet_component.xml
Scope
All.
Elements
base_type
See base_type, page 726.
default_type
See default_type, page 731.
cabinet_filter
1 <cabinet_filter>
<selection>
<entries>
<entry></entry>
</entries>
</selection>
</preset_item>
</cabinet_filter>
1 Specifies an object type preset filter for cabinets.

2 Standard preset_item structure that specifies an object type filter. See preset_item, page 743.
preset_item
See preset_item, page 743.
newcabinetcontainer
newcabinetcontainer
Purpose
Extends propertysheetwizardcontainer, page 831 and contains attributes, newcabinet, and
permissions. The newcabinet component requires a visit.
Parameters
component (Required) Supplied by the action execution

class). The name of the component to contain.
Description
Since
5.x
Configuration File
webcomponent\config\library\create\newcabinetcontainer_component.xml
Parent Definition
Scope
All.
Usage
The container parameters are added by the LaunchComponent action execution class in order to
support actions on multiple objects. Do not call the container by URL.
Elements
newcomponentname
See newcomponentname, page 740.
numberedtabs
newfolder
newfolder
Purpose
Creates a new folder. This component must run within the component newfoldercontainer, page 853.
Parameters

contain the new folder.
Description
Since
5.x
Configuration File
webcomponent\config\library\create\newfolder_component.xml
Scope
All.
Elements
base_type
default_type
folder_filter
See folder_filter, page 735.
newfoldercontainer
Purpose
Extends propertysheetwizardcontainer, page 831 and contains attributes, newfolder, and permissions.
The newfolder container requires a visit.
attributes (type dm_category)
Parameters
component (Required): The name of the component to

contain. Supplied by the action execution class.
Description
Since
5.x
Configuration File
webcomponent\config\library\create\newfoldercontainer_component.xml
Parent Definition
Scope
All.
Elements
numberedtabs
newcomponentname
Categories
Purpose
The attributes component displays the primary attributes of the selected object and includes a link
to expand the attributes list or to display all attributes. The attributes component is scoped for
dm_sysobject, dm_document, and dm_folder, with three different JSP pages to display attributes.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\properties\dm_category_properties_component.xml
Parent Definition
attributes:webcomponent/config/library/attributes/attributes_dm_folder_component.xml
Scope
type dm_category
Usage
You can configure the layout of the attributes display using the docbaseattributelist control. See
the control description for details. Each category of attributes that is defined in the list layout
Configuration file can be shown as tabs or inline in the properties UI. Set the value of showpagesastabs
in the Configuration file to true to display category tabs.
Using filters
</filter>
Elements
readOnly
showpagesastabs
categoriesnotenabled
categoriesnotenabled
Purpose
Displays a message that CIS is not enabled for the repository.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\category\categorylist_component.xml
Scope
All.
Elements
None.
categoryattributes
Purpose
Sets the attributes of a work queue category.
Parameters

for setting the breadcrumbs
objectId (Required) ID of the work queue category object
categoryclassic (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\categoryattributes_component.xml
Scope
All.
Elements
None.
categoryclassic (Webtop)
Purpose
Extends the component WDK categorylist component and displays categories in a classic view. Only
categories with a status of "online" are shown.
Parameters
folderId (Optional) ID of the category folder to navigate.

example, /Documentation/Library/subfolder
nodeIds (Optional) List of dot-separated object IDs used
to build an absolute location to display the
categories.
Description
Since
6.0
Configuration File
webtop\config\categoryclassic_component.xml
categorydrilldown
Parent Definition
categorylist:webcomponent/config/navigation/category/categorylist_component.xml
Scope
All.
Elements
showfilters
See showfilters, page 748.
failoverenabled
This element structure is inherited from categorylist:webcomponent/config/navigation/category/
categorylist_component.xml. See categorylist, page 859.
objectfilters
See objectfilters, page 741.
columns
preset_item
categorydrilldown
Purpose
Allows the user to view CIS categories in a streamline style presentation. The repository must have
CI types installed and configured to use this component.
Parameters
folderId (Optional) ID of the category folder to navigate

Description
Since
5.x
categorylist
Configuration File
webcomponent\config\navigation\category\categorydrilldown_component.xml
Scope
All.
Elements
failoverenabled
showfilters
objectfilters
columns
categorylist
Purpose
Allows the user to browse CIS categories in a classic (tree and content frame) presentation. The
repository must have CI types installed and configured to use this component.
Parameters
folderId (Optional) ID of the category folder to navigate

Description
Since
5.x
Configuration File
webcomponent\config\navigation\category\categorylist_component.xml
categorylocator
Scope
All.
Elements
failoverenabled
showfilters
objectfilters
columns
preset_item
categorylocator
Purpose
Enables users to select categories.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\categorylocator_component.xml
Parent Definition
Scope
All.
categorylocator
Elements
objecttype
<objecttype>dm_category</objecttype>

containerselectable
1 <containerselectable>false</containerselectable>
allversionsvisible
views
columns
1 <contenttypepanelvisible>false</contenttypepanelvisible>
<filenamefiltervisible>true</filenamefiltervisible>
categorylocatorcontainer
categorylocatorcontainer
Purpose
Enables users to select categories.
Parameters
The parameters are inherited from locatorcontainer:webcomponent/config/library/locator/
locatorcontainer_component.xml. See locatorcontainer, page 960.
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
categorystreamline (Webtop)
Purpose
Displays categories in a streamline view. Only categories with a status of "online" are shown.
categorysubscriptionlocator
Parameters
folderId (Optional) ID of the category folder to navigate.

folderPath (Optional) Path to the category folder to
navigate.
categories.
Description
Since
5.x
Configuration File
webtop\config\categorystreamline_component.xml
Parent Definition
categorydrilldown:webcomponent/config/navigation/category/categorydrilldown_component.xml
Scope
All.
Elements
failoverenabled
This element structure is inherited from categorydrilldown:webcomponent/config/navigation/
category/categorydrilldown_component.xml. See categorydrilldown, page 858.
showfilters
objectfilters
columns
Purpose
Enables user to select from a list of category subscriptions.
Parameters
The parameters are inherited from subscriptionlocator:webcomponent/config/library/locator/
subscriptionlocator_component.xml. See subscriptionlocator, page 1252.
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
objecttype

containerselectable
1 <privatecabinetvisible>true</privatecabinetvisible>
allversionsvisible
views
columns
properties (type dm_category)
flatlist
properties (type dm_category)
Purpose
Extends the container propertysheetcontainer, page 830 and displays property sheets that show
general information about the selected object, such as name, type, format and owner. The properties
component contains attributes, history, and permissions. The properties component for dm_category
objects extends this properties component.
Parameters
The parameters are inherited from properties:webcomponent/config/library/properties/properties_
component.xml. See properties, page 828.
Description
Since
5.x
Configuration File
webcomponent\config\library\properties\dm_category_properties_component.xml
Parent Definition
properties:webcomponent/config/library/properties/properties_component.xml
Scope
type dm_category
recentcategorylocator
Elements
failoverenabled
This element structure is inherited from properties:webcomponent/config/library/properties/
properties_component.xml. See properties, page 828.
commitorder
recentcategorylocator
Purpose
Locator for all recently selected categories.
Parameters
The parameters are inherited from recentsysobjectlocator:webcomponent/config/library/locator/
recentsysobjectlocator_component.xml. See recentsysobjectlocator, page 968.
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
objecttype
submitforcategorization

iconwell_icon
columns
containerselectable
views
submitforcategorization
Purpose
Submits the selected object to a task queue for categorization by the category manager.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\submitforcategorization\submitforcategorization_component.xml
Scope
All.
Elements
None.
taxonomylocator
taxonomylocator
Purpose
This component is used to search for taxonomies.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\taxonomylocator_component.xml
Parent Definition
Scope
All.
Elements
objecttype
<objecttype>dm_taxonomy</objecttype>

containerselectable
allversionsvisible
clipboard
views
columns
Clipboard operations
clipboard
Purpose
The clipboard component displays the contents of the current user’s clipboard and supports link
and copy operations.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\clipboard\clipboard_component.xml
Scope
All.
link
Usage
To disable clipboard functions for specific object types, use the addtoclipboard action (see
addtoclipboard (type dm_sysobject), page 374).
Elements
dragdrop
link
Purpose
This component is used to create a link to an object in the local repository or to create a reference
object.
Parameters
folderId (Required) ID of the target folder for the link

objectId (Required) Object for which to create a link
Description
Since
5.x
Configuration File
webcomponent\config\library\link\link_component.xml
Scope
All.
Elements
None.
linkcontainer
linkcontainer
Purpose
This component displays the link component, which is used to create a link to a local object or to
create a reference object.
Parameters

localItems (Optional) This is a comma-separated list of IDs
of linked items from the local repository. Local
items are linked differently than items linked
from external sources. IDs of items not listed
in the localItems parameter are assumed to be
from an external repository.
Description
Since
5.x
Configuration File
webcomponent\config\library\link\linkcontainer_component.xml
Parent Definition
combocontainer:wdk/config/combocontainer_component.xml
Scope
All.
Elements
failoverenabled
This element structure is inherited from combocontainer:wdk/config/combocontainer_component.
xml. See combocontainer, page 1046.
propagatepreviouspagevalues
addroommembercontainer
Collaboration
addroommembercontainer
Purpose
Container object for adding a user as a member of a room. Requires Documentum Collaborative
Services.
Parameters
arrangeselect (Optional) Boolean: Set to true to allow selection

of users in a sequential order.
in a flat list, set to false to display a drop-down
list.
multiple selection.
objectId (Required) ID of the dmc_room object.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\addroommembercontainer_component.xml
Parent Definition
userorgrouplocatorcontainer:webcomponent/config/library/locator/userorgrouplocator_component.
xml
Scope
All.
Elements
failoverenabled
addroomusercontainer
addroomusercontainer
Purpose
Enables adding users as members to rooms.
Parameters

of users and groups in a sequential order.
objectId (Required) Object ID of the dm_user object to
add.
roomId (Required) Object ID of the room to which to
add the user as a member.
Description
Since
6.0
Configuration File
webcomponent\config\admin\unlisteduser\unlisteduser_component.xml
Parent Definition
userproperties:webcomponent/config/admin/user/userproperties_component.xml
Scope
All.
Elements
failoverenabled
objecttype
<objecttype>dm_user</objecttype>
Specifies the object type of the objects to display.
addroomuserorgrouplocator
addroomuserorgrouplocator
Purpose
A locator that finds users or groups in a docbase. Used in operations that add groups or users to a
room.
Parameters
objectId This is a copy of the existing parameter

description.(Required) ID of the dm_user or
dm_group object to add.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\addroommembercontainer_component.xml
Parent Definition
userorgrouplocator:webcomponent/config/library/locator/userorgrouplocator_component.xml
Scope
All.
Elements
columns
containerselectable
failoverenabled
This element structure is inherited from userorgrouplocator:webcomponent/config/library/locator/
userorgrouplocator_component.xml. See userorgrouplocator, page 1341.
flatlist
attributes (type dmc_calendar_event)
iconwell_icon
includeunlisted
See includeunlisted, page 737.
objecttype

preset_item
privategroupvisible
See privategroupvisible, page 745.
views
See workqueuegroupvisible, page 753.
attributes (type dmc_calendar_event)
Purpose
Displays the attributes of a dmc_calendar_event object.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\attributes_dmc_calendar_event_component.xml
Parent Definition
Scope
attributes (type dmc_datatable_row)
Elements
enableShowAll
failoverenabled
readOnly
showpagesastabs
attributes (type dmc_datatable_row)
Purpose
Displays the attributes of a dmc_datatable_row object.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\attributes_dmc_datatable_row_component.xml
Parent Definition
Scope
Elements
enableShowAll
changeroommemberrole
failoverenabled
readOnly
showpagesastabs
changeroommemberrole
Purpose
Specifies whether a given user is a contributor or an owner to a room. Requires Documentum
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\changeroomrolecontainer_component.xml
Scope
All.
Elements
None.
changeroommemberrolecontainer
Purpose
Container component for changing the roles assigned to room members. Requires Documentum
Parameters

of members in a sequential order.
multiple selections.
roomId (Required) Object ID of the dmc_room object.
Description
Since
5.x
Configuration File
Parent Definition
roomuserorgrouplocatorcontainer:webcomponent/config/library/rooms/
roomuserorgrouplocatorcontainer_component.xml
Scope
All.
Elements
multidocbasesupport
changeroommemberrolelocator
Purpose
Displays a list of room members to select for changing their roles. Requires Documentum
Parameters
The parameters are inherited from roomuserorgrouplocator:webcomponent/config/library/rooms/
roomuserorgrouplocatorcontainer_component.xml. See roomuserorgrouplocator, page 933.
Description
Since
5.x
Configuration File
Parent Definition
roomuserorgrouplocator:webcomponent/config/library/rooms/roomuserorgrouplocatorcontainer_
component.xml
Scope
All.
Elements
includeunlisted
changeroommemberrolestep
Purpose
This is a container component that displays the second step in the process to pick the role which
the selected users will have.
choosecontributors
Parameters
The parameters are inherited from dialogcontainer:wdk/config/dialogcontainer_component.xml. See
dialogcontainer, page 1048.
Description
Since
5.x
Configuration File
Parent Definition
dialogcontainer:wdk/config/dialogcontainer_component.xml
Scope
All.
Elements
failoverenabled
This element structure is inherited from dialogcontainer:wdk/config/dialogcontainer_component.xml.
See dialogcontainer, page 1048.
choosecontributors
Purpose
Sets the list of contributors for a room. Requires Documentum Collaborative Services.
Parameters
The parameters are inherited from userorgrouplocator:webcomponent/config/library/locator/
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\newroom_component.xml
chooseowners
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
objecttype

preset_item
privategroupvisible
views
chooseowners
Purpose
Sets the owners for a room. Requires Documentum Collaborative Services.
chooseowners
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
includeunlisted
objecttype

preset_item
privategroupvisible
datatableentrypage (type dmc_datatable_row)
views
Purpose
Displays a datatable entry, which corresponds to a row. Requires a Documentum Collaborative
Services license.
Since
6.5

(Webtop)
Purpose
Displays a datatable entry, which corresponds to a row. Requires a Documentum Collaborative
Services license.
Since
6.5
datatablerepeatingattreditcomponent
Purpose
Enables editing repeating attribute values in a datatable.
dceuserattributes
Since
6.5
dceuserattributes
Purpose
Displays the properties for creating new users and for viewing existing users’ attributes.
Parameters
objectId (Required) Object ID of the dm_user object for

which to display attributes.
objectname (Required) ID of the folder or cabinet in which
the new object is to be created. If this is a new
user then this parameter’s value is newobject.
Description
Since
6.0
Configuration File
Scope
All.
Usage
This component also contains specific attributes for users created by users that belong to the
dce_user_manager role. Provides the ability to create users with inline passwords, mark users as
unlisted, and add restricted folders to a user.
Elements
None.
dceuserproperties
dceuserproperties
Purpose
Displays a room user’s properties (container for the dceuserattributes, page 884 component).
Parameters
component (Required) Name of the contained component.

objectId (Required) Object ID of the dm_user object for
which to display attributes.
objectname (Required) ID of the folder or cabinet in which
the new object is to be created. If this is a new
user then this parameter’s value is newobject.
Description
Since
6.0
Configuration File
Parent Definition
adminpropertycontainer:webcomponent/config/admin/container/adminpropertycontainer_
component.xml
Scope
All.
Elements
objecttype
delete (type dmc_calendar_event)
Purpose
Deletes a dmc_calendar_event object.
delete (type dmc_calendar)
Parameters
objectId (Required) ID of the dmc_calendar_event object.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\deletecalendarevent_component.xml
Scope
Elements
None.
delete (type dmc_calendar)
Purpose
Deletes a dmc_calendar object.
Parameters
The parameters are inherited from delete:webcomponent/config/library/delete/deletefolder_
component.xml. See delete (type dm_folder), page 850.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\deletecalendar_component.xml
Parent Definition
delete:webcomponent/config/library/delete/deletefolder_component.xml
Scope
type dmc_calendar
Elements
None.
Purpose
Deletes a comment from a thread.
Parameters
objectId (Required) ID of the dmc_comment object to

delete.
Description
Since
5.x
Configuration File
webcomponent\config\library\discussion\deletecomment_component.xml
Scope
type dmc_comment
Elements
None.
Purpose
Deletes a dmc_datatable object. Requires Documentum Collaborative Services.
delete (type dmc_notepage)
Since
6.5
delete (type dmc_notepage)
Purpose
This component is used to delete dmc_notepage objects. Requires Documentum Collaborative
Services.
Parameters
The parameters are inherited from delete:webcomponent/config/library/delete/deletedocument_
component.xml. See delete (type dm_sysobject), page 993.
Description
Since
5.x
Configuration File
webcomponent\config\library\notepage\deletenotepage_component.xml
Parent Definition
delete:webcomponent/config/library/delete/deletedocument_component.xml
Scope
type dmc_notepage
Elements
None.
delete (type dmc_room)
Purpose
Deletes room objects. Requires Documentum Collaborative Services.
doclist (type dmc_calendar)
Parameters
folderId (Optional) Not required for deleting dmc_room

objects.
objectId (Required) Object ID of the dmc_room object to
delete.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\deleteroom_component.xml
Scope
type dmc_room
Elements
None.
doclist (type dmc_calendar)
Purpose
Displays the contents, including calendar events, of a dmc_calendar object.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_listing_components.xml
doclist (type dmc_datatable)
Parent Definition
webcomponent/config/navigation/doclist/doclist_component.xml
Scope
type dmc_calendar
Elements
None.
doclist (type dmc_datatable)
Purpose
Displays the contents of a dmc_datatable object. Requires Documentum Collaborative Services.
Since
6.5
edit (type dmc_notepage)
Purpose
This component is used to edit dmc_notepage objects. Requires Documentum Collaborative Services.
Parameters
objectId (Required) Object ID of the note
Description
Since
5.x
Configuration File
webcomponent\config\library\notepage\editnotepage_component.xml
editdatatableentry (type dmc_datatable_row)
Scope
type dmc_notepage
Elements
None.
editdatatableentry (type dmc_datatable_row)
Purpose
Enbles editing a dmc_datatable_row object. Requires Documentum Collaborative Services.
Since
6.5
editdatatableentrycontainer (type dmc_datatable_

row)
Purpose
Container for the editdatatableentry component. Requires Documentum Collaborative Services.
Since
6.5
embeddedtopic
Purpose
Enables a user to add, edit, or delete a topic in an embedded view. The embedded view appears at
the bottom of dm_folder and dmc_notepage objects. Requires Documentum Collaborative Services.
embeddedtopic (type dmc_room)
Parameters
folderPath (Optional) Folder path of the parent topic.

embedded topic
objectId (Required) ID of the parent topic.
type (Optional) Object type of the topic parent
Description
Since
5.x
Configuration File
webcomponent\config\library\discussion\topicembedded_component.xml
Scope
All.
Usage
Use the componentinclude tag to embed the component at the bottom of parent page. The parameter
objectId is that of the parent page and is used to acquire the existing topic or is used in the creation of
a topic upon entry of the first comment.
<dmfx:componentinclude name="showtopic" component="embeddedtopic">
<dmfx:argument name="objectId" contextvalue="objectId">
</dmfx:componentinclude>
Elements
comments
See comments, page 729.
embeddedtopic (type dmc_room)
Purpose
Displays the topic for a folder or note at the bottom of the parent objects page in a room. Requires
Documentum Collaborative Services. A user adds, edits or deletes a comment using the controls
rendered by the components page.
Parameters
The parameters are inherited from embeddedtopic:webcomponent/config/library/discussion/
topicembedded_component.xml. See embeddedtopic, page 891.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\topicembedded_component.xml
Parent Definition
embeddedtopic:webcomponent/config/library/discussion/topicembedded_component.xml
Scope
type dmc_room
Elements
comments
Purpose
Used for eRoom 7.x for integration with Webtop. For internal use only. (Customization not
supported.)
Parameters
component (Required) For internal use only.

er_objectId (Required) For internal use only.
newFile (Required) For internal use only.
export (type dmc_datatable)
Description
Since
5.x
Configuration File
webtop\config\eroom_properties_component.xml
Parent Definition
Scope
All.
Elements
commitorder
failoverenabled
export (type dmc_datatable)
Purpose
Exports dmc_datatable objects.
Parameters
contentType (Optional) Content type of document being

exported.
objectId (Required) ID of the dmc_datatable object to
export.
attribute of the dmc_datatable object. You
should not pass in your own value for PDF
renditions. Specifies a user-defined attribute
(page_modifier) value that distinguishes
between renditions.
govern (type dm_folder)
Description
Since
6.0
Configuration File
Scope
type dmc_datatable
Elements
init-controls
See init-controls, page 738.
service
See service, page 747.
ucfrequired
1 <ucfrequired></ucfrequired>
govern (type dm_folder)
Purpose
Enables the user to specify whether governing should be applied to the children of a selected object to
govern. Requires Documentum Collaborative Services.
Parameters
folderId (Required) Object ID of the folder that contains

the object specified by the objectID parameter
objectId (Required) ID of the object to govern
sourceFolderId (Optional) ID of the folder that will be added to
the governed folder or room
Description
Since
5.x
homecabinet_classic (type dmc_calendar) (Webtop)
Configuration File
webcomponent\config\library\rooms\govern_component.xml
Scope
type dm_folder
Elements
None.
homecabinet_classic (type dmc_calendar) (Webtop)
Purpose
Supports browsing of the user home cabinet for dmc_calendar objects. Users can select cabinets
and folders and view their contents. The component is identical to the doclist component with
the exception that the top-level navigation location is the user’s home cabinet path instead of the
repository root cabinet list.
Parameters
None.
Description
Since
6.0
Configuration File
webtop\config\calendar_listing_components.xml
Parent Definition
webtop/config/homecabinet_classic_component.xml
Scope
type dmc_calendar
Elements
columnpreferenceid
<columnpreferenceid>application.display.presetlist_columns</columnpreferenceid>
homecabinet_classic (type dmc_datatable) (Webtop)
columns
objectfilters
showfilters
showthumbnail
Since 6.0 SP1.
Enables (true) and disables (false) displaying thumbnails.
homecabinet_classic (type dmc_datatable) (Webtop)
Purpose
Supports browsing of the user home cabinet for dmc_datatable objects in classic view.
Parameters
None.
Description
Since
6.0
Configuration File
webtop\config\datatable_listing_components.xml
Parent Definition
webtop/config/homecabinet_classic_component.xml
Scope
type dmc_datatable
Elements
columns
objectfilters
homecabinet_classic (type dmc_room) (Webtop)
showfilters
showthumbnail
Since 6.0 SP1.
homecabinet_classic (type dmc_room) (Webtop)
Purpose
Supports browsing of the user home room.
Parameters
The parameters are inherited from homecabinet_classic:webtop/config/homecabinet_classic_
component.xml. See homecabinet_classic (Webtop), page 1066.
Description
Since
5.x
Configuration File
webtop\config\room_homecabinet_classic_component.xml
Parent Definition
homecabinet_classic:webtop/config/homecabinet_classic_component.xml
Scope
type dmc_room
Elements
failoverenabled
This element structure is inherited from homecabinet_classic:webtop/config/homecabinet_classic_
component.xml. See homecabinet_classic (Webtop), page 1066.
homecabinet_list (type dmc_calendar)
Purpose
Browsing of a user’s home cabinet for dmc_calendar objects.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_listing_components.xml
Parent Definition
webcomponent/config/navigation/homecabinet/homecabinet_list_component.xml
Scope
type dmc_calendar
Elements
None.
homecabinet_streamline (type dmc_room) (Webtop)
Purpose
Supports browsing of the user home room.
Parameters
The parameters are inherited from homecabinet_drilldown:webcomponent/config/navigation/
homecabinet/homecabinet_drilldown_component.xml. See homecabinet_drilldown, page 1067.
import (type dmc_calendar_event)
Description
Since
5.x
Configuration File
webtop\config\room_homecabinet_streamline_component.xml
Parent Definition
homecabinet_streamline:webtop/config/homecabinet_streamline_component.xml
Scope
type dmc_room
Elements
None.
import (type dmc_calendar_event)
Purpose
Imports dmc_calendar_event objects.
Parameters
The parameters are inherited from import:webcomponent/config/library/contenttransfer/
importcontent/import_component.xml. See import, page 1026.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\import_component.xml
Parent Definition
import:webcomponent/config/library/contenttransfer/importcontent/import_component.xml
import (type dmc_calendar)
Scope
Elements
See docbase-type-mappings, page 732.
document_filter
See document_filter, page 733.
See document-docbase-base-type, page 732.
See document-docbase-type, page 732.
folder_filter
folder-docbase-type
See folder-docbase-type, page 735.
init-controls
See preserve-file-extension, page 743.
preset_item
service
ucfrequired
Purpose
Imports a dmc_calendar object.
Parameters
The parameters are inherited from import:webcomponent/config/library/contenttransfer/
importcontent/import_component.xml. See import, page 1026.
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\import_component.xml
Parent Definition
import:webcomponent/config/library/contenttransfer/importcontent/import_component.xml
Scope
type dmc_calendar
Elements
document_filter
folder_filter
folder-docbase-type
init-controls
preset_item
service
ucfrequired
myrooms_classic (Webtop)
myrooms_classic (Webtop)
Purpose
Lists rooms used by the user. This component is displayed when the user is in classic view
Description
Since
5.x
Configuration File
webtop\config\myrooms_classic_component.xml
Parent Definition
myrooms_list:/webcomponent/config/library/rooms/myrooms_list_component.xml
Scope
All.
Elements
columns
objecttype
<objecttype>dmc_room</objecttype>

preferences
See preferences, page 742.
showfolders
See showfolders, page 748.
myrooms_drilldown
Purpose
In My Rooms Streamline view component, used to display the rooms to which the user belongs.
Deprecated as of version 6.
myrooms_list
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\myrooms_drilldown_component.xml
Parent Definition
myobjects_drilldown:/webcomponent/config/library/myobjects/myobjects_drilldown_component.
xml
Scope
All.
Elements
columns
failoverenabled
This element structure is inherited from myobjects_drilldown:/webcomponent/config/library/
myobjects/myobjects_drilldown_component.xml. See myobjects_drilldown, page 1108.
modifiedwithindays
objecttype

preferences
showfolders
myrooms_list
Purpose
My Rooms Classic view component, used to list rooms of which the user is a member.
Description
Since
5.x
myrooms_streamline (Webtop)
Configuration File
webcomponent\config\library\rooms\myrooms_list_component.xml
Parent Definition
myobjects_list:/webcomponent/config/library/myobjects/myobjects_list_component.xml
Scope
All.
Elements
columns
failoverenabled
This element structure is inherited from myobjects_list:/webcomponent/config/library/myobjects/
myobjects_list_component.xml. See myobjects_list, page 961.
modifiedwithindays
<modifiedwithindays>7</modifiedwithindays>

objecttype

preset_item
showfolders
<showfolders>false</showfolders>
myrooms_streamline (Webtop)
Purpose
Displays a drilldown style list of rooms used by the user.
Description
Since
5.x
Configuration File
webtop\config\myrooms_streamline_component.xml
nativeroomobjectlocator
Parent Definition
myrooms_drilldown:/webcomponent/config/library/rooms/myrooms_drilldown_component.xml
Scope
All.
Elements
columns
objecttype

preferences
nativeroomobjectlocator
Purpose
Locates and selects dmc_room objects in the repository.
Parameters

objectId (Optional) Object ID of the dmc_room object to
select initially.
Description
Since
6.0
Configuration File
webcomponent\config\library\locator\nativeroomobjectlocator_component.xml
Parent Definition
persistentobjectlocator:webcomponent/config/library/locator/persistentobjectlocator_component.xml
nativeroomobjectlocatorcontainer
Scope
All.
Elements
attributes
See attributes, page 725.
columns
objecttype

views
nativeroomobjectlocatorcontainer
Purpose
Container for the nativeroomobjectlocator, page 906component.
Parameters
multiselect (Optional)
objectId (Optional)
Description
Since
6.0
Configuration File
webcomponent\config\library\locator\nativeroomobjectlocator_component.xml
Parent Definition
Scope
All.
newcalendar
Elements
multidocbasesupport
newcalendar
Purpose
Creates a new dmc_calendar object.
Parameters
The parameters are inherited from newfolder:webcomponent/config/library/create/newfolder_
component.xml. See newfolder, page 853.
Description
Since
5.x
Configuration File
webcomponent\config\library\calendars\newcalendar_component.xml
Parent Definition
newfolder:webcomponent/config/library/create/newfolder_component.xml
Scope
All.
Elements
base_type
default_type
folder_filter
newcalendarcontainer
newcalendarcontainer
Purpose
Contains the newcalendar, page 908 component.
Parameters
The parameters are inherited from newfoldercontainer:webcomponent/config/library/create/
newfoldercontainer_component.xml. See newfoldercontainer, page 853.
Description
Since
5.x
Configuration File
webcomponent\config\library\calendars\newcalendar_component.xml
Parent Definition
newfoldercontainer:webcomponent/config/library/create/newfoldercontainer_component.xml
Scope
All.
Elements
newcomponentname
numberedtabs
newcalendarevent
Purpose
Creates a new dmc_calendar_event object.
Parameters
The parameters are inherited from newdocbaseobject:webcomponent/config/library/create/
newdocbaseobject_component.xml. See newdocbaseobject, page 941.
newcalendareventcontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\calendars\newcalendarevent_component.xml
Parent Definition
newdocbaseobject:webcomponent/config/library/create/newdocbaseobject_component.xml
Scope
All.
Elements
objecttype
<objecttype>dmc_calendar_event</objecttype>
newcalendareventcontainer
Purpose
Container for newcalendarevent, page 909.
Parameters
The parameters are inherited from newdocbaseobjectcontainer:webcomponent/config/library/create/
newdocbaseobject_component.xml. See newdocbaseobjectcontainer, page 941.
Description
Since
5.x
Configuration File
Parent Definition
newdocbaseobjectcontainer:webcomponent/config/library/create/newdocbaseobject_component.xml
newinvitewindow (entitlement collaboration)
Scope
All.
Elements
newcomponentname
newinvitewindow (entitlement collaboration)
Purpose
Displays a second WDK application browser window from which users can send an invitation
to selected room members.
Parameters

Description
Since
6.0
Configuration File
webcomponent\config\library\rooms\room_invites_component.xml
Parent Definition
newwindow:webcomponent/config/library/newwindow/newwindow_component.xml
Scope
Elements
windowparams
newnotepage
newnotepage
Purpose
This component is used to create a new notepage object. Requires Documentum Collaborative
Services.
Parameters
objectId (Required) ID of the folder in which to create

the new notepage object
Description
Since
5.x
Configuration File
webcomponent\config\library\notepage\newnotepage_component.xml
Scope
All.
Elements
base_type
default_type
newnotepagecontainer
Purpose
This component is used to display the newnotepage component. Requires Documentum
Parameters
component (Required) ID of the component to be displayed
newroom
Description
Since
5.x
Configuration File
webcomponent\config\library\notepage\newnotepagecontainer_component.xml
Parent Definition
Scope
All.
Elements
newcomponentname
numberedtabs
newroom
Purpose
Creates a new room: its name, description, and default access controls. Requires Documentum
Collaborative Services. This component must run within the container newroomcontainer, page 914.
Parameters
objectId (Optional) Object ID of the cabinet in which the

new room is created.
Description
Since
5.x
Configuration File
newroomcontainer
Scope
All.
Elements
None.
newroomcontainer
Purpose
Container component for creating new eRooms. Requires Documentum Collaborative Services.
Parameters
The parameters are inherited from propertysheetwizardcontainer:webcomponent/config/
library/propertysheetwizardcontainer/propertysheetwizardcontainer_component.xml. See
propertysheetwizardcontainer, page 831.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\newroomcontainer_component.xml
Parent Definition
Scope
All.
Elements
newcomponentname
numberedtabs
newroomgroup
newroomgroup
Purpose
Creates a private group in a room. Requires Documentum Collaborative Services.
Parameters
groupName (Optional) ID of group to which the selection

will be restricted
objectId (Optional) Object ID of the room in which the
private group is created
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\newroomgroupcontainer_component.xml
Parent Definition
objectlocator:webcomponent/config/library/locator/objectlocator_component.xml
Scope
All.
Elements
columns
containerselectable
flatlist
objecttype
newroomgroupcontainer
views
newroomgroupcontainer
Purpose
Container component for creating private groups in a room. Requires Documentum Collaborative
Services.
Parameters
component (Required) Name of the contained component to

display first.
groupName (Optional) ID of group to be created
objectId (Required) Object ID of the room in which the
private group is created.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\newroomgroupcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
newtable
newtable
Purpose
Creates a new dmc_datatable object.
Parameters
The parameters are inherited from newfolder:webcomponent/config/library/create/newfolder_
component.xml. See newfolder, page 853.
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\newtable_component.xml
Parent Definition
newfolder:webcomponent/config/library/create/newfolder_component.xml
Scope
All.
Elements
base_type
default_type
folder_filter
newtablecontainer
Purpose
A container component for creating a new dmc_datatable object.
newtableentry
Parameters
component (Required) Name of the component to contain.
Description
Since
6.0
Configuration File
Parent Definition
Scope
All.
Elements
newcomponentname
numberedtabs
newtableentry
Purpose
Creates a new dmc_datatable object entry.
Parameters
The parameters are inherited from newdocbaseobject:webcomponent/config/library/create/
newdocbaseobject_component.xml. See newdocbaseobject, page 941.
Description
Since
6.0
newtableentrycontainer
Configuration File
webcomponent\config\library\datatables\newtableentry_component.xml
Parent Definition
newdocbaseobject:webcomponent/config/library/create/newdocbaseobject_component.xml
Scope
All.
Elements
objecttype
<objecttype>dmc_document</objecttype>
newtableentrycontainer
Purpose
A container component for creating new dmc_datatable object table entries.
Parameters
The parameters are inherited from newdocbaseobjectcontainer:webcomponent/config/library/create/
newdocbaseobject_component.xml. See newdocbaseobjectcontainer, page 941.
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\newtableentry_component.xml
Parent Definition
newdocbaseobjectcontainer:webcomponent/config/library/create/newdocbaseobject_component.xml
Scope
All.
Elements
newcomponentname
notepage (type dmc_notepage)
notepage (type dmc_notepage)
Purpose
This component is used to display a note object. A note is a content file that can be displayed directly
in the browser. Requires Documentum Collaborative Services.
Parameters
folderId (Optional) ID of the folder in which the notepage

is located
folderPath (Optional) Specifies the ID of the primary
location for the folder in which the notepage is
located
objectId (Required) ID of the notepage to be displayed
Description
Since
5.x
Configuration File
webcomponent\config\library\notepage\notepage_component.xml
Scope
type dmc_notepage
Elements
None.
notepage (type dmc_notepage) (Webtop)
Purpose
Displays a note (content file that can be displayed directly in the browser). Requires Documentum
objectlist (type dmc_calendar) (Webtop)
Parameters
The parameters are inherited from notepage:webcomponent/config/library/notepage/notepage_
component.xml. See notepage (type dmc_notepage), page 920.
Description
Since
5.x
Configuration File
webtop\config\notepage_component.xml
Parent Definition
notepage:webcomponent/config/library/notepage/notepage_component.xml
Scope
type dmc_notepage
Elements
None.
objectlist (type dmc_calendar) (Webtop)
Purpose
Displays a list of dmc_calendar objects.
Parameters
None.
Description
Since
6.0
Configuration File
webtop\config\calendar_listing_components.xml
objectlist (type dmc_datatable) (Webtop)
Parent Definition
webtop/config/objectlist_component.xml
Scope
type dmc_calendar
Elements
columnpreferenceid
columns
objectfilters
showfilters
showthumbnail
Since 6.0 SP1.
objectlist (type dmc_datatable) (Webtop)
Purpose
Displays a list of dmc_datatable objects.
Parameters
None.
Description
Since
6.0
Configuration File
webtop\config\datatable_listing_components.xml
Parent Definition
webtop/config/objectlist_component.xml
objectlist (type dmc_room) (Webtop)
Scope
type dmc_datatable
Elements
columns
objectfilters
showfilters
showthumbnail
Since 6.0 SP1.
objectlist (type dmc_room) (Webtop)
Purpose
Displays a list of all rooms in the repository.
Parameters
The parameters are inherited from objectlist:webtop/config/objectlist_component.xml. See objectlist
(Webtop), page 962.
Description
Since
5.x
Configuration File
webtop\config\room_objectlist_component.xml
Parent Definition
objectlist:webtop/config/objectlist_component.xml
Scope
type dmc_room
properties (type dmc_calendar_event)
Usage
This component can be initialized in the following ways:
• No parameters
Displays Docbase root cabinets
• folderId
Displays the primary location of the specified folder Id
• folderIds
Displays an absolute folder that is specified as a list of dot-separated (.) object IDs
• folderPath
Displays the folder that is specified by the path
Elements
None.
properties (type dmc_calendar_event)
Purpose
Displays the properties of a dmc_calendar_event object.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\calendars\calendar_event_properties_component.xml
Parent Definition
Scope
properties (type dmc_datatable)
Elements
commitorder
failoverenabled
properties (type dmc_datatable)
Purpose
Displays the properties of dmc_datatable objects.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\table_properties_component.xml
Parent Definition
Scope
type dmc_datatable
Elements
commitorder
failoverenabled
properties (type dmc_room)
Set to true to execute the query against the source repository. Affects reference and foreign objects.
properties (type dmc_room)
Purpose
Displays property sheets that show general information about the selected room object, such as name,
type, format and owner. Requires Documentum Collaborative Services.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\room_properties_component.xml
Parent Definition
Scope
type dmc_room
Elements
commitorder
failoverenabled
recurrence
recurrence
Purpose
Creates the recurring event portion of a dmc_calendar_event object.
Parameters
objectId (Required) ID of the dmc_calendar_event object.
Description
Since
6.0
Configuration File
Scope
All.
Elements
None.
richtextimagepicker
Purpose
Uploads an image into the Rich Text Editor, resulting in the insertion of an image tag <img> in the
rich text HTML. The image file is stored in a temporary location on the application server until the
rich text is saved, at which point the image file is saved to the repository. Requires Documentum
Collaborative Services on the Content Server.
Parameters
None.
richtextinsertlink
Description
Since
5.x
Configuration File
webcomponent\config\library\richtext\imagepicker_component.xml
Scope
All.
Elements
None.
richtextinsertlink
Purpose
Inserts a link in the rich text editor. Requires Documentum Collaborative Services on the Content
Server.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\richtext\insertlink_component.xml
Scope
All.
Elements
None.
roomgrouplocator
roomgrouplocator
Purpose
Displays a selection list with all groups for a room.
Parameters

drop-down list.
roomId (Required) Object ID of the room whose
members to include in the list.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\roomuserorgrouplocatorcontainer_component.xml
Parent Definition
grouplocator:webcomponent/config/library/locator/grouplocator_component.xml
Scope
All.
Elements
containerselectable
objecttype
<objecttype>dm_group</objecttype>
roomgrouplocatorcontainer
privategroupvisible
views
roomgrouplocatorcontainer
Purpose
Contains one or more roomgrouplocator components.
Parameters

drop-down list.
nobuiltingroups (Optional) Boolean: Set to true to suppress
display of built-in groups (Owners,
Contributors, Members, Visitors)
selected
Description
Since
5.x
Configuration File
roominvite (entitlement collaboration)
Parent Definition
grouplocatorcontainer:webcomponent/config/library/locator/grouplocator_component.xml
Scope
All.
Elements
None.
roominvite (entitlement collaboration)
Purpose
Sends an invitation to selected room members.
Parameters

Description
Since
6.0
Configuration File
webcomponent\config\library\rooms\room_invites_component.xml
Scope
Elements
None.
roommembership
roommembership
Purpose
Displays a table listing all members of a room. Requires Documentum Collaborative Services.
Parameters
objectId (Required) Object ID of the room whose

members are listed.
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\room_membership.xml
Scope
All.
Elements
None.
roomoptions
Purpose
Sets the options for a room, including default permissions for contributors. Requires Documentum
Parameters
None.
roomuserorgrouplocator
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
Purpose
Displays a selection list with all members of a room. Requires Documentum Collaborative Services.
Parameters

drop-down list.
groupName (Optional) ID of group to which the selection
will be restricted
multiple selection.
nobuiltingroups (Optional) Boolean: Set to true to suppress
display of built-in groups (Owners,
Contributors, Members, Visitors).
objecttype (Optional) Object type to display.
toplevelusers (Optional) Boolean: Set to true to display only
those users added directly to room.
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
includeunlisted
objecttype

preset_item
privategroupvisible
views
roomuserorgrouplocatorcontainer
roomuserorgrouplocatorcontainer
Purpose
Container component for displaying a list of room members. Requires Documentum Collaborative
Services.
Parameters

drop-down list.
groupName (Optional) ID of a group to which the selection
will be limited.
multiple selection.
nobuiltingroups (Optional) Boolean: Set to true to display only
custom groups.
objecttype (Optional) Object type to display.
selectedobjectids (Optional) Comma-separated list of IDs of
objects that are to be initially selected.Since 6.0.
toplevelusers (Optional) Boolean: Set to true to display only
top-level users.
Description
Since
5.x
Configuration File
Parent Definition
userorgrouplocatorcontainer:webcomponent/config/library/locator/userorgrouplocator_component.
xml
showtopic
Scope
All.
Elements
failoverenabled
This element structure is inherited from userorgrouplocatorcontainer:webcomponent/config/library/
locator/userorgrouplocator_component.xml. See userorgrouplocatorcontainer, page 1342.
multidocbasesupport
showtopic
Purpose
Displays a standalone topic page for objects that do not have embedded topics. The topic is
rendered on the page along with the controls needed to add, edit, and delete comments. Requires
Parameters
folderPath (Optional) Folder path of the parent topic

to build an absolute location for display
objectId (Required) ID of the parent object
type (Optional) Parent object type, for example,
dm_folder
Description
Since
5.x
Configuration File
webcomponent\config\library\discussion\topicpage_component.xml
Scope
All.
showtopic (Webtop)
Elements
comments
showtopic (Webtop)
Purpose
Extends the webcomponent showtopic and displays an object’s associated topic. Requires
Parameters
The parameters are inherited from showtopic:/webcomponent/config/library/discussion/topicpage_
component.xml. See showtopic, page 936.
Description
Since
5.x
Configuration File
webtop\config\topicpage_component.xml
Parent Definition
showtopic:/webcomponent/config/library/discussion/topicpage_component.xml
Scope
All.
Elements
comments
spellchecker
spellchecker
Purpose
Checks the spelling in the rich text editor. Requires the ActiveX plug-in to be enabled in app.xml
and a successful plug-in download to the client. Rich text editing or display requires Documentum
Collaborative Services on the Content Server.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\richtext\spellchecker_component.xml
Scope
All.
Usage
The calling window needs to set the following variables:
window.contentWindow window: the iFrame ContentWindow
window.layerDoc: the iFrame document
Elements
None.
streamlineview (type dmc_room) (Webtop)
Purpose
Displays dmc_room objects in the Webtop streamline view.
tablefields
Parameters
The parameters are inherited from drilldown:webcomponent/config/navigation/drilldown/
drilldown_component.xml. See drilldown, page 952.
Description
Since
5.x
Configuration File
webtop\config\room_streamlineview_component.xml
Parent Definition
streamlineview:webtop/config/streamlineview_component.xml
Scope
type dmc_room
Elements
None.
tablefields
Purpose
Displays table entries in a dmc_table object.
Parameters
objectId (Required) ID of the dmc_table object.
Description
Since
6.0
Configuration File
ungovern (type dm_folder)
Scope
All.
Elements
None.
ungovern (type dm_folder)
Purpose
Confirms that objects are being removed from a Room. Allows users to ungovern just a folder or
the folder and all children. Children that are governed by a different room than the folder remain
governed. Requires Documentum Collaborative Services.
Parameters
objectId (Required) ID of the object being removed
Description
Since
5.x
Configuration File
webcomponent\config\library\rooms\ungovern_component.xml
Scope
type dm_folder
Elements
None.
newdocbaseobject
Creating objects
newdocbaseobject
Purpose
Creates a new object in the repository.
Parameters
objectId (Required) ID of the object to create.
Description
Since
6.0
Configuration File
webcomponent\config\library\create\newdocbaseobject_component.xml
Scope
All.
Elements
objecttype
<objecttype>dmc_document</objecttype>
newdocbaseobjectcontainer
Purpose
Calls the newdocbaseobject, page 941 component.
newdoccontainer
Parameters
component (Required) Name of the component to call.
Description
Since
6.0
Configuration File
webcomponent\config\library\create\newdocbaseobject_component.xml
Parent Definition
Scope
All.
Elements
newcomponentname
numberedtabs
newdoccontainer
Purpose
Extends propertysheetwizardcontainer, page 831 and contains attributes, the component
newdocument, page 944, and permissions. The componentnewdocument, page 944 requires a visit.
Parameters
component (Required) ID of the component displayed

contentType (Optional) Content type of document being
created.
editAfterCreate (Optional) Boolean: Set to true to open the new
document object in edit mode after it has been
created.
newdoccontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\create\newdoccontainer_component.xml
Parent Definition
Scope
All.
Usage
For performance reasons, validation is not performed on new document creation. The validation is
performed only when the document is checked in. If the user creates a document with no format (zero
content), then validation is done, because the document can not be edited and is not checked out.
Both NewContainer and NewDocContainer determine the component name by calling a protected
member function, getNewComponentName(). You can override this function to return the
component name. For example, the NewAssemblyContainer Java class, which derives from
NewDocContainer, overrides the getNewComponentName() function to return "newassembly"
as the contained component name.
The parameters for combocontainer (parent of newdoccontainer) are added by the LaunchComponent
action execution class in order to support actions on multiple objects. Do not call the container by
URL.
Elements
numberedtabs
newcomponentname
numberedtabs
newdocument
newdocument
Purpose
Creates new objects. This component must run within the component newdoccontainer, page 942
or the component newhttpdoccontainer, page 945. Each custom object must have a template in the
repository Templates cabinet in order for the template and its associated formats to show up in
the newdocument UI.
Parameters
objectId (Required) ID of the folder that will contain the

new document
Description
Since
5.x
Configuration File
webcomponent\config\library\create\newdocument_component.xml
Scope
All.
Usage
Refer to newdoccontainer, page 942.
Elements
combo_defaults
1 <combo_defaults>
2<base_type>dm_document</base_type>
3<type>dm_document</type>
4<format>msw8</format>
</combo_defaults>
1 Configures the preferred default selected object type and format and whether to display templates
for supertypes of formats that do not have a template in the current repository.
2 Base object type of the one specified in <type>.
3 Default type to display in type combo box. Valid values: dm_sysobject or subtype.
4 Default format to display in format combo box. A template of this format must be available in the
/Templates cabinet or subfolder. Valid values: ’name’ attribute values for dm_format object.
newhttpdoccontainer
wdk_new_doc_aspect
1 <wdk_new_doc_aspect>
2 <enabled>false<enabled/>
3 <exclusion_list><exclusion_list/>
<wdk_new_doc_aspect/>
1 This configuration enables users who do not have the Delete permission on the object being
created, to create a document as the object owner. For example, if you enable this behavior, users
with the Version permission can create new documents.
2 When this option is enabled, the application attaches a temporary permission by attaching a new
aspect and removes the aspect on the first version.
3 If you specify any custom types for dm_document, this behavior does not apply for these types
even if the option is enabled in step 2.
Note: This configuration is supported since Documentum 6.5 SP2 and requires the Documentum
6.5 SP2 Webtop.dar to be compatible with the Content Server.
document_filter
preset_item
newhttpdoccontainer
Purpose
Extends newdoccontainer, page 942.
Parameters
The parameters are inherited from newdoccontainer:webcomponent/config/library/create/
newdoccontainer_component.xml. See newdoccontainer, page 942.
Description
Since
5.x
Configuration File
webcomponent\config\library\httpcreate\newhttpdocument_component.xml
Parent Definition
newdoccontainer:webcomponent/config/library/create/newdoccontainer_component.xml
exporttocsv
Scope
All.
Elements
numberedtabs
newcomponentname
Data import and export
exporttocsv
Purpose
Exports datagrid row content to a comma-separated value file.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\exporttocsv\exporttocsv_component.xml
Scope
All.
Elements
None.
importcsv
importcsv
Purpose
Imports a comma-separated value file into a repository.
Parameters
objectId (Required) ID of the object to be imported.
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\import_csv_component.xml
Scope
All.
Elements
None.
importcsvcontainer
Purpose
Contains the importcsv, page 947 component.
Parameters
component (Required) Name of the contained component.

objectId (Required) ID of the object to be imported.
alldocumentlocator
Description
Since
6.0
Configuration File
webcomponent\config\library\datatables\import_csv_component.xml
Scope
All.
Elements
None.
Displaying lists of objects
alldocumentlocator
Purpose
Locates dm_objects in a repository. It allows users to navigate from the root cabinets to locate objects.
Users can filter objects by the content format.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\documentlocators_component.xml
Parent Definition
attachments
Scope
All.
Elements
allversionsvisible
columns
containerselectable
objecttype
<objecttype>dm_document</objecttype>

views
attachments
Purpose
Displays a list of attachment objects.
Since
6.5
dmr_contentlocator
dmr_contentlocator
Purpose
This component is the locator for all repository documents and dmr_content with folders shown.
Parameters

objecttype (Optional) The logical (base) type of the
selectable type
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\dmr_contentlocators_component.xml
Parent Definition
alldocumentlocator:webcomponent/config/library/locator/documentlocators_component.xml
Scope
All.
Elements
objecttype

views
dmr_contentlocatorcontainer
dmr_contentlocatorcontainer
Purpose
This component is the locator for all docbase documents and dmr_content with folders shown.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\dmr_contentlocators_component.xml
Parent Definition
documentlocatorcontainer:webcomponent/config/library/locator/documentlocators_component.xml
Scope
All.
Elements
None.
documentlocatorcontainer
Purpose
Extends the container locatorcontainer, page 960 and contains locator components:
alldocumentlocator, page 948, documentsubscriptionlocator, page 1248, mydocumentlocator, page
1103, and recentdocumentlocator, page 966.
Parameters
drilldown
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
drilldown
Purpose
Displays a folder frame and a folder contents frame. The content pane supports filters similar to
those in the doclist component. The user navigates by clicking on a folder or on a folder name
in the breadcrumb control. The drilldown component has an extended version in Webtop called
streamlineview. Deprecated as of version 6.
Parameters
folderId (Optional) Specifies the ID of the folder in which

to start browsing
home_component (Optional) In Portal application, specifies portal
component that calls this component. Used to
construct a breadcrumb back to the portal.
home_component_args (Optional) In Portal application, specifies
arguments that are passed to the portal
component that calls this component when the
user clicks the breadcrumb to go back.
drilldown (type dm_message_archive)
isolate (Optional) Set to true to disable clicking in the

path to the drilldown component
showAllVersions (Optional) Set to true to show all versions of the
object
Description
Since
5.x
Configuration File
webcomponent\config\navigation\drilldown\drilldown_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
objectfilters
preferences
showfilters
Purpose
Displays a dm_message_archive object in a folder frame and a folder contents frame.
Parameters

to start browsing.
home_component (Optional) In Portal application, specifies portal
component that calls this component. Used to
construct a breadcrumb back to the portal.
home_component_args (Optional) In Portal application, specifies
arguments that are passed to the portal
component that calls this component when the
user clicks the breadcrumb to go back.
isolate (Optional) Set to true to disable clicking in the
path to the drilldown component.
objectId (Optional) ID of the dm_message_archive object.
showAllVersions (Optional) Boolean: Whether to show all
versions of objects (True) or not (False).
Description
Since
5.x
Configuration File
webcomponent\config\library\messagearchive\messagearchive_component.xml
Parent Definition
drilldown:webcomponent/config/navigation/drilldown/drilldown_component.xml
Scope
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from drilldown:webcomponent/config/navigation/drilldown/
folderlocatorcontainer
objectfilters
preferences
showfilters
folderlocatorcontainer
Purpose
Extends the containerlocatorcontainer, page 960 and selects the folders to be searched. This container
is used by advsearch, page 1192 and contains allfolderlocator, page 846, foldersubscriptionlocator,
page 1249, and recentfolderlocator, page 967.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
locatecheckinlocalfile
locatecheckinlocalfile
Purpose
Enables browsing the local filesystem to find files to check in.
Parameters
The parameters are inherited from locatelocalfile:webcomponent/config/library/contenttransfer/
locatelocalfile_component.xml. See locatelocalfile, page 959.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkin\locatecheckinlocalfile_component.xml
Parent Definition
locatelocalfile:webcomponent/config/library/contenttransfer/locatelocalfile_component.xml
Scope
All.
Elements
None.
locatecheckinlocalfilecontainer
Purpose
Container for components that enable browsing the local filesystem to find files to check in.
Parameters
The parameters are inherited from locatelocalfilecontainer:webcomponent/config/library/
contenttransfer/locatelocalfilecontainer_component.xml. See locatelocalfilecontainer, page 959.
locateimportlocalfile
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkin\locatecheckinlocalfilecontainer_
component.xml
Parent Definition
locatelocalfilecontainer:webcomponent/config/library/contenttransfer/locatelocalfilecontainer_
component.xml
Scope
All.
Elements
None.
locateimportlocalfile
Purpose
Displays local files for import into repositories.
Parameters
The parameters are inherited from locatelocalfile:webcomponent/config/library/contenttransfer/
locatelocalfile_component.xml. See locatelocalfile, page 959.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\locateimportlocalfile_component.
xml
Parent Definition
locatelocalfile:webcomponent/config/library/contenttransfer/locatelocalfile_component.xml
locateimportlocalfilecontainer
Scope
All.
Elements
None.
locateimportlocalfilecontainer
Purpose
Container for components that display local files to import.
Parameters
The parameters are inherited from locatelocalfilecontainer:webcomponent/config/library/
contenttransfer/locatelocalfilecontainer_component.xml. See locatelocalfilecontainer, page 959.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\locateimportlocalfilecontainer_
component.xml
Parent Definition
locatelocalfilecontainer:webcomponent/config/library/contenttransfer/locatelocalfilecontainer_
component.xml
Scope
All.
Elements
None.
locatelocalfile
locatelocalfile
Purpose
Displays local files.
Parameters
fileName (Optional) Name of the file to import.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\locatelocalfile_component.xml
Scope
All.
Elements
None.
locatelocalfilecontainer
Purpose
Container for components that display local files.
Parameters

fileName (Optional) Name of the file to import.
locatorcontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\locatelocalfilecontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
locatorcontainer
Purpose
Extends propertysheetcontainer, page 830 and serves as a base locator container component.
Parameters

drop-down list.
folderId (Optional) The ID of the folder in which to begin
the search.
repository (Optional) The docbase in which to search
selected
storelist (Optional)
myobjects_list
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\locatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
multidocbasesupport
myobjects_list
Purpose
Lists objects that are owned by the user.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\myobjects\myobjects_list_component.xml
Scope
All.
objectlist (Webtop)
Elements
columns
failoverenabled
modifiedwithindays
objecttype

preset_item
showfolders
objectlist (Webtop)
Purpose
Displays a list of dm_sysobject objects.
Parameters
folderId (Optional) Specifies the primary location of the

specified folder Id
folderIds (Optional) Specifies a list of dot-separated object
IDs that are used to build an absolute location
to display as the path
a complete path from the Docbase root, for
example, /Documentation%20Library/subfolder
showAllVersions (Optional) Set to true to display all versions of
the objects
Description
Since
5.x
objectlist (Webtop)
Configuration File
webtop\config\objectlist_component.xml
Parent Definition
doclist:webcomponent/config/navigation/doclist/doclist_component.xml
Scope
All.
Usage
This component can be initialized in the following ways:
• No parameters
Displays Docbase root cabinets
• folderId
Displays the primary location of the specified folder Id
• folderIds
Displays an absolute folder that is specified as a list of dot-separated (.) object IDs
• folderPath
Displays the folder that is specified by the path
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from doclist:webcomponent/config/navigation/doclist/doclist_
component.xml. See doclist, page 1050.
objectfilters
preset_item
showfilters
objectlocator
objectlocator
Purpose
The locator components locate objects in the repository. You can include locators in your component
class when you need to locate Documentum objects. Locator components locate objects by type. Some
locators search on specific criteria within the type, such as objects that are subscribed to or belong to
the user. Two types of views are supported: flatlist, in which all selectable objects in the repository
are shown, and hierarchical, in which the user can drill down from a list of root container (cabinets).
Parameters

drop-down list.
folderId (Optional) ID of the folder in which to search
selected.
storelist (Optional)
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\objectlocator_component.xml
Scope
All.
Elements
columns
containerselectable
persistentobjectlocator
flatlist
objecttype

views
persistentobjectlocator
Purpose
Locates and selects any persistent object in the repository. It is a generic locator which can be
configured to locate any object in the repository.
Parameters

drop-down list.
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\persistentobjectlocator_component.xml
Scope
All.
Elements
attributes
recentdocumentlocator
columns
objecttype

views
recentdocumentlocator
Purpose
Displays all objects that have been selected within the user’s current HTTP session. This component
has no scope, but <objecttype> element is configured by default to restrict search to dm_document.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
columns
containerselectable
recentfolderlocator
iconwell_icon
objecttype

views
recentfolderlocator
Purpose
Extends recentsysobjectlocator, page 968 and locates folders that were recently selected or used. This
component has no scope, but the <objecttype> element restricts the search by default to dm_folder
objects.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
columns
containerselectable
recentsysobjectlocator
iconwell_icon
objecttype

views
recentsysobjectlocator
Purpose
Extends objectlocator, page 964 and locates objects that were recently selected or used.
Parameters

multiple selection.
objecttype (Optional) Object type to display in the list
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\recentsysobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
columns
containerselectable
sysobjectlocator
flatlist
iconwell_icon
objecttype
<objecttype>dm_sysobject</objecttype>

views
sysobjectlocator
Purpose
Displays all dm_sysobject objects in a locator.
Parameters

drop-down list.
folderId (Optional) ID of folder in which to begin the
search
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\sysobjectlocator_component.xml
sysobjectlocator
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
objecttype

views
unfilteredcontainersysobjectlocator
unfilteredcontainersysobjectlocator
Purpose
Extends sysobjectlocator, page 969 and allows the user to navigate the repository from the root
cabinet in order to locate a dm_sysobject. Two types of views are supported: flatlist, in which all
selectable objects in the repository are shown, and hierarchical, in which the user can drill down
from a list of root container (cabinets).
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\unfilteredcontainersysobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
locations
objecttype

views
Displaying lists of objects associated with an

object
locations
Purpose
Extends objectgrid, page 1056 and lists the folders and virtual documents to which the selected
object is directly linked.
Parameters
objectId (Required) ID of the object
Description
Since
5.x
Configuration File
webcomponent\config\library\locations\locations_component.xml
Parent Definition
locations (Webtop)
Scope
All.
Elements
dragdrop
header
columns
nondocbasecolumns
locations (Webtop)
Purpose
Extends the WDK locations component and lists the folders and virtual documents to which the
selected object is directly linked. Gets the current view, sets the appropriate view page, and presents
the Webtop browsertree.
Parameters
The parameters are inherited from locations:/webcomponent/config/library/locations/locations_
component.xml. See locations, page 972.
Description
Since
5.x
Configuration File
webtop\config\locations_component.xml
Parent Definition
locations:/webcomponent/config/library/locations/locations_component.xml
Scope
All.
relationships
Elements
dragdrop
relationships
Purpose
Extends objectgrid, page 1056 and lists the sysobjects to which the source sysobject has a relationship
(dm_relation object).
Parameters
objectId (Required) ID of the sysobject for which to locate

relationships
Description
Since
5.x
Configuration File
webcomponent\config\library\relationships\relationships_component.xml
Parent Definition
Scope
All.
Elements
columns
header
nondocbasecolumns
bravaviewer
Document Imaging Services
bravaviewer
Purpose
This is a sample IGC Brava viewer component for illustration purposes only.
Parameters
The parameters are inherited from daejaviewer:webcomponent/config/library/imaging/samples/
daejaviewer_component.xml. See daejaviewer, page 976.
Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\samples\bravaviewer_component.xml
Parent Definition
daejaviewer:webcomponent/config/library/imaging/samples/daejaviewer_component.xml
Scope
All.
Elements
CreateAnno and CreateRedact
These element structures are inherited from daejaviewer:webcomponent/config/library/imaging/
samples/daejaviewer_component.xml. See daejaviewer, page 976.
daejaviewer
daejaviewer
Purpose
Base component used by the Image Viewer Framework. All the other viewer components, such as
pdfviewer and bravaviewer, are derived from this base component, which means that they share
the same component behavior class and parameters but with different JSP pages to embed different
viewers. The JSP page for the base component uses Daeja ViewOne Pro as the viewer.
Parameters
objectId (Required) Document to be opened by the

viewer.
Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\samples\daejaviewer_component.xml
Scope
All.
Elements
<filter>
<CreateAnno>true</CreateAnno>
<CreateRedact>false</CreateRedact>
</filter>
getannotation
Purpose
getdocument
Parameters
format (Optional) For internal use only.

Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\getannotation_component.xml
Scope
All.
Elements
None.
getdocument
Purpose
Parameters

pageModifier (Optional) For internal use only.
pageNumber (Optional) For internal use only.
Description
Since
5.x
imagingserviceservlet
Configuration File
webcomponent\config\library\imaging\getdocument_component.xml
Scope
All.
Elements
None.
imagingserviceservlet
Purpose
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\samples\imagingserviceservlet_component.xml
Scope
All.
Elements
None.
pdfviewer
pdfviewer
Purpose
Component derived from daejaviewer component; the JSP page shows Acrobat Reader as the viewer.
Parameters
The parameters are inherited from daejaviewer:webcomponent/config/library/imaging/samples/
daejaviewer_component.xml. See daejaviewer, page 976.
Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\samples\pdfviewer_component.xml
Parent Definition
daejaviewer:webcomponent/config/library/imaging/samples/daejaviewer_component.xml
Scope
All.
Elements
These element structures are inherited from daejaviewer:webcomponent/config/library/imaging/
samples/daejaviewer_component.xml. See daejaviewer, page 976.
printdocuments (type dm_sysobject)
Purpose
saveannotation
Parameters
clientlog (Optional) For internal use only.

inline (Optional) For internal use only.
Description
Since
6.0
Configuration File
webcomponent\config\library\imaging\printdocuments_component.xml
Scope
type dm_sysobject
Elements
printablemimetypes
<printablemimetypes>
<mimetype>application/pdf</mimetype>
...
</printablemimetypes>
saveannotation
Purpose
Parameters

savedocument
Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\saveannotation_component.xml
Scope
All.
Elements
None.
savedocument
Purpose
Since
6.5
viewcontainer_imaging (type dm_sysobject)
Purpose
Sample viewer container component used to illustrate the use of other viewer components, for
example, daejaviewer and pdfviewer.
viewcontainer_imaging (type dm_sysobject)
Parameters
component (Required) Viewer container component;

use defaultviewer to call the default viewer
component; use pdfviewer to call the viewer
component for showing a PDF document.
componentArgs (Required) List of arguments and values to pass
to each contained component. Supplied by the
LaunchComponent action execution class.
Description
Since
5.x
Configuration File
webcomponent\config\library\imaging\samples\viewcontainer_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
defaultviewer
<defaultviewer>daejaviewer</defaultviewer>
Specifies the default viewer.

pdfviewer
<pdfviewer>pdfviewer</pdfviewer>
Specifies the PDF viewer.

failoverenabled
attachmentcheckin
Downloading and uploading content
attachmentcheckin
Purpose
Checks in attachments.
Since
6.5
attachmentimport
Purpose
Imports files as attachments.
Since
6.5
attachmentimportcontainer
Purpose
Container for importing files as attachments.
Since
6.5
Purpose
This is the WDK 5.3 cancelcheckout component. It cancels the checkout of one or more previously
checked out objects by removing the lock on the specified objects. This component must run within
the 5.3 cancelcheckoutcontainer component or the httpcancelcheckoutcontainer. The cancelcheckout
component is defined for dm_sysobject and dm_folder.
Parameters
nodeId (Optional) Node ID of the checked out object,

when it is part of a virtual document.
objectId (Required)The ID of the checked out docbase
object.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\cancelcheckout\cancelcheckout_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
ucfrequired
cancelcheckoutcontainer
cancelcheckoutcontainer
Purpose
This is the WDK 5.3 cancelcheckoutcontainer component. It allows users to remove the lock on
specified checked-out documents
Parameters
The parameters are inherited from combocontainer:wdk/config/combocontainer_component.xml. See
combocontainer, page 1046.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\cancelcheckout\cancelcheckoutcontainer_
component.xml
Parent Definition
Scope
All.
Elements
See bindingcomponentversion, page 726.
failoverenabled
service
ucfrequired
changeucfcheckoutlocation
changeucfcheckoutlocation
Purpose
Sets the checkout location for objects.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\general\changeucfcheckoutlocation_component.
xml
Scope
All.
Elements
ucfrequired
Purpose
This is the WDK 5.3 checkin component. It checks in objects that were checked out and sets properties
on the objects. The checkin component is available in all views for objects that are checked out on the
user’s current machine. This component must be used within 5.3 checkincontainer.
Parameters
keepLocalFile (Optional) Whether to keep the local file on the

machine (True) or not (False).Since 6.0.
to check in
objectId (Required) The ID of the object to check in.

retainLock (Optional) Boolean: Whether to keep the lock on
the object (True) or not (False).Since 6.0.
silent (Optional) Boolean: Whether to check in the
object without displaying the checkin or checkin
from dialog box (True) or not (False). If you
specify true for this parameter, you must specify
a valid value for the version parameter.Since 6.0.
vdmRootObjectId (Optional) Root object ID or the virtual
document to check in.
version (Optional) Whether to check in the object as a
major, minor, branched, or the same version
when true is specified for the silent parameter.
Valid values are: major, minor, branch, same. If
this parameter is not specified, then the checkin
dialog box is displayed even when true is
specified for the silent parameter.Since 6.0.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkin\checkin_component.xml
Scope
type dm_sysobject
Usage
To customize the checkin layout, use the control. First, create a definition file that is scoped to the
custom type. In the JSP page for the custom type, add a tag for the custom attribute list that you wish
to display on checkin. Add a tag similar to the following:
<dmfx:docbaseattributelist name="attrlist"
object="obj" attrconfigid="checkin"/>
All custom attributes that are in a category appear unless they are listed in the <ignore_attributes>
element. Attributes are displayed in order of category. If the value of showpagesastabs, then the
categories are displayed as tabs.
You can have different attribute lists for checkin, properties, import, and other components.
Elements
init-controls
checkincontainer
preset_item
service
ucfrequired
checkincontainer
Purpose
This is the WDK 5.3 checkincontainer component. Checking in multiple objects creates one checkin
container and an inner checkin component instance for each object.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkin\checkincontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
ucfrequired
Purpose
This is the WDK 5.3 checkout component. It checks out objects from the repository without launching
an editing application. The checkout component is available in all views for objects that are checked
out on the user’s current machine. This component must be used within the 5.3 checkoutcontainer.
The checkoutcontainer component extends combocontainer, page 1046. Checking out multiple objects
creates one checkout container and an inner checkout component instance for each object.
Parameters

document.
isLockOnly (Optional) Boolean value that indicates whether
or not to check out objects that are locked.
nodeId (Optional) r_object_id of a virtual document
node to check out.
objectId (Required) The ID of the object to check out.
vdmRootObjectId (Optional) r_object_id of the virtual document
root.
Description
Since
5.x
checkoutbyother
Configuration File
webcomponent\config\library\contenttransfer\checkout\checkout_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
skipVersionCheck
See skipVersionCheck, page 749.
ucfrequired
checkoutbyother
Purpose
Informs the user that the requested object is checked out by another user.
Parameters
message (Optional) The message to display to the user.
Description
Since
5.x
Configuration File
webcomponent\config\library\checkout\checkoutbyother_component.xml
Scope
All.
Elements
None.
checkoutbyothercontainer
checkoutbyothercontainer
Purpose
Container for informing the user that a requested object is checked out by another user.
Parameters

message (Optional) The message to display to the user.
Description
Since
5.x
Configuration File
webcomponent\config\library\checkout\checkoutbyothercontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
checkoutcontainer
Purpose
This is the WDK 5.3 checkoutcontainer component. It is the container for the checkout process.
delete
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkout\checkoutcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
ucfrequired
delete
Purpose
Base component for deleting work queue-related objects.
Parameters
objectId (Required) ID of the object to delete.

objectname (Optional) The name of the object.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\delete\deleteworkqueueobject_component.xml
Scope
All.
Elements
None.
Purpose
component.
Parameters
folderId (Optional) ID of the parent folder of the file

or folder that is to be deleted. Applies only to
dm_folder and dm_sysobject types.
to all types.
delete (type dm_sysobject) (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\delete\deletedocument_component.xml
Scope
type dm_sysobject
Elements
None.
delete (type dm_sysobject) (Webtop)
Purpose
(dm_notification and dm_queued), and deletes folders (queries the user whether all objects should
be deleted from a folder selected for deletion).
Parameters
The parameters are inherited from delete:webcomponent/config/library/delete/deletedocument_
component.xml. See delete (type dm_sysobject), page 993.
Description
Since
6.0
Configuration File
webtop\config\deletedocument_component.xml
Parent Definition
delete:webcomponent/config/library/delete/deletedocument_component.xml
Scope
type dm_sysobject
download
Elements
None.
download
Purpose
The download component calls a servlet that forces download of an object to the browser.
Parameters
docId (Optional) ID of the object to download.

servletAction (Optional) Type of action. Valid values: view
| download.
Description
Since
5.x
Configuration File
webcomponent\config\library\httpview\download_action_component.xml
Scope
All.
Elements
None.
downloadcontentcontainer (type dm_sysobject)
Purpose
Container for components that enable downloading content objects.
edit (type dm_sysobject)
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\viewcontainer_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
failoverenabled
service
ucfrequired
edit (type dm_sysobject)
Purpose
This is the WDK 5.3 edit component. It edits objects in the repository. This component must run
within the editcontainer component. The edit component is defined for dm_sysobject scope. Editing
is excluded for dm_folder objects by the notdefined attribute on the component element. The
container extends combocontainer, page 1046.
editcontainer (type dm_sysobject)
Parameters
The parameters are inherited from checkout:webcomponent/config/library/contenttransfer/checkout/
checkout_component.xml. See checkout (type dm_sysobject), page 989.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\edit\edit_component.xml
Parent Definition
checkout:webcomponent/config/library/contenttransfer/checkout/checkout_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
skipVersionCheck
ucfrequired
editcontainer (type dm_sysobject)
Purpose
This is the WDK 5.3 editcontainer component. It is the container for components that enable checking
out objects and opening them for editing in an associated application.
Parameters
emfimport
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\edit\editcontainer_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
failoverenabled
service
ucfrequired
emfimport
Purpose
Enables importing an email as a dm_message_archive object.
Since
6.5
Purpose
This is the WDK 5.3 export component. Exports objects from the repository to the client file system.
This component must run within the 5.3 component exportcontainer.
Parameters

isIgnoreDescendents (Optional) Specifies whether descendants of a
virtual document should be ignored.
node to edit.
objectId (Required) ID of the object to be exported.
root.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\export_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
ucfrequired
export (type dmr_content)
export (type dmr_content)
Purpose
This is the WDK 5.3 export component. It is used to export dm_sysobjects and dmr_content objects
from the repository to the client file system. This component must run within the component
exportcontainer. Export of multiple objects creates one export container and an inner export
component instance for each object.
Parameters

objectId (Required) ID of the object to be
exported(Required) ID of the object to be
exported
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\export_component.xml
Scope
type dmr_content
Elements
init-controls
service
ucfrequired
exportcontainer (type dm_sysobject)
exportcontainer (type dm_sysobject)
Purpose
This is a WDK 5.3 exportcontainer component. It is used to export dm_sysobjects and dmr_content
objects from the repository to the client file system. Export of multiple objects creates one export
container and an inner export component instance for each object.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\exportcontainer_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
failoverenabled
service
ucfrequired
Whether to enable (true) or disable (false) UCF. To enable and disable UCF for specific events, specify
the events/event element structure, where the event element’s attributes are:
• name: name of event.
• enabled: true to enable or false to disable UCF.
exportcontainer (type dmr_content)
Since 6.0 SP1.
exportcontainer (type dmr_content)
Purpose
This is a WDK 5.3 exportcontainer component. It is used to export dm_sysobjects and dmr_content
objects from the repository to the client file system. This component must run within the component
exportcontainer. Export of multiple objects creates one export container and an inner export
component instance for each object.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\exportcontainer_component.xml
Parent Definition
Scope
type dmr_content
Elements
failoverenabled
service
exportviewcontainer (type dm_message_archive)
ucfrequired
exportviewcontainer (type dm_message_archive)
Purpose
Displays a dm_message_archive object to export.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\contenttransfer\view\exportviewcontainer_component.xml
Parent Definition
Scope
Elements
failoverenabled
service
ucfrequired
externalresultimportcontainer
externalresultimportcontainer
Purpose
Container for components that enable importing local files into repositories.
Parameters

search context
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\externalresultimportcontainer_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
getcontent
getcontent
Purpose
Streams Documentum object content to the browser without the use of applets. Login is requested if
the user has not already logged in.
Parameters
format (Optional) If a value is provided, the component

attempts to stream the content in the specified
format. If not, the object’s native format is used.
pageModifier (Optional) Specifies a user-defined attribute
(page_modifier) value that distinguishes
between renditions.
pageNumber (Optional) Specifies the page number of a
document.
streamingMode (Optional) Specifies whether the file is to be
opened in the client application appropriate to
the file’s format or the browser. Valid values are:
attachment: The downloaded file opens in the
client application. inline: The downloaded file
opens in the same browser window. Default is
attachment.Since 6.0.
Description
Since
5.x
Configuration File
wdk\config\getcontent_component.xml
Scope
All.
Usage
The start page is specified as the URL (/wdk5-download) that is mapped to the streaming content
servlet.
Following is an example of a URL to stream content to the browser:
http://host:port/webtop/component/getcontent?objectId=0900d47f80002426
httpcancelcheckout (type dm_sysobject)
&format=richtext&pageNumber=1&ext=bmp&streamingMode=inline
Because the getcontent component is a servlet, you must construct a fully qualified URL when calling
getcontent from a component class. The URL must have the virtual root, which you can obtain
from HttpServletRequest. For example:
String strVirtualRoot = ((HttpServletRequest)pageContext.
getRequest()).getContextPath();
String strUrl = strVirtualRoot + "/component/getcontent?objectId=" +
args.get("objectId"));
setRedirectUrl(strUrl);
Elements
streamingMode
<streamingMode>attachment</streamingMode>
Specifies whether the file is to be opened in the client application appropriate to the file’s format or the
browser. Valid values are: attachment: The downloaded file opens in the client application. inline:
The downloaded file opens in the same browser window. Default is attachment.
httpcancelcheckout (type dm_sysobject)
Purpose
This is the WDK 5.3 httpcancelcheckout component. It enables cancelling checkouts of objects.
Parameters
objectId (Required) r_object_id of the object for which

to cancel the checkout.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\cancelcheckout\httpcancelcheckout_component.
xml
Scope
type dm_sysobject
httpcancelcheckoutcontainer
Elements
init-controls
service
httpcancelcheckoutcontainer
Purpose
This is the WDK 5.3 httpcancelcheckoutcontainer component. It is a container for components that
enable cancelling the checkout of a repository object.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\cancelcheckout\httpcancelcheckoutcontainer_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
httpcheckin (type dm_sysobject)
service
httpcheckin (type dm_sysobject)
Purpose
This is the WDK 5.3 httpcheckin component. It checks in non-XML objects one at a time using the
HTTP input mechanism.
Parameters
objectId (Required) The ID of the object to check in.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkin\httpcheckin_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
httpcheckincontainer
httpcheckincontainer
Purpose
This is the WDK 5.3 httpcheckincontainer. It checks in non-XML objects one at a time using the HTTP
input mechanism. (XML objects must be checked in using the UCF checkin component, which
contains a parser.) The httpcheckincontainer component extends combocontainer, page 1046.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkin\httpcheckincontainer_component.xml
Parent Definition
Scope
All.
Usage
The parameters are added by the action execution class. Do not call the container by URL.
Elements
failoverenabled
service
httpcheckout (type dm_sysobject)
httpcheckout (type dm_sysobject)
Purpose
This is the WDK 5.3 httpcheckout component. It checks out objects from the repository without
launching an editing application. The httpcheckout component is available in all views for objects
that are checked out on the user’s current machine. This component must be used within the
httpcheckoutcontainer, page 1011 container. Checking out multiple objects creates one checkout
container and an inner checkout component instance for each object.
Parameters

document.
isLockOnly (Optional) Boolean value that indicates whether
or not to check out objects that are locked.
node to check out.
objectId (Required) The ID of the object to check out.
root.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkout\httpcheckout_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
httpcheckoutcontainer
httpcheckoutcontainer
Purpose
This is the WDK 5.3 httpcheckoutcontainer component. It is the container for components that
enable checking out objects from a repository.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\checkout\httpcheckoutcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
httpedit (type dm_sysobject)
httpedit (type dm_sysobject)
Purpose
This is the WDK 5.3 httpedit component. It enables checking out objects from repositories and
opening them for editing in an associated application on the local machine.
Parameters
The parameters are inherited from httpcheckout:webcomponent/config/library/contenttransfer/
checkout/httpcheckout_component.xml. See httpcheckout (type dm_sysobject), page 1010.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\edit\httpedit_component.xml
Parent Definition
httpcheckout:webcomponent/config/library/contenttransfer/checkout/httpcheckout_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
httpeditcontainer
Purpose
This is the WDK 5.3 httpeditcontainer component. It is used to display components that enable
checking out objects and opening them for editing in an associated application via the HTTP protocol.
httpexport (type dm_sysobject)
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\edit\httpeditcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
httpexport (type dm_sysobject)
Purpose
This is the WDK 5.3 httpexport component. It is used to export dm_sysobjects from the repository
to the client file system. This component must run within the 5.3 exportcontainer (see export (type
dm_sysobject), page 999).
httpexport (type dmr_content)
Parameters

objectId (Required) ID of the object to be exported
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\httpexport_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
httpexport (type dmr_content)
Purpose
This is the WDK 5.3 httpexport component. It is used to export dmr_content objects from the
repository to the client file system. This component must run within the 5.3 exportcontainer (see
export (type dmr_content), page 1000).Export of multiple objects creates one export container and an
inner export component instance for each object.
httpexportcontainer
Parameters

objectId (Required) ID of the object to be exported
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\httpexport_component.xml
Scope
type dmr_content
Elements
init-controls
service
httpexportcontainer
Purpose
This is the WDK 5.3 httpexportcontainer component. It is the container for components that enable
exporting objects from repositories to local machines.
Parameters
httpimport
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\export\httpexportcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
httpimport
Purpose
This is the WDK 5.3 httpimport component. It must be used within the httpimportcontainer
component. Using the HTTP protocol, it enables the import of local files into repositories.
Parameters
baseDocbaseType (Optional) Parent object_type of the object_type

of the object to be imported.
docbaseType (Optional) object_type that the file is to be
imported as.
httpimportcontainer
filenameWithPath (Required) True to display the file path with the

file name
localFilePath (Optional) Full path to the file to be imported.
objectId (Required) ID of the target folder for import
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\httpimport_component.xml
Scope
All.
Elements
init-controls
service
httpimportcontainer
Purpose
This is the WDK 5.3 httpimportcontainer component. It is the container for components that use the
HTTP protocol to import local files into repositories.
httpimportcontainer
Parameters

filePath (Optional) Path to the file on the local machine.
object being imported is a directory.
parentPath (Optional) Repository path into which the file is
imported.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\httpimportcontainer_component.
xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
httpimportrendition
httpimportrendition
Purpose
This is the WDK 5.3 httpimportrendition component. It extends the component import, page 1026
and is used to import a single rendition into the repository using the HTTP content transfer. The
component must run within the 5.3 container httpimportrenditioncontainer.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importrendition\httpimportrendition_component.
xml
Scope
All.
Elements
init-controls
service
updatereplicasource
See updatereplicasource, page 751.
httpimportrenditioncontainer
Purpose
This is the WDK 5.3 httpimportrenditioncontainer component. It is the container for components that
are used to import renditions into repositories.
httpmultifiledownload
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importrendition\httpimportrenditioncontainer_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
httpmultifiledownload
Purpose
Displays a list of files to be downloaded over HTTP content transfer. The user will not have to open
multiple windows at the same time to do simultaneous downloads. It is used by all outbound HTTP
content transfer operations when more than one file is selected.
httpview
Parameters
componentArgs (Optional) Not used

contentId (Optional) Array of IDs of selected objects for
download.
Description
Since
5.x
Configuration File
wdk\config\httpmultifiledownload_component.xml
Scope
All.
Elements
None.
httpview
Purpose
This is the WDK 5.3 httpview component. It downloads repository content to the browser local file
system and opens a viewing application on the client. The httpview component must run in the
httpviewcontainer, page 1025 container.
Parameters

(False). Default is false for dm_sysobjects, but
true for dmr_content objects.Since 5.3 SP4.
objectId (Required) ID of the object to be viewed
httpview (type dmr_content)
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\httpview_component.xml
Scope
All.
Elements
init-controls
See isIgnorePrefRenditions, page 738.
service
httpview (type dmr_content)
Purpose
Downloads repository content to the browser local file system and opens a viewing application on
the client. The view component must run in the view (type dmr_content), page 1033 container.
Parameters

(False). Default is true. Since 5.3 SP4.
Description
Since
5.x
httpview (type dmr_content) (Webtop)
Configuration File
webcomponent\config\library\contenttransfer\view\httpview_component.xml
Scope
type dmr_content
Elements
init-controls
service
httpview (type dmr_content) (Webtop)
Purpose
Downloads repository content (of the dmr_content type) to the browser local file system and opens a
viewing application on the client. The view component must run in the WDK httpview container.
Parameters

Description
Since
5.x
Configuration File
webtop\config\httpview_component.xml
httpview (Webtop)
Scope
type dmr_content
Elements
init-controls
service
httpview (Webtop)
Purpose
Downloads repository content to the browser local file system and opens a viewing application on
the client. The view component must run in the WDK httpview container.
Parameters

Description
Since
5.x
Configuration File
webtop\config\httpview_component.xml
Scope
All.
httpviewcontainer
Elements
init-controls
service
httpviewcontainer
Purpose
5.3 container for components that enable (via the HTTP protocol) viewing objects in an associated
application on local machines.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\httpviewcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
import
service
import
Purpose
This is the WDK 5.3 import component. Imports objects from the client file system to the repository.
The component must run within the 5.3 importcontainer or httpimportcontainer.
Parameters
baseDocbaseType (Optional) Parent object_type of the object_type

of the object to be imported.
defaultAttributesValues (Optional) Default attribute values for the object
that is to be imported.
docbaseType (Optional) object_type that the file is to be
imported as.
filenameWithPath (Required) True to display the file path with the
file name
format (Optional) dm_format of the object to be
imported.
localFilePath (Optional) Full path to the file to be imported.
oleScanEnable (Optional) Boolean: Whether to enable (true) or
disable (false) scanning files for OLE links.
Since 6.0 SP1.

imported.
import
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\import_component.xml
Scope
All.
Usage
When the user imports a document and selects a custom type for the document, a format dropdown
list is presented for selecting the associated document format. The custom type must have a template
in order be associated with a format. You must have a template in the Templates cabinet for each
format that will apply to your custom type.
To customize the import layout, use the docbaseattributelist, page 39control. First, create a definition
file that is scoped to each type for which you wish to provide a different set of import attributes, as
described in docbaseattributelist, page 39. In the JSP page for the custom type, add a tag for the
custom attribute list that you wish to display on import. Add a tag similar to the following:
<dmfx:docbaseattributelist
name="attrlist" object="obj" attrconfigid="import"/>
All custom attributes that are in a category appear unless they are listed in the <ignore_attributes>
element. Attributes are displayed in order of category. If the value of showpagesastabs is true, then
the categories are displayed as tabs. You can have different attribute lists for checkin, properties,
import, and other components.
You can add default attribute values on import. The following example from a custom import class
that extends Import adds the value in onInit. It adds a value for a custom date attribute named
doc_date to an ArgumentList instance.
DateTime dtDocDt = (DateTime)getControl("cust_doc_date", DateTime.class);
argumentlist1.add("doc_date", new Long(dtDocDt.toDate().getTime()).toString());
setDefaultAttributesValues(argumentlist1);
Elements
document_filter
folder_filter
folder-docbase-type
importcontainer
init-controls
preset_item
service
ucfrequired
importcontainer
Purpose
This is the WDK 5.3 importcontainer component. It is the container used to display components that
enable the import of local files into repositories.
Parameters

filePath (Optional) Path to the file on the local machine.
imported.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importcontent\importcontainer_component.xml
importrendition
Parent Definition
Scope
All.
Elements
failoverenabled
max-import-files-and-folders
<max-import-files-and-folders>1000</max-import-files-and-folders>
Specifies the maximum number of files and folders that can be imported in a single operation.
<propagatepreviouspagevalues>false</propagatepreviouspagevalues>
Whether the previous page values are propagated to the next page (true) or not (false).
service
ucfrequired
Since 6.0 SP1.
importrendition
Purpose
This is the WDK 5.3 importrendition component. It extends the component import, page 1026 and is
used to import a rendition into the repository. The component must run within the 5.3 container
importrenditioncontainer.
Parameters
importrenditioncontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\importrendition\importrendition_component.xml
Scope
All.
Elements
init-controls
preset_item
service
ucfrequired
updatereplicasource
See updatereplicasource, page 751.
importrenditioncontainer
Purpose
This is the WDK 5.3 importrenditioncontainer component. It is the container for components that
enable the import of renditions into repositories.
Parameters
Description
Since
5.x
locateappviewer
Configuration File
webcomponent\config\library\contenttransfer\importrendition\importrenditioncontainer_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
service
ucfrequired
Since 6.0 SP1.
locateappviewer
Purpose
Enables browsing the local filesystem to find the application with which to view the downloaded
object.
Since
6.5
locateappviewercontainer
locateappviewercontainer
Purpose
Container for the locateappviewer, page 1031 component.
Since
6.5
residentucfinvoker
Purpose
Enables invoking a component using the unified client facilities feature.
Since
6.5
Purpose
This is a WDK 5.3 view component. It is used to download repository content to the browser local
file system and open a viewing application on the client. The view component must run in the
viewcontainer component. This component is defined for dm_sysobject and dmr_content scopes.
The component is undefined for dm_folder using the notdefined attribute, so that folders cannot be
viewed with a viewing application. The viewcontainer extends combocontainer, page 1046.
Parameters
contentType (Optional) Type of object to view

or not to download descendants in a virtual
document.

(False). Default is false.Since 5.3 SP4.
attribute of the object. You should not pass in
your own value for PDF renditions.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\view_component.xml
Scope
type dm_sysobject
Elements
init-controls
service
ucfrequired
Purpose
This is a WDK 5.3 view component. It is used to download repository content to the browser local
file system and open a viewing application on the client. The view component must run in the
viewcontainer component. This component is defined for dm_sysobject and dmr_content scopes.
The component is undefined for dm_folder using the notdefined attribute, so that folders cannot be
viewed with a viewing application. The viewcontainer extends combocontainer, page 1046.
viewcontainer (type dm_sysobject)
Parameters
contentType (Optional) Type of object to view

(False). Default is true.Since 5.3 SP4.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\view_component.xml
Scope
type dmr_content
Elements
init-controls
service
ucfrequired
viewcontainer (type dm_sysobject)
Purpose
This is the WDK 5.3 viewcontainer component. It is the container used to display components that
enable viewing objects in an associated application on a local machine.
viewcontainer (type dmr_content)
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\viewcontainer_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
failoverenabled
service
ucfrequired
viewcontainer (type dmr_content)
Purpose
This is a WDK 5.3 viewcontainer component. It is a container used to display components that
enable viewing objects from repositories.
sendemailcontainer
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\view\viewcontainer_component_dmr.xml
Parent Definition
Scope
type dmr_content
Elements
failoverenabled
service
ucfrequired
Emailing object links
sendemailcontainer
Purpose
Invokes an email client.
sendlocator
Parameters

wfperformers (Optional) User names of the workflow
performers.
wfsupervisor (Optional) User name of the supervisor of the
dm_workflow object.
Description
Since
6.0
Configuration File
webcomponent\config\library\workflow\sendemail\sendemailcontainer_component.xml
Scope
All.
Elements
None.
sendlocator
Purpose
Sends an email link (DRL, see drl, page 793) to one or more selected documents, folders, tasks,
notifications, or quickflow items using the HTML mailto command.
Parameters
objectId (Required) ID of the folder or object for which

to send a locator.
Description
Since
5.x
Configuration File
webcomponent\config\library\sendlocator\sendlocator_component.xml
Scope
All.
Elements
None.
Purpose
Parameters
The parameters are inherited from sendlocator:webcomponent/config/library/sendlocator/
sendlocator_component.xml. See sendlocator, page 1037.
Description
Since
5.x
Configuration File
webcomponent\config\library\sendlocator\sendlocator_workflow_items_component.xml
Parent Definition
sendlocator:webcomponent/config/library/sendlocator/sendlocator_component.xml
Scope
Elements
None.
Purpose
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
type dm_queued
Elements
None.
Purpose
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
type dm_router_task
Elements
None.
Purpose
Parameters
Description
Since
5.x
Configuration File
Parent Definition
sendlocatorcontainer
Scope
type dm_task
Elements
None.
sendlocatorcontainer
Purpose
This component is used to display a sendlocator component, which is used to send an email link
(DRL, see drl, page 793) to one or more selected documents, folders, tasks, notifications, or quickflow
items using the HTML mailto command.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\sendlocator\sendlocatorcontainer_component.xml
Scope
All.
Elements
None.
sendtodistributionlist
sendtodistributionlist
Purpose
Sends objects to users within an ad hoc workflow (also known as quickflow).
Parameters
objectId (Required) ID of the object to send
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\sendto\sendtodistributionlist_component.xml
Scope
All.
Elements
None.
Formats
format_preferences
Purpose
Enables the user to set format preferences for preferred renditions.
Parameters
None.
formatattributes
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\format\format_preferences_component.xml
Scope
All.
Elements
ucfrequired
base_type
formatattributes
Purpose
Displays attributes of objects or creates new objects of type dm_format. This component is contained
within the container formatproperties, page 1044.
Parameters

are displayed. Set to newobject to create a new
format.
Description
Since
5.x
Configuration File
webcomponent\config\admin\format\formatattributes_component.xml
Scope
All.
formatlist
Elements
None.
formatlist
Purpose
Displays a list of formats in the repository (objects of type dm_format).
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\format\formatlist_component.xml
Scope
All.
Elements
None.
formatproperties
Purpose
Extends the container adminpropertycontainer, page 755 and the attributes of format objects or
creates a new format object. Contains the component formatattributes, page 1043.
select_application
Parameters

format.
Description
Since
5.x
Configuration File
webcomponent\config\admin\format\formatproperties_component.xml
Parent Definition
component.xml
Scope
All.
Elements
objecttype
<objecttype>dm_format</objecttype>
select_application
Purpose
Enables the user to select an application from the file system to use as the standard application for a
given rendition or format type. Clicking OK returns the full path of the application to the calling
component as a return parameter.
Parameters
path (Optional) File system path to the folder

displayed as the default starting location.
combocontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\selectapplication\select_application_component.xml
Scope
All.
Elements
None.
General user interface
combocontainer
Purpose
Extends the component wizardcontainer, page 1062 and adds support for multiple instances of the
same contained component. This allows the user to perform multi-select operations for a component.
An Apply to all prompt is displayed when the user selects multiple operations.
Parameters

Description
Since
5.x
container
Configuration File
wdk\config\combocontainer_component.xml
Parent Definition
Scope
All.
Usage
The combo container extends the wizard container and adds support for multiple instances of the
same contained component. This allows the user to perform multi-select operations for a component.
An Apply to All prompt is displayed when the user selects multiple operations. Change notifications
and paging methods are called as appropriate for each button event.
Control values that are changed by the user are propagated to all instances of the control in other
embedded components. For example, a user selects two checked out documents and then selects
Checkin. When the user enters a description for the first file and selects Next, the description is
propagated to the description field of the next file.
Some examples of actions that use the combocontainer include delete, rename, sendto,
removeattachment, abort, halt, or resume workflow.
The parameters, component and componentArgs, are added by the LaunchComponent action
execution class in order to support actions on multiple objects. Do not call the container by URL.
Elements
failoverenabled
<propagatepreviouspagevalues>false</propagatepreviouspagevalues>
Whether the previous page values are propagated to the next page (true) or not (false).
container
Purpose
The container component is a generic container component definition. It is the base component
for all containers.
dialogcontainer
Parameters

is displayed.
Description
Since
5.x
Configuration File
wdk\config\container_component.xml
Scope
All.
Usage
Set requiresVisit attribute to true to declare that a particular component must be visited before the
container can commit changes. In the following example, the attributes component must be viewed
before the user can commit changes:
<contains>
<component>newFolder</component>
<component requiresVisit='true'>attributes</component>
</contains>
You can also declare the visit requirement in the individual component definition. Add the following
tag to a component definition:
<requiresVisitBeforeCommit>true</requiresVisitBeforeCommit>
Elements
failoverenabled
dialogcontainer
Purpose
Extends the container container, page 1047, making a single set of arguments available to a single
contained component and providing a set of dialog buttons.
dialogcontainer
Parameters

is displayed.
subTitle (Optional) Text for the subtitle of the dialog
box.Since 6.0.
title (Optional) Text for the title of the dialog
box.Since 6.0.
Description
Since
5.x
Configuration File
wdk\config\dialogcontainer_component.xml
Parent Definition
container:wdk/config/container_component.xml
Scope
All.
Usage
The dialog container extends the abstract container and adds dialog support for a single contained
component. The dialog layout contains a header and footer. The header includes a title (MSG_TITLE)
and object label (MSG_OBJECT). The footer contains OK (MSG_OK), Cancel (MSG_CANCEL) or
Close (MSG_CLOSE), and Help buttons. Change notifications are called as appropriate for each
button event.
The OK and Cancel buttons are disabled if canCommitChanges() or canCancelChanges() return false,
respectively. If both methods return false, the Close button is displayed.
Some examples of actions that use the dialogcontainer include removeuserorgroup, add_translation
(Web Publisher), newchangeset (Web Publisher). If an action launches a component within
dialogcontainer, the component fills up the entire browser frame. To display the component within
the content frame only, add the <navigation>jump</navigation> element to any location within the
<execution> element.
Elements
failoverenabled
doclist
doclist
Purpose
Displays the contents of a folder as a list of objects and folders. The user can filter the list to see
folders only, documents only, folders and documents, or all objects. The user navigates through a
separate tree frame or by clicking on a folder in the doc list. This component is extended in Webtop
as the objectlist component.
Parameters

to start browsing
showAllVersions (Optional) Set to true to show all versions of the
object
Description
Since
5.x
Configuration File
webcomponent\config\navigation\doclist\doclist_component.xml
Scope
All.
Usage
The doclist and drilldown components have a default set of standard sysobject attributes that are
displayed and formatted in columns. You can also configure columns to be displayed dynamically
based on other attributes. SeeWeb Development Kit Development Guide for more information.
Elements
columns
dragdrop
failoverenabled
doclist (type dm_message_archive)
objectfilters
preset_item
showfilters
doclist (type dm_message_archive)
Purpose
Displays a dm_message_archive object and its dm_message_attachment objects as a list of objects
and folders.
Parameters
folderId (Optional) ID of the folder in which to initially

display.
folderPath (Optional) Path to the folder in which to initially
display.
objectId (Optional) ID of the dm_message_archive object
to display.
Description
Since
6.0
Configuration File
Parent Definition
doclist:webcomponent/config/navigation/doclist/doclist_component.xml
Scope
multiargdialogcontainer
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from doclist:webcomponent/config/navigation/doclist/doclist_
component.xml. See doclist, page 1050.
objectfilters
preset_item
showfilters
multiargdialogcontainer
Purpose
Extends the container dialogcontainer, page 1048 and allows multiple sets of arguments (following a
multi-select in classic view, for example) to be used by a single component contained in this container.
Contains sendtodistributionlist, page 1042.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\multiargdialogcontainer\multiargdialogcontainer_component.xml
navigation (type dm_message_archive) (Webtop)
Parent Definition
Scope
All.
Elements
failoverenabled
navigation (type dm_message_archive) (Webtop)
Purpose
Launches the homecabinet_classic (type dm_message_archive) (Webtop), page 1065 component to
browse a dm_message_archive object and its dm_message_attachment objects in a user’s home
cabinet in classic view.
Parameters

display.
object.
Description
Since
6.0
Configuration File
Scope
Elements
None.
navigationcontainer
navigationcontainer
Purpose
Displays a breadcrumb, title, and drop-down list above an included component to support navigation
to an object from the included component. This container component is a base component and
must be extended in order to add components.
Parameters
component (Required) Contained component.

folderId (Optional) Specifies the primary location of the
specified folder Id
objectId (Required) Selected object.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\navigationcontainer\navigationcontainer_component.xml
Scope
All.
Usage
The navigation container wraps navigation components and provides a header with active
breadcrumb and title controls. The breadcrumb allows the user to navigate to an object that is
displayed, and the drilldown component is updated by the breadcrumb selection. Override this
component definition to jump to another navigation component using a breadcrumb.
The navigationcontainer definition includes a <navigation> element that specifies the type of
navigation.
Some examples of actions that use the navigationcontainer include versions, locations, relationships,
renditions.
navigationcontainer (Webtop)
Elements
None.
navigationcontainer (Webtop)
Purpose
Extends the WDK navigationcontainer component and displays a breadcrumb, title, and drop-down
list above an included component to support navigation to an object from the included component.
This container component is a base component and must be extended in order to add components.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\navigationcontainer_component.xml
Parent Definition
/webcomponent/config/navigation/navigationcontainer/navigationcontainer_component.xml
Scope
All.
Elements
None.
nestedcomponentcontainer
Purpose
Extends the container dialogcontainer, page 1048 and displays Close and Help buttons for the
component that is nested within this container.
objectgrid
Parameters
Description
Since
5.x
Configuration File
wdk\config\nestedcomponentcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
objectgrid
Purpose
Renders the result of a query attached to a data grid.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\objectgrid\objectgrid_component.xml
objectgrid
Scope
All.
Usage
The objectgrid component and the datagrid control can both display objects. The objectgrid
component renders attributes for a single object type. Some examples of components that extend
objectgrid to display objects are locations, relationships, renditions, versions, and history.
In Webtop, components that extend object grid component display a subset of the dm_sysobject
attributes and the folder path for the objects in the result set. If your component doesn’t need to
display attributes other than those of dm_sysobject, you can use the default object grid JSP pages. To
display other dm_sysobject attributes, you must extend this component and modify the JSP page
data fields to display the attributes you wish.
Components that extend ObjectGrid provide the query string by implementing getQuery(String
strVisibleAttrs, ArgumentList args). You must also provide custom JSP pages that display the custom
attributes from your query. For an example of a customized attribute display of the query resultset,
see /webcomponent/library/relationships/relationships.jsp.
Sample override of getQuery (error handling removed):
protected String geQuery(String strVisibleAttrs, ArgumentList args)
{
String strQuery = null;
String strCustomAttr = args.get("customAttr");
strQuery = new StringBuffer(512)
.append("SELECT" ")
.append(strVisibleAttrs)
.append(INTERNAL_attrs)
.append(" from mycustomobject(all) ")
.append("WHERE mycustomattr = '")
.append(strCustomAttr)
.append("')"
.toString();
return strQuery;
}
Elements
columns
header
nondocbasecolumns
streamlineview (type dm_message_archive) (Webtop)
streamlineview (type dm_message_archive)

(Webtop)
Purpose
Displays dm_message objects and their dm_message_attachment objects in the Webtop streamline
view.
Parameters
The parameters are inherited from drilldown:webcomponent/config/library/messagearchive/
messagearchive_component.xml. See drilldown (type dm_message_archive), page 953.
Description
Since
6.0
Configuration File
webtop\config\messagearchive_component.xml
Parent Definition
drilldown:webcomponent/config/library/messagearchive/messagearchive_component.xml
Scope
Elements
None.
streamlineview (Webtop)
Purpose
Extends the WDK drilldown component and displays the Webtop streamline view of folders and
content, adding a title frame at top and status bar frame at bottom. This component is called from a
tab in the tabbar component. This component is the default folder viewing component as defined in
the Webtop component main (Webtop), page 805.
tabbar (Webtop)
Parameters
The parameters are inherited from drilldown:webcomponent/config/navigation/drilldown/
Description
Since
5.x
Configuration File
webtop\config\streamlineview_component.xml
Parent Definition
drilldown:webcomponent/config/navigation/drilldown/drilldown_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from drilldown:webcomponent/config/navigation/drilldown/
objectfilters
preferences
showfilters
tabbar (Webtop)
Purpose
The tabbar component is loaded into a frame iin the Webtop streamlineview component. The UI
contains a tab bar control, tab selection event handlers, and a Docbase selector control.
tabbar (Webtop)
Parameters
entryTab (Optional) Name of the tab (component ID) to

be displayed on the first tab.
refreshOnInit (Optional) Boolean: Whether the content
component is to be initialized during tab bar
initialization (True) or not (False). Defaultis true.
Since 5.3 SP5.
Description
Since
5.x
Configuration File
webtop\config\tabbar_component.xml
Scope
All.
Elements
entrytab
<entrytab>homecabinet_streamline</entrytab>
Specifies the default tab to be selected on entry to the streamline component. Can be overridden by
user preference.
failoverenabled
tabs
1 <tabs>
2<tab componentid="homecabinet_streamline">
3<label>
4<nlsid>MSG_HOME_CABINET</nlsid>
</label>
5<tooltip>
6<nlsid>MSG_HOME_CABINET_TIP</nlsid>
</tooltip>
7<classiccomponent>homecabinet_classic</classiccomponent>
</tab>
...
</tabs>
1 Root element for a structure that specifies tabs that are links to components.
2 The componentid attribute corresponds to a component defined in the application. The component
is displayed when the user clicks a tab.
3 Contains a string or <nlsid> that is displayed on the tab UI.
5 Tip that is displayed on mouseover. Can be string or <nlsid>.
7 Specifies the component to be displayed if the user switches to classic view.
titlebar (Webtop)
titlebar (Webtop)
Purpose
Displays buttons and provides client-side event handlers for advanced search, clipboard, preferences,
logout, and help, and a text field and button for simple search. The titlebar component is included
in the top frame of both the classic and streamline views. There is no dynamic behavior in the title
bar, so no special component class is provided.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\titlebar_component.xml
Scope
All.
Elements
failoverenabled
toolbar (Webtop)
Purpose
Displays action buttons for checkin, checkout, and properties. The tool bar component is included
in the top frame of the classic view UI of the main component.
Parameters
None.
wizardcontainer
Description
Since
5.x
Configuration File
webtop\config\toolbar_component.xml
Scope
All.
Elements
failoverenabled
wizardcontainer
Purpose
Displays a component within a wizard framework, where each layout page (JSP) is presented as a
different page in the wizard. Provides navigation buttons.
Parameters
Description
Since
5.x
Configuration File
wdk\config\wizardcontainer_component.xml
Parent Definition
Scope
All.
componentlist
Usage
The wizard container extends the dialog container and adds wizard navigation support for a single
contained component that has multiple pages. The wizard layout adds Next (MSG_NEXT) and
Previous (MSG_PREVIOUS) buttons.
Component.hasNextPage() and hasPrevPage() are called on the contained component to determine
when to enable and display the next and previous page navigation buttons. The methods
onNextPage() and onPrevPage() are called to switch the contained component page when the user
clicks the Next or Previous button. The component within the container must support onNextPage()
and onPrevPage(), which returns false in the base Component class.
The taskcomponentcontainer in /webcomponent/config/library/workflow/taskmanager extends the
wizardcontainer. Use this component as an example of how to extend the wizardcontainer.
Elements
failoverenabled
Helpers
componentlist
Purpose
Generates a list of components with their scopes and other information. This list can be generated
(after login to the application) through a URL such as the following: http:// host_name:8080/
webtop/component/componentlist/. Displays all components in the application, with links. Each link
displays the name of the config file, NLS bundle, parameters, whether it is a container, whether it
is configurable, the fully qualified class name, and the component description from the component
definition file.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\componentList\component_list.xml
help-index
Scope
All.
Elements
None.
help-index
Purpose
Help files are mapped in the help-index component definition. The help_component.xml
configuration file stores a list of reference entries for HTML help pages. This definition is overridden
by the Webtop help component, which has entries for help topics.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\help\help_component.xml
Scope
All.
Elements
help-entries
See help-entries, page 736.
help-index (Webtop)
Purpose
Specifies context-sensitive map entries for help topics. For information about adding custom or
localized help files to the application, see Web Development Kit Development Guide.
homecabinet_classic (type dm_message_archive) (Webtop)
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\help_component.xml
Parent Definition
help-index:/webcomponent/config/help/help_component.xml
Scope
All.
Elements
help-entries
See help-entries, page 736.
Home Cabinet
homecabinet_classic (type dm_message_archive)

(Webtop)
Purpose
Supports browsing of a dm_message_archive object and its dm_message_attachment objects in a
user’s home cabinet in classic view.
Parameters
The parameters are inherited from homecabinet_list:webcomponent/config/library/messagearchive/
messagearchive_component.xml. See homecabinet_list (type dm_message_archive), page 1070.
homecabinet_classic (Webtop)
Description
Since
6.0
Configuration File
Parent Definition
homecabinet_list:webcomponent/config/library/messagearchive/messagearchive_component.xml
Scope
Elements
columns
Purpose
Supports browsing of the user home cabinet. Users can select cabinets and folders and view their
contents. The visibility of object types is configurable. The component is identical to the doclist
component with the exception that the top-level navigation location is the user’s home cabinet path
instead of the repository root cabinet list.
Parameters

display.
nodeIds (Optional) Nodes to be displayed as the
breadcrumb path.
Description
Since
5.x
homecabinet_drilldown
Configuration File
webtop\config\homecabinet_classic_component.xml
Parent Definition
homecabinet_list:webcomponent/config/navigation/homecabinet/homecabinet_list_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
objectfilters
preset_item
showfilters
homecabinet_drilldown
Purpose
Supports browsing of the user home cabinet contents. The user can select cabinets or folders and drill
down into them to see their contents. The visibility of object types is configurable. The component is
identical to the drilldown component except that the top-level navigation location is the user’s home
cabinet path instead of the repository root cabinet list. Deprecated as of version 6.
Parameters
folderPath (Optional) Specifies the ID of the folder in which

to start browsing.
homecabinet_drilldown (type dm_message_archive)
Description
Since
5.x
Configuration File
webcomponent\config\navigation\homecabinet\homecabinet_drilldown_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
objectfilters
showfilters
homecabinet_drilldown (type dm_message_archive)
Purpose
user’s home cabinet.
Parameters

to start browsing.
objectId (Optional) ID of the dm_message_archive object
to browse.
homecabinet_list
Description
Since
6.0
Configuration File
Parent Definition
homecabinet_drilldown:webcomponent/config/navigation/homecabinet/homecabinet_drilldown_
component.xml
Scope
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from homecabinet_drilldown:webcomponent/config/navigation/
objectfilters
showfilters
homecabinet_list
Purpose
Supports browsing of the user home cabinet. Users can select cabinets and folders and view their
contents. The visibility of object types is configurable. The component is identical to the doclist
component with the exception that the top-level navigation location is the user’s home cabinet path
instead of the repository root cabinet list.
Parameters

to start browsing.
homecabinet_list (type dm_message_archive)
Description
Since
5.x
Configuration File
webcomponent\config\navigation\homecabinet\homecabinet_list_component.xml
Scope
All.
Elements
columns
dragdrop
objectfilters
preset_item
showfilters
homecabinet_list (type dm_message_archive)
Purpose
user’s home cabinet.
Parameters
folderId (Optional) ID of the folder in which to initially

display.
display.
objectId (Optional) ID of the dm_message_archive object.
homecabinet_streamline (type dm_message_archive) (Webtop)
Description
Since
6.0
Configuration File
Parent Definition
homecabinet_list:webcomponent/config/navigation/homecabinet/homecabinet_list_component.xml
Scope
Elements
columns
dragdrop
objectfilters
preset_item
showfilters
homecabinet_streamline (type dm_message_

archive) (Webtop)
Purpose
user’s home cabinet in streamline view.
Parameters
The parameters are inherited from homecabinet_drilldown:webcomponent/config/library/
messagearchive/messagearchive_component.xml. See homecabinet_drilldown (type
dm_message_archive), page 1068.
homecabinet_streamline (Webtop)
Description
Since
6.0
Configuration File
Parent Definition
homecabinet_drilldown:webcomponent/config/library/messagearchive/messagearchive_component.
xml
Scope
Elements
columns
homecabinet_streamline (Webtop)
Purpose
user’s home cabinet in streamline view.
Parameters
The parameters are inherited from homecabinet_drilldown:webcomponent/config/navigation/
Description
Since
6.0
Configuration File
webtop\config\homecabinet_streamline_component.xml
objectlist (type dm_message_archive) (Webtop)
Parent Definition
homecabinet_drilldown:webcomponent/config/navigation/homecabinet/homecabinet_drilldown_
component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from homecabinet_drilldown:webcomponent/config/navigation/
objectfilters
showfilters
objectlist (type dm_message_archive) (Webtop)
Purpose
Displays a list of dm_message_archive objects.
Parameters
The parameters are inherited from doclist:webcomponent/config/library/messagearchive/
messagearchive_component.xml. See doclist (type dm_message_archive), page 1051.
Description
Since
6.0
Configuration File
Parent Definition
doclist:webcomponent/config/library/messagearchive/messagearchive_component.xml
inboxclassic (Webtop)
Scope
Elements
columns
Inbox
inboxclassic (Webtop)
Purpose
Extends the WDK inboxlist component and displays the inbox in a single-selection list format. This
component is a node in the browsertree (Webtop), page 1299 component.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\inboxclassic_component.xml
Parent Definition
inboxlist:webcomponent/config/navigation/inbox/inboxlist_component.xml
Scope
All.
Elements
autogettaskdefault
See autogettaskdefault, page 726.
columns
inboxdrilldown
failoverenabled
This element structure is inherited from inboxlist:webcomponent/config/navigation/inbox/inboxlist_
component.xml. See inboxlist, page 1425.
preset_item
showattachmentinfo
See showattachmentinfo, page 747.
showautogettask
See showautogettask, page 748.
showfilters
taskmanagerid
See taskmanagerid, page 750.
inboxdrilldown
Purpose
Lists the user’s inbox tasks, using a streamline-style layout. Deprecated as of version 6.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\inbox\inboxdrilldown_component.xml
Scope
All.
Elements
autogettaskdefault
columns
inboxstreamline (Webtop)
failoverenabled
showattachmentinfo
showautogettask
showfilters
taskmanagerid
workflowreportactionname
<workflowreportactionname>reportmaindrilldown</workflowreportactionname>
Specifies the action that calls the workflow report page.

See workflowstatusactionname, page 753.
inboxstreamline (Webtop)
Purpose
Extends the WDK inboxdrilldown component and displays the inbox in a drilldown view. This
component is a node in the tabbar (Webtop), page 1059 component.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\inboxstreamline_component.xml
Parent Definition
inboxdrilldown:webcomponent/config/navigation/inbox/inboxdrilldown_component.xml
Scope
All.
jobabort
Elements
autogettaskdefault
columns
failoverenabled
This element structure is inherited from inboxdrilldown:webcomponent/config/navigation/inbox/
inboxdrilldown_component.xml. See inboxdrilldown, page 1075.
showattachmentinfo
showautogettask
showfilters
taskmanagerid
workflowreportactionname
<workflowreportactionname>reportmainstreamline</workflowreportactionname>
Specifies the action that calls the workflow report page.

See workflowstatusactionname, page 753.
Jobs
jobabort
Purpose
Called by the action abortjob, page 462 to abort a running asynchronous action or component job.
Parameters
jobId (Required) ID of the job to abort.
Description
Since
5.x
jobprogressmonitor
Configuration File
webcomponent\config\library\async\jobabort_component.xml
Scope
All.
Elements
None.
jobprogressmonitor
Purpose
Displays the progress of an asynchronous job
Parameters
jobId (Optional) ID of the asynchronous job

pending (Optional) Boolean flag that signals to the
JobProgressMonitor class that the job is
already pending. This flag is set by the content
transfer container class when nesting to the
jobprogressmonitor component.
Description
Since
5.x
Configuration File
webcomponent\config\library\progress\progress_component.xml
Scope
All.
Elements
None.
jobstatus
jobstatus
Purpose
This component displays status and details about every running asynchronous action or component
job.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\async\jobstatus_component.xml
Scope
All.
Elements
None.
jobstatushistory
Purpose
This component displays job history and messages for a selected job.
Parameters
jobId (Required) ID of the selected job.

jobName (Required) Name of the selected job.
renamejobrequestlist
Description
Since
5.x
Configuration File
webcomponent\config\library\async\jobstatushistory_component.xml
Scope
All.
Elements
None.
renamejobrequestlist
Purpose
Displays jobs that rename users or groups
Parameters
renametarget (Optional) Type of objects to be renamed. Valid

values: user | group. Default = user
Description
Since
5.x
Configuration File
webcomponent\config\admin\renamelog\renamejobrequestlist_component.xml
Scope
All.
Elements
None.
alllifecyclelocator
Lifecycles
alllifecyclelocator
Purpose
Locates dm_policy objects in a repository.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\lifecyclelocators_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
columns
objecttype
<objecttype>dm_policy</objecttype>

flatlist
1 <flatlist>true</flatlist>
allversionsvisible
preset_item
containerselectable
views
Purpose
Applies a lifecycle to the selected object. It displays the available lifecycles in the system. Contains
applylifecycleall (type dm_sysobject), page 1083.
applylifecycleall (type dm_sysobject)
Parameters
component (Required) Name of the component within the

container
componentArgs (Optional) List of arguments and values to pass
objectId (Required) ID of the object to which a lifecycle
shall be applied
Description
Since
5.x
Configuration File
webcomponent\config\library\applylifecycle\applylifecyclecontainer_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
multidocbasesupport
applylifecycleall (type dm_sysobject)
Purpose
Applies a lifecycle to all selected objects.
lifecyclefolderlocator
Parameters
objectId (Required) ID of the object to which the lifecycle

shall be applied
Description
Since
5.x
Configuration File
webcomponent\config\library\applylifecycle\applylifecycle_all_component.xml
Scope
type dm_sysobject
Elements
None.
Purpose
Extends the component sysobjectlocator, page 969 and displays in a folder view all objects with
attached lifecycles.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
iconwell_icon
columns
objecttype

flatlist
allversionsvisible
1 <allversionsvisible>true</allversionsvisible>
containerselectable
lifecyclelocatorcontainer
views
lifecyclelocatorcontainer
Purpose
Extends the container locatorcontainer, page 960 and contains lifecyclelocator components:
alllifecyclelocator, page 1081, lifecyclesubscriptionlocator, page 1087, lifecyclefolderlocator, page
1084, and recentlifecyclelocator, page 1088.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
lifecyclesubscriptionlocator
lifecyclesubscriptionlocator
Purpose
Extends subscriptionlocator, page 1252 and displays subscribed lifecycle objects.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
iconwell_icon
columns
objecttype

flatlist
allversionsvisible
recentlifecyclelocator
containerselectable
views
recentlifecyclelocator
Purpose
Locates lifecycles that were recently selected or used. This component has no scope, but the
<objecttype> element restricts the search to objects of type dm_policy.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
iconwell_icon
selectlifecycle (type dm_sysobject)
columns
objecttype

containerselectable
views
selectlifecycle (type dm_sysobject)
Purpose
Selects a lifecycle.
Parameters
type (Required) Object type of the lifecycle.
Description
Since
6.0
Configuration File
webcomponent\config\library\applylifecycle\selectlifecyclecontainer_component.xml
Parent Definition
Scope
type dm_sysobject
findtarget (Webtop)
Elements
multidocbasesupport
Locating objects
findtarget (Webtop)
Purpose
repository.
Parameters

a folder.
Description
Since
5.x
Configuration File
webtop\config\findtarget_component.xml
Scope
All.
Elements
None.
choosetransformationtype
choosetransformationtype
Purpose
A transformation selection component. Requires Media Transformation Services. Enables the user
to select the available media profiles.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\choosetransformationtype_component.xml
Scope
All.
Elements
None.
transformationapplylifecycle (type dm_sysobject)
Purpose
Applies a lifecycle (business policy) to the selected transformed dm_sysobject object. Requires Media
Transformation Services.
transformationapplylifecycle (type dmr_content)
Parameters

objectId (Optional) ID of the transformed object to which
a lifecycle will be applied.
objectType (Required) Content type of the object.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationapplylifecycle_component.xml
Parent Definition
transformationapplylifecyclecontainer:webcomponent/config/library/transformation/
transformationapplylifecyclecontainer_component.xml
Scope
type dm_sysobject
Elements
None.
transformationapplylifecycle (type dmr_content)
Purpose
Applies a lifecycle (business policy) to the selected transformed dmr_content object. Requires Media
Transformation Services.
Parameters

transformationapplylifecycleall (type dm_sysobject)
Description
Since
5.x
Configuration File
Parent Definition
transformationapplylifecyclecontainer:webcomponent/config/library/transformation/
transformationapplylifecyclecontainer_component.xml
Scope
type dmr_content
Elements
None.
transformationapplylifecycleall (type dm_sysobject)
Purpose
Applies a lifecycle (business policy) to all the selected transformed dm_sysobject objects. Requires
Parameters

Description
Since
5.x
Configuration File
transformationapplylifecycleall (type dmr_content)
Parent Definition
applylifecycleall:webcomponent/config/library/applylifecycle/applylifecycle_all_component.xml
Scope
type dm_sysobject
Elements
None.
transformationapplylifecycleall (type dmr_content)
Purpose
Applies a lifecycle (business policy) to all the selected transformed dmr_content objects. Requires
Parameters

Description
Since
5.x
Configuration File
Parent Definition
applylifecycleall:webcomponent/config/library/applylifecycle/applylifecycle_all_component.xml
Scope
type dmr_content
Elements
None.
transformationapplylifecyclecontainer
transformationapplylifecyclecontainer
Purpose
Base container for the transformationapplylifecycle component. Requires Media Transformation
Services.
Parameters
The parameters are inherited from applylifecycle:webcomponent/config/library/applylifecycle/
applylifecyclecontainer_component.xml. See applylifecycle (type dm_sysobject), page 1082.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationapplylifecyclecontainer_component.
xml
Parent Definition
applylifecycle:webcomponent/config/library/applylifecycle/applylifecyclecontainer_component.xml
Scope
All.
Elements
transformationcontainer
Purpose
Base container for transformation. Requires Media Transformation Services.
transformationcontainernewobject
Parameters

Supplied by the action execution class).
componentArgs (Required) List of arguments and values to pass
folderId (Optional) Not used.
objectId (Required) ID of the transformed object.
renditionId (Optional) ID of the content selected for
transformation.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationcontainer_component.xml
Parent Definition
Scope
All.
Elements
transformation
See transformation, page 750.
numberedtabs
transformationcontainernewobject
Purpose
Transformation container for the new object. Requires Media Transformation Services.
transformationcontainerrendition
Parameters
The parameters are inherited from transformationcontainer:webcomponent/config/library/
transformation/transformationcontainer_component.xml. See transformationcontainer, page 1095.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationcontainer_newobject_component.xml
Parent Definition
transformationcontainer:webcomponent/config/library/transformation/transformationcontainer_
component.xml
Scope
All.
Elements
transformation
transformationcontainerrendition
Purpose
Transformation container for the new rendition. Requires Media Transformation Services.
Parameters
The parameters are inherited from transformationcontainer:webcomponent/config/library/
transformation/transformationcontainer_component.xml. See transformationcontainer, page 1095.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationcontainer_rendition_component.xml
transformationdetails
Parent Definition
transformationcontainer:webcomponent/config/library/transformation/transformationcontainer_
component.xml
Scope
All.
Elements
transformation
transformationdetails
Purpose
Specifies transformation details for an object. Requires Media Transformation Services.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationdetails_component.xml
Scope
All.
Elements
controlproperties
1 <controlproperties>
2<textareanumcols value="32"></textareanumcols>
3<textareanumrows value="5"></textareanumrows>
4<thumbnailheight value="40"></thumbnailheight>
5<thumbnailwidth value="40"></thumbnailwidth>
6<listboxsize value="5"></listboxsize>
7<colorpickernumrows value="24"></colorpickernumrows>
8<colorpickerwidth value="200"></colorpickerwidth>
transformationnewobjectdef
9<colorpickerheight value="20"></colorpickerheight>
</controlproperties>
1 Contains specifications for the control.

2 Number of columns of the text block.
3 Number of rows of the text block.
4 Height of the content object thumbnail .
5 Width of the content object thumbnail.
6 Size of the list box .
7 Number of rows of the color picker.
8 Width of the color picker.
9 Height of the color picker.
transformationnewobjectdef
Purpose
Provides definition of the new transformation object. Requires Media Transformation Services.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationnewobjectdef_component.xml
Scope
All.
Elements
showaliasset
<showaliasset>false</showaliasset>
Whether to display (true) the alias set or not (false).
transformationselect
transformationselect
Purpose
A transformation selection component. Requires Media Transformation Services. Enables the user
to select the available media profiles.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\transformation\transformationselect_component.xml
Scope
All.
Elements
None.
Menus
menubar
Purpose
Adds a bar of menu controls.
Parameters
accessible (Optional) Set to true to render menu selections

accessible (Section 508 compliant)
menubar (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\menubar\menubar_component.xml
Scope
All.
Elements
menugrouptarget
See menugrouptarget, page 739.
failoverenabled
menuconfigids
1 <menuconfigids>
2<id>menubar_file_menu</id>
...
</menuconfigids>
1 Contains <id> elements that identify <menuconfig> elements.

2 A string that corresponds to the ID attribute of a <menuconfig> element.
menubar (Webtop)
Purpose
Adds a bar of menu controls in the top frame of workarea.jsp (the content frame of the Webtop
classic view). The menubar component loads into a frame of the workarea.jsp (part of the main
component set of JSP pages).
Parameters
The parameters are inherited from menubar:/webcomponent/config/library/menubar/menubar_
component.xml. See menubar, page 1100.
messagearchiveattach (type dm_message_archive)
Description
Since
5.x
Configuration File
webtop\config\menubar_component.xml
Parent Definition
menubar:/webcomponent/config/library/menubar/menubar_component.xml
Scope
All.
Elements
menugrouptarget
See menugrouptarget, page 739.
failoverenabled
menuconfigids
See menuconfigids, page 1101.
Message archives
messagearchiveattach (type dm_message_archive)
Purpose
Provides user interface and behaviour for displaying and editing a dm_message_archive object’s
attachement attributes.
Since
6.5
messagearchiveattachlocations
messagearchiveattachlocations
Purpose
Lists the email message to which the selected attachment object is linked.
Since
6.5
messagearchiveattachlocations (Webtop)
Purpose
Lists the email message to which the selected attachment object is linked.
Since
6.5
My Files
mydocumentlocator
Purpose
Extends myobjectlocator, page 1107 and displays all objects of type dm_document or its subtypes
that are owned by the user. The scope is not defined, but the <objecttype> element restricts this
component to dm_document objects.
Parameters
The parameters are inherited from myobjectlocator:webcomponent/config/library/locator/
myobjectlocator_component.xml. See myobjectlocator, page 1107.
mydocumentlocator
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
objecttype

views
columns
containerselectable
flatlist
allversionsvisible
myfiles_classic (Webtop)
modifiedwithindays
myfiles_classic (Webtop)
Purpose
Lists objects that are checked out or recently used by the user. The time interval since last modified
date, as a criterion for display, is configurable.
Description
Since
5.x
Configuration File
webtop\config\myfiles_classic_component.xml
Parent Definition
myobjects_list:/webcomponent/config/library/myobjects/myobjects_list_component.xml
Scope
All.
Elements
showfolders
failoverenabled
columns
preset_item
objecttype
myfiles_streamline (Webtop)
modifiedwithindays
myfiles_streamline (Webtop)
Purpose
Displays a folder frame and a folder contents frame for folders that contain objects checked out or
recently edited by the user.
Description
Since
5.x
Configuration File
webtop\config\myfiles_streamline_component.xml
Parent Definition
myobjects_drilldown:/webcomponent/config/library/myobjects/myobjects_drilldown_component.
xml
Scope
All.
Elements
failoverenabled
columns
objecttype

showfolders
modifiedwithindays
preferences
myobjectlocator
myobjectlocator
Purpose
Extends sysobjectlocator, page 969 and displays all sysobjects that are owned by the user.
Parameters

drop-down list
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\myobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
columns
objecttype

containerselectable
myobjects_drilldown
flatlist
allversionsvisible
modifiedwithindays
views
myobjects_drilldown
Purpose
Displays a folder frame and a folder contents frame for folders that contain objects owned by the user.
Parameters
None.
Description
Since
5.x
attributes (type dmc_prm_library_request)
Configuration File
webcomponent\config\library\myobjects\myobjects_drilldown_component.xml
Scope
All.
Elements
failoverenabled
columns
objecttype

showfolders
modifiedwithindays
preferences
Physical Records Manager
attributes (type dmc_prm_library_request)
Purpose
Displays the attributes of a dmc_prm_library_request object.
Parameters
None.
Description
Since
6.0
dmc_prm_address_locatorcontainer
Configuration File
webcomponent\config\library\records\request\attributes_prm_library_request_component.xml
Scope
Elements
showpagesastabs
dmc_prm_address_locatorcontainer
Purpose
Container for the dmc_prm_addresslocator, page 1111 component.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\records\locator\prm_address_locator_container.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
dmc_prm_addresslocator
dmc_prm_addresslocator
Purpose
Contains dmc_prm_physical_address objects.
Parameters
attachedDocIds (Optional)
Description
Since
6.0
Configuration File
webcomponent\config\library\records\locator\prm_address_locator_container.xml
Parent Definition
allfolderlocator:webcomponent/config/library/locator/folderlocators_component.xml
Scope
All.
Elements
allversionsvisible
containerselectable
flatlist
iconwell_icon
makelibraryrequest
objecttype
<objecttype>dmc_prm_address</objecttype>

views
makelibraryrequest
Purpose
Creates a library request (dmc_prm_library_request object).
Parameters
objectId (Required) Object ID of the dmc_prm_library_

request object to create.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\make_prm_library_request_component.xml
Scope
All.
Elements
None.
makelibraryrequestcontainer
makelibraryrequestcontainer
Purpose
Contains the makelibraryrequest, page 1112 component.
Parameters

Supplied by the action execution class.
componentArgs (Optional) List of arguments and values to pass
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\make_prm_library_request_container_component.
xml
Parent Definition
Scope
All.
Elements
failoverenabled
pendingtargets
Purpose
Displays a list of all pending items in a library request.
properties (type dmc_prm_library_request)
Parameters
objectId (Required) Object ID of the library request

object.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\pending_targets_component.xml
Scope
All.
Elements
None.
properties (type dmc_prm_library_request)
Purpose
Displays the properties of dmc_prm_library_request objects.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\prm_library_request_properties_component.xml
Parent Definition
requestedtargets
Scope
Elements
commitorder
failoverenabled
requestedtargets
Purpose
Displays a list of all items in a library request.
Parameters
objectId (Required) Object ID of the library request

object.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\requested_targets_component.xml
Scope
All.
Elements
None.
userrequestlist (entitlement prm, role dmc_prm_library_user)
userrequestlist (entitlement prm, role

dmc_prm_library_user)
Purpose
Displays a list of a user’s library requests.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\request\user_request_list.xml
Scope
entitlement prm
Elements
None.
Preferences
columnselector
Purpose
Edits display preferences. The JSP page contains an attributeselector control that generates the lists of
columns, selected columns, and selection buttons.
columnselector
Parameters
columns (Required) A serialized list of items to populate

the available items list box. See multiselector
control for details on the list format.
defaultSelectedColumns (Optional) A serialized list of items to populate
the selected items list box before the user
performs an initial selection.
docbaseTypes (Optional) Specifies the repository types, in
addition to the default option, to populate the
attribute selectors docbase types drop-down list.
If omitted, no docbase types will be available
for selection. This is a simple list of alternating
type names and values. To pass in as a string
argument to the column selector, the list may be
passed to ColumnListUtil.
enableOrdering (Optional) Boolean: true to enable the user to
control the order of columns.
selectedColumns (Optional) A serialized list of items to populate
the selected columns list box.
showRepeatingAttributes (Optional) Specifies whether repeating attributes
should be shown when selecting one of the
repository types specified by docbasetypes.
Default is true.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\display\columnselector_component.xml
Scope
All.
Usage
The onCommitChanges method sets a list of return values by calling Form.setReturnValue. If your
component nests to the columnselector component and implements IReturnListener, you can get the
values from the Map instance with the onReturn(Form form, Map map) method.
Elements
None.
columnselectorcontainer
columnselectorcontainer
Purpose
Edits display preferences. The JSP page contains an attributeselector control that generates the lists of
columns and selected columns and the selection buttons.
Parameters

class. The name of the component to contain.
displaytitle (Optional) A title for the component.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\display\columnselectorcontainer_component.
xml
Parent Definition
Scope
All.
Elements
failoverenabled
component_preferences
Purpose
Enables users to set preferences for portals.
debug_preferences
Parameters
componentid (Optional) For internal use only.

context (Optional) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\portal\component\component_preferences_
component.xml
Scope
All.
Elements
None.
debug_preferences
Purpose
Sets debugging preferences during application development. This component is designed to run
within the preferences component, which is a property sheet container.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\debug\debug_preferences_component.xml
display_preferences
Scope
All.
Elements
None.
display_preferences
Purpose
Sets the user’s preferences for the columns to be displayed by another component. This component
is presented within the preferences container. Displays the following (generated by the preference
control): the component’s list of columns in the order they will appear, and checkboxes (if
appropriate) to use the cabinets view and to use thumbnails.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\display\display_preferences_component.xml
Scope
All.
Usage
WDK display preferences are edited by the columnselector component. The editing component is
configurable as the value of the display_preferences <editcomponent> element. You cannot display
an attribute if is_searchable is set to false. For more information on configuring display preferences,
see WDK Development Guide.
Elements
See preferencedisplaygroups, page 742.
preferences
display_preferences (version 5.3) (Webtop)
display_preferences (version 5.3) (Webtop)
Purpose
Sets the user’s preferences for the columns to be displayed by another component.
Description
Since
6.0
Configuration File
webtop\config\display_preferences_component.xml
Parent Definition
display_preferences:webcomponent/config/environment/preferences/display/display_preferences_
component.xml
Scope
version 5.3
As of 6.5: Changed from “5.3.0” to “5.3”.
Elements
preferences
display_preferences (Webtop)
Purpose
Sets the user’s preferences for the columns to be displayed by another component.
Parameters
None.
format_pref_attr_selector
Description
Since
6.0
Configuration File
webtop\config\display_preferences_ex_component.xml
Parent Definition
display_preferences:webcomponent/config/environment/preferences/display/display_preferences_
component.xml
Scope
All.
Elements
preferences
Purpose
Enables selection of the attributes for a preferred rendition setting.
Parameters
editApp (Optional) Name of the application to edit

content of the specified preferred rendition
format.
isEditing (Optional) Boolean: Whether the format is
already being edited (True) or not (False).
preferredRenditionFormat (Optional) Name of the preferred rendition
format.
type (Optional) Object type to which the preferred

rendition setting applies.
viewApp (Optional) Name of the application to view
content of the specified preferred rendition
format.
Description
Since
6.0
Configuration File
webcomponent\config\environment\preferences\format\format_preference_attr_selector_
component.xml
Parent Definition
format_preferences:webcomponent/config/environment/preferences/format/format_preferences_
component.xml
Scope
All.
Caller
editformatpref, page 487
Usage
If the isEditing parameter value that was passed from the editformatpref, page 487 action is true,
this component sets the values of its controls to the values of the passed parameters. If the isEditing
parameter value that was passed from the editformatpref, page 487 action is false, then the controls
are populated with string values that prompt the user to input a value (for example, Choose an
object type). When the user clicks OK in this component, the format preference is passed to the
format_preferences_summary, page 1124 component and displays them. When the user saves
the changes in the format_preferences_summary, page 1124 component, the format preference is
committed to the repository.
Elements
base_type
ucfrequired
format_preferences_summary
format_preferences_summary
Purpose
Displays the current set of format preferences and allow a user to add, edit and delete specific format
preferences.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\environment\preferences\format\format_preferences_summary_
component.xml
Scope
All.
Usage
When the user saves the format preferences in this component, the format preferences are committed
to the repository.
Elements
None.
formatpreferencescontainer
Purpose
Container for the format_preferences_summary, page 1124 component that enables users to set
format preferences.
Parameters
general_preferences
Description
Since
6.0
Configuration File
webcomponent\config\environment\preferences\format\format_preferences_container_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
ucfrequired
general_preferences
Purpose
Enables the user to select a UI theme and the startup location.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\general\general_preferences_component.xml
Scope
All.
general_preferences (version 5.3) (Webtop)
Elements
None.
general_preferences (version 5.3) (Webtop)
Purpose
Description
Since
5.x
Configuration File
webtop\config\general_preferences_component.xml
Parent Definition
general_preferences:webcomponent/config/environment/preferences/general/general_preferences_
component.xml
Scope
version 5.3
As of 6.5: Changed from “5.3.0” to “5.3”.
Elements
None.
general_preferences (Webtop)
Purpose
portal_preferences
Description
Since
6.0
Configuration File
webtop\config\general_preferences_ex_component.xml
Parent Definition
general_preferences:webcomponent/config/environment/preferences/general/general_preferences_
component.xml
Scope
All.
Elements
None.
portal_preferences
Purpose
Enables users to set preferences for portals..
Parameters
The parameters are inherited from propertysheetcontainer:wdk/config/propertysheetcontainer_
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\portal\portal_preferences_component.xml
Parent Definition
portlet_preferences
Scope
All.
Elements
failoverenabled
ucfrequired
portlet_preferences
Purpose
Enables users to set preferences for portlets. For internal use only.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\portal\portlet\portlet_preferences_component.
xml
Parent Definition
Scope
All.
Elements
failoverenabled
preferences
preferences
Purpose
Extends the propertysheet container. Launched by the preferences action to contain several
preferences components.
Parameters
Since 6.0 SP1.

refreshclient (Optional) Set to true to refresh the page once
the user has restored all preferences.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\preferences_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
ucfrequired
visiblerepository_preferences
visiblerepository_preferences
Purpose
Enables the user to select repositories that will be visible in the login dialog. The repositories that
are displayed for selection are those that are accessible to the connection brokers in the user’s
preferred connection broker list. The user can select or enter new connection brokers by clicking the
Configure connection broker link.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\visiblerepository\visiblerepository_preferences_
component.xml
Scope
All.
Elements
None.
Presets
deletepreset (type dmc_preset_package)
Purpose
Deletes dmc_preset_package objects.
deletepresetcombocontainer (type dmc_preset_package)
Parameters
objectName (Required) Name of the dmc_preset_package

object to delete.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\delete\deletepreset_component.xml
Scope
Elements
None.
deletepresetcombocontainer (type dmc_preset_

package)
Purpose
Displays dmc_preset_package objects to delete.
Parameters
Description
Since
6.0
Configuration File
migratepresets
Parent Definition
Scope
Elements
failoverenabled
migratepresets
Purpose
Prepare preset objects to be deployed to a production repository.
Parameters
objectName (Required) Object name of the preset to prepare

for migration.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\presets\migrate\migratepreset_component.xml
Scope
All.
presetactionitem
Usage
ACL object ID references are udpated to use object_name and owner_name. Location folder object
ID references are updated with aspects. Repository scope references are updated to production
repository scopes.
Elements
None.
presetactionitem
Purpose
Enables editiing preset action items.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetactionitem_component.xml
Scope
All.
Elements
menuconfigs
1 <menuconfigs>
2<menuconfig>
3<id>menubar_file_menu</id>
4<nlsbundle>com.documentum.webcomponent.library.menubar.MenuBarNlsProp</nlsbundle>
</menuconfig>
...
</menuconfigs>
1 Specifies a menu items in a menubar.

2 Specifies a single menu item.
3 Specifies the ID of a menu item.
4 Specifies the NLS bundle for the menu.
presetallfolderlocator
See preset_item_definition, page 744.
presetallfolderlocator
Purpose
Locates all preset folders in a repository and displays them in a hierarchical view.
Parameters
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\locator\presetlocationlocators_component.xml
Parent Definition
Scope
All.
Elements
None.
presetautoattributesitem
Purpose
Enables editing of preset auto attributes items.
presetdocbasenamescope
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetautoattributesitem_component.xml
Scope
All.
Elements
basetype
<basetype>dm_document</basetype>
Specifies the base object type.

excludetypes
<excludetypes>dm_folder</excludetypes>
A list of comma-separated object types to be excluded.

presetdocbasenamescope
Purpose
Enables setting repository scope for presets.
Parameters
None.
Description
Since
6.0
preseteditorcontainer
Configuration File
webcomponent\config\library\presets\scopes\presetdocbasenamescope_component.xml
Scope
All.
Elements
See preset_scope_definitions, page 745.
show_selections
Sets the initial display of selections to expanded (true) or collapsed (false).
Since 6.0 SP1.
preseteditorcontainer
Purpose
Container for the presetscopes, page 1148 and presetitems, page 1138 components.
Parameters

objectName (Optional) Name of the preset object.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\preseteditorcontainer_component.xml
Parent Definition
Scope
All.
presetformatitem
Elements
numberedtabs
presetformatitem
Purpose
Enables editing preset formats.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetformatitem_component.xml
Scope
All.
Elements
presetgroupitem
Purpose
Enables editing preset group items.
Parameters
None.
presetitems
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetgroupitem_component.xml
Scope
All.
Elements
groupfilters
1 <groupfilters>
2<groupfilter>
3<group_class>
4<nlsid>MSG_ALL_FILTER</nlsid>
</group_class>
5<label>
6<nlsid>MSG_ALL_FILTER</nlsid>
</label>
</groupfilter>
...
</groupfilters>
1 Specifies a filter for groups.
presetitems
Purpose
Enables editing preset items.
Parameters
None.
Description
Since
6.0
presetlifecycleitem
Configuration File
webcomponent\config\library\presets\items\presetitems_component.xml
Scope
All.
Elements
preset_item_editors
1 <preset_item_editors>
2<preset_item_editor>
3<componentname>presetpermissionitem</componentname>
4<label>
5<nlsid>MSG_PERMISSION_EDITOR</nlsid>
</label>
</preset_item_editor>
...
</preset_item_editors>
show_summary
<show_summary>true</show_summary>
Whether to initially display the summary (true) or not (false).
presetlifecycleitem
Purpose
Enables selecting a lifecycle for a preset.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetlifecycleitem_component.xml
Scope
All.
presetlist
Elements
presetlist
Purpose
Displays a list of available presets.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\admin\presetlist\presetlist_component.xml
Scope
All.
Elements
columnpreferenceid
columns
presetlocationlocatorcontainer
Purpose
Enables navigating preset cabinets and folders.
presetlocationscope
Parameters
Since 6.0 SP1.


selected.
Description
Since
6.0
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
presetlocationscope
Purpose
Enables setting location scope for a preset.
Parameters
None.
presetnavigationitem
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\scopes\presetlocationscope_component.xml
Scope
All.
Elements
show_selections
Since 6.0 SP1.
presetnavigationitem
Purpose
Sets preferences for the preset navigation editor.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetnavigationitem_component.xml
Scope
All.
presetobjectlocator
Elements
exclude_node
Excludes navigation nodes in this component. For example, in this component’s configuration file,
the administration node is not displayed:
<navigation_exclusion_nodes>
<exclude_node>administration</exclude_node>
</navigation_exclusion_nodes>
presetobjectlocator
Purpose
Enables locating preset objects.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\locator\presetobjectlocators_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
presetobjectlocatorcontainer
containerselectable
iconwell_icon
objecttype
<objecttype>dmc_preset_package</objecttype>

views
presetobjectlocatorcontainer
Purpose
Contains the presetobjectlocator, page 1143 component to locate dmc_preset_package objects.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\locator\presetobjectlocators_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
Purpose
Enables locating dmc_preset_package objects.
Parameters

Description
Since
6.0
Configuration File
webcomponent\config\library\locator\presetobjecttypelocatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
attributes
presetobjecttypelocatorcontainer
columns
iconwell_icon
objecttype
<objecttype>dm_type</objecttype>

views
presetobjecttypelocatorcontainer
Purpose
Contains the presetobjecttypelocator, page 1145 component to locate dmc_preset_package objects.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\locator\presetobjecttypelocatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
presetotherdocbaselocationeditor
presetotherdocbaselocationeditor
Purpose
Enables editing locations in other repositories to which a preset is applied.
Parameters
None.
Description
Since
6.0 SP1
Configuration File
Scope
All.
Usage
Although you can remove a location preset in another repository directly in this component, to add a
location preset, you must log into the repository.
Elements
iconwell_icon
presetpermissionitem
Purpose
Enables defining permission sets as preset items.
Parameters
None.
presetscopes
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presetpermissionitem_component.xml
Scope
All.
Elements
presetscopes
Purpose
Enables defining scopes for a dmc_preset_package object.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\scopes\presetscopes_component.xml
Scope
All.
Elements
preset_scope_editors
1 <preset_scope_editors>
2<preset_scope_editor>
3<componentname>presetusergrouprolescope</componentname>
4<label>
5<nlsid>MSG_USER_GROUP_ROLE_SCOPE</nlsid>
</label>
presettemplateitem
</preset_scope_editor>
...
</preset_scope_editors>
presettemplateitem
Purpose
Enables defining items for a preset template.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presettemplateitem_component.xml
Scope
All.
Elements
presettypeitem
Purpose
Enables defining object types as preset items.
Parameters
None.
presettypescope
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\items\presettypeitem_component.xml
Scope
All.
Elements
presettypescope
Purpose
Enables setting the object type scope for a preset.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\scopes\presettypescope_component.xml
Scope
All.
Elements
show_selections
presetusergrouprolescope
Since 6.0 SP1.
presetusergrouprolescope
Purpose
Enables setting a user, group, or role scope for a preset.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\scopes\presetusergrouprolescope_component.xml
Scope
All.
Elements
show_selections
Since 6.0 SP1.
presetwizardcontainer
Purpose
Contains the presetscopes, page 1148 and presetitems, page 1138 components to enable creating
and modifying dmc_preset_package objects.
presetworkflowitem
Parameters

objectName (Optional) Name of the dmc_preset_package

object to modify.
Description
Since
6.0
Configuration File
webcomponent\config\library\presets\presetwizardcontainer_component.xml
Parent Definition
Scope
All.
presetworkflowitem
Purpose
Enables setting the workflows that can be started for a preset.
Parameters
None.
Description
Since
6.0
assemblylist (type dmc_rm_formal_record) (Webtop)
Configuration File
webcomponent\config\library\presets\items\presetworkflowitem_component.xml
Scope
All.
Elements
Records Manager
assemblylist (type dmc_rm_formal_record) (Webtop)
Purpose
Displays the structure of a virtual document snapshot for a dmc _rm_formal_record object.
Parameters
The parameters are inherited from vdmlist:webcomponent/config/navigation/vdm/vdmlist_
component.xml. See vdmlist, page 1371.
Description
Since
6.0
Configuration File
webtop\config\recordlist_component.xml
Parent Definition
vdmlist:webcomponent/config/navigation/vdm/vdmlist_component.xml
Scope
type dmc_rm_formal_record
assemblyliststreamline (type dmc_rm_formal_record) (Webtop)
Elements
dragdrop
columns
preset_item
See default_binding_filter_values, page 731.
assemblyliststreamline (type dmc_rm_formal_

record) (Webtop)
Purpose
Displays the structure of a virtual document snapshot for a dmc_rm_formal_record object in
drilldown (streamline) view.
Parameters
The parameters are inherited from vdmliststreamline:webcomponent/config/navigation/vdm/
vdmliststreamline_component.xml. See vdmliststreamline, page 1373.
Description
Since
6.0
Configuration File
webtop\config\recordliststreamline_component.xml
Parent Definition
vdmliststreamline:webcomponent/config/navigation/vdm/vdmliststreamline_component.xml
Scope
Elements
dragdrop
attributes (type dmc_rm_formal_rec_folderdmc_rm_formal_rec_cabinet)
columns
attributes (type dmc_rm_formal_rec_folderdmc_rm_

formal_rec_cabinet)
Purpose
Displays the primary attributes of the selected dmc_rm_formal_record object or
dmc_rm_formal_rec_cabinet and includes a link to expand the attributes list or to display all
attributes. Requires a Records Manager license.
Parameters
The parameters are inherited from xforms:webcomponent/config/xforms/xforms_component.xml.
See xforms, page 1546.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\attribute_rm_formalfolder_component.xml
Parent Definition
recordattributes:webcomponent/config/library/records/declarerecord/attribute_rm_formalrecord_
component.xml
Scope
type dmc_rm_formal_rec_folder, dmc_rm_formal_

rec_cabinet
Elements
None.
attributes (type dmc_rm_formal_record)
attributes (type dmc_rm_formal_record)
Purpose
Displays the primary attributes of the selected dmc_rm_formal_record object or
dmc_rm_formal_rec_cabinet and includes a link to expand the attributes list or to display all
attributes. Requires a Records Manager license.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\records\declarerecord\attribute_rm_formalrecord_component.xml
Parent Definition
recordattributes:webcomponent/config/library/records/declarerecord/attribute_rm_formalrecord_
component.xml
Scope
Elements
None.
cancelcheckout (type dmc_rm_formal_record)
Purpose
Cancels the checkout of one or more previously checked out dmc_rm_formal_record objects by
removing the lock on the specified objects.
cancelcheckoutcontainer (type dmc_rm_formal_record)
Parameters
The parameters are inherited from cancelcheckout:/webcomponent/config/library/contenttransfer/
cancelcheckout/cancelcheckout_component.xml. See cancelcheckout (type dm_sysobject), page 984.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\cancelcheckout\cancelcheckout_component.xml
Parent Definition
cancelcheckout:/webcomponent/config/library/contenttransfer/cancelcheckout/cancelcheckout_
component.xml
Scope
Elements
ucfrequired
service
init-controls
cancelcheckoutcontainer (type dmc_rm_formal_

record)
Purpose
Allows users to remove the lock on specified checked-out dmc_rm_formal_record objects.
Parameters
checkin (type dmc_rm_formal_record)
Description
Since
5.x
Configuration File
webcomponent\config\library\records\cancelcheckout\cancelcheckoutcontainer_component.xml
Parent Definition
cancelcheckoutcontainer:/webcomponent/config/library/contenttransfer/cancelcheckout/
cancelcheckoutcontainer_component.xml
Scope
Elements
ucfrequired
service
checkin (type dmc_rm_formal_record)
Purpose
Checks in dmc_rm_formal_record objects that were checked out and sets properties on objects.
Parameters

to check in.
objectId (Required) The ID of the dmc_rm_formal_record
object to check in.
vdmRootObjectId (Optional) Root object ID or the virtual
document to check in.
checkincontainer (type dmc_rm_formal_record)
Description
Since
5.x
Configuration File
webcomponent\config\library\records\checkin\checkin_component.xml
Parent Definition
checkin:/webcomponent/config/library/contenttransfer/checkin/checkin_component.xml
Scope
Elements
init-controls
ucfrequired
service
preset_item
checkincontainer (type dmc_rm_formal_record)
Purpose
Checking in multiple dmc_rm_formal_record objects creates one checkin container and an inner
checkin component instance for each object.
Parameters
Description
Since
5.x
checkout (type dmc_rm_formal_record)
Configuration File
webcomponent\config\library\records\checkin\checkincontainer_component.xml
Parent Definition
checkincontainer:/webcomponent/config/library/contenttransfer/checkin/checkincontainer_
component.xml
Scope
Elements
ucfrequired
service
checkout (type dmc_rm_formal_record)
Purpose
Checks out dmc_rm_formal_record objects from the repository without launching an editing
application. This component is available in all views for dmc_rm_formal_record objects that are
checked out on the user’s current machine. Checking out multiple objects creates one checkout
container and an inner checkout component instance for each dmc_rm_formal_record object.
Parameters
The parameters are inherited from checkout:/webcomponent/config/library/contenttransfer/checkout/
checkout_component.xml. See checkout (type dm_sysobject), page 989.
Description
Since
5.x
checkoutcontainer (type dmc_rm_formal_record)
Configuration File
webcomponent\config\library\records\checkout\checkout_component.xml
Parent Definition
checkout:/webcomponent/config/library/contenttransfer/checkout/checkout_component.xml
Scope
Elements
ucfrequired
service
init-controls
skipVersionCheck
checkoutcontainer (type dmc_rm_formal_record)
Purpose
Container for the checkout process for dmc_rm_formal_record objects.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\records\checkout\checkoutcontainer_component.xml
Parent Definition
checkoutcontainer:/webcomponent/config/library/contenttransfer/checkout/checkoutcontainer_
component.xml
declareformalrecord (entitlement recordsmanager)
Scope
Elements
ucfrequired
service
declareformalrecord (entitlement recordsmanager)
Purpose
Declare, that is, createformal record objects from existing objects. Requires a Records Manager license.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\declareformalrecord_component.xml
Scope
Elements
None.
declareFormalRecordContainer (entitlement recordsmanager)
declareFormalRecordContainer (entitlement
recordsmanager)
Purpose
Container for the declareformalrecord (entitlement recordsmanager) component. Requires a Records
Manager license.
Parameters

componentArgs (Optional) Supplied by the LaunchComponent
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\declareformalrecordcontainer_component.
xml
Parent Definition
Scope
Elements
newcomponentname
numberedtabs
fileplanlocator (entitlement recordsmanager)
fileplanlocator (entitlement recordsmanager)
Purpose
Enables selection of a file plan in which to place a record. Requires a Records Manager license.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\records\locator\fileplan_locator_component.xml
Parent Definition
Scope
Elements
iconwell_icon
objecttype

containerselectable
fileplanlocatorcontainer (entitlement recordsmanager)
allversionsvisible
views
fileplanlocatorcontainer (entitlement
recordsmanager)
Purpose
Container for the fileplanlocator component. Requires a Records Manager license.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
folderlocatorcontainer:webcomponent/config/library/locator/folderlocators_component.xml
Scope
Elements
None.
fileplanmyobjectlocator (entitlement recordsmanager)
fileplanmyobjectlocator (entitlement
recordsmanager)
Purpose
Displays all file plan objects that are owned by the user. Requires a Records Manager license.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
iconwell_icon
columns
objecttype

containerselectable
flatlist
fileplansubscriptionlocator (entitlement recordsmanager)
allversionsvisible
modifiedwithindays
views
fileplansubscriptionlocator (entitlement
recordsmanager)
Purpose
Displays a user’s subscribed file plans. Requires a Records Manager license.
Parameters
Description
Since
5.x
Configuration File
fileplansubscriptionlocator (entitlement recordsmanager)
Parent Definition
Scope
Elements
iconwell_icon
columns
objecttype

containerselectable
flatlist
allversionsvisible
views
formalrecordcombocontainer (entitlement recordsmanager)
formalrecordcombocontainer (entitlement
recordsmanager)
Purpose
Enables a user to perform multi-select operations on formal record objects. Requires a Records
Manager license.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\formalrecordcombocontainer_component.
xml
Parent Definition
Scope
Elements
failoverenabled
properties (type dmc_rm_formal_record)
properties (type dmc_rm_formal_record)
Purpose
Enables users to view and change properties of dmc_rm_formal_record objects. Requires a Records
Manager license.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\formalrecord_properties_component.xml
Parent Definition
Scope
Elements
failoverenabled
commitorder
recordattributes
Purpose
Displays the attributes of formal record objects in a form based on a form template. Requires
a Records Manager license.
recordlocator (entitlement recordsmanager)
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\records\declarerecord\attribute_rm_formalrecord_component.xml
Parent Definition
xforms:webcomponent/config/xforms/xforms_component.xml
Scope
All.
Elements
None.
Purpose
Locator for formal record objects. Requires a Records Manager license.
Parameters
objectId (Required) ID of the source formal record

object of the create relationship action. This
formal record will be excluded from the list of
formal records, since an object cannot have a
relationship to itself.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\locator\rm_record_locator_container.xml
Parent Definition
Scope
Elements
iconwell_icon
columns
allversionsvisible
objecttype

containerselectable
recordlocatorcontainer (entitlement recordsmanager)
views
recordlocatorcontainer (entitlement
recordsmanager)
Purpose
Container for the recordlocator (entitlement recordsmanager), recordmyobjectlocator (entitlement
recordsmanager), and recordsubscriptionlocator (entitlement recordsmanager) components. Requires
a Records Manager license.
Parameters
objectId (Required) Object ID for the formal record that

is the parent of the relationship to create.
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
multidocbasesupport
recordmyobjectlocator (entitlement recordsmanager)
recordmyobjectlocator (entitlement
recordsmanager)
Purpose
Displays all formal record objects owned by a user. Requires a Records Manager license.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
Elements
iconwell_icon
columns
objecttype

containerselectable
allversionsvisible
recordsubscriptionlocator (entitlement recordsmanager)
flatlist
modifiedwithindays
views
recordsubscriptionlocator (entitlement
recordsmanager)
Purpose
Displays all formal record objects to which a user is subscribed. Requires a Records Manager license.
Parameters
Description
Since
5.x
Configuration File
recordsubscriptionlocator (entitlement recordsmanager)
Parent Definition
Scope
Elements
iconwell_icon
columns
objecttype

containerselectable
allversionsvisible
flatlist
views
view_record_relationships (entitlement recordsmanager)
view_record_relationships (entitlement
recordsmanager)
Purpose
View relationships between records. Requires a Records Manager license.
Parameters
objectId (Required) Object ID of the source record.
Description
Since
5.x
Configuration File
webcomponent\config\library\records\relationships\record_relationships.xml
Parent Definition
Scope
Elements
columns
header
nondocbasecolumns
viewContainedInFormalRecords (entitlement
recordsmanager) (Webtop)
Purpose
View a list of formal record objects that contain a specified object. Requires a Records Manager license.
xformsattachmentlocator (type rm_classification_guide)
Parameters
objectId (Required) ID of the object contained within the

formal record objects to display.
Description
Since
6.0
Configuration File
webtop\config\view_contained_in_formal_records.xml
Scope
Elements
columns
xformsattachmentlocator (type rm_classification_

guide)
Purpose
This component is a locator specialized for locating document attachments based on the
rm_classification_guide type.
Parameters
Description
Since
5.x
xformsattachmentlocator (type rm_classification_guide)
Configuration File
webcomponent\config\library\records\locator\classification_guide_locator_component.xml
Parent Definition
xformsattachmentlocator:webcomponent/config/xforms/locator/xformsattachmentlocator_
component.xml
Scope
type rm_classification_guide
Elements
iconwell_icon
columns
objecttype
<objecttype>rm_classification_guide</objecttype>

views
containerselectable
allversionsvisible
flatlist
xformsattachmentlocator (type rm_dod5015ch4record)
xformsattachmentlocator (type rm_

dod5015ch4record)
Purpose
Locator that locates document attachments for objects of the rm_dod5015ch4record type.
Parameters
objecttype (Optional) Type of the object.
Description
Since
6.0
Configuration File
webcomponent\config\library\records\locator\original_classified_records_locator_component.xml
Parent Definition
xformsattachmentlocator:webcomponent/config/xforms/locator/xformsattachmentlocator_
component.xml
Scope
type rm_dod5015ch4record
Elements
iconwell_icon
columns
containerselectable
allversionsvisible
flatlist
objecttype
Relationships between objects
Purpose
Deletes an existing relation (dm_relation) between two dm_document objects.
Parameters
relationObjectId (Required) ID of the dm_relation object.
Description
Since
6.0
Configuration File
webcomponent\config\library\delete\deleterelation_component.xml
Scope
type dm_document
Elements
None.
Purpose
Creates a new relation (dm_relation) between two dm_document objects.
Parameters
childObjectId (Required) ID of the child object in the relation.

objectId (Required) ID of the parent object in the relation.
Description
Since
6.0
Configuration File
webcomponent\config\library\create\newrelation_component.xml
Scope
type dm_document
Elements
None.
newrelationcontainer
newrelationcontainer
Purpose
Container for newrelation (type dm_document), page 1182 component, which creates a new relation
(dm_relation) between two dm_document objects.
Parameters
childObjectId (Optional) ID of the child object in the relation.

drop-down list.
folderId (Optional) ID of the folder in which to begin
the search.
objectId (Required) ID of the parent object in the relation.
repository (Optional) Repoitory in which to search.
selected.
Description
Since
6.0
Configuration File
webcomponent\config\library\create\newrelationcontainer_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
relationships (Webtop)
relationships (Webtop)
Purpose
Extends the WDK relationships component and lists the sysobjects to which the source sysobject has
a relationship (dm_relation object).
Parameters
The parameters are inherited from relationships:/webcomponent/config/library/relationships/
relationships_component.xml. See relationships, page 974.
Description
Since
5.x
Configuration File
webtop\config\relationships_component.xml
Parent Definition
relationships:/webcomponent/config/library/relationships/relationships_component.xml
Scope
All.
Elements
columns
Renditions
renditions (type dm_sysobject)
Purpose
Extends objectgrid, page 1056 and lists the renditions of an object. This component is defined with
dm_sysobject scope. For dm_folder objects it is specifically not defined, so that the renditions
component is not available for folders.
renditions (type dm_sysobject) (Webtop)
Parameters
contentType (Optional) Type of content to be rendered.

objectId (Required) ID of the object to be rendered.
Description
Since
5.x
Configuration File
webcomponent\config\library\renditions\renditions_component.xml
Parent Definition
Scope
type dm_sysobject
Elements
columns
nondocbasecolumns
header
renditions (type dm_sysobject) (Webtop)
Purpose
Extends the WDK renditions component and lists the renditions of an object. This component
is defined with dm_sysobject scope.
Parameters
The parameters are inherited from renditions:/webcomponent/config/library/renditions/renditions_
component.xml. See renditions (type dm_sysobject), page 1184.
changehomedocbase
Description
Since
5.x
Configuration File
webtop\config\renditions_component.xml
Parent Definition
renditions:/webcomponent/config/library/renditions/renditions_component.xml
Scope
type dm_sysobject
Usage
For dm_folder objects, this component is specifically not defined, so that the renditions component
is not available for folders.
Elements
columns
nondocbasecolumns
Repository
changehomedocbase
Purpose
Changes the user’s home docbase. The component offers the choice of running the associated job
immediately or waiting until the scheduled job.
Parameters
objectId (Required) ID of the new home repository

objectname (Required) User name
changepassword
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\changehomedocbase_component.xml
Scope
All.
Elements
None.
changepassword
Purpose
The component provides a user interface and functionality that allow users to change their repository
passwords. The login and changepassword components are the only two Documentum components
that do not require a Documentum connection.
Parameters
docbase (Optional) Name of the repository in which the

user is changing the password
domain (Optional) Network domain for the repository
username (Required) Name of user who is changing the
password
Description
Since
5.x
Configuration File
wdk\config\changepassword_component.xml
Scope
All.
configuredocbroker
Elements
editableusername
<editableusername>true</editableusername>
Boolean. True to allow the username to be edited.
configuredocbroker
Purpose
This component allows the user to select the connection brokers that will supply repositories for
login. A dropdown list of connection brokers that are specified in the application server dmcl.ini file
is displayed. The user can enter the name of another connection broker to the list. The component
verifies the existence and connection to connection brokers when the user clicks OK.
Parameters
None.
Description
Since
5.x
Configuration File
wdk\config\configuredocbroker_component.xml
Scope
All.
Elements
None.
launchrepositoryselector
Purpose
This component is nested in the locatorcontainer component to call the launchauthenticate action.
repositoryselector
Parameters
suppressLoginEvent (Optional) Specifies whether to fire the

loginSuccess or loginCancel client events after
the login dialog has been dismissed
Description
Since
5.x
Configuration File
wdk\config\launchrepositoryselector_component.xml
Scope
All.
Elements
None.
repositoryselector
Purpose
This component allows the user to select a repository to be added to a list of preferred repositories.
Like the login component, this component and its container are listed in Environment.properties as
non_docbase_components. Displays visible repositories for the list of connection brokers. The user
can manually enter the name of a connection broker to select a repository that connects to that broker.
Parameters
None.
Description
Since
5.x
Configuration File
wdk\config\repositoryselector_component.xml
repositoryselectorcontainer
Scope
All.
Elements
failoverenabled
repositoryselectorcontainer
Purpose
A container that enables selection of a content repository.
Parameters
Description
Since
5.x
Configuration File
wdk\config\repositoryselectorcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
setretentiondate (type dm_sysobject)
Retention Policy Services
setretentiondate (type dm_sysobject)
Purpose
Sets a retention date for the object in its storage location. The action is executed asynchronously.
Parameters
lockOwner (Optional) Name of user who has checked out

the document
objectId (Required) ID of the object for which the
retention date is set.
Description
Since
5.x
Configuration File
webcomponent\config\library\retentiondate\setretentiondate_component.xml
Scope
type dm_sysobject
Caller
Not called in Webtop.
Elements
asynchronous
See asynchronous, page 725.
advsearch
Search
advsearch
Purpose
WDK advanced search allows a user to select type, type attributes, and location for search. The data
dictionary supplies searchable types and attributes as well as value assistance and conditional value
assistance. Search results display columns are configured in the search column and can be selected by
users in the display_preferences component UI.
Parameters
drilldown (Optional) Set to true to use the drilldown view

by default to display the search results. This
parameter is set to false in Webtop when the
user selects classic view in preferences.
folderpath (Optional) Used to populate the radio button
that displays the current location
includetypes (Optional) Comma-delimited list of object types
to display for search. Subtypes of the selected
type will also be searched. Overrides the default
set in the <includetypes> element.
objectId (Optional) Specifies the object id of the saved
search to be revised
query (Optional) Full-text query string
queryId (Optional) Internally used to identify the current
search context
showwait (Optional) Specifies whether to show the wait
page for a non-DQL query. By default, the wait
page is displayed.
type (Optional) Initial search type, defaults to the first
type in includetypes
advsearch (clientenv portal, type dm_message_archive)
usedocumentpresetfilter (Optional) Set to true to activate the use

of the type filter preset element from the
newDocument component. This element
overrides the includetypes element value.
Since 6.0 SP1.
usepreviousinput (Optional) Set to true to restore previous search

criteria input, if possible
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\advsearch_component.xml
Scope
All.
Elements
failoverenabled
includetypes
See includetypes, page 737. This element value is not used if <usedocumentpresetfilter> is set to true.
usedocumentpresetfilter
Since 6.0 SP1.
Set to true to use the Types preset rule (which is also used by the newdocument component) to limit
the displayed types in the Object Types field; the includetypes element value is ignored. Set to false to
use the includetypes element value. Default is false.
advsearch (clientenv portal, type dm_message_

archive)
Purpose
WDK advanced search for dm_message_archive objects in a WDK portlet environment.
advsearch (type dm_message_archive)
Since
6.5
advsearch (type dm_message_archive)
Purpose
WDK advanced search for dm_message_archive objects. It extends the advanced search component
to search mails (complex components).
Parameters
The parameters are inherited from webcomponent\config\library\search\searchex\advsearch_
component.xml. See advsearch, page 1192
Description
Since
5.x
Configuration File
webcomponent\config\library\messagearchive\messagearchive_advsearchex_component.xml
Parent Definition
advsearch:webcomponent\config\library\search\searchex\advsearch_component.xml
advsearch (type dm_message_archive) (Webtop)
Purpose
Webtop advanced search for dm_message_archive objects. Webtop advanced search allows a user to
select type, type attributes, and location for search. The data dictionary supplies searchable types
and attributes as well as value assistance (except conditional value assistance). Search results display
columns are configured in the search column and can be selected by users in the display_preferences
component UI.
advsearch (Webtop)
Parameters
The parameters are imported from webtop\config\advsearchex_component.xml. See advsearch
(Webtop), page 1195
Description
Since
5.x
Configuration File
webtop\config\messagearchive_advsearchex_component.xml
Parent Definition
advsearch:webtop\config\advsearchex_component.xml
advsearch (Webtop)
Purpose
The Webtop advanced search allows a user to select type, type attributes, and location for search. The
data dictionary supplies searchable types and attributes as well as value assistance and conditional
value assistance. Search results display columns are configured in the search column and can be
selected by users in the display_preferences component UI.
Parameters
The parameters are inherited from advsearch:webcomponent/config/library/search/searchex/
advsearch_component.xml. See advsearch, page 1192.
Description
Since
5.x
Configuration File
webtop\config\advsearchex_component.xml
Parent Definition
advsearch:webcomponent/config/library/search/searchex/advsearch_component.xml
advsearchcontainer
Scope
All.
Elements
failoverenabled
This element structure is inherited from advsearch:webcomponent/config/library/search/searchex/
includetypes
usedocumentpresetfilter
advsearchcontainer
Purpose
Contains the WDK 5.3 search components.
Parameters
basetype (Optional) The base object type used to populate

the available search types
component (Optional) Name of the component within the
container
folderpath (Optional) Specifies the initial folder path for the
search location. This value is used if the user has
not set a search location preference.
objectId (Optional) Specifies the object id of the saved
search to be revised
queryId (Optional) Internally used to identify the current
search context
showwait (Optional) Not used
advsearchcontainer (version 5.2.5)
type (Optional) Initial search type, defaults to the

basetype
usepreviousinput (Optional) Set to true to restore previous search
criteria input, if possible
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\advsearchcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
advsearchcontainer (version 5.2.5)
Purpose
WDK 5.2.5 component that contains the search components advsearch and savedsearches. This
component cannot be addressed directly, but it is present to support custom components that
extend it.
Parameters
component (Optional) Name of the component within the

container to be initially displayed
allsavedsearches
Description
Since
5.x
Configuration File
webcomponent\config\library\search\advsearchcontainer_component.xml
Parent Definition
Scope
version 5.2.5
Elements
failoverenabled
allsavedsearches
Purpose
Lists all dm_smartlist objects for which the user has access. The user can revise (if permitted), execute,
view properties, and delete (if permitted).
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\allsavedsearches_component.xml
Scope
All.
Elements
failoverenabled
Purpose
This component allows the user to view name and URL for an object that is in an external source,
returned by a query. Note that dm_externalresult is not a real docbase type, but a pseudotype used
only in the WDK for scoping.
Parameters

search context
Description
Since
5.x
Configuration File
webcomponent\config\library\attributes\attributes_dm_externalresult_component.xml
Scope
Elements
None.
changesearchsources
changesearchsources
Purpose
Enables a user to change the repositories to search.
Parameters
searchsources (Optional) A semicolon-separated list of

repositories to search in the format source:path
Description
Since
5.x
Configuration File
webcomponent\config\library\changesearchsources\changesearchsources_component.xml
Scope
All.
Elements
None.
deletesmartlistcontainer (type dm_smart_list)
Purpose
This component is the component container used to delete dm_smart_list objects (saved search
objects)
Parameters
mysavedsearches
Description
Since
5.x
Configuration File
webcomponent\config\library\delete\deletesmartlistcontainer_component.xml
Parent Definition
Scope
type dm_smart_list
Elements
failoverenabled
mysavedsearches
Purpose
Lists all dm_smartlist objects that are owned by the user. The user can revise , execute, view
properties, and delete.
Parameters
None.
Description
Since
5.x
portalsearch
Configuration File
webcomponent\config\library\search\searchex\mysavedsearches_component.xml
Scope
All.
Elements
failoverenabled
portalsearch
Purpose
Enables searching repositories for portal users. For internal use only.
Parameters
drilldown (Optional) For internal use only.

showwait (Optional) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\portalsearch_component.xml
Scope
All.
Elements
None.
portalsearchcontainer
portalsearchcontainer
Purpose
Container for the portalsearch component. For internal use only.
Parameters
drilldown (Optional) For internal use only.

showwait (Optional) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\portalsearchcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
resultshandling_preferences
Purpose
Enables users to dynamically display asynchronous search results by arrival order or by relevancy
criteria.
savedsearches (version 5.2.5)
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\environment\preferences\search\results\resultshandling_preferences.xml
Scope
All.
Elements
insertionmethod
<insertionmethod>dynamic_order</insertionmethod>
Specifies the default insertion method. Valid values are:

• arrival_order: Results are inserted according to their order of arrival.
• dynamic_order: Results are inserted dynamically according to sort criteria.
savedsearches (version 5.2.5)
Purpose
This is the WDK 5.2.5 savedsearches component that supports operations on saved searches. The
user can execute the saved search by viewing it from a folder or object list or by selecting the
savedsearches component within advanced search. This component cannot be called by URL, but it
can be extended by a custom component.
Parameters
None.
Description
Since
5.x
savesearch
Configuration File
webcomponent\config\library\search\savedsearches_component.xml
Scope
version 5.2.5
Elements
queryfilterset
1 <queryfilterset>
2<queryfilter>
3<displayname>
4<nlsid>MSG_MY_SAVEDSEARCHES</nlsid>
</displayname>
5<dqlfilter>where owner_name=user</dqlfilter>
</queryfilter>
...
</queryfilterset>
savesearch
Purpose
Creates a dm_smart_list object. The search is automatically stored in the current repository. The
search is saved within a folder named Saved Searches in the user’s home cabinet. (This folder is
always hidden and is created if it does not exist.)
Parameters
queryId (Required) The object id of the current search,

an internal parameter to enable sharing of the
query context between search components. If
the parameter does not exist, the 5.2.5 save
search component is called.??
Description
Since
5.x
Configuration File
webcomponent\config\library\savesearch\savesearchex\savesearch_component.xml
savesearch (version 5.2.5)
Scope
All.
Elements
enablesavingsearchresults
<enablesavingsearchresults>true</enablesavingsearchresults>
If the tag is set to true, a panel is displayed in SaveSearchEx component with two checkboxes. One
checkbox enables the user choose to include results in the saved search and the other one enables
the user to choose whether the save search must be public or not. If no tag is specified, the feature
is enabled by default.
failoverenabled
includeresults
<includeresults>true</includeresults>
If the savingSearchResults feature is enabled, a default value for the includeresults checkbox can be
set by using the includeresults tag. If no tag is specified, it uses the default value, which is true. If the
savingSearchResults feature is disabled, then this value is ignored.
savesearch (version 5.2.5)
Purpose
This is the 5.2.5 savesearch component, present for backward compatibility. Saves a performed search
as a dm_query object. The search is saved within a folder named Saved Searches in the user’s home
cabinet. (The folder is created if it does not exist.)
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\savesearch\savesearch_component.xml
Scope
version 5.2.5
savesearchcontainer
Usage
If your custom WDK 5.2.x component extends this component, it will use this component definition.
If your application simply calls savesearch, you will get the 5.3 component.
Elements
None.
savesearchcontainer
Purpose
This container extends dialogcontainer and contains the 5.3 savesearch component. It allows
authentication in the container initialization.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\savesearch\savesearchex\savesearchcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
savesearchtemplate
savesearchtemplate
Purpose
Creates in the current repository a search template from a search.
Parameters
objectId (Optional) ID of the search template object to

create.
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchtemplate\savesearchtemplate_component.xml
Scope
All.
Elements
failoverenabled
search
Purpose
The search component performs a search query on the current repository for the supplied string of
keywords or other type of query input. This component displays the search results; can also display
cluster results. Searches in indexed attributes as well as full-text.
search
Parameters
clusterId (Optional) ID of the ClusterInfo structure, which

contains cluster results, to display instead of
the global results list. A ClusterInfo structure’s
ID is generated by a ClusterTree control in a
ClusterTreeGroup control.Requires Enterprise
Content Integration (ECI) Services.
drilldown (Optional) Not used (incorrectly documented
in 6.0).
query (Required) DQL query (for queryType = dql) or
search string (for queryType = string)
queryType (Optional) Specifies the type of query. Valid
values:
• dql — a DQL query
• lastQuery — to display the results of the last

executed search
• objectId — object ID of a smartlist
• querydef — sthe XML content of a smartlist
• queryId — for internal use only
• savedResults — to display saved search

results
• string or null — one or more full-text search

keywords
showwait (Optional) Not used.
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchex\search60_component.xml
Scope
All.
search (clientenv portal, type dm_message_archive)
Usage
Results columns are configured in this component, even results for advanced search. You can scope
this component to display results columns for various object types. Add a column element for each
custom attribute to the scoped definition.
Elements
columns_drilldown
See .
columns_list
defaultsources
See defaultsources, page 731.
displayresultspath
See displayresultspath, page 732.
dragdrop
failoverenabled
See highlight_matching_terms, page 736.
type
See type, page 750.
search (clientenv portal, type dm_message_archive)
Purpose
Performs a search query on dm_message_archive objects in a portal environment for the current
repository for the supplied string of keywords or other type of query input
Since
6.5
search (type dm_message_archive)
Purpose
Performs a search query on dm_message_archive objects in the current repository for the supplied
string of keywords or other type of query input
search (type dm_message_archive) (Webtop)
Since
6.5
search (type dm_message_archive) (Webtop)
Purpose
Performs a search query on dm_message_archive objects in the current repository for the supplied
string of keywords or other type of query input
Since
6.5
search (version 5.3)
Purpose
The Webtop 5.3 search component performs a search query on the current repository (if the
<defaultsources> parameter is set to current_docbase) for the supplied string of keywords or
other type of query input. This component displays the search results. Searches in indexed attributes
as well as full-text.
Parameters

query (Required) DQL query (for queryType = dql) or
search string (for queryType = string)
search (version 5.3)
queryType (Optional) Specifies the type of query. Valid

values: string (one or more full-text search
keywords) | objectId (of a saved search) |
querydef (string consisting of smartlist content)
| queryId (internal ID for the current query to
be revised) | null (one or more full-text search
keywords)
showwait (Optional) Not used.
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\search_component.xml
Scope
version 5.3
Usage
For backward compatibility.
Elements
columns_drilldown
See .
columns_list
See columns_saved_search, page 729.
defaultsources
displayresultspath
dragdrop
failoverenabled
type
See type, page 750.
search (version 5.3) (Webtop)
search (version 5.3) (Webtop)
Purpose
The Webtop 5.3 search component performs a search query on the current repository (if the
<defaultsources> parameter is set to current_docbase) for the supplied string of keywords or
other type of query input. This component displays the search results. Searches in indexed attributes
as well as full-text.
Parameters
The parameters are inherited from search:webcomponent/config/library/search/searchex/search_
component.xml. See search (version 5.3), page 1211.
Description
Since
5.x
Configuration File
webtop\config\searchex_component.xml
Parent Definition
search:webcomponent/config/library/search/searchex/search_component.xml
Scope
version 5.3
Elements
columns_drilldown
See .
columns_list
See columns_saved_search, page 729.
defaultsources
displayresultspath
dragdrop
search (Webtop)
failoverenabled
This element structure is inherited from search:webcomponent/config/library/search/searchex/
search_component.xml. See search (version 5.3), page 1211.
type
See type, page 750.
search (Webtop)
Purpose
This component displays the search results on indexed attributes as well as full-text.
Parameters
The parameters are inherited from search:webcomponent/config/library/search/searchex/search60_
component.xml. See search, page 1208.
Description
Since
6.0
Configuration File
webtop\config\search60_component.xml
Parent Definition
search:webcomponent/config/library/search/searchex/search60_component.xml
Scope
All.
Usage
You can override the default behavior by using a null queryType parameter and supplying a DQL
string for the query attribute.
Elements
columns_drilldown
See .
columns_list
search_preferences
defaultsources
displayresultspath
dragdrop
failoverenabled
This element structure is inherited from search:webcomponent/config/library/search/searchex/
search60_component.xml. See search, page 1208.
type
See type, page 750.
search_preferences
Purpose
Container for user preferences related to search.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\environment\preferences\search\search_preferences_component.xml
Scope
All.
Elements
None.
searchcontainer
searchcontainer
Purpose
This is the WDK 5.2.5 search container component. It cannot be addressed by URL, but it can be
extended by your custom component for backward compatibility.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchcontainer_component.xml
Parent Definition
nestedcomponentcontainer:wdk/config/nestedcomponentcontainer_component.xml
Scope
All.
Elements
failoverenabled
searchitems
Purpose
Calls the searchstoreclassic, page 1224 or searchstoretemplate, page 1225 component.
searchmonitoring
Parameters
compselection (Optional) Whether the the searchstoreclassic,

page 1224 (searchstoreclassic) or search-
storetemplate, page 1225 (searchstoretemplate)
component is displayed. Default depends
on the preferences (that is, the last displayed
component). If preferences is not set, then the
searchstoreclassic component is displayed. The
searchstoreclassic component is only displayed
when the ECI option is installed.
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchex\searchitems_component.xml
Scope
All.
Elements
None.
searchmonitoring
Purpose
Displays the search repositories and external sources and their status, including real-time graphics
and text data.
Parameters
page (Optional) For internal use only.

queryId (Optional) ID of the query to display. Valid
value is a queryId in the com.documentum.
webcomponent.library.search.SearchInfo class.
Default is the most recent queryId value in
SearchInfo class.
searchmonitoring
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchex\searchmonitoring_component.xml
Scope
All.
Usage
Status information includes:
• Number of results returned by each source
• Original query (if available)
• Source status (including a detailed error message when the search fails for a source)
Figure 1, page 1219 shows the animation for in-progress real-time stack graphics:
• ECIDEV1: One stack (0 results)
• MSSQL53SP4ECI9: Two stacks (the first one for 0 results and the second one for 9 results)
• ORA53SP1ECI5: Three stacks (the first one for 0 results, the second stack for 50 results, and the
third stack for 42 results).
searchmonitoring
Figure 1. In-progress real-time search monitoring
Figure 2, page 1220 shows the animation after results have been completely returned:
• ECIDEV1: Three stacks (the first one for 0 results, the second stack for 50 results, and the third
stack for 283 results)
• MSSQL53SP4ECI9: Two stacks (the first one for 0 results and the second one for 9 results)
• ORA53SP1ECI5: Three stacks (the first one for 0 results, the second stack for 50 results, and the
third stack for 42 results)
searchmonitoring
Figure 2. Completed real-time search monitoring
Elements
animation_max_results_heap_1
<animation_max_results_heap_1>0</animation_max_results_heap_1>
Maximum number of results that the first stack (heap) graphic represents for a source. Valid values
are positive integers. Default is 0.
animation_max_results_heap_2
<animation_max_results_heap_2>50</animation_max_results_heap_2>
Maximum number of results that the second stack (heap) graphic represents for a source. Valid values
are positive integers starting after the animation_max_results_heap_1 parameter value. Default is 50.
The maximum number of stack graphics displayed for a source is three. The third stack graphic
represents the remainder of the search results.
failoverenabled
refresh_timeout
<refresh_timeout>3500</refresh_timeout>
Interval (in milliseconds) between refreshes of the animation of the real-time graphics.
searchmonitoringcontainer
searchmonitoringcontainer
Purpose
Contains the searchmonitoring, page 1217 component to display the current search’s repository and
external sources and their status, including real-time graphics and text data.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchex\searchmonitoringcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
searchsources_preferences
Purpose
Enables the user to select repositories for their search preference. Users can select external sources
if ECI Services is installed.
Parameters
None.
searchstatus
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\searchsources\searchsources_preferences_
component.xml
Scope
All.
Elements
preferences
searchstatus
Purpose
Lists each repository and external source that is used for the current search and gives the status of
each source. This component is displayed when the search monitoring (part of Webtop Federated
Search) is not available.
Parameters
queryId (Optional) The object id of the current search,

an internal parameter to enable sharing of the
query context between search components.
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\searchstatus_component.xml
Scope
All.
searchstatuscontainer
Elements
None.
searchstatuscontainer
Purpose
Contains one or more search status components.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\searchstatuscontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
searchstoreclassic
searchstoreclassic
Purpose
In classic view, enables users to view, delete, execute a search on, and view properties of existing user
(or all public) dm_smartlist objects (that is, saved searches), and modify new dm_smart_list objects in
the current repository. This component is displayed in the tree.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchex\searchstore_component.xml
Scope
All.
Elements
See columns_all_saved_searches, page 728.
See columns_my_saved_searches, page 728.
defaultview
See defaultview, page 732.
failoverenabled
Usage
In 6.0, it replaced the allsavedsearches and mysavedsearches 5.3 components (which have been
deprecated).
searchstorestreamline
searchstorestreamline
Purpose
In streamline view, enables users to view, delete, execute a search on, and view properties of existing
user (or all public) dm_smartlist objects (that is, saved searches), and modify new dm_smart_list
objects in the current repository. This component is displayed in the tree.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchex\searchstorestreamline_component.xml
Scope
All.
Elements
See columns_all_saved_searches, page 728.
See columns_my_saved_searches, page 728.
defaultview
failoverenabled
searchstoretemplate
Purpose
Lists end-user or all public search_template objects, enables executing search_template objects (that
is, run a new search with a search_template object),viewing properties, and deleting search_template
objects.
searchstoretemplate
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchtemplate\searchstoretemplate_component.xml
Scope
All.
Elements
columns_all_search_templates
1 <columns_all_search_templates>
3<column>
5<label>
</label>
</column>
...
</columns_all_search_templates>
1 Configures the attributes to display for all search templates.

2 Whether to load hidden attributes (true) or not (false).
3 Specifies a column.
4 Specifies the name of the attribute to display in the column.
5 Specifies the text to display as the column head.
6 Whether to display (true) or hide (false) the column.
columns_my_search_templates
1 <columns_my_search_templates>
3<column>
5<label>
</label>
</column>
...
</columns_my_search_templates>
1 Configures the attributes to display for a user’s search templates.

2 Whether to load hidden attributes (true) or not (false).
3 Specifies a column.
4 Specifies the name of the attribute to display in the column.
searchtemplate
5 Specifies the text to display as the column head.

6 Whether to display (true) or hide (false) the column.
defaultview
failoverenabled
searchtemplate
Purpose
Enables executing a search from a search template, displaying a search form from a search template,
and creating a search.
Parameters
objectId (Required)
queryId (Optional)
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchtemplate\searchtemplate_component.xml
Scope
All.
Elements
failoverenabled
searchtemplatecontainer
searchtemplatecontainer
Purpose
Container for the search template.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\search\searchtemplate\searchtemplatecontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
smartnavigation_preferences
Purpose
Enables users to set their preferences for displaying the results of search strategies on the smart
navigation panel; that is, add and remove search cluster strategies, and move the cluster strategies up
and down.
Parameters
None.
viewexternalresult
Description
Since
6.0
Configuration File
webcomponent\config\environment\preferences\search\cluster\smartnavigation_preferences_
component.xml
Scope
All.
Elements
None.
viewexternalresult
Purpose
This is an internal component that is invoked by the view action to view the results of a search on
external sources. Failover is not enabled for this component.
Parameters

search context
Description
Since
5.x
Configuration File
webcomponent\config\library\search\searchex\viewexternalresult_component.xml
Scope
All.
accessoractions
Elements
None.
Security
accessoractions
Purpose
Displays actions for user or group permissions. The available actions are Edit and Remove for
the selected accessor.
Parameters
accessorName (Required) Name of accessor (user or group)

aceavailableactions (Optional) accessor action link list name
Default = 3 (read)
permission controls
objectId (Optional) Not used
objectName (Optional) Accessor name
accessoractionscontainer

type (Optional) Not used
Description
Since
5.x
Configuration File
webcomponent\config\library\accessoractions\accessoractions_component.xml
Scope
All.
Elements
failoverenabled
accessoractionscontainer
Purpose
Contains the accessoractions component to display actions on accessors (Edit and Remove)
Parameters
component (Optional) Specifies the contained component
Description
Since
5.x
aclacelist
Configuration File
webcomponent\config\library\accessoractions\accessoractionscontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
aclacelist
Purpose
Displays and allows editing of the current list of accessors (users and groups) and their permissions
within access control lists (ACLs, known as permission sets).
Parameters
objectId (Required) The ID of the ACL object to be

displayed.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\aclacelist_component.xml
Scope
All.
Elements
None.
acldelete
acldelete
Purpose
Deletes access control lists (ACLs, also called permission sets). Not used in Webtop.
Parameters

deleted.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\acldelete_component.xml
Scope
All.
Elements
None.
aclinfo
Purpose
Displays and updates the simple (single-valued) attributes of access control lists (ACLs, known as
permission sets).
Parameters

displayed and updated.
acllist
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\aclinfo_component.xml
Scope
All.
Elements
None.
acllist
Purpose
Displays repository access control lists (ACLs, known as permission sets) according to various criteria.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\acllist_component.xml
Scope
All.
Elements
showbreadcrumb
See showbreadcrumb, page 748.
aclobjectlocator
aclobjectlocator
Purpose
Locates and selects any ACL in the repository
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\locator\aclobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
iconwell_icon
attributes
columns
objecttype
<objecttype>dm_acl</objecttype>
aclobjectlocatorcontainer
views
preset_item
aclobjectlocatorcontainer
Purpose
Container component for locating and selecting any ACL in the repository
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\aclobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
multidocbasesupport
aclproperties
aclproperties
Purpose
Allows the user to view the attributes of an access control list (ACL). Contains aclinfo, page 1233 and
aclacelist, page 1232.
Parameters
component (Required) Specifies the starting component to

display (default = aclinfo). The components that
should be displayed within this container must
be listed as child elements of <contains>.
objectId (Required) The ID of the ACL object for which
attributes are to be displayed.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\aclproperties_component.xml
Parent Definition
component.xml
Scope
All.
Elements
objecttype
aclsaveas
aclsaveas
Purpose
Saves an ACL with a new name.
Parameters
The parameters are inherited from aclproperties:webcomponent/config/admin/acl/aclproperties_
component.xml. See aclproperties, page 1237.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\aclsaveas_component.xml
Parent Definition
aclproperties:webcomponent/config/admin/acl/aclproperties_component.xml
Scope
All.
Elements
objecttype
aclvalidate
Purpose
This component is used to display the accessors for an access control list (ACL). Some features of the
UI are turned on only if Trusted Content Services is enabled in the Content Server.
aclwhereused
Parameters
validation (Required) This is a background parameter

passed by the server to the component.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\aclvalidate_component.xml
Scope
All.
Elements
failoverenabled
aclwhereused
Purpose
Displays lists of all objects that use specific access control lists.
Parameters
objectId (Required) The ID of the ACL object for which

attributes are to be shown.
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\aclwhereused_component.xml
addaccessor
Scope
All.
Elements
None.
addaccessor
Purpose
Adds or edits individual accessors and accessor groups, including their permissions, for inclusion
in access control lists.
Parameters
accessorName (Required) The name of the individual or group

to be added.
Default = 3 (read)
permission controls
objectName (Optional) Accessor name passed from container
admindelete
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\addaccessor_component.xml
Scope
All.
Elements
failoverenabled
admindelete
Purpose
Enables the administrator to delete an ACL
Parameters

objectname (Required) Name of the ACL.
type (Required) Object type of the ACL.
Description
Since
5.x
Configuration File
webcomponent\config\admin\admindelete\admindelete_component.xml
Scope
All.
Elements
None.
aliassetobjectlocator
aliassetobjectlocator
Purpose
Selects any alias set in the repository
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\locator\aliassetobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
attributes
columns
objecttype
<objecttype>dm_alias_set</objecttype>

views
aliassetobjectlocatorcontainer
aliassetobjectlocatorcontainer
Purpose
Selects any alias set in the repository.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\aliassetobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
extendedaddaccessor
Purpose
Adds or edits individual accessors and accessor groups, including their permissions, for inclusion in
access control lists. Requires Trusted Content Services for accessor groups.
extendedaddaccessor
Parameters
accessorName (Required) The name of the individual or group

to be added.
Default = 3 (read)
permission controls
objectName (Optional) Accessor name passed from container
Description
Since
5.x
Configuration File
webcomponent\config\admin\acl\extendedaddaccessor_componenet.xml
Scope
All.
Elements
failoverenabled
multiobjectspermissions
multiobjectspermissions
Purpose
Displays the permissions for multiple objects.
Parameters
The parameters are inherited from permissions:/webcomponent/config/library/permissions/
extendedpermissions_component.xml. See permissions, page 1246.
Description
Since
5.x
Configuration File
webcomponent\config\library\permissions\multiobjectsextendedpermissions_component.xml
Parent Definition
permissions:/webcomponent/config/library/permissions/extendedpermissions_component.xml
Scope
All.
Elements
failoverenabled
nomaclsupport
See nomaclsupport, page 740.
permissionsservice
See permissionsservice, page 742.
nomaclsupport_permissions
Purpose
This is a backup ID for WDK 5.3 that passes the arguments to the standard permissions component.
permissions
Parameters
The parameters are inherited from permissions:webcomponent/config/library/permissions/
extendedpermissions_component.xml. See permissions, page 1246.
Description
Since
5.x
Configuration File
webcomponent\config\library\permissions\extendedpermissions_component.xml
Parent Definition
permissions:webcomponent/config/library/permissions/permissions_component.xml
Scope
All.
Elements
failoverenabled
permissions
Purpose
Sets extended permissions on objects using Trusted Content Services when that feature is enabled for
the repository.
Parameters
objectId (Required) ID of the object
Description
Since
5.x
permissions (version 5.2.5)
Configuration File
webcomponent\config\library\permissions\extendedpermissions_component.xml
Scope
All.
Elements
failoverenabled
nomaclsupport
See nomaclsupport, page 740.
permissionsservice
See permissionsservice, page 742.
permissions (version 5.2.5)
Purpose
Sets permissions on objects. This component is the 5.2.5 version and cannot be launched directly. If
your custom component extends this component, it will continued to work until you migrate it to 5.3.
Parameters
objectId (Required) ID of the ACL
Description
Since
5.x
Configuration File
webcomponent\config\library\permissions\permissions_component.xml
Scope
version 5.2.5
Elements
failoverenabled
documentsubscriptionlocator
Subscriptions
documentsubscriptionlocator
Purpose
Extends the component subscriptionlocator, page 1252 and locates objects of type dm_document to
which the user has subscribed.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
foldersubscriptionlocator
objecttype

views
foldersubscriptionlocator
Purpose
Extends the component subscriptionlocator, page 1252 and locates subscribed folders.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
allversionsvisible
subscribeotherslocator
columns
containerselectable
flatlist
iconwell_icon
objecttype

1 <privatecabinetvisible>true</privatecabinetvisible>
views
subscribeotherslocator
Purpose
Locator that displays all users except the current user; used by a user to subscribe other users
to objects.
Parameters
Description
Since
5.x
subscribeotherslocatorcontainer
Configuration File
webcomponent\config\library\subscription\subscribeotherslocator_component.xml
Parent Definition
useronlylocator:webcomponent/config/library/locator/useronlylocator_component.xml
Scope
All.
Elements
containerselectable
flatlist
objecttype

privategroupvisible
views
subscribeotherslocatorcontainer
Purpose
Container for the subscribeotherslocator, page 1250 component.
Parameters

subscriptionlocator
Description
Since
5.x
Configuration File
webcomponent\config\library\subscription\subscribeotherslocator_component.xml
Parent Definition
useronlylocatorcontainer:webcomponent/config/library/locator/useronlylocator_component.xml
Scope
All.
Elements
None.
subscriptionlocator
Purpose
Extends sysobjectlocator, page 969 and locates and displays a user’s subscriptions.
Parameters

drop-down list.
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\subscriptionlocator_component.xml
subscriptionlocator
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
objecttype

views
subscriptions_classic (Webtop)
subscriptions_classic (Webtop)
Purpose
Displays subscriptions of the current session user.
Description
Since
5.x
Configuration File
webtop\config\subscriptions_classic_component.xml
Parent Definition
subscriptions_list:/webcomponent/config/library/subscription/subscriptions_list_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from subscriptions_list:/webcomponent/config/library/
subscription/subscriptions_list_component.xml. See subscriptions_list, page 1255.
objecttype

preset_item
showfilters
showfolders
subscriptions_drilldown
subscriptions_drilldown
Purpose
Displays subscriptions of the current session user. Deprecated as of version 6.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\subscription\subscriptions_drilldown_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
preferences
subscriptions_list
Purpose
Displays subscriptions of the current session user.
Parameters
None.
subscriptions_streamline (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\subscription\subscriptions_list_component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
objecttype

preset_item
showfilters
showfolders
subscriptions_streamline (Webtop)
Purpose
Extends the WDK subscriptions_drilldown component and displays subscriptions of the current
session user.
Description
Since
5.x
Configuration File
webtop\config\subscriptions_streamline_component.xml
taskmgrclassic (Webtop)
Parent Definition
subscriptions_drilldown:/webcomponent/config/library/subscription/subscriptions_drilldown_
component.xml
Scope
All.
Elements
columns
dragdrop
failoverenabled
This element structure is inherited from subscriptions_drilldown:/webcomponent/config/library/
subscription/subscriptions_drilldown_component.xml. See subscriptions_list, page 1255.
preferences
Task manager
taskmgrclassic (Webtop)
Purpose
Displays the info tab in the taskmanager component group. It is the main component in the group of
task manager components, which are contained in the taskmanagercontainer component.
Parameters
Description
Since
5.x
Configuration File
webtop\config\taskmgrclassic_component.xml
taskmgrstreamline (Webtop)
Parent Definition
taskmanager:webcomponent/config/library/workflow/taskmanager/taskmanager_component.xml
Scope
All.
Elements
formsavefolderpath
See formsavefolderpath, page 735.
showusertimeandcost
See showusertimeandcost, page 749.
failoverenabled
This element structure is inherited from taskmanager:webcomponent/config/library/workflow/
taskmanager/taskmanager_component.xml. See taskmanager, page 1451.
taskmgrstreamline (Webtop)
Purpose
Extends the WDK taskmanager component and displays the info tab in the taskmanager component
group. It is the main component in the group of task manager components, which are contained in
the taskmanagercontainer component.
Parameters
Description
Since
5.x
Configuration File
webtop\config\taskmgrstreamline_component.xml
Parent Definition
taskmanager:webcomponent/config/library/workflow/taskmanager/taskmanager_component.xml
Scope
All.
actionbuttonlisttest
Elements
formsavefolderpath
showusertimeandcost
failoverenabled
This element structure is inherited from taskmanager:webcomponent/config/library/workflow/
taskmanager/taskmanager_component.xml. See taskmanager, page 1451.
Testing
actionbuttonlisttest
Purpose
Tests action button list controls
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
actionbuttontest
actionbuttontest
Purpose
Tests action button controls
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
actionlinklisttest
Purpose
Tests action link list controls
Parameters
None.
Description
Since
5.x
actionlinktest
Configuration File
Scope
All.
Elements
None.
actionlinktest
Purpose
Tests action link controls
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
actionmenuitemtest
Purpose
Tests action menu item controls
actionmultiselecttest
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
actionmultiselecttest
Purpose
Tests action multiselect controls.
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
compiletest
compiletest
Purpose
Tests whether a WDK Automated Test Framework test case file compiles.
Parameters
file (Required) Path to the test case file to compile.
Description
Since
6.0
Configuration File
webcomponent\config\testtool\compiletest_component.xml
Scope
All.
Elements
None.
componentincludetest
Purpose
One of a set of components and actions that test controls and actions. This component is used for
internal testing at Documentum.
Parameters
None.
componenttestbed
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
componenttestbed
Purpose
Obsolete component that was used to test WDK 5.1 components.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\componentTestbed\testbed_index_component.xml
Scope
All.
Elements
None.
componenturltest
componenturltest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
configservicemaintest
Purpose
Parameters
folderPath (Optional) Full repository path to the folder.
configservicetest
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
configservicetest
Purpose
Parameters
testInstructs (Optional) Instructions for testing.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
defineuifieldvalidation
defineuifieldvalidation
Purpose
Parameters
controlTestId (Required) For internal use only.

optArgs (Optional) For internal use only.
uniqueFormId (Required) For internal use only.
Description
Since
6.0
Configuration File
wdk\config\test\defineuifieldvalidation_component.xml
Scope
All.
docbaseattributeedittest
Purpose
Parameters
docbaseattributelabeltest
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseattributelabeltest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseattributelistmaintest
docbaseattributelistmaintest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseattributelisttest
Purpose
Parameters
None.
Description
Since
5.x
docbaseattributetest
Configuration File
Scope
All.
Elements
None.
docbaseattributetest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseattributevalidatortest
docbaseattributevalidatortest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseattributevaluetest
Purpose
Parameters
None.
Description
Since
5.x
docbasefoldertreetest
Configuration File
Scope
All.
Elements
None.
docbasefoldertreetest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseicontest
docbaseicontest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaselockicontest
Purpose
Parameters
None.
Description
Since
5.x
docbaseobjectMainTest
Configuration File
Scope
All.
Elements
None.
docbaseobjectMainTest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseobjecttest
docbaseobjecttest
Purpose
Parameters
lifecycleId (Optional) r_object_id of the document lifecycle

to which the object is attached.
objectId (Optional) r_object_id of the object to be tested.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docbaseobjectvalidatortest
Purpose
Parameters
docformatvalueformattertest
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docformatvalueformattertest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
docsizevalueformattertest
docsizevalueformattertest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
iconwelltest
Purpose
Tests the iconwell control in the dmf tag library.
Parameters
component (Required) At least one component must be

specified as the value of <iconwell>.<id> in the
iconwelltest
Description
Since
5.x
Configuration File
wdk\config\iconwelltest_component.xml
Scope
All.
Elements
iconwell
1 <iconwell>
2<iconwellicon>
3<id>homecabinet_classic</id>
4<icon>icons/iconwell/iconwell_all.gif</icon>
5<label>
<nlsid>MSG_HOME_CABINET</nlsid>
</label>
6<tooltip>
<nlsid>MSG_HOME_CABINET_TIP</nlsid>
</tooltip>
</iconwellicon>
...
7<normalbgimage>images/iconwell/normalBg.gif</normalbgimage>
8<disabledbgimage>images/iconwell/disabledBg.gif</disabledbgimage>
9<selectedbgimage>images/iconwell/selectedBg.gif</selectedbgimage>
10<highlightedbgimage>images/iconwell/highlightedBg.gif</highlightedbgimage>
11<defaultid>inboxclassic</defaultid>
</iconwell>
1 Specifies icons.
2 Specifies one icon.
3 Specifies the component ID.
4 Specifies the relative path to the icon.
5 Specifies the label to display.
6 Specifies the tooltip to display.
7 Specifies the relative path to the normal background image to display.
8 Specifies the relative path to the disabled background image to display.
9 Specifies the relative path to the selected background image to display.
10 Specifies the relative path to the highlighted background image to display.
11 Specifies the default component ID..
inspector
inspector
Purpose
Provides functionality to inspect variable values resulting from test execution.
Parameters
controlTestId (Required)
optArgs (Optional)
uniqueFormId (Required)
Description
Since
6.0
Configuration File
wdk\config\test\inspector_component.xml
Scope
All.
Elements
definition
<definition>
<inputassistanceinspectors>
<inspector>
<inputassistanceclass>com.documentum.web.test.validation.ui.
inputassistance.Checkbox</inputassistanceclass>
<class>com.documentum.web.test.validation.ui.inspector.CheckboxInspector</class>
<jsp>/wdk/system/test/inputassistance/checkboxInputAssistance.jsp</jsp>
</inspector>
...
</inputassistanceinspectors>
<commomcontrolvalidation>
<entry>
<field>visible</field>
<label>
<nlsid>MSG_IS_VISIBLE</nlsid>
</label>
</entry>
...
</commomcontrolvalidation>
<commomcontrolidentity>
<entry>
<field>name</field>
inspector
</entry>
...
</commomcontrolidentity>
<valuevalidation>
<entry>
<field>value</field>
<label>
<nlsid>MSG_VALUE</nlsid>
</label>
</entry>
</valuevalidation>
<dropdownlistvalidation>
<entry>
<field>size</field>
<label>
<nlsid>MSG_SIZE</nlsid>
</label>
</entry>
...
</dropdownlistvalidation>
<labelvalidation>
<entry>
<field>label</field>
<label>
<nlsid>MSG_LABEL</nlsid>
</label>
</entry>
</labelvalidation>
<controls>
<control>
<class>com.documentum.web.formext.control.docbase.DocbaseAttributeLabel</class>
<validation>
<entry>
<reference>commomcontrolvalidation</reference>
</entry>
<entry>
<field>attributeLabel</field>
<label>
<nlsid>MSG_ATTRIBUTE_LABEL</nlsid>
</label>
</entry>
</validation>
<identity>
<entry>
<reference>commomcontrolidentity</reference>
</entry>
<entry>
<field>attribute</field>
</entry>
</identity>
</control>
...
</controls>
</definition>
multidocbasetreetest
multidocbasetreetest
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
Scope
All.
Elements
None.
recordertestcasevariables
Purpose
Parameters
nodeId (Required) For internal use only.

ticket (Required) For internal use only.
recordingurlgenerator
Description
Since
5.x
Configuration File
webcomponent\config\testtool\recordertestcasevariables_component.xml
Scope
All.
Elements
None.
recordingurlgenerator
Purpose
Parameters
target (Required) For internal use only.

Description
Since
5.x
Configuration File
webcomponent\config\testtool\recordingurlgenerator_component.xml
Scope
All.
Elements
None.
showtestcaseresult
showtestcaseresult
Purpose
Parameters
file (Optional) For internal use only.

index (Required) For internal use only.
ticket (Optional) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\testtool\showtestcaseresult_component.xml
Scope
All.
Elements
None.
showtestresult
Purpose
Parameters
None.
taborderoncomponentinclude
Description
Since
5.x
Configuration File
wdk\config\test\showtestresult_component.xml
Scope
All.
Elements
None.
taborderoncomponentinclude
Purpose
For internl use only.
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\samples\samples_component.xml
Scope
All.
Elements
None.
taborderoncomponentincludetest
taborderoncomponentincludetest
Purpose
Parameters
None.
Description
Since
6.0
Configuration File
webcomponent\config\samples\samples_component.xml
Scope
All.
Elements
None.
testbed
Purpose
Provides a testing environment for individual actions and components. Any action or component
from the WDK library, WDK client application library, or custom library built on WDK can be tested.
Also provides a common GUI for test automation.
Parameters
startComp (Optional) Specifies the component that will be

loaded in the content frame initially. Overrides
the value of the <startComp> element.
testbed_generic
Description
Since
5.x
Configuration File
webcomponent\config\testbed\testbed_component.xml
Scope
All.
Elements
startComp
See startComp, page 749.
pageTitle
See pageTitle, page 741.
homeURL
See homeURL, page 737.
startQueryString
See startQueryString, page 749.
testbed_generic
Purpose
Provides actionlink controls for invoking the actions defined by the application. The component also
includes links to navigate to particular components or individual JSP pages. This component works
within the menubar frame of the component testbed, page 1285.
Parameters
cut (Optional) Name of component to test. Default =

attributes
Description
Since
5.x
Configuration File
webcomponent\config\componentTestbed\testbed_generic_component.xml
testbed (Webtop)
Scope
All.
Elements
None.
testbed (Webtop)
Purpose
Provides a testing environment for individual actions and components. Any action or component
from the WDK library, WDK client application library, Webtop library, or custom library built on
WDK and Webtop can be tested. Also provides a common GUI for test automation.
Parameters
The parameters are inherited from testbed:webcomponent/config/testbed/testbed_component.xml.
See testbed, page 1285.
Description
Since
5.x
Configuration File
webtop\config\testbed_component.xml
Parent Definition
testbed:webcomponent/config/testbed/testbed_component.xml
Scope
All.
Elements
pageTitle
See pageTitle, page 741.
startComp
See startComp, page 749.
homeURL
See homeURL, page 737.
testcaseparameters
startQueryString
See startQueryString, page 749.
testcaseparameters
Purpose
Parameters
nodeId (Required) For internal use only.

target (Required) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testcaseparameters_component.xml
Scope
All.
Elements
None.
testiteminfo
Purpose
testlauncher
Parameters
type (Required) For internal use only.

value (Required) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testiteminfo_component.xml
Scope
All.
Elements
None.
testlauncher
Purpose
Parameters

folderPath (Optional) For internal use only.
password (Optional) For internal use only.
username (Optional) For internal use only.
Description
Since
5.x
testlaunchermonitorticker
Configuration File
webcomponent\config\testtool\testlauncher_component.xml
Scope
All.
Elements
None.
testlaunchermonitorticker
Purpose
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testlaunchermonitorticker_component.xml
Scope
All.
Elements
None.
testlaunchermonitortree
testlaunchermonitortree
Purpose
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testlaunchermonitortree_component.xml
Scope
All.
Elements
None.
testlinks
Purpose
Provides actionlink controls for invoking the actions defined by the application. The component also
includes links to navigate to particular components or individual JSP pages. This component works
within the menubar frame of the component testbed, page 1285.
Parameters
None.
testlinks (Webtop)
Description
Since
5.x
Configuration File
Scope
All.
Elements
navigationlinks
See navigationlinks, page 739.
actiontable
See actiontable, page 725.
homecabinet
See homecabinet, page 737.
inbox
See inbox, page 737.
subscriptions
See subscriptions, page 749.
myobjects
See myobjects, page 739.
category
See category, page 726.
cabinets
See cabinets, page 726.
testlinks (Webtop)
Purpose
Description
Since
5.x
Configuration File
webtop\config\testbed_component.xml
testmessage
Parent Definition
testlinks:webcomponent/config/testbed/testbed_component.xml
Scope
All.
Elements
menupath
<menupath>/webcomponent/library/menubar/menubar_body.jsp</menupath>
homecabinet
See homecabinet, page 737.
inbox
See inbox, page 737.
subscriptions
See subscriptions, page 749.
myobjects
See myobjects, page 739.
category
See category, page 726.
cabinets
See cabinets, page 726.
navigationlinks
See navigationlinks, page 739.
actiontable
See actiontable, page 725.
testmessage
Purpose
Displays the last status message that was generated by a component in the testbed component. It also
provides simple search capability. This component loads within the message frame of the component
testbed, page 1285 and cannot be used outside the testbed component.
Parameters
None.
testrecorderlauncher
Description
Since
5.x
Configuration File
Scope
All.
Usage
To see the full list of messages, use the Message List link in the Navigation column of wdklinks.jsp.
The testbed.jsp page contains the onNewMessage() handler which reloads the testmessage
component when a new message should be displayed.
Simple search is implemented using a form with a text field and button. A JavaScript function is
invoked when the form is submitted, calling the search component.
Elements
None.
testrecorderlauncher
Purpose
Parameters
classname (Optional) For internal use only.

configpath (Optional) For internal use only.
folderPath (Optional) For internal use only.
packagename (Optional) For internal use only.
password (Optional) For internal use only.
path (Optional) For internal use only.
testcaseId (Optional) For internal use only.
url (Optional) For internal use only.
username (Optional) For internal use only.
testrecorderlaunchermonitortree
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testrecorderlauncher_component.xml
Scope
All.
Elements
None.
testrecorderlaunchermonitortree
Purpose
Parameters
classTicket (Required) For internal use only.

isRecording (Optional) For internal use only.
setupTicket (Required) For internal use only.
tearDownTicket (Required) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testrecorderlaunchermonitortree_component.xml
Scope
All.
testresultsviewer
Elements
None.
testresultsviewer
Purpose
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testresultsviewer_component.xml
Scope
All.
Elements
None.
testtool
Purpose
Parameters
None.
testxmleditor
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testtool_component.xml
Scope
All.
Elements
None.
testxmleditor
Purpose
Parameters
recordmode (Optional) For internal use only.

ticket (Optional) For internal use only.
Description
Since
5.x
Configuration File
webcomponent\config\testtool\testxmleditor_component.xml
Scope
All.
Elements
None.
unittestcase
unittestcase
Purpose
Provides functionality to perform unit testing of components and actions (that is, testing without any
user interface interaction).
Parameters
None.
Description
Since
6.0
Configuration File
wdk\config\test\unitestcase_component.xml
Scope
All.
Elements
None.
Trees
browsertree (version 6.0) (Webtop)
Purpose
Extends the WDK foldertree component to support custom tree nodes and browsing
through multiple Docbases. The browsertree component adds an optional entryNode
parameter, reads tree nodeconfiguration, and handles tree events. You can set the limit for
Since
6.5
Purpose
Extends the WDK foldertree component to support custom tree nodes and browsing
through multiple Docbases. The browsertree component adds an optional entryNode
parameter, reads tree nodeconfiguration, and handles tree events. You can set the limit for
Parameters
entryNode (Optional) Specifies the node that is initially

selected in the browser tree.
entryObjectId (Optional) ID of the virtual document or
assembly document object associated with the
node that is to be initially selected in the browser
tree. Since 5.3 SP5.
folderPath (Optional) Specifies the folder path to
the node that is initially selected in the
browser tree. This path must be a complete
path from the Docbase root, for example,
/Documentation%20Library/subfolder
Description
Since
5.x
Configuration File
webtop\config\browsertree_component.xml
Parent Definition
foldertree:webcomponent/config/navigation/foldertree/foldertree_component.xml
Scope
All.
Usage
You cannot filter a browsertree node for repository, because all nodes are generated from a single
component configuration file. The result is that every node that is defined in the component definition
is shown for every repository.
You can configure the browsertree component to add a new component node. In your custom
component that extends the browsertree definition, add a new node by adding a <node> block. This
element does not need to contain a <handlerclass> element. The componetid attribute on the <node>
tag specifies the component to be launched when the user selects the tree node.
A simple node without a handler class cannot have custom sub-nodes.
Adding a Tree Node
The following example adds a node that launches the my_coolness component when the user selects
the node in the tree:
<pages><whynot>/custom/library/whynot.jsp</whynot>
</pages>
<node componentid=my_coolness>
<startpage>mycoolpage</startpage>
<icon>reallycoolicon.gif</icon>
<label><nlsid>MSG_COOLCOMPONENT</nlsid></label>
</node>
To refresh the browser tree, fire the client event treeInvalidated in the component class that needs a
tree refresh. For example, in the JSP page classic.jsp, the client event handles the browsertree refresh:
function treeInvalidated(docbase, compId)
{
// inform the BrowserTree of a required tree refresh
window.frames["browser"].safeCall(
"postServerEvent", null, null, null, "onTreeInvalidated", "
docbase", docbase, "componentId", compId);
}
Fire this client event in your control class. For example, HomeCabinetClassicView performs the
refresh in the following way:
public void onRefreshData()
{
super.onRefreshData();
// fire a client event to refresh the WebTop Browser Tree
ArgumentList args = new ArgumentList();
args.add("docbase", getCurrentDocbase());
args.add("componentId", getComponentId());
setClientEvent("treeInvalidated", args);
}
Elements
failoverenabled
clusteringenabled
emptycontentclassic (Webtop)
<clusteringenabled>true</clusteringenabled>
Set to true to enable display of search clusters.

nodes
includevirtualdocuments
<includevirtualdocuments>true</includevirtualdocuments>
Set to true to include virtual documents in the tree.

includeassemblydocuments
<includeassemblydocuments>true</includeassemblydocuments>
Set to true to include virtual document snapshots in the tree.

enableVdmExpandAll
<enableVdmExpandAll>true</enableVdmExpandAll>
Set to true to display a link to expand all nodes in the selected virtual document in the tree
enableVdmCollapseAll
<enableVdmCollapseAll>true</enableVdmCollapseAll>
Set to true to display a link to collapse all nodes in the selected virtual document in the tree.
enableTreeNodeSort
<enableTreeNodeSort>true</enableTreeNodeSort>
To enable (true) or disable the sorting of nodes.

dragdrop
preset_item
emptycontentclassic (Webtop)
Purpose
Monitors the content frame of workarea.jsp for entryNode IDs passed from the browsertree
component. If an entryNode ID is on the request, the component generates a client-side event that
causes the browsertree to reload and initialize the content frame with the requested content.
emptycontentstreamline (Webtop)
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\emptycontentclassic_component.xml
Scope
All.
Elements
failoverenabled
emptycontentstreamline (Webtop)
Purpose
Monitors the content frame of workarea.jsp for entryNode IDs passed from the tabbar component. If
an entryNode ID is on the request, the component generates a client-side event that causes the tabbar
to reload and initialize the content frame with the requested content.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\emptycontentstreamline_component.xml
Scope
All.
foldertree
Elements
failoverenabled
foldertree
Purpose
The folder tree component provides basic folder navigation functionality. The user can browse
cabinets and folders. Failover is enabled for foldertree. This component is extended by the Webtop
browsertree component.
Parameters
folderPath (Optional) Specifies the path to the folder that

serves as the base for navigation. This path must
be a complete path from the repository root, for
Description
Since
5.x
Configuration File
webcomponent\config\navigation\foldertree\foldertree_component.xml
Scope
All.
Usage
You can set the limit for number of folders to be displayed in the tree in the file Environment.properties,
located in /WEB-INF/classes/com/documentum/web/formext. Larger numbers will be replaced with
a More Folders link.
The folder tree component class FolderTree has a single method: onInit(ArgumentList args). This
method gets the folder path parameter if it is supplied as an argument, and sets the base for
navigation to the supplied path or to the root path as supplied by the DocbaseFolderTree control. The
control docbasefoldertree, page 271 must be present in the foldertree component JSP page.
errormessage
Elements
failoverenabled
User feedback
errormessage
Purpose
The errormessage component displays a fatal error message, which appears in a popup dialog box if
and when the error message handler receives a fatal error.
Parameters
None.
Description
Since
5.x
Configuration File
wdk\config\errormessage_component.xml
Scope
All.
Elements
displaystacktrace
<displaystacktrace>true</displaystacktrace>
Set to true to display the stack trace in an error message.

failoverenabled
informinvalidaction
informinvalidaction
Purpose
Displays an error message indicating that the action that uses a dynamic filter is not valid for the
specified object.
Since
6.5
informinvalidactionformessagearchive
Purpose
Displays an error message indicating that the action that uses a dynamic filter is not valid for a
dm_message_archive object.
Since
6.5
informinvalidactionformessagearchiveattach
Purpose
Displays an error message indicating that the action that uses a dynamic filter is not valid for a
dm_message_archive object’s attachments.
Since
6.5
informinvalidactionformultiobjects
informinvalidactionformultiobjects
Purpose
Displays an error message indicating that the action that the user attempted to perform is not valid
for multiple objects.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\informinvalidaction\informinvalidactionformultiobjects_
component.xml
Scope
All.
Elements
None.
informinvalidactionforreference
Purpose
Launched by certain actions that use a dynamic filter to display a message to the user that the action
is invalid for the selected reference object.
Parameters
None.
informinvalidactionforreplica
Description
Since
5.x
Configuration File
webcomponent\config\library\informinvalidaction\informinvalidactionforreference_component.
xml
Scope
All.
Usage
For actions that should not be performed on reference objects, add a dynamic filter to the action
definition and list the action as notdefined for the scope foreign. To create a dynamic filter in the
action definition, see "Dynamic Component Launching in Web Development Kit Development Guide. To
specify the action as notdefined, create an XML file in the /custom/config directory or a subdirectory
with the following type of entries:
<scope type="foreign">

<action id="versions" notdefined="true"></action>
<action id="relationships" notdefined="true"></action>
...
</scope>
Elements
None.
informinvalidactionforreplica
Purpose
Launched by certain actions that use a dynamic filter to display a message to the user that the action
is invalid for the selected replicated object.
Parameters
None.
Description
Since
5.x
messages
Configuration File
webcomponent\config\library\informinvalidaction\informinvalidactionforreplica_component.xml
Scope
All.
Usage
For actions that should not be performed on replica objects, add a dynamic filter to the action
definition and list the action as notdefined for the scope foreign. To create a dynamic filter in the
action definition, see Dynamic Component Launching in Web Development Kit Development Guide. To
specify the action as notdefined, create an XML file in the /custom/config directory or a subdirectory
with the following type of entries:
<scope type="foreign">

<action id="versions" notdefined="true"></action>
<action id="relationships" notdefined="true"> </action>
...
Elements
None.
messages
Purpose
Displays a data grid of all the user’s messages for a session. The error message service passes
non-fatal error messages to the messages component for display.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\messages\messages_component.xml
Scope
All.
messagebar (Webtop)
Usage
The messages component uses the message service to get the result set of messages and initialize a
data grid with the result set. For example:
Datagrid msgGrid = (Datagrid)getControl(
CONTROL_GRID, Datagrid.class);
ResultSet res = MessageService.getResultSet();
msgGrid.getDataProvider().setScrollableResultSet((
ScrollableResultSet)res)
Elements
None.
messagebar (Webtop)
Purpose
Loads into the left side of the status frame in classicview.jsp and streamlineview.jsp, part of the UI of
the component main (Webtop), page 805. The messagebar adds a message bar icon in the bottom
frame in both the class and streamline view of Webtop. The message bar gets messages from the
message service and renders them in the label.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\messagebar_component.xml
Scope
All.
Elements
failoverenabled
ignoreformloadforcomponent
1 <ignoreformloadforcomponent>
modalerrordialog
2<name>messagebar</name>
...
</ignoreformloadforcomponent>
1 Contains one ore more <name> elements

2 Specifies the ID of a component that will not clear the message bar when the component is
rendered.
modalerrordialog
Purpose
This component provides the UI used to present modal error dialogs to the user.
Parameters
forceModal (Optional) Boolean: If this component is being

directed to a non-modal frame, set to true to set
up the forced modality infrastructure.
Description
Since
5.x
Configuration File
webcomponent\config\library\modalerrordialog\modalerrordialog_component.xml
Scope
All.
Elements
None.
prompt
prompt
Purpose
Provides the functionality of a message box. A prompt has a title, a message, and a selection of
buttons: OK, Cancel, Continue, Yes, No, Yes to all, No to all, and Help, any combination of which
can be displayed. There is also an optional icon and "Don’t show this again" checkbox. The don’t
show again feature is enabled only when the prompt component is used within the combocontainer
component.
Parameters
button (Required) The name of the button that will be

displayed. Multiple values may be passed.
dontshowagain (Optional) Boolean flag to display a checkbox
that will hide the prompt the next time the
context of the prompt occurs. The actual
handling of this flag must be implemented in
the caller component.
icon (Optional) Name of icon class.
message (Optional) String message in the prompt frame.
title (Optional) String title for the prompt frame.
Description
Since
5.x
Configuration File
wdk\config\prompt_component.xml
Scope
All.
Usage
The prompt component can either be extended, in order to set the message and title or modify its
behavior, or the component can be driven directly through arguments. In the following example,
the prompt component is nested within another component, and the user is returned to the parent
component after responding to the prompt:
args.add(Prompt.ARG_TITLE, getString(strTitleId));
args.add(Prompt.ARG_MESSAGE, getString(strMessageId));
args.add(Prompt.ARG_ICON, Prompt.ICON_WARNING);
args.add(Prompt.ARG_BUTTONS, Prompt.CONTINUE + "," +
prompt
Prompt.CANCEL);
args.add(Prompt.ARG_DONTSHOWAGAIN,
"true");
setComponentNested("prompt", args, getContext());
For an example of the usage of the prompt component, see the combo container. The prompt
component is displayed when a user clicks OK before the last page has been displayed.
Handling DONTSHOWAGAIN
If you want to give the user the option of turning off the prompt when the prompt context arises,
your calling component must set the dontshowagain argument and then handle the user’s selection.
You should store the selection as a preference and retrieve it in your component.
The following example sets up the prompt component based on the user’s preference:
public void onEvent(Control control, ArgumentList args)
{
...
// display prompt conditionally
if (showPrompt())
// see helper below
{
args.add(Prompt.ARG_TITLE, getString(TITLE));
args.add(Prompt.ARG_MESSAGE, getString(MESSAGE));
args.add(Prompt.ARG_ICON, Prompt.ICON_WARNING);
args.add(Prompt.ARG_BUTTONS, Prompt.CONTINUE + "," +
Prompt.CANCEL);
args.add(Prompt.ARG_DONTSHOWAGAIN, "true");
setComponentNested("prompt", args, getContext());
}
}
The helper method gets the user preference:

private boolean showPrompt()
{
IPreferenceStore preferences = PreferenceService.
getPreferenceStore();
return (preferences.readBoolean(
INHIBIT_PROMPT_PREFERENCE) == null);
}
// unique preference string
final private static String INHIBIT_PROMPT_PREFERENCE
= " com.documentum...";
The component onRender() method checks the prompt return and whether to inhibit or show the
prompt:
public void onRender()
{
...
// check whether the prompt has returned
String strButton = (String)getReturnedValue(
Prompt.RTN_BUTTON);
String strDontShowAgain = (String)getReturnedValue(
Prompt.RTN_DONTSHOWAGAIN);
if (strButton != null || strDontShowAgain != null)

{
// remove return values
removeReturnedValue(Prompt.RTN_BUTTON);
removeReturnedValue(Prompt.RTN_DONTSHOWAGAIN);
if ( strButton.equals(Prompt.CONTINUE) )
{
promptinput
// inhibit prompt if 'dont show again' was selected

if ( strDontShowAgain != null && Boolean.valueOf(
strDontShowAgain).booleanValue())
{
inhibitPrompt();
// see inhibitPrompt() helper below
}
// perform task
}
}
}
Another helper method writes the preference:

private void inhibitPrompt()
{
IPreferenceStore preferences = PreferenceService.
getPreferenceStore();
preferences.writeBoolean(
INHIBIT_PROMPT_PREFERENCE, Boolean.TRUE);
}
Elements
None.
promptinput
Purpose
Prompts users for input.
Parameters
input (Required) Text that users enter.

message (Optional) Text that is displayed requesting
input from users.
values (Optional) Valid values that users can choose.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\promptinput_component.xml
promptinputcontainer
Scope
All.
Elements
None.
promptinputcontainer
Purpose
Container for components that prompt users for input.
Parameters

input (Required) Text that users enter.
message (Optional) Text that is displayed requesting
input from users.
values (Optional) Valid values that users can choose.
Description
Since
5.x
Configuration File
webcomponent\config\library\contenttransfer\promptinputcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
statusbar (Webtop)
statusbar (Webtop)
Purpose
Displays a status message in statusbar.jsp, which is the source page for the bottom frame in both
the class and streamline view of Webtop. The status bar displays a button to show all messages and
tabs that toggle between the classic and streamline views. The error messages are passed in from
the message service.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\statusbar_component.xml
Scope
All.
Elements
failoverenabled
Users, groups, and roles
adminuserorgrouplocator
Purpose
Locates users and groups in a repository.
Parameters
adminuserorgrouplocator
Description
Since
5.x
Configuration File
webcomponent\config\admin\adminuserorgrouplocator\adminuserorgrouplocator_component.
xml
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
objecttype

preset_item
privategroupvisible
views
adminuserorgrouplocatorcontainer
adminuserorgrouplocatorcontainer
Purpose
Locates users and groups in a repository.
Parameters

drop-down list.
Description
Since
5.x
Configuration File
webcomponent\config\admin\adminuserorgrouplocator\adminuserorgrouplocator_component.
xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
groupattributes
Purpose
Creates a new user profile and edits existing user groups.
groupdelete
Parameters
objectId (Required) The ID of the selected group.

objectname (Required) The name of the selected group.
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\groupattributes_component.xml
Scope
All.
Elements
None.
groupdelete
Purpose
Deletes an existing user group. Warns the administrator about the repercussions of performing this
task and offers alternative solutions.
Parameters
objectId (Required) The ID of the group to delete.

objectname (Required) The name of the group to delete.
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\groupdelete_component.xml
grouplist
Scope
All.
Elements
None.
grouplist
Purpose
Displays a list of all user groups present in the repository. It provides the ability to drill down in a
group to view all the users and groups within the group.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\grouplist_component.xml
Scope
All.
Usage
To preserve repository consistency, do not remove groups from the repository. Remove all members
of the group and leave the empty group in the repository. When you delete a group, the server does
not remove the group’s name from objects in the repository, such as ACLs and other groups. You can
delete a group, and then create a group with the same name. If you create a new group with the same
name as a deleted group, the new group inherits the group memberships and object permissions
belonging to the deleted group.
Elements
showbreadcrumb
grouplocator
grouplocator
Purpose
Displays a list of groups in the repository.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\grouplocator_component.xml
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
objecttype
grouplocatorcontainer

preset_item
privategroupvisible
views
grouplocatorcontainer
Purpose
Extends the container locatorcontainer, page 960 and contains one or more grouplocator, page 1320.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
groupproperties
groupproperties
Purpose
Extends the container adminpropertycontainer, page 755 and displays properties components for the
selected group. It overrides some of the behavior from the adminpropertycontainer component. and
contains groupattributes, page 1317.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\admin\group\groupproperties_component.xml
Parent Definition
component.xml
Scope
All.
Elements
objecttype
grouprename
Purpose
Reassigns an existing group. The administrator can reassign all the objects owned by the current
group and generate an exhaustive report.
groupwhereused
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\admin\group\grouprename_component.xml
Scope
All.
Elements
None.
groupwhereused
Purpose
Lists the locations where the selected group is being used; for example, it lists all sysobjects owned
by the group, acls in which the group exists, and workflows for which the group is a designated
performer.
Parameters
objectId (Required) Object ID of the group to locate.

objectname (Required) Object name of the group to locate.
Description
Since
5.x
recentgrouplocator
Configuration File
webcomponent\config\admin\group\groupwhereused_component.xml
Scope
All.
Elements
None.
recentgrouplocator
Purpose
Extends recentuserorgrouplocator, page 1326 and locates user groups that were recently selected or
used. This component has no scope, but <objecttype> element restricts the search to dm_group objects.
Parameters
The parameters are inherited from recentuserorgrouplocator:webcomponent/config/library/locator/
recentuserorgrouplocator_component.xml. See recentuserorgrouplocator, page 1326.
Description
Since
5.x
Configuration File
Parent Definition
recentuserorgrouplocator:webcomponent/config/library/locator/recentuserorgrouplocator_
component.xml
Scope
All.
Elements
columns
failoverenabled
This element structure is inherited from recentuserorgrouplocator:webcomponent/config/library/
locator/recentuserorgrouplocator_component.xml. See recentuserorgrouplocator, page 1326.
recentuseronlylocator
iconwell_icon
objecttype

views
recentuseronlylocator
Purpose
Extends recentuserorgrouplocator, page 1326 and locates users that were recently selected or
changed. This component has no scope, but the <objecttype> element restricts the search to objects
of type dm_user.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\useronlylocator_component.xml
Parent Definition
recentuserorgrouplocator:webcomponent/config/library/locator/recentuserorgrouplocator_
component.xml
Scope
All.
Elements
columns
failoverenabled
This element structure is inherited from recentuserorgrouplocator:webcomponent/config/library/
locator/recentuserorgrouplocator_component.xml. See recentuserorgrouplocator, page 1326.
recentuserorgrouplocator
iconwell_icon
objecttype

useronly
See useronly, page 751.
views
recentuserorgrouplocator
Purpose
Extends objectlocator, page 964 and locates users or groups that were recently selected or modified.
This component has no scope, but the <objecttype> element restricts the search to objects of type
dm_user or dm_group.
Parameters

multiple selection.
objecttype (Optional) Object type to display in the list.
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\recentuserorgrouplocator_component.xml
Parent Definition
Scope
All.
renamegrouplist
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
objecttype

useronly
views
renamegrouplist
Purpose
Extends renamejobrequestlist, page 1080 and displays job requests for rename user or group.
Parameters

Description
Since
5.x
renamereport
Configuration File
webcomponent\config\admin\renamelog\renamegrouplist_component.xml
Parent Definition
renamejobrequestlist:webcomponent/config/admin/renamelog/renamejobrequestlist_component.xml
Scope
All.
Elements
None.
renamereport
Purpose
Displays job requests for rename user or group.
Parameters
objectId (Required) ID of the selected report

oldname (Optional) Name of the report before rename
Description
Since
5.x
Configuration File
webcomponent\config\admin\renamelog\renamereport_component.xml
Scope
All.
Elements
None.
renameuserlist
renameuserlist
Purpose
Extends renamejobrequestlist, page 1080 and displays job requests for renaming users.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\admin\renamelog\renameuserlist_component.xml
Parent Definition
renamejobrequestlist:webcomponent/config/admin/renamelog/renamejobrequestlist_component.xml
Scope
All.
Elements
None.
roleattributes
Purpose
Extends the component groupattributes, page 1317 and displays a list of attributes of a role
(dm_group object with attributes group_class="role" and group_name=" role_name").
Parameters
The parameters are inherited from groupattributes:webcomponent/config/admin/group/
groupattributes_component.xml. See groupattributes, page 1317.
rolelist
Description
Since
5.x
Configuration File
webcomponent\config\admin\role\roleattributes_component.xml
Parent Definition
groupattributes:webcomponent/config/admin/group/groupattributes_component.xml
Scope
All.
Elements
None.
rolelist
Purpose
Extends the component grouplist, page 1319 and displays a list of objects of type dm_group with
attributes group_class="role" and group_name=" role_name". This component is a node in the
usermanagement, page 1338 component.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\role\rolelist_component.xml
Parent Definition
grouplist:webcomponent/config/admin/group/grouplist_component.xml
roleproperties
Scope
All.
Elements
showbreadcrumb
roleproperties
Purpose
Extends the container adminpropertycontainer, page 755 and displays a list of object attributes of
type dm_group with attributes group_class="role" and group_name=" role_name". Contains the
roleattributes component.
Parameters

role.
objectname (Required) Name of the object.
Description
Since
5.x
Configuration File
webcomponent\config\admin\role\roleproperties_component.xml
Parent Definition
component.xml
Scope
All.
Elements
objecttype
useraclobjectlocator
useraclobjectlocator
Purpose
Browses for ACLs that are owned by the user.
Parameters
The parameters are inherited from aclobjectlocator:webcomponent/config/library/locator/
aclobjectlocator_component.xml. See aclobjectlocator, page 1235.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\useraclobjectlocator_component.xml
Parent Definition
aclobjectlocator:webcomponent/config/library/locator/aclobjectlocator_component.xml
Scope
All.
Elements
attributes
columns
failoverenabled
This element structure is inherited from aclobjectlocator:webcomponent/config/library/locator/
aclobjectlocator_component.xml. See aclobjectlocator, page 1235.
iconwell_icon
objecttype
useraclobjectlocatorcontainer
preset_item
views
useraclobjectlocatorcontainer
Purpose
Browses for ACLs that are owned by the user. The container extends the container aclobjectlocator,
page 1235.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\useraclobjectlocator_component.xml
Parent Definition
aclobjectlocatorcontainer:webcomponent/config/library/locator/aclobjectlocator_component.xml
Scope
All.
Elements
failoverenabled
This element structure is inherited from locatorcontainer:webcomponent/config/library/locator/
userattributes
userattributes
Purpose
Creates new user profiles and edits existing user profiles. Administrators can set all the attributes of
the user object, such as name, email, privileges, and default group.
Parameters
objectId (Required) Object ID of the user object whose

attributes to set.
objectname (Required) Object name of the user object whose
attributes to set.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userattributes_component.xml
Scope
All.
Elements
None.
userchangehomedblist
Purpose
Displays user change home repository job requests and their status.
Parameters
None.
userchangestate
Description
Since
5.x
Configuration File
webcomponent\config\admin\renamelog\userchangehomedblist_component.xml
Scope
All.
Elements
None.
userchangestate
Purpose
Changes the state of the user. When the administrator changes the state of the user from active to
inactive, this component offers the choice of unlocking all objects locked by the user.
Parameters
objectId (Required) Object ID of the user object whose

state to change.
objectname (Required) Object name of the user object whose
state to change.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userchangestate_component.xml
Scope
All.
userdelete
Elements
None.
userdelete
Purpose
Deletes an existing user profile from the repository. The component warns the administrator of the
repercussions of performing this task and offers alternative solutions.
Parameters
objectId (Required) Object ID of the user object to delete.

objectname (Required) Object name of the user object to
delete.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userdelete_component.xml
Scope
All.
Elements
None.
userimport
Purpose
Imports users through a LDIFF (list difference) utility. The administrator can select the ldiff format
file containing information about all the users. The component also offers the choice of overriding
any of the user attributes. The component must run within the userimportcontainer.
userlist
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userimport_component.xml
Scope
All.
Elements
None.
userlist
Purpose
Searches for a user or pages through a list of all the users in the repository.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userlist_component.xml
Scope
All.
usermanagement
Elements
showbreadcrumb
usermanagement
Purpose
Extends nodemanagement, page 756 and defines the subnodes (components) of the usermanagement
node: userlist, grouplist, and rolelist
Parameters
The parameters are inherited from nodemanagement:webcomponent/config/admin/
nodemanagement/nodemanagement_component.xml. See nodemanagement, page 756.
Description
Since
5.x
Configuration File
webcomponent\config\admin\usermanagement\usermanagement_component.xml
Parent Definition
nodemanagement:webcomponent/config/admin/nodemanagement/nodemanagement_component.
xml
Scope
All.
Elements
None.
useronlylocator
useronlylocator
Purpose
Locates users in a repository. The component allows users to navigate from user groups to find a
user. This component extends userorgrouplocator, page 1341.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
useronlylocatorcontainer
objecttype

preset_item
privategroupvisible
views
useronlylocatorcontainer
Purpose
Extends locatorcontainer, page 960 and contains user locators: useronlylocator, page 1339 and
recentuseronlylocator, page 1325.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
userorgrouplocator
userorgrouplocator
Purpose
Extends objectlocator, page 964 and locates users and groups in a repository.
Parameters

of users and groups in a sequential order.
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\userorgrouplocator_component.xml
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
userorgrouplocatorcontainer
iconwell_icon
objecttype

preset_item
privategroupvisible
views
userorgrouplocatorcontainer
Purpose
Extends locatorcontainer, page 960 and contains the locator components userorgrouplocator, page
1341 and recentuserorgrouplocator, page 1326.
Parameters

of objects in a sequential order.
drop-down list.
selectedobjectids (Optional) IDs of the objects selected when the
component is displayed
Description
Since
5.x
userorgroupmemberlocator
Configuration File
webcomponent\config\library\locator\userorgrouplocator_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
multidocbasesupport
userorgroupmemberlocator
Purpose
Extends userorgrouplocator, page 1341 and locates users and group members in a repository.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\userorgroupmemberlocator_component.xml
Parent Definition
Scope
All.
userorgroupmemberlocatorcontainer
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
objecttype

preset_item
privategroupvisible
views
userorgroupmemberlocatorcontainer
Purpose
Extends userorgrouplocatorcontainer, page 1342 and contains the locator components
userorgroupmemberlocator, page 1343 and recentuserorgrouplocator, page 1326.
userproperties
Parameters

drop-down list.
Description
Since
5.x
Configuration File
webcomponent\config\admin\group\userorgroupmemberlocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
userproperties
Purpose
Extends adminpropertycontainer, page 755 and overrides some of the behavior of the container.
Contains userattributes, page 1334.
Parameters
objectId (Required) Object ID of the user.

objectname (Required) Object name of the user.
userrename
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userproperties_component.xml
Parent Definition
component.xml
Scope
All.
Elements
objecttype
userrename
Purpose
Reassigns an existing user. The administrator is offered choices such as reassigning all the objects
owned by the current user and generating a report.
Parameters
objectId (Required) Object ID of the user to rename.

objectname (Required) Current object name of the user.
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userrename_component.xml
userwhereused
Scope
All.
Elements
None.
userwhereused
Purpose
Finds where a selected user has activity, for example, all sysobjects owned by the user, groups in
which the user exists, and workflows for which the user is a designated performer.
Parameters
objectname (Required) Name of the user
Description
Since
5.x
Configuration File
webcomponent\config\admin\user\userwhereused_component.xml
Scope
All.
Elements
None.
assemblylist
Virtual document assemblies
assemblylist
Purpose
Displays the structure of a virtual document snapshot. The user can navigate to the different parts of
the virtual document snapshot by clicking on the breadcrumb or the child node. This component has
an extended version in Webtop called assemblylist.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\navigation\vdm\assemblylist_component.xml
Parent Definition
Scope
All.
Elements
columns
dragdrop
preset_item
assemblylist (Webtop)
assemblylist (Webtop)
Purpose
Displays the structure of a virtual document snapshot. The user can navigate to the different parts of
the virtual document snapshot by clicking on the breadcrumb or the child node.
Parameters
Description
Since
6.0
Configuration File
webtop\config\assemblylist_component.xml
Parent Definition
assemblylist:webcomponent/config/navigation/vdm/assemblylist_component.xml
Scope
All.
Elements
dragdrop
assemblyliststreamline
Purpose
Displays a list of virtual document snapshots in drilldown (streamline) view.
Parameters
assemblyliststreamline (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\navigation\vdm\assemblyliststreamline_component.xml
Parent Definition
Scope
All.
Elements
columns
dragdrop
assemblyliststreamline (Webtop)
Purpose
Displays a list of virtual document snapshots in drilldown (streamline) view.
Parameters
Description
Since
6.0
Configuration File
webtop\config\assemblyliststreamline_component.xml
newassembly
Parent Definition
assemblyliststreamline:webcomponent/config/navigation/vdm/assemblyliststreamline_component.
xml
Scope
All.
Elements
dragdrop
newassembly
Purpose
Creates a new virtual document snapshot. The user must have a contributor role assigned in the
repository. The container extends newdoccontainer and contains the newassembly component as well
as the attributes and permissions components, to set attributes and permissions on the new snapshot.
Parameters
folderId (Optional) ID of the folder in which to create

the assembly
nodeId (Optional) ID of root node in the virtual
document
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\newassembly\newassembly_component.xml
Scope
All.
Elements
None.
newassemblycontainer
newassemblycontainer
Purpose
Contains component used to create a new assembly and set its attributes and permissions.
Parameters
The parameters are inherited from newdoccontainer:webcomponent/config/library/create/
newdoccontainer_component.xml. See newdoccontainer, page 942.
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\newassembly\newassemblycontainer_component.xml
Parent Definition
Scope
All.
Elements
newcomponentname
numberedtabs
viewassemblies
Purpose
Displays a list of all assemblies that contain a specified object
viewassemblies
Parameters

folderId (Optional) Specifies the ID of the primary
location for the folder in which the assembly is
located
a complete path from the Docbase root, for
example, /Documentation%20Library/subfolder
virtual document.
objectId (Required) ID of the assembly to view
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\viewassemblies\viewassemblies_component.xml
Parent Definition
Scope
All.
Elements
columns
header
nondocbasecolumns
viewassemblies (Webtop)
viewassemblies (Webtop)
Purpose
Displays a list of all assemblies that contain a specified object.
Parameters
The parameters are inherited from viewassemblies:/webcomponent/config/library/vdm/
viewassemblies/viewassemblies_component.xml. See viewassemblies, page 1352.
Description
Since
5.x
Configuration File
webtop\config\viewassemblies_component.xml
Parent Definition
viewassemblies:/webcomponent/config/library/vdm/viewassemblies/viewassemblies_component.
xml
Scope
All.
Elements
None.
Virtual documents
addchildsysobjectlocator
Purpose
Locates sysobjects to add to a virtual document. Two types of views are supported: flatlist, in which
all selectable objects in the repository are shown, and hierarchical, in which the user can drill down
addchildsysobjectlocator
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\addcomponent\addchildsysobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
objecttype
addchildsysobjectlocatorcontainer
views
addchildsysobjectlocatorcontainer
Purpose
Locates sysobjects to add to a virtual document. Two types of views are supported: flatlist, in which
all selectable objects in the repository are shown, and hierarchical, in which the user can drill down
Parameters

in a flat list, set to false to display a drop-down
list
multiselect (Required) Boolean. Set to true to support
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\addcomponent\addchildsysobjectlocatorcontainer_
component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
Purpose
Adds a new node to a virtual document, enabling the user to create the content of the node.
Parameters

nodeId (Optional) Node ID of the parent node under
which to add the new content.
objectId (Required) Object ID of the parent object.
document.
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\addcomponent\addnewvirtualdocumentnode_component.
xml
Scope
type dm_sysobject
Elements
None.
addvirtualdocumentnode (type dm_sysobject)
addvirtualdocumentnode (type dm_sysobject)
Purpose
Adds a node to a virtual document.
Parameters
insertAfterNodeId (Optional) Node ID of the virtual document

node after which to add the new node.
newNodeIds (Optional)
newNodeObjectIds (Required) Comma-delimited string of new
object IDs for the objects that are to be added
to the virtual document
newVDRootNodeIds (Optional)
nodeId (Optional) Node ID of the parent node for the
new node.
objectId (Required) Object ID of the parent node for the
new node.
document.
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\addcomponent\addvirtualdocumentnode_component.xml
Scope
type dm_sysobject
Elements
None.
addvirtualdocumentnodefromclipboard (type dm_sysobject)
addvirtualdocumentnodefromclipboard (type
dm_sysobject)
Purpose
Adds an object from the clipboard to a virtual document
Parameters
lockOwner (Optional) Name of the user who owns the root

node of the virtual document
nodeId (Optional) Node ID of the object to operate on,
objectId (Required) ID of the object being added to the
virtual document
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\addcomponent\addvirtualdocumentnodefromclipboard_
component.xml
Scope
type dm_sysobject
Elements
None.
addvirtualdocumentnodefromfileselector (type dm_sysobject)
addvirtualdocumentnodefromfileselector (type
dm_sysobject)
Purpose
Adds an object to a virtual document that is selected by the user. This component nests to the
addchildsysobjectlocatorcontainer component to make the object selection.
Parameters
lockOwner (Optional) Name of the owner of the virtual

document root node
nodeId (Optional) Node ID of the object to operate on,
virtual document
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\addcomponent\addvirtualdocumentnodefromfileselector_
component.xml
Scope
type dm_sysobject
Elements
None.
removevirtualdocumentnode
Purpose
This component is used to remove a node from a virtual document.
Parameters
nodeId (Required) ID of the node to be removed from

the virtual document
vdmRootObjectId (Required) ID of the root document of the
virtual document from which the node is being
removed
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\removecomponent\removevirtualdocumentnode_component.
xml
Scope
All.
Elements
None.
removevirtualdocumentnodecontainer
Purpose
This component displays the removevirtualdocumentnode component and allows the user to remove
a node from a virtual document.
removevirtualdocumentnodecontainer
Parameters

action execution class.) ID of the component
being displayed
class.) List of arguments and values to pass
to each contained component.(Required) This
parameter is supplied by the LaunchComponent
class and consists of a list of arguments and
nodeId (Required) ID of the node being removed from
the virtual document(Required) ID of the node
being removed from the virtual document
vdmRootObjectId (Required) ID of the root node of the virtual
document from which the node is being
removed(Required) ID of the root node of the
virtual document from which the node is being
removed
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\removecomponent\removevirtualdocumentnodecontainer_
component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
reordervirtualdocumentnodes
reordervirtualdocumentnodes
Purpose
This component is used to change the order of nodes in a virtual document.
Parameters
nodeId (Required) ID of node being reordered

vdmRootObjectId (Required) ID of root node
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\reordercomponents\reordervirtualdocumentnodes_
component.xml
Scope
All.
Elements
None.
repositionvirtualdocumentnode (type dm_sysobject)
Purpose
Contains one or more components that move a virtual document node to a different part of the
virtual document tree
savechanges
Parameters
insertAfterNodeId (Optional) Node ID of the node after which the

object should be added
nodeId (Required) Node ID of the object to operate on,
targetParentNodeId (Required) Node ID of the parent node to which
the object will be added
vdmRootObjectId (Required) Object ID of the root of a virtual
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\repositionnode\repositionvirtualdocumentnode_component.
xml
Scope
type dm_sysobject
Elements
None.
savechanges
Purpose
Provides the UI and functionality for saving changes made to virtual document structures.
Parameters
closeUponCompletion (Optional) Set to true to close the virtual

document after changes are saved.
objectId (Optional) ID of the virtual document
savechanges (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\savechanges\savechanges_component.xml
Scope
All.
Elements
None.
savechanges (Webtop)
Purpose
Provides the UI and functionality for saving changes made to virtual document structures.
Parameters
closeUponCompletion (Optional) Set to true to close the virtual

document after changes are saved.
objectId (Optional) ID of the virtual document
Description
Since
6.5
Configuration File
webtop\config\savechanges_component.xml
Scope
All.
Elements
None.
setbindingrule
setbindingrule
Purpose
Launched by the setbindingrule action, this component extends checkout and allows the user to set a
binding rule on a virtual document node. Displays the binding rule and version for the selected node.
The container extends checkoutcontainer and performs the actual setting of the binding rule.
Parameters
nodeId (Required) ID of the selected node for which to

display the binding rule
vdmRootObjectId (Required) ID of the root node of the virtual
document to which the node is bound
Description
Since
5.x
Configuration File
webcomponent\config\library\vdm\setbindingrule\setbindingrule_component.xml
Scope
All.
Elements
None.
vdm_preferences
Purpose
Enables the user to set preferences for Virtual Document Manager (VDM).
Parameters
None.
vdm_preferences (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\environment\preferences\vdm\vdm_preferences_component.xml
Scope
All.
Elements
None.
vdm_preferences (Webtop)
Purpose
Enables the user to set display preferences for Virtual Document Manager (VDM).
Description
Since
5.x
Configuration File
webtop\config\vdm_preferences_component.xml
Parent Definition
vdm_preferences:webcomponent/config/environment/preferences/vdm/vdm_preferences_
component.xml
Scope
All.
Elements
None.
vdmclickactionprompt
vdmclickactionprompt
Purpose
Displays a dialog when the user clicks a link to a virtual document that allows the user to open the
virtual document in an editing application or open the virtual document manager to edit the structure.
Parameters

isLaunchedFromDRL (Optional) Boolean: Whether the link to the
virtual document was a DRL (True) or not
(False).Since 5.3 SP5.
the object is a reference object.
breadcrumb
useAssembly (Optional) Set to true for virtual document
assembly objects
Description
Since
5.x
Configuration File
webcomponent\config\navigation\vdm\vdmclickactionprompt_component.xml
Scope
All.
vdmclickactionprompt (Webtop)
Elements
None.
vdmclickactionprompt (Webtop)
Purpose
Displays a dialog when the user clicks a link to a virtual document that allows the user to open the
virtual document in an editing application or open the virtual document manager to edit the structure.
Parameters
The parameters are inherited from vdmclickactionprompt:webcomponent/config/navigation/vdm/
vdmclickactionprompt_component.xml. See vdmclickactionprompt, page 1368.
Description
Since
5.x
Configuration File
webtop\config\vdmclickactionprompt_component.xml
Parent Definition
vdmclickactionprompt:webcomponent/config/navigation/vdm/vdmclickactionprompt_component.
xml
Scope
All.
Elements
None.
vdmclickactionpromptcontainer
Purpose
Contains one or more vdmclickactionprompt components
vdmcopyoption
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\navigation\vdm\vdmclickactionpromptcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
vdmcopyoption
Purpose
Launches the vdmcopyoption component in the dialogcontainer to present the user with options for
the type of copy operation on a virtual document.
Parameters
objectName (Required) Name of the object that will be

copied.
Description
Since
5.x
vdmlist
Configuration File
webcomponent\config\library\vdm\copyoption\copyoption_component.xml
Scope
All.
Elements
None.
vdmlist
Purpose
Displays the structure of a virtual document. The user can navigate to the different parts of the
virtual document by clicking on the breadcrumb or the child node. This component has an extended
version in Webtop called vdmlist.
Parameters
nodeId (Optional) ID of the node in a virtual document.

breadcrumb.
component is first displayed.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\vdm\vdmlist_component.xml
Scope
All.
vdmlist (Webtop)
Usage
To make the late binding value display by default for each node, make the r_object_id column visible
in the component definition. Users who customize the column display can add this as the "Fix to
Version column.
Elements
columns
dragdrop
preset_item
vdmlist (Webtop)
Purpose
Extends the WDK vdmlist component and adds support for the classic view. Displays the structure of
a virtual document. The user can navigate to the different parts of the virtual document by clicking
on the breadcrumb or the child node.
Parameters
Description
Since
5.x
Configuration File
webtop\config\vdmlist_component.xml
Parent Definition
Scope
All.
vdmliststreamline
Elements
columns
dragdrop
preset_item
vdmliststreamline
Purpose
document’s hierarchy, and displays menus to launch actions on selected items. Deprecated as of version
6.
Parameters
nodeId (Optional) ID of the node in a virtual document.

breadcrumb.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\vdm\vdmliststreamline_component.xml
Scope
All.
vdmliststreamline (Webtop)
Usage
To make the late binding value display by default for each node, make the r_object_id column visible
in the component definition. Users who customize the column display can add this as the "Fix to
Version column.
Elements
columns
dragdrop
vdmliststreamline (Webtop)
Purpose
document’s hierarchy, and displays menus to launch actions on selected items.
Parameters
Description
Since
5.x
Configuration File
webtop\config\vdmliststreamline_component.xml
Parent Definition
Scope
All.
vdmvalidate
Elements
columns
dragdrop
vdmvalidate
Purpose
Validates the XML of an XML virtual document node.
Parameters
maxDisplayError (Required) Maximum number of validation

errors to display.
nodeId (Required) Node ID of the node to validate.
objectId (Required) Object ID of node to validate.
document.
Description
Since
6.0
Configuration File
webcomponent\config\library\vdm\validate\vdmvalidate_component.xml
Scope
All.
Elements
None.
vdmvalidate_container
vdmvalidate_container
Purpose
Container for the vdmvalidate, page 1375component.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\vdm\validate\vdmvalidatecontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
Workflow reporting
historicalactivityreportresults
Purpose
Displays the results of a historical activity report query.
Parameters
process_id (Required) ID of the workflow template

(process) on which to report
query (Required) When the querytype is string, this
value is the search string. If the querytype is not
string, this value is the query string.
title (Optional) Title to be displayed at the top of the
report
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\activityresults_component.xml
Scope
All.
Elements
columns_list
failoverenabled
Purpose
This component displays a workflow process historical report.
Parameters
None.
historicalprocessreportcontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\processreport_component.xml
Scope
All.
Elements
See cost_attribute_conditions, page 730.
See duration_attribute_conditions, page 734.
failoverenabled
showjobstatus
See showjobstatus, page 748.
historicalprocessreportcontainer
Purpose
This component is used to display historical workflow reports for processes and performers.
Parameters
component (Optional) ID of the component to be displayed
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\processreportcontainer_component.xml
historicalprocessreportresults
Parent Definition
Scope
All.
Elements
failoverenabled
historicalprocessreportresults
Purpose
This component is used to display reports on workflow processes that have been completed.
Parameters

title (Optional) The title that will appear at the top
of the report.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\processresults_component.xml
Scope
All.
Elements
columns_list
historicalreportcolumnselector
failoverenabled
historicalreportcolumnselector
Purpose
This component provides UI and behavior for selecting the columns and column order for view
components such as DocList and Drilldown.
Parameters
baseType (Optional) Specifies the repository types, in

addition to the default option, to populate the
attribute selectors docbase types drop-down list.
columns (Required) A serialized list of items to populate
the available items list box. See multiselector
control for details on the list format.
defaultSelectedColumns (Optional) A serialized list of items to populate
the selected items list box before the user
performs an initial selection.
selectedColumns (Optional) A serialized list of items to populate
the selected columns list box.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\columnselector_component.xml
Parent Definition
columnselector:webcomponent/config/environment/preferences/display/columnselector_component.
xml
Scope
All.
Elements
None.
Purpose
This component displays a workflow process historical report for a performer.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\userreport_component.xml
Scope
All.
Elements
See cost_attribute_conditions, page 730.
See duration_attribute_conditions, page 734.
failoverenabled
showjobstatus
See showjobstatus, page 748.
historicaluserreportcontainer
historicaluserreportcontainer
Purpose
This component is a container for components that display historical user reports.
Parameters
component (Optional) ID of the component to display
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\userreportcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
historicaluserreportresults
Purpose
This component displays the report results of a historical workflow process report for a performer.
processdetailreportresults
Parameters

string, this value is the querystring.
title (Optional) The title to display at the top of the
report.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\userresults_component.xml
Scope
All.
Elements
columns_list
failoverenabled
processdetailreportresults
Purpose
Displays the results of a workflow process
Parameters
process_id (Required) ID of the workflow process

(template)
title (Optional) Title for the report
reportdetailsauditclassic (type dm_workflow) (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\processdetailresults_component.xml
Scope
All.
Elements
columns_list
failoverenabled
reportdetailsauditclassic (type dm_workflow)

(Webtop)
Purpose
Extends the WDK component reportdetailsauditlist to display the audit events of a workflow
instance. Called by the WDK action reportdetailsauditlist. The user will see no events if the workflow
is not audited.
Parameters
The parameters are inherited from reportdetailsauditlist:webcomponent/config/library/workflow/
reportdetails/reportdetailsauditlist_component.xml. See reportdetailsauditlist, page 1386.
Description
Since
5.x
Configuration File
webtop\config\reportdetailsauditclassic_component.xml
Parent Definition
reportdetailsauditlist:webcomponent/config/library/workflow/reportdetails/reportdetailsauditlist_
component.xml
reportdetailsauditdrilldown
Scope
type dm_workflow
Elements
columns
hideEvents
See hideEvents, page 736.
reportdetailsauditdrilldown
Purpose
This component displays the audit events of a workflow instance. The user will see no events if
the workflow is not audited.
Parameters
eventFilter (Optional) Specifies the filter to use: 0 = show

workflow events | 1 = show workflow and doc
events
hideEvents (Optional) String of event names that should not
be displayed.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetails\reportdetailsauditdrilldown_component.
xml
Scope
All.
Elements
columns
reportdetailsauditlist
reportdetailsauditlist
Purpose
This component displays the audit events of a workflow instance. The user will see no events if
Parameters
eventFilter (Optional) Specifies the filter to use: 0 = show

workflow events | 1 = show workflow and doc
events
hideEvents (Optional) String of event names that should
not be displayed. Event names are listed in the
Content Server API Reference Manual.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetails\reportdetailsauditlist_component.xml
Scope
All.
Elements
columns
reportdetailsauditstreamline (type dm_workflow)

(Webtop)
Purpose
Extends WDK reportdetailsauditdrilldown component to display the audit events of a workflow
instance. Called by the WDK action reportdetailsauditdrilldown. The user will see no events if
reportdetailscontainerclassic (type dm_workflow) (Webtop)
Parameters
The parameters are inherited from reportdetailsauditdrilldown:webcomponent/config/
library/workflow/reportdetails/reportdetailsauditdrilldown_component.xml. See
reportdetailsauditdrilldown, page 1385.
Description
Since
5.x
Configuration File
webtop\config\reportdetailsauditstreamline_component.xml
Parent Definition
reportdetailsauditdrilldown:webcomponent/config/library/workflow/reportdetails/
reportdetailsauditdrilldown_component.xml
Scope
type dm_workflow
Elements
columns
hideEvents
See hideEvents, page 736.
reportdetailscontainerclassic (type dm_workflow)

(Webtop)
Purpose
Extends the WDK component reportdetailscontainerlist and contains report detail components
on a workflow.
Parameters
The parameters are inherited from reportdetailscontainerlist:webcomponent/config/library/workflow/
reportdetailscontainer/reportdetailscontainerlist_component.xml. See reportdetailscontainerlist (type
dm_workflow), page 1389.
reportdetailscontainerdrilldown (type dm_workflow)
Description
Since
5.x
Configuration File
webtop\config\reportdetailscontainerclassic_component.xml
Parent Definition
reportdetailscontainerlist:webcomponent/config/library/workflow/reportdetailscontainer/
reportdetailscontainerlist_component.xml
Scope
type dm_workflow
Elements
None.
reportdetailscontainerdrilldown (type dm_workflow)
Purpose
Extends propertysheetcontainer, page 830 and contains report detail components on a workflow.
Deprecated as of version 6.
Parameters
component (Optional) The contained component.

Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetailscontainer\reportdetailscontainerdrilldown_
component.xml
reportdetailscontainerlist (type dm_workflow)
Parent Definition
Scope
type dm_workflow
Elements
failoverenabled
reportdetailscontainerlist (type dm_workflow)
Purpose
Extends propertysheetcontainer, page 830 and contains report detail components on a workflow.
Parameters
component (Optional) The contained component.

Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetailscontainer\reportdetailscontainerlist_
component.xml
Parent Definition
Scope
type dm_workflow
reportdetailscontainerstreamline (type dm_workflow) (Webtop)
Elements
failoverenabled
reportdetailscontainerstreamline (type
dm_workflow) (Webtop)
Purpose
Extends the WDK reportdetailscontainerdrilldown component and contains report detail components
on a workflow.
Parameters
The parameters are inherited from reportdetailscontainerdrilldown:webcomponent/config/
library/workflow/reportdetailscontainer/reportdetailscontainerdrilldown_component.xml. See
reportdetailscontainerdrilldown (type dm_workflow), page 1388.
Description
Since
5.x
Configuration File
webtop\config\reportdetailscontainerstreamline_component.xml
Parent Definition
reportdetailscontainerdrilldown:webcomponent/config/library/workflow/reportdetailscontainer/
reportdetailscontainerdrilldown_component.xml
Scope
type dm_workflow
Elements
None.
reportdetailsheader
reportdetailsheader
Purpose
This component is included in the UI of reportdetailscontainerlist (type dm_workflow), page 1389
and reportdetailscontainerdrilldown (type dm_workflow), page 1388. The header component
displays a different page depending on the active component in the container.
Parameters
component (Optional) Specifies the component for which

to display the header.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetails\reportdetailsheader_component.xml
Scope
All.
Elements
None.
reportdetailsmap
Purpose
This component displays the map view of the workflow instance in the Web Workflow Manager.
Parameters
The parameters are inherited from webwfm:webcomponent/config/library/workflow/webwfm/
webwfm_component.xml. See webwfm, page 1457.
reportdetailssummaryclassic (type dm_workflow) (Webtop)
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetails\reportdetailsmap_component.xml
Parent Definition
webwfm_checkjvm:webcomponent/config/library/workflow/webwfm/webwfm_component.xml
Scope
All.
Elements
None.
reportdetailssummaryclassic (type dm_workflow)

(Webtop)
Purpose
Extends the WDK component reportdetailssummarylist and displays the summary of a selected
workflow’s task and task attributes.
Parameters
The parameters are inherited from reportdetailssummarylist:webcomponent/config/library/
workflow/reportdetails/reportdetailssummarylist_component.xml. See reportdetailssummarylist,
page 1394.
Description
Since
5.x
Configuration File
webtop\config\reportdetailssummaryclassic_component.xml
reportdetailssummarydrilldown
Parent Definition
reportdetailssummarylist:webcomponent/config/library/workflow/reportdetails/
reportdetailssummarylist_component.xml
Scope
type dm_workflow
Elements
columns
taskmgractionname
See taskmgractionname, page 750.
reportdetailssummarydrilldown
Purpose
Displays the summary of a selected workflow’s tasks and their attributes, such as task name, runtime
status, action, performer, comments, and receive/complete/overdue days. Deprecated as of version 6.
Parameters

showAttachment (Optional) Set to true to display attached
documents with tasks
taskFilter (Optional) Sets the selected filter. Valid values: 0
= all | 1 = current | 2 = overdue
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetails\reportdetailssummarydrilldown_
component.xml
Scope
All.
reportdetailssummarylist
Elements
columns
taskmgractionname
reportdetailssummarylist
Purpose
Displays the summary of a selected workflow’s tasks and their attributes, such as task name, runtime
status, action, performer, comments, and receive/complete/overdue days.
Parameters

showAttachment (Optional) Set to true to display attached
documents with tasks
taskFilter (Optional) Sets the selected filter. Valid values: 0
= all | 1 = current | 2 = overdue
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportdetails\reportdetailssummarylist_component.xml
Scope
All.
Elements
columns
taskmgractionname
reportdetailssummarystreamline (type dm_workflow) (Webtop)
reportdetailssummarystreamline (type
dm_workflow) (Webtop)
Purpose
Extends the WDK component reportdetailssummarydrilldown and displays the summary of a
selected workflow’s task and its attributes, such as task name, runtime status, action, performer,
comments, and receive/complete/overdue days.
Parameters
The parameters are inherited from reportdetailssummarydrilldown:webcomponent/config/
library/workflow/reportdetails/reportdetailssummarydrilldown_component.xml. See
reportdetailssummarydrilldown, page 1393.
Description
Since
5.x
Configuration File
webtop\config\reportdetailssummarystreamline_component.xml
Parent Definition
reportdetailssummarydrilldown:webcomponent/config/library/workflow/reportdetails/
reportdetailssummarydrilldown_component.xml
Scope
type dm_workflow
Elements
columns
taskmgractionname
reportdql
reportdql
Purpose
This component displays a workflow report based on a DQL query.
Parameters
query (Optional) When the querytype is string, this

Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\historicalreport\reportdql_component.xml
Scope
All.
Elements
None.
Purpose
Extends the WDK component reportmainlist and displays a list of workflow instances and their
attributes. This component is called by the component class.
Parameters
The parameters are inherited from reportmainlist:webcomponent/config/library/workflow/
reportmain/reportmainlist_component.xml. See reportmainlist, page 1398.
reportmaindrilldown
Description
Since
5.x
Configuration File
webtop\config\reportmainclassic_component.xml
Parent Definition
reportmainlist:webcomponent/config/library/workflow/reportmain/reportmainlist_component.xml
Scope
All.
Elements
columns
savedetailsreport
See savedetailsreport, page 746.
reportmaindrilldown
Purpose
Displays a list of workflow instances and its attributes. Deprecated as of version 6.
Parameters
overdueDays (Optional) Sets minimum number of days

overdue (default = 0)
workflowFilter (Optional) Sets the selected filter. Valid values: 0
= all | 1 = completed | 2 = running
workflowType (Optional) Type of workflow query. Valid
values: 0 = general | 1 = supervisor | 2 = template
ID | 3 = workflow name | 4 = Document ID | 5 =
Workflow ID | 6 = all | 7 (default) = supervisor
and performer
workflowTypeParam (Optional) Second workflow type for query (see
workflowType for valid values)
reportmainlist
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportmain\reportmaindrilldown_component.xml
Scope
All.
Elements
columns
savedetailsreport
reportmainlist
Purpose
Displays a list of workflow instances and its attributes. This component is extended by the Webtop
reportmainclassic component.
Parameters
overdueDays (Optional) Sets minimum number of days

overdue (default = 0)
workflowFilter (Optional) Sets the selected filter. Valid values: 0
= all | 1 = completed | 2 = running
workflowType (Optional) Type of workflow query. Valid
values: 0 = general | 1 = supervisor | 2 = template
ID | 3 = workflow name | 4 = Document ID | 5 =
Workflow ID | 6 = all | 7 (default) = supervisor
and performer
workflowTypeParam (Optional) Second workflow type for query (see
workflowType for valid values)
reportmainsettings
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportmain\reportmainlist_component.xml
Scope
All.
Elements
columns
savedetailsreport
reportmainsettings
Purpose
This component allows the user to set criteria for the workflow instances to be displayed in the
reportmain component.
Parameters
documentId (Optional) Specifies a document for which

filter (Required) Sets the selected filter. Valid values:
0 = all | 1 = completed | 2 = running
overdueDays (Optional) Specifies the minimum number of
days overdue for which to display a report
overdueOnly (Required) True to filter for overdue task status.
templateId (Optional) Specifies a template for which
userName (Required) Name of the user for which to
display workflows.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportmain\reportmainsettings_component.xml
Scope
All.
Elements
None.
Purpose
Extends the WDK component reportmaindrilldown and displays a list of workflow instances and
their attributes. This component is called by the component class inboxstreamline (Webtop), page
1076 in the WDK nestedcomponent container.
Parameters
The parameters are inherited from reportmaindrilldown:webcomponent/config/library/workflow/
reportmain/reportmaindrilldown_component.xml. See reportmaindrilldown, page 1397.
Description
Since
5.x
Configuration File
webtop\config\reportmainstreamline_component.xml
Parent Definition
reportmaindrilldown:webcomponent/config/library/workflow/reportmain/reportmaindrilldown_
component.xml
Scope
All.
reportsysobjectlocator
Elements
columns
savedetailsreport
reportsysobjectlocator
Purpose
Extends sysobjectlocator, page 969 and locates reports. This locator is nested to from the component
class reportmainsettings, page 1399. The container extends locatorcontainer, page 960.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportsysobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
reportsysobjectlocatorcontainer
objecttype

views
reportsysobjectlocatorcontainer
Purpose
This component displays a simple list of sysobjects including the folder and the findtype.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\reportsysobjectlocatorcontainer_component.xml
Parent Definition
savereportlocator
Scope
All.
Elements
multidocbasesupport
savereportlocator
Purpose
Extends folderlocatorcontainer, page 955 and allows a user to locate a folder in which to save a report.
This locator is nested within the component class of several reporting components.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\savereport\savereportlocator_component.xml
Parent Definition
folderlocatorcontainer:webcomponent/config/library/locator/folderlocators_component.xml
Scope
All.
Elements
None.
savereportname
savereportname
Purpose
This component is included in the component savereportlocator, page 1403 and allows the user to
specify a report name for a saved report.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\savereport\savereportlocator_component.xml
Scope
All.
Elements
None.
Workflows
Purpose
Terminates Documentum workflows prematurely and then deletes them. This component is
generally used to abort obsolete workflows.
Parameters
objectId (Required) The ID of the workflow object to be

terminated.
addtaskattachmentlocatorcontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\abort\abortworkflow_component.xml
Scope
type dm_workflow
Elements
None.
addtaskattachmentlocatorcontainer
Purpose
Adds an attachment to a task. Contains attachmentlocator, page 1408.
Parameters
formTemplateId (Optional) ID of the form template, if the

attachment is a form instance
objectId (Required) ID of the attachment
objecttype (Required) Attachment object type
versionlabel (Optional) Version label for the attachment
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\addattachment\addtaskattachmentlocatorcontainer_
component.xml
alluserwftemplatelocator
Parent Definition
Scope
All.
Elements
multidocbasesupport
alluserwftemplatelocator
Purpose
Lists all repository workflow templates that are not system-generated.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\userwftemplatelocator_component.xml
Parent Definition
allwftemplatelocator:webcomponent/config/library/locator/wftemplatelocators_component.xml
Scope
All.
Elements
allversionsvisible
allwftemplatelocator
columns
flatlist
iconwell_icon
objecttype
<objecttype>dm_process</objecttype>

preset_item
views
allwftemplatelocator
Purpose
Locates dm_process objects (workflow templates) in a repository
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\locator\wftemplatelocators_component.xml
Parent Definition
attachmentlocator
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
objecttype

views
attachmentlocator
Purpose
Locates object attachments, based on their type and required version label or labels.
attachmentlocator
Parameters
formTemplateId (Optional) ID for the XForm template

objecttype (Optional) Type of object to be located
versionlabel (Optional) Version label on attachment, for
example, CURRENT
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\attachmentlocator_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
iconwell_icon
objecttype
attachmentlocatorcontainer

views
attachmentlocatorcontainer
Purpose
Locates object attachments, based on their type and required version label or labels.
Parameters

drop-down list.
formTemplateId (Optional) ID of the form template, if the
attachment is a form instance
selected
versionlabel (Optional) Version label on attachment; for
example, CURRENT
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\attachmentlocatorcontainer_component.xml
attachmentmyobjectlocator
Parent Definition
Scope
All.
Elements
multidocbasesupport
attachmentmyobjectlocator
Purpose
Selects attachment objects from the user’s objects.
Parameters

example, CURRENT
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\attachmentmyobjectlocator_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
attachmentsubscriptionlocator
columns
containerselectable
flatlist
iconwell_icon
modifiedwithindays
objecttype

views
Purpose
Selects attachment objects from the user’s subscriptions list.
Parameters

example, CURRENT
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\attachmentsubscriptionlocator_component.xml
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
iconwell_icon
objecttype

views
Purpose
Allows the user to change the performer of a future task in a workflow.
Parameters
objectName (Required) Activity name of the future task.

values: 0=dormant | 1=acquired | 2=finished |
workflowId (Required) ID of the workflow.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\performers\changeperformer_component.xml
Scope
type dm_task
Elements
None.
changeperformercontainer
Purpose
Allows the user to change the performer of a future task in a workflow.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\performers\changeperformercontainer_component.xml
Scope
All.
Elements
None.
Purpose
This component is a container that extends locatorcontainer, page 960. It allows the user to select a
new supervisor for a workflow. This container contains the component userorgrouplocator, page
1341.
Parameters
Description
Since
5.x
completefailedautoworkflowtask
Configuration File
webcomponent\config\library\workflow\changesupervisor\changesupervisor_component.xml
Parent Definition
Scope
type dm_workflow
Elements
multidocbasesupport
Purpose
The completefailedautoworkflowtask component forces completion of a failed automatic workflow
task. It is invoked from the task manager component.
Parameters
objectId (Required) ID of the workflow task
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\completeautotask_component.xml
Scope
All.
Elements
None.
delegateworkflowtask
delegateworkflowtask
Purpose
The delegateworkflowtask component delegates workflow tasks.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\delegateworkflowtask_component.xml
Scope
All.
Elements
None.
Purpose
component.
deleteworkflow (type dm_workflow)
Parameters

to all types.
objectName (Optional) Name of the object to be deleted.
Applies only to dm_notification and dm_queued
types.
Description
Since
5.x
Configuration File
webcomponent\config\library\delete\delete_notification_component.xml
Scope
Elements
None.
deleteworkflow (type dm_workflow)
Purpose
The deleteworkflow component deletes aborted workflow objects.
Parameters
objectId (Required) ID of the workflow to be deleted
Description
Since
5.x
deleteworkflowcalendar
Configuration File
webcomponent\config\library\workflow\delete\deleteworkflow_component.xml
Scope
type dm_workflow
Elements
None.
deleteworkflowcalendar
Purpose
Enables deleting a workflow business calendar.
Parameters
objectId (Required) Not used.

objectname (Optional) Object name of the workflow business
calendar.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\workflow\calendar\deleteworkflowcalendar_component.xml
Scope
All.
Usage
A workflow business calendar object can be deleted only if it is not associated with a workflow object.
Elements
None.
Purpose
Adds, edits, and removes attachment notes from dmi_package objects during the workflow
initialization process.
Parameters

processId (Required) ID of the workflow process
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\editnote\editstartwfnote_component.xml
Scope
type dmi_package
Elements
None.
edittasknote (type dmi_package)
Purpose
The edittasknote component adds, edits, and removes attachment notes. This component is defined
for dmi_package objects in edittasknote_component.xml.
finishworkflowtask
Parameters

queueItemId (Required) ID of the queue item with which the
note is associated.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\editnote\edittasknote_component.xml
Scope
type dmi_package
Elements
None.
finishworkflowtask
Purpose
The finishworkflowtask component completes non-manual workflow tasks (for which the user is
not expected to specify the next task).
Parameters

userCost (Optional) Currency cost, such as dollars, euros,
or other type of cost defined by customer. Value
is stored as a double.
userTime (Optional) Time in units defined by the
customer. Value is stored as an integer.
forwardroutertask
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\finishworkflowtask_component.xml
Scope
All.
Elements
None.
forwardroutertask
Purpose
Forwards router tasks. It is invoked from the taskmanager component.
Parameters
objectId (Required) ID of the router task
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\forwardroutertask_component.xml
Scope
All.
Elements
None.
forwardworkflowtask
forwardworkflowtask
Purpose
Forwards manual workflow tasks. It is invoked from the taskmanager component.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\forwardworkflowtask_component.xml
Scope
All.
Elements
None.
Purpose
Halts (pauses) a task in a workflow. This component is defined for dm_task objects.
Parameters
objectId (Required) ID of the work item.

Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\halt\halttask_component.xml
Scope
type dm_task
Elements
None.
Purpose
Halts (pauses) workflow objects. This component is defined for dm_workflow objects.
Parameters
objectId (Required) ID of the workflow
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\halt\haltworkflow_component.xml
Scope
type dm_workflow
Elements
None.
inboxlist
inboxlist
Purpose
Lists the user’s inbox tasks, using a classic-style layout.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\navigation\inbox\inboxlist_component.xml
Scope
All.
Elements
autogettaskdefault
columns
failoverenabled
preset_item
showattachmentinfo
showautogettask
showfilters
taskmanagerid
installedrecentwftemplatelocator
installedrecentwftemplatelocator
Purpose
Extends recentwftemplatelocator, page 1431 and allows the user to locate a recently used workflow
template that has been installed.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\startworkflow\startworkflowtemplatelocatorcontainer_
component.xml
Parent Definition
recentwftemplatelocator:webcomponent/config/library/locator/wftemplatelocators_component.xml
Scope
All.
Elements
columns
objecttype

views
installedwftemplatefolderlocator
Purpose
Extends unfilteredcontainersysobjectlocator, page 971 and allows the user to locate a template folder.
installedwftemplatesubscriptionlocator
Parameters
Description
Since
5.x
Configuration File
component.xml
Parent Definition
unfilteredcontainersysobjectlocator:webcomponent/config/library/locator/
unfilteredcontainersysobjectlocator_component.xml
Scope
All.
Elements
None.
installedwftemplatesubscriptionlocator
Purpose
Extends wftemplatesubscriptionlocator, page 1466 and locates and displays installed workflow
templates to which the user has subscribed.
Parameters
Description
Since
5.x
myuserwftemplatelocator
Configuration File
component.xml
Parent Definition
wftemplatesubscriptionlocator:webcomponent/config/library/locator/wftemplatelocators_
component.xml
Scope
All.
Elements
allversionsvisible
columns
flatlist
iconwell_icon
objecttype

views
Purpose
Extends allwftemplatelocator, page 1407 and lists all non-system workflow templates owned by
the current user.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\myuserwftemplatelocator_component.xml
Parent Definition
allwftemplatelocator:webcomponent/config/library/locator/wftemplatelocators_component.xml
Scope
All.
Elements
allversionsvisible
columns
flatlist
iconwell_icon
objecttype
1 <objecttype>dm_process</objecttype>
views
mywftemplatelocator
mywftemplatelocator
Purpose
Extends myobjectlocator, page 1107 and displays a flat list of workflow templates that have been
checked out or recently modified by the current user.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
modifiedwithindays
recentwftemplatelocator
objecttype

views
recentwftemplatelocator
Purpose
Extends recentsysobjectlocator, page 968 and locates workflow templates that were recently used by
the user. This component has no scope specified, but the <objecttype> element restricts the search to
objects of type dm_process (templates).
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
columns
rejectroutertask
containerselectable
iconwell_icon
objecttype

views
rejectroutertask
Purpose
Rejects router tasks.
Parameters
objectId (Required) ID of the router task
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\rejectroutertask_component.xml
Scope
All.
Elements
None.
rejectworkflowtask
rejectworkflowtask
Purpose
Displays a UI to allow the user to reject manual workflow tasks.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\rejectworkflowtask_component.xml
Scope
All.
Elements
None.
removeattachment
Purpose
Removes attached objects from a workflow. It is part of the task manager component group.
Parameters
attachmentName (Optional) Name of the workflow attachment

objectId (Required) ID of the attachment.
removestartwfattachment
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\removeattachment\removeattachment_component.xml
Scope
All.
Elements
None.
removestartwfattachment
Purpose
Removes attached objects. It is part of the startworkflow container component.
Parameters
attachmentName (Optional) Name of the workflow attachment

objectId (Required) ID of the attachment.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\removeattachment\removeattachment_component.xml
Scope
All.
Elements
None.
removestartwfwfattachment
removestartwfwfattachment
Purpose
This component is used with the startworkflow and taskmanager components. It is used to remove
an attachment from a workflow.
Parameters
attachmentName (Optional) Name of the attachment object being

docId (Required) ID of the attachment object being
objectId (Required) Process (template) ID
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\removeattachment\removewfattachment_component.
xml
Scope
All.
Elements
None.
removewfattachment
Purpose
This component is used to remove an attachment from a workflow.
reassignworkflowtask
Parameters

objectId (Required) Workflow task ID
packageName (Optional) ID of the package associated with the
workflow from which the attachment is being
removed
wf_attachment_id (Required) ID of the attachment being removed
from the workflow
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\removeattachment\removewfattachment_component.
xml
Scope
All.
Elements
None.
reassignworkflowtask
Purpose
Delegate task in a workflow’s ReportDetailsSummary page.
Since
6.5
repeatworkflowtask
repeatworkflowtask
Purpose
Completes workflow tasks and assign repeat performers for them. You can use it only for repeatable
tasks.
Parameters
objectId (Required) ID of the workflow task to be

repeated.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\repeatworkflowtask_component.xml
Scope
All.
Elements
None.
rerunfailedautoworkflowtask
Purpose
Retries failed automatic workflow tasks. You can use it only for failed automatic tasks. It is invoked
from the task manager.
Parameters
objectId (Required) ID of failed autoworkflow task.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\rerunautotask_component.xml
Scope
All.
Elements
None.
Purpose
Resumes a task in a workflow that was previously halted. This component is defined for dm_task
objects.
Parameters
objectId (Required) ID of the work item.

Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\resume\resumetask_component.xml
Scope
type dm_task
Elements
None.
Purpose
Resumes halted workflow objects.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\resume\resumeworkflow_component.xml
Scope
type dm_workflow
Elements
None.
startwfattachment
Purpose
Manages the attachment information during the workflow initialization process. It is part of the
startworkflow container component.
Parameters
attachmentIds (Optional) IDs of attachments to workflow

objectId (Required) ID of the workflow process
startwfcomments
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\attachment\startwfattachment_component.xml
Scope
All.
Elements
None.
startwfcomments
Purpose
Manages the process of adding notes to attachments during the workflow initialization process. It is
part of the startworkflow component group.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\comments\startwfcomments_component.xml
Scope
All.
Elements
See showheaderforsinglepackage, page 748.
startwfcontainer (type dm_process)
startwfcontainer (type dm_process)
Purpose
Extends propertysheetcontainer, page 830 and operates on dm_process (template) objects.
Parameters
attachmentIds (Optional) IDs of attachments to workflow

component (Optional) Start component
startworkflowId (Required) ID of the workflow
type (Required) Object type of the attachment, passed
to the contained components
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\startwfcontainer\startwfcontainer_component.xml
Parent Definition
Scope
type dm_process
Elements
asynchronous
failoverenabled
startwfperformers
startwfperformers
Purpose
Manages the process of performer assignment. It is part of the startworkflow component group.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\performers\startwfperformers_component.xml
Scope
All.
Elements
None.
startwfxformcontainer (type dm_process)
Purpose
Container for the startwfperformers, page 1442 and the startwfcomments, page 1440 components.
Parameters
The parameters are inherited from startwfcontainer:webcomponent/config/library/workflow/
startwfcontainer/startwfcontainer_component.xml. See startwfcontainer (type dm_process), page
1441.
startworkflow
Description
Since
6.0
Configuration File
webcomponent\config\library\workflow\startworkflowxformcontainer\startworkflowxformcontainer_
component.xml
Parent Definition
startwfcontainer:webcomponent/config/library/workflow/startwfcontainer/startwfcontainer_
component.xml
Scope
type dm_process
Elements
asynchronous
formsavefolderpath
startworkflow
Purpose
Displays the info for a workflow. The component has a classic-style layout. It is part of the group of
task manager components.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\startworkflow\startworkflow_component.xml
startworkflowdrilldown
Scope
All.
Elements
defaultformacl
You must specify a default ACL.
Since 6.0 SP1.
formsavefolderpath
startworkflowdrilldown
Purpose
Extends startworkflow, page 1443 and displays the Info tab on a workflow. The component has a
streamline-style layout. It is part of the group of task manager components. Deprecated as of version 6.
Parameters
The parameters are inherited from startworkflow:/webcomponent/config/library/workflow/
startworkflow/startworkflow_component.xml. See startworkflow, page 1443.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\startworkflow\startworkflowdrilldown_component.xml
Parent Definition
startworkflow:/webcomponent/config/library/workflow/startworkflow/startworkflow_component.
xml
Scope
All.
Elements
formsavefolderpath
startworkflowtemplatelocatorcontainer
startworkflowtemplatelocatorcontainer
Purpose
Extends wftemplatelocatorcontainer, page 1466 and launches the workflow operation after the user
selects the workflow template. The contained components locate various kinds of workflows and
templates.
Parameters
componentArgs (Optional) Supplied by the LaunchComponent

class.) List of arguments and values to pass to
each contained component.
objectId (Optional) Attachment ID
startworkflowId (Required) ID of the workflow
Description
Since
5.x
Configuration File
component.xml
Parent Definition
wftemplatelocatorcontainer:webcomponent/config/library/locator/wftemplatelocators_component.
xml
Scope
All.
Elements
None.
startworkflowxforms
Purpose
Starts a workflow using the xforms component.
taskattachment
Parameters
activityId (Optional) Object ID of the initial activity.

deleteOnCancel (Optional) Whether to delete the workflow
instance when the workflow instance is
cancelled (true) or not (false).
isactivityformtemplate (Optional) Whether the initial activity is a form
template (true) or not (false).
isNew (Optional) Whether the workflow is new (true)
or existing (false).
objectId (Required) Object ID of the workflow instance.
templateId (Optional) Object ID of the workflow template.
Description
Since
6.0
Configuration File
webcomponent\config\library\workflow\startworkflow\startworkflowxforms_component.xml
Parent Definition
Scope
All.
Elements
None.
taskattachment
Purpose
Manages the attachments to tasks in the inbox.
Parameters
taskcomments
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\attachment\taskattachment_component.xml
Scope
All.
Elements
None.
taskcomments
Purpose
Adds notes to inbox tasks. It is part of the task manager component.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\comments\taskcomments_component.xml
Scope
All.
Elements
See showheaderforsinglepackage, page 748.
taskcomponentcontainer
taskcomponentcontainer
Purpose
Extends the component wizardcontainer, page 1062 and displays task components for workflows.
Parameters
component (Required) Start component.

objectId (Required) ID of the workflow process.
type (Required) Task type. Valid values:
dm_notification | dm_queued | dm_task. The
type is passed by the taskmanagercontainer
component to the contained components.
userCost (Optional) Currency cost, such as dollars, euros,
or other type of cost defined by customer. Value
is stored as a double.
userTime (Optional) Time in units defined by the
customer. Value is stored as an integer.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\taskcomponentcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
This element structure is inherited from wizardcontainer:wdk/config/wizardcontainer_component.
xml. See wizardcontainer, page 1062.
taskheader
taskheader
Purpose
Displays header information for tasks. It is part of the task manager and start workflow component
groups.
Parameters

taskName (Optional) Name of the task
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskheader\taskheader_component.xml
Scope
All.
Elements
None.
taskhistory
Purpose
Displays runtime or audit history of a workflow that generated a specific task. It is part of the task
manager component group.
Parameters
taskinfo
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskhistory\taskhistory_component.xml
Scope
All.
Elements
events
1 <events>
2<visibility name="dm_abortworkflow">true</visibility>
...
</events>
1 Contains <visibility> elements which correspond to individual audit events.

2 Corresponds to an event. Set to true to display the specified event. Set the name attribute to
correspond to an audit type such as dm_signoff.
historytype
<historytype>runtime</historytype>
Specifies audit or runtime. Valid values: audit | auditorruntime (shows audit if available) | runtime
(default = runtime)
taskinfo
Purpose
Displays next and previous task information for specific tasks. It is part of the task manager.
Parameters
Description
Since
5.x
taskmanager
Configuration File
webcomponent\config\library\workflow\taskinfo\taskinfo_component.xml
Scope
All.
Elements
showtaskinfo
1 <showtaskinfo>
2<next>true</next>
3<previous>false</previous>
</showtaskinfo>
1 Whether to display or hide information about the previous and next tasks. Contains <next> and
<previous> elements.
2 True to display information about the next task.
3 True to display information about the previous task.
taskmanager
Purpose
Displays the info tab in the taskmanager component group. It is the main component in the group of
task manager components, which are contained in the taskmanagercontainer component.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\taskmanager_component.xml
Scope
All.
taskmanagercontainer (type dm_notification)
Elements
defaultformacl
You must specify a default ACL.
Since 6.0 SP1
failoverenabled
formsavefolderpath
showusertimeandcost
taskmanagercontainer (type dm_notification)
Purpose
Extends propertysheetcontainer, page 830. This component is defined for following scopes:
dm_notification, dm_queued, dm_router_task, and dm_task. The definitions for dm_notification,
dm_queued, and dm_router_task do not contain components.
Parameters
component (Optional) Specifies the ID of the component to

initialize
taskmanagerId (Required) ID of the taskmanager object
type (Required) Not used (any value can be inserted)
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmgrcontainer\taskmanagercontainer_component.
xml
Parent Definition
taskmanagercontainer (type dm_router_task)
Scope
Elements
failoverenabled
taskmanagercontainer (type dm_router_task)
Purpose
Parameters

initialize
type (Required) Not Used (any value can be inserted)
Description
Since
5.x
Configuration File
xml
Parent Definition
Scope
type dm_router_task
taskmanagercontainer (type dm_task)
Elements
failoverenabled
taskmanagercontainer (type dm_task)
Purpose
Parameters

initialize
type (Required) Not used (any value can be inserted)
Description
Since
5.x
Configuration File
xml
Parent Definition
Scope
type dm_task
taskmgrabortworkflow (type dm_task)
Elements
failoverenabled
taskmgrabortworkflow (type dm_task)
Purpose
Extends the abortworkflow component and aborts workflows that generated failed automatic
workflow tasks. It is invoked from the taskmanager component.
Parameters
The parameters are inherited from abortworkflow:webcomponent/config/library/workflow/abort/
abortworkflow_component.xml. See abortworkflow (type dm_workflow), page 1404.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskmanager\taskmgrabortworkflow_component.xml
Parent Definition
abortworkflow:webcomponent/config/library/workflow/abort/abortworkflow_component.xml
Scope
type dm_task
Elements
None.
taskprocessvariables
taskprocessvariables
Purpose
Displays a workflow’s process variables (defined in Business Process Manager) for which a user can
specify values.
Parameters
Description
Since
6.0
Configuration File
webcomponent\config\library\workflow\taskprocessvariables\taskprocessvariables_component.
xml
Scope
All.
Elements
None.
taskprogress
Purpose
Contains taskhistory and taskinfo components. It is part of the task manager component group.
Parameters
webwfm
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\taskprogress\taskprogress_component.xml
Scope
All.
Elements
None.
webwfm
Purpose
Launches the Web workflow manager applet. This component is launched by the following actions:
new, view, editfile, and delete on a single object of type dm_process (template) objects, and the view
action on a single dm_workflow (template) object. The container extends combocontainer, page 1046.
Parameters
objectId (Required) ID of a process, a workflow, or a

folder or cabinet in which to create the workflow.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\webwfm\webwfm_component.xml
Scope
All.
webwfm_checkjvm
Usage
The Web workflow manager applet requires the Sun virtual machine in the client browser. The user is
prompted to install the required VM when the workflow manager is called.
The Web workflow manager is called for a single object. If a workflow or template is edited, it must
be checked in through the Web workflow manager UI. Checkin for workflows and templates is
disabled in the Webtop UI.
Elements
helppath
See helppath, page 736.
map
See map, page 738.
maxidletime
See maxidletime, page 739.
webwfm_checkjvm
Purpose
This component is a container for the web workflow manager component that also checks the Java
Virtual Machine to ensure that it is compatible.
Parameters
The parameters are inherited from webwfm:webcomponent/config/library/workflow/webwfm/
webwfm_component.xml. See webwfm, page 1457.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\webwfm\webwfm_component.xml
Parent Definition
webwfm:webcomponent/config/library/workflow/webwfm/webwfm_component.xml
Scope
All.
webwfmcontainer
Elements
helppath
See helppath, page 736.
map
See map, page 738.
maxidletime
See maxidletime, page 739.
webwfmcontainer
Purpose
Container component for the Workflow Manager.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\webwfm\webwfmcontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
webwfmeditcontainer
webwfmeditcontainer
Purpose
This component calls the component webwfm, page 1457 to launch the Web workflow manager
applet in editing mode. This container extends combocontainer, page 1046.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\webwfm\webwfmeditcontainer_component.xml
Parent Definition
webwfmcontainer:webcomponent/config/library/workflow/webwfm/webwfmcontainer_component.
xml
Scope
All.
Elements
None.
wfgrouponlylocator
Purpose
Extends userorgrouplocator, page 1341 and selects groups in workflow operations. The container
component extends locatorcontainer, page 960.
Parameters
wfgrouponlylocator
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfgrouponlylocator_component.xml
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
iconwell_icon
objecttype

preset_item
privategroupvisible
views
wfgrouponlylocatorcontainer
wfgrouponlylocatorcontainer
Purpose
This component is the container for the component wfgrouponlylocator, page 1460, which is used to
select groups in workflow operations.
Parameters

drop-down list.
multiple selection.
repository (Optional) ID of the repository in which to
search
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfgrouponlylocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
wfrecentuseronlylocator
wfrecentuseronlylocator
Purpose
This component is used to search for users who were recently selected or changed. It is used in
conjunction with workflow operations.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfuseronlylocatorcontainer_component.xml
Parent Definition
recentuseronlylocator:webcomponent/config/library/locator/useronlylocator_component.xml
Scope
All.
Elements
objecttype

useronly
wfsysobjectlocatorcontainer
Purpose
Contains sysobjectlocator, page 969 and recentsysobjectlocator, page 968.
wftemplatefolderlocator
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfsysobjectlocatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
Purpose
Locates folders containing dm_process objects (workflow templates) in a repository.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
<filenamefiltervisible>true</filenamefiltervisible>
flatlist
objecttype

views
wftemplatelocatorcontainer
wftemplatelocatorcontainer
Purpose
Contains workflow template locators: allwftemplatelocator, page 1407, wftemplatesubscriptionlocator,
page 1466, mywftemplatelocator, page 1430, wftemplatefolderlocator, page 1464, and
recentwftemplatelocator, page 1431.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
wftemplatesubscriptionlocator
Purpose
Locates and displays workflow templates to which the user has subscribed.
Parameters
wftemplatesubscriptionlocator
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
allversionsvisible
columns
containerselectable
flatlist
iconwell_icon
objecttype

views
wfuseronlylocator
wfuseronlylocator
Purpose
Contains workflow user locators useronlylocator, page 1339 and recentuseronlylocator, page 1325.
Parameters
Description
Since
5.x
Configuration File
Parent Definition
useronlylocator:webcomponent/config/library/locator/useronlylocator_component.xml
Scope
All.
Elements
columns
containerselectable
objecttype

privategroupvisible
wfuseronlylocatorcontainer
wfuseronlylocatorcontainer
Purpose
This component allows the selection of users for workflow operations. It displays the component
wfuseronlylocator, page 1468.
Parameters

in a flat list.
objecttype (Optional) ID of the selected object
search
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
multidocbasesupport
wfuserorgroupfromgrouplocator
wfuserorgroupfromgrouplocator
Purpose
Locates users who are members of a specific group. It is used in workflow operations.
Parameters
groupName (Optional) Name of group from which to locate

users and groups
multiselect (Optional) Set to true to support multiple
selection.
objecttype (Optional) Type of object to locate
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfuserorgroupfromgrouplocator_component.xml
Parent Definition
Scope
All.
Elements
columns
containerselectable
failoverenabled
flatlist
wfuserorgroupfromgrouplocatorcontainer
iconwell_icon
objecttype

preset_item
privategroupvisible
views
wfuserorgroupfromgrouplocatorcontainer
Purpose
Contains the userorgrouplocator component used in the sendtodistributionlist component.
Parameters
arrangeselect (Optional) True to allow selection of workflow

performers in a sequential order.
groupName (Optional) Name of the group of which the listed
users/groups are to be members
repository (Optional) Repository in which to search
delimited list of object IDs of the selected
recipients (users and groups).Since 6.0.
Description
Since
5.x
wfuserorgrouplocator
Configuration File
webcomponent\config\library\workflow\wfuserorgroupfromgrouplocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
wfuserorgrouplocator
Purpose
This component is used to locate active users or groups in a repository. The component allows a user
navigate from usergroups to find a user or group.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfuserorgrouplocatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
columns
wfuserorgrouplocatorcontainer
containerselectable
failoverenabled
flatlist
iconwell_icon
includeunlisted
objecttype

preset_item
privategroupvisible
views
wfuserorgrouplocatorcontainer
Purpose
Container for simple user-or-group locator used in sendtodistributionlist.
Parameters

of users in a sequential order.
flatlist (Optional) Boolean: Set to true to list objects in a
flat list.

objecttype (Optional) The type of the selected object
search
selectedobjectids (Optional) IDs of objects that are selected when
the component is displayed
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\wfuserorgrouplocatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
Purpose
Launched by the action workflowavailability, page 675 in dialogcontainer, page 1048, this component
sets the user’s availability to receive workflows.
Parameters
None.
workflowcalendar
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\availability\workflowavailability_component.xml
Scope
All.
Elements
None.
workflowcalendar
Purpose
Represents a workflow business calendar.
Parameters
objectId (Required) Object ID of the workflow business

calendar.
calendar.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\workflow\calendar\workflowcalendar_component.xml
Scope
All.
Elements
None.
workflowcalendarcontainer
workflowcalendarcontainer
Purpose
Displays the properties of a workflow business calendar.
Parameters

calendar.
calendar.
component (Optional) Not used.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\workflow\calendar\workflowcalendardetails_component.xml
Parent Definition
Scope
All.
Elements
None.
workflowcalendardetails
Purpose
Displays detailed information about a workflow business calendar.
workflowcalendareditcontainer
Parameters
objectId (Optional) Object ID of the workflow calendar.
Description
Since
6.0 SP1
Configuration File
Scope
All.
Elements
None.
workflowcalendareditcontainer
Purpose
Displays and enables editing the properties of a workflow business calendar.
Parameters

calendar.
calendar.
component (Optional) Supplied by the LaunchComponent
workflowcalendarevent
Description
Since
6.0 SP1
Configuration File
Parent Definition
workflowcalendarcontainer:webcomponent/config/library/workflow/calendar/
workflowcalendarcontainer_component.xml
Scope
All.
Elements
None.
workflowcalendarevent
Purpose
Enables editing an existing or creating a new workflow business calendar event.
Parameters

calendar event.
calendar event.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\workflow\calendar\workflowcalendarevent_component.xml
workflowcalendarlist
Scope
All.
Elements
None.
workflowcalendarlist
Purpose
Displays a list of all workflow business calendars.
Parameters
None.
Description
Since
6.0 SP1
Configuration File
webcomponent\config\library\workflow\calendar\workflowcalendarlist_component.xml
Scope
All.
Elements
columns
Purpose
Extends the WDK workflowstatuslist component and lists workflow objects and their statuses, using
a list layout. Reads in the user display preferences.
Parameters
The parameters are inherited from workflowstatuslist:webcomponent/config/library/workflow/
status/workflowstatuslist_component.xml. See workflowstatuslist, page 1481.
Description
Since
5.x
Configuration File
webtop\config\workflowstatusclassic_component.xml
Parent Definition
workflowstatuslist:webcomponent/config/library/workflow/status/workflowstatuslist_component.
xml
Scope
All.
Elements
None.
Purpose
Lists workflow objects and their statuses, using a streamline layout. Deprecated as of version 6.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\status\workflowstatusdrilldown_component.xml
workflowstatuslist
Scope
All.
Elements
None.
workflowstatuslist
Purpose
Lists workflow objects and their statuses, using a list layout.
Parameters
mode (Optional) Specifies the workflows to be

displayed. Valid values: all (shows all
workflows) | supervisor (shows workflows
supervised by the current user) | creator (shows
workflows created by the current user) |
supervisorcreator (shows workflows supervised
or created by the current user)
Description
Since
5.x
Configuration File
webcomponent\config\library\workflow\status\workflowstatuslist_component.xml
Scope
All.
Elements
None.
Purpose
Extends the WDK workflowstatusdrilldown component and lists workflow objects and their statuses,
using a streamline layout.
Parameters
None.
Description
Since
5.x
Configuration File
webtop\config\workflowstatusstreamline_component.xml
Parent Definition
workflowstatusdrilldown:webcomponent/config/library/workflow/status/workflowstatusdrilldown_
component.xml
Scope
All.
Elements
None.
workflowxforms
Purpose
Workflow that uses the xforms component.
Parameters
advanceprocessorqueuelist
Description
Since
6.0
Configuration File
webcomponent\config\library\workflow\workflowxforms\workflowxforms_component.xml
Parent Definition
Scope
All.
Elements
None.
Work queue management
advanceprocessorqueuelist
Purpose
List the work queues for an advanced queue processor.
Parameters

nodeIds (Optional) IDs of the nodes.
object_name (Optional) Name of the dm_user object with role
set to advance_queue_processor.
objectId (Optional) ID of the dm_user object with role set
to advance_queue_processor.
allworkqueuecategorylocator
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\advanceprocessorqueuelist_component.xml
Scope
All.
Elements
wqlist
<wqlist>true</wqlist>
Whether to display (true) or hide (false) the work queue list.

columns
nodes
Purpose
Lists all defined work queue categories.
Parameters
arrangeselect (Optional) Not used.

multiple selection.
selected
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueuecategorylocators_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
objecttype
<objecttype>dmc_workqueue_category</objecttype>

containerselectable
allversionsvisible
views
columns
assignqueuedtask
assignqueuedtask
Purpose
Assigns a task from a work queue to a processor.
Parameters
objectId (Required) ID of the task to assign

performer (Required) ID of the user to whom the task will
be assigned
queueName (Required) Name of the work queue
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\assignqueuedtask_component.xml
Scope
All.
Elements
None.
assignqueuedtaskcontainer
assignqueuedtaskcontainer
Purpose
Container object for assigning tasks from a work queue to a processor. Contains the component
assignqueuedtask, page 1486.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\assignqueuedtaskcontainer_component.xml
Parent Definition
multiargdialogcontainer:webcomponent/config/library/multiargdialogcontainer/
multiargdialogcontainer_component.xml
Scope
All.
Elements
None.
Purpose
component.
Parameters

to all types.
objectName (Optional) Name of the object to be deleted.
Applies only to dm_notification and dm_queued
types.
Description
Since
5.x
Configuration File
webcomponent\config\library\delete\delete_queued_component.xml
Scope
type dm_queued
Elements
None.
Purpose
Deletes a work queue category. A work queue category can be deleted only if it does not contain
any work queues or other categories.
Parameters
The parameters are inherited from delete:webcomponent/config/library/queuemanagement/delete/
deleteworkqueueobject_component.xml. See delete, page 992.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\delete\deleteworkqueuecategory_component.
xml
Parent Definition
delete:webcomponent/config/library/queuemanagement/delete/deleteworkqueueobject_component.
xml
Scope
Elements
None.
Purpose
Deletes a work queue document profile. A work queue document profile can be deleted only if
no work items reference it.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\delete\deleteworkqueuedocprofile_component.
xml
Parent Definition
xml
Scope
Elements
None.
Purpose
Deletes a work queue policy. A work queue policy can be deleted only if the work queue policy is not
referenced by any work item, work queue, or work queue document profile.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\delete\deleteworkqueuepolicy_component.xml
Parent Definition
xml
Scope
Elements
None.
Purpose
Deletes a work queue. A work queue can be deleted only if it contains no work items.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\delete\deleteworkqueue_component.xml
Parent Definition
xml
Scope
type dmc_workqueue
Elements
None.
Purpose
Deletes dmc_wq_skill_info objects.
docprofileadd
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\delete\deletewqskillinfo_component.xml
Parent Definition
xml
Scope
Elements
None.
docprofileadd
Purpose
Adds a work queue document profile.
Parameters
objectId (Optional) Not used.
Description
Since
5.x
docprofileattributes
Configuration File
webcomponent\config\library\queuemanagement\docprofileadd_component.xml
Scope
All.
Elements
None.
docprofileattributes
Purpose
Edits the attributes of a work queue document profile.
Parameters
objectId (Required) ID of the document profile object for

which you want to set attributes.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\docprofileattributes_component.xml
Scope
All.
Elements
None.
docprofilelist
docprofilelist
Purpose
Displays a list of the available queue management document profiles.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\docprofilelist_component.xml
Scope
All.
Elements
showbreadcrumb
editprocessorauthentication
Purpose
Displays a page in the Properties component for a work queue processor, enabling the user to set the
processor’s skill level and available document profiles. The component does not save the work queue
processor profile, but passes any changes back to the calling component.
Parameters
docprofile_enable (Optional) Boolean: set to true to enable the user

to change the work queue document profile
assigned to the processor. Default is false.
docprofile_name (Optional) Name of the work queue document
profile.
managequeueinbox
skill (Optional) Skill level of the user for this work

queue. Valid values are the skill level strings
from the data dictionary.
username (Required) User name of the work queue
processor.
wq_name (Required) Name of the work queue.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\editprocessorauthentication_component.xml
Scope
All.
Elements
None.
managequeueinbox
Purpose
Lists all uncompleted tasks in a work queue, both assigned and unassigned.
Parameters

Description
Since
5.x
movetoqueue
Configuration File
webcomponent\config\library\queuemanagement\managequeueinbox_component.xml
Scope
All.
Elements
showbreadcrumb
showfilters
failoverenabled
useroptions
See useroptions, page 751.
columns
movetoqueue
Purpose
Moves a task from one work queue to another.
Parameters
The parameters are inherited from assignqueuedtask:webcomponent/config/library/
queuemanagement/assignqueuedtask_component.xml. See assignqueuedtask, page 1486.
Description
Since
6.0
Configuration File
webcomponent\config\library\queuemanagement\movetoqueue_component.xml
Parent Definition
assignqueuedtask:webcomponent/config/library/queuemanagement/assignqueuedtask_component.
xml
movetoqueuecontainer
Scope
All.
Elements
None.
movetoqueuecontainer
Purpose
Moves one or more selected queued tasks to another work queue.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\actions\movetoqueuecontainer_component.xml
Parent Definition
Scope
All.
Elements
None.
policyattributes
policyattributes
Purpose
Sets the attributes for a work queue policy.
Parameters
objectId (Required) ID of the work queue policy object

whose attributes to set.
selectPolicy (Optional) Boolean: Whether all policy attributes
are read-only, so users can select an existing
policy only (True) or all fields are editable, so
users can create a new policy (False). Default
is false.Since 6.0.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\policyattributes_component.xml
Scope
All.
Elements
objecttype
<objecttype>dmc_workqueue_policy</objecttype>
Specifies the object type of the objects to modify.
policylist
Purpose
Displays a list of the available work queue policies.
processorattributes
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\policylist_component.xml
Scope
All.
Elements
columns
showbreadcrumb
processorattributes
Purpose
Sets the queue-related attributes for a work queue processor.
Parameters
objectId (Required) ID of the user acting as a work queue

processor.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorattributes_component.xml
processorauthenticationlocatorcontainer
Scope
All.
Elements
None.
processorauthenticationlocatorcontainer
Purpose
Container component for specifying the work queue document profile, skill level, and work queues
for a newly defined work queue processor.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorauthenticationlocator_component.xml
Parent Definition
workqueuelocatorcontainer:webcomponent/config/library/queuemanagement/workqueuelocator_
component.xml
Scope
All.
Elements
None.
processorauthenticationselect
processorauthenticationselect
Purpose
Sets the skill level and document profile settings as part of adding a new work queue processor. The
component saves the work queue processor profile.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorauthenticationlocator_component.xml
Scope
All.
Elements
None.
processorinfo
Purpose
Displays processor information.
Parameters
objectId (Required) ID of the work queue processor.

objectname (Required) Name of the work queue processor.
processormember
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorinfo_component.xml
Scope
All.
Elements
None.
processormember
Purpose
Displays the members of a work queue.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processormember_component.xml
Scope
All.
Elements
None.
processorprofilecontainer
processorprofilecontainer
Purpose
Container for the processor profile properties.
Parameters

component to contain.(Required) Supplied by
the LaunchComponent action execution class.)
The name of the component to contain.
objectId (Required) ID of the user object for the work
queue processor.(Required) ID of the user object
for the work queue processor.
objectname (Required) Name of the user object for the work
queue processor.(Required) Name of the user
object for the work queue processor.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorprofilecontainer_component.xml
Parent Definition
queuemgmtpropertycontainer:webcomponent/config/library/queuemanagement/
queuemgmtpropertycontainer_component.xml
Scope
All.
Elements
None.
processorprofilelist
processorprofilelist
Purpose
Searches for a work queue processor profile or pages through a list of all the work queue processor
profiles in the repository.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\processorprofilelist_component.xml
Parent Definition
userlist:webcomponent/config/admin/user/userlist_component.xml
Scope
All.
Elements
showbreadcrumb
processorproperties
Purpose
Sets the properties for a work queue processor.
processorqueueinbox
Parameters
component (Required) ID of the component to display

objectId (Required) ID of the user object for the work
queue processor.
objectname (Required) Name of the user
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorproperties_component.xml
Parent Definition
component.xml
Scope
All.
Elements
objecttype
processorqueueinbox
Purpose
Work queue inbox for a work queue processor.
processorskill
Parameters

queuename (Required) Name of the work queue to display.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorqueueinbox_component.xml
Scope
All.
Elements
failoverenabled
useroptions
See useroptions, page 751.
showfilters
columns
processorskill
Purpose
Enables creating and updating a processor’s skills.
Parameters
objectId (Optional) ID of a dmc_wq_user_skill object.

objectname (Required) Name of a dmc_wq_user_skill object.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorskill_component.xml
Scope
All.
Elements
None.
Purpose
Enables modification of a work queue processor’s skill attributes.
Parameters
skill_info_id (Optional) skill_info_id attribute of the

dmc_wq_user_skill object.
skill_values (Optional) Values of the dmc_wq_user_skill
object.
user_name (Required) Name of the user object for the
processor.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\processorskillattributes_component.xml
Scope
All.
Elements
None.
Purpose
Provides a queue manager with a list of the tasks awaiting a work queue processor.
Parameters

objectname (Required) ID of the user object for the work
queue processor.
Description
Since
5.x
Configuration File
webcomponent\config\actions\processorworkloadinbox_component.xml
Scope
All.
Elements
showfilters
showattachmentinfo
columns
pullqueuedtask
pullqueuedtask
Purpose
Enables users, who are in the advanced_queue_processor role, to assign unassigned tasks from
work queues to themselves.
Parameters
objectId (Required) ID of the dm_task object to pull.

queueName (Required) Name of the dmc_workqueue to
from which to assign the dm_task object.
Description
Since
6.0
Configuration File
webcomponent\config\library\queuemanagement\pullqueuedtask_component.xml
Scope
All.
Elements
openTaskManager
<openTaskManager>true</openTaskManager>
Whether to enable (true) or disable (false) opening the task manager from within this component.
pullqueuedtaskcontainer
Purpose
Container for the pullqueuedtask, page 1509 component.
qualifiedqueueprocessorslocator
Parameters

Description
Since
6.0
Configuration File
webcomponent\config\library\queuemanagement\pullqueuedtaskcontainer_component.xml
Parent Definition
Scope
All.
Elements
None.
qualifiedqueueprocessorslocator
Purpose
Displays a selection list of users who are qualified to process tasks from a specific work queue.
qualifiedqueueprocessorslocatorcontainer
Parameters
groupName (Required) Name of the dm_group object

representing the work queue.
multiselect (Optional) Boolean: Set to true to enable users to
select multiple processors.
objecttype (Optional) Object type of the users to display in
the selection list; default is dm_user.
Description
Since
5.x
Configuration File
webcomponent\config\actions\qualifiedqueueprocessorslocator_component.xml
Parent Definition
wfuserorgroupfromgrouplocator:webcomponent/config/library/workflow/
wfuserorgroupfromgrouplocator_component.xml
Scope
All.
Elements
columns
qualifiedqueueprocessorslocatorcontainer
Purpose
Container component for selecting qualified queue processors. Contains the component
qualifiedqueueprocessorslocator, page 1510.
Parameters

groupName (Required) Name of the group to which users
must belong to process tasks in the queue.
queueattributes
multiselect (Optional) Boolean: Set to true to enable users to

select multiple processors.
objecttype (Optional) Object type of the users to display in
the selection list.
Description
Since
5.x
Configuration File
webcomponent\config\actions\qualifiedqueueprocessorslocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
queueattributes
Purpose
Sets the attributes for a work queue.
Parameters

objectname (Optional) Name of the work queue object.
queueinfo
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queueattributes_component.xml
Scope
All.
Elements
None.
queueinfo
Purpose
Enables creating and updating work queues.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queueinfo_component.xml
Scope
All.
queuelist
Elements
None.
queuelist
Purpose
Displays a navigable list of the work queues and work queue categories.
Parameters
category_path (Optional) Not used.

objectId (Optional) ID of the work queue category to
display as the initial starting point for the list.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\queuelist_component.xml
Scope
All.
Elements
columns
showbreadcrumb
queuelist (Webtop)
queuelist (Webtop)
Purpose
Displays a navigable list of the work queues and work queue categories.
Parameters

nodeIds (Optional) IDs of queue management nodes in
the browsertree.
Description
Since
6.0
Configuration File
webtop\config\queuelistclassic_component.xml
Parent Definition
queuelist:webcomponent/config/library/queuemanagement/list/queuelist_component.xml
Scope
All.
Elements
columns
showbreadcrumb
queuemanagement (Webtop)
queuemanagement (Webtop)
Purpose
Displays admin nodes in the browsertree that handle work items in the queue.
Parameters
nodeIds (Optional)IDs of queue management nodes in

the browsertree.
Description
Since
5.x
Configuration File
webtop\config\queuemanagement_component.xml
Parent Definition
xml
Scope
All.
Elements
None.
queuemanagementclipboard
Purpose
Displays contents of the Queue Management clipboard.
Parameters
None.
queuemember
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queuemanagementclipboard_component.xml
Parent Definition
clipboard:webcomponent/config/environment/clipboard/clipboard_component.xml
Scope
All.
Elements
dragdrop
queuemember
Purpose
Enables displaying and updating members of a work queue.
Parameters
objectId (Required) ID of the work queue object..

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queuemember_component.xml
Scope
All.
queuemgmtpropertycontainer
Elements
None.
queuemgmtpropertycontainer
Purpose
Enables updating work queue properties.
Parameters

action execution class. The name of the
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queuemgmtpropertycontainer_component.xml
Parent Definition
Scope
All.
Elements
failoverenabled
queuemonitorlist
queuemonitorlist
Purpose
Displays overview information for monitoring the contents of work queues.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queuemonitor_component.xml
Scope
All.
Elements
columns
showbreadcrumb
queuepolicy
Purpose
Enables displaying and updating work queue policies.
Parameters
queuepropertiescontainer
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queuepolicy_component.xml
Parent Definition
policyattributes:webcomponent/config/library/queuemanagement/policyattributes_component.xml
Scope
All.
Elements
objecttype
<objecttype>dmc_workqueue_policy</objecttype>
queuepropertiescontainer
Purpose
Container for the work queue properties component.
Parameters

objectname (Optional) Name of the work queue object.
queueskill
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queuepropertiescontainer_component.xml
Parent Definition
Scope
All.
Elements
None.
queueskill
Purpose
Enables creating and updating dmc_wq_skill_info objects.
Parameters

object.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queueskill_component.xml
Scope
All.
queueusersandgroups
Elements
None.
queueusersandgroups
Purpose
Displays the users and groups assigned to work on a work queue.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\queueusersandgroups_component.xml
Scope
All.
Elements
showbreadcrumb
recentworkqueuecategorylocator
Purpose
Lists work queue categories that the user has recently selected.
recentworkqueuecategorylocator
Parameters

multiple selection.
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
Elements
iconwell_icon
objecttype
<objecttype>dmc_workqueue_category</objecttype>

columns
containerselectable
views
skillinfolist
skillinfolist
Purpose
Displays a work queue’s skill info.
Parameters
None.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\list\skillinfolist_component.xml
Scope
All.
Elements
columns
showbreadcrumb
suspendqueuedtask
Purpose
Puts a task from a work queue into a suspended state.
Parameters
objectId (Required) ID of the task to suspend.
taskmanagercontainer (type dm_queued)
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\suspendqueuedtask_component.xml
Scope
All.
Elements
None.
taskmanagercontainer (type dm_queued)
Purpose
Parameters

initialize.
objectId (Required) Task ID.
taskmanagerId (Required) ID of the taskmanager object.
type (Required) Not used (any value can be inserted).
Description
Since
5.x
Configuration File
xml
unassignqueuedtask
Parent Definition
Scope
type dm_queued
Elements
failoverenabled
unassignqueuedtask
Purpose
Removes a work item from a particular work queue processor’s Inbox.
Parameters
objectId (Required) ID of the task to unassign.

queueName (Required) Name of the work queue containing
the task.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\unassignqueuedtask_component.xml
Scope
All.
Elements
None.
unassignqueuedtaskcontainer
unassignqueuedtaskcontainer
Purpose
Container component for removing work items from a particular work queue processor’s Inbox.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\unassignqueuedtaskcontainer_component.xml
Parent Definition
Scope
All.
Elements
None.
unsuspendqueuedtask
Purpose
Returns a suspended task in a work queue to active state.
Parameters
objectId (Required) ID of the suspended task.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\unsuspendqueuedtask_component.xml
Scope
All.
Elements
None.
Purpose
Changes the skill level of a work queue processor or the work queue document profile that the
processor is authorized to process.
Parameters
docprofile_name (Optional) Name of a work queue document

profile
skill (Optional) Skill level of the user for this work
queue. Valid values are the skill level strings
from the data dictionary.
username (Required) Name of the user.
wq_name (Required) Name of the work queue.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\updateprocessorauthentication_component.xml
Parent Definition
editprocessorauthentication:webcomponent/config/library/queuemanagement/
editprocessorauthentication_component.xml
Scope
All.
Elements
None.
Purpose
Enables updating a work queue processor’s skills.
Parameters
objectId (Optional) ID of a dmc_wq_user_skill object.

objectname (Required) Name of a dmc_wq_user_skill object.
requiredSkillIds (Required) IDs of the required dmc_wq_skill_
info objects required by the work queue.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\updateprocessorskill_component.xml
workqueuecategorylocatorcontainer
Parent Definition
processorskill:webcomponent/config/library/queuemanagement/processorskill_component.xml
Scope
All.
Elements
None.
workqueuecategorylocatorcontainer
Purpose
Container component for locating work queue categories.
Parameters

multiple selection.
selected
Description
Since
5.x
Configuration File
Parent Definition
Scope
All.
workqueuecategoryproperties
Elements
multidocbasesupport
workqueuecategoryproperties
Purpose
Sets the properties for a work queue category.
Parameters

objectId (Required) ID of the work queue category object.
objectname (Required) Name of the work queue category.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueuecategoryproperties_component.xml
Parent Definition
Scope
All.
Elements
None.
workqueuedocprofileproperties
workqueuedocprofileproperties
Purpose
Sets the properties of a work queue document profile.
Parameters

profile object.
profile.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueuedocprofileproperties_component.
xml
Parent Definition
Scope
All.
Elements
None.
workqueuelocator
Purpose
Lists the available work queues.
workqueuelocatorcontainer
Parameters
The parameters are inherited from persistentobjectlocator:webcomponent/config/library/locator/
persistentobjectlocator_component.xml. See persistentobjectlocator, page 965.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueuelocator_component.xml
Parent Definition
Scope
All.
Elements
attributes
columns
objecttype

views
iconwell_icon
workqueuelocatorcontainer
Purpose
Container component for locating available work queues.
workqueuepolicyproperties
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueuelocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
workqueuepolicyproperties
Purpose
Sets the properties for a work queue policy.
Parameters

objectname (Required) Name of the work queue policy.
workqueueproperties
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueuepolicyproperties_component.xml
Parent Definition
Scope
All.
Elements
None.
workqueueproperties
Purpose
Sets the properties for a work queue.
Parameters

objectname (Required) Name of the work queue.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\workqueueproperties_component.xml
Parent Definition
component.xml
wqpolicymanagement (Webtop)
Scope
All.
Elements
objecttype
<objecttype>dmc_workqueue</objecttype>
wqpolicymanagement (Webtop)
Purpose
Displays work queue policy and queue management document profile nodes as a list in the content
area.
Parameters
nodeIds (Optional) Target nodes in the tree.
Description
Since
6.0
Configuration File
Parent Definition
xml
Scope
All.
Elements
None.
wqskillinfoattributes
wqskillinfoattributes
Purpose
Enables displaying and updating work queue skill attributes.
Parameters
isNew (Optional) (Boolean) True, if the work queue is

new; False, if not..
objectname (Optional) Name of the skill info object that is
not used by the component.
readOnly (Optional) (Boolean) True, if the attribute is
read-only; False, if not.
templateId (Optional) ID of the work queue template.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\wqskillinfoattributes_component.xml
Parent Definition
Scope
All.
Elements
None.
wqskillinfolocator
Purpose
Locates work queue skill information (dmc_wq_skill_info objects).
wqskillinfolocatorcontainer
Parameters
The parameters are inherited from persistentobjectlocator:webcomponent/config/library/locator/
persistentobjectlocator_component.xml. See persistentobjectlocator, page 965.
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\wqskillinfolocator_component.xml
Parent Definition
Scope
All.
Elements
attributes
columns
objecttype
<objecttype>dmc_wq_skill_info</objecttype>

iconwell_icon
views
wqskillinfolocatorcontainer
Purpose
Container for wqskillinfolocator, page 1537 component.
wqskillmanagement (Webtop)
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\library\queuemanagement\wqskillinfolocator_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
wqskillmanagement (Webtop)
Purpose
Displays work queue skill info and work queue processor profile nodes as a list in the content area.
Parameters
nodeIds (Optional) Target nodes in the tree.
Description
Since
6.0
Configuration File
editxforms
Parent Definition
xml
Scope
All.
Elements
None.
XForms
editxforms
Purpose
Extends dialogcontainer to edit forms. Contains the component xforms, page 1546. If the user does
not have the form_user role, the form will be displayed as XML.
Parameters
deleteOnCancel (Optional) Specifies whether the new form

instance should be deleted when the user clicks
Cancel. The default is false; that is, the new
form instance is not deleted. This parameter
is set by the NewXFormsContainer. Because
XFormsComponent can be extended, you might
want to change this behavior.
isNew (Optional) Specifies whether the form is new.
objectId (Required) ID of the selected form.
readOnly (Optional) A value of true renders the form as
readonly (view mode).
templateId (Optional) ID of the associated form template. If
this parameter is not specified, the default form
template associated with the form instance is
used.
editxformsproperties
Description
Since
5.x
Configuration File
webcomponent\config\xforms\editxforms_component.xml
Parent Definition
Scope
All.
Elements
lockInstance
See lockInstance, page 738.
failoverenabled
editxformsproperties
Purpose
This component is used to edit a form component definition.
Parameters
The parameters are inherited from editxforms:webcomponent/config/xforms/editxforms_component.
xml. See editxforms, page 1540.
Description
Since
5.x
Configuration File
webcomponent\config\xforms\editxformsproperties_component.xml
Parent Definition
editxforms:webcomponent/config/xforms/editxforms_component.xml
newprintforms
Scope
All.
Elements
lockInstance
newprintforms
Purpose
Enables creating new printforms instance data.
Since
6.5
newprintformscontainer
Purpose
Container for the newprintforms, page 1542 component.
Since
6.5
newxforms
Purpose
This component is used to create a new form. The user must have the role form_user.
newxformscontainer
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\xforms\create\newxforms_component.xml
Scope
All.
Elements
None.
newxformscontainer
Purpose
Displays the component newxforms, page 1542 to create a new form. It extends wizardcontainer,
page 1062.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\xforms\newxformscontainer_component.xml
printformcheckin (type dm_sysobject)
Parent Definition
Scope
All.
Elements
failoverenabled
printformcheckin (type dm_sysobject)
Purpose
Performs a check in from the HiFi form edit component.
Since
6.5
printformcheckout (type dm_sysobject)
Purpose
Performs a check out from the HiFi form edit component.
Since
6.5
printformedit (type dm_sysobject)
Purpose
The HiFi form edit component that enables editing objects in the repository. This component is same
as the normal edit component, but its processor extends from the print form check out processor.
saveasxforms
Since
6.5
saveasxforms
Purpose
Creates a new form from a current form. The user must have the role form_user.
Parameters

Description
Since
5.x
Configuration File
webcomponent\config\xforms\saveasxforms_component.xml
Scope
All.
Elements
None.
viewxforms
Purpose
Extends editxforms component to display forms. Contains the xforms, page 1546 component. If the
user does not have the form_user role, the form will be displayed as XML.
xforms
Parameters
objectId (Required) ID of the selected form

templateId (Optional) ID of the associated form template
Description
Since
5.x
Configuration File
webcomponent\config\xforms\viewxforms_component.xml
Parent Definition
editxforms:webcomponent/config/xforms/editxforms_component.xml
Scope
All.
Elements
readOnly
lockInstance
xforms
Purpose
Displays a form for viewing or editing a selected form object. The user must have the role form_user.
The component is launched within the editxforms container or the viewxforms container by the
edit or view actions, respectively. The component passes parameter values to the xforms control,
which renders the form.
xformsattachmentimportlocatorcontainer
Parameters
lockInstance (Optional) Boolean: Whether the component is

to lock the form instance automatically when
the form is edited and release the lock when the
component is exited (by submitting or canceling)
(True) or not (False). Default is false.Since 6.0.
objectId (Required) Object ID of the form.
readOnly (Optional) Specifies whether the form should
be shown in edit or view mode. In edit mode,
WDK buttons are not hidden (form is modal).
In view mode, form buttons are disabled, and
WDK buttons are displayed (Close and Help).
Description
Since
5.x
Configuration File
webcomponent\config\xforms\xforms_component.xml
Scope
All.
Elements
None.
Purpose
This component is a locator container that contains a locator tab and an import tab. The user is able
to use the import tab to initiate an import action. After the import is completed, the corresponding
imported object will be included in the selected list.
Parameters

drop-down list.
importlocation (Required) ID of the repository folder to which
the document will be imported
objecttype (Required) Type of the selected object
restrictformats (Optional) Specify the formats the locator will
display
selected
startinlocation (Optional) ID of the folder where the locator
should begin the search
whereclause (Optional) Specifies the where clause that will
be used to locate the selected objects
Description
Since
5.x
Configuration File
webcomponent\config\xforms\locator\xformsattachmentimportlocatorcontainer_component.xml
Parent Definition
xformsattachmentlocatorcontainer:webcomponent/config/xforms/locator/
xformsattachmentlocatorcontainer_component.xml
Scope
All.
Elements
multidocbasesupport
xformsattachmentlocator
xformsattachmentlocator
Purpose
This component is a locator specialized for locating document attachments based on their type
and required version label(s).
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\xforms\locator\xformsattachmentlocator_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
objecttype

containerselectable
xformsattachmentlocatorcontainer
allversionsvisible
columns
views
xformsattachmentlocatorcontainer
Purpose
This component displays the component xformsattachmentlocator, page 1549, which is used to locate
attachments in the repository based on type and required version labels.
Parameters

drop-down list.
objecttype (Required) Type of the selected object
restrictformats (Optional) Specify the formats the locator will
display
selected
xformsimportlocator
startinlocation (Optional) ID of folder in which to start the

search
whereclause (Optional) Specifies the where clause that will
be used to locate the selected objects
Description
Since
5.x
Configuration File
webcomponent\config\xforms\locator\xformsattachmentlocatorcontainer_component.xml
Parent Definition
Scope
All.
Elements
multidocbasesupport
xformsimportlocator
Purpose
A dummy locator to be shown on an attachment locator container.
Parameters
Description
Since
5.x
xformsimportlocator
Configuration File
webcomponent\config\xforms\locator\xformsimportlocator_component.xml
Parent Definition
Scope
All.
Elements
iconwell_icon
columns
objecttype

containerselectable
allversionsvisible
views
xformsproperties
xformsproperties
Purpose
This component displays the properties panel for an xform object.
Parameters
Description
Since
5.x
Configuration File
webcomponent\config\xforms\xformsproperties_component.xml
Parent Definition
Scope
All.
Elements
None.
xformsproperties
Appendix A
Version 6.7: New Controls, Actions,
and Components
Controls
None.
Actions
None.
Components
None.
Version 6.7: New Controls, Actions, and Components
Appendix B
Obsolete, Deprecated, or Unused
functionality
This appendix lists the actions/components/jsp files that are obsolete, deprecated, or unused.
Controls
None.
Actions
Streamline view:
• streamlineviewvirtualdoc
• streamlineviewassembly
Portlets:
• None.
Components
Streamline view:
• assemblyliststreamline_component.xml
• categorystreamline_component.xml
• emptycontentstreamline_component.xml
• homecabinet_streamline_component.xml
• inboxstreamline_component.xml
• myfiles_streamline_component.xml
• myrooms_streamline_component.xml
Obsolete, Deprecated, or Unused functionality
• recordliststreamline_component.xml
• reportdetailsauditstreamline_component.xml
• reportdetailscontainerstreamline_component.xml
• reportdetailssummarystreamline_component.xml
• reportmainstreamline_component.xml
• room_homecabinet_streamline_component.xml
• room_streamlineview_component.xml
• streamlineview_component.xml
• subscriptions_streamline_component.xml
• taskmgrstreamline_component.xml
• vdmliststreamline_component.xml
• workflowstatusstreamline_component.xml
Portlets:
• portletspages.xml
• portlet.xml
• weblogic-portlet.xml
• portlet_preferences_component.xml
JSP files
Streamline view:
• view_record_relationships_streamline.jsp
• relationships_streamline.jsp
• renditions_streamline.jsp
• renditions_streamline_appintg.jsp
• searchstore_streamline.jsp
• viewassemblies_streamline.jsp
• messagearchiveviewer_streamline.jsp
• navigationcontainer_streamline.jsp
• objectgrid_streamline.jsp
• objectgrid_streamline_appintg.jsp
• vdmlist_streamline_body.jsp
• vdmlist_streamline.jsp
• emptyContentStreamline.jsp
• streamlineview.jsp
• vdmlist_streamline.jsp
Portlets:
• portletFooter.jsp
• portletHeader.jsp
• portlet_preferences.jsp
Index
A addgroupmembership (type
abortfailedautoworkflowtask (type dm_restriction) action, 568
dm_task) action, 621 addnewvirtualdocumentnode (type
abortworkflow (type dm_workflow) dm_sysobject) component, 1357
action, 622 addprocessorauthentication action, 569
abortworkflow (type dm_workflow) addrequiredgroup action, 569
component, 1404 addrequiredgroupset action, 570
about (Webtop) component, 787 addroommembercontainer
about component, 787 component, 872
absolutefilepathvalidator control, 122 addroomusercontainer component, 873
acceptworkflowtask (type dm_task) addroomuserorgrouplocator
action, 623 component, 874
accessiblefolderbrowse (privilege addtaskattachmentlocatorcontainer
sysadmin, type dm_user) action, 566 component, 1405
accessiblefolderbrowse (type adduserorgroup (type grouplist)
dm_member_user, entitlement action, 571
collaboration6) action, 567 addvirtualdocumentnode (type
accessiblefolderbrowser (entitlement dm_sysobject) component, 1358
collaboration6, role dce_user_manager) addvirtualdocumentnodefromclipboard
action, 381 (type dm_sysobject) component, 1359
action (control attribute), 15 addvirtualdocumentnodefromfileselector
actionbutton control, 17 (type dm_sysobject) component, 1360
actionbuttonlist control, 20 addwfattachment action, 624
actiondispatcher component, 753 adminbrowse (type dm_group) action, 572
actionimage control, 21 administration (Webtop) component, 754
actionlink control, 24 adminpropertycontainer component, 755
actionlinklist control, 27 adminuserorgrouplocator
actionmenuitem control, 28 component, 1315
actionmultiselect control, 30 adminuserorgrouplocatorcontainer
actionmultiselectcheckall control, 31 component, 1317
actionmultiselectcheckbox control, 32 advsearch (Webtop) component, 1195
actions advsearch component, 1192
common attributes, 15 advsearchcontainer (version 5.2.5)
control attributes, 15 component, 1197
actiontable element, 725 advsearchcontainer component, 1196
addattachment (type dmi_package) alldocumentlocator component, 948
action, 623 allsavedsearches component, 1198
addchildsysobjectlocator component, 1354 alluserwftemplatelocator component, 1406
addchildsysobjectlocatorcontainer allversionsvisible element, 725
component, 1356 allwftemplatelocator component, 1407
api component, 788
Index
appintgcontroller (Webtop) assemblyliststreamline (Webtop)

component, 758 component, 1350
appintgcontroller component, 756 assemblyliststreamline component, 1349
appintgcontrollerlogin (Webtop) asynchronous element, 725
component, 760 attachmenticon control, 59
appintgcontrollerlogin component, 759 attachmentlocator component, 1408
appintghelp component, 761 attachmentlocatorcontainer
appintginsertcabinetslocator component, 1410
component, 761 attachmentmyobjectlocator
appintginsertcategorieslocator component, 1411
component, 762 attachmentsubscriptionlocator
appintginsertlocatorcontainer component, 1412
component, 763 attributes
appintginsertmyfileslocator input masks, 131
component, 764 attributes (type dm_acl) action, 355
appintginsertobject action, 344 attributes (type dm_document)
appintginsertobject component, 765 component, 814
appintginsertsubscriptionslocator attributes (type dm_externalresult)
component, 765 action, 355
appintginsertweblink action, 345 attributes (type dm_externalresult)
appintginsertweblink component, 766 component, 1199
appintgnewfromtemplate action, 346 attributes (type dm_group) action, 356
appintgnewfromtemplate component, 767 attributes (type dm_member_group)
appintgopen component, 768 action, 357
appintgopenfrom action, 347 attributes (type dm_member_user,
appintgopenfrom component, 769 entitlement collaboration6) action, 358
appintgopenfromcabinetslocator attributes (type dm_sysobject) action, 359
component, 770 attributes (type dm_sysobject)
appintgopenfromcategorieslocator component, 815
component, 771 attributes (type dm_user) action, 360
appintgopenfromlocatorcontainer attributes (type dm_user, entitlement
component, 773 collaboration6) action, 359
appintgopenfrommyfileslocator attributes (type dm_workflow_calendar)
appintgopenfromrecentfileslocator attributes (type dmc_calendar_event)
appintgopenfromsubscriptionslocator attributes (type dmc_datatable_row)
appintgsaveas action, 348 attributes (type dmc_prm_library_request)
appintgsaveascabinets component, 778 component, 1109
appintgsaveascategories component, 779 attributes (type dmc_workqueue)
appintgsaveascontainer component, 780 action, 363
appintgsaveasmyfiles component, 781 attributes (type dmc_workqueue_category)
appintgsaveasrecentfiles component, 783 action, 361
appintgsaveassubscriptions attributes (type dmc_workqueue_doc_
component, 784 profile) action, 362
appintgxdql component, 785 attributes (type dmc_workqueue_policy)
argument control, 259 to 260 action, 362
assemblylist (Webtop) component, 1349 attributes (type workflow_calendar)
assemblylist component, 1348 action, 625
Index
attributes element, 725 changeucfcheckoutlocation

authenticate (Webtop) component, 790 component, 986
authenticate component, 789 checkin (type dm_sysobject) action, 420
authenticateexternalsource checkin (type dm_sysobject)
autogettaskdefault element, 726 checkincontainer component, 988
checkout (type dm_sysobject) action, 421
B component, 989
backdetector component, 791 checkoutbyother component, 990
bannerbox control, 60 checkoutbyothercontainer component, 991
base_type element, 726 checkoutcontainer component, 991
bindingcomponentversion element, 726 choosecontributors component, 880
bookmarklink control, 235 chooseowners component, 881
breadcrumb control, 237 clientapplicationinstaller component, 785
breadcrumbiconwellmode element, 726 clientevent element, 727
<breadcrumbiconwellmode>, 192 clustergroup control, 283
browsertree (Webtop) control, 318 clustertree control, 285
columnpanel control, 89
C columns (for data columns) element, 727
columns (for streamline view) element, 727
cabinets element, 726
columns_all_saved_searches element, 728
columns_list element, 728
action, 626
columns_my_saved_searches element, 728
columns_saved_search element, 729
action, 419
columnselector component, 1116
columnselectorcontainer component, 1118
component, 984
combocontainer component, 1046
cancelcheckoutcontainer component, 985
combocontainerpanel control, 324
category element, 726
comment (type dm_process) action, 628
celllist control, 87
comment (type dm_sysobject) action, 505
celltemplate control, 88
comment (type dm_task) action, 629
commentimage control, 61
action, 627
commentrow control, 63
comments element, 729
component, 1414
changeperformercontainer
action, 630
component, 1414
commitorder element, 730
changeroommemberrole component, 877
comparevalidator control, 123
completefailedautoworkflowtask (type
component, 878
dm_task) action, 630
component, 879
component, 1416
changeroommemberrolestep
component_preferences component, 1118
component, 879
components
changesearchsources component, 1200
actiontable element, common, 725
allversionsvisible element,
action, 627
common, 725
asynchronous element, common, 725
component, 1415
attributes element, common, 725
Index
autogettaskdefault element, failoverenabled element, common, 734

common, 726 filenamefiltervisible element,
base_type element, common, 726 common, 734
bindingcomponentversion element, filter element, common, 735
common, 726 flatlist element, common, 735
breadcrumbiconwellmode element, folder-docbase-type element,
common, 726 common, 735
cabinets element, common, 726 folder_filter element, common, 735
category element, common, 726 formsavefolderpath element,
clientevent element, common, 727 common, 735
columns (for data columns) element, header element, common, 736
common, 727 help-entries element, common, 736
columns (for streamline view) element, helppath element, common, 736
common, 727 hideEvents element, common, 736
columns_all_saved_searches element, highlight_matching_terms element,
columns_list element, common, 728 homecabinet element, common, 737
columns_my_saved_searches element, homeURL element, common, 737
common, 728 iconwell_icon element, common, 737
columns_saved_search element, inbox element, common, 737
common, 729 includetypes element, common, 737
comments element, common, 729 includeunlisted element, common, 737
commitorder element, common, 730 init-controls element, common, 738
common elements, 725 isIgnorePrefRenditions element,
containerselectable element, common, 738
common, 730 locator element, common, 738
contenttypepanelvisible element, lockInstance element, common, 738
common, 730 map element, common, 738
cost_attribute_conditions element, maxidletime element, common, 739
common, 730 menugrouptarget element,
default_binding_filter_values element, common, 739
common, 731 modifiedwithindays element,
default_type element, common, 731 common, 739
defaultaccounts element, common, 731 multidocbasesupport element,
defaultsources element, common, 731 common, 739
defaultview element, common, 732 myobjects element, common, 739
displayresultspath element, navigationlinks element, common, 739
common, 732 newcomponentname element,
docbase-type-mappings element, common, 740
common, 732 nodes element, common, 740
document-docbase-base-type element, nomaclsupport element, common, 740
common, 732 nondocbasecolumns element,
document-docbase-type element, common, 741
common, 732 numberedtabs element, common, 741
document_filter element, common, 733 objectfilters element, common, 741
dragdrop element, common, 733 pageTitle element, common, 741
duration_attribute_conditions element, permissionsservice element,
enableShowAll element, common, 734 preferencedisplaygroups element,
entrypage element, common, 734 common, 742
Index
preferences element, common, 742 transformation element, common, 750

preserve-file-extension element, type element, common, 750
common, 743 ucfrequired element, common, 750
preset_item_definition element, updatereplicasource element,
preset_scope_definitions element, useronly element, common, 751
common, 745 useroptions element, common, 751
privatecabinet_visible element, views element, common, 751
common, 745 windowparams element, common, 753
privatecabinetvisible element, workflowstatusactionname element,
privategroupvisible element, workqueuegroupvisible element,
readOnly element, common, 745 container component, 1047
savedetailsreport element, containerselectable element, 730
common, 746 contenttypepanelvisible element, 730
search_types element, common, 746 controls
searchtypes element, common, 746 event attributes, 14
selectedattribute element, set focus, 13
common, 747 WDK, 13
serveroptionenabled element, cost_attribute_conditions element, 730
common, 747 createhtmlrendition (type dm_sysobject)
service element, common, 747 action, 505
setrepositoryfromobjectid element, createhtmlrendition (type dmr_content)
common, 747 action, 506
showattachmentinfo element, createhtmlrenditiongeneric (type
common, 747 dm_sysobject) action, 507
showautogettask element, createhtmlrenditiongeneric (type
common, 748 dmr_content) action, 508
showbreadcrumb element, createpdfrendition (type dm_sysobject)
common, 748 action, 508
showfilters element, common, 748 createpdfrendition (type dmr_content)
showfolderpath element, common, 748 action, 509
showfolders element, common, 748 createpdfrenditiongeneric (type
showheaderforsinglepackage element, dm_sysobject) action, 510
common, 748 createpdfrenditiongeneric (type
showjobstatus element, common, 748 dmr_content) action, 511
showoptions element, common, 749 createpreset (type dmc_preset_package)
showpagesastabs element, action, 489
common, 749 cssclass attribute, 13
showusertimeandcost element,
common, 749
skipVersionCheck element,
D
common, 749 datacolumnbeginswith control, 90
startComp element, common, 749 datagrid control, 92
startQueryString element, datagridRow control, 95
common, 749 datagridRowBreak control, 96
subscriptions element, common, 749 datagridRowEvent control, 98
taskmgractionname element, datagridRowModifier control, 98
common, 750 datagridRowTd control, 99
Index
datagridTh control, 100 delete (type dmc_preset_package)

dataoptionlist control, 101 action, 490
datapagesize control, 102 delete (type dmc_room) component, 888
datapaging control, 104 delete (type dmc_search_template)
datasortimage control, 106 action, 518
datasortlink control, 107 delete (type dmr_content) action, 426
datatablefield control, 64 delete (type job_request) action, 427
datatablefieldpanel control, 110 delete (type workflow_calendar)
datatablefieldPanel control, 65 action, 635
datatablerowattributelist control, 111 delete component, 992
datetimevalidator control, 124 deletenotification (type dm_notification)
datevalidator control, 125 action, 635
dceuserattributes component, 884 deletepreset (type dmc_preset_package)
dceuserproperties component, 885 component, 1130
debug_preferences component, 1119 deletepresetcombocontainer
default_binding_filter_values element, 731 (type dmc_preset_package)
default_type element, common, 731 component, 1131
defaultaccounts element, common, 731 deletesmartlistcontainer (type
defaultsources element, common, 731 dm_smart_list) component, 1200
defaultview element, common, 732 deleteworkflow (type dm_workflow)
delegateworkflowtask (type dm_task) component, 1418
action, 631 deleteworkflowcalendar component, 1419
delegateworkflowtask component, 1417 dialogcontainer component, 1048
delete (entitlement collaboration, type disabledclass, 16
dmc_notepage) action, 382 disabledstyle, 16
delete (privilege sysadmin, type dm_user) display_preferences (version 5.3) (Webtop)
delete (type dm_activity) action, 632 display_preferences (Webtop)
delete (type dm_folder) action, 423 component, 1121
delete (type dm_group) action, 423 display_preferences component, 1120
delete (type dm_notification) action, 424 displayresultspath element, common, 732
delete (type dm_notification) dmc_prm_address_locatorcontainer
delete (type dm_process) action, 633 dmc_prm_addresslocator
delete (type dm_smart_list) action, 517 component, 1111
delete (type dm_sysobject) (Webtop) dmr_contentlocator component, 950
component, 994 dmr_contentlocatorcontainer
delete (type dm_sysobject) action, 425 component, 951
delete (type dm_sysobject) component, 993 docbase-type-mappings element,
delete (type dm_workflow) action, 634 common, 732
delete (type dmc_calendar) docbaseattribute control, 33
component, 886 docbaseattributedelegate control, 36
delete (type dmc_calendar_event) docbaseattributelabel control, 38
component, 885 docbaseattributelist control, 39
delete (type dmc_comment) action, 426 docbaseattributeproxy control, 42
delete (type dmc_comment) docbaseattributeseparator control, 43
component, 887 docbaseattributevalidator control, 126
delete (type dmc_notepage) docbaseattributevalue control, 44
component, 888 docbaseattributevalueassistance
control, 46
Index
docbaseattributevalueassistancevalue drlview (type dm_process) action, 636

control, 47 drlview (type dm_smart_list) action, 520
docbasemultiobjects control, 49 drlview (type dm_sysobject) (Webtop)
docbasemultiobjectsvalidator control, 127 action, 434
docbaseobject control, 49 drlview (type dm_sysobject) action, 433
docbaseobjectattributevalidator drlview (type dmc_datatable_row)
control, 128 action, 385
docbaseobjectvalidator control, 129 drlview (type dmc_search_template)
docbaserepeatingattribute component, 817 action, 521
docbasesingleattribute component, 818 drlview (type dmi_queue_item) (Webtop)
doclist (type dm_message_archive) action, 435
component, 1051 drlview (type search_template) action, 436
doclist (type dmc_calendar) duration_attribute_conditions element,
component, 889 common, 734
doclist component, 1050 dynamic attribute, on action control, 16
document-docbase-base-type element,
common, 732
document-docbase-type element,
E
common, 732 edit (type dm_smart_list) action, 522
document_filter element, common, 733 edit (type dm_sysobject) component, 996
documentlocatorcontainer component, 951 edit (type dmc_notepage) component, 890
documentsubscriptionlocator editafternew (type dm_sysobject)
DONTSHOWAGAIN, 1312 editcontainer (type dm_sysobject)
download component, 995 component, 997
downloadcontent (type dm_sysobject) editfile (entitlement collaboration, type
action, 428 dmc_notepage) action, 386
downloadcontentcontainer (type editfile (type dm_process) action, 637
dm_sysobject) component, 995 editfile (type dm_smart_list) action, 524
dql component, 792 editfile (type dm_sysobject) action, 438
dqleditor component, 793 editfile (type dmc_calendar_event)
dragdrop element, common, 733 action, 386
drilldown (type dm_message_archive) editfile (type dmc_datatable) action, 388
component, 953 editfile (type dmc_datatable_row)
drilldown component, 952 action, 387
drl component, 793 editfile (type dmc_search_template)
drlauthenticate component, 795 action, 526
drledit (type dm_smart_list) action, 519 editpreset (type dmc_preset_package)
drledit (type dm_sysobject) (Webtop) action, 491
action, 430 editsearch action, 522
drledit (type dm_sysobject) action, 429 editstartwfnote (type dmi_package)
drledit (type dmc_search_template) action, 638
action, 519 editstartwfnote (type dmi_package)
drledit (type search_template) action, 431 component, 1420
drlview (entitlement collaboration, type edittasknote (type dmi_package)
dmc_notepage) action, 384 action, 638
drlview (type dm_folder) (Webtop) edittasknote (type dmi_package)
drlview (type dm_message_archive) edittemplate (type dmc_search_template)
(Webtop) action, 432 action, 526
Index
edittemplatedefinition (type folder_filter element, common, 735

dmc_search_template) action, 527 folderbrowse (entitlement collaboration6,
elements role dce_user_manager) action, 390
common component, 725 folderbrowse (type dm_member_user,
emailperformers (type dm_workflow) entitlement collaboration6) action, 391
action, 639 folderlocatorcontainer component, 955
emailsupervisor (type dm_workflow) foldersubscriptionlocator component, 1249
action, 640 format_pref_attr_selector component, 1122
embeddedtopic (type dmc_room) format_preferences_summary
embeddedtopic component, 891 formatmessageparams control, 324
enabled, 13 formatpreferencescontainer
enableShowAll element, common, 734 component, 1124
entrypage element, common, 734 formsavefolderpath element, common, 735
er_properties (Webtop) action, 389 formurl control, 239
er_properties (Webtop) component, 893 forwardroutertask (type dm_router_task)
er_search (Webtop) action, 389 action, 642
events forwardroutertask component, 1422
control, 14 forwardworkflowtask (type dm_task)
export (type dm_message_archive) action, 642
action, 439 forwardworkflowtask component, 1423
export (type dm_sysobject) action, 439
component, 999
G
export (type dmc_datatable) general_preferences (version 5.3) (Webtop)
export (type dmr_content) general_preferences (Webtop)
exportcontainer (type dm_sysobject) general_preferences component, 1125
component, 1001 getcontent component, 1005
exportcontainer (type dmr_content) govern (entitlement collaboration)
exportrendition (type dmr_content) govern (type dm_folder) component, 895
action, 440 governedicon control, 66
exportviewcontainer (type dm_message_ governfolder (entitlement collaboration)
archive) component, 1003 action, 392
externalresultimportcontainer groupattributes component, 1317
component, 1004 groupbrowse (privilege sysadmin, type
dm_user) action, 572
groupbrowse (type dm_group) action, 573
F groupbrowse (type dm_member_user,
failoverenabled element, common, 734 entitlement collaboration6) action, 393
filenamefiltervisible element, common, 734 groupdelete component, 1318
filter element, common, 735 grouplist component, 1319
finishworkflowtask (type dm_task) grouplocator component, 1320
action, 641 grouplocatorcontainer component, 1321
finishworkflowtask component, 1421 groupproperties component, 1322
flatlist element, common, 735 groupreassign (type dm_group) action, 574
focus attribute, 13 groupreassign (type dm_member_group)
folder-docbase-type element, common, 735 action, 574
Index
grouprename component, 1322 homecabinet_drilldown (type dm_

grouprenamelog (type dm_group) message_archive) component, 1068
action, 575 homecabinet_drilldown component, 1067
groupwhereused component, 1323 homecabinet_list (type dm_message_
archive) component, 1070
H component, 899
halttask (type dm_task) action, 643 homecabinet_list component, 1069
halttask (type dm_task) component, 1423 homecabinet_streamline (type
haltworkflow (type dm_workflow) dm_message_archive) (Webtop)
haltworkflow (type dm_workflow) homecabinet_streamline (type dmc_room)
component, 1424 (Webtop) component, 899
header element, common, 736 homecabinet_streamline (Webtop)
help-entries element, common, 736 component, 1072
helppath element, common, 736 homeURL element, common, 737
hideEvents element, common, 736 httpcancelcheckout (type dm_sysobject)
highlight_matching_terms element, component, 1006
common, 736 httpcancelcheckoutcontainer
historicalactivityreportresults component, 1007
component, 1376 httpcheckin (type dm_sysobject)
historicalprocessreport action, 645 component, 1008
historicalprocessreport component, 1377 httpcheckincontainer component, 1009
historicalprocessreportcontainer httpcheckout (type dm_sysobject)
historicalprocessreportresults httpcheckoutcontainer component, 1011
component, 1379 httpedit (type dm_sysobject)
historicalreportcolumnselector component, 1012
component, 1380 httpeditcontainer component, 1012
historicaluserreport action, 646 httpexport (type dm_sysobject)
historicaluserreport component, 1381 component, 1013
historicaluserreportcontainer httpexport (type dmr_content)
historicaluserreportresults httpexportcontainer component, 1015
component, 1382 httpimport component, 1016
history (type dm_sysobject) action, 364 httpimportcontainer component, 1017
history (type dm_task) action, 646 httpimportrendition component, 1019
history component, 819 httpimportrenditioncontainer
homecabinet element, common, 737 component, 1019
homecabinet_classic (type dm_message_ httpmultifiledownload component, 1020
archive) (Webtop) component, 1065 httpview (type dmr_content) (Webtop)
homecabinet_classic (type dmc_calendar) component, 1023
(Webtop) component, 896 httpview (type dmr_content)
homecabinet_classic (type dmc_datatable) component, 1022
(Webtop) component, 897 httpview (Webtop) component, 1024
homecabinet_classic (type dmc_room) httpview component, 1021
(Webtop) component, 898 httpviewcontainer component, 1025
component, 1066
Index
I L
iconwell_icon element, common, 737 label attribute
id attribute controls, 14
controls, 14 label control, 312
import (type dm_folder) action, 441 listbox control, 114
import (type dmc_calendar) locatecheckinlocalfile component, 956
component, 901 locatecheckinlocalfilecontainer
import (type dmc_calendar_event) component, 956
component, 900 locateimportlocalfile component, 957
import (type dmc_datatable) action, 394 locateimportlocalfilecontainer
import component, 1026 component, 958
importcontainer component, 1028 locatelocalfile component, 959
importexternalresult (type dm_ locatelocalfilecontainer component, 959
externalresult) action, 528 locator element, common, 738
importrendition (type dm_sysobject) locatorcontainer component, 960
action, 442 lockInstance element, common, 738
importrendition (type dmr_content) login (Webtop) component, 800
action, 443 login component, 798
importrendition component, 1029 logoff (Webtop) component, 802
importrenditioncontainer logoff component, 801
component, 1030
importrenditiongeneric (type
dm_sysobject) action, 444
M
importrenditiongeneric (type dmr_content) main (version 5.3) (Webtop)
inbox element, common, 737 main (Webtop) component, 805
inboxclassic (Webtop) component, 1074 main component, 802
inboxdrilldown component, 1075 makelibraryrequest component, 1112
inboxlist component, 1425 makelibraryrequestcontainer
inboxstreamline (Webtop) component, 1113
component, 1076 map element, common, 738
includetypes element, common, 737 markread (entitlement collaboration, type
includeunlisted element, common, 737 dm_sysobject) action, 395
index component, 796 markunread (entitlement collaboration,
init-controls element, common, 738 type dm_sysobject) action, 396
input masks, 131 maxidletime element, common, 739
inputmaskvalidator control, 130 menugrouptarget element, common, 739
installedrecentwftemplatelocator messageimportanceformatter control, 68
component, 1426 migratepresets action, 491
installedwftemplatefolderlocator migratepresets component, 1132
component, 1426 modifiedwithindays element,
installedwftemplatesubscriptionlocator common, 739
component, 1427 modifyversionlabels (type dm_sysobject)
isIgnorePrefRenditions element, action, 365
common, 738 modifyversionlabels component, 820
msgattachmenticon control, 68
multiargdialogcontainer component, 1052
K multidocbasesupport element,
Kerberos common, 739
SSO login, 797
Index
multiobjectsattributes (type dm_sysobject) navigationcontainer (Webtop)

multiobjectsdocbaseattribute control, 51 navigationcontainer component, 1054
multiobjectsdocbaseattributelabel navigationlinks element, common, 739
control, 53 nestedcomponentcontainer
multiobjectsdocbaseattributelist control, 54 component, 1055
multiobjectsdocbaseattributevalidator newassembly component, 1351
control, 132 newassemblycontainer component, 1352
multiobjectsdocbaseattributevalue newcalendar (type dm_folder, entitlement
control, 55 collaboration6) action, 397
multiobjectsdocbaserepeatingattribute newcalendar component, 908
component, 822 newcalendarcontainer component, 909
multiobjectsdocbasesingleattribute newcalendarevent (type dmc_calendar)
multiobjectsproperties component, 823 newcalendarevent component, 909
multiobjectsselectsingleattributevalue newcalendareventcontainer
multiobjectsselectuserattributevalue newcomponentname element,
component, 825 common, 740
multiobjectsversionlabels component, 827 newgroup (privilege creategroup, type
multiselector control, 116 dm_group) action, 576
multivaluesinputmaskvalidator newinvitewindow (entitlement
control, 133 collaboration) component, 911
multivaluesrequiredfieldvalidator newinvitewindow (entitlement
control, 134 collaboration6) action, 399
myobjects element, common, 739 newnotepage (entitlement collaboration,
myobjects_list component, 961 type dm_folder) action, 399
myrooms_classic (Webtop) newnotepage component, 912
component, 903 newnotepagecontainer component, 912
myrooms_drilldown component, 903 newprocess (type dm_folder) action, 647
myrooms_list component, 904 newrole (privilege creategroup, type
myrooms_streamline (Webtop) dm_role) action, 576
component, 905 newroom (entitlement collaboration,
mysavedsearches component, 1201 privilege creategroup, type dm_folder)
myuserwftemplatelocator action, 400
component, 1428 newroom component, 913
mywftemplatelocator component, 1430 newroomcontainer component, 914
newroomgroup component, 915
newroomgroupcontainer component, 916
N newtable (type dm_folder, entitlement
name attribute collaboration6) action, 401
controls, 14 newtable component, 917
nativeroombrowse (type dm_group) newtablecontainer component, 917
action, 396 newtableentry (type dmc_datatable)
nativeroomobjectlocator component, 906 action, 402
nativeroomobjectlocatorcontainer newtableentry component, 918
component, 907 newtableentrycontainer component, 919
navigation (type dm_message_archive) newuser (entitlement collaboration6,
(Webtop) component, 1053 privilege sysadmin, type dm_user)
action, 403
Index
newuser (entitlement collaboration6, role permissionsservice element, common, 742

dce_user_manager, type dm_user) persistentobjectlocator component, 965
action, 404 portal_login component, 808
newuser (privilege sysadmin, type portal_preferences component, 1127
dm_user) action, 577 portalsearch component, 1202
newwindow (Webtop) component, 807 portalsearchcontainer component, 1203
newwindow component, 806 portlet_preferences component, 1128
newWorkflowCalendar (type preferencedisplaygroups element,
workflow_calendar) action, 648 common, 742
nlsid attribute preferences component, 1129
controls, 14 preferences element, common, 742
nodataRow control, 118 preserve-file-extension element,
nodemanagement component, 756 common, 743
nodes element, common, 740 preset_item_definition element,
nomaclsupport element, common, 740 common, 744
nondocbasecolumns element, preset_scope_definitions element,
notepage (type dmc_notepage) (Webtop) presetactionitem component, 1133
component, 920 presetallfolderlocator component, 1134
notepage (type dmc_notepage) presetautoattributesitem component, 1134
component, 920 presetdocbasenamescope component, 1135
numberedtabs element, common, 741 presetdocbaseselector action, 492
preseteditorcontainer component, 1136
presetformatitem component, 1137
O presetgroupitem component, 1137
objectfilters element, common, 741 presetgrouplocator action, 493
objectgrid component, 1056 presetitems component, 1138
objectlist (type dm_message_archive) presetlifecycleitem component, 1139
(Webtop) component, 1073 presetlist component, 1140
objectlist (type dmc_calendar) (Webtop) presetlocationlocator action, 494
component, 921 presetlocationlocatorcontainer
objectlist (type dmc_datatable) (Webtop) component, 1140
component, 922 presetlocationscope component, 1141
objectlist (type dmc_room) (Webtop) presetnavigationitem component, 1142
component, 923 presetobjectlocator action, 495
objectlist (Webtop) component, 962 presetobjectlocator component, 1143
objectlocator component, 964 presetobjectlocatorcontainer
onchange event, 15 component, 1144
onclick event, 15 presetobjecttypelocator action, 496
oncomplete, 16 presetobjecttypelocator component, 1145
onselect event, 15 presetobjecttypelocatorcontainer
options (type dmc_room) action, 404 component, 1146
ownerbrowse (type dm_group) action, 578 presetotherdocbaselocationeditor
component, 1147
P presetpermissionitem component, 1147
presetpermissionlocator action, 496
pageTitle element, common, 741
presetscopes component, 1148
pendingtargets component, 1113
presettemplateitem component, 1149
permissions (type dm_sysobject)
presettypeitem component, 1149
action, 365
presettypescope component, 1150
Index
presetusergrouprolescope R
component, 1151 rangevalidator control, 137
presetuserorgrouplocator action, 497 readOnly element, common, 745
presetwizardcontainer component, 1151 reassignuser (privilege superuser, type
presetworkflowitem component, 1152 dm_user) action, 581
primaryfolderpathlink control, 240 reassignuser (type dm_member_user)
privatecabinet_visible element, action, 582
common, 745 recentdocumentlocator component, 966
privatecabinetvisible element, recentfolderlocator component, 967
common, 745 recentgrouplocator component, 1324
privategroupvisible element, common, 745 recentsysobjectlocator component, 968
processdetailreportresults recentuseronlylocator component, 1325
component, 1383 recentuserorgrouplocator
progressbar control, 326 component, 1326
progressbarupdater control, 327 recentwftemplatelocator component, 1431
promptedtext control, 327 recordsubscriptionlocator (entitlement
properties (entitlement collaboration6, type recordsmanager), 1175
dm_user) action, 405 recurrence component, 927
properties (type dm_externalresult) recurrexceptionicon control, 69
action, 529 regexpvalidator control, 138
properties (type dm_externalresult) rejectroutertask (type dm_router_task)
properties (type dm_group) action, 579 rejectroutertask component, 1432
properties (type dm_member_group) rejectworkflowtask (type dm_task)
action, 579 action, 649
properties (type dm_member_user, rejectworkflowtask component, 1433
entitlement collaboration6) action, 580 relationships (type dm_sysobject)
properties (type dm_message_archive) action, 367
action, 366 removeattachment (type dmi_package)
properties (type dm_smart_list) action, 530 action, 650
properties (type dm_sysobject) action, 366 removeattachment component, 1433
properties (type dm_user) action, 581 removecredential component, 808
properties (type dmc_calendar_event) removerequiredgroup action, 583
component, 924 removerequiredgroupset action, 584
properties (type dmc_datatable) removestartwfattachment (type
component, 925 dmi_package) action, 651
properties (type dmc_preset_package) removestartwfattachment
properties (type dmc_prm_library_request) removestartwfwfattachment (type
component, 1114 dmi_wf_attachment) action, 652
properties (type dmc_room) removestartwfwfattachment
properties component, 828 removeuserorgroup (type dm_member_
propertysheetcontainer component, 830 group) action, 584
propertysheetwizardcontainer removeuserorgroup (type dm_member_
component, 831 user) action, 585
Q component, 1361
quotevalidator control, 136
Index
removevirtualdocumentnodecontainer reportdetailssummarydrilldown (type

component, 1361 dm_workflow) (Webtop) action, 659
removewfattachment (type reportdetailssummarydrilldown (type
dmi_wf_attachment) action, 653 dm_workflow) action, 658
removewfattachment component, 1435 reportdetailssummarydrilldown
rename (type dm_sysobject) action, 368 component, 1393
rename component, 832 reportdetailssummarylist (type
renamegrouplist component, 1327 dm_workflow) (Webtop) action, 660
renamereport component, 1328 reportdetailssummarylist (type
renameuserlist component, 1329 dm_workflow) action, 659
renditions (type dm_sysobject) action, 511 reportdetailssummarylist component, 1394
reordervirtualdocumentnodes reportdetailssummarystreamline
component, 1363 (type dm_workflow) (Webtop)
repeatworkflowtask (type dm_task) component, 1395
action, 654 reportdql component, 1396
repeatworkflowtask component, 1437 reportmainclassic (Webtop) action, 661
reportdetailsauditclassic (type reportmainclassic (Webtop)
dm_workflow) (Webtop) action, 655 component, 1396
reportdetailsauditclassic (type reportmaindrilldown action, 661
dm_workflow) (Webtop) reportmaindrilldown component, 1397
component, 1384 reportmainlist component, 1398
reportdetailsauditdrilldown (type reportmainsettings action, 662
dm_workflow) action, 655 reportmainsettings component, 1399
reportdetailsauditdrilldown reportmainstreamline (Webtop) action, 663
component, 1385 reportmainstreamline (Webtop)
reportdetailsauditlist (type dm_workflow) component, 1400
action, 656 reportsysobjectlocator component, 1401
reportdetailsauditlist component, 1386 reportsysobjectlocatorcontainer
reportdetailsauditstreamline (type component, 1402
dm_workflow) (Webtop) action, 657 repositionvirtualdocumentnode (type
reportdetailsauditstreamline (type dm_sysobject) component, 1363
dm_workflow) (Webtop) repositorysearch control, 288
component, 1386 requestedtargets component, 1115
reportdetailscontainerclassic (type requiredfieldvalidator control, 139
dm_workflow) (Webtop) rerunfailedautoworkflowtask (type
component, 1387 dm_task) action, 664
reportdetailscontainerdrilldown (type rerunfailedautoworkflowtask
dm_workflow) component, 1388 component, 1437
reportdetailscontainerlist (type resultshandling_preferences
dm_workflow) component, 1389 component, 1203
reportdetailscontainerstreamline resumetask (type dm_task) action, 665
(type dm_workflow) (Webtop) resumetask (type dm_task)
reportdetailsheader component, 1391 resumeworkflow (type dm_workflow)
reportdetailsmap (type dm_workflow) action, 665
action, 657 resumeworkflow (type dm_workflow)
reportdetailsmap component, 1391 component, 1439
reportdetailssummaryclassic (type revisesearchtemplate action, 531
dm_workflow) (Webtop) richtextdisplay control, 70
component, 1392 richtextdocbaseattribute control, 72
Index
richtextdocbaseattributelabel control, 73 search component, 1208

richtextdocbaseattributevalue control, 74 search_preferences component, 1215
richtexteditor control, 75 search_types element, common, 746
richtextimagepicker component, 927 searchattribute control, 288
richtextinsertlink component, 928 searchattributegroup control, 290
richtextpanel control, 77 searchcontainer component, 1216
roleattributes component, 1329 searchdateattribute control, 293
rolelist component, 1330 searchfulltext control, 295
roleproperties component, 1331 searchitems component, 1216
roombanner control, 78 searchlocation control, 297
roomgrouplocator component, 929 searchmonitoring component, 1217
roomgrouplocatorcontainer searchmonitoringcontainer
roominvite (entitlement collaboration) searchobjecttypedropdownlist control, 298
component, 931 searchscopecheckbox control, 301
roommembers (type dmc_room) searchsizeattribute control, 303
action, 407 searchsources_preferences
roommembership component, 932 component, 1221
roomoptions component, 932 searchstatus component, 1222
roomuserorgrouplocator component, 933 searchstatuscontainer component, 1223
roomuserorgrouplocatorcontainer searchstoreclassic component, 1224
component, 935 searchstorestreamline component, 1225
row control, 119 searchstoretemplate component, 1225
run time searchtemplate component, 1227
attribute values resolved, 17 searchtemplatecontainer component, 1228
runatclient attribute, 15 searchtemplatefreelist control, 305
runsearchtemplate (type dmc_search_ searchtemplatehiddenfixedlist control, 306
template) action, 531 searchtypes element, common, 746
searchuser (type dm_user) action, 535
selectedattribute element, common, 747
S selectmultipleuserattributevalue
savechanges (Webtop) component, 1365 component, 832
savechanges component, 1364 selectmultipleuseridattributevalue
savecredential component, 810 component, 834
savedetailsreport element, common, 746 selectmultipleuserorgroupattributevalue
savedsearches (version 5.2.5) component, 834
component, 1204 selectrepeatingattributevalue
savereportlocator component, 1403 component, 835
savereportname component, 1404 selectsingleattributevalue component, 836
savesearch (version 5.2.5) component, 1206 selectuser (type selectuser) action, 586
savesearch action, 532 selectuserattributevalue component, 837
savesearch component, 1205 selectuseridattributevalue component, 839
savesearchcontainer component, 1207 selectuserorgroupattributevalue
savesearchtemplate action, 533 component, 839
savesearchtemplate component, 1208 sendlocator (type dm_notification)
search (version 5.3) (Webtop) action, 666
component, 1213 sendlocator (type dm_router_task)
search (version 5.3) component, 1211 action, 667
search (Webtop) component, 1214 sendlocator (type dm_task) action, 668
search action, 534
Index
serveroptionenabled element, startwfperformers component, 1442

common, 747 startwfxformcontainer (type dm_process)
service element, common, 747 component, 1442
setbindingrule component, 1366 startworkflow (type dm_process)
setrepositoryfromobjectid element, action, 668
common, 747 startworkflow component, 1443
showattachmentinfo element, startworkflowdrilldown component, 1444
common, 747 startworkflowfromdoc (type dm_sysobject)
showautogettask element, common, 748 action, 669
showbreadcrumb element, common, 748 startworkflownotemplate action, 670
showfilters element, common, 748 startworkflowtemplatelocatorcontainer
showfolderpath element, common, 748 component, 1445
showfolders element, common, 748 startworkflowxforms component, 1445
showheaderforsinglepackage element, strategyselector control, 310
common, 748 streamlineview (type dm_message_
showifdisabled, 16 archive) (Webtop) component, 1058
showifinvalid, 16 streamlineview (type dmc_room) (Webtop)
showjobstatus element, common, 748 component, 938
showoptions element, common, 749 streamlineview (Webtop) component, 1058
showpagesastabs element, common, 749 style attribute, 14
showtopic (entitlement collaboration, type subscribeotherslocator component, 1250
dm_sysobject) action, 407 subscribeotherslocatorcontainer
showtopic (Webtop) component, 937 component, 1251
showtopic component, 936 subscriptionlocator component, 1252
showtopicaction (entitlement collaboration, subscriptions element, common, 749
type dm_sysobject) (Webtop) subscriptions_classic (Webtop)
showtopicaction (entitlement collaboration, subscriptions_drilldown component, 1255
type dm_sysobject) action, 408 subscriptions_list component, 1255
showtopicdocbaseattribute control, 79 subscriptions_streamline (Webtop)
showtopicdocbaseattributelabel control, 80 component, 1256
showtopicdocbaseattributevalue symbolicversionlabelvalidator control, 140
control, 80 sysobjectlocator component, 969
showusertimeandcost element,
common, 749
skipVersionCheck element, common, 749
T
smartnavigation_preferences tabbar (Webtop) component, 1059
component, 1228 tablefields (type dmc_datatable) action, 410
sortableclustertreelist control, 307 tablefields component, 939
sortablelistbox control, 309 taskattachment component, 1446
spellchecker component, 938 taskcomments component, 1447
SSO login taskcomponentcontainer component, 1448
Kerberos, 797 taskheader component, 1449
sso_login component, 810 taskhistory component, 1449
startComp element, common, 749 taskinfo component, 1450
startQueryString element, common, 749 taskmanager component, 1451
startwfattachment component, 1439 taskmanagercontainer (type
startwfcomments component, 1440 dm_notification) component, 1452
startwfcontainer (type dm_process) taskmanagercontainer (type
component, 1441 dm_router_task) component, 1453
Index
taskmanagercontainer (type dm_task) useronlylocator component, 1339

component, 1454 useronlylocatorcontainer component, 1340
taskmgrabortworkflow (type dm_task) useroptions element, common, 751
component, 1455 userorgroupchooser action, 588
taskmgractionname element, common, 750 userorgrouplocator component, 1341
taskprocessvariables component, 1456 userorgrouplocatorcontainer
taskprogress component, 1456 component, 1342
text control, 314 userorgroupmemberlocator
textarea control, 316 component, 1343
titlebar (Webtop) component, 1061 userorgroupmemberlocatorcontainer
toolbar (Webtop) component, 1061 component, 1344
tooltip attribute, 14 userproperties component, 1345
tooltipdatafield attribute, 14 userrename component, 1346
tooltipnlsid attribute, 14 userrenamelog (type dm_user) action, 588
topic control, 81 userrequestlist (entitlement prm,
topicpanel control, 82 role dmc_prm_library_user)
topicstatus control, 83 component, 1116
transformation element, common, 750 userwhereused component, 1347
tree control, 321 utf8stringlengthvalidator control, 141
type element, common, 750
V
U validationsummary control, 143
ucfinvoker component, 811 vdm_preferences (Webtop)
ucfrequired element, common, 750 component, 1367
unfilteredcontainersysobjectlocator vdm_preferences component, 1366
component, 971 vdmclickactionprompt (Webtop)
ungovern (entitlement collaboration) component, 1369
action, 411 vdmclickactionprompt component, 1368
ungovern (type dm_folder) vdmclickactionpromptcontainer
ungovernfolder (entitlement collaboration) vdmcopyoption component, 1370
action, 411 vdmlist (Webtop) component, 1372
updatereplicasource element, vdmlist component, 1371
common, 751 vdmliststreamline (Webtop)
useraclobjectlocator component, 1332 component, 1374
useraclobjectlocatorcontainer vdmliststreamline component, 1373
component, 1333 vdmvalidate component, 1375
userattributes component, 1334 vdmvalidate_container component, 1376
userbrowse (privilege sysadmin, type versionlabels component, 840
dm_user) action, 586 versions (type dm_sysobject) (Webtop)
userchangehomedblist component, 1334 component, 842
userchangestate component, 1335 versions (type dm_sysobject) action, 369
userdelete component, 1336 versions (type dm_sysobject)
userimport (privilege sysadmin, type component, 841
dm_user) action, 587 versions (type wdk5_testtype_1)
userimport component, 1336 component, 843
userlist component, 1337 versions (type wdk5_testtype_2)
usermanagement component, 1338 component, 844
useronly element, common, 751
Index
versions (type wdk5_testtype_3) virtuallinkconnect component, 812

component, 845 visible attribute, 14
view (entitlement collaboration, type visiblerepository_preferences
dmc_notepage) action, 412 component, 1130
view (type dm_externalresult) action, 535
action, 448
W
view (type dm_message_archive) (Webtop) webwfm component, 1457
action, 449 webwfm_checkjvm component, 1458
view (type dm_message_archive) webwfmcontainer component, 1459
action, 449 webwfmeditcontainer component, 1460
view (type dm_notification) action, 671 wfgrouponlylocator component, 1460
view (type dm_process) action, 672 wfgrouponlylocatorcontainer
view (type dm_query) action, 536 component, 1462
view (type dm_router_task) action, 672 wfrecentuseronlylocator component, 1463
view (type dm_smart_list) action, 538 wfsysobjectlocatorcontainer
view (type dm_sysobject) (Webtop) component, 1463
action, 452 wftemplatefolderlocator component, 1464
view (type dm_sysobject) action, 451 wftemplatelocatorcontainer
view (type dm_sysobject) component, 1032 component, 1466
view (type dm_task) action, 673 wftemplatesubscriptionlocator
view (type dm_workflow) action, 674 component, 1466
view (type dmc_calendar_event) wfuseronlylocator component, 1468
action, 413 wfuseronlylocatorcontainer
view (type dmc_datatable_row) action, 414 component, 1469
view (type dmc_search_template) wfuserorgroupfromgrouplocator
view (type dmr_content) action, 453 wfuserorgroupfromgrouplocatorcontainer
view (type dmr_content) component, 1033 component, 1471
view_as_html (type dm_message_archive) wfuserorgrouplocator component, 1472
(Webtop) action, 446 wfuserorgrouplocatorcontainer
view_as_html_drilldown (type component, 1473
dm_message_archive) (Webtop) windowparams element, common, 753
action, 445 wizardcontainer component, 1062
view_as_outlook_mail_msg (type workflowavailability action, 675
dm_message_archive) action, 447 workflowavailability component, 1474
viewassemblies (Webtop) component, 1354 workflowcalendar component, 1475
viewassemblies component, 1352 workflowcalendarcontainer
viewcontainer (type dm_sysobject) component, 1476
component, 1034 workflowcalendardetails component, 1476
viewcontainer (type dmr_content) workflowcalendareditcontainer
viewcontent (type dm_sysobject) workflowcalendarevent component, 1478
action, 454 workflowcalendarlist (type
viewexternalresult component, 1229 workflow_calendar) action, 675
viewreport (type dm_rename_log) workflowcalendarlist component, 1479
action, 589 workflowstatusactionname element,
views element, common, 751 common, 753
viewsavedresults (type dm_smart_list) workflowstatusclassic (Webtop) action, 676
action, 540
Index
workflowstatusclassic (Webtop) workflowstatusstreamline (Webtop)

workflowstatusdrilldown action, 677 workflowstatusstreamline (Webtop)
workflowstatusdrilldown component, 1482
component, 1480 workflowxforms component, 1482
workflowstatuslist action, 677 workqueuegroupvisible element,
workflowstatuslist component, 1481 common, 753

Documentum Web Development Kit and Webtop 6.7 Reference Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Documentum Web Development Kit and Webtop 6.7 Reference Guide

Uploaded by

Copyright:

Available Formats

EMC ® Documentum ®

Web Development Kit and Webtop

User feedback................................................................................................. 324

Chapter 2 Actions Reference ..................................................................................... 343

User feedback................................................................................................. 565

Chapter 3 Components Reference ............................................................................. 725

hideEvents ................................................................................................. 736

taskmgractionname .................................................................................... 750

Repository ................................................................................................... 1186

Appendix B Obsolete, Deprecated, or Unused functionality ....................................... 1557

Figure 1. In-progress real-time search monitoring ............................................................. 1219

Table 1. Common control attributes ................................................................................... 13

Revision Date Description

• Added the Appendix B, Obsolete, Deprecated, or Unused functionality.

Revision Date Description

Common control attributes

Table 1. Common control attributes

nlsid NLS lookup key. The string corresponding to

Table 2. Event attributes

Table 3. Common action control attributes

• (False) the control is not displayed.

Default is false. A value of true overrides a

To hide all invalid actions in the application, set

showifdisabled Whether, when one or more of the action

• (False) the control is not displayed.

disabledstyle Entire CSS-syntax style sheet rule (enclosed in

Dynamic action attribute values

Note: Dynamic action controls do not support the oncomplete attribute.

Runtime tag attribute override

action (Required) ID of the action to be launched by

cssclass (Optional) CSS class that is applied to this

oncompleteclient (Optional) For internal use only.

Tag library descriptor

cssclass (Optional) CSS class to apply to this control.

oncomplete (Optional) Event to be fired when an associated

visible (Optional) (Boolean) Whether the control is

Tag library descriptor

action (Required) ID of the action to be launched by

datafielddisabled (Optional) Overrides srcdisabled value.

showimage (Optional) Whether to display the icon (True) or

Tag library descriptor

action (Required) ID of the action to be launched by

id (Optional) ID for the control. The ID is generated

tabindex (Optional) Value (a whole number from 0 to

Tag library descriptor

columns (Optional) Number of columns in which to

style (Optional) CSS rule (enclosed in quotation

Tag library descriptor

action (Required) ID of the action to be launched by

id (Optional) ID of the control. The ID is generated

Tag library descriptor

id (Optional) ID of the control. The ID is generated

Tag library descriptor

cssclass (Optional) CSS class to apply to this control.

that do not have this attribute, or specify a

Tag library descriptor

cssclass (Optional) CSS class to apply to this control.

tabindex (Optional) Value (a whole number from 0 to

Tag library descriptor

attribute (Optional) Name of an object attribute.

readonly (Optional) Whether this control is read-only

Tag library descriptor

<dmfx:docbaseattribute object="obj" attribute="keywords"

attribute (Optional) Name of the object attribute to