{{property-table}}

The {{property-table}} tag can be used to output a list of application properties with their corresponding labels in a two-column table.

This tag provides a number of ways to define which properties are to be included and how they are to be rendered.

Attributes

contents

Optional: no

Permitted Values: all, standard, descriptors

Comment: This defines the list of properties to be included in the table.

  • all means that all properties are included.
  • standard means that all but advanced properties are included.
  • descriptors means that only descriptor properties are included, with the primary descriptor always the first to be listed.

The property name is not the same as the display name shown by the application to the user. It is an internal identifier that is frequently the same as the display name, but is not guaranteed to be. The list of property identifiers are provided in the StarTeam SDK documentation and in the StarTeam User’s Guide. The Workflow Designer provides an easy way to insert property references (the entire property tag) into the message subject or body. Custom (user-defined) properties have the prefix “Usr_” in front of their internal identifier, for example, Usr_WorkflowStatus.

Examples

The following template excerpt defined in the message template for a Change Request:

{{property-table contents="descriptors" label-style="color:blue;font-weight:bold" modified-style="color:red;font-weight:bold"}}

will change at runtime either to the following HTML format:

<TABLE><TR><TD STYLE="color:blue;font-weight:bold">CR Number</TD><TD>242</TD></TR><TR><TD STYLE="color:blue;font-weight:bold">Synopsis</TD><TD> This is a test CR.</TD></TR></TABLE>

or to the following plain-text format:

CR Number: 242
Synopsis: This is a test CR.

The plain-text versus HTML behavior of this tag is determined by the type of the mime part it is placed in. If the tag is found inside an HTML part, it will produce HTML output. If the tag is found in a plain-text part, it will produce plain text output.

Back to top