XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://xmlns.krupczak.org/xsd/xmpdconfigs-1.0
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Schema Composition
  • This schema imports schema(s) from the following namespace(s):
    • http://xmlns.krupczak.org/xsd/xmptypes-2.0 (at http://xmlns.krupczak.org/xsd/xmptypes-2.0.xsd)
Documentation XML Schema for XMP agent configuration files: xmpd.xml cartographer.xml cartographer-local.xml appdata.xml connectiondata.xml Version $Id$ Last update Fri Oct 26 10:48:06 EDT 2012

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
conf http://xmlns.krupczak.org/xsd/xmpdconfigs-1.0
xmp http://xmlns.krupczak.org/xsd/xmp-1.0
smi http://xmlns.krupczak.org/xsd/xmptypes-2.0
xsi http://www.w3.org/2001/XMLSchema-instance
xs http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xs:schema targetNamespace="http://xmlns.krupczak.org/xsd/xmpdconfigs-1.0" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:import namespace="http://xmlns.krupczak.org/xsd/xmptypes-2.0" schemaLocation="http://xmlns.krupczak.org/xsd/xmptypes-2.0.xsd"/>
...
</xs:schema>
top

Global Declarations

Element: applicationData

Name applicationData
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This configuration file, appdata.xml, is tracked and distributed by the agent engine. A version number is included as an attribute of the element tag. The config file consists of statements that define applications by processes that they contain.
XML Instance Representation
<conf:applicationData
version="xs:integer [1]">
Start Choice [0..*]
<conf:application> conf:appDeclarationType </conf:application> [1]
End Choice
</conf:applicationData>
Schema Component Representation
<xs:element name="applicationData">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="application" type="conf:appDeclarationType"/>
</xs:choice>
<xs:attribute name="version" type="xs:integer" use="required"/>
</xs:complexType>
</xs:element>
top

Element: cartographerConfig

Name cartographerConfig
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Main configuration file for the Cartographer plugin. Version of this config is included as an attribute of the element tag.
XML Instance Representation
<conf:cartographerConfig
version="xs:integer [1]">
Start Choice [1..*]
<conf:dependencyAgeOutInterval> xs:integer </conf:dependencyAgeOutInterval> [1]
<conf:peerAgeOutInterval> xs:integer </conf:peerAgeOutInterval> [1]
<conf:xmpAuthenUser> xs:string </conf:xmpAuthenUser> [1]
<conf:dependencyScanInterval> xs:string </conf:dependencyScanInterval> [1]
End Choice
</conf:cartographerConfig>
Schema Component Representation
<xs:element name="cartographerConfig">
<xs:complexType>
<xs:choice minOccurs="1" maxOccurs="unbounded">
<xs:element name="dependencyAgeOutInterval" type="xs:integer"/>
<xs:element name="peerAgeOutInterval" type="xs:integer"/>
<xs:element name="xmpAuthenUser" type="xs:string"/>
<xs:element name="dependencyScanInterval" type="xs:string"/>
</xs:choice>
<xs:attribute name="version" type="xs:integer" use="required"/>
</xs:complexType>
</xs:element>
top

Element: cartographerLocal

Name cartographerLocal
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Local system-specific configuration file for the Cartographer plugin. Version of this config is included as an attribute of the element tag. cartographer-local.xml is distributed and updated by the agent engine and can contain multiple system declarations, each targeted to a separate system.
XML Instance Representation
<conf:cartographerLocal
version="xs:integer [1]">
Start Choice [0..*]
<conf:system> conf:systemConfigType </conf:system> [1]
End Choice
</conf:cartographerLocal>
Schema Component Representation
<xs:element name="cartographerLocal">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="system" type="conf:systemConfigType"/>
</xs:choice>
<xs:attribute name="version" type="xs:integer" use="required"/>
</xs:complexType>
</xs:element>
top

Element: connectionData

