Specify User Interface Preferences

Overview

This activity enables you to specify the user interface preferences for a component. You can define the UI configuration, control types, action patterns, precision types, business terms and hidden controls for a specified component.

Click the checkbox next to a component in the multiline and click the Specify User Interface Preferences link from the Define Process page.

The Specify User Interface Preferences page appears that enables you to define the user interface preferences for the selected component.

The following details are displayed in the header:

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

There are six tabs displayed namely Define UI Configuration, Define Control Types, Define Action Patterns, Define Precision Types, Define Business Terms and Define Hidden Controls.

Define UI Configuration

Click the Define UI Configuration tab from the Specify User Interface Preferences page.

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

To define the user interface configuration details

Enter the following fields:

Caption Control Separator	The character that you want to set as caption control separator. For e.g. :, - etc.
Caption Alignment for Checkbox and Radio Buttons	Use the drop-down list box to select an option to indicate the caption alignment for checkbox and radio buttons in the user interface. The following are the options displayed: Center the checkboxes and radio buttons are aligned in the center of the page Left the checkboxes and the radio buttons are aligned to the left of the page Right the checkboxes and the radio buttons are aligned to the right of the page Use Control Settings uses the checkbox and radio button controls settings defined in the Define Control Types tab. Mandatory
Caption Alignment for other controls	Use the drop-down list box to select an option to indicate the caption alignment for other controls (other than check box and radio buttons) in the user interface. The following are the options displayed: Center the other controls are aligned in the center of the page Left the other control are aligned to the left of the page Right the checkboxes and the radio buttons are aligned to the right of the page Right the checkboxes and the radio buttons are aligned to the right of the page Use Control Settings uses the other controls settings defined in the Define Control Types tab. Mandatory
Help Icon Placement for header controls	Use the drop-down list box to select an option to indicate the help icon placement for header controls in the user interface. The following are the options displayed: Right side of Control and Left side of Control. Mandatory
Horizontal Rule Size	The thickness of the horizontal line for the user interface. Enter the measurement / values in pixels.
Trail Bar Option	Use the drop-down list box to indicate the trail bar option that displays the navigation drill-down for the User Interface. The following are the options displayed : Bottom trail bar to be displayed only in the bottom of the user interface None trail bar is not required for the user interface Top trail bar to be displayed only in the top of the user interface Top and Bottom trail bar to be displayed both in the top and bottom of the user interface. Mandatory
Tab Height	The height in which tab sections should appear in the user interface. Enter the measurement in pixels. Mandatory
Section Margin	The measurement for the section margin in the user interface. This is the space between each section. Enter the measurement in pixels.
Section Cell Margin	The measurement for the section cell margin. This is the space between each control available in a section. Enter the measurement in pixels
Update default UI Configuration	Click the checkbox if you want to update the default UI configuration details globally across all components in the business process.
Overwrite UI Configuration definition	If the UI configuration is already used in the User Interface then, click the checkbox Overwrite UI Configuration definition and then click on Save UI Configuration to save the updated changes.

Click Save UI Configuration.

The user interface configurations details are saved for the selected component.

Note: The updated details are applicable for all the User Interface available to the component. This information can be overridden in the individual User Interface definition

Define Control Types

Click the Define Control Types tab from the Specify User Interface Preferences page.

The Define Control Types tab is displayed.

To define new control type

Click Fill Base Control Types to fill the Base Control Type combo box with values for selection.

The system fills the Base Control Types combo in the Define New Control Type and in the Maintain Control Types sections of the page for selection.

Enter the following fields in the Define New Control Type section of the page:

Control Type Name	The name of the control type. Mandatory
Control Type Description	The description of the control type. Mandatory
Base Control Type	Use the drop-down list box to select the base control type. A predefined list of base control types is displayed as options. Mandatory Refer List of Base Control Types for an explanation of the base control types and their attributes.
Default Control Type	Click the checkbox to set the control type as a default control type. If this checkbox is selected the control type is updated globally across all components.

