Go to Welcome Page

Operating Guide

Version 3.3

What’s New

System Manuals

User Operations

Managing Operations

Outputs and Records

Administration

User Operations

Basics

My Summary

Portal / Mobile Device

Useful

Glossary

Managing Operations

SMCR (Accountability UK)

Compliance

Risk

KRIs

Events

Registers

Contracts

Control Inventory

Document Library

Obligations

Triage PRO

Outputs and Records

Dashboards

Reports Charts Adhoc Stats

Record Management

Alerts

Administration

Configuration & Maintenance

Current Tasks

Security

Monitor

Audit Trail

New Record Help

Page contents

Overview

Procedures

Overview

Providing Help for creating new Records

Administrators can add customised Help information to assist users when they create a new Record.

The following Record types are supported:

The ‘New Record Help’ menu option is available in the Maintenance Section of the Menu of each Record type.

The Compliance menu 'New Record Help'
The Compliance menu ‘New Record Help’

A user creating a new Record of the types listed above can access New Record Help information by clicking the icon on the New (Record Type) popup window.

The Help icon on a 'New Risk' popup window
The Help icon on a ‘New Risk’ popup window

Note:
If no New Record Help exists for a particular record type, the icon is not displayed on the New (Record Type) window.

See the procedure Provide Help for creating new Records.

Procedures

Provide Help for creating new Records

The following is applicable to all record types listed above.

Note:
Labels and other items shown in (brackets) are configurable and may be different on your system.

Add or Edit New Record Help

  1. From the Main Menu, select Risk | New Record Help.

  2. The New Record Help editor is displayed.

    The ‘New Record Help’ editor elements
    ID Element Description
    1 Page Help icon Click this icon to display basic information about how to work with this Page.
    2 ‘Type’ selector Use the Type to select the Record type for which you want to create or edit the New Record Help (e.g. ‘Risk’).
    3 Formatting Toolbar Use these controls to format the text that you type in the New Record Help field (item 4) and to add lists, hyperlinks, simple tables and more.
    4 ‘New Record Help’ field Type the details of the New Record Help in this field, then format the text, add lists and other features using the Formatting Toolbar (item 3).
    5 ‘Save’ icon Click this icon to save the New Record Help.
  3. Create or edit your Help text in the Text Editor pane. You can use the Formatting Toolbar to style any headings, format bulleted or numbered lists and so on.

  4. Click the icon to save your new or edited Help text.

  5. The following message is displayed at the bottom of the Page (e.g. ‘Risk’):

  6. Check your Help text edits by performing the first steps of creating a new Record of the relevant type (e.g. Risk) and clicking the associated icon.

Remove New Record Help

  1. From the Main Menu, select Risk | New Record Help.

  2. The New Record Help editor is displayed.

  3. Remove all of the text in the Text Editor pane.

  4. Click the icon to save your changes.

  5. The following message is displayed at the bottom of the Page (e.g. ‘Risk’):

  6. Check that the Help icon is no longer displayed on the New (Record Type) Page. In this case Compliance also does not have any text:

Page Contents Glossary