Specify User Interface

Overview

This activity enables you to specify a new user defined screen, modify, delete and view the existing user defined screens. You can use the Business Process, components, Activity to specify the user interface layout for the screens. You can also specify the report, state, data extension, error messages for the tasks specified in the screens through this same page.

Select the “Define User Interface” activity under the “EDK – User Defined Screens” component.

The “Specify User Interface ” page appears.

Enter the following fields:

Business Process	Use the drop-down list box to select the business process for which you want to specify the user interface layout. Mandatory.
Component	Use the drop-down list box to select the component for which you want to specify the user interface layout. The list of components defined under the selected business process is displayed as options. Mandatory
Activity	Use the drop-down list box to select the activity for which you want to specify the user interface layout. The list of activities defined under the selected component is displayed as options. Mandatory
Reference UI Name	If you want fetch the existing control details enter the name of the reference UI and click “Default from Reference UI”. Click to select a user defined user interface from the “Help on User Interface” page. The control details are retrieved and displayed in the respective tab which can be modified. Note: This is applicable for the control details including page and sections.
User Interface Name	The name of the user interface for which you want to specify the layout. Mandatory. Click to select an existing user interface from the “Help on User Interface” page. You can enter the user interface name for creating a new user interface
User Interface Description	The description of the user interface.
Entry Point Screen	Select the check box to indicate that the user interface is the entry point screen of the activity.

There are four tabs displayed viz. User Interface Properties, Specify Controls, Specify Grid Contents, and Generate Service.

User Interface Properties

This tab allows you to specify the properties of the user interface defined. In this tab, you can specify the UDS extension type and the data extension properties.

Click the “User Interface Properties” tab to specify the user interface properties.

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

Click any one of the following from the “Extension Type” group box:

UDS Extension Type

The extension type of the user defined screen.

Data Extension – Click the radio button to indicate that the UDS extension is data extension.

Logic Extension – Click the radio button to indicate that the UDS extension is logic extension. Control details are not applicable for logic extensions.

None – Click the radio button to indicate that the UDS extension is not applicable for this user defined interface

Click the following from the “Data Extension Properties” group box:

Data Extension Type

The data extension type of the user defined screen.

Mandatory – Click the radio button to indicate that the data extension is mandatory for the user defined screen.

Non Mandatory – Click the radio button to indicate that the data extension is non mandatory for the user defined screen.

Conditional Mandatory – Click the radio button to indicate that the data extension is conditional mandatory for the user defined screen.

Independent Transaction

Select the check box to indicate that the extension transaction is independent.

Click the “Save User Interface Properties”.

The system saves the user interface properties of the UDS. If the user defined screen is not available then it is created here. Main Page and Main Section will be added during the user defined screen creation that will be used for control definition.

Note:

Extension Details

When the UDS Extension Type is selected as “None”, then extension is not possible for the user defined screen.
When the UDS Extension Type is “Data Extension” and the Independent Transaction check box is selected, then user defined screen is allowed to define more than one Base screen extensions.
When the UDS Extension Type is “Data Extension” and the Independent Transaction check box is not selected, then only one to one extension between UDS and Base screen is allowed.

While defining the extension details in Specify data transfer, two extension Tasks will be generated.
One task for Screen Task execution and Data transfer will be done to the previous UI. This task will save data temporarily in the database based on transaction keys.
Another Task for Extension Data Item mapping from Base UI. This task will be invoked by the base service and it will run in the base service transaction. The temporary data saved in the uds screen is updated to the main objects here.

When the UDS Extension Type is “Logic Extension” – While defining the extension details in Specify data transfer one extension task will be generated and it will be associated in base UI through Extension Data Item Mapping. Multiple extensions will be possible with different base user interfaces and tasks. This task will be invoked by the base service and it will run in the base service transaction. This is mostly used for additional validations for the base screens.

Specify Controls

This tab enables you to define the control details for each section in a given page/tab in the user interface. The system captures the control name, control prefix, control type, caption for the control, the business term to be mapped to the control, the data type to which the business term belongs, the length and precision of the business term, the visible length of the control and the tab sequence for the control.

Click the “Specify Controls” tab to define the control details for the user interface.

The “Specify Controls” tab is displayed.

Select the following field:

Page	Use the drop-down list box to select the page for which you want to define the controls. The list of pages defined for the specified user interface through the “Specify Pages” user interface is displayed as options.
Section	Use the drop-down list box to select the section for which you want to define the control details. The list of sections defined for the selected page through the “Specify Sections” user interface is displayed as options.

Enter the following fields in the “Control Details” multiline:

