User assistance - version 9.20
- Frank Gambino
User assistance
Improved reporting of updates and hotfixes
The LMS Documentation 9.x help space now includes an improved method of reporting updates and hotfixes in UniFocus Release Notes.
In versions 9.14 through 9.18 of UniFocus Release Notes, update and hotfix notes appeared in every affected version. For each version of the release notes, the Updates and hotfixes notification section included an overview of the issue and a link to the corresponding Fixed issues page.
Ticket 19038 was released as a fixed issue in
RMS
version 9.17, but it was also included as a hotfix to versions 9.14 through 9.16. The fixed issue note for this ticket appeared in Release Notes 9.14, Release Notes 9.15, Release Notes 9.16, and Release Notes 9.17. If you went to the landing page for Release Notes 9.15, the link in the Updates and hotfixes section sent you to the Fixed issues in version 9.15 page.
Starting with
RMS
9.20, the LMS Documentation 9.x help space offers several improvements to how updates and hotfixes are reported:- A centralized view of all updates and hotfixes—The new Updates and hotfixes for 9.x releases page consolidates all release notes for updates and hotfixes to
RMS
9 software. You no longer have to check each UniFocus Release Notes version to determine whether an update or hotfix has been added to your software version. All notes are now available in a single page. - Additional information—The Updates and hofixes for 9.x releases page contains an overview table with key information about each change:
- Date—The date when the update or hotfix was published.
- Ticket—The ticket number for the update or hotfix.
- Overview—A summary of the change.
- Category—The main component of UniFocus software that was affected by the change.
- Type—Whether the change was an update or hotfix.
- Updated Versions—UniFocus RMS software versions that are affected by the change.
Improved user experience—Not only does the overview table contain important information about each ticket, but it also allows you to sort by column headers and quickly access the detailed note by clicking the link in the Ticket column.
Click any column header to change the sort order of the table. For example, if you want to see the newest updates, click the Date column to move the most recent changes to the top of the table.
Clicking a link in the table takes you directly to the corresponding update or hotfix note.
Tip: If you are looking for a specific ticket, just press Ctrl+F (or Command+F in Mac) and enter the ticket number. If the note is on the page, you'll find results in both the overview table and in the detailed notes section.
Improved notifications in affected release notes—On the landing page of affected UniFocus Release Notes, the Updates and hotfixes notification section still contains summary statement of each change. However, the link in the section now takes you to the Updates and hofixes for 9.x releases page for more information.
Using the example above, the note for ticket 19038 is introduced as a fixed issue for the primary Fix Version 9.17 and then added to the Updates and hotfixes for 9.x releases page. The Updates and hotfixes sections of affected release notes now contain a single link to the Updates and hotfixes for 9.x releases page.
Build numbers added to updates and hotfixes section—In previous versions of the UniFocus Release Notes, updates and hotfixes were grouped by the date when the release note was published to the online help space. Starting with this release, updates and hotfixes are now grouped by build number. The build number is the number associated with the software release version.
To view your current software version:
- Open the UniFocus
RMS
software. - In the lower-right corner of the screen, hover over the database icon (
).
A yellow box appears displaying your UniFocus version number.
Updates and hotfixes that have not yet been released are marked as Coming soon. When the new version of the
RMS
software is released, the Coming soon label is removed to show that the build has been released and the updates and hotfixes are accessible within the current software version.Example:
- Open the UniFocus
Tip: Bookmark the Updates and hotfixes for 9.x releases page for easy access to the latest information.
Improved layout and descriptions in Work Rules user documentation
The online help for work rules has been updated with the following improvements:
- Page navigation—At the top of the help page for each work rule type, there is a page-level table of contents. Clicking a link takes you to the relevant work rule description.
- Table format—Documentation for each work rule is now organized in a table. This format not only improves readability of the descriptions, but it also allows for expanded content such as examples, tips, and best practices.
- Revised content—Descriptions of rules and parameters have been edited.
Expanded content—New content includes examples, tips, best practices, and supplemental help topics.
The image below shows an excerpt of the updated documentation for the Schedule Lunch work rule:
| # | Item | Description |
| 1 | Overview | A brief description of the work rule type. |
| 2 | Table of contents | Click a link to go to the documentation for the selected work rule. |
| 3 | Work Rule | Name of the work rule. |
| 4 | Description | Description of the work rule and how it might be used. |
| 5 | Tips * | Helpful information about how and when to use the work rule. |
| 6 | Example(s) * | Examples of how the work rule might be used in typical business operations. |
| 7 | Parameters | Descriptions and examples of the configuration options within the work rule. |
* Not all work rule descriptions contain tips and examples.
New user documentation for the Employee User Maps screen
When an administrative user creates a new username (Login ID) in the Security screen, the username must then be linked to an existing employee via the Employee User Maps screen (Setup > Employee > Employee User Maps).
In this release, two new pages have been added to the online help:
- Employee User Maps—An overview of the Employee User Maps user interface.
- Working with the Employee User Maps screen—Instructions for mapping user accounts to existing employees and removing user account mapping from employees.