XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.platform.com/ego/2005/05/schema/sc
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://www.platform.com/ego/2005/05/schema (at ego.xsd)
Documentation This schema describes the configuration file format for the EGO Service Controller.

Declared Namespaces

Prefix Namespace
ego http://www.platform.com/ego/2005/05/schema
xml http://www.w3.org/XML/1998/namespace
sc http://www.platform.com/ego/2005/05/schema/sc
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema targetNamespace="http://www.platform.com/ego/2005/05/schema/sc" elementFormDefault="qualified">
<xsd:import namespace="http://www.platform.com/ego/2005/05/schema" schemaLocation="ego.xsd"/>
...
</xsd:schema>
top

Global Declarations

Element: ActivityDescription

Name ActivityDescription
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Ties a particular ActivitySpecification to resources that match given attributes. For example, on a compute host type of resource, you might use the hostType attribute to restrict an ActivitySpecification to hosts with a hostType of "LINUXResourceSpeci86".
Logical Diagram
XML Instance Representation
<sc:ActivityDescription>
<ego:Attribute> ... </ego:Attribute> [1]
<ego:ActivitySpecification> ... </ego:ActivitySpecification> [1]
</sc:ActivityDescription>
Diagram
Schema Component Representation
<xsd:element name="ActivityDescription">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" ego:Attribute " maxOccurs="1"/>
<xsd:element ref=" ego:ActivitySpecification "/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: AllocationSpecification

Name AllocationSpecification
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Describes the resource allocation information for this service.
Logical Diagram
XML Instance Representation
<sc:AllocationSpecification>
<ego:ConsumerID> ... </ego:ConsumerID> [1]
<sc:ResourceSpecification> ... </sc:ResourceSpecification> [1]
</sc:AllocationSpecification>
Diagram
Schema Component Representation
<xsd:element name="AllocationSpecification">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" ego:ConsumerID "/>
<xsd:element ref=" sc:ResourceSpecification "/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: BlockHostExitValues

Name BlockHostExitValues
Used by (from the same schema document) Element ControlPolicy
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Specifies exit values, which, if received from all instances of a service on a host, should cause that host to be blocked from running this service. The EGO service controller should not restart instances on that host unless the host is unblocked.
Logical Diagram
XML Instance Representation
<sc:BlockHostExitValues>
<sc:ExitValue> ... </sc:ExitValue> [1..*]
</sc:BlockHostExitValues>
Diagram
Schema Component Representation
<xsd:element name="BlockHostExitValues">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" sc:ExitValue " maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: ControlPolicy

Name ControlPolicy
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Describes the service lifecycle parameters of a service. It defines parameters for starting and restarting the service, and detecting hung services.
Logical Diagram
XML Instance Representation
<sc:ControlPolicy>
<sc:StartType> ... </sc:StartType> [1]
<sc:MaxRestarts> ... </sc:MaxRestarts> [0..1]
<sc:HeartbeatInterval> ... </sc:HeartbeatInterval> [0..1]
<sc:MaxMissedHeartbeats> ... </sc:MaxMissedHeartbeats> [0..1]
<sc:HostFailoverInterval> ... </sc:HostFailoverInterval> [0..1]
<sc:Dependency> ... </sc:Dependency> [0..*]
<sc:BlockHostExitValues> ... </sc:BlockHostExitValues> [0..1]
</sc:ControlPolicy>
Diagram
Schema Component Representation
<xsd:element name="ControlPolicy">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" sc:StartType "/>
<xsd:element ref=" sc:MaxRestarts " minOccurs="0"/>
<xsd:element ref=" sc:HeartbeatInterval " minOccurs="0"/>
<xsd:element ref=" sc:MaxMissedHeartbeats " minOccurs="0"/>
<xsd:element ref=" sc:HostFailoverInterval " minOccurs="0"/>
<xsd:element ref=" sc:Dependency " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref=" sc:BlockHostExitValues " minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: Dependency

