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

Monitor models for IBM Business Monitor are in XML format with an associated XML schema named monitor.xsd. The monitor.xsd schema includes simple and complex types.

• AggregationType
  AggregationType is an enumeration used to restrict the functions that can be applied to a measure or KPI.
• AssignmentListSpecificationType
  AssignmentListSpecificationType contains a collection of AssignmentSpecificationTypes, each of which is used to set the value of a single field in an outbound event.
• AssignmentSpecificationType
  AssignmentSpecificationType is used by an AssignmentListSpecificationType to specify individual values for each attribute of an outbound event.
• BaseMetricType
  BaseMetricType is an abstract complex type used to hold the attribute and element definitions that are common across counters, stopwatches, and metrics.
• ChartType
  ChartType is the enumeration of possible values for the chartType attribute of ReportType.
• ContextType
  ContextType is an abstract complex type that holds the common elements for both monitoring contexts and KPI contexts.
• CounterType
  CounterType describes a counter that is part of a monitoring context. A counter holds an integer value that can be incremented, decremented, or set to zero by triggers. The type must always be set to the integer type defined in the XML Schema Datatypes specification.
• CubeType
  CubeType describes the dimensions and measures that define a cube. Each cube maps to one monitoring context.
• DimensionalModelNamedElementType
  DimensionalModelNamedElementType is the base type of DimensionalModelType. It restricts the ID attribute to a fixed value of DMM that is required for path references.
• DimensionalModelType
  DimensionalModelType contains the cube definitions that are available for the monitor model. The dimensional model can contain the cube definitions themselves or can contain an import element that identifies cubes contained in another location.
• DateTimeDimensionFixedPeriodType
  DateTimeDimensionFixedPeriodType contains the settings required to specify a fixed period type for a key performance indicator (KPI).

  For example, the DateTimeDimensionFixedPeriodType element would be used if the value for the KPI calculation was to be taken from Jan. 1, 2006 to Feb. 5, 2006.

• DateTimeDimensionRepeatingPeriodType
  DateTimeDimensionRepeatingPeriodType contains the settings required to specify a repeating period type for a key performance indicator (KPI).

  For example, DateTimeDimensionRepeatingPeriodType would be used if the value for the KPI calculation was to be taken from the last 10 minutes, hours, days, months, or years. The calculation can include the minute, hour, day, month, or year in progress, depending on the setting of the periodBasis attribute.

• DateTimeDimensionRollingPeriodType
  DateTimeDimensionRollingPeriodType contains the settings required to specify a rolling period type for a key performance indicator (KPI). The time period can be minutes, hours, days, months, or years.

  For example, DateTimeDimensionRollingPeriodType would be used if the value for the KPI calculation was to be taken from the last 10 days or last 30 days.

• DescribableElementType
  DescribableElementType is an abstract class used to describe an element.
• DimensionAttributeType
  DimensionAttributeType identifies the metrics, counters, and stopwatches that make up the hierarchical levels of a dimension. The dimension becomes a set of dimension tables in the cube that is created for the target monitoring context. DimensionAttributeType elements are used in the DimensionType element.
• DimensionType
  DimensionType describes the dimensions that make up a cube. A dimension is used to query a subset of data, such as querying by a certain geography.
• EndNamedElementType
  EndNamedElementType is the base type of EndValueNamedElementType. It restricts the ID attribute for end range values to a fixed ID of endValue that is required for referencing the end of a range.
• EndValueNamedElementType
  EndValueNamedElementType is the type used for all range end values. Use EndValueNamedElementType to specify a decimal number in the value attribute for the end value of a particular range.
• EventDeliveryOptionMultipleMatchesType
  EventDeliveryOptionMultipleMatchesType is an enumeration that defines the valid event delivery options for an inbound event when multiple correlation matches are found. Valid values are ignore, raiseException, deliverToAny, and deliverToAll. These values are used in the InboundEventType element.
