complexType XmlGroup

diagram |
namespace | http://base.api.de.bpm.tibco.com
type | extension of XmlModelEntity
properties |
base | XmlModelEntity
children | allocation-method group req-capability privilege-holding push-destination candidate-query
used by |
elements | getOrgModelRootsResponse/group getOrgModelEntityResponse/group getOrgModelResponse/group XmlGroup/group
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.
resource-count | xs:int | optional | 0 |  |
documentation
Reports the number of resources assigned to this group. This information is only included if requested as part of the request parameters.
calendar-alias | xs:string | optional |  |  |
documentation
The alias of the calendar that this group 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 Group holds a Candidate Query configuration.
annotation |
documentation
Describes an org-model Group and the associated entities.
source | <xs:complexType name="XmlGroup"> <xs:annotation> <xs:documentation>Describes an org-model Group and the associated entities.</xs:documentation> </xs:annotation> <xs:complexContent> <xs:extension base="XmlModelEntity"> <xs:sequence> <xs:element name="allocation-method" type="XmlSelectionMode" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Describes the method of work allocation for this group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="group" type="XmlGroup" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Creates a nested collection of sub-groups for this group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="req-capability" type="XmlEntityAssignmentQualified" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies a capability assignment that forms the collection of capabilities required to join this group.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="privilege-holding" type="XmlEntityAssignmentQualified" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the privileges held by this group, and any qualifier values that may apply.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="push-destination" type="XmlPushDestination" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Describes a Push Destinations, used to push work-items to Resources.</xs:documentation> </xs:annotation> </xs:element> <xs:element name="candidate-query" type="XmlCandidateQuery" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The optional query that will identify candidate Resource for this Group.</xs:documentation> </xs:annotation> </xs:element> </xs:sequence> <xs:attribute name="resource-count" type="xs:int" use="optional" default="0"> <xs:annotation> <xs:documentation>Reports the number of resources assigned to this group. This information is only included if requested as part of the request parameters.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="calendar-alias" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>The alias of the calendar that this group will use for deadline calculations. This information is only included if requested as part of the request parameters.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="candidate-query" type="xs:boolean" use="optional"> <xs:annotation> <xs:documentation>Only used in the org-model drill-down API. Returns true if this Group holds a Candidate Query configuration. </xs:documentation> </xs:annotation> </xs:attribute> </xs:extension> </xs:complexContent> </xs:complexType>

attribute XmlGroup/@resource-count

type | xs:int
properties |
use | optional
default | 0
annotation |
documentation
Reports the number of resources assigned to this group. This information is only included if requested as part of the request parameters.
source | <xs:attribute name="resource-count" type="xs:int" use="optional" default="0"> <xs:annotation> <xs:documentation>Reports the number of resources assigned to this group. This information is only included if requested as part of the request parameters.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlGroup/@calendar-alias

type | xs:string
properties |
use | optional
annotation |
documentation
The alias of the calendar that this group will use for deadline calculations. This information is only included if requested as part of the request parameters.
source | <xs:attribute name="calendar-alias" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>The alias of the calendar that this group will use for deadline calculations. This information is only included if requested as part of the request parameters.</xs:documentation> </xs:annotation> </xs:attribute>

attribute XmlGroup/@candidate-query

type | xs:boolean
properties |
use | optional
annotation |
documentation
Only used in the org-model drill-down API. Returns true if this Group holds a Candidate Query configuration.
source | <xs:attribute name="candidate-query" type="xs:boolean" use="optional"> <xs:annotation> <xs:documentation>Only used in the org-model drill-down API. Returns true if this Group holds a Candidate Query configuration. </xs:documentation> </xs:annotation> </xs:attribute>

element XmlGroup/allocation-method

diagram |
type | XmlSelectionMode
properties |
minOcc | 0
maxOcc | 1
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
method | XmlAllocationMethod | 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 | optional |  |  |
documentation
Name of custom plugin implementation.
annotation |
documentation
Describes the method of work allocation for this group.
source | <xs:element name="allocation-method" type="XmlSelectionMode" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>Describes the method of work allocation for this group.</xs:documentation> </xs:annotation> </xs:element>

element XmlGroup/group

diagram |
type | XmlGroup
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | allocation-method group req-capability privilege-holding 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.
resource-count | xs:int | optional | 0 |  |
documentation
Reports the number of resources assigned to this group. This information is only included if requested as part of the request parameters.
calendar-alias | xs:string | optional |  |  |
documentation
The alias of the calendar that this group 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 Group holds a Candidate Query configuration.
annotation |
documentation
Creates a nested collection of sub-groups for this group.
source | <xs:element name="group" type="XmlGroup" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Creates a nested collection of sub-groups for this group.</xs:documentation> </xs:annotation> </xs:element>

element XmlGroup/req-capability

diagram |
type | XmlEntityAssignmentQualified
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | qualifier-value
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.
annotation |
documentation
Identifies a capability assignment that forms the collection of capabilities required to join this group.
source | <xs:element name="req-capability" type="XmlEntityAssignmentQualified" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies a capability assignment that forms the collection of capabilities required to join this group.</xs:documentation> </xs:annotation> </xs:element>

element XmlGroup/privilege-holding

diagram |
type | XmlEntityAssignmentQualified
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | qualifier-value
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.
annotation |
documentation
Identifies the privileges held by this group, and any qualifier values that may apply.
source | <xs:element name="privilege-holding" type="XmlEntityAssignmentQualified" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Identifies the privileges held by this group, and any qualifier values that may apply.</xs:documentation> </xs:annotation> </xs:element>

element XmlGroup/push-destination

diagram |
type | XmlPushDestination
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | value
attributes |
Name | Type | Use | Default | Fixed | Annotation
name | xs:string | required |  |  |
documentation
The name of the push destination.
channel-type | ChannelType | required |  |  |
documentation
Enumerated type defining the presentation technology used by the channel associated with this push destination.
channel-id | xs:string | required |  |  |
documentation
Unique ID of the channel associated with this push destination.
enabled | xs:boolean | required |  |  |
documentation
Boolean value indicating whether this push destination is currently enabled (TRUE) or not (FALSE).
resource-attr-guid | xs:string | optional |  |  |
documentation
Unique ID of a resource attribute whose value should be used for the push destination. The parameter descriptor must be assigned to the organization model entity for whom the push destination is being set. If a value is assigned to both this attribute and the "value" element, the value of this attribute will be used.
annotation |
documentation
Describes a Push Destinations, used to push work-items to Resources.
source | <xs:element name="push-destination" type="XmlPushDestination" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Describes a Push Destinations, used to push work-items to Resources.</xs:documentation> </xs:annotation> </xs:element>

element XmlGroup/candidate-query

diagram |
type | XmlCandidateQuery
properties |
minOcc | 0
maxOcc | 1
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
container-id | xs:long | required |  |  |
documentation
Identifies the LDAP Container whose the Primary LDAP Source will be used to evaluate the query.
query | xs:string | optional |  |  |
documentation
The LDAP Query that will be combined with the query of the Primary LDAP Source to identify candidate Resources.
base-dn | xs:string | optional |  |  |
documentation
(Optional) Provides an additional base DN that will be used to restrict the scope of the Candidate Query. This base DN is relative to, and in additon, to any base DN of the LDAP Container's primary LDAP Source.
search-scope | XmlLdapSearchScope | optional |  |  |
documentation
Enumerated value indicating the scope on which an LDAP search is to be performed.
annotation |
documentation
The optional query that will identify candidate Resource for this Group.
source | <xs:element name="candidate-query" type="XmlCandidateQuery" minOccurs="0" maxOccurs="1"> <xs:annotation> <xs:documentation>The optional query that will identify candidate Resource for this Group.</xs:documentation> </xs:annotation> </xs:element>

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