Name Dependency
Used by (from the same schema document) Element ControlPolicy
Type Locally-defined complex type
Nillable no
Abstract no
Documentation This element is used to indicate that there is a dependency on another service. The type attribute of the element is used to describe the dependency type, and the content of the element holds the name of the service that is being depended on.
Logical Diagram
XML Instance Representation
<sc:Dependency
type=" sc:DependencyTypeEnumeration [1]">
xsd:string
</sc:Dependency>
Diagram
Schema Component Representation
<xsd:element name="Dependency">
<xsd:complexType>
<xsd:simpleContent>
<xsd:extension base=" xsd:string ">
<xsd:attribute name="type" type=" sc:DependencyTypeEnumeration " use="required"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
</xsd:element>
top

Element: Description

Name Description
Used by (from the same schema document) Element ServiceDefinition
Type xsd:string
Nillable no
Abstract no
Documentation Describes this service. Specify a string of up to 120 alphanumeric and special characters, except control characters.
Logical Diagram
XML Instance Representation
<sc:Description> xsd:string </sc:Description>
Diagram
Schema Component Representation
<xsd:element name="Description" type=" xsd:string "/>
top

Element: ExitValue

Name ExitValue
Used by (from the same schema document) Element BlockHostExitValues
Type xsd:integer
Nillable no
Abstract no
Documentation Specifies an exit value, which, if received from all instances of a service on a host, should cause that host to be blocked from running this service. The EGO service controller should not restart instances on that host unless the host is unblocked. Specify an integer.
Logical Diagram
XML Instance Representation
<sc:ExitValue> xsd:integer </sc:ExitValue>
Diagram
Schema Component Representation
<xsd:element name="ExitValue" type=" xsd:integer "/>
top

Element: HeartbeatInterval

Name HeartbeatInterval
Used by (from the same schema document) Element ControlPolicy
Type xsd:duration
Nillable no
Abstract no
Documentation Specifies how often the EGO service controller checks if a service instance is hung. Specify the duration in the format PTnHnMnS, where nH the number of hours, nM the number of minutes and nS the number of seconds. The number of seconds can include decimal digits to arbitrary precision.
Logical Diagram
XML Instance Representation
<sc:HeartbeatInterval> xsd:duration </sc:HeartbeatInterval>
Diagram
Schema Component Representation
<xsd:element name="HeartbeatInterval" type=" xsd:duration "/>
top

Element: HostFailoverInterval

Name HostFailoverInterval
Used by (from the same schema document) Element ControlPolicy
Type xsd:duration
Nillable no
Abstract no
Documentation Specifies the length of time to wait after a host fails until the service should be restarted on another host. Specify the duration in the format PTnHnMnS, where nH the number of hours, nM the number of minutes and nS the number of seconds. The number of seconds can include decimal digits to arbitrary precision.
Logical Diagram
XML Instance Representation
<sc:HostFailoverInterval> xsd:duration </sc:HostFailoverInterval>
Diagram
Schema Component Representation
<xsd:element name="HostFailoverInterval" type=" xsd:duration "/>
top

Element: InstanceSequenceId

Name InstanceSequenceId
Used by (from the same schema document) Element ServiceInstanceInfo , Element ServiceInstanceStateChange
Type xsd:string
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:InstanceSequenceId> xsd:string </sc:InstanceSequenceId>
Diagram
Schema Component Representation
<xsd:element name="InstanceSequenceId" type=" xsd:string "/>
top

Element: MaxInstances

Name MaxInstances
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the maximum number of instances this service is allowed to run. Specify a number greater than or equal to the value specified for MinInstances.
Logical Diagram
XML Instance Representation
<sc:MaxInstances> xsd:integer (1 <= value <= 2147483647) </sc:MaxInstances>
Diagram
Schema Component Representation
<xsd:element name="MaxInstances">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: MaxInstancesPerHost

Name MaxInstancesPerHost
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the maximum number of instances of this service allowed per host. Specify a number greater than or equal to 1.
Logical Diagram
XML Instance Representation
<sc:MaxInstancesPerHost> xsd:integer (1 <= value <= 2147483647) </sc:MaxInstancesPerHost>
Diagram
Schema Component Representation
<xsd:element name="MaxInstancesPerHost">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: MaxInstancesPerSlot

