12.3 Creating Entitlements through the Entitlement Wizard

Designer comes with an Entitlement Wizard. This wizard steps you through the creation of entitlements by asking a series of questions about how the entitlement will be used in the enterprise. Use one of the following methods to access the Entitlement Wizard:

From the Outline View

To access the Entitlement Wizard from the Outline view, right-click a Driver object, then click New > Entitlement.

Figure 12-3 Adding an Entitlement through the Outline View

From the Modeler View

To access the Entitlement Wizard from the Modeler view, right-click the driver icon, then click New > Entitlement.

There are two types of entitlements that you can create: valueless and valued. The type you use depends on whether you need to pass additional information to the policies.

12.3.1 Valueless Entitlements

A valueless entitlement has no values to go with it. An example is the Account Entitlement for Active Directory, which is used to turn on account capabilities. You use valueless entitlements if you don’t need to pass any extra information to driver policies.

To create a valueless entitlement:

  1. Right-click the driver icon in the Outline view or in the Modeler view, then click New > Entitlement.

    Creating an account entitlement
  2. Type the name and description information. For this example, the entitlement is named Account, with a description of “This is an Account Entitlement.” Click Next.

    Setting whether to include values
  3. Because this first example is valueless, select No to Do you want this entitlement to include values?

  4. Click Finish.

  5. In the Add To Filter dialog box, answer Yes if you want the driver to listen for this entitlement. This enables entitlements for the driver.

    Enabling entitlements

    The DirXML-EntitlementRef attribute allows the driver filter to listen for entitlement activities. This is necessary in order to use the entitlements you are creating.

    If you don’t want to see the Add To Filter window on every entitlement you are creating for any driver in Designer, select Remember Selection - Don’t Prompt Again, then click OK. However, after the attribute is added to this driver filter, you won’t see the Add To Filter window again.

    If you have a file conflict, you are asked to save the editor’s changes before continuing. Once the editor is saved, the entitlement displays in the Modeler view.

12.3.2 Valued Entitlement that Queries an External Application

