Navigation:  Business Operations >

Customised Functionality

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

This function provides functionality to customise the captions that appear on the functions (also referred to as forms) in the system.  Customisation refers to either translation in different languages or substituting terms with preferred terminology.  Captions can be customised by language or by language and user.  When a function opens, the customised captions - if there are - will be used.  If no customised values exist, the system default values will be used.  The system default values are the captions for the System Original language.  The language in which the captions can be displayed is firstly dependant on the logged on user's language preference (set on the Employee Information function) and secondly or alternatively on the company's default language (set on the System Configuration function).

 

How front end captions are referenced in the system

The system stores data about the controls on the forms in system tables in the database - this data always ships with the system.  It is not always easy to identify the control by its name.   Though the naming convention used should make it easier, it is usually easier to look at the captions to find the control you are looking for.

 

The following section is fairly technical.  It is recommended for users of whom there are required to understand detail about the working of this function.  Users who want to use the function to do bulk translation or customisation without understanding the underlying data structures and processes, can continue reading the help on the tabs.

 

The data required to provide this functionality are mainly stored in 3 tables:

. Front_End_Control,

. Front_End_Control_Detail and

. Front_End_Control_Customised

 

All three are considered to be system tables - which means that incorrect data modification in them may cause system instability.  Four values are used to identify a control: The Function it is on, the control's name, the index and the context.  Col and Row identify a specific row and/or column within a control.  Captions are associated with a function, control name, index and context with the applicable row and/or column.  For controls where a row or column is not applicable (a normal text box for instance), a zero will be stored in the row and col fields.  Take note that because of technical considerations, zero can also reference the first row or column - a user need not be concerned about it, only aware of it to identify the correct caption to maintain.  Only system default captions are stored in the Front_End_Control_Detail table (no captions in the Front_End_Control Table).  Customised and translated captions  are stored in the Front_End_Control_Customised table.  In this table the employee ID and language code are also required to identify a single caption.

 

How captions to be displayed are determined

A language preference method is defined in the system. (For release 6.1, this method is determined by the development house and cannot be change by system users.)  When selecting a caption, the caption in the language with the highest preference is selected.  The languages in order of preference are:

1.  employee's preferred language

2.  company's default language

3.  System Original language (i.e. system default value)

 

Users can define their own languages in the system (refer to the language codes help).  One of the requirements for a user defined language is that it must be based on a system defined language.  In so doing, instead of redefining all captions in the user defined language, it is only necessary to define the items that differ from the system definition (the values for system defined languages are available form the development house).  A caption in a user define language, takes preference above the same item in a system language.  Thus, the extended order of language preference is:

1.  employee's preferred user defined language

2.  language on which employee's preferred user defined language is based (this language is deducted from the language code table and is not read from the employee master table)

3.  company's user defined default language

4.  language on which company's user defined default language is based (this language is deducted from the language code on system configuration  and is not read directly from system configuration)

5.  System Original language (i.e. system default value)

 

Since captions can be customised on user level, the system will give preference to a value customised for the logged on user in a language above the general value specified for the same language.  Theoretically, the final preference for captions to be displayed is as follows:

1.  user define value in employee's preferred user defined language

2.  general value in employee's preferred user defined language

3.  user define value in language on which employee's preferred user defined language is based

4.  general value in language on which employee's preferred user defined language is based

5.  user define value in company's user defined default language

6.  general value in company's user defined default language

7.  user define value in language on which company's user defined default language is based

8.  general value in language on which company's user defined default language is based

9.  System Original language (i.e. system default value)

 

In practice (when this help file was created it is release 6.1) the user defined values in the employee's preferred language, be it a user defined or system define language, is not considered.  The following table summarises the preference that is used:

 


 Employee's Preferred Language

 Company's Default language

 

Preference

 User Defined Value

 Language Is User Defined

 Language Is System Defined

 Language Is User Defined

 Language Is System Defined

 System Default

1

 No

 Yes

 No

 No

 No

 No

2

 No

 No

 Yes

 No

 No

 No

3

 Yes

 No

 No

 Yes

 No

 No

4

 No

 No

 No

 Yes

 No

 No

5

 Yes

 No

 No

 No

 Yes

 No

6

 No

 No

 No

 No

 Yes

 No

7

 No

 No

 No

 No

 No

 Yes

 

Using this sequence, the first available caption will be selected and displayed on the front end.

 

Referencing a Glossary item from the front end control definition

A system reference to the glossary is included with the control data that ships with the system.  The reference is only a glossary ID and assumes the term in the system original language.  A second, user defined, reference can be specified on the Glossary Reference tab of the Customised Function function.  For this reference a glossary ID and a language code is required.  The both the system defined and user defined glossary reference can be used to speed up the translation or customisation of forms' captions.  This process is explained on the help of the Maintenance tab of the Customised Function function.

 

HEADER

Select the controls to view or maintain by selecting a function or function and a specific control.  The data shown or maintenance that will be done on the three tabs, refer to the selected controls.

 

CUSTOMISED VALUES TAB

This tab is an information display and shows in which languages the selected controls are translated or customised.

 

GLOSSARY REFERENCE TAB

On this tab a user can customised a glossary reference to a front end control caption.  The customised values are shown in the Language and Cust Glossary ID columns in the list.  If no customised reference is specified, the Language column in the list will be System Original and the Cust Glossary ID column will be 0 (zero).  The customised glossary reference can be in any language and be any glossary ID the user deems most appropriate.  A term must exist for the glossary ID in the selected language to apply the customisation.  The customised reference will not automatically be applied as the caption for the control.  It is used to automatically select a value for customisation on the maintenance tab.  To delete the customised reference, select the control in the list, clear the Customer Glossary ID and Customer Language fields and click apply.  The Language will be reset to System Original and the Glossary ID will be reset to 0 (zero).

 

MAINTENANCE TAB

Captions on functions can be customised or translated on this tab.  The easiest way to do this is to make use of the glossary by following the next few steps:

1.  Select the function to be customised

2.  Make sure the "Default To Glossary Term" box is checked

3.  Select a language in which the captions must be customised

4.  Click the select all button.

5.  Confirm that the captions are correct - change if necessary

6.  Click the apply button.

 

In general, lines are added to the grid for preparation.  When the apply button is clicked, the values in the grid are written to the database.  The Language, Name and Caption columns can default if Default To Glossary Term, Language and Employee are selected respectively.  The default values can be changed.

 

On this tab the following fields can be viewed:

 

hmtoggle_plus1Control Name

The list shows controls for the selected function.  If no control is selected, all the controls are shown in the listbox.

hmtoggle_plus1Function Internal Name / Function Caption

Select the function to view or maintain in this combo.  The names for the functions that appear in the list are determined by the Select Function By option. The list always references the same functions and is determined by system tables.

hmtoggle_plus1Listbox

The entries that define the controls on the form, or the entries that define the selected control, are listed.

Control

Index

Context

Col

Row

Caption

Tooltip

Language

Cust Glossary ID

Term

System glossary

hmtoggle_plus1Select Function By Option

A function to view or maintain can be selected by the internal name or by its caption.  The caption is the name by which the function is known in the system (it can be customised using the Customised Menu function) and the Internal Name is the technical name used by the system to identify the function.  By changing this option the caption of, and the values listed in, the first combo to the right of this option changes accordingly.