Name connectionData
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This configuration file, connectiondata.xml, is tracked and distributed by the agent engine. A version number is included as an attribute of the element tag. The config file consists of statements that map UDP and TCP connections/ports to dependency types.
XML Instance Representation
<conf:connectionData
version="xs:integer [1]">
Start Choice [0..*]
<conf:connection> conf:connectionDeclarationType </conf:connection> [1]
End Choice
</conf:connectionData>
Schema Component Representation
<xs:element name="connectionData">
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="connection" type="conf:connectionDeclarationType"/>
</xs:choice>
<xs:attribute name="version" type="xs:integer" use="required"/>
</xs:complexType>
</xs:element>
top

Element: xmpd_config

Name xmpd_config
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Main configuration file for the xmp agent engine. Version of this config is included as an attribute of the element tag.
XML Instance Representation
<conf:xmpd_config
version="xs:integer [1]">
Start Choice [1..*]
<conf:xmpd_trace> conf:onOffNumeralType </conf:xmpd_trace> [1]
<conf:xmpd_verbose> conf:onOffNumeralType </conf:xmpd_verbose> [1]
<conf:xmpd_port> xs:integer </conf:xmpd_port> [1]
<conf:xmpd_daemon> conf:onOffNumeralType </conf:xmpd_daemon> [1]
<conf:xmpd_eventageoutinterval> xs:integer </conf:xmpd_eventageoutinterval> [1]
<conf:xmpd_defaultmanager> xs:string </conf:xmpd_defaultmanager> [1]
<conf:xmpd_autoupgrade> xs:boolean </conf:xmpd_autoupgrade> [1]
<conf:xmpd_authenuser> conf:authenUserType </conf:xmpd_authenuser> [1]
End Choice
</conf:xmpd_config>
Schema Component Representation
<xs:element name="xmpd_config">
<xs:complexType>
<xs:choice minOccurs="1" maxOccurs="unbounded">
<xs:element name="xmpd_trace" type="conf:onOffNumeralType"/>
<xs:element name="xmpd_verbose" type="conf:onOffNumeralType"/>
<xs:element name="xmpd_port" type="xs:integer"/>
<xs:element name="xmpd_daemon" type="conf:onOffNumeralType"/>
<xs:element name="xmpd_eventageoutinterval" type="xs:integer"/>
<xs:element name="xmpd_defaultmanager" type="xs:string"/>
<xs:element name="xmpd_autoupgrade" type="xs:boolean"/>
<xs:element name="xmpd_authenuser" type="conf:authenUserType"/>
</xs:choice>
<xs:attribute name="version" type="xs:integer" use="required"/>
</xs:complexType>
</xs:element>
top

Global Definitions

Complex Type: appDeclarationType

Super-types: None
Sub-types: None
Name appDeclarationType
Abstract no
XML Instance Representation
<...>
<conf:appname> xs:string </conf:appname> [1]
<conf:appfilter> xs:string </conf:appfilter> [1]
</...>
Schema Component Representation
<xs:complexType name="appDeclarationType">
<xs:sequence>
<xs:element name="appname" type="xs:string"/>
<xs:element name="appfilter" type="xs:string"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: authenUserType

Super-types: None
Sub-types: None
Name authenUserType
Abstract no
XML Instance Representation
<...>
<conf:user> xs:string </conf:user> [1] ?
<conf:protocol_ops> conf:protocolOperationsList </conf:protocol_ops> [1] ?
<conf:mibs> xs:string </conf:mibs> [1] ?
</...>
Schema Component Representation
<xs:complexType name="authenUserType">
<xs:sequence>
<xs:element name="user" type="xs:string"/>
<xs:element name="protocol_ops" type="conf:protocolOperationsList"/>
<xs:element name="mibs" type="xs:string"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: connectionDeclarationType

