Manage help options

Help options affect the look and feel of the Help window, password management, and the What's New link that appears on the Portal and Case Home pages.

In the application, a Help button is located on the navigation bar, next to the user name menu. There are two ways to configure the help for access by your users. Select the best method for your environment.

Installed help is the browser-based help and allows users to search for information or navigate using the table of contents. You must configure the installed help if users do not have Internet access. 

The external online help searches for content based on the Nuix Discover page that you are using when you click the Help button. Users can use the search box in the Help window and get results from a variety of sources. You can add links for your users to submit a support ticket or to contact the Nuix Support team. Nuix Discover web servers require Internet access for online help to work. If you do not have Internet access, clear the information in the URL to browse documentation box, as described in the following table.

Note: To view the external online help, users may have to enable pop-up windows in their web browsers. 

Only system administrators can access help options.

To manage help options:

On the Portal Home page, under Portal Management, click Settings.

On the Help Options page, edit options as needed. Hover over the tooltip for a description of each option.

To save the changes, click Save. To revert to the last saved server properties, click Reset.

The following table contains a description of the settings on the Help Options page.

Option

Description

Default

Affected areas

URL for login provider site

This setting is located under the Login configuration and password heading on this page. Link to the site that provides third-party and single-sign on authentication and login for the application. 

No default

Login page

URL of change password link

This setting is located under the Login configuration and password heading on this page. Link to the third-party password management site. The link must be a fully-qualified URL. Password self-service must be configured for this portal.

No default

Login page

URL of forgotten password link

This setting is located under the Login configuration and password heading on this page. Link to a third-party password management site. This must be a fully-qualified URL and password self-service must be configured for this portal. If present, users are directed here when they click the “I've forgotten my password” link on the application login page.

No default

Login page

Help search service credentials

Encrypted credentials for accessing the user help search API, which is used to run searches for help content on ringtail.com.

Populated by default with the encrypted credentials.

Help window

URL for Get Help button

Web address or email address (in the form mailto:yourcompany@example.com) for users to contact support from the Help window. If you leave this value blank, the Get Help button does not appear in the Help window.

https://nuix.service-now.com/support

Help window

URL for search API

Web address of the user help search API, which provides suggested search results in the Help window. To display suggested results, set this value to https://www.document-search.ringtail.com/v1. If you leave this value blank, suggested results do not appear in the Help window.

https://document-search.ringtail.com/v1

Help window

URL to browse documentation

Web address of the documentation website, such as https://www.ringtail.com/resources/documentation.

Note: If you leave this value blank, when users click the Documentation button in the Help window, the installed help opens instead of the online help. The installed help runs faster when you remove URLs in the Help menu area of the Help Options page.

https://www.ringtail.com/documentation

Help window

URL to submit a ticket

Web address or email address (in the form mailto:yourcompany@example.com) for users to submit a support ticket using the Help window. If you leave this value blank, the Ticketing button does not appear in the Help window.

https://nuix.service-now.com/support

Help window

What's New blurb

Additional text to appear in the “What’s new” section on the Portal home page. You can add extra text to this section, which then appears under the "See the recent changes" link.

No default

Portal Home pages

What's New display

If you select this option, the "What's new" section and the "See the recent changes" link appear on both the Case and Portal home pages. By default, the link takes you to a web page that provides an overview of the features for each release.

Selected

Case and Portal Home pages

What's New URL

Link to a web page describing new features.

Links by default to the version notes page on www.ringtail.com.

Case and Portal Home pages