Name MaxInstancesPerSlot
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the maximum number of instances of this service allowed per CPU slot. Specify a number greater than or equal to 1.
Logical Diagram
XML Instance Representation
<sc:MaxInstancesPerSlot> xsd:integer (1 <= value <= 2147483647) </sc:MaxInstancesPerSlot>
Diagram
Schema Component Representation
<xsd:element name="MaxInstancesPerSlot">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: MaxMissedHeartbeats

Name MaxMissedHeartbeats
Used by (from the same schema document) Element ControlPolicy
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the maximum number of missed heartbeats before a service instance is considered hung. Specify a number greater than or equal to 1.
Logical Diagram
XML Instance Representation
<sc:MaxMissedHeartbeats> xsd:integer (0 <= value <= 2147483647) </sc:MaxMissedHeartbeats>
Diagram
Schema Component Representation
<xsd:element name="MaxMissedHeartbeats">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: MaxRestarts

Name MaxRestarts
Used by (from the same schema document) Element ControlPolicy
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the maximum number of times this service can be restarted before it is flagged in an error state. Specify a number greater than or equal to 1.
Logical Diagram
XML Instance Representation
<sc:MaxRestarts> xsd:integer (0 <= value <= 2147483647) </sc:MaxRestarts>
Diagram
Schema Component Representation
<xsd:element name="MaxRestarts">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="0"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: MinInstances

Name MinInstances
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the minimum number of instances this service requires to run. Specify a number greater than or equal to 1.
Logical Diagram
XML Instance Representation
<sc:MinInstances> xsd:integer (1 <= value <= 2147483647) </sc:MinInstances>
Diagram
Schema Component Representation
<xsd:element name="MinInstances">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: NeedCredential

Name NeedCredential
Used by (from the same schema document) Element ServiceDefinition
Type xsd:boolean
Nillable no
Abstract no
Documentation Specifies whether the service requires a credential to be passed from the EGO_SERVICE_CREDENTIAL environment variable. Specify TRUE or FALSE.
Logical Diagram
XML Instance Representation
<sc:NeedCredential> xsd:boolean </sc:NeedCredential>
Diagram
Schema Component Representation
<xsd:element name="NeedCredential" type=" xsd:boolean "/>
top

Element: NumServiceInstances

Name NumServiceInstances
Used by (from the same schema document) Element ServiceInfo
Type xsd:int
Nillable no
Abstract no
Documentation The number of active service instances for a service.
Logical Diagram
XML Instance Representation
<sc:NumServiceInstances> xsd:int </sc:NumServiceInstances>
Diagram
Schema Component Representation
<xsd:element name="NumServiceInstances" type=" xsd:int "/>
top

Element: Priority

Name Priority
Used by (from the same schema document) Element ServiceDefinition
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies the order in which the service controller starts services at startup time. Specify a number greater than or equal to 1 that represents the relative starting order for this service.
Logical Diagram
XML Instance Representation
<sc:Priority> xsd:integer (1 <= value <= 2147483647) </sc:Priority>
Diagram
Schema Component Representation
<xsd:element name="Priority">
<xsd:simpleType>
<xsd:restriction base=" xsd:integer ">
<xsd:minInclusive value="1"/>
<xsd:maxInclusive value="2147483647"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: ResourceSpecification

Name ResourceSpecification
Used by (from the same schema document) Element AllocationSpecification
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Describes the resources required by this service.
Logical Diagram
XML Instance Representation
<sc:ResourceSpecification
ResourceType=" xsd:anyURI [1]

'Indicates the type of a resource. The URI is intended to match with the URI of the namespace of an XML schema that is used to further describe the resource.'

"
>
<ego:ResourceGroupName> ... </ego:ResourceGroupName> [0..1]
<ego:ResourceRequirement> ... </ego:ResourceRequirement> [0..1]
</sc:ResourceSpecification>
Diagram
Schema Component Representation
<xsd:element name="ResourceSpecification">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" ego:ResourceGroupName " minOccurs="0"/>
<xsd:element ref=" ego:ResourceRequirement " minOccurs="0"/>
</xsd:sequence>
<xsd:attribute name="ResourceType" type=" xsd:anyURI " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: ServiceAllocationInfo