Note: The Control Type Name field accepts characters a to z, A to Z, 0 to 9, _ (underscore). The first letter of the name should be a character.

Click Create New Control Type.

The new control type definition details are saved for the selected component component.

The new control type is added to the list of options in the Control Type Name combo control in the Maintain Control Types section of the page.

Note: The system validates for duplicate entries and displays an error message in case of a duplicate entry.

To maintain existing control types

Click Fill Control Types to fill the Base Control Type and Control Type Name combo box with values for selection.

The system fills the Control Type Name combo with values for selection.

Enter the following fields in the Maintain Control Types section of the page:

Control Type Name	Use the drop-down list box to select the control type whose attributes you want to view/edit. Mandatory
Control Type Description	The description of the selected control type. Mandatory
Base Control Type	The base control type that is associated with the selected control type. Use the drop-down list box to select a different base control type. A predefined list of base control types is displayed as options. Mandatory
Default Control Type	Click the checkbox to set the control type as the default control type. If this checkbox is selected the selected control type can be used globally across all components.
Overwrite Control Type Definition	Click the checkbox if you want to overwrite the existing control type definition details that have been already used by the user interface.

The list of properties for the selected Base Control Type is displayed in the Control Properties multiline:

Property Description	The description of the property for the selected base control type.
Accepted Values	The list of accepted values for the property.
Editable	The system displays Yes or No to indicate whether the property value is editable or not.

Note: On clicking the Update Control Type only the entered data is updated.

Enter the following field in the Control Properties multiline:

Property Value

The value that you want to set for the property.

Click Update Control Type.

The details of the control properties are saved.

To delete a control type

Select the following field:

Control Type Name

Use the drop-down list box to select the control type that you want to delete. Mandatory

The details of the selected control type are displayed in the respective fields.

Click Delete Control Type.

The selected control type and its attributes are deleted when it is confirmed.

List of Base Control Types

Base Control Type	Property		Accepted Values	Editable
Button	Control Alignment	Alignment of the button whether center, left or right.	Center, Left, Right	Yes
	Mandatory	Whether the button is mandatory to be clicked by the user. If Yes then the generated Htm control caption will be displayed in Bold	Yes, No	Yes
	Report Required	Whether report is required to be generated on click of the button.	Yes, No	Yes
	Text Wrap	Whether text wrap is applicable for the button description.	Yes, No	Yes
Checkbox	Caption Alignment	Alignment of the caption for the checkbox whether center, left or right.	Center, Left, Right	Yes
	Caption Required	Whether control caption is required for the checkbox.	Yes, No	Yes
	Caption Wrap	Whether text wrap is applicable for the checkbox caption.	Yes, No	Yes
	Control Alignment	Alignment of the control whether center, left or right.	Center, Left, Right	Yes
	Mandatory	Whether the checkbox is mandatory for selection by the user. If Yes then the generated Htm control caption will be displayed in Bold	Yes, No	Yes
	Visible	Whether the checkbox should be visible in the user interface.	Yes, No	Yes
Combo	Caption Alignment	Alignment of the caption for the combo whether center, left or right.	Center, Left, Right	Yes
	Caption Required	Whether caption is required for the combo control.	Yes, No	Yes
	Caption Wrap	Whether text wrap is applicable for the combo caption.	Yes, No	Yes
	Control Alignment	Alignment of the combo whether center, left or right.	Center, Left, Right	Yes
	Enumerated	Whether enumerated values should be set as Yes or Not for the combo. If Yes then the initialize stored procedure is not required; the system loads the specified enumerated values in the combo. If No then initialize stored procedure is invoked and values in the stored procedure are loaded in the combo.	Yes, No	Yes
	Handle Events	Whether handle events should be set as Yes or No. This indicates that when the value changes on selection in the combo, the values of another control should be changed on performing a task.	Yes, No	Yes
	Mandatory	Whether the combo is mandatory for selection in the user interface. If Yes then the generated Htm control caption will be displayed in Bold	Yes, No	Yes
	Visible	Whether the combo control should be visible in the user interface.	Yes, No	Yes
