Dynamic list definition

<action> </action>
The primary element that defines a dynamic list. The following attributes are supported:
resourceBundle
A required attribute that specifies which resource bundle is used. For example, 
resourceBundle="catalog.ItemNLS"
formName
A required attribute that specifies the form name. A dynamic list is rendered as an HTML form. For example, 
formName="ItemFindResultsFORM"
beanClass
An optional attribute that specifies a custom bean for a simple dynamic list. For example, 
beanClass="com.ibm.commerce.tools.catalog.beans.simpleCataListBean"
helpKey
An optional attribute that defines the corresponding help key in the Tools User Interface Center Help Map file. For example, 
helpKey="MC.auction.auctionWizardPricePanel.Help"
<parameter> </parameter>
This element defines the parameters that are passed to the dynamic list. The following attributes are supported:
listsize
A required attribute that sets the maximum number of list items that display on each page. For example, 
listsize="15"
startindex
A required attribute that sets the index value of the first item in the list. For example, the following parameter defines first list item with an index of 0.
startindex="0"
resultsize
A required attribute that defines the length of the entire list. This value is not known until run time, and is dynamically calculated. However, this property must be defined as a placeholder. It does not matter what the initial value is, as it is recalculated. For example, 
resultsize="0"
orderby
An optional attribute that identifies the column by which the table is sorted. For example, 
orderby="name"
itemName
An optional attribute available as a user-defined parameter.
<scrollcontrol> </scrollcontrol>
This element defines the scroll control frame. The following attributes are supported:
title
An optional attribute that defines the page title. For example, 
title="Products"
display
A required element that determines whether the scroll control frame is displayed. For example, 
display="true"
<controlpanel> </controlpanel>
This element defines the control panel. The following attributes are supported:
display
A required element that determines whether the control panel is displayed. For example, 
display="true"
<button> </button>
This element defines the button frame. The button element contains <menu> elements.
<menu> </menu>
This element defines a button. The following attributes are supported:
name
A required attribute that specifies a name for the button. For example, 
name="New"
action
A required attribute that defines the action that is performed when the button is clicked. For example, 
action="Action()"
users
A required attribute that defines the access control for the button. The value must be a space delimited list of the roles that are permitted to perform the action that is associated with the button. For WebSphere Commerce Accelerator, these names are predefined in WC_profiledir/xml/tools/common/Roles.xml, and match the ID column in the ROLE database table. For example, 
users="makMgr merMgr merchant siteAdmin"
selection
An optional attribute that defines how selected items in the dynamic list affect the button. Permitted values include "single", "multiple", or "none". These values specify that the button is enabled when one of the following conditions occur:
  • Only one item is selected
  • One or more items are selected
  • No items are selected
If one or more items are selected, the action that is associated with the button is performed on the selected items. For example, 
selection="multiple"
component
An optional attribute that sets the component of this button. For example, 

component="CSRComponent"
<view> </view>
This element defines an optional view filter that is contained in a drop-down list in the control panel. The following attributes are supported:
name
A required attribute that specifies a name for the list item. For example, 
name="newList"
action
An optional attribute that specifies the action that is performed when this view filter is selected. For example, 
action="Action()"
<jsFile> </jsFile>
Specifies a JavaScript file to be included in the dynamic list. Files that are defined here are included in the parent frame. Thus, access to these functions requires that the prefix parent. to be added to function calls to scope them to the parent frame. The following attribute is supported:
src
A required attribute that specifies the location of the JavaScript file. For example, 
src="/wcs/javascript/tools/common/DateUtil.js"
Example
The following example defines a dynamic list, which contains these components:
  • buttons.
  • view filters available for selection in the scroll control frame.
  • a resource bundle for the national language text.
  • a title that is displayed in the title area (the title is a key that maps to the resource bundle).
  • a help key for the base, buttons, and scroll control frames.
Each view tag added is put into the view filter drop-down list for filtering different types of contents.

<?xml version="1.0" encoding="UTF-8" ?>
<action resourceBundle="campaigns.campaignsRB" formName="initiativeForm" helpKey="MC.campaigns.InitiativeList.Help">
 
<parameter listsize="22" startindex="0" endindex="0" orderby="name" state="AllList" />
<scrollcontrol title="initiativeListTitle" display="true" />
<controlpanel display="true" />
<button>
   <menu name="new" action="basefrm.newInitiative()" />
   <menu name="copy" action="basefrm.copyInitiative()" selection="single" />
   <menu name="delete" action="basefrm.deleteInitiative()" selection="multiple" />
   <menu name="properties" action="basefrm.initiativeProperties()" selection="single" />
   <menu name="resume" action="basefrm.resumeInitiative()" selection="multiple" />
   <menu name="suspend" action="basefrm.suspendInitiative()" selection="multiple" />
   <menu name="statistics" action="basefrm.initiativeStatistics()" selection="single" />
   <menu name="reports" component="CommerceAnalyzer" action="basefrm.initiativeReports()" />
</button>
 
<view name="AllList" action="top.setContent(basefrm.getListTitle(), 
   '/webapp/WCS/tools/servlet/NewDynamicListView?state=AllList&amp;ActionXMLFile=campaigns.InitiativeList
   &amp;cmd=CampaignInitiativeListView', false)" />
<view name="ActiveList" action="top.setContent(basefrm.getListTitle(), 
   '/webapp/WCS/tools/servlet/NewDynamicListView?state=ActiveList&amp;ActionXMLFile=campaigns.InitiativeList
   &amp;cmd=CampaignInitiativeListView', false)" />
<view name="SuspendList" action="top.setContent(basefrm.getListTitle(), 
   '/webapp/WCS/tools/servlet/NewDynamicListView?state=SuspendList&amp;ActionXMLFile=campaigns.InitiativeList&amp;
   &amp;cmd=CampaignInitiativeListView', false)" />
 
</action>