Values are a way of passing data that you might need to use in policies. Valued entitlements can get their values from an external query; they can be administrator-defined, or they can be free-form.

  1. Right-click the driver icon in the Outline view or in the Modeler view, then click New > Entitlement.

  2. Give the entitlement a name. This example uses Application Query, with the Use Name for Display Name option selected. In the Description box, type Looks for the Class name of Groupx, then click Next.

    Creating an Application Query entitlement
  3. On the Set Entitlements Values page, select Yes so you can query values from an application or define a group of values, then click Next.

  4. The next Set Entitlements Values page allows you to define where you get the values for this entitlement. Valued entitlements can get their values from an external query, or they can be administrator-defined. For this example, select the Values from an application query option, then click Next.

    Select values from application query

    The Define Application Query window combines two steps: defining the query and mapping the query results.

  5. To fill in the Class Query, click the Schema Browser button on the right side of the Class entry.

    Using the schema browser
  6. The Schema Browser shows you the Classes in the eDirectory namespace that are available. If you know the name of the Class type you want to query, click to select a selection in the Classes tab, then start typing the Class name. The browser jumps to the alphabetical order of what you type. Select the Class name, then click OK.

    Defining the application query
  7. Type the base distinguished name (DN) and the scope. For this example, select the Class Group, at the Base Distinguished Name of Blanston, with the Scope of subtree (choices are subtree, entry, and subordinates).

    This example maps the query results from the connected system to certain values that entitlement consumers can use. At present, the consumers are iManager managing Role-Based Entitlement policies and the User Application managing workflow-based provisioning entitlements. The Value From Query information pre-populates the consumer’s user interface with the following:

    • Display Name: Defines the attribute that displays in the list of values. The example selects Source Distinguished Name for the display name. Click the drop-down button on the Display Name shown to entitlement consumers list to see a list of Attributes associated with the class you selected through the Schema Browser. The list includes both the Attributes and the Inherited Attributes for the selected class.

    • Description: Defines the attribute that displays as a description for that value. For the description, select Description from the Value drop-down list to map the query results from the connected system to the entitlement.

    • Value: Defines the attribute or token that is the actual value. The Value entry is not seen in the entitlement consumer, but it is the value that is assigned when the entitlement is granted or revoked. In this case, choose Association.

    If you do not use the Schema Browser button when selecting the class, you see only two selections in the Value From Query lists: Association and Source Distinguished Name. If these attributes suit your needs, use them. You can also type the attribute name into the text field. However, if you want to select the attributes from the lists, use the Schema Browser button when selecting a class for the query. You see the attributes and inherited attributes for the selected class.

  8. When the values are filled out, select Next.

  9. In the Assign Multiple Values window, select Yes if you want the entitlements to be granted more than once and with different values. If you select No, the entitlement can only be granted once. For this example, click Yes, then click Next.

    It makes sense to assign group entitlements with multiple values, but it would not make sense to assign an account entitlement more than once.

  10. You are asked if this entitlement is intended to be used by Role-Based Entitlement policies through iManager. If you want this entitlement to be granted or revoked automatically, select Yes to the Role-Based Entitlements question, click Next, then continue with Step 11.

    or

    If you want the granting or revoking of this entitlement to be a manual process (approved by someone), select No to use the User Application, then skip to Step 12.

    We recommend that you have only one agent control an entitlement. If multiple agents are in control, you have the following consequences:

    • Whoever comes last controls the entitlement results

    • Results are unpredictable

    • Using both agents to control an entitlement is not supported by Novell

  11. (Conditional) If you select Yes to the Role-Based Entitlements question, you are asked if you want to use the Role-Based Entitlements priority to resolve any conflicts that might happen when this entitlement is assigned more than once with different values. You can resolve the conflict by either using Role-Based Entitlements priority, or by merging the values.

    Merging the values merges the entitlements of all involved Role-Based Entitlement policies, so if one policy revokes an entitlement but another policy grants an entitlement, the entitlement is eventually granted. Solving conflicts by priority works if you need to ensure that only one policy is applied to this entitlement at any time. This example uses priority.

  12. Click Finish.

    For this example, the query values look for the Source Distinguished Name attribute of the Class name of Group, starting from the Base DN (Blanston) and checking through the subtree from that beginning point. The values that come back from the query are similar to the following:

    <instance class-name="Group" src-dn="o=Blanston,cn=group1">
       <association>o=Blanston,cn=group1</association>
       <attr attr-name="Description"> the description for group1</attr>
    </instance>
    <instance class-name="Group" src-dn="o=Blanston,cn=group2">
       <association>o=Blanston,cn=group2</association>
       <attr attr-name="Description"> the description for group2</attr>
    </instance>
    <instance class-name="Group" src-dn="o=Blanston,cn=group3">
       <association>o=Blanston, cn=group3</association>
       <attr attr-name="Description"> the description for group3</attr>
    </instance>
    <!-- ... ->
    

    The information received from the query fills in the various fields. For instance, the <display-name> field receives o=Blanston,cn=group1. The <description> field receives the description for Group1, and the <ent-value> field receives o=Blanston,cn=group1. Because more than one group exists and meets the query criteria, this information is also collected and shown as other instances of the query.

    The association format value is unique for every external system, so the format and syntax are different for each external system queried.

  13. In the Add To Filter window, click Yes if you want the driver to listen for this entitlement. This enables entitlements for the driver.

    Enabling entitlements

    The DirXML-EntitlementRef attribute allows the driver filter to listen for entitlement activities. This is necessary in order to use the entitlements you are creating.

    If you don’t want to see the Add To Filter window on entitlements you are creating for any driver in Designer, select Remember Selection - Don’t Prompt Again, then click OK. However, after the attribute is added to this driver filter, you won’t see the Add To Filter window again.

    If you have a file conflict, you are asked to save the editor’s changes before continuing. Once the editor is saved, the entitlement displays in the Modeler view.

12.3.3 Administrator-Defined Entitlements with Lists