Super-types: None
Sub-types: None
Name connectionDeclarationType
Abstract no
XML Instance Representation
<...>
<conf:proto> conf:protoStringType </conf:proto> [1]
<conf:port> conf:portNumberType </conf:port> [1]
<conf:dependencyType> smi:dependencyTypeType </conf:dependencyType> [1]
<conf:args> xs:string </conf:args> [1]
</...>
Schema Component Representation
<xs:complexType name="connectionDeclarationType">
<xs:sequence>
<xs:element name="proto" type="conf:protoStringType"/>
<xs:element name="port" type="conf:portNumberType"/>
<xs:element name="dependencyType" type="smi:dependencyTypeType"/>
<xs:element name="args" type="xs:string"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: dependencyDeclarationType

Super-types: None
Sub-types: None
Name dependencyDeclarationType
Abstract no
XML Instance Representation
<...>
<conf:dependClient> xs:string </conf:dependClient> [1]
<conf:dependServer> xs:string </conf:dependServer> [1]
<conf:dependType> smi:dependencyStringType </conf:dependType> [1]
<conf:dependArgs> xs:string </conf:dependArgs> [1]
<conf:dependReference> smi:dependencyReferenceStringType </conf:dependReference> [1]
Start Choice [0..*]
<conf:ipVersion> xs:integer </conf:ipVersion> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="dependencyDeclarationType">
<xs:sequence>
<xs:element name="dependClient" type="xs:string"/>
<xs:element name="dependServer" type="xs:string"/>
<xs:element name="dependType" type="smi:dependencyStringType"/>
<xs:element name="dependArgs" type="xs:string"/>
<xs:element name="dependReference" type="smi:dependencyReferenceStringType"/>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="ipVersion" type="xs:integer"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
top

Complex Type: logfileDependencyDeclarationType

Super-types: None
Sub-types: None
Name logfileDependencyDeclarationType
Abstract no
XML Instance Representation
<...>
<conf:logfile> xs:string </conf:logfile> [1]
<conf:dependType> smi:dependencyStringType </conf:dependType> [1]
<conf:addExpression> xs:string </conf:addExpression> [1]
<conf:removeExpression> xs:string </conf:removeExpression> [1]
<conf:dependClient> xs:string </conf:dependClient> [1]
<conf:dependServer> xs:string </conf:dependServer> [1]
<conf:dependArgs> xs:string </conf:dependArgs> [1]
<conf:scanInterval> xs:integer </conf:scanInterval> [1]
<conf:timeout> xs:integer </conf:timeout> [1]
Start Choice [0..*]
<conf:description> xs:string </conf:description> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="logfileDependencyDeclarationType">
<xs:sequence>
<xs:element name="logfile" type="xs:string"/>
<xs:element name="dependType" type="smi:dependencyStringType"/>
<xs:element name="addExpression" type="xs:string"/>
<xs:element name="removeExpression" type="xs:string"/>
<xs:element name="dependClient" type="xs:string"/>
<xs:element name="dependServer" type="xs:string"/>
<xs:element name="dependArgs" type="xs:string"/>
<xs:element name="scanInterval" type="xs:integer"/>
<xs:element name="timeout" type="xs:integer"/>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="description" type="xs:string"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
top

Complex Type: logfileMonitorDeclarationType

Super-types: None
Sub-types: None
Name logfileMonitorDeclarationType
Abstract no
XML Instance Representation
<...>
<conf:logfile> xs:string </conf:logfile> [1]
<conf:expression> xs:string </conf:expression> [1]
<conf:scanInterval> xs:integer </conf:scanInterval> [1]
Start Choice [0..*]
<conf:description> xs:string </conf:description> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="logfileMonitorDeclarationType">
<xs:sequence>
<xs:element name="logfile" type="xs:string"/>
<xs:element name="expression" type="xs:string"/>
<xs:element name="scanInterval" type="xs:integer"/>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="description" type="xs:string"/>
</xs:choice>
</xs:sequence>
</xs:complexType>
top

Complex Type: systemConfigType

