My webMethods Server 10.7 | My webMethods Server Webhelp | My webMethods Server Portlet Reference | Legacy Portlets and Backwards Compatibility | Dynamic Table Portlet
 
Dynamic Table Portlet
Portlet Title
Dynamic Table
Portlet Name
wm_table
Portlet File Name
wm_table.pdp
Top-level Folder
system
JSR168 Portlet?
No
Alias
portlet.table
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 table. For My webMethods Server version 7.x and later, use the Table controls that the webMethods CAF framework provides.
Page developers can embed the Dynamic Table portlet into a custom portlet using the <portlet:portlet> JSP tag, and then configure the datasource of the data to display in the table.
Alternatively, page developers can publish the Dynamic Table 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 as listed 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.
Properties
List (list)
Identifies unsorted, unpaged data to display in the table. 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 table, 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 table will be empty.
List Command (listCommand)
Identifies unsorted, unpaged data to display in the table. 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
*Parameters (parameters) property to specify properties for the command
To identify the data to display in the table, 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 table will be empty.
Slice (slice)
Identifies the sorted and paged data slice to display in the table. 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 table, you should specify this Slice (slice) property, the List Command (listCommand) property, or the Slice Command (sliceCommand) property. If none of these properties have values, the table will be empty.
Slice Command (sliceCommand)
Identifies sorted and paged data slice to display in the table. 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
*Parameters (parameters) property to specify properties for the command
To identify the data to display in the table, 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 table will be empty.
Resource (resource)
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.
Portlet (portlet)
Identifies the portlet to use for paging and sorting controls when the Dynamic Table 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.
Parameters (parameters)
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.
Titles (titles)
Defines the titles, or headers, to use for the columns in the table. Specify a comma-separated list of titles. For example, for a table with four columns you might specify:
ID, Category, Description, Priority
If the property has no value, the table will not have column headers.
Keys (keys)
Defines the sort keys to use for each column of the table. A sort key is a property to use for sorting. 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 table with four columns you might specify the following where the third column is not sortable:
{ID}, {category}, , {priority}
If the property has no value, none of the columns will be sortable.
Values (values)
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 table with four columns you might specify:
{ID}, {category}, {description}, {priority}
If the property has no value, the columns will be empty.
Links (links)
Defines how to link the data displayed in each column of the table. 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 table 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}, ,
If the property has no value, none of the column values will be linked.
Tooltips (tooltips>)
Defines the tooltips for each column's value. Specify a comma-separated list of text to use for tooltips. For example, for a table with four columns you might specify the following where only the second and third columns have tooltips:
, {categoryDescription}, , {priorityDescription}
If the property has no value, none of the column will have tooltips.
Alignments (alignments)
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 table with four columns you might specify the following:
center, left, left, center
If the property has no value, all columns use default alignment value: left.
Widths (widths)
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 table with four columns you might specify:
5%, 30%, 50%, 15%
If the property has no value, column widths are determined by the client browser, based on the amount of content in each column.
Wrappings (wrappings)
Defines whether to wrap the data in each column. Specify a comma-separated list of wrap values. For wrap values:
*If you do not want the data to wrap specify, nowrap.
*If you want the data to wrap, specify nothing.
For example, for a table with four columns you might specify:
nowrap, nowrap, , nowrap
If the property has no value, all columns will wrap if necessary.
Selected (selected)
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 table will not be selectable. A row is selected if its property value matches a value in the Selection (selection) property.
Selection (selection)
Identifies the values to use for selecting table 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.
Allow Selection (allowSelection)
Indicates whether end users can select rows in the table. Specify one of the following:
*true – Users can select one row at a time.
*false – Default. Rows are not selectable.
Allow Multiple Selection (allowMultipleSelection)
Indicates whether end users can select multiple rows in the table at one time. Specify one of the following:
*true – Users can select multiple rows at one time.
*false – Default. Users cannot select multiple rows at one time.
The order of precedence between allowMultipleSelection and allowSelection is described in the following table:
allowMultipleSelection = false
allowMultipleSelection = true
allowSelection = false
Users cannot select any rows.
Users can select multiple rows at a time.
allowSelection = true
Users can select one row at a time.
Users can select multiple rows at a time.
Start (start)
Defines the index of the first table row to display. Specify the index number, which is one-based; that is, specify 1 to display row one of the table. If the property has no value, it defaults to 1.
Page Size (pageSize)
Defines the number of rows to display per page. Specify a whole number that is one or greater. If the property has no value, the portlet determines the number of items to display per page from the user preferences in the User Profile; the default user preference value is 10.
Sort Key (sort)
Defines how to sort the table data. Specify the row property on which to sort. For example, to sort the table by the ID property, specify {ID}. If the property has no value, the table data is not sorted.
Sort Order (order)
Defines the order in which to sort the table data. Specify one of the following:
*ascending – Default. Sorts the table in ascending order.
*descending – Sorts the table data in descending order.
Query String (queryString)
Defines the query string that the table's datasource should use to generate the table 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.
View (view)
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.
Style (style)
Defines the display style for the table. 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.
*table – Displays the table as a single HTML table.
Show Header (showHeader)
Indicates whether to display column headers. Specify one of the following:
*true – Default. Display column headers.
*false – Do not display column headers.
Show Footer (showFooter)
Indicates whether to display the paging footer for the table. Specify one of the following:
*true – Default. Display the paging footer.
*false – Do not display the paging footer.
Show Total (showTotal)
Indicates whether to display the total number of rows in the table. Specify one of the following:
*true – Default. Display the total number of rows.
*false – Do not display the total number of rows.
Show Total Selection (showTotalSelection)
Indicates whether to display the total number of selected rows in the table. Specify one of the following:
*true – Default. Display the total number of selected rows.
*false – Do not display the total number of selected rows.
Show Pages (showPages)
Indicates whether to display links to individual pages, (for example, ... 4 5 6 7 8 9 10 11 12 13 ...). Specify one of the following:
*true – Default. Display links to individual pages.
*false – Do not display links to individual pages.
Show Empty (showEmpty)
Indicates whether to display an empty message in the table contents when there is no table data to display. Specify one of the following:
*true – Default. Display an empty message when there is no table data to display.
*false – Display nothing in the table contents when there is no table data to display.
The default empty message is "Empty". If you want to display alternative text, use the emptyMessage property.
Properties that are Not Displayed in the User Interface
textTitles
Defines a set of alternate column headers to use when the table is exported. If you specify a value for this property, when the table is exported, the export uses the textTitles values in place of the column titles defined by the Titles (titles) property. Specify a comma-separated list of column titles, for example:
ID, Category, Description, Priority Number
You can use this property in conjunction with the textValues property to export a different set of columns than are normally displayed for the table.
If the property has no value, when the table is exported, the column titles defined by the Titles (titles) property are used.
textValues
Defines a set of alternate column values to use for a table export. If you specify a value for this property, when the table is exported, the values you define with the textValues property are exported rather than the values defined by the Values (values) property. Specify a comma-separated list of properties for example:
{ID}, {category}, {description}, {priority}
You can use this property in conjunction with the textTitles property to export a different set of columns than are normally displayed for the table.
If the property has no value, when the table is exported, the values defined by the Values (values) property are exported.
selectionPropertyName
Identifies alternate values to use for selecting table 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.
onchange
Identifies client-side JavaScript to invoke when an end user selects or deselects a row. Specify the name of the JavaScript onchange handler. If the property has no value, custom JavaScript is not invoked when a table row selection changes.
cookie
Identifies a paging cookie to use instead of the values in the Start (start), 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 Start (start), Sort Key (sort), Sort Order (order), and Query String (queryString) properties.
formPaging
Indicates whether to submit the form containing the table (with a void portlet-controller method) when an end user selects a paging link. Specify one of the following:
*true – Submit the form (with a void pca method) when an end user selects a paging link.
*false – Default. Use regular paging links when an end user selects a paging link.
emptyMessage
Defines the empty message. Specify the text to display in the table 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.
showExport
Indicates whether to display the Export Table button. Specify one of the following:
*true – Display the Export Table button.
*false – Do not display the Export Table button.
showPagingHeader
Indicates whether to show paging information in the table header or the table footer. Specify one of the following:
*true – Display the total number of rows, total selected rows, and the Export Table button in the table header.
*false – Default. Display the total number of rows, total selected rows, and the Export Table button in the table footer.
Note that the paging items displayed also depend on the values of the Show Total (showTotal), Show Total Selection (showTotalSelection), and showExport properties. The values of these properties must be true for the corresponding information to be displayed in the table header or table footer.
categorized
Indicates that you want to group rows into categories and defines how to categorize the rows. Specify the row property to use to categorize the table rows. All the rows that have the same value for the row property you specify will be in the same category. For example, to categorize rows by their priority property, specify {priority}. If the categorized property has no value, the portlet does not categorize rows.