Maintain Synonyms

Overview

This activity enables you to define the synonyms for user interfaces under an activity in a component for Multilanguage support. You can define the UI control synonyms and non UI controls synonyms for the business terms for a selected component, activity and user interface.

Click the checkbox next to a component in the multiline and click the “Specify User Interface Preferences” link from the “Define Process” page.
Click the “Maintain Synonyms” link from the “Define Business Terms” tab in the “Specify User Interface Preferences” page.

The “Maintain Synonyms” page appears that enables you to create/edit/view the UI control and non UI control synonyms for the selected component.

The following details are displayed in the header:

Business Process	The name of the selected business process is displayed from the main page.
Component	The name of the selected component under the specified business process is displayed from the main page.

Select the following fields in the header:

Activity	Use the drop-down list box to select an activity for which you want to view/define UI control and non UI control synonyms. The activities that have been defined for the given component is listed as options.
User Interface	Use the drop-down list box to select a user interface for which you want to view/define UI control and non UI control synonyms. The user interfaces that have been defined for the selected activity is listed as options.
Language	Use the drop-down list box to select the language for which you want to view/define UI control and non UI control synonyms. The available languages are listed as options.

There are two tabs displayed namely “UI Control Synonym” and “Non UI Control Synonym”.

UI control Synonyms

Click the “UI Control Synonyms” tab from the “Maintain Synonyms” page.

This tab is displayed by default on launch of the page.

To view list of existing UI control synonyms

Enter the following search criteria:

Synonym	The equivalent word for the control whose details you want to retrieve. You can specify the synonym fully or partially using the “*” as the wild card character. All the synonyms similar to the value entered are retrieved and displayed.
Caption	The caption for the control whose details you want to retrieve. You can specify the caption fully or partially using the “*” as the wild card character. All the captions similar to the value entered are retrieved and displayed.
Business Term Name	The business term mapped to the control by which you want to retrieve the list of synonyms. If you know the business term enter the business term else click to select a business term from the “Help on Business Terms” page.
Data Type	Use the drop-down list box to select the data type by which you want to retrieve the list of synonyms. The data types listed are “Character – Ascii Fixed”, “Character – Ascii Variable”, “Character – Unicode Fixed”, “Character – Unicode Variable”, “Date”, “Date – Time”, “Integer”, “Numeric” and “Time”. Note: If the business term is specified the data type is automatically fetched and displayed when you press <Enter>.
Precision	If the data type of the business term is chosen as “Numeric” select the precision type by which you want to retrieve the list of synonyms from the drop-down list box. The list of precision types defined through the “Define Precision Types” tab for the business process component is displayed as options.
Length From	The length of the business term from which you want to retrieve the list of synonyms.
Length To	The length of the business term until which you want to retrieve the list of synonyms.

Click “Search”.

The system retrieves and displays the list of UI control synonyms based on the specified search and filter criteria in the “UI Control Details” multiline:

Synonym	The equivalent word for the control.
Caption in English	The caption for the control in English.
Caption	The caption for the control in the selected language.
Business Term Name	The business term that is mapped to the synonym.
Data Type	The data type to which the business term belongs. The data type can be any one of the following: “Character – Ascii Fixed”, “Character – Ascii Variable”, “Character – Unicode Fixed”, “Character – Unicode Variable”, “Date”, “Date – Time”, “Integer”, “Numeric” or “Time”.
Precision	If the data type of the business term is chosen as “Numeric” the precision is displayed.
Length	The length of the business term.
Overwrite Synonym Definition	The checkbox status indicates whether the synonym definition details can be overwritten or not. If the checkbox is left unchecked then changes cannot be made to the existing synonym definition details.

To modify the UI control synonyms

Enter the following details in the “UI Control Details” multiline:

