Skip to content

Entitlement Catalog Attributes

Use the Edit Entitlement Catalog Configuration page to define custom extended entitlement attributes. The extended attributes are displayed with the rest of the entitlement information throughout the product. An example of a extended entitlement attribute might be Time Zone.

The Edit Entitlement Catalog Configuration page contains the following information:

Name
The display name of the extended entitlement attribute assigned when it was added.

Category Name
The category defined when the attribute was created.
If no category was defined this column is blank.

Description
A short description of the extended entitlement attribute.

Click New Attribute to add additional extended entitlement attributes.

To edit or delete an existing attribute or type from the list, right-click the item and select the corresponding option from the menu. If you are deleting, you must confirm the deletion in the pop-up dialog.

Extended Attributes

Use the Edit Extended Attribute page to create and edit additional role attributes including the display name, attribute type and description.

The Edit Extended Attribute page contains the following information:

Attribute Name
The name of the attribute as it appears in the application.

Important

Extended attributes must use unique attribute names that will not be duplicated in other parts of your IdentityIQ environment. For example, an extended attribute name must not duplicate any attribute names in any of your application schema(s). A best practice is to use a standard prefix or naming convention that ensures that your extended attribute names are unique.

Caution

Changing an attribute name might cause attributes that were previously aggregated to no longer be recognized.

Display Name
The name for use throughout the product.

Type
The attribute type to be linked, for example string, Boolean, date, rule, or identity.

Description
A brief description of the entitlement attribute.

Category Name
An optional category used to separate the attributes into categories on the Application Configuration page. Enter a category name or select an existing one from the dropdown list.

Searchable
Enable this entitlement attribute for use in queries.

Editable
Enable editing of this attribute from other pages in the product.

Required
For String type attributes only. Required attributes must have a value before you can save an entitlement.

Allowed Values
For String type attributes only. Enter the values that are allowed for this attribute. The values entered in this list are used to populate the dropdown value list on the Roles page.

Default Value
Enter a default value for the attribute or select a value from the dropdown list, depending on the attribute type you are working with.

How to Add or Edit Extended Entitlement Attributes

Note

When mapping to a named column, specify the name to match the .hbm.xml property name, not the database column name. With camel case the database column name is translated to lower case with underscore separators. For example, costCenter in the Hibernate mapping file becomes cost_center in the database.

  1. Click New Attribute or click an existing attribute to display the Edit Extended Attribute page.

  2. Enter or change the attribute name and an intuitive display name.

    Important

    Extended attributes must use unique attribute names that will not be duplicated in other parts of your IdentityIQ environment. For example, an extended attribute name must not duplicate any attribute names in any of your application schema(s). A best practice is to use a standard prefix or naming convention that ensures that your extended attribute names are unique.

    Caution

    If you define an extended attribute with the same name as an application attribute, the value of the extended attribute overwrites the value of the connector attribute.

  3. Select the attribute type from the drop-down list, String, Integer, Boolean, Date, Rule, or Identity.

  4. Optional Selections:

    • Optional: Enter a description of the additional attribute.

    • Optional: Select a category for the attribute.

    • Optional: Activate the Searchable option to enable this attribute for searching throughout the product.

    • Optional: Activate the Editable option to enable this attribute for editing from other pages within the product.

    • Optional: Mark the attribute as required. For string type attributes only.

    • Optional: Enter allowed values for the attribute. For string type attributes only.

    • Optional: Specify a default value.

  5. Click Save to save your changes and return to the Edit Entitlement Catalog Configuration page.