• EventDeliveryOptionNoMatchesType
  EventDeliveryOptionNoMatchesType is an enumeration that defines the valid event delivery options for an inbound event when no correlation matches are found. The values are ignore, raiseException, createNewContext, and retry. These values are used in the InboundEventType element.
• EventDeliveryOptionOneMatchType
  EventDeliveryOptionOneMatchType is an enumeration that defines the valid event delivery options for an inbound event when one correlation match is found. Valid values are ignore, raiseException, and deliverEvent. These values are used in the InboundEventType element.
• EventModelType
  EventModelType groups the events used in the monitor model.
• EventModelNamedElementType
  EventModelNamedElementType is the base type of EventModelType. It restricts theID attribute to a fixed value of EM that is required for path references.
• EventPartType
  EventPartType is used to specify the structure of a part of an event. A single event definition can have different event parts that are defined by different XML schemas. All the event parts, together with the Common Base Event definition if one is provided, describe the structure of the entire event.
• ExpressionSpecificationType
  ExpressionSpecificationType describes how metrics, filters, and correlation expressions are evaluated at run time.
• ImportType
  ImportType describes the location of an external file that contains information that the monitor model requires. The file is either an event definition file or a Scalable Vector Graphics (SVG) file.
• InboundEventType
  InboundEventType identities the inbound events in which this monitoringContext is interested.
• KPIAggregatedDefinitionType
  KPIAggregatedDefinitionType holds the definition of a KPI that is based on an aggregated metric. It includes the metric, aggregation function, time filter, and data filter. KPIAggregatedDefinitionType is used in KPIType.
• KPICalculatedDefinitionType
  KPICalculatedDefinitionType holds the definition of a KPI that is based on an expression that uses other KPIs. KPICalculatedDefinitionType is used in KPIType.
• KPIContextType
  KPIContextType defines a key performance indicator (KPI) context, which contains all the elements defined by the abstract ContextType complex type from which KpiContext and KPIType elements extend.
• KPICurrencyType
  The KPICurrencyType element describes a three-letter ISO 4217 currency code.
• KPIDateTimeMetricFilterRefType
  KPIDateTimeMetricFilterRefType specifies the time period type to use when calculating a key performance indicator (KPI) value. Details on the meanings of each of the period types can be found in the individual type descriptions. Only one of the given period types can be specified at a time. KPIDateTimeMetricFilterRefType is used in KPIAggregatedDefinitionType.
• KPIMetricFilterOperatorType
  KPIMetricFilterOperatorType specifies the operator for filtering a KPI based on the value of a metric. KPIMetricFilterOperatorType is used in KPIMetricFilterRefType.
• KPIMetricFilterRefType
  KPIMetricFilterRefType specifies how to filter a KPI based on the value of a metric. KPIMetricFilterRefType is used in KPIAggregatedDefinitionType.
• KPIModelNamedElementType
  KPIModelNamedElementType is the base type of KPIModelType. It restricts the ID attribute to a fixed value of KM that is required for path references.
• KPIModelType
  KPIModelType contains key performance indicator (KPI) contexts, which in turn contain KPI definitions, inbound events, outbound events, and triggers.
• KPIRangeColorType
  The KPIRangeColorType element describes a color using a hexadecimal notation for the combination of Red, Green, and Blue (RGB) color values.
• KPIType
  KPIType holds the key performance indicator (KPI) data for the KPI, such as targets and thresholds, as well as the definition that describes how the KPI is calculated using either an aggregated metric or a calculation using other KPIs. KPIType is used in KPIContextType.
• MapType
  MapTypes are contained in metrics and outbound events and determine how and when each of these are updated and set.
• MeasureType
  MeasureType identifies a metric, counter, or stopwatch that is to be used as a measure within a cube. MeasureType also identifies the function that can be used against the metric, counter, or stopwatch. The functions are enumerated by the AggregationType.
• MetricType
  MetricType describes a metric in a monitoringContext.
• MonitoringContextType
  MonitoringContextType represents the events and data that are being monitored.
