entitlement

An entitlement definition that is stored in the XmlData attribute of a DirXML-Entitlement object. The actual name of the entitlement comes from the RDN of the DirXML-Entitlement object. The entitlement definition defines a display name and description for the entitlement for use in UI agents, and can define whether or not an entitlement requires a single parameter value. If a parameter value is required, then it is possible to specify a list of possible values for that parameter value, or a query that can be issued to the associated application in order to get a list of possible parameters values.

Example

<entitlement conflict-resolution="union"    description="Recipient is entitled to an account in the connected application"    display-name="User Account"/><entitlement conflict-resolution="union"    description="Groups that the recipient is entitled to belong to in the connected application"    display-name="Group Membership">  <values>    <query-app>      <query-xml>        <nds dtd-version="2.0">          <input>            <query class-name="Group" scope="subtree">              <search-class class-name="Group"/>              <read-attr attr-name="Description"/>            </query>          </input>        </nds>      </query-xml>      <result-set>        <display-name>          <token-src-dn/>        </display-name>        <description>          <token-attr attr-name="Description"/>        </description>        <ent-value>          <token-association/>        </ent-value>      </result-set>    </query-app>  </values></entitlement><entitlement conflict-resolution="priority"    description="The Musical Instrument played by the recipient"    display-name="Musical Instrument">  <values multi-valued="false">    <value>Trumpet</value>    <value>Clarinet</value>    <value>Tuba</value>    <value>Trombone</value>    <value>Flute</value>    <value>Violin</value>  </values></entitlement>

Allowed Content

Element	Description
values	Legal values of the entitlement.

Attributes

Attribute	Possible Values	Default Value
conflict-resolution	priority \| union The conflict resolution method to be used by the Entitlements driver when the entitlement is used in conjunction with Role-based Entitlements and is granted via more than one role. union: The parameter values of all the granting roles are granted to the recipient. priority: Only the parameter values of the granting role with the highest priority are granted to the recipient.	priority
description	CDATA The description for the entitlement that should be displayed by a UI agent.	#REQUIRED
display-name	CDATA The name for the entitlement that should be displayed by a UI agent.	#REQUIRED

Attribute

Possible Values

Default Value

conflict-resolution

priority | union

The conflict resolution method to be used by the Entitlements driver when the entitlement is used in conjunction with Role-based Entitlements and is granted via more than one role.

union: The parameter values of all the granting roles are granted to the recipient.

priority: Only the parameter values of the granting role with the highest priority are granted to the recipient.

priority

description

CDATA

The description for the entitlement that should be displayed by a UI agent.

#REQUIRED

display-name

CDATA

The name for the entitlement that should be displayed by a UI agent.

#REQUIRED

Content Rule

( values ? )

Parent Elements

None