Synonym	The equivalent word for the control. (Non editable)
Caption in English	The caption for the control in English. (Non editable)
Caption	The caption for the control in the selected language. For e.g., if the language is chosen as French enter the equivalent word for the caption in French.
Business Term Name	The business term that you want to map to the control. If you know the business term enter the business term else click to select a business term from the “Help on Business Term” page.
Data Type	The data type to which the business term belongs. The data type can be any one of the following: “Character – Ascii Fixed”, “Character – Ascii Variable”, “Character – Unicode Fixed”, “Character – Unicode Variable”, “Date”, “Date – Time”, “Integer”, “Numeric” or “Time”. Note: If the business term is specified the data type is automatically fetched and displayed when you press <Enter>.
Precision	If the data type of the business term is chosen as “Numeric” the precision is displayed.
Length	The length of the business term.
Overwrite Synonym Definition	Click the checkbox to indicate whether the synonym definition details can be overwritten or not. Since the synonym details are already in use, If the checkbox is left unchecked then changes cannot be made to the existing synonym definition details.

Click “Save”.

The UI control synonyms details are saved for the specified user interface.

Note: Caption details are updated based on the selected Language combo value.

Non UI Control Synonyms

Click the “Non UI Control Synonym” tab from the “Maintain Synonyms” page.

The “Non UI Control Synonym” tab is displayed.

To view list of existing non UI control synonyms

Enter the following search criteria:

Synonym

The equivalent word for the control whose details you want to retrieve.

You can specify the synonym fully or partially using the “*” as wild card character. All the synonyms similar to the value entered are retrieved and displayed.

Caption

The caption for the control whose details you want to retrieve.

You can specify the caption fully or partially using the “*” as wild card character. All the captions similar to the value entered are retrieved and displayed.

Synonym Used For

Use the drop-down list box to select the control by which you want to retrieve the list of non UI control synonyms. The options listed are “Activity”, “Button”, “Component”, “Enumerated Value”, “Link”, “Page”, “Precision Type”, “Section”, “Task Confirmation”, “Task Status Message” and “User Interface”.

Click “Search”.

The system retrieves and displays the list of non UI control synonyms based on the specified search and filter criteria in the “Non UI Control Synonym Details” multiline:

Synonym Used For	The non UI control for which the synonym is being used. If All is selected then all the non UI control details are displayed in the grid “Non UI Control Synonym Details”
Synonym	The equivalent word for the non UI control which includes Activity, Button, Component, Enumerated value, Link, Page, Precision Type, Section, Task Confirmation, Task Status Message and User Interface
Caption in English	The caption for the non UI control in English.
Caption	The caption for the non UI control in the selected language.
Remarks	The text that should be displayed as an error message to the user.
Activity	The name of the activity in which the control appears. This is applicable for button controls.
User Interface	The name of the user interface in which the control appears.
Page	The page in the user interface in which the control appears.
Section	The section in the page in which the control appears.
Control	The name of the non UI control.

To modify the existing non UI control synonyms

Enter the following details in the “Non UI Control Synonym Details” multiline:

Synonym Used For	The non UI control for which the synonym is being used. (Non editable)
Synonym	The equivalent word for the non UI control. (Non editable)
Caption in English	The caption for the non UI control in English. (Non editable)
Caption	The caption for the non UI control in the selected language.
Remarks	Displays the maximum length details of the Synonym caption. The caption length varies based on the “Synonym Used For” value.
Activity	The name of the activity in which the non UI control appears. This is applicable for button controls.
User Interface	The name of the user interface in which the non UI control appears.
Page	The page in the user interface in which the non UI control appears.
Section	The section in the page in which the non UI control appears.
Control	The name of the non UI control.

Click “Save”.

The non UI control synonyms details are saved for the specified user interface.

Note: If the caption length exceeds the Length available in the remarks then the system will display an error message. The caption details are updated based on the selected Language combo value.

Prerequisites:

4 Business processes, components, activities and user interfaces should have been defined through the “Define Process” activity.

4 Control types, precision types and business terms should have defined for the business process components.