Configuring multitenancy that is based on a user account attribute

You can designate a specific user account attribute in your authentication provider to map to the tenant. After you choose the user account attribute that you want to map to the tenant, you must create a custom property and map it to that attribute.

You need to map the user account attribute to the Tenant ID Mapping > Pattern property in IBM® Cognos® Configuration.

Before you begin

The user account attribute that you choose to identify the user's tenant should be used only for this purpose.

For example, you can decide that the businessUnit attribute of an LDAP user account will identify the user's tenant. In this case, you set the Pattern type property as shown in the following example: ~/parameters/parameter_name. Next, you specify a custom property named parameter_name and associate this property with the user account attribute businessUnit

Procedure

  1. Open IBM Cognos Configuration.
  2. Choose whether to configure multitenancy settings globally for all namespaces, or for a specific namespace.
    • To configure multitenancy for all namespaces, in the Explorer window, for the Security category, click Authentication.
    • To configure multitenancy for one namespace, in the Explorer window, for the Security category, click Authentication. Then, click the namespace that you want to configure.
  3. In the Multitenancy group of properties, click the edit button for the Tenant ID Mapping property.
  4. In the Tenant ID Mapping box that is displayed, specify your mapping in the following way:
    1. For Type, select Pattern.
    2. For Value, type the string that you created that is based on the instructions earlier in this topic.

      For example, type ~/parameters/parameter_name, where ~/parameters is a constant part of the syntax and parameter_name is the custom property name.

    3. Click OK.
  5. In the Account Mappings (Advanced) group of properties, specify the custom property and map it to the account attribute in the following way:
    1. Click in the Value column for Custom properties, and click the edit button.
    2. In the Value - Custom properties window, click Add.
    3. In the Name column, type the custom property name. In the Value column, type the name of the attribute. For the example that is used in step 4, the custom property should be: parameter_name for Name and businessUnit for Value.
    4. Click OK.
  6. Test your multitenancy configuration.
    1. Right-click either Authentication or the namespace (depending on your choice in step 2) and click Test.
    2. Log on using the credentials of the system administrator, and click OK.
    3. Click the Details button, and read the information that is displayed.

    If multitenancy is properly configured, your tenant ID is displayed in the details. If the tenant ID is not displayed, update and correct the values and test again.

  7. If the testing was successful, from the File menu, click Save.
  8. Restart the IBM Cognos service for the changes to take effect.
Parent topic: Configuring multitenancy