XML Schema Documentation

Schema Document Properties
Global Declarations
Global Definitions
- Simple Type: x733-alarm-type

Legend

Glossary

Schema Document Properties

Target Namespace	http://xmlns.opennms.org/xsd/event
Element and Attribute Namespaces	Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations have no namespace. By default, local attribute declarations have no namespace.
Documentation	XML Schema for OpenNMS events. Version: $Id: event.xsd 11208 2008-11-10 17:15:03Z tarus $ Top-level element for OpenNMS events.

Declared Namespaces

Prefix	Namespace
Default namespace	http://www.w3.org/2001/XMLSchema
xml	http://www.w3.org/XML/1998/namespace
xsi	http://www.w3.org/2001/XMLSchema-instance
this	http://xmlns.opennms.org/xsd/event
ns2	http://www.w3.org/1999/xhtml
ns	http://www.w3.org/2001/XMLSchema
hfp	http://www.w3.org/2001/XMLSchema-hasFacetAndProperty

Schema Component Representation

...

</schema>

top

Name	alarm-data
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	This element is used for converting events into alarms.

<this:alarm-data
reduction-key="string [1]"
alarm-type=" int (value >= 1) [1]"
clear-uei="string [0..1]"
clear-key="string [0..1]"
auto-clean="boolean [0..1]"
x733-alarm-type=" this:x733-alarm-type [0..1]"
x733-probable-cause="int [0..1]"/>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

top

Element: autoacknowledge

Name	autoacknowledge
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The autoacknowledge information for the user with state controlling if event is marked acknoledged when inserted into the database

XML Instance Representation

<this:autoacknowledge
state=" string (pattern = (on|off)) [0..1]">
string
</this:autoacknowledge>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Element: autoaction

Name	autoaction
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The automatic action to occur when this event occurs with state controlling if action takes place

XML Instance Representation

<this:autoaction
state=" string (pattern = (on|off)) [0..1]">
string
</this:autoaction>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Element: correlation

Name	correlation
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The event correlation information

XML Instance Representation

<this:correlation
state=" string (pattern = (on|off)) [0..1] ?"
path=" string (pattern = (suppressDuplicates|cancellingEvent|suppressAndCancel|pathOutage)) [0..1]">

<cuei> string </cuei> [0..*] ?

<cmin> string </cmin> [0..1] ?

<cmax> string </cmax> [0..1] ?

<ctime> string </ctime> [0..1] ?

</this:correlation>

Schema Component Representation

</sequence>

</restriction>

</simpleType>

</attribute>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

top

Element: event

Name	event
Type	Locally-defined complex type
Nillable	no
Abstract	no

XML Instance Representation

<this:event
uuid="string [0..1]">

<dbid> int (value >= 1) </dbid> [0..1] ?

<dist-poller> string </dist-poller> [0..1]

<creation-time> string </creation-time> [0..1] ?

<master-station> string </master-station> [0..1] ?

<this:mask> ... </this:mask> [0..1] ?

<uei> string </uei> [0..1] ?

<source> string </source> [1]

<nodeid> long </nodeid> [0..1] ?

<time> string </time> [1] ?

<host> string </host> [0..1] ?

<interface> string </interface> [0..1] ?

<snmphost> string </snmphost> [0..1] ?

<service> string </service> [0..1] ?

<this:snmp> ... </this:snmp> [0..1] ?

<this:parms> ... </this:parms> [0..1] ?

<descr> string </descr> [0..1] ?

<this:logmsg> ... </this:logmsg> [0..1] ?

<severity> string </severity> [0..1] ?

<pathoutage> string </pathoutage> [0..1] ?

<this:correlation> ... </this:correlation> [0..1] ?

<operinstruct> string </operinstruct> [0..1] ?

<this:autoaction> ... </this:autoaction> [0..*] ?

<this:operaction> ... </this:operaction> [0..*] ?

<this:autoacknowledge> ... </this:autoacknowledge> [0..1] ?

<loggroup> string </loggroup> [0..*] ?

<this:tticket> ... </this:tticket> [0..1] ?

<this:forward> ... </this:forward> [0..*] ?

<this:script> ... </this:script> [0..*] ?

<ifIndex> string </ifIndex> [0..1] ?

<ifAlias> string </ifAlias> [0..1] ?

<mouseovertext> string </mouseovertext> [0..1] ?

<this:alarm-data> ... </this:alarm-data> [0..1] ?

</this:event>

Schema Component Representation

</restriction>

</simpleType>

</element>

</sequence>

</complexType>

</element>

top

Element: event-receipt

Name	event-receipt
Type	Locally-defined complex type
Nillable	no
Abstract	no

XML Instance Representation

<this:event-receipt>

<uuid> string </uuid> [1..*]

</this:event-receipt>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: events

Name	events
Type	Locally-defined complex type
Nillable	no
Abstract	no

XML Instance Representation

<this:events>

<this:event> ... </this:event> [1..*]

</this:events>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: forward

Name	forward
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The forwarding information for this event - state determines if event is forwarded, mechanism determines how event is forwarded .

XML Instance Representation

<this:forward
state=" string (pattern = (on|off)) [0..1]"
mechanism=" string (pattern = (snmpudp|snmptcp|xmltcp|xmludp)) [0..1]">
string
</this:forward>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Element: header

