Document toolboxDocument toolbox

Access Help Entries

Owned by Former user (Deleted)
Last updated: Jan 24, 2023 by Former user (Deleted)
4 min read

Related pages:

HELP ENTRIES

Overview

Administrators can add additional help entries within the 'Help' or '?' icon for most modules within Lucidity Software. This function can be useful to relay additional, organisation specific information for users in the form of links to additional URL's, documents or text. 

 

Video: Help Entries Overview

The Help icon within each Lucidity module is located in the top right hand corner and is accessible to all users.

These can be managed by administrators from the Help Entries page within the Lucidity Access module.

From the Help Entries page, administrators can:

  • View default help entries

  • Create and manage help entries

Default Help Entries

By default, most pages within Lucidity will have three entries in the Help drop-down:

  • User Guide - Direct link to the user manual for the module the user is currently accessing (cannot be edited or deleted)

  • Support Page - Link to the Lucidity Help Centre (cannot be edited or deleted)

  • Add / Edit - Only visible to Administrators

Help within the Intranet module

The Intranet module Help is slightly different. A single ? icon is displayed which is a direct link to the Intranet user guide. 

As the Intranet module includes a Management System for housing documents, it is recommended that company specific help is added directly to the management system pages.

Create New Help Entry

Adding help documentation to end users can be useful and allows for the addition of organisational specific information. Some examples of help entries to add could be:

  • Risk: Company risk matrix

  • Incident: When to report and Incident or a Hazard

  • Competency: Training booking form

  • InForm: Annual leave policy 

  • Contractor: link to Contractor portal

There are two ways help entries can be added: from the Help Entry page within Lucidity Access or from the Add/Edit option in the help drop-down.

To create a new help entry, from the Help Entry page:

  1. Click 'Add New'

  2. Complete the fields (see table 'Definitions of Fields' below)

    1. The details captured for each user may vary slightly between each system configuration. Fields marked with * are mandatory

  3. Click 'Save'

Table of Definitions

Information

Title

Enter a title for the help entry. This will be displayed under the Help icon within each module

 

Application

Select the module the help entry is to be displayed in

 

Disabled

Tick to hide the help entry from end users. This is useful when a help entry is no longer valid or when building a new help entry which isn't yet ready for end user access.

Details

Help Entry Type

Select the help entry type - either URL or Text

Note that the resource option has been replaced by the use of the URL option, in combination with a link from the appropriate document once placed in the Filing Cabinet. Resources and documents cannot be added as direct attachments to help entries.

Refer to the Generate File Links section on the Filing Cabinet page within the Lucidity Intranet user guide for more details.

 

Help URL

Displays when URL is selected as the help entry type.

Enter the URL. This can be links to external websites, internal share point links or links to documents houses in Lucidity Intranet.

 

Help Text

Displays when text is selected as the help entry type.

Enter the text to be displayed to end users. A limited toolbar of formatting options is available. Hyperlinks can also be added here. 

 

To create a new help entry, from the Add/Edit option in the help drop-down:

  1. Click the 'Help' icon from within any page in Lucidity

  2. Click 'Add/Edit'

     

  3. In the pop-up that appears, click 'Add New'

     

  4. Complete the fields (see table 'Definitions of Fields' above)

    1. Note the only difference here is the option to select:

      1. 'All Pages' where the help entry will be added to all pages within the module

      2. or 'Current Pages' where the help entry will be added to the current page only

  5. Use the 'Sort' button to adjust the order the help entries are displayed

  6. Click 'Save'

Â