The example in the following procedure is an administrator-defined entitlement that allows you to select a listed entry. This type of entitlement is best used through Workflow entitlements rather than Role-Based Entitlements.

  1. Right-click the driver icon in the Outline view or the Modeler view, then click New > Entitlement.

    Creating an admin-defined entitlement

    In this example, the entitlement name is Admin-defined, but the defined display name is Admin-defined Entitlement. You need to define a display name only if you want the display name to be different from the name you called the entitlement; otherwise, you can just use the entitlement name as the display name. In this example, the Description field is defined as This will show Administrator-defined Values.

  2. Click Next.

  3. In the Set Entitlement Values window, select Yes to the question “Do you want this entitlement to include values?” Click Next.

  4. In the next Set Entitlement Values window, select Administrator Defined Values, then click Next.

  5. In the Define Values window, type the values you want to add to the Entitlement Value entry, click Add to add the value to the Defined List pane, then click Next.

    Defining a list of values

    In this example, the values are corporate buildings: Building A through Building D. Through an entitlement client, such as an iManager Role-Based Entitlement task or through the user application, users or defined-task managers can specify the building information, which is then included in an external application, such as Novell eDirectory.

    Use the Remove button to remove a value, or use the Edit button to edit a value.

  6. In the Assign Multiple Values window, select Yes if you want the entitlements to be granted more than once and with different values. If you select No, the entitlement can only be granted once. For the example, click No, then click Next.

    It makes sense to assign group entitlements with multiple values, but it does not make sense to assign building letters more than once.

  7. You are asked if this entitlement is intended to be used by Role-Based Entitlement policies through iManager. If you want this entitlement to be granted or revoked automatically, select Yes to the Role-Based Entitlements question, click Next, then continue with Step 8.

    or

    If you want the granting or revoking of this entitlement to be a manual process (approved by someone), select No to use the User Application, then skip to Step 9.

    We recommend that you have only one agent control an entitlement. If multiple agents are in control, you have the following consequences:

    • Whoever comes last controls the entitlement results

    • Results are unpredictable

    • Using both agents to control an entitlement is not supported by Novell

  8. (Conditional) If you select Yes to the Role-Based Entitlements question, you are asked if you want to use the Role-Based Entitlements priority to resolve any conflicts that might happen when this entitlement is assigned by different Role-Based Entitlement Policies with different values. You can resolve the conflict by either using the Role-Based Entitlements priority, or by merging the values. This example merges the values.

    Merging the values merges the entitlements of all involved Role-Based Entitlement policies, so if one policy revokes an entitlement but another policy grants an entitlement, the entitlement is eventually granted. Solving conflicts by priority works if you need to ensure that only one policy is applied to this entitlement at any time.

  9. Click Finish.

  10. If you see the Add To Filter window, answer Yes if you want the driver to listen for this entitlement. This enables entitlements for the driver. The DirXML-EntitlementRef attribute allows the driver filter to listen for entitlement activities, which is necessary in order to use the entitlements you are creating.

    Or

    If you don’t want to see the Add To Filter window on entitlements you are creating for any driver in Designer, select Remember Selection - Don’t Prompt Again, then click OK. However, after the attribute is added to this driver filter, you won’t see the Add To Filter window again.

Before you can edit this entitlement, you are asked to save the editor’s changes before continuing. Once the editor is saved, the entitlement displays in the Modeler view.

12.3.4 Administrator-Defined Entitlements without Lists

The example in the following procedure is an administrator-defined entitlement that forces the administrator to type a value. You can use this kind of entitlement if you do not have all of the information at the initial setup, so you cannot create a task list.

  1. Right-click the driver icon in the Outline view or the Modeler view, then click New > Entitlement.

    Creating an admin-defined No Lists entitlement

    In this example, the entitlement name is Admin-defined (no lists), and it uses the entitlement name as the displayed name because the Use Name For Display Name option is selected.

  2. Click Next.

  3. Select Yes on the Set Entitlement Values page, then click Next.

  4. Select Administrator Defined Values on the second Set Entitlement Values page, then click Next.

  5. Select No to the question “Do you want to define a list of values?” on the Define Values page, then click Next.

    Selecting this option allows the administrator or users to type in a value. Using this option can be risky however since wrong or mispelled information can cause the vaule to be incorrect and the action in the entitlement to fail.

  6. Select No to the question “Allow this entitlement to be assigned multiple times with different values?” on the Assign Multiple Values page, then click Next.

  7. You are asked if this entitlement is intended to be used by Role-Based Entitlement policies through iManager. If you want this entitlement to be granted or revoked automatically, select Yes to the Role-Based Entitlements question, click Next, then continue with Step 8.

    or

    If you want the granting or revoking of this entitlement to be a manual process (approved by someone), select No to use the User Application, then skip to Step 9.

    We recommend that you have only one agent control an entitlement. If multiple agents are in control, you have the following consequences:

    • Whoever comes last controls the entitlement results

    • Results are unpredictable

    • Using both agents to control an entitlement is not supported by Novell

  8. (Conditional) If you select Yes to the Role-Based Entitlements question, you are asked if you want to use the Role-Based Entitlements priority to resolve any conflicts that might happen when this entitlement is assigned by different Role-Based Entitlement Policies with different values. You can resolve the conflict by either using the Role-Based Entitlements priority, or by merging the values. This example uses priority.

    Merging the values merges the entitlements of all involved Role-Based Entitlement policies, so if one policy revokes an entitlement but another policy grants an entitlement, the entitlement is eventually granted. Solving conflicts by priority works if you need to ensure that only one policy is applied to this entitlement at any time.

  9. Click Finish.

  10. If you see the Add To Filter window, answer Yes if you want the driver to listen for this entitlement. This enables entitlements for the driver. The DirXML-EntitlementRef attribute allows the driver filter to listen for entitlement activities, which is necessary in order to use the entitlements you are creating.

    or

    If you don’t want to see the Add To Filter window on entitlements you are creating for any driver in Designer, select Remember Selection - Don’t Prompt Again, then click OK. However, after the attribute is added to this driver filter, you won’t see the Add To Filter window again.

Before you can edit this entitlement, you are asked to save the editor’s changes before continuing. Once the editor is saved, the entitlement displays in the Modeler view.