Control Name	The name of the control.
Control Type	Use the drop-down to select the type to which the control belongs. The list of control types defined through the “Define Control Types” tab in “Specify User Interface Preferences” page is displayed as options.
Caption	The caption for the control.
Business Term Name	The business term that you want to map to the control. If you know the existing business term, enter the business term and press <Enter> or click to select a business term from the “Help on Business Terms” page. The last saved details of the specified business term are retrieved and displayed in the subsequent fields. You can also define a new business term here.
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”. Note: If the business term is specified the data type is automatically fetched and displayed when you press <Enter>.
Length	The length of the business term.
Precision	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 in “Specify User Interface Preferences” page is displayed as options.
Control Visible Length	The visible length of the control.
Caption Visible Length	The visible length of caption.
Control Position(row,col)	The position of the control in terms of row and column. When the control position is not provided then system itself will generate the control positions. The control positions starts with first row and first column and goes on. If the user had provided the row position then from that control the row position is associated and the column position will start from one.
Control Col Span - Specified	The specified column span for control.
Caption Col Span – Specified	The specified column span for caption.
Tab Sequence	The tab sequence for the control.

Click “Save Control Information”.

The control details for the given section and page combination in the specified user interface are saved.If the user defined user interface details are not available then those details are also saved here along with the default Main Page and Main Section.

The system displays the following:

Control Col Span - Computed	The computed column span for control.
Caption Col Span - Computed	The computed column span for caption.

Note: The control definition is not applicable for Logic Extension user interface type.

The control name entered should be unique across the control types such as grid column, grid hidden column, hidden views, hidden control and report additional fields for each user interface.

After saving the control definition, control type cannot be modified. However the modified base control type specified in the “Define Control Type” is same then that will be modified. To modify the control type the existing control has to be deleted and created again.

Business terms can be created in this tab, if the business term is not used in another screen then the user is allowed to change the business term details. If the business term is already used in another screen then modify the necessary changes in the Specify User Interface Preferences > Define Business Terms.

If the editable control is defined for the user interface then system will create the fetch task for the User Interface.

If the control base type is combo and enumerate is not set then initialize task is created for the user interface.

If the defined control base type is grid then on deleting the grid then all the grid details such as grid column, grid hidden column, hidden views will also be deleted

If the defined control base type is a button then its associated task is created. When the control is deleted the associated service will also be deleted.

If the defined control type contains help / link then the appropriate task is created

If the defined control base type is enumerated combo then initialize task will not be generated for that combo. When the enumerated combo is deleted then the associated enumerated values will also be deleted.

If the defined control base type is a radio button option, when the control is deleted the corresponding enumerated values will also be deleted.

If the defined control such as fillers, grid, html rule, link and buttons are not used in the service data. In these cases system will automatically default the bt name as “system BT”

To fetch control information

Click “Fetch UI Information” you need to select the required page and section drop downs to fetch the control information for that sections.

To fetch default control information from reference UI

Enter the following field in the header:

Reference UI Name

The name of the user interface from which you want to fetch the existing control details. Click to select a user interface from the “Help on User Interface” page.

Click “Default from Reference UI”.

The control details that have defined in the specified reference user interface are retrieved and displayed in the respective fields.

You can modify the details displayed in Specify Controls, Specify Grid contents,Specify pages UI and Specify sections UI

Specify Grid Contents

This tab enables you to define the content details for a selected grid and section in the given page/tab in the user interface.

Click the “Specify Controls” tab to define the grid control details for the user interface.

The “Specify Controls” tab is displayed.

Select the following field:

Page	Use the drop-down list box to select the page for which you want to define the grid details. The list of pages defined for the specified user interface through the “Specify Pages” tab is displayed as options.
Section	Use the drop-down list box to select the section for which you want to define the grid details. The list of sections defined for the selected page through the “Specify Sections” tab is displayed as options.
Grid	Use the drop-down list box to select the grid for which you want to define the content details. The list of grids defined through the “Specify Controls” tab is displayed as options.

Enter the following fields in the “Grid Details” multiline:

Column Name	The name of the column control.
Column Type	Use the drop-down to select the type to which the column control belongs. The list of control types defined through the “Define Control Types” tab in “Specify User Interface Preferences” page is displayed as options.
Caption	The caption for the column control.
Business Term Name	The business term that you want to map to the column control. If you know the business term, enter the business term and press <Enter> or click to select a business term from the “Help on Business Terms” page. The last saved details of the specified business term are retrieved and displayed in the subsequent fields. You can also define a new business term here.
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”. Note: If the business term is specified the data type is automatically fetched and displayed when you press <Enter>.
Length	The length of the business term.
Precision	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 in “Specify User Interface Preferences” page is displayed as options.
Visible Length	The visible length of the column control.
Column Sequence	The sequence for the column control.
Column Visible	Select the check box to indicate that the column control will be visible.

