Template

Overview

This register provides the following features:

// This section just gives an overview of the general function of the register/module.
Mention what it is for and how different users might use it etc. including any information about other related registers.
Include a conceptual diagram if there is one (workflow or chart). 
Alternatively a screenshot of the Active datagrid (make sure content in columns is visible)
(Large centred)
Label [Register] datagrid (sample view)

Positions

// Optional, typically outlined at module level. If more than one position, otherwise delete. 

The following table outlines [Module or Register] positions and what users with them can do according to their default security policies:

Position
Description

This position [description of overall purpose] Users on duty with this position can [description of abilities]

Other positions may have similar security policies. A System Administrator can establish positions with custom security policies.

Process

Refer to: Workflow

// This section outlines the workflow and links to relevant sections below

Setup and Configuration

Refer to: Configuring the System and Administration

// Optional, if helpful, otherwise delete. 

To configure [Register]:

// List the things administrators can do that other users can't

Access

To access the register:

  1. Go on duty with an appropriate position. If you can't access it after doing this, contact your System Administrator.

  2. Locate the [Register] register under [Location of Register] in the menu.

// Screenshot of menu highlighting the register
(Medium centred)
Label Location of the [Register] register in the [Module] module

Finding [Register item]

Searching and Filtering

The register includes a number of features to assist in finding [Register item]s:

  • [Map view] (remove it doesn't support)

  • Filters including [List of common filters]

  • Combination filters and search by most fields

// Screenshot of the Active datagrid (make sure content in columns is visible)
(Large centred)
Label [Register] datagrid (sample view)

If the register has a map mode, also show an item summary selected from the map
(Medium centred)
Label [Register] map with item summary (sample view) 

Filters

Filters help make management of [Register item]s easier by focusing on specific groups of items on the datagrid.

// Screenshot of filter menu - main and optionally workflow for context
(Medium centred)
Label [Register] filter menu
Filter menu explanations

The following lists some of the filters and how to use them:

Filter Group
Filter/s
Use

Main

Workflow

[Other useful filter/group/s]

Active tags

[List is based on your system configuration]*

Any tags in use.

Refer to: tags

* May vary based on your system configuration

Opening and Viewing

Viewing Items

When viewing [Register item], sections can be expanded to show information.

As each section is completed, new sections may show additional information.

// Screenshot showing read only view of main section
(Medium centred)
Label Explain what is going on in the item 

Settings

[Register item]s are divided into the following sections (sections may or may not appear depending on what information is entered, your permissions level, and what mode you're viewing):

// In Edit mode, check for all variations of settings.
Create a heading for each
Link the table below to the relevant sections as an index
Use H3 for any important fields/settings within the sections
Left Column
Right Column

Record Notes

Workflow

Classification

Activity

// For each section, include description of the use of major fields.
Bold the field name where possible.
Some extra info can be found where needed in the expanding lists below
Examples [delete if not used]
Example
Sample Text

Lookup

Your Administrator configures the list for your site using the [Lookup name] lookup.

File Upload

Image/s [or document/s] are uploaded using the Add File button.

Tags

Refer to: Tagging Items

Due Date

Refer to: Setting Dates

Record Notes

When editing, record notes in the rich text field as you make changes which will appear in the Activity log.

Refer to: Recording Notes

Workflow

Status

// Use if appropriate and rename. 
Add rows and icons for each. 
If the workflow is complex and there is no diagram, use next available steps column.
Status
Datagrid Icon
Next available steps
Notes

Requested

Assigned, Closed

All new requests begin with this status

// Optional, if used, otherwise delete. 
Can add screenshot for context. 
Make sure order is correctly reflected in table

Refer to: Linked items

Classification

// Optional, if used, otherwise delete. 
Make sure order is correctly reflected in table.

Refer to: Editing Items: Classification

Activity

Refer to: Viewing Items: Activity

Updating

Editing Items

When updating [Register Item]s:

// Bullet list of key fields to update. 
Focus mainly on essential fields. 
Include specific instructructions for non-standard settings
  • Add notes on your edits in the Record Notes field

  • Complete each section of the Settings as required. Note that some options may open up new sections to complete.

// Screenshot of edit screen

Adding

// If sub-item leave out link below 
Mention if it can only be added through parent register
List any compatible parent registers
Adding Items
// Modify step one with the specific register button if there is one
If sub-item remove the drop down list option unless it can be added standalone
Focus any further instructions on required fields. 
  1. From the register, in the New item menu select the New button (or drop down the list from any other register and select it)

  2. Complete each section of the Settings as required.

  3. Save

// Screenshot of add screen

Bulk Actions

Bulk Actions

The following additional bulk actions can be performed via the Actions menu:

// Remove any that aren't relevant
Add any that are specific to the register
Put them in the same order as the Bulk Action menu
Put extra instructions on a new line after the Refer to line
Action
Description

Copy IDs

Refer to: Copy IDs

Export [Report name]

Bulk Edit

Refer to: Bulk Edit

Create a Copy

Send Communication

Importing

// Optional, if used, otherwise delete. 
Imports

A System Administrator can import in bulk via the Import system using the [Relevant Import] option.

Reports

// Optional, if used, otherwise delete. 
Running Reports

Reports available for [Register Item] include:

// Bullet list if multiple
Otherwise just mention the main one, you can optionally link to Built-in reports page

Last updated

Was this helpful?