{{property}}
The {{property}} tag is de-referenced by StarTeam Notification Agent using the property value from the corresponding item object. For example,
{{property name="Status"}}
is converted to the current value of the Status property. The name is the internal identifier for the property, not the display name.
The tag has a number of style attributes that allow for emphasizing the value text if the value has changed from the previous
revision of the item. For example, if the
Status property changed from
New
to
Open
, and causes a notification to occur, the tag can produce the following output in the notification message:
Status: <FONT STYLE="color:blue;font-weight:bold"> Open </FONT>Note that style and modified-style must contain valid HTML style attributes, or they will not render properly. StarTeam Notification Agent does not perform any syntax checks on the values of the style attributes.
Attributes
name | Optional: no Permitted Values: Item-specific property identifiers, or @primary-descriptor, @workflow-property, @responsibility-property Comment: This is the property name as recognized by the application. @primary-descriptor is a symbolic reference to a primary descriptor property of a given application type. For a file, the primary descriptor is its name. For a change request, requirement, task, or topic, the primary descriptor is its number. |
style | Optional: yes Permitted Values: text Comment: This is the default style. This attribute is only applicable in the HTML part of the message. In the plain text part, it is ignored. |
modified-style | Optional: yes Permitted Values: text Comment: This style is used if the property value has changed from the previous revision of the item. This attribute is only applicable in the HTML part of the message. In the plain text part, it is ignored. |
modified-prefix | Optional: yes Permitted Values: text Comment: This is the text that is placed in front of the de-referenced property value. This attribute impacts output in both the plain text and HTML formats of the message. 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:
Status: {{property name="Status" style= "color:black" modified-style= "color:blue;font-weight:bold"}} <B>
will change at run-time to:
Status: <FONT STYLE="color:black"> Open </FONT>
if the Status value did not change. If it did change, the tag will produce:
Status: <FONT STYLE="color:blue;font-weight:bold"> Open </FONT>
Similarly, if you use:
Status: {{property name="Status" modified-prefix= "***Modified*** "}}
the output will be:
Status: Open
for an unchanged Status property and:
Status: ***Modified*** Open
for a changed Status property.