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

The visual model definition in the monitor model can optionally associate a diagram representation with each monitoring context and KPI context. This diagram is displayed in the dashboards in the Diagram portlet. You can use the visual model to attach a Scalable Vector Graphics (SVG) diagram to the context and specify how the diagram is annotated based on the values of key performance indicators (KPIs) and metrics at run time.

Diagrams can be customized in the following ways:

• By setting a text value somewhere in the diagram
• By changing the fill or outline color associated with a set of SVG shapes
• By showing or hiding a set of diagram elements
• By associating a shape with a context ID, so that inter-diagram navigation can be used

Each type of customization can be conditionally applied based on the values of metrics, counters, or stopwatches in the context with which the visualization is associated. KPI values can also be referenced in these conditions. For visual model action conditions and the textValue expressions for SetTextType, use an XML Path Language (XPath) 2.0 expression as specified in Expression support.

In the expressions, references can be made to metrics, counters, and stopwatches in monitoring contexts, and to KPI values in KPI contexts.

The following expression returns the sum of two numeric metrics with a counter:

MyFirstMetric + MySecondMetric + MyCounter

The sections that follow describe each element in the visual model portion of the monitor model XML schema.

• ActionsType
  ActionsType contains the set of actions that can be performed on the visualization. Six actions are supported: setColor, setText, hideShapes, setDiagramLink, sendHumanTaskNotification, and sendNotification.
• ActionType
  ActionType defines the basic characteristics of any action that can be used to customize a diagram representation of a context at run time.
• HideShapesType
  HideShapesType defines the action used to specify that a set of Scalable Vector Graphics (SVG) elements be hidden at run time based on some condition.
• PositionType
  PositionType defines the location at which the text should be placed in the setText action by specifying absolute X and Y coordinates within the diagram.
• PropertyNameValueType
  PropertyNameValueType defines the attribute name and value pairs that form the notification that is sent to widgets when a user clicks a shapeSet in the Scalable Vector Graphics (SVG) diagram.
• SetColorType
  SetColorType defines the action used to set the outline or fill color of the Scalable Vector Graphics (SVG) elements in a referenced ShapeSet. The outline and fill color can be specified independently of each other. Additionally, a condition can be used to specify when the SetColor action should be applied, based on the values of metrics, counters, stopwatches, and KPIs.
• SetDiagramLinkType
  SetDiagramLinkType defines the action that allows a user to navigate between diagrams at run time using mouse clicks. This action specifies a target context and a shape set that, when clicked, causes the diagram to be replaced with the diagram associated with the target context.
• SetSelectionType
  SetSelectionType defines the action used to send notifications to widgets when a user clicks a shapeSet in the Scalable Vector Graphics (SVG) diagram.
• 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.
• ShapesListType
  ShapesListType limits the list of shape IDs to make sure that at least one ID is present in the list.
• ShapeSetRefType
  ShapeSetRefType defines an element that can refer to a shapeSet that is defined in the current visualization. The value of the ref attribute is the ID attribute value of the shapeSet intended to be referenced. Defining the ref attribute enables an action to specify the Scalable Vector Graphics (SVG) shapes upon which it should act.
• ShapeSetsType
  ShapeSetsType contains zero or more individual shapeSets.
• ShapeSetType
  ShapeSetType contains a single list of shape IDs.
• SvgDocumentType
  SvgDocumentType is the container element for the reference to the Scalable Vector Graphics (SVG) diagram. The SVG diagram is included as an import statement that points to an SVG diagram file.
• VisualizationType
  VisualizationType is used to relate a given context (either a monitoring context or a KPI context) to a set of shapeSets, actions, and a particular Scalable Vector Graphics (SVG) file.
• VisualModelNamedElementType
  VisualModelNamedElementType is the base type of VisualModelType. It restricts the id attribute to a fixed value of VM that is required for path references.
• VisualModelType
  VisualModelType is used to contain visualization information, which is used by the dashboard to display a visual representation of the associated contexts.

XML schema (monitor.xsd) description