Data Hyperlink	Caption Alignment	Alignment of the caption for the data hyperlink whether center, left or right.	Center, Left, Right	Yes
	Caption Required	Whether caption is required for the data hyperlink control.	Yes, No	Yes
	Caption Wrap	Whether text wrap is applicable for the data hyperlink caption.	Yes, No	Yes
	Control Alignment	Alignment of the data hyperlink whether center, left or right.	Center, Left, Right	Yes
	Report Required	Whether report is required to be generated on click of the hyperlink.	Yes, No	Yes
	Text Wrap	Whether text wrap is required for the data hyperlink control.	Yes, No	Yes
	Visible	Whether the data hyperlink should be visible in the user interface.	Yes, No	Yes
Edit	Caption Alignment	Alignment of the caption for the text box whether center, left or right.	Center, Left, Right	Yes
	Caption Required	Whether caption is required for the text box.	Yes, No	Yes
	Caption Wrap	Whether text wrap is applicable for the text box caption.	Yes, No	Yes
	Control Alignment	Alignment of the edit control whether center, left or right.	Center, Left, Right	Yes
	Editable	Whether the text box is editable or display only. Editable control can be Edit box, Text Area or Password	Yes, No	Yes
	Ellipses Required	Whether ellipses is required or not. If Yes then an icon is displayed next to the control that enables the user to zoom and view the entire contents.	Yes, No	Yes
	Handle Events	Whether handle events should be set as Yes or No. This indicates that when the enter key is pressed in the control; values of another control should be changed on performing a task.	Yes, No	Yes
	Help Required	Whether help screen should be available for selection for the text box.	Yes, No	Yes
	Mandatory	Whether the control is mandatory for selection in the user interface. If Yes then the generated Htm control caption will be displayed in Bold.	Yes, No	Yes
	Password Field	The value Yes should be selected to indicate that the text box is for password entry.	Yes, No	Yes
	Text Area	Whether the text box should be set as text area. If Yes a larger box is displayed for multiple line entries. To enable this Editable should be Yes.	Yes, No	Yes
	Visible	Whether the text box should be visible in the user interface.	Yes, No	Yes
	Visible Rows	The number of editable lines that should be displayed for entry. Normally this is set as 1. If Text Area is set as Yes the number of visible rows for entry can be set as more than 1, maximum being 50.	1-50	Yes
Grid	Allow Row Deletion	Whether the records displayed in the grid can be deleted.	Yes, No	Yes
	Allow Row Insertion	Whether user can insert new rows in the grid.	Yes, No	Yes
	Allow Row Selection	Whether a record can be selected for further action.	Yes, No	Yes
	Caption Alignment	Alignment of the caption for the grid whether center, left or right.	Center, Left, Right	Yes
	Caption Required	Whether caption is required for the grid.	Yes, No	Yes
	Caption Wrap	Whether text wrap is applicable for the grid caption.	Yes, No	Yes
	Control Alignment	Alignment of the grid whether center, left or right.	Center, Left, Right	Yes
	Visible	Whether the grid should be visible in the user interface.	Yes, No	Yes
	Visible Rows	The number of rows that should be displayed in the grid. The maximum number of visible rows that can be set for the grid is 50.	1-50	Yes
	Zoom	Whether you want to set zoom facility for the grid contents.	Yes, No	Yes
HTML Filler	Width	The spacing between the controls.	1-100	No
HTML Horizontal Rule	Visible	Whether the horizontal line should be visible in the user interface.	Yes, No	Yes
Label	Caption Alignment	Alignment of the caption for the label whether center, left or right.	Center, Left, Right	Yes
	Caption Wrap	Whether text wrap is applicable for the label caption.	Yes, No	Yes
	Control Alignment	Alignment of the label whether center, left or right.	Center, Left, Right	Yes
	Mandatory	Whether the label is mandatory.	Yes, No	Yes
	Visible	Whether the label should be visible in the user interface.	Yes, No	Yes
