complexType XmlOrgUnit

diagram |
namespace | http://base.api.de.bpm.tibco.com
type | extension of XmlBaseOrgUnit
properties |
base | XmlBaseOrgUnit
children | schema-type allocation-method location-ref privilege-holding attribute push-destination extension-point instance-id-attr position org-unit
used by |
elements | getOrgModelEntityResponse/org-unit XmlOrgUnit/org-unit XmlOrganization/org-unit
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
name | xs:string | required |  |  |
documentation
The name assigned to the entity.
label | xs:string | optional |  |  |
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
calendar-alias | xs:string | optional |  |  |
documentation
The alias of the calendar that this org-unit will use for deadline calculations. This information is only included if requested as part of the request parameters.
dynamic | xs:boolean | optional |  |  |
documentation
Returns true if this entity was dynamically generated as a result of an Organisational Model Extension Point; rather than part of an org-model deployment.
extension-point | xs:boolean | optional |  |  |
documentation
Only used in the org-model drill-down API. Returns true if this Org-Unit has been designated as an Extension Point.
annotation |
documentation
Describes an organization model organization unit and the associated entities.
source | <xs:complexType name="XmlOrgUnit"> <xs:annotation> <xs:documentation>Describes an organization model organization unit and the associated entities.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="XmlBaseOrgUnit"> <xs:sequence> <xs:element name="extension-point" type="XmlExtensionPointSetting" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Marks this entity as being an Organisation Extension Point; and provides the configuration details of that Extension Point.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="instance-id-attr" type="XmlModelInstanceIdValue" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Only used for Dynamic Model-Template instances. Makes up one element of the Model-Template Identity; each element being a named attribute linked to a named LDAP attribute. These elements are only included for the root org-unit of a Model-Template instance.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="position" type="XmlPosition" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Describes the positions contained within this organization unit.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="org-unit" type="XmlOrgUnit" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Describes the organization units contained within this organization unit (the sub-organization units). Each organization unit described may have further sub-organization units.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="dynamic" type="xs:boolean" use="optional"> <xs:annotation> <xs:documentation>Returns true if this entity was dynamically generated as a result of an Organisational Model Extension Point; rather than part of an org-model deployment. </xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="extension-point" type="xs:boolean" use="optional"> <xs:annotation> <xs:documentation>Only used in the org-model drill-down API. Returns true if this Org-Unit has been designated as an Extension Point. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType>

attribute XmlOrgUnit/@dynamic

type | xs:boolean
properties |
use | optional
annotation |
documentation
Returns true if this entity was dynamically generated as a result of an Organisational Model Extension Point; rather than part of an org-model deployment.
source | <xs:attribute name="dynamic" type="xs:boolean" use="optional"> <xs:annotation> <xs:documentation>Returns true if this entity was dynamically generated as a result of an Organisational Model Extension Point; rather than part of an org-model deployment. </xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlOrgUnit/@extension-point

type | xs:boolean
properties |
use | optional
annotation |
documentation
Only used in the org-model drill-down API. Returns true if this Org-Unit has been designated as an Extension Point.
source | <xs:attribute name="extension-point" type="xs:boolean" use="optional"> <xs:annotation> <xs:documentation>Only used in the org-model drill-down API. Returns true if this Org-Unit has been designated as an Extension Point. </xs:documentation> </xs:annotation> </xs:attribute>

element XmlOrgUnit/extension-point

diagram |
type | XmlExtensionPointSetting
properties |
minOcc | 0
maxOcc | 1
content | complex
children | instance-id-attr
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
Identifies the LDAP Connection on which the LDAP Query will be performed.
query | xs:string | required |  |  |
documentation
This LDAP Query expression will locate entries that identify new model template instances.
base-dn | xs:string | optional |  |  |
documentation
Optionally names the LDAP branch to which the LDAP Query will be restricted. This will be in addition to any Base-DN already specified on the LDAP Connection.
search-scope | XmlLdapSearchScope | required |  |  |
documentation
The Search Scope determines the depth to which the search will be performed.
ldap-attribute | xs:string | required |  |  |
documentation
Names the LDAP Attribute from which the name of the new Model Template Instance will be taken. The root Organisation-Unit of the Model Template Instance will be named with the value of this attribute.
model-template | xs:string |  |  |  |
documentation
Identifies the Model Template entity to which this Extension Point refers.
complete | xs:boolean |  | true |  |
documentation
Indicates whether this Extension Point configuration is complete. If false then it will require configuration before it is used to generate dynamic org-model fragments.
annotation |
documentation
Marks this entity as being an Organisation Extension Point; and provides the configuration details of that Extension Point.
source | <xs:element name="extension-point" type="XmlExtensionPointSetting" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Marks this entity as being an Organisation Extension Point; and provides the configuration details of that Extension Point.</xs:documentation> </xs:annotation> </xs:element>

