Configuring SAML authentication for Historical Reporting

Last Updated : Mar 20, 2026 |
Prolog information
Use this procedure to configure SAML authentication post-installation of Avaya Analytics™. You can use this procedure to configure and generate the SAML files on Historical Reporting linking to profile created on an Identity Provider (IDP).
Before you begin
  • You must create the following three groups on Active Directory and Identity Provider and add Avaya Analytics™ reporting supervisors into these groups:
    • Consumer
    • Basic
    • Advanced
    These groups link Avaya Analytics™ reporting supervisors to the respective groups with appropriate user privileges in Avaya Analytics™.
  • You must create a relying party trust (ADFS) profile on your IDP. For more information refer to Creating a relying party trust section in Avaya Analytics™ maintenance and troubleshooting guide.
  • Note the relying party trust identifier and the relying party SAML SSO service URL.
    The relying party trust identifier is the unique identifier of the web application. The relying party configured SAML SSO service URL is the URL that IDP sends and receives in SAML requests and responses.
  • The /saml/SSO is removed from the end of the URL.
  • Export the IDP metadata.xml and make it available on the CCM.
  1. Log in to the Cluster Control Manager (CCM) console as the customer user.
  2. Switch to being the root user by entering the command su.
  3. To run the Analytics Administration script, use the following command:
    ADDITIONAL INFORMATION:
    ccm release orca analytics
  4. To select the Historical Reporting option, enter the corresponding number.
  5. To select the SAML option, enter the corresponding number.
  6. To select the Enable SAML option, enter the corresponding number.
  7. Enter the full path and file name to the IDP Metadata XML file on CCM for the web.
  8. Enter the full path and file name to the IDP Library Metadata XML file for the library.
  9. Enter the Unique Identifier of the web application that recognizes the IDP.
    ADDITIONAL INFORMATION:
    For example, AnalyticsWebHome.
  10. Enter the Web URL from which IDP sends and receives SAML requests and responses.
    ADDITIONAL INFORMATION:
  11. Enter Unique identifier of the library application to be recognized by the IDP. Leave it blank if not applicable.
    ADDITIONAL INFORMATION:
    For example, AnalyticsLibHome.
  12. Enter Library URL from which IDP sends and receives SAML requests and responses. Leave it blank if not applicable.
    ADDITIONAL INFORMATION:
    For example, https://cluster.fqdn/MicroStrategyLibrary.
    ADDITIONAL INFORMATION:
    Note:
    The above mentioned example library URL is applicable for release 4.3.1.0 and later. For older releases, use the Library URL - https://cluster.fqdn/AvayaAnalytics/library.
  13. Set SAML behind a proxy to True.
  14. Enter SAML signature algorithm. For example, SHA256WITHRSA.
  15. If, SAML encryption key is required, set Generate SAML encryption key as True. Otherwise, set it to False.
  16. In the User display name attribute, enter DisplayName.
  17. In the User email address attribute, enter EMail.
  18. In the User distinguished name attribute, enter DistinguishedName.
  19. In the User group attribute, enter Groups.
  20. In the Group attribute format, enter Simple.
  21. In the Groups (Advanced, Basic, Consumer) that can access Web Administrator page. Leave it blank if not applicable.
  22. Enter Authentication method when accessing an admin page. Set to 1 to use standard authentication or 2 to protect with SAML Authentication.
    ADDITIONAL INFORMATION:
    Note:
    If set to 2, a group needs to be entered in the step. Enter the groups (Advanced, Basic, Consumer) that can access Web Administrator.
  23. Confirm the following settings (y/n):
    ADDITIONAL INFORMATION:
    SAML configuration
    IDP Metadata XML file: /home/cust/IDPMetadata.xml
    IDP Library Metadata XML file(blank if not applicable): /home/cust/IDPMetadata.xml
    Unique identifier of the web application: AnalyticsWebHome
    URL the IDP sends and receive SAML requests: https://cluster.fqdn/AvayaAnalytics
    Unique identifier of the library application:AnalyticsLibHome
    Library URL,(blank if not applicable):https://cluster.fqdn/AvayaAnalytics/library
    Use Proxy,(blank if not applicable): true
    SAML signature algorithm: SHA256WITHRSA
    Generate SAML encryption key: false
    DisplayName: DisplayName
    Email: EMail
    DistinguishedName: DistinguishedName
    Groups: Groups
    Group format: Simple
    Admin Groups: Advanced
    Authentication method: 1
    STEP RESULT:
    The SAML authentication for historical reporting is configured.