IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Developing monitor models > What are monitor models? > Monitor XML schema definition (monitor.xsd) > XML schema (monitor.xsd) description > Visual model elements

SetTextType

SetTextType defines the action used to specify that user-defined text be placed somewhere in the dashboards. The text can be the dynamic result of the evaluation of an expression, meaning that metric, counter, stopwatch and KPI values can be displayed.

You can set the color of the text. You can specify the position of the text in one of two ways:

• Define a shapeSet that refers to a text element in the SVG diagram. This text element will then have its value set to the specified text when the action is taken. This is the most efficient way to use the setText action because you can use a text node that already exists in the diagram.
• Place text on the SVG diagram to specify a set position for the text using absolute X and Y coordinates.

Elements

Name	Min-max	Description
shapeSet	1 - 1	One shapeSet that defines the text SVG element to put the text into. Either the shapeSet or the textPosition element must be present to define where the text should be placed.
textPosition	1 - 1	The X and Y coordinates to use for the text position. Either the textPosition or the shapeSet element must be present to define where the text should be placed.

Attributes

Name	Required or optional	Type	Description
textValue	Required	String	The value of the text to display on the diagram. This is an XPath 2.0 expression as specified in Expression support. The return value is cast to a string and used as the value to display. If that constant string values can also be specified.
textColor	Optional	String	The color to use for the text displayed by this action. Values of this attribute must conform to the syntax specified in the W3 CSS specification (http://www.w3.org/TR/REC-CSS2/syndata.html#value-def-color). This allows for the specification of colors using various methods, such as hex values (#EEFF99), or common color constant keywords ("red")

Restrictions

• The shapeSet reference, if present, must refer to a shapeSet, and this referenced shapeSet must contain a reference to an SVG text element so that the value of the text element can be overwritten by the resolved value of the textValue attribute at run time.

• The textColor must be as specified in the W3 CSS specification, which you can find at: http://www.w3.org/TR/REC-CSS2/syndata.html#value-def-color.

• All restrictions for ActionType apply to SetTextType.

• The shapeSet reference must be in the set of ids for shapeSets in this same visualization.

• The textValue attribute expression must be valid.

• The textValue attribute expression initial context is the context referenced by the visualization context attribute.

• The textValue attribute expression scope is BaseMetrics (if any of them are in the referenced context) or KPI values.

• The textValue attribute expression must evaluate to a string value.

Schema definition

<xsd:complexType name="SetTextType">
        <xsd:complexContent>
            <xsd:extension base="mon:ActionType">
                <xsd:choice minOccurs="1" maxOccurs="1">
                    <xsd:element name="shapeSet" type="mon:ShapeSetRefType" />
                    <xsd:element name="textPosition" type="mon:PositionType" />
                </xsd:choice>
                <xsd:attribute name="textValue" type="xsd:string" 
                      use="required"/>
                <!--  See http://www.w3.org/TR/REC-CSS2/syndata.html#value-def-color
                      for description of color values -->
                <xsd:attribute name="textColor" type="xsd:string" 
                      use="optional"/>
            </xsd:extension>
        </xsd:complexContent>
</xsd:complexType>

Visual model elements