element XmlOrgUnit/instance-id-attr

diagram |
type | XmlModelInstanceIdValue
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | xs:string | required |  |  |
documentation
Names the model-template instance ID attribute that will take its value from the named LDAP Attribute.
value | xs:string | optional |  |  |
documentation
The value of the LDAP Attribute from which the model-template instance ID will be constructed. If the named LDAP Attribute holds many values, only one will be chosen - at random.
annotation |
documentation
Only used for Dynamic Model-Template instances. Makes up one element of the Model-Template Identity; each element being a named attribute linked to a named LDAP attribute. These elements are only included for the root org-unit of a Model-Template instance.
source | <xs:element name="instance-id-attr" type="XmlModelInstanceIdValue" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Only used for Dynamic Model-Template instances. Makes up one element of the Model-Template Identity; each element being a named attribute linked to a named LDAP attribute. These elements are only included for the root org-unit of a Model-Template instance.</xs:documentation> </xs:annotation> </xs:element>

element XmlOrgUnit/position

diagram |
type | XmlPosition
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | schema-type allocation-method location-ref req-capability privilege-holding attribute push-destination candidate-query
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
name | xs:string | required |  |  |
documentation
The name assigned to the entity.
label | xs:string | optional |  |  |
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
ideal-number | xs:int | required |  |  |
documentation
For modelling purposes only, this returns the ideal number of resources that should be assigned to this Position. A position can be filled by any number of human resources, but an ideal number can be specified. This ideal number is merely an indication, and a lower or higher number of human resource assignments can be made.
calendar-alias | xs:string | optional |  |  |
documentation
The alias of the calendar that this position will use for deadline calculations. This information is only included if requested as part of the request parameters.
candidate-query | xs:boolean | optional |  |  |
documentation
Only used in the org-model drill-down API. Returns true if this Position holds a Candidate Query configuration.
resource-count | xs:int | optional | 0 |  |
documentation
Reports the number of resources assigned to this position. This information is only included if requested as part of the request parameters.
dynamic | xs:boolean | optional |  |  |
documentation
Returns true if this Position was dynamically generated as a result of an Organisational Model Extension Point; rather than part of an org-model deployment.
annotation |
documentation
Describes the positions contained within this organization unit.
source | <xs:element name="position" type="XmlPosition" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Describes the positions contained within this organization unit.</xs:documentation> </xs:annotation> </xs:element>

element XmlOrgUnit/org-unit

diagram |
type | XmlOrgUnit
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | schema-type allocation-method location-ref privilege-holding attribute push-destination extension-point instance-id-attr position org-unit
attributes |
Name | Type | Use | Default | Fixed | Annotation
guid | xs:string | required |  |  |
documentation
The GUID that uniquely identifies the entity.
name | xs:string | required |  |  |
documentation
The name assigned to the entity.
label | xs:string | optional |  |  |
documentation
The optional label assigned to the entity. This is used for display purposes. If not given, the name is used for display.
calendar-alias | xs:string | optional |  |  |
documentation
The alias of the calendar that this org-unit will use for deadline calculations. This information is only included if requested as part of the request parameters.
dynamic | xs:boolean | optional |  |  |
documentation
Returns true if this entity was dynamically generated as a result of an Organisational Model Extension Point; rather than part of an org-model deployment.
extension-point | xs:boolean | optional |  |  |
documentation
Only used in the org-model drill-down API. Returns true if this Org-Unit has been designated as an Extension Point.
annotation |
documentation
Describes the organization units contained within this organization unit (the sub-organization units). Each organization unit described may have further sub-organization units.
source | <xs:element name="org-unit" type="XmlOrgUnit" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Describes the organization units contained within this organization unit (the sub-organization units). Each organization unit described may have further sub-organization units.</xs:documentation> </xs:annotation> </xs:element>

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