Navigation:  Business Operations >

Glossary

Training Manuals Alphabetical Function List Back Print this Topic Previous topicOne level upNext topic
Show/Hide Hidden Text

The function is used to view and maintain glossary items.  A user requires a profile linked to the Glossary function with appropriate action allowed to use the function.

 

The Concept of the Glossary

The glossary is a collection of language sensitive terminology used in the system.  A glossary item is reference by its ID number which is a system generated number.  The same glossary item can have several glossary entries - in different languages.  Glossary terms in a system defined language [jump to LANGUAGE CODES FUNCTION header help] is maintained by the development house (users cannot add, change or delete glossary entries in system defined languages.).  A user can create a terms in user defined languages for system defined items or add new glossary items in user defined languages.  The glossary entries for system defined languages are created as part of the system installation process.

 

The primary purpose is of the glossary is to aid users when customising captions on front ends.  A secondary purpose is to define terminology used in the system.

 

TERMINOLOGY

Glossary Item

Refers to a single number – the glossary ID  - regardless of the language in which it is defined.

 

Glossary Entry

Refers to a glossary item defined in a specific language.

 

Glossary Term

Refers to wording used to define a glossary entry.

 

Overview Tab

On this tab the user can search for glossary items and see where they are used as captions in the systems functions.  A user must have a profile linked to the Glossary function with view permission in order to use this search function.

 

The Glossary ID and Language combos and the Term Like textbox are provided to enter search criteria.  When values are entered, click on the search button to view results.  The search results are glossary entries that have a glossary ID equal to the one selected, and, exists in the language selected, and, have a term that contains the phrase entered in the Term Like text box as part of the term.  If any of the three parameters is omitted, the search uses a wild card on that field.  If the System Values option is selected as the view option, the results show glossary entries for system defined languages. When Customised Values is selected, the results show glossary entries for user defined languages.

 

The Where Used list show where the glossary entries listed are used as captions on the functions in the system.  (The reference to the front end captions is a fairly technical definition.  Refer to the "How a front end caption is referenced in the system" topic in the "Customised Function" help.)

 

On this tab the following fields can be viewed:

 

hmtoggle_plus1Add 3

To add a glossary entry, the Glossary ID must be empty, a language and term is required and a definition is optional.  The system generated numerically sequential glossary ID that will be created, will be displayed in the glossary ID combo.

hmtoggle_plus1Change 3

The user must have a security profile linked to the function Glossary with an access allowed of Change.

hmtoggle_plus1Delete 3

The user must have a security profile linked to the function Glossary with an access allowed of Delete.

hmtoggle_plus1Definition

A definition that describes the meaning of the term as used in the system.  The definition is optional.

[Database Reference: Reads from and writes to Glossary.Description1, Description2, Description3, Description14]

hmtoggle_plus1Glossary Id

A numeric list of all glossary Ids.  If selected, it acts as a parameter for the search.

hmtoggle_plus1Language

The language in which the term is defined.  The language is always required.

[Database Reference: reads from Language_Code.Language_Code and writes to Glossary.Glossary_ID]

hmtoggle_plus1Maintenance

hmtoggle_plus1Reset

This button resets the term on the form to the wording in the System Original language (I.E. the default system value).  Clicking the button does not update the database.

hmtoggle_plus1Results List Box

Show the Glossary ID, Language description, term and definition of glossary entries that are selected by applying the specified search parameters.

hmtoggle_plus1Search Button

Click this button to search or to fresh the results.

hmtoggle_plus1Term

The wording of the term in the selected language.  The term is always required .

[Database Reference: Reads from and writes to Glossary.Term]

hmtoggle_plus1Term Like

Enter characters or a phrase that youre looking for in his field. The result will include all terms that include the text in any part of the term – start, middle or end.

hmtoggle_plus1View Options

Select system values to view results of glossary items defined in a system defined language.

Select Customised values to view results of glossary items defined in a user defined language.

When the selected view option changes, the search results are refreshed.

hmtoggle_plus1Where Used List Box

This list shows on which functions the glossary terms returned by the search is used as captions.

 

Glossary entries are maintained on this tab.  In order to add, change or delete glossary entries, a user must have a profile linked to the glossary function with add, change or delete permission respectively. Glossary entries in system defined languages cannot be maintained.  A glossary term can be created or maintained in any user defined language.  Glossary terms created will have an ID number greater than 100 000 (the development house reserve numbers 0 to 99 999 for use).