Name ServiceAllocationInfo
Used by (from the same schema document) Element ServiceInfo
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:ServiceAllocationInfo>
<ego:AllocationID> ... </ego:AllocationID> [1]
<ego:Resource> ... </ego:Resource> [0..*]
</sc:ServiceAllocationInfo>
Diagram
Schema Component Representation
<xsd:element name="ServiceAllocationInfo">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" ego:AllocationID "/>
<xsd:element ref=" ego:Resource " minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: ServiceControlOperation

Name ServiceControlOperation
Type Locally-defined simple type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:ServiceControlOperation> xsd:string (value comes from list: {'enable'|'disable'}) </sc:ServiceControlOperation>
Diagram
Schema Component Representation
<xsd:element name="ServiceControlOperation">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="enable"/>
<xsd:enumeration value="disable"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: ServiceDefinition

Name ServiceDefinition
Used by (from the same schema document) Element ServiceInfo
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Configures a service to be managed by the EGO service controller, defining version, resources, allocations, activities, and other configuration parameters for the service.
Logical Diagram
XML Instance Representation
<sc:ServiceDefinition
ServiceName=" xsd:string [1]

'Specifies a unique name for the service. Specify up to 40 alphanumeric characters, where the first character is alphabetic.'

"
>
<sc:Version> ... </sc:Version> [1]
<sc:Description> ... </sc:Description> [1]
<sc:MinInstances> ... </sc:MinInstances> [1]
<sc:MaxInstances> ... </sc:MaxInstances> [1]
<sc:MaxInstancesPerSlot> ... </sc:MaxInstancesPerSlot> [1]
<sc:MaxInstancesPerHost> ... </sc:MaxInstancesPerHost> [0..1]
<sc:Priority> ... </sc:Priority> [1]
<sc:ControlPolicy> ... </sc:ControlPolicy> [1]
<sc:AllocationSpecification> ... </sc:AllocationSpecification> [1]
<sc:ActivityDescription> ... </sc:ActivityDescription> [1..*]
<sc:NeedCredential> ... </sc:NeedCredential> [1]
</sc:ServiceDefinition>
Diagram
Schema Component Representation
<xsd:element name="ServiceDefinition">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" sc:Version "/>
<xsd:element ref=" sc:Description "/>
<xsd:element ref=" sc:MinInstances "/>
<xsd:element ref=" sc:MaxInstances "/>
<xsd:element ref=" sc:MaxInstancesPerSlot "/>
<xsd:element ref=" sc:MaxInstancesPerHost " minOccurs="0"/>
<xsd:element ref=" sc:Priority "/>
<xsd:element ref=" sc:ControlPolicy "/>
<xsd:element ref=" sc:AllocationSpecification "/>
<xsd:element ref=" sc:ActivityDescription " maxOccurs="unbounded"/>
<xsd:element ref=" sc:NeedCredential "/>
</xsd:sequence>
<xsd:attribute name="ServiceName" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: ServiceInfo

Name ServiceInfo
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The ServiceInfo element describes the configuration of a single service to be managed by the EGO Service Controller. The ServiceName attribute identifies this service, and must be unique amongst all services controlled by the EGO Service Controller.
Logical Diagram
XML Instance Representation
<sc:ServiceInfo
ServiceName=" xsd:string [1]">
<sc:ServiceDefinition> ... </sc:ServiceDefinition> [1]
<sc:ServiceState> sc:ServiceStateEnumeration </sc:ServiceState> [1]
<sc:ServiceAllocationInfo> ... </sc:ServiceAllocationInfo> [1]
<sc:NumServiceInstances> ... </sc:NumServiceInstances> [1]
<sc:ServiceInstanceInfo> ... </sc:ServiceInstanceInfo> [1..*]
</sc:ServiceInfo>
Diagram
Schema Component Representation
<xsd:element name="ServiceInfo">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" sc:ServiceDefinition "/>
<xsd:element name="ServiceState" type=" sc:ServiceStateEnumeration "/>
<xsd:element ref=" sc:ServiceAllocationInfo "/>
<xsd:element ref=" sc:NumServiceInstances "/>
<xsd:element ref=" sc:ServiceInstanceInfo " maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="ServiceName" type=" xsd:string " use="required"/>
</xsd:complexType>
</xsd:element>
top

