Smart Help Designer

Component overview

Glossary

Basics of using Ramco Enterprise series web page

Using online help

This page allows you to design the help ilbo of the activity. You have to specify the stored procedure name to get the header, multiline and property page details of the help ilbo. Once the details are fetched you can modify the details of control and grid column.

The “Smart Help Designer” page appears.

Help ILBO Description

A unique name of the help ilbo.

The system displays the following in the “Help ILBO Description” group box.

Help ILBO Code

The code identifying the help ilbo.

The system displays the following in the “ILBO Associated To” group box.

Activity Description

The name of the activity for which the help ilbo to be designed.

Activity Name

The description of the activity.

Component Description

The name of the component.

Component Name

The description of the component.

Stored Proc. Name

The stored procedure name defined for the help ilbo.

Update Existing Help ILBO

 

Task Name

The task name of the help ilbo.

OU Instance Name

Use the drop-down list box to select the organization unit (OU) instance name for the help ilbo. The combo is loaded with the values as defined in the “Masters”.

The Smart Help Designer page has 2 tabs.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Tab: Screen Details

Based on the details entered, system retrieves the data and displays in the multiline.

The system displays the following in the “Help Screen Header Details” multiline.

Control ID

A unique identification number of the controls in the help screen.

Control Type

Use the drop-down list box to select the control type. The combo is loaded with the values as defined in the “Masters”. More Details.

Caption

The caption name of the control.

Row No.

The position of the control in row wise.

Col No

The position of the control in column wise.

Visible Length

The visible length of the control.

The system displays the following in the “Help Screen Header Details” multiline.

Data Type                

The data type specified for the control.

Precision

The precision value of the datatype.

For example: If the datatype is specified as .00, the system displays the precision value as 2. If the datatype is specified as .000, the system updates the precision value as 3.

Precision Type

Use the drop-down list box to select the precision type defined for the control in the help screen. The combo is loaded with the values as defined in the “Masters”.

Default Value

The default value for the control.

Sample Data

The sample data for the control.

UDD Name

The User Defined Datatype (UDD) name of the control.

UDD Length

The total length defined of the user defined datatype.

No. of Visible Rows

The number of rows to be visible in the multiline of the help screen.

The system displays the following in the multiline.

Control Name

The name of the control to be displayed in the multiline.

Column Ordinal

The sequence number of the column to be displayed in the multiline.

Column Caption

The caption name for the control.

The system displays the following in the multiline.

Column Type

The type of column inserted in the multiline.

Visible Length

The visible length of the column.

The system displays the following in the multiline.

BT Data Type

The datatype for the business term specified to the control.

Precision

The precision value of the datatype.

For example: If the datatype is specified as .00, the system displays the precision value as 2. If the datatype is specified as .000, the system updates the precision value as 3.

Precision Type

Use the drop-down list box to select the precision type defined for the column in the help screen. The combo is loaded with the values as defined in the “Masters”.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Tab: Property Page

Control Name

Use the drop-down list box to select control name to which the properties has to be defined. The combo is loaded with the values as defined in the “Masters”.

View Name

Use the drop-down list box to select the view name of the control. The combo is loaded with the values as defined in the “Masters”.

The system displays the following in the multiline.

Property Name

The property name those defined for the control.

Value

The values to be defined for the control properties.

The system displays the following details in the multiline.

Description

The description of the control property.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

The details of the Control Type

Control Type

Description

RSAttachDoc

To define file upload control.

RSButton

To define button control.

RSCheck

To define checkbox control.

RSCombo

To define combo control.

RSComboUI

To define the combo control mapped to the UI task.

RSDisplayOnly

To define non editable control.

RSEdit

To define editable text box.

RSEditHelp

To define a text box with help icon.

RSEditUI

To define a text box with On Enter task.

RSEditUIHelp

To define a text box with help icon mapped to the UI task.

RSFiller

To define an empty space between the controls.

RSGrid

To define multiline control.

RSHelp

To define help control.

RSHidden

To define hidden control.

RSLink

To define a link control.

RSListEdit

To define an autocomplete text box.

RSListEditUI

To define an autocomplete text box mapped to the UI task.

RSReportButton

To launch a report by clicking the button.

RSReportLink

To launch a report by clicking the link.

RSTextArea

To define the text area control.