complexType XmlEntityDetail

diagram
namespace	http://api.de.n2.tibco.com
type	extension of XmlModelEntity
properties	base  XmlModelEntity
children	dynamic-id-attr qualifierSet groups org-units positions privileges capabilities queries selection-mode ldap-containers
attributes	Name   Type   Use   Default   Fixed   Annotation model-version   xs:int   optional   -1      documentation Major version number of the organization model in which an organization model entity resides. If not specified, the default value will be the latest version of the organization model. (Version numbers must be compatible with, and conform to, the OSGi version number schema. For Directory Engine, only the major part of the version number is significant.) entity-type   OrganisationalEntityType   required         documentation Enumerated value defining the type of the organization model entity. guid   xs:string   required         documentation Globally unique ID of the organization model entity. (Although this value is unique across all entities, if the entity exists within more than one major version, it will share the same GUID.) qualifier   xs:string   optional         documentation Only applicable in certain circumstances, and only to organization model entities whose entity-type is PRIVILEGE or CAPABILITY. These entities can have an association with other entities - for example, a resource may hold many capabilities, or a position may have many privileges. These associations can have a qualifying value, according to their nature, to differentiate them. For example, the PRIVILEGE to sign off a purchase order may be qualified with the maximum amount that can be signed off. name   xs:string   required         documentation Name of the organization model entity. The name must be unique within entities of the same type and in the same majotr version of the organization model. resource-type   ResourceType      HUMAN      documentation Resouce type of this entity (for entities of type RESOURCE). alias   xs:string   optional         documentation Alias name by which the LDAP connection (from which the resource originates) is registered with Directory Engine. This attribute is used with "dn" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE. dn   xs:string   optional         documentation DN of the LDAP entry for which the resource originates. This attribute is used with "alias" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.
annotation	documentation Details of an identified organization model entity. Not all elements are relevant to all organization model entity types.
source	<xs:complexType name="XmlEntityDetail">   <xs:annotation>     <xs:documentation>Details of an identified organization model entity. Not all elements are relevant to all organization model entity types.       </xs:documentation>   </xs:annotation>   <xs:complexContent>     <xs:extension base="XmlModelEntity">       <xs:sequence>         <xs:element name="groups" type="xs:string" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>GUIDs of the groups to which this resource belongs. This attribute is only relevant for entities of type RESOURCE.               </xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="org-units" type="xs:string" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>GUIDs of the organization units to which this resource belongs, via the positions to which it belongs. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="positions" type="xs:string" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>GUIDs of the positions to which this resource belongs. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="privileges" type="xs:string" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>GUIDs of the privileges currently held by this resource. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="capabilities" type="xs:string" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>GUIDs of the capabilities currently associated with this resource. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="queries" type="xs:string" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>GUIDs of the queries currently associated with this resource. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="selection-mode" type="SelectionMode" minOccurs="0">           <xs:annotation>             <xs:documentation>Default algorithm used to select a resource from those associated with this organization model entity. This attribute is only relevant for entities of type GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION.</xs:documentation>           </xs:annotation>         </xs:element>         <xs:element name="ldap-containers" type="AdminLDAPContainer" minOccurs="0" maxOccurs="unbounded">           <xs:annotation>             <xs:documentation>(Optional) Lists the LDAP Containers that can map resources to this Organisation. This element is only relevant for ORGANIZATION entity types.</xs:documentation>           </xs:annotation>         </xs:element>       </xs:sequence>       <xs:attribute name="resource-type" type="ResourceType" default="HUMAN">         <xs:annotation>           <xs:documentation>Resouce type of this entity (for entities of type RESOURCE).</xs:documentation>         </xs:annotation>       </xs:attribute>       <xs:attribute name="alias" type="xs:string" use="optional">         <xs:annotation>           <xs:documentation>Alias name by which the LDAP connection (from which the resource originates) is registered with Directory Engine. This attribute is used with "dn" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.</xs:documentation>         </xs:annotation>       </xs:attribute>       <xs:attribute name="dn" type="xs:string" use="optional">         <xs:annotation>           <xs:documentation>DN of the LDAP entry for which the resource originates. This attribute is used with "alias" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.             </xs:documentation>         </xs:annotation>       </xs:attribute>     </xs:extension>   </xs:complexContent> </xs:complexType>

attribute XmlEntityDetail/@resource-type

type	ResourceType
properties	default  HUMAN
facets	Kind  Value  Annotation enumeration  DURABLE enumeration  CONSUMABLE enumeration  HUMAN
annotation	documentation Resouce type of this entity (for entities of type RESOURCE).
source	<xs:attribute name="resource-type" type="ResourceType" default="HUMAN">   <xs:annotation>     <xs:documentation>Resouce type of this entity (for entities of type RESOURCE).</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlEntityDetail/@alias