Click “Save Grid Contents Information”.

The content details for a selected grid and section in the given page/tab in the user interface are saved.

Note:

Note: The grid column name entered should be unique across the control types such as control name, Grid hidden column, hidden views, hidden control and report additional fields for each user interface.

After saving the grid column definition, control type cannot be modified. To modify the control type the existing column detail has to be deleted and created again. However the modified base control type specified in the “Define Control Type” is same then that will be modified.

The business term can be created in this tab, if the business term is not used in another screen then the user is allowed to change the business term details. If the business term is already used in another screen then modify the necessary changes in the Specify User Interface Preferences > Define Business Terms.

If the editable grid column is defined for the user interface system will create the fetch task for the user interface.

If the grid column base type is combo and enumerate is not set then initialize task is created for the user interface.

If the defined grid column control type contains help / link then the appropriate task is created for the user interface.

If the defined column base type is enumerated combo then initialize task will not be generated for that combo. When the enumerated combo is deleted then the associated enumerated values will also be deleted.

To fetch grid content information

Click “Fetch UI Informatio"..
Select the Page, Section, Grid to get the required grids Grid column details.

Generate Service

This tab enables you to map action patterns to actions and task types for a selected page in the given user interface. If an action pattern that is mapped to an action is not applicable, then the respective error message will be displayed.

Click the “Generate Service” tab to generate the services for the user interface.

The “Generate Service” tab is displayed.

Select the following fields:

Page

Use the drop-down list box to select the page for which you want to generate the services. The list of pages defined for the specified user interface through the “Specify Pages” tab is displayed as options.

The list of actions and task types for the actions defined for the selected page is displayed in the “Action Details” multiline:

Action Name

The name of the action defined for the page.

Note: If reports have been defined for the selected page, report definition details should be completed before you generate the services for the report action.

Action Description	The description of the action defined for the page.
Task Type	The type of task associated with the action.
Service Name	The name of the service is generated and displayed for the action when you click “Generate Service”.

Select the following field in the “Action Details” multiline:

Action Pattern

Use the drop-down list box to select the action pattern that you want to map to the action and task type displayed. The list of action patterns defined for the business process component through the “Specify User Interface Preferences” page is displayed as options.

To generate services

Click the checkbox next to select an action and click “Generate Service”.

The system generates the service for the selected actions in the given page in the user interface.

Note: Note: If an action pattern has been modified then you have to select the existing action pattern mapping and click “Generate Service” once again to update the details for that action pattern.

To proceed carry out the following

Click the “Specify Errors” link to specify the error message details for the specified component.

The “Handle Message” page appears that enables you to define the error message details for the selected component.

Click the “Report Definition” link to define the report details for the user interface.

The “Report Definition” page appears that enables you to define the report details for the specified user interface.

Click “Generate Preview” to generate the preview for the user interface.

The system generates displays a preview of the user interface in a separate window.

Click the “Extension Data Item Mapping” link to define the extension data item mapping for the user interface.

Click “Generate Preview” to generate the preview for the user interface.

The system generates and displays a preview of the user interface in a separate window.

Click “Delete User Interface” to delete the user interface.

The system deletes the selected user interface.

Click the “Specify UI Configuration” link to specify the UI configuration for the user interface.
Click the “Specify Pages” link to specify the pages for the user interface.
Click the “Specify Section” link to specify the sections for the user interface.
Click the “Specify Radio Buttons” link to specify the radio buttons for the user interface.
Click the “Specify Hidden Views” link to specify the hidden views for the user interface.
Click the “Specify Enumerated Values” link to specify the enumerated values for the user interface.
Click the “Specify Data Transfer” link to specify the data transfer for the user interface.
Click the “Specify Combo Re-Load” link to specify the combo re-load for the user interface.
Click the “Specify UI State” link to specify the UI state for the user interface.
Click the “Specify Ezee View” link to specify the ezee view for the user interface.
Click the “Maintain Synonym” link to define and maintain the synonym details for the component.

The “Maintain Synonym” page appears that enables you to define and maintain the synonym details for the specified component.

Click the “Generate Deliverables” link to generate the deliverables for the component.

The “Generate Deliverables” page appears that enables you to generate the deliverables for the specified component.

Getting familiar with the pages inside

Go to page…	For…
Specify User Interface	Specifying user interface layout for the screens in a business process component activity

Prerequisites:

4Business process, components and activities should have been defined.