Element: ServiceInstanceControlOperation

Name ServiceInstanceControlOperation
Type Locally-defined simple type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:ServiceInstanceControlOperation> xsd:string (value comes from list: {'stop'}) </sc:ServiceInstanceControlOperation>
Diagram
Schema Component Representation
<xsd:element name="ServiceInstanceControlOperation">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="stop"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: ServiceInstanceInfo

Name ServiceInstanceInfo
Used by (from the same schema document) Element ServiceInfo
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The ServiceInstanceInfo element describes the configuration of a single instance of a service to be managed by the EGO Service Controller.
Logical Diagram
XML Instance Representation
<sc:ServiceInstanceInfo>
<sc:ServiceInstanceState> sc:ServiceInstanceStateEnumeration </sc:ServiceInstanceState> [1]
<ego:ActivityID> ... </ego:ActivityID> [1]
<ego:ResourceName> ... </ego:ResourceName> [1]
<sc:InstanceSequenceId> ... </sc:InstanceSequenceId> [1]
</sc:ServiceInstanceInfo>
Diagram
Schema Component Representation
<xsd:element name="ServiceInstanceInfo">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="ServiceInstanceState" type=" sc:ServiceInstanceStateEnumeration "/>
<xsd:element ref=" ego:ActivityID "/>
<xsd:element ref=" ego:ResourceName "/>
<xsd:element ref=" sc:InstanceSequenceId "/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: ServiceInstanceStateChange

Name ServiceInstanceStateChange
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:ServiceInstanceStateChange>
<sc:ServiceName> ... </sc:ServiceName> [1]
<sc:InstanceSequenceId> ... </sc:InstanceSequenceId> [1]
<ego:ResourceName> ... </ego:ResourceName> [1]
<sc:OldState> sc:ServiceInstanceStateEnumeration </sc:OldState> [1]
<sc:NewState> sc:ServiceInstanceStateEnumeration </sc:NewState> [1]
<ego:ActivityID> ... </ego:ActivityID> [1]
<sc:Reason> xsd:string </sc:Reason> [1]
</sc:ServiceInstanceStateChange>
Diagram
Schema Component Representation
<xsd:element name="ServiceInstanceStateChange">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" sc:ServiceName "/>
<xsd:element ref=" sc:InstanceSequenceId "/>
<xsd:element ref=" ego:ResourceName "/>
<xsd:element name="OldState" type=" sc:ServiceInstanceStateEnumeration "/>
<xsd:element name="NewState" type=" sc:ServiceInstanceStateEnumeration "/>
<xsd:element ref=" ego:ActivityID "/>
<xsd:element name="Reason" type=" xsd:string "/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: ServiceName

Name ServiceName
Used by (from the same schema document) Element ServiceStateChange , Element ServiceInstanceStateChange
Type xsd:string
Nillable no
Abstract no
Documentation Specifies a unique name for the service. Specify up to 40 alphanumeric characters, where the first character is alphabetic.
Logical Diagram
XML Instance Representation
<sc:ServiceName> xsd:string </sc:ServiceName>
Diagram
Schema Component Representation
<xsd:element name="ServiceName" type=" xsd:string "/>
top

Element: ServiceNotificationState

Name ServiceNotificationState
Type Locally-defined simple type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:ServiceNotificationState> xsd:string (value comes from list: {'ok'}) </sc:ServiceNotificationState>
Diagram
Schema Component Representation
<xsd:element name="ServiceNotificationState">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="ok"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: ServiceStateChange

Name ServiceStateChange
Type Locally-defined complex type
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:ServiceStateChange>
<sc:ServiceName> ... </sc:ServiceName> [1]
<sc:OldState> sc:ServiceStateEnumeration </sc:OldState> [1]
<sc:NewState> sc:ServiceStateEnumeration </sc:NewState> [1]
<ego:AllocationID> ... </ego:AllocationID> [1]
</sc:ServiceStateChange>
Diagram
Schema Component Representation
<xsd:element name="ServiceStateChange">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref=" sc:ServiceName "/>
<xsd:element name="OldState" type=" sc:ServiceStateEnumeration "/>
<xsd:element name="NewState" type=" sc:ServiceStateEnumeration "/>
<xsd:element ref=" ego:AllocationID "/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
top

