8Help Configuration

This chapter contains the following:

You don't have to set anything up for help to work. But you can do optional setup, for example to make help icons visible to everyone, or to give people access to add help content. First enable help features, then do some tasks in the Application Extensions functional area.

Enable Features

In the Offerings work area, review these features at the offering level.

  • Local Installation of Help: Make sure to leave this enabled.

  • Access to Internet-Based Help Features: This feature isn't used, so it doesn't matter if you enable it or not.

  • Help Content Management: Enable this feature if you want some people to be able to add company-specific help to help windows or the Getting Started work area.

  • Security for Added Help: Enable this feature if you want certain help to be available only to a restricted set of user roles.

    Caution: Enable this feature only if you have this requirement, because the feature can affect performance.

By default, help icons that open help windows are hidden. You can set it up so that users do see the icons every time they sign in, on any page that has help icons.

  1. In the Setup and Maintenance work area, go to the Set Help Options task in the Application Extensions functional area.

  2. On the Set Help Options page, select the Show help icons by default check box. You just need to do this for one offering, and the setting applies to everyone.

  3. Sign out and sign back in to see the icons by default. The same goes for any user next time they sign in.

To hide the icons, people can still click their user image or name in the global header and select Hide Help Icons, and later select Show Help Icons to see the icons again.

Note: What we are talking about here affects only help windows, not help text that appears when you hover over or click certain UI elements on the page. To edit or delete UI element help text, use Page Composer or other tools.

If you enabled the Help Content Management feature, check who has the Manage Help Content (ATK_CUSTOMIZE_HELP_TOPICS_PRIV) privilege. Here's what these users can do:

  • Add help in any help window, and also edit and manage the help that anyone added.

  • Edit existing pages in the Getting Started work area and also add new pages.

By default, the administrators for product families have this privilege. Your security administrator can assign job roles with this privilege to other users. The Assign Help Text Administration Duty task is a reminder for you to follow up with your security administrator. Make sure that people who want to create and edit help have the access to do so.

Enable Global Search for Added Help

If your company adds help, you might want to enable global search and make sure it includes the Help category. People can then search for any added help using the search in the global area.

In this example, you want to add company policies as help in a help window. But, at all times, only human resources (HR) specialists should be able to see those policies. Let's look at the steps to create a help security group that includes only the job role for HR specialists. You can then secure your company policies with this help security group so that only people with that job role can see the help.

Before You Start

In the Offerings work area, make sure that these features are enabled at the offering level:

  • Local Installation of Help

  • Help Content Management

  • Security for Added Help

Create the Help Security Group

  1. In the Setup and Maintenance work area, go to the Manage Help Security Groups task in the Application Extensions functional area.

  2. On the Manage Help Security Groups page, add a new row.

  3. Enter these values, but leave the start and end dates blank.

    Field Value

    Help Security Group

    HR

    Display Name

    HR Only

    Description

    Viewing by HR specialists only

  4. Click Save.

  5. With your new help security group selected, go to the Associated Roles section and add a new row.

  6. Select PER_HUMAN_RESOURCE_SPECIALIST as the role name.

  7. Click Save and Close.