Difference between revisions of "System Wide Terminology"

From Charitylog Manual
Jump to: navigation, search
(Created page with "=Introduction= The system allows you to re-name most fields that are available. Changes will be applied globally to all record types and also be included in reports/data extr...")
 
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
=Introduction=
 
=Introduction=
  
The system allows you to re-name most fields that are available. Changes will be applied globally to all record types and also be included in reports/data extractions. You will also notice the field will be re-named in the Menu items.  
+
The system allows you to rename most fields that are available. Changes will be applied globally to all record types and also be included in reports/data extractions. You will also notice the field will be renamed in the Menu items.  
* '''Use the Filter to find the field you wish to rename'''
+
 
* '''Items listed in Grey cannot be renamed as they are functional fields'''
+
{{#ev:youtube|7p8t6ZnoyIc|790}}
 +
 
 +
=How to edit system Terminology=
 +
 
 +
The system terminology settings are located under the Cog and listed as 'Terminology'.
 +
 
 +
There are two sections on the left hand side of the page. These sections are:
 +
 
 +
* System Wide Terminology
 +
 
 +
This is where you can control the terminology of system-wide features and tools. These are: Projects, Referrals and Classification Codes.
 +
 
 +
[[File:sys_term1.jpg|700px|alt="a screenshot of the system wide terminology section. This displays a field for referrals, projects and classification codes, with a field for renaming them."]]
 +
 
 +
* Standard Fields
 +
 
 +
This is where you can change the terminology of individual fields. This covers the 'standard' fields, which are controlled under the 'Customise Orgs & People' settings. The field name column provides a list of fields and the option to change the text within the fields.
 +
 
 +
Some fields are greyed out. This is because they can't be renamed as the fields are linked to other parts of the system. You will find an explanation for this in the Notes column.
 +
 
 +
[[File:sys_term2.jpg|800px|alt="a screenshot of the standard fields section. This displays a list of the standard fields, with a field for renaming them."]]
 +
 
 +
=Future plans=
 +
Where practical, we want the system to talk the organisation's own language. Currently, these items can be renamed:
 +
 
 +
* Organisation and people types, e.g. if you want to rename Clients to Service Users
 +
* The standard field labels used on those types, e.g. if you want to rename Ethnic Group to Ethnicity
 +
* Groups of actions, e.g. if you want to rename cases to enquiries or referrals
 +
 
 +
These items will be renameable in a future release:
 +
 
 +
* Clubs and Clinics, e.g. if you want to call them Group Activities
 +
* Meetings at Clubs and Clinics, e.g. if you want to call them Sessions
 +
* Attendees of Meetings at Clubs and Clinics, e.g. if you want to call them Customers
 +
 
 +
These items define the behaviour of the system, so we have no plans to make them renameable :
 +
* The menu
 +
* Roles
 +
* Actions, as in the Action List
 +
* Success messages, warnings and errors, e.g. "Please enter a date to continue"
 +
* Record a Contact
 +
* Ladder Outcomes
 +
 
 +
As the of renameable items continues, in order to prevent one word being used to describe multiple things, it will be necessary to have reserved names which cannot be used, both for the web application, and the API.
 +
 
 +
Web application reserved names are likely to include:
 +
* Groups, which are used for the Group Access security settings
 +
* Users, e.g. people who have a login
 +
* Action List and Case Manager, which are tools used to manage your workload
 +
* Templates, Stages and Workflow, which are used to structure Record a Contact
 +
* Record a Contact
 +
* Ladder Outcomes
 +
* Extension Databases
 +
 
 +
API reserved names are likely to include:
 +
* Anything listed with an API name in the terminology editor in the web application
 +
* type
 +
* active
 +
* project

Latest revision as of 11:59, 2 August 2024

Introduction

The system allows you to rename most fields that are available. Changes will be applied globally to all record types and also be included in reports/data extractions. You will also notice the field will be renamed in the Menu items.

How to edit system Terminology

The system terminology settings are located under the Cog and listed as 'Terminology'.

There are two sections on the left hand side of the page. These sections are:

  • System Wide Terminology

This is where you can control the terminology of system-wide features and tools. These are: Projects, Referrals and Classification Codes.

"a screenshot of the system wide terminology section. This displays a field for referrals, projects and classification codes, with a field for renaming them."

  • Standard Fields

This is where you can change the terminology of individual fields. This covers the 'standard' fields, which are controlled under the 'Customise Orgs & People' settings. The field name column provides a list of fields and the option to change the text within the fields.

Some fields are greyed out. This is because they can't be renamed as the fields are linked to other parts of the system. You will find an explanation for this in the Notes column.

"a screenshot of the standard fields section. This displays a list of the standard fields, with a field for renaming them."

Future plans

Where practical, we want the system to talk the organisation's own language. Currently, these items can be renamed:

  • Organisation and people types, e.g. if you want to rename Clients to Service Users
  • The standard field labels used on those types, e.g. if you want to rename Ethnic Group to Ethnicity
  • Groups of actions, e.g. if you want to rename cases to enquiries or referrals

These items will be renameable in a future release:

  • Clubs and Clinics, e.g. if you want to call them Group Activities
  • Meetings at Clubs and Clinics, e.g. if you want to call them Sessions
  • Attendees of Meetings at Clubs and Clinics, e.g. if you want to call them Customers

These items define the behaviour of the system, so we have no plans to make them renameable :

  • The menu
  • Roles
  • Actions, as in the Action List
  • Success messages, warnings and errors, e.g. "Please enter a date to continue"
  • Record a Contact
  • Ladder Outcomes

As the of renameable items continues, in order to prevent one word being used to describe multiple things, it will be necessary to have reserved names which cannot be used, both for the web application, and the API.

Web application reserved names are likely to include:

  • Groups, which are used for the Group Access security settings
  • Users, e.g. people who have a login
  • Action List and Case Manager, which are tools used to manage your workload
  • Templates, Stages and Workflow, which are used to structure Record a Contact
  • Record a Contact
  • Ladder Outcomes
  • Extension Databases

API reserved names are likely to include:

  • Anything listed with an API name in the terminology editor in the web application
  • type
  • active
  • project