Element: StartOnBoot

Name StartOnBoot
Type xsd:boolean
Nillable no
Abstract no
Documentation Indicates whether the EGO Service Controller should start this service when it starts, or whether it should be left to be started on demand.
Logical Diagram
XML Instance Representation
<sc:StartOnBoot> xsd:boolean </sc:StartOnBoot>
Diagram
Schema Component Representation
<xsd:element name="StartOnBoot" type=" xsd:boolean "/>
top

Element: StartType

Name StartType
Used by (from the same schema document) Element ControlPolicy
Type Locally-defined simple type
Nillable no
Abstract no
Documentation Specifies whether the service starts automatically or manually. Specify AUTOMATIC or MANUAL.
Logical Diagram
XML Instance Representation
<sc:StartType> xsd:string (value comes from list: {'AUTOMATIC'|'MANUAL'}) </sc:StartType>
Diagram
Schema Component Representation
<xsd:element name="StartType">
<xsd:simpleType>
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="AUTOMATIC"/>
<xsd:enumeration value="MANUAL"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
top

Element: SubscriptionID

Name SubscriptionID
Type xsd:string
Nillable no
Abstract no
Logical Diagram
XML Instance Representation
<sc:SubscriptionID> xsd:string </sc:SubscriptionID>
Diagram
Schema Component Representation
<xsd:element name="SubscriptionID" type=" xsd:string "/>
top

Element: Version

Name Version
Used by (from the same schema document) Element ServiceDefinition
Type xsd:string
Nillable no
Abstract no
Documentation Specifies the version of the service controller this service runs on.
Logical Diagram
XML Instance Representation
<sc:Version> xsd:string </sc:Version>
Diagram
Schema Component Representation
<xsd:element name="Version" type=" xsd:string "/>
top

Global Definitions

Simple Type: DependencyTypeEnumeration

Super-types: xsd:string < DependencyTypeEnumeration (by restriction)
Sub-types: None
Name DependencyTypeEnumeration
Used by (from the same schema document) Element Dependency
Content
  • Base XSD Type: string
  • value comes from list: {'OnStart'}
Documentation This enumeration type is used to identify the different types of dependencies.
Diagram
Schema Component Representation
<xsd:simpleType name="DependencyTypeEnumeration">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="OnStart"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: ServiceInstanceStateEnumeration

Super-types: xsd:string < ServiceInstanceStateEnumeration (by restriction)
Sub-types: None
Name ServiceInstanceStateEnumeration
Used by (from the same schema document) Element ServiceInstanceInfo , Element ServiceInstanceStateChange , Element ServiceInstanceStateChange
Content
  • Base XSD Type: string
  • value comes from list: {'null'|'start'|'run'|'suspend'|'finish'|'unknown'|'hang'|'error'}
Diagram
Schema Component Representation
<xsd:simpleType name="ServiceInstanceStateEnumeration">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="null"/>
<xsd:enumeration value="start"/>
<xsd:enumeration value="run"/>
<xsd:enumeration value="suspend"/>
<xsd:enumeration value="finish"/>
<xsd:enumeration value="unknown"/>
<xsd:enumeration value="hang"/>
<xsd:enumeration value="error"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: ServiceStateEnumeration

Super-types: xsd:string < ServiceStateEnumeration (by restriction)
Sub-types: None
Name ServiceStateEnumeration
Used by (from the same schema document) Element ServiceInfo , Element ServiceStateChange , Element ServiceStateChange
Content
  • Base XSD Type: string
  • value comes from list: {'defined'|'init'|'allocating'|'started'|'deallocating'|'error'|'hang'}
Diagram
Schema Component Representation
<xsd:simpleType name="ServiceStateEnumeration">
<xsd:restriction base=" xsd:string ">
<xsd:enumeration value="defined"/>
<xsd:enumeration value="init"/>
<xsd:enumeration value="allocating"/>
<xsd:enumeration value="started"/>
<xsd:enumeration value="deallocating"/>
<xsd:enumeration value="error"/>
<xsd:enumeration value="hang"/>
</xsd:restriction>
</xsd: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
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="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