New article
Recently updated
Creating a new Help entry
Who is this article for?Administrators who want to learn to create new Help entries.
Administratorpermissions are required.
Creating custom Help entries in Lucidity Software empowers administrators to tailor support resources to their organisation's specific needs and workflows. This guide walks you through the step-by-step process of adding new Help entries.
1. Creating a new Help entry
Video: Create and Edit Help Entries
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.
- From the Add/Edit option in the help drop-down.
To create a new help entry, from the Help Entry page:
-
Click Add New.
-
Complete the fields (see table Definitions of fields below).
Note: The details captured for each user may vary slightly between each system configuration. Fields marked with * are mandatory.
-
Click Save.
1.1. Definition of fields
|
Field |
Definition |
|---|---|
|
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. |
|
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. |
|
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:
-
Click the Help icon from within any page in Lucidity.
-
Click Add/Edit.
- In the pop-up that appears, click Add New.
-
Complete the fields.
- The only difference here is the option to select:
-
-
All Pages - where the help entry will be added to all pages within the module.
-
Current Page - where the help entry will be added to the current page only.
-
-
-
Use the Sort button to adjust the order the help entries are displayed.
- Click Save.