cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

IdentityIQ 8.0: Context-sensitive help

IdentityIQ 8.0: Context-sensitive help

Back to the IdentityIQ 8.0 overview: What's New in IdentityIQ 8.0

 

 

New and brandable context-sensitive help

New context-sensitive help has been added to these UIs:

  • Targeted certifications
  • Access reviews
  • Access requests

 

You can customize some of the appearance of the context-sensitive help, to reflect your company's branding, including the cascading style sheets (CSS), the logo, and the window title.

 

Customizing the CSS

The context sensitive help inherits any other system-wide CSS customizations you have implemented. The context-sensitive help windows use the ui-custom.css file for CSS customizations.

 

Customizing the logo and title bar of help windows

The logo and title bar used in the context sensitive help pages are set in the UI Configuration object, which is accessible from the Debug pages:
    1. From the Debug pages, choose UI Configuration from the Configuration Objects drop-down menu.
    2. All context-sensitive help pages are configured in the contextualHelp entry key. You can search on contextualHelp to jump to the relevant section of the file. Individual help pages are configured in ContextualHelpItem elements.

<entry key="contextualHelp">
        <value>
          <Map>
            <entry key="accessReviewDetailURL">
              <value>
                <ContextualHelpItem enabled="true" height="600" homeUrl="certification/certification.jsf" key="accessReviewDetailURL" title="ui_access_review_detail_help" type="URL" url="ui/help/accessReview/access-review-detail-help.html" useTemplate="true" width="1024"/>
              </value>
            </entry>
            <entry key="accessReviewSummaryCardURL">
              <value>
                <ContextualHelpItem enabled="true" height="600" homeUrl="certification/certification.jsf" key="accessReviewSummaryCardURL" title="ui_access_review_summary_card_help" type="URL" url="ui/help/accessReview/access-review-summary-card-help.html" useTemplate="true" width="1024"/>
              </value>
            </entry>

 

          3. To change the logo, CSS, or title of a help page, use the values described below.

 
 

Customizing the logo

To customize the logo, use logoPath to point it to an image of your choice. The path is relative to the IdentityIQ installation directory. For example, the value below modifies the logo in the Access Review Details page context-sensitive help, to point to a logo file in a customer-created [installDirectory]/custom/ui folder. There is also an option to set specific descriptive alt text for the logo image, which may be useful for meeting accessibility requirements.

 

<entry key="accessReviewDetailURL">

  <value>

   <ContextualHelpItem logoPath="custom/ui/MyOwnLogo.jpg" logoDescription="My Own Alt Text for This Logo" enabled="true" height="600" homeUrl="certification/certification.jsf" key="accessReviewDetailURL" title="ui_access_review_detail_help" type="URL" url="ui/help/accessReview/access-review-detail-help.html" useTemplate="true" width="1024"/>

  </value>

</entry>

 

Customizing the title

To customize the context-sensitive help's window title, which can help with accessibility, use the title value. Be sure to replace the default title that is provided out of the box, rather than adding a second title key. For example:

 

<entry key="accessReviewDetailURL">

  <value>

    <ContextualHelpItem logoPath="custom/ui/MyOwnLogo.jpg" logoDescription="My Own Alt Text for This Logo" enabled="true" height="600" homeUrl="certification/certification.jsf" key="accessReviewDetailURL" title="Access Reviews for My Company" type="URL" url="ui/help/accessReview/access-review-detail-help.html" useTemplate="true" width="1024"/>

  </value>

</entry>

Labels (1)
Version history
Revision #:
3 of 3
Last update:
‎Jul 17, 2023 11:02 PM
Updated by:
 
Contributors