Link	Control Alignment	Alignment of the control whether center, left or right.	Center, Left, Right	Yes
	Report Required	Whether report is required to be generated on click of the hyperlink.	Yes, No	Yes
	Text Wrap	Whether text wrap is applicable for the link control.	Yes, No	Yes
	Visible	Whether the hyperlink should be visible in the user interface.	Yes, No	Yes
Radio	Caption Alignment	Alignment of the caption for the radio button whether center, left or right.	Center, Left, Right	Yes
	Caption Required	Whether the control is mandatory for selection in the user interface. If Yes then the generated Htm control caption will be displayed in Bold	Yes, No	Yes
	Caption Wrap	Whether text wrap is applicable for the radio button caption.	Yes, No	Yes
	Control Alignment	Alignment of the radio button whether center, left or right.	Center, Left, Right	Yes
	Mandatory	Whether the radio button is mandatory for selection by the user.	Yes, No	Yes
	Visible	Whether the radio button should be visible in the user interface.	Yes, No	Yes

Define Action Pattern

Click the Define Action Patterns tab from the Specify User Interface Preferences page.

The Define Action Patterns tab is displayed.

To define new action pattern

Enter the following fields in the Define New Action Pattern section of the page:

Action Pattern Name	The name of the action pattern. Mandatory
Action Pattern Description	The description of the action pattern. Mandatory
Default Control Type	Click the checkbox to set the action pattern as a default action pattern. If this checkbox is selected the action pattern is updated globally across the component.

Note: The Action Pattern Name field accepts characters a to z, A to Z, 0 to 9, _ (underscore). The first letter of the name should be a character.

Click Create New Action Pattern.

The new action pattern definition details are saved for the specified business process component.

The new action pattern is added to the list of options in the Action Pattern Name combo control in the Maintain Action Pattern section of the page.

To maintain existing action patterns

Click Fill Action Patterns to fill the Action Pattern Name combo box with values for selection.

The system fills the Action Pattern Name control in the Maintain Action Pattern section of the page.

Enter the following fields in the Maintain Action Pattern section of the page:

Action Pattern Name	Use the drop-down list box to select the action pattern whose attributes you want to view/edit. Mandatory
Action Pattern Description	The description of the selected action pattern. Mandatory
Default Action Pattern	Click the checkbox to set the action pattern as the default action pattern. If this checkbox is selected the action pattern attributes are updated globally across all components in the business process.
Overwrite Action Pattern Definition	If the action pattern is used in the server and the user changes the Action Pattern properties and to update the changes click the checkbox to overwrite the action pattern definition details.

The list of properties for the selected Action Pattern is displayed in the Action Pattern Properties multiline:

Property Description

The description of the property for the selected action pattern.

Refer List of Action Pattern Properties for an explanation of the action pattern properties and their attributes.

Select the following field in the Action Pattern Properties multiline:

Property Required

Click the checkbox to indicate whether the property is required or not.

Click Update Action Pattern.

The details of the action pattern properties are saved.

Note: The system displays an error message in case of a duplicate entry

To delete an action pattern

Select the following field:

Action Pattern Name

Use the drop-down list box to select the action pattern that you want to delete. Mandatory

The details of the selected action pattern are displayed in the respective fields.

Click Delete Action Pattern.

The selected action pattern and its attributes are deleted when it is confirmed.

List of Action Pattern Properties

