XML Schema Documentation

Target Namespace	http://xmlns.opennms.org/xsd/config/datacollection
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.
Schema Composition	This schema imports schema(s) from the following namespace(s): http://xmlns.opennms.org/xsd/types (at types.xsd)
Documentation	XML Schema for the datacollection-config.xml configuration file.

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

Schema Component Representation

...

</schema>

Name	collect
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	container for list of MIB groups to be collected for the system

XML Instance Representation

<dc:collect>

<includeGroup> string </includeGroup> [0..*]

</dc:collect>

Schema Component Representation

</sequence>

</complexType>

</element>

Name	datacollection-config
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Top-level element for the datacollection-config.xml configuration file.

XML Instance Representation

<dc:datacollection-config
rrdRepository="string [1] ?">

<dc:snmp-collection> ... </dc:snmp-collection> [1..*] ?

</dc:datacollection-config>

Schema Component Representation

</sequence>

</complexType>

</element>

Name	group
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	a MIB object group

XML Instance Representation

<dc:group
name="string [1] ?"
ifType=" string (pattern = ^(all|ignore|(\d+,)*\d+)$) [1] ?">

<dc:mibObj> ... </dc:mibObj> [0..*] ?

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

</dc:group>

Schema Component Representation

</sequence>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

Name	groups
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	MIB object groups

XML Instance Representation

<dc:groups>

<dc:group> ... </dc:group> [1..*] ?

</dc:groups>

Schema Component Representation

</sequence>

</complexType>

</element>

Name	ipList
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	list of IP address or IP address mask values to which this system definition applies.

XML Instance Representation

<dc:ipList>

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

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

</dc:ipList>

Schema Component Representation

</sequence>

</complexType>

</element>

Name	mibObj
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	a MIB object

XML Instance Representation

Schema Component Representation

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

Name	parameter
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	Parameters to be used for configuration this strategy.

XML Instance Representation

<dc:parameter
key="string [1]"
value="string [1]"/>

Schema Component Representation

</complexType>

</element>

Name	resourceType
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	a custom resource type

XML Instance Representation

<dc:resourceType
name="string [1] ?"
label="string [1] ?"
resourceLabel="string [0..1] ?">

<persistenceSelectorStrategy
class="string [1] ?"> [1] ?

<dc:parameter> ... </dc:parameter> [0..*] ?

</persistenceSelectorStrategy>

<storageStrategy
class="string [1] ?"> [1] ?

<dc:parameter> ... </dc:parameter> [0..*] ?

</storageStrategy>

</dc:resourceType>

Schema Component Representation

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

Name	snmp-collection
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	a grouping of SNMP related RRD parms, MIB object groups and sysoid based system definitions.

XML Instance Representation

<dc:snmp-collection
name="string [1] ?"
maxVarsPerPdu="int [0..1] ?"
snmpStorageFlag=" string (pattern = (all|primary|select)) [1] ?">

<typ:rrd> ... </typ:rrd> [1] ?

<dc:resourceType> ... </dc:resourceType> [0..*] ?

<dc:groups> ... </dc:groups> [1] ?

<dc:systems> ... </dc:systems> [1] ?

</dc:snmp-collection>

Schema Component Representation

</sequence>

</restriction>

</simpleType>

</attribute>

</complexType>

</element>

Name	systemDef
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	system definition

XML Instance Representation

<dc:systemDef
name="string [1]">
Start Choice [1]

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

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

End Choice

<dc:ipList> ... </dc:ipList> [0..1] ?

<dc:collect> ... </dc:collect> [1] ?

</dc:systemDef>

Schema Component Representation

</choice>

</sequence>

</complexType>

</element>

Name	systems
Type	Locally-defined complex type
Nillable	no
Abstract	no
Documentation	systems

XML Instance Representation

<dc:systems>

<dc:systemDef> ... </dc:systemDef> [1..*] ?

</dc:systems>

Schema Component Representation

</sequence>

</complexType>

</element>

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: collect

Element: datacollection-config

Element: group

Element: groups

Element: ipList

Element: mibObj

Element: parameter

Element: resourceType

Element: snmp-collection

Element: systemDef

Element: systems

Legend

Complex Type:

AusAddress

Glossary