Super-types: None
Sub-types: None
Name systemConfigType
Abstract no
XML Instance Representation
<...
name="xs:string [1]">
Start Choice [0..*]
<conf:dependency> conf:dependencyDeclarationType </conf:dependency> [1]
<conf:logfileDependency> conf:logfileDependencyDeclarationType </conf:logfileDependency> [1]
<conf:logfileMonitor> conf:logfileMonitorDeclarationType </conf:logfileMonitor> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="systemConfigType">
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element name="dependency" type="conf:dependencyDeclarationType"/>
<xs:element name="logfileDependency" type="conf:logfileDependencyDeclarationType"/>
<xs:element name="logfileMonitor" type="conf:logfileMonitorDeclarationType"/>
</xs:choice>
<xs:attribute name="name" type="xs:string" use="required"/>
</xs:complexType>
top

Simple Type: onOffNumeralType

Super-types: xs:integer < onOffNumeralType (by restriction)
Sub-types: None
Name onOffNumeralType
Content
  • Base XSD Type: integer
  • value comes from list: {'0'|'1'}
Schema Component Representation
<xs:simpleType name="onOffNumeralType">
<xs:restriction base="xs:integer">
<xs:enumeration value="0"/>
<xs:enumeration value="1"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: portNumberType

Super-types: xs:unsignedShort < portNumberType (by restriction)
Sub-types: None
Name portNumberType
Content
  • Base XSD Type: unsignedShort
  • value >= 1
Schema Component Representation
<xs:simpleType name="portNumberType">
<xs:restriction base="xs:unsignedShort">
<xs:minInclusive value="1"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: protoStringType

Super-types: xs:string < protoStringType (by restriction)
Sub-types: None
Name protoStringType
Content
  • Base XSD Type: string
  • value comes from list: {'tcp'|'udp'}
Schema Component Representation
<xs:simpleType name="protoStringType">
<xs:restriction base="xs:string">
<xs:enumeration value="tcp"/>
<xs:enumeration value="udp"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: protocolOperations

Super-types: xs:string < protocolOperations (by restriction)
Sub-types: None
Name protocolOperations
Content
  • Base XSD Type: string
  • value comes from list: {'response'|'getrequest'|'setrequest'|'selecttablerequest'|'inserttablerequest'|'deletetablerequest'|'updatetablerequest'|'trap'|'information'|'all'|'Response'|'GetRequest'|'SetRequest'|'SelectTableRequest'|'InsertTableRequest'|'DeleteTableRequest'|'UpdateTableRequest'|'Trap'|'Information'|'All'}
Schema Component Representation
<xs:simpleType name="protocolOperations">
<xs:restriction base="xs:string">
<xs:enumeration value="response"/>
<xs:enumeration value="getrequest"/>
<xs:enumeration value="setrequest"/>
<xs:enumeration value="selecttablerequest"/>
<xs:enumeration value="inserttablerequest"/>
<xs:enumeration value="deletetablerequest"/>
<xs:enumeration value="updatetablerequest"/>
<xs:enumeration value="trap"/>
<xs:enumeration value="information"/>
<xs:enumeration value="all"/>
<xs:enumeration value="Response"/>
<xs:enumeration value="GetRequest"/>
<xs:enumeration value="SetRequest"/>
<xs:enumeration value="SelectTableRequest"/>
<xs:enumeration value="InsertTableRequest"/>
<xs:enumeration value="DeleteTableRequest"/>
<xs:enumeration value="UpdateTableRequest"/>
<xs:enumeration value="Trap"/>
<xs:enumeration value="Information"/>
<xs:enumeration value="All"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: protocolOperationsList

Super-types: None
Sub-types: None
Name protocolOperationsList
Content
Schema Component Representation
<xs:simpleType name="protocolOperationsList">
<xs:list itemType="conf:protocolOperations"/>
</xs: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.

Schema Component Representation
<complexTypename="AusAddress">
<complexContent>
<extensionbase="Address">
<sequence>
<elementname="state" type="AusStates"/>
<elementname="postcode">
<simpleType>
<restrictionbase="string">
<patternvalue="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attributename="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
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