• MonitorDetailsModelNamedElementType
  MonitorDetailsModelNamedElementType is the base type of MonitorDetailsModelType. It restricts the ID attribute to a fixed value of MDM that is required for path references.
• MonitorDetailsModelType
  MonitorDetailsModelType contains monitoringContexts and provides the structure to enable the observation of a business entity. Nested monitoring details models are not supported.
• MonitorType
  MonitorType is the type of the root document element. It contains the various models that are required to perform monitoring activities.
• NamedElementType
  NamedElementType is an abstract base complex type that holds the ID and displayName fields.
• NameType
  The NameType element restricts strings to 256 characters.
• OutboundEventType
  OutbountEventType describes an event that is emitted from a monitoring context. Outbound events are generated when triggers that are specified in the map of the outbound event fire. If triggers are identified in multiple maps in the outbound event, multiple outbound events will be generated. If the same trigger is identified in multiple maps, multiple outbound events will fire. One outbound event will fire for each map that is run (provided the outbound event filter evaluates to true). If a map for an outbound event has no trigger, it will never run, even if the elements it refers to are updated.
• PeriodBasisType
  PeriodBasisType holds the enumeration of possible values used in the TimeDimensionRepeatingPeriodType and TimeDimensionRollingPeriodType constructs. The period basis setting determines whether the current time period is included in the calculation or whether the calculation only includes values up to the most recently completed time period.
• RangeType
  RangeType contains the individual range for the enclosing key performance indicator (KPI). This element defines the name, ID, description, start value, end value, and color for the range.
• RangeTypeType
  RangeTypeType is the enumeration of possible values for the RangeType attribute of KPIType.
• ReportType
  ReportType identifies the type of chart to use when you are authoring IBM Cognos Business Intelligence reports.
• ReferenceType
  ReferenceType defines a reference to an existing element in the model.
• RepeatingPeriodTypeType
  RepeatingPeriodTypeType is an enumeration used to select whether the repeating period for a KPI is daily, monthly, quarterly, or yearly. These values are used in the DateTimeDimensionRepeatingPeriodType element.
• RollingPeriodTypeType
  RollingPeriodTypeType is an enumeration used to select whether the rolling period for a KPI is minutes, hours, days, months, or years. These values are used in the DateTimeDimensionRollingPeriodType element.
• StartNamedElementType
  StartNamedElementType is the base type of StartValueNamedElementType. It restricts the ID attribute for start range values to a fixed ID of startValue that is required for referencing the start of a range.
• StartValueNamedElementType
  StartValueNamedElementType is the type used for all range start values. Use StartValueNamedElementType to specify a decimal number in the value attribute for the start value of a particular range.
• StopwatchType
  StopwatchType defines a stopwatch used by a monitoringContext. A stopwatch contains an elapsed time, such as a duration, and can be started, stopped, and reset by triggers. The type must always be set to the duration type defined in the XML Schema Datatypes specification.
• TargetValueType
  TargetValueType provides the target value for a key performance indicator (KPI). The target value of the KPI must always be a decimal value, even if the KPI itself is of type Duration. In that case, the decimal value is interpreted as a number of milliseconds.
• TimeIntervalsType
  TimeIntervalsType defines a duration based on a unit of time for use with triggers that fire at regularly scheduled time intervals.
• TriggerType
  TriggerType describes a trigger in a monitoringContext.
• ValueSpecificationType
  ValueSpecificationType is an abstract class used where either an AssignmentListSpecification or an ExpressionSpecificationType can be used. An AssignmentListSpecification is used to set multiple output fields and an ExpressionSpecificationType is used to set a single output field.
• VersionAggregationType
  VersionAggregationType is an enumeration used to select all versions of the model or only the most recent version of the model. These values are used in the KPIAggregatedDefinitionType element.
• XPathFunctionsType
  XPathFunctionsType associates a namespace with one or more classes containing functions that you have defined.
• 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.

Monitor XML schema definition (monitor.xsd)