Dynamic Tree Portlet

Portlet Title	Dynamic Tree
Portlet Name	wm_tree
Portlet File Name	wm_tree.pdp
Top-level Folder	system
JSR168 Portlet?	No
Alias	portlet.tree
Default Instances of the portlet	None

System. Page developers using My webMethods Server version 6.x can use this portlet to display data in a tree. For My webMethods Server version 7.x and later, use the Tree controls that the webMethods CAF framework provides.

Page developers can embed the Dynamic Tree portlet into a custom portlet using the <portlet:portlet> JSP tag, and then configure the datasource of the data to display in the tree.

Alternatively, page developers can publish the Dynamic Tree portlet as a standalone portlet and configure it to use My webMethods Server commands or wiring to provide the data to display.

If a page developer specifies more than one data property, the order of precedence is described in the following table:

Data Property	Precedence
command	Overrides all other properties.
sliceCommand	Overrides listCommand, slice, and list.
listCommand	Overrides slice and list.
slice	Overrides list.
list	No override applies.

Identifies unsorted data to display in the tree. Specify the data using a list (java.util.List), array, comma-separated values (CSV) string, or XML Document Object Model (DOM) node.

To identify the data to display in the tree, you should specify this List (list) property, the List Command (listCommand) property, the Slice (slice) property, or the Slice Command (sliceCommand) property. If none of these properties have values, the tree will be empty.

Identifies unsorted data to display in the tree. Specify a My webMethods Server command to invoke to produce the data to display. When you use this property, you can also specify:

Resource (resource) property to identify a My webMethods Server resource against which to execute the command

To identify the data to display in the tree, you should specify this List Command (listCommand) property, the List (list) property, the Slice (slice) property, or the Slice Command (sliceCommand) property. If none of these properties have values, the tree will be empty.

Identifies the sorted data slice to display in the tree. Specify the data using a list (java.util.List), array, comma-separated values (CSV) string, or XML Document Object Model (DOM) node.

To identify the data to display in the tree, you should specify this u property, the List (list) property, the Slice (slice) property, or the Slice Command (sliceCommand) property. If none of these properties have values, the tree will be empty.

Identifies the sorted data slice to display in the tree. Specify a My webMethods Server command to invoke to produce the data to display. When you use this property, you can also specify:

Resource (resource) property to identify a My webMethods Server resource against which to execute the command

To identify the data to display in the tree, you should specify this Slice Command (sliceCommand) property, the List (list) property, the List Command (listCommand) property, or the Slice (slice) property. If none of these properties have values, the tree will be empty.

Identifies the My webMethods Server resource against which to execute the command specified in the List Command (listCommand) or Slice Command (sliceCommand) property. Specify the thingID or alias of the resource.

If you specify the Portlet (portlet) property, it is used instead of this property. If neither this property nor the Portlet (portlet) property has a value, the List Command or Slice Command is invoked without a specific resource.

This property is ignored if you do not specify the List Command (listCommand) or Slice Command (sliceCommand) property.

Identifies the portlet to use for paging and sorting controls when the Dynamic Tree portlet is used inside another legacy portlet. Specify the thingID or alias of the portlet. If the property has no value, it defaults to this portlet's thingID.

Identifies parameters to use with the command specified in the List Command (listCommand) or Slice Command (sliceCommand) property. Specify the parameters in the form of URL parameters, for example, paramOne=valueOne&paramTwo=valueTwo. If this property has no value, the command is executed with no additional parameters.

This property is ignored if you do not specify the List Command (listCommand) or Slice Command (sliceCommand) property.

Defines the column headers to use for the columns in the tree. Specify a comma-separated list of titles. For example, for a tree with four columns you might specify:

Defines the sort keys to use for each column of the tree. A sort key is the property to use to sort the column. Specify a comma-separated list of sort keys. If you do not specify a sort key for a column, that column is not sortable. For example, for a tree with four columns you might specify the following where the third column is not sortable:

Defines the values to specify in each column. Specify a comma-separated list of the properties to display in each column. For example, for a tree with four columns you might specify:

Defines how to link the data displayed in each column of the tree. Specify a comma-separated list of links. If you do not specify a link for a column, the data in that column is displayed without a link. For example, for a tree with four columns you might specify the following where only the first and second columns are linked:

http://example.com/items?id={ID}, http://example.com/categories?cat={category}, ,

Defines the tooltips for each column's value. Specify a comma-separated list of text to use for tooltips. For example, for a tree with four columns you might specify the following where only the second and third columns have tooltips:

Defines the alignment to use for each column. Specify a comma-separated list of alignment values. For alignment values, you can specify the following: left, right, centered, or specify nothing if you want to use the default value. The default alignment value is left. For example, for a tree with four columns you might specify the following:

If the property has no value, the columns use default alignment value: left.

Defines the width of each column. Specify a comma-separated list of widths using either a percentage of the table or pixel value. For example, for a tree with four columns you might specify:

If the property has no value, column widths are determined by the client browser, based on the amount of content in each column.

Defines whether to wrap the data in each column. Specify a comma-separated list of wrap values. For wrap values:

