IBM Support

How to add additional Session Parameters to the available Parameters in Framework Manager



This document describes how to make Custom User Properties for LDAP available to Cognos BI Components.


  • IBM Cognos BI
  • LDAP or Active Directory Authentication Source

Resolving The Problem

You can use arbitrary user attributes from your LDAP authentication provider (ADS as well) in Cognos BI components. To configure this, you must add these attributes as custom properties for the LDAP namespace. The custom properties are available as session parameters through Framework Manager.
Name Value
ntUserDomainId ntUserDomainId
  1. On every computer where Content Manager is installed open Cognos Configuration
  2. In the Explorer window, under Security, Authentication, click the LDAP namespace.
  3. In the Properties window, click in the Value column for Custom properties and click the Edit button.
  4. In the Value - Custom properties window, click Add.
  5. Click the Name column, and enter the name you want Cognos BI components to use for the session parameter.
  6. Click the Value column, and enter the name of the account parameter in your LDAP authentication provider.
  7. Repeat the preceding two steps for each custom parameter.

    Example for using the NT User ID:
  8. Click OK.
  9. From the File menu, click Save.
  10. Restart the Cognos BI Service
  11. Open your Framework Manager Project
  12. Edit the Query Subject Definition
  13. Click the Filters tab
  14. Click Add to Insert a Filter
  15. Click the Parameters tab
  16. The new Session Parameter is called $account.parameters.<Name>, e.g.: #$account.parameters.ntUserDomainId#

    Example for such a filter:
    [Namespace].[QuerySubject].[NTUserID] = #sq($account.parameters.ntUserDomainId)#

[{"Product":{"code":"SSEP7J","label":"Cognos Business Intelligence"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"Framework Manager","Platform":[{"code":"PF033","label":"Windows"}],"Version":"10.2.2;10.2.1;10.2;10.1.1;10.1;8.4.1","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
20 March 2020