UpdateViewlet

Description

Generates or updates a viewlet on a Rational Asset Manager community home page. A viewlet is a section of a page.

Parameters

Attribute Description Required
colspan The number of columns that this viewlet spans. Possible values are 1, 2 or 3. No. Default is 1
column The column on the home page in which to place this viewlet. Possible values are 1, 2 or 3. No. Default is 2
community The name of the community on which this viewlet is placed Yes
failOnError If false, the build continues execution when an error occurs. Otherwise, the build fails. No. Default is true.
footer Static HTML to be rendered at the bottom of the viewlet No
header Static HTML to be rendered at the top of the viewlet No
id The ID of the viewlet to update Yes
remove If true, this attribute removes the specified viewlet. No. Default is false
rowclasses A comma-separated list of CSS classes that are used for the table rows. The first row uses the first class, the second row uses the second class, and so on. When there are more rows in the table than classes in the list, the classes are reused in a looping fashion. No
server The ID of the server that connects to Rational Asset Manager Yes
tableclass A space-separated list of CSS classes that are applied to the entire table No
template A template that specifies the HTML to be applied to each row of assets. The template must include at least one <td> tag, because that tag is placed inside a <tr> tag. You can specify the following values to get information from the asset:
  • @asset.name@: Replaced by the name of the asset
  • @asset.version@: Replaced by the version of the asset
  • @asset.url@: Replaced by the URL for the asset
  • @asset.artifacts@: Replaced by the root URL for artifacts. For example, @asset.artifacts@/MyFile.txt is replaced with the URL to MyFile.txt in the asset.
  • @asset.attribute.Attribute Name@: Replaced by the value of the specified attribute. For example, @asset.attribute.Build ID@ is replaced by the value of the Build ID attribute.
  • @asset.urlartifact.URL Artifact Name@: Replaced by the URL of the specified URL artifact. For example, @asset.urlartifact.Deployed Build@ is replaced by the URL of the Deployed Build artifact.
No. Default is <td>@asset.name@ [@asset.version@]</td>
title The viewlet title, which is displayed in the section header No

Parameters specified as nested elements

search

A search must be specified. All assets that are returned from that query are listed in the viewlet.

Example

Create or update a viewlet on a community home page to display assets that are in the draft state

<updateViewlet server="ramServer" community="My Community" id="draftassets" title="Assets in draft state">
      <search query="state:(draft)" />
</updateViewlet>