Identifies the unique identifier to use for a row. Specify a row property. For example, to use a row's ID property as the unique identifier, specify {ID}. If the property has no value, the tree is displayed as a flat list. This property is required, along with the Child References (childIDRefs) and Parent Reference (parentIDRef) properties to establish the tree hierarchy.

Defines how to establish child rows. Specify a row property that lists the IDs of the children for a row. The list must be either a comma-separated or whitespace-separated list of row IDs. For example to use a row's childIds property, specify {childIds}.

One of the Child References (childIDRefs), Parent Reference (parentIDRef), Children (children), or Parent (parent) properties must be specified in order to establish the tree hierarchy. Otherwise, the tree will be displayed as a flat list of rows.

Defines how to establish parent rows. Specify a row property that contains the ID of the row's parent. For example, to use a row's parentId property, specify {parentId}.

Defines the children for a row. Specify a row property that contains the children of the row (as a list, array, or XML Document Object Model (DOM) node list of child rows). For example, to use a row's children property, specify {children}.

Defines the parent for a row. Specify a row property that contains the parent of the row. For example, to use a row's parent property, specify {parent}.

Defines how to select a row. Specify a row property to use for a selection key. For example, to select a row using its ID property, specify {ID}. If the property has no value, the rows of the tree will not be selectable. A row is selected if its property value matches the value in the Selection (selection) property

Identifies the values to use for selecting tree rows. Specify a list of selection values. If the property has no value, no table rows are selected by default.

For example, if you specify {ID} for Selected (selected) and 1,3,5 for Selection (selection), the rows with ID property value of 1, 3, or 5 are selected.

Indicates whether end users can select multiple rows in the tree at one time. Specify one of the following:

Indicates whether to persist the open state when an end user re-sorts or submits the form containing the tree. Specify one of the following:

Defines how to determine whether to consider a row as open. Specify a row property. How the portlet uses the row property you specify depends on the value of the Store Opened State (storeOpenedState) property:

When Store Opened State (storeOpenedState) is true indicating to persist the row open state:

A row is considered open if the value of the row property you specify for Is Open (open) matches a value in the Opened (opened) property. For example, to use the ID property by specifying {ID} for this property, a row is open if its ID property matches a value that you specify for the Opened (opened) property.

If the Opened (opened) property has no value, the opened state will not be stored.

When Store Opened State (storeOpenedState) is false indicating to not persist the row open state:

A row is considered open if the value of the property you specify for Is Open (open) evaluates to true. For example, to use the open property by specifying {open}, a row is open if the value of its open property is true.

If the Opened (opened) property has no value, no rows will be displayed initially as open.

Defines the rows to open by default when the Store Opened State (storeOpenedState) property is true. This property is ignored when the Store Opened State (storeOpenedState) property is false.

Specify a list of opened row keys. For example, if you specify {ID} for Is Open (open) and 1,3,5 for Opened (opened), the rows with ID property value of 1, 3, or 5 are initially displayed as opened.

If the property has no value, rows will only be opened if the Store Opened State (storeOpenedState) property is true and there are open row in the saved state.

Defines how to sort the tree data. Specify the row property on which to sort. For example, to sort the tree by the ID property, specify {ID}. If the property has no value, the tree data is not sorted.

Defines the order in which to sort the tree data. Specify one of the following:

Defines the query string that the tree's datasource should use to generate the tree data. The value you specify depends on the datasource. If the property has no value, a query string is not used. Note that most datasources do not require or use a query string.

Defines the namespace to use for the paging cookie and/or paging links. Specify an arbitrary string to identify the namespace. If the property has no value, a special namespace is not used.

Defines the display style for the tree. Specify one of the following:

standard – Default. Displays the table in the standard My webMethods Server table style.

condensed – Displays the table slightly condensed, depending on the skin that is used.

Indicates whether to display column headers. Specify one of the following:

Indicates whether to display the total number of selected rows in the tree. Specify one of the following:

Indicates whether to display an empty message in the tree contents when there is no tree data to display. Specify one of the following:

true – Default. Display an empty message when there is no tree data to display.

false – Display nothing in the tree contents when there is no tree data to display.

The default empty message is "Empty". If you want to display alternative text, use the emptyMessage property.

Identifies the column of the tree in which to display open and close controls. Specify the zero-based index number of the column. The default is 0, indicating to display the open and close controls in the first column.

Identifies alternate values to use for selecting tree rows. Specify a list of selection values.

If you specify a value for this property, for example, "mySelectionProperty", the portlet uses the property with the specified name to determine the selected rows instead of the Selection (selection) property. If the property has no value, the Selection (selection) property is used.

Identifies the row property to use to consider a row open instead of the value of the Opened (opened) property. Specify the name of the property. If the property has no value, the Opened (opened) property is used.

Identifies a paging cookie to use instead of the values in the Sort Key (sort), Sort Order (order), and Query String (queryString) properties. Specify the name of the paging cookie.

If the property has no value, a paging cookie is automatically generated and populated with the values specified in the Sort Key (sort), Sort Order (order), and Query String (queryString) properties.

Defines the empty message. Specify the text to display in the tree contents when there is no table data to display. The portlet uses the emptyMessage when the Show Empty (showEmpty) property is true. If the emptyMessage property has no value, the empty message defaults to Empty.