Name	header
Type	Locally-defined complex type
Nillable	no
Abstract	no

XML Instance Representation

<this:header>

<ver> string </ver> [1]

<dpName> string </dpName> [1]

<created> string </created> [1] ?

<mstation> string </mstation> [1]

</this:header>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: log

Name	log
Type	Locally-defined complex type
Nillable	no
Abstract	no

XML Instance Representation

<this:log>

<this:header> ... </this:header> [0..1]

<this:events> ... </this:events> [1]

</this:log>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: logmsg

Name	logmsg
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The event logmsg with the destination attribute defining if event is for display only, logonly, log and display or neither. A destination attribute of 'donotpersist' indicates that Eventd is not to persist the event to the database. The optional notify attributed can be used to suppress notices on a particular event (by default it is true - i.e. a notice will be sent.

XML Instance Representation

<this:logmsg
notify="boolean [0..1]"
dest=" string (pattern = (logndisplay|displayonly|logonly|suppress|donotpersist)) [0..1]">
string
</this:logmsg>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Element: mask

Name	mask
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The Mask for event configuration: The mask contains one or more 'maskelements' which uniquely identify an event. This can only include elements from the following subset: uei, source, host, snmphost, nodeid, interface, service, id(SNMP EID), specific, generic, community

XML Instance Representation

<this:mask>

<this:maskelement> ... </this:maskelement> [1..*]

</this:mask>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: maskelement

Name	maskelement
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The mask element

XML Instance Representation

<this:maskelement>

<mename> string </mename> [1] ?

<mevalue> string </mevalue> [1..*] ?

</this:maskelement>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: operaction

Name	operaction
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The operator action to be taken when this event occurs with state controlling if action takes place. The menutext gets displayed in the UI.

XML Instance Representation

<this:operaction
state=" string (pattern = (on|off)) [0..1]"
menutext="string [1]">
string
</this:operaction>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Element: parm

Name	parm
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	A varbind from the trap

XML Instance Representation

<this:parm>

<parmName> string </parmName> [1] ?

<this:value> ... </this:value> [1] ?

</this:parm>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: parms

Name	parms
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The varbinds from the trap

XML Instance Representation

<this:parms>

<this:parm> ... </this:parm> [1..*]

</this:parms>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: script

Name	script
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The script information for this event - describes a script to be executed whenever the event occurs.

XML Instance Representation

<this:script
language="string [1]">
string
</this:script>

Schema Component Representation

</extension>

</simpleContent>

</complexType>

</element>

top

Element: snmp

Name	snmp
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The snmp information from the trap

XML Instance Representation

<this:snmp>

<id> string </id> [1] ?

<idtext> string </idtext> [0..1] ?

<version> string </version> [1] ?

<specific> int </specific> [0..1] ?

<generic> int </generic> [0..1] ?

<community> string </community> [0..1] ?

<time-stamp> long </time-stamp> [0..1] ?

</this:snmp>

Schema Component Representation

</sequence>

</complexType>

</element>

top

Element: tticket

Name	tticket
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	The trouble ticket info with state on/off determining if action is taken on the trouble ticket.

XML Instance Representation

<this:tticket
state=" string (pattern = (on|off)) [0..1]">
string
</this:tticket>

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Element: value

Name	value
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	parm value

XML Instance Representation

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</restriction>

</simpleType>

</attribute>

</extension>

</simpleContent>

</complexType>

</element>

top

Global Definitions

Simple Type: x733-alarm-type

Super-types:	string < x733-alarm-type (by restriction)
Sub-types:	None

Name	x733-alarm-type
Content	Base XSD Type: string pattern = CommunicationsAlarm\|ProcessingErrorAlarm\|EnvironmentalAlarm\|QualityOfServiceAlarm\|EquipmentAlarm\|IntegrityViolation\|SecurityViolation\|TimeDomainViolation\|OperationalViolation\|PhysicalViolation

Name

x733-alarm-type

Content

Base XSD Type: string

pattern = CommunicationsAlarm|ProcessingErrorAlarm|EnvironmentalAlarm|QualityOfServiceAlarm|EquipmentAlarm|IntegrityViolation|SecurityViolation|TimeDomainViolation|OperationalViolation|PhysicalViolation

Schema Component Representation

</restriction>

</simpleType>

top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name

Super-types:	Address < AusAddress (by extension)
Sub-types:	QLDAddress (by restriction)

If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.

Name	AusAddress
Abstract	no

The table above displays the properties of this schema component.

XML Instance Representation

<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
- If the element/attribute's type is in the schema, a link is provided to it.
- For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

Schema Component Representation

The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)

top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top

XML Schema Documentation

Table of Contents

Schema Document Properties

Declared Namespaces

Global Declarations

Element: alarm-data

Element: autoacknowledge

Element: autoaction

Element: correlation

Element: event

Element: event-receipt

Element: events

Element: forward

Element: header

Element: log

Element: logmsg

Element: mask

Element: maskelement

Element: operaction

Element: parm

Element: parms

Element: script

Element: snmp

Element: tticket

Element: value

Global Definitions

Simple Type: x733-alarm-type

Legend

Complex Type:

AusAddress

Glossary