type	xs:string
properties	use  optional
annotation	documentation Alias name by which the LDAP connection (from which the resource originates) is registered with Directory Engine. This attribute is used with "dn" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.
source	<xs:attribute name="alias" type="xs:string" use="optional">   <xs:annotation>     <xs:documentation>Alias name by which the LDAP connection (from which the resource originates) is registered with Directory Engine. This attribute is used with "dn" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.</xs:documentation>   </xs:annotation> </xs:attribute>

attribute XmlEntityDetail/@dn

type	xs:string
properties	use  optional
annotation	documentation DN of the LDAP entry for which the resource originates. This attribute is used with "alias" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.
source	<xs:attribute name="dn" type="xs:string" use="optional">   <xs:annotation>     <xs:documentation>DN of the LDAP entry for which the resource originates. This attribute is used with "alias" to locate the resource's entry in the LDAP directory. The attribute is only relevant for entities of type RESOURCE.             </xs:documentation>   </xs:annotation> </xs:attribute>

element XmlEntityDetail/groups

diagram
type	xs:string
properties	minOcc  0 maxOcc  unbounded content  simple
annotation	documentation GUIDs of the groups to which this resource belongs. This attribute is only relevant for entities of type RESOURCE.
source	<xs:element name="groups" type="xs:string" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>GUIDs of the groups to which this resource belongs. This attribute is only relevant for entities of type RESOURCE.               </xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/org-units

diagram
type	xs:string
properties	minOcc  0 maxOcc  unbounded content  simple
annotation	documentation GUIDs of the organization units to which this resource belongs, via the positions to which it belongs. This attribute is only relevant for entities of type RESOURCE.
source	<xs:element name="org-units" type="xs:string" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>GUIDs of the organization units to which this resource belongs, via the positions to which it belongs. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/positions

diagram
type	xs:string
properties	minOcc  0 maxOcc  unbounded content  simple
annotation	documentation GUIDs of the positions to which this resource belongs. This attribute is only relevant for entities of type RESOURCE.
source	<xs:element name="positions" type="xs:string" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>GUIDs of the positions to which this resource belongs. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/privileges

diagram
type	xs:string
properties	minOcc  0 maxOcc  unbounded content  simple
annotation	documentation GUIDs of the privileges currently held by this resource. This attribute is only relevant for entities of type RESOURCE.
source	<xs:element name="privileges" type="xs:string" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>GUIDs of the privileges currently held by this resource. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/capabilities

diagram
type	xs:string
properties	minOcc  0 maxOcc  unbounded content  simple
annotation	documentation GUIDs of the capabilities currently associated with this resource. This attribute is only relevant for entities of type RESOURCE.
source	<xs:element name="capabilities" type="xs:string" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>GUIDs of the capabilities currently associated with this resource. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/queries

diagram
type	xs:string
properties	minOcc  0 maxOcc  unbounded content  simple
annotation	documentation GUIDs of the queries currently associated with this resource. This attribute is only relevant for entities of type RESOURCE.
source	<xs:element name="queries" type="xs:string" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>GUIDs of the queries currently associated with this resource. This attribute is only relevant for entities of type RESOURCE.</xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/selection-mode

diagram
type	SelectionMode
properties	minOcc  0 maxOcc  1 content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation method   AllocationMethod   required         documentation Algorithm used to select a resource. One of: - ANY: use random selection. - NEXT: use iterative selection. - THIS: use the specifically identified resource. - PLUGIN: use the named plugin code (where the name is given separately) to perform the selection. plugin   xs:string            documentation Name of plugin.
annotation	documentation Default algorithm used to select a resource from those associated with this organization model entity. This attribute is only relevant for entities of type GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION.
source	<xs:element name="selection-mode" type="SelectionMode" minOccurs="0">   <xs:annotation>     <xs:documentation>Default algorithm used to select a resource from those associated with this organization model entity. This attribute is only relevant for entities of type GROUP, ORGANIZATION, ORGANIZATIONAL_UNIT, POSITION and LOCATION.</xs:documentation>   </xs:annotation> </xs:element>

element XmlEntityDetail/ldap-containers

diagram
type	AdminLDAPContainer
properties	minOcc  0 maxOcc  unbounded content  complex
attributes	Name   Type   Use   Default   Fixed   Annotation id   xs:long   required         documentation Unique ID reference of the LDAP container. name   xs:string            documentation Unique name of the LDAP container.
annotation	documentation (Optional) Lists the LDAP Containers that can map resources to this Organisation. This element is only relevant for ORGANIZATION entity types.
source	<xs:element name="ldap-containers" type="AdminLDAPContainer" minOccurs="0" maxOccurs="unbounded">   <xs:annotation>     <xs:documentation>(Optional) Lists the LDAP Containers that can map resources to this Organisation. This element is only relevant for ORGANIZATION entity types.</xs:documentation>   </xs:annotation> </xs:element>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy