complexType XmlEntityMapping

diagram |
namespace | http://api.de.n2.tibco.com
children | target create remove
annotation |
documentation
Definition of a target organization model entity (a position or group) and the resources that are to be mapped to (created) or removed from it. A collection of these elements form the request to the MapEntities operation in the Mapping service.
source | <xs:complexType name="XmlEntityMapping"> <xs:annotation> <xs:documentation>Definition of a target organization model entity (a position or group) and the resources that are to be mapped to (created) or removed from it. A collection of these elements form the request to the MapEntities operation in the Mapping service.</xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="target" type="orgdto:XmlModelEntityId"> <xs:annotation> <xs:documentation>Target organization model entity (a position or group) to which resources should be mapped (created), or from which they should or removed.</xs:documentation> </xs:annotation> </xs:element> <xs:choice> <xs:element name="create" type="XmlLdapEntity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of the resources to be mapped to the target organization model entity. A new resource will be created if no existing resource can be found for the specified organization model guid or LDAP entry identifier (ldap-dn).</xs:documentation> </xs:annotation> </xs:element> <xs:element name="remove" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of the resources to be removed from the target organization model entity.</xs:documentation> </xs:annotation> </xs:element> </xs:choice> </xs:sequence> </xs:complexType>

element XmlEntityMapping/target

diagram |
type | XmlModelEntityId
properties |
content | complex
children | dynamic-id-attr qualifierSet
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.
annotation |
documentation
Target organization model entity (a position or group) to which resources should be mapped (created), or from which they should or removed.
source | <xs:element name="target" type="orgdto:XmlModelEntityId"> <xs:annotation> <xs:documentation>Target organization model entity (a position or group) to which resources should be mapped (created), or from which they should or removed.</xs:documentation> </xs:annotation> </xs:element>

element XmlEntityMapping/create

diagram |
type | XmlLdapEntity
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | LdapReference
attributes |
Name | Type | Use | Default | Fixed | Annotation
resource-type | ResourceType |  | HUMAN |  |
documentation
Specifies the type of an organization model resource entity. One of: - HUMAN - DURABLE - CONSUMABLE
guid | xs:string | optional |  |  |
documentation
Unique identifier of the resource.
name | xs:string | optional |  |  |
documentation
Descriptive name of the resource.
startDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes available.
endDate | xs:dateTime | optional |  |  |
documentation
Date/time at which the entity becomes unavailable.
invalid | xs:boolean |  |  |  |
documentation
Boolean value indicating whether the resource is valid (FALSE) or invalid (TRUE). A resource may be invalid if, for example, the resource has been removed from the LDAP source, or if all of the data cannot be returned from the LDAP source. Check the invalidReason attribute for more details.
invalidReason | xs:string |  |  |  |
documentation
Description of the reason why this resource is invalid.
annotation |
documentation
Details of the resources to be mapped to the target organization model entity. A new resource will be created if no existing resource can be found for the specified organization model guid or LDAP entry identifier (ldap-dn).
source | <xs:element name="create" type="XmlLdapEntity" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of the resources to be mapped to the target organization model entity. A new resource will be created if no existing resource can be found for the specified organization model guid or LDAP entry identifier (ldap-dn).</xs:documentation> </xs:annotation> </xs:element>

element XmlEntityMapping/remove

diagram |
type | XmlModelEntityId
properties |
minOcc | 0
maxOcc | unbounded
content | complex
children | dynamic-id-attr qualifierSet
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.
annotation |
documentation
Details of the resources to be removed from the target organization model entity.
source | <xs:element name="remove" type="orgdto:XmlModelEntityId" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>Details of the resources to be removed from the target organization model entity.</xs:documentation> </xs:annotation> </xs:element>

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