Property Description	Property Usage	Property Required
Data Saving Task	If the checkbox is selected, on clicking the User Interface Cancel button in run time, the system displays a message to the user This page has not been saved. Would you like to proceed? if OK is clicked then the control is transferred to the previous screen, if Cancel is clicked then the current screen is displayed (shown to the user).	Select / Unselect checkbox
Grid Fetch Required	During the Fetch Task whether the Grid should be filled with data. Displays data in the grid on launch of the user interface.
Grid Refresh Required	During the Trans task, UI task, Report Task whether grid should retrieve the existing data into the grid control.
Grid Save Required	During the Trans task, UI task, Report Task whether grid should store the gird contents in the database.
Header Check Required	During the Trans task, UI task, Report Task whether validation is required for the data in the header.
Header Fetch Required	During the Fetch task whether header control should display the data on launch of the user interface.
Header Refresh Required	During the Trans task, UI task, Report Task whether the header control should retrieve the existing data in the header controls.
Header Save Required	During the Trans task, UI task, Report Task whether the header control values are required to be stored in the database.
Task Confirmation	On performing the Trans Task in runtime whether a confirmation message is required for Save or Delete action.
Task Status	On performing the task in runtime whether the status message for the action should be displayed in the status bar.
Transaction Scope Required	On performing the task at runtime whether the transaction should be carried out in the transaction scope or not.

Define Precision Types

Click the Define Precision Types tab from the Specify User Interface Preferences page.

The Define Precision Types tab is displayed.

To view list of existing precision types

Click Fetch Precision Types to retrieve the existing precision types.

The list of existing precision types are retrieved and displayed in the Precision Type Details multiline.

Precision Type Name	The name of the precision type.
Precision Type Description	The description of the precision type.
Total Length	The total length of the precision type.
Decimal Length	The decimal length of the precision type.
Default Precision Type	The checkbox status indicates whether the precision type is set as the default precision type. If this checkbox is selected the precision type attributes are updated globally across all components in the business process.
Overwrite Precision Type Definition	The checkbox status indicates whether the precision type definition details can be overwritten or not. If the checkbox is left unchecked then changes cannot be made to the existing precision type definition details.

To define new precision types

Click in the multiline header to insert a blank row in the Precision Type Details multiline.
Enter the following fields in the multiline:

Precision Type Name	The name of the precision type.
Precision Type Description	The description of the precision type.
Total Length	The total length for the precision type.
Decimal Length	The decimal length for the precision type.
Default Precision Type	Click the checkbox to set the precision type as the default precision type. If this checkbox is selected the precision type can be used globally across all components.
Overwrite Precision Type Definition	If the precision is already in used in one or more Business Terms and the precision definition is changed then click the checkbox if you want to overwrite the precision type definition details.

Note: The Precision Type Name field accepts characters a to z, A to Z, 0 to 9, _ (underscore). The first letter of the name should be a character.

Click Save Precision Types.

The precision type definition details are saved for the selected component.

Note: The system validates displays an error message in case of a duplicate entry.

To delete a precision type

Click the checkbox next to a Precision Type in the multiline and click in the multiline header to delete the selected precision type.

The selected precision type details are deleted when it is confirmed.

Define Business Terms

Click the Define Business Terms tab from the Specify User Interface Preferences page.

The Define Business Terms tab is displayed.

To view list of existing business terms

Click Fill Precision to fill the Precision Type combo with values for selection in the Search Criteria section of the page.

The system fills the Precision Type control in the Search Criteria section and in the Business Terms Details multiline with values for selection.

Enter any or all of the following search criteria:

Business Term Name	The name of the business term whose details you want to retrieve.
Business Term Description	The description of the business term whose details you to retrieve.
Data Type	Use the drop-down list box to select the data type by which you want to retrieve the list of business terms. The list of existing data types is displayed as options.
Precision Type	Use the drop-down list box to select the precision type by which you want to retrieve the list of business terms. The list of existing precision types is displayed as options.
Length From	The starting length of the business term from which you want to retrieve the list of business terms.
Length To	The ending length of the business term until which you want to retrieve the list of business terms.
Fetch Default Business Term Only	Click the checkbox to retrieve only the list of default (global) business terms.

Click Search.

The list of existing business terms are retrieved and displayed in the Business Terms Details multiline based on the specified search and filter criteria:

Business Term Name	The name of the business term.
Business Term Description	The description of the business term.
Data Type	The data type to which the business term belongs. The data types are Character Ascii Fixed, Character Ascii Variable, Character Unicode Fixed, Character Unicode Variable, Date, Date Time, Integer, Numeric and Time.
Length	The length of the business term.
Precision Type	The precision type that is mapped to the business term.
Default Business Term	The checkbox status indicates whether the business term is set as the default business term. If this checkbox is selected the business term attributes are updated globally for all components in the business process.
Overwrite Business Term Definition	If the business term is in use and the business term definition is changed, the checkbox status indicates whether the business term definition details can be overwritten or not. If the checkbox is left unchecked then changes cannot be made to the existing business term definition details.

To define new business terms

Click in the multiline header if you want to insert a blank row in the Business Term Details multiline for entry.
Enter the following fields in the multiline:

Business Term Name	The name of the business term.
Business Term Description	The description of the business term.
Data Type	From the drop-down list box select an option to indicate the data type to which the business term belongs. The data types listed are Character Ascii Fixed, Character Ascii Variable, Character Unicode Fixed, Character Unicode Variable, Date, Date Time, Integer, Numeric and Time.
Length	The length of the business term.
Precision Type	If the data type of the business term is chosen as Numeric select the precision type that you want to map to the business term 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.
Default Business Term	Click the checkbox to set the business term as the default business term. If this checkbox is selected the business term attributes are updated globally across all components in the business process.
Overwrite Business Term Definition	If the business term is already in use in one or more control definition and the business term definition is changed then click the checkbox if you want to overwrite business term definition details.

Note: The Business Term Name field accepts characters a to z, A to Z, 0 to 9, _ (underscore). The first letter of the name should be a character.

Click Save Business Terms.

The business term definition details are saved for the specified business process component.

Note: The system validates displays an error message in case of a duplicate entry.

To delete a business term

Click the checkbox next to a Business Term in the multiline and click in the multiline header to delete the selected business term.

The selected business term details are deleted when it is confirmed.

To proceed carry out the following

Click the Maintain Synonym link to define the synonyms for business terms.

The Maintain Synonyms page appears that enables you to define the synonyms for business terms.

Define Hidden Controls

Click the Define Hidden Controls tab from the Specify User Interface Preferences page.

The Define Hidden Controls tab is displayed.

To view list of existing hidden controls

Click Fetch Hidden Controls to retrieve the list of existing hidden controls for the business process component.

The list of existing hidden controls are retrieved and displayed in the Hidden Control Details multiline.

Hidden Control Name	The name of the hidden control.
Business Term Name	The name of the business term mapped to the hidden control.
Data Type	The data type to which the business term belongs.
Length	The length of the business term.
Precision Type	The precision type is displayed if the data type of the business term is Numeric.
Default Hidden Control	The checkbox status indicates whether the hidden control is set as the default hidden control. If this checkbox is selected the hidden control attributes are updated globally across all components in the business process.

To define new hidden controls

Click Fill Precision to fill the combo values for the Precision Type control.

The system fills the Precision Type combo in the Hidden Control Details multiline with values for selection.

Click in the multiline header if you want to insert a blank row in the Hidden Control Details multiline for entry.
Enter the following fields in the multiline:

Hidden Control Name	The name of the hidden control.
Business Term Name	The name of the business term that you want to map to the hidden control. 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	The data type to which the specified business term belongs is displayed.
Length	The length of the business term is displayed.
Precision Type	The precision type is displayed if the data type of the business term is Numeric.
Default Hidden Control	Click the checkbox to set the precision type as the default precision type. If this checkbox is selected the precision type attributes are updated globally across all components in the business process.

Note: The Hidden Control Name field accepts characters a to z, A to Z, 0 to 9, _ (underscore). The first letter of the name should be a character.

Click Save Hidden Controls.

The hidden control definition details are saved for the specified business process component.

Note: The system displays an error message in case of a duplicate entry.

To delete a hidden control

Click the checkbox next to a Hidden Control in the multiline and click in the multiline header to delete the selected hidden control.

The selected hidden control details are deleted when it is confirmed.

Getting familiar with the pages inside

Go to page&	For&
Maintain Synonyms	Defining synonyms for business terms.

Prerequisites:

4 Business processes and components should have been defined through the Define Process activity.