Versions Compared

Version Old Version 5 New Version Current
Changes made by

Lakshminarayanan1 S CTOO

Lakshminarayanan1 S CTOO

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Lookup is a text field that allows searching and selecting the data within a widget which is likely to be the input.

...

Info

To change the widget, click the SETTINGS icon.


Adding a template for Lookup form item

To add a template for the Lookup form item, you have to specify the JSON structure of the single-click selection for the selected lookup form item along with the appropriate template ID in the APPLICATION_CONFIG column present in the FORM_ITEM_DEFINITION table in the Canvas schema. You must use the relevant template ID to specify the appropriate template which needs to be added to the selected lookup form item. The following code snippet serves as a sample reference: 

Code Block
languageactionscript3
{
 "enableSingleClk":true,
 "returnRowData":true,
 "selectedTemplateUrl":"NEWTEMPLATE" // The template ID is NEWTEMPLATE
}


The sample DB entries to be provided in the FORM_ITEM_DEFINITION table for adding a template to the Lookup form item are listed as follows:

Note

In the following example, the provided DB entries are associated with the MySQL database. However, the following listed DB entries are applicable for other databases like Oracle, Postrgre and MSSQL. 


Column Names
Column Values
APPLICATION_IDMODELHOUSE
FORM_IDNEW_FORM
ITEM_IDLOOKUP
PARENT_IDNEW_FORM
POSITION1
ITEM_TYPE20
DISPLAY_NM_KEY(NULL)
PLAIN_LBLLookup Field
LAYOUT(NULL)
ANCHOR100
BUNDLE_KEYcommon
MIN_LENGTH(NULL)
MAX_LENGTH(NULL)
MAX_NUM_LINES(NULL)
MAX_CHAR_PER_LINES(NULL)
TOTAL_COLS(NULL)
ROW_SPAN(NULL)
COL_SPAN(NULL)
VALIDATION_TYPE

(NULL)

RAW_KEYS(NULL)
RAW_VALUES(NULL)
INCLUDE_SELECT_IND(NULL)
CONTAINER_IND(NULL)
VISIBLE_INDY
EDITABLE_INDY
READ_ONLY_INDN
REQUIRED_INDN
LOOKUP_INDY
COLLAPSIBLE_FIRST_IND(NULL)
DS_VIEW_IND(NULL)
DS_KEY_COLUMN_ID(NULL)
DS_VAL_COLUMN_ID(NULL)
WIDGET_IDBENEFICIARIES
CONDITIONAL_INDN
CACHE_DATA_IND(NULL)
VALIDATE_ON_SWITCH_IND(NULL)
CRITERIA_ID_REQ_IND(NULL)
CONTEXT_CONTAINER_IND(NULL)
HIDE_LABELN
MULTI_LANG_INDN
UPLOAD_FILE_FORMATS(NULL)
RESIZABLE_INDN
LINKED_CURR_COL(NULL)
LABEL_ALIGN_TYPEtop
APPEND_CURRENCY_MODE(NULL)
INITIAL_MULTIPLICITY(NULL)
PRINT_REQUIRED_INDY
TOGGLE_IND(NULL)
CHANNEL_IDA
LABEL_CHAR_COUNT(NULL)
HELP_ICON_INDN
COPY_PASTE_IND(NULL)
PRODUCT(NULL)
SUB_PRODUCT(NULL)
FUNCTION_CODE(NULL)
INPUT_ACTION(NULL)
APPLICATION_CONFIG{
 "enableSingleClk":true,
 "returnRowData":true,
 "selectedTemplateUrl":"NEWTEMPLATE" 
}
EVENT_CONFIG(NULL)
VALIDATION_CONFIG(NULL)
LOV_CATEGORY(NULL)
LOV_PARENT_ID(NULL)
LST_UPD_DT2021-10-11 15:42:52



The following table provides information about the properties that are applicable to

...

the Lookup form item:


#

Property

Description

Sample Value

1

Form ID

Unique ID of the Form on which you want to place the Form Item.

FORM_PAYMNT_CRMCQ

2

Item ID

Unique ID to the Form item.
This value is automatically configured once the form is selected from the pop-up window.

INPUT_ACC_NO

3

Item Type

To identify the item type in a form.

LOOKUP

4

Channel

Assigns the form item compatibility for various devices.

All Devices

5

Bundle Key

Name of the key associated with the property file which provides the localized label text for the current form item.
Form item bundle key supersede the form level bundle key. If this value is blank, form level bundle key will be used to find label keys.

common

6

Plain Label

Text entered in Plain Label field appears as the label of the form item without the resource bundle key translation.

18.1:

If you are using the property files, leave the Plain Label field as blank.
See About Display Name Key and Plain Label till 18.1 for more details about this property and the related conditions.

Display Name Key is the property-driven label key for the form item. 
See About Display Name Key and Plain Label till 18.1 for more details about this property and the related conditions.

19.1:

In Canvas 19.1, the Display Name Key field is a configuration-driven label key for the form item. 

See About Display Name Key and Plain Label from 19.1 and Managing Display Names for Forms for more information. 


7

Display Name Key

ACCOUNT NO

8

Edit

Selected: Renders the Form in edit enabled mode.
De-Selected: Renders the Form in edit disabled mode.

Selected

9

Visibility

Selected: Shows the form item on the Form.
De-Selected: Hides the form item from the form, but the data will still be in active.

Selected

10

Help

Selected: Renders the form item with a help icon.
De-Selected: Renders the form item without a help icon.
Refer the Configuring Help Messages and Tooltips for Form Items section for more information on configuring help text.

Selected

11

Anchor

Defines the size of the form item in terms of percentage (without % symbol).

50

12

Print

Selected: Allows printing the form item while printing the form.
De-Selected: Does not print the particular form item while printing the form.

Selected

13

Column Span

Occupies the specified number of item spaces horizontally for the current item.

1

14

Label Alignment

Indicates the alignment of the labels of the form items.
Select Options: Left () or Top () or Inline ()

Top

15

Hide Label

Selected: Hides the label of the form item.
De-Selected: Shows the label of the form item.

De-selected

16

Mandatory

Selected: Shows the red asterisk ({}{*}) on the label of the form item, and converts the particular field as mandatory.
De-Selected: Considers the particular field as non-mandatory.

Selected

17

Conditional Mandatory

Selected: Shows the blue double asterisks ({}{}) on the label of the form item, and converts the particular field as conditional mandatory.

Info

If selected, write the conditional logic in the CFEC.PRE_VALIDATE event. See Form Item Handlers for more information.

De-Selected: considers the particular field as normal.
If 'Mandatory' is already selected, do not select this property.

De-Selected

18Add Icon

Image Modified

By making use of Add Icon option, you can add an icon to the form item. Perform the following steps for adding an icon to a form item: 

  1. ClickImage Modifiedicon to add an icon to the field. By default, the Left option gets selected, which paves the way for the icon to get placed on the left side of the form item's label, whereas if the option Right is chosen, then the icon gets placed on the right side of the form item's label. 

    Image Modified
  2. ClickImage Modifiedicon to choose an icon for the form item.  

    Image Modified
  3. Icons and Custom are the two available tabs. From the list of icons in Font Awesome, you can choose an icon of your choice. Click Search text field and type the name of the icon, which you wish to choose.  

    Image Modified
  4. Default, Active, Disabled and Error are the four available options, categorized under the field, Choose icons for different state. You can assign separate icons for the four different states of Default, Active, Disabled and Error. Default indicates the default icon of the form item, whereas Active and Disabled depict the active and disabled states of the form item. When the selected form item is active, the chosen icon for Active state gets displayed and similarly, the icon, chosen for Disabled state, gets displayed, if the form item is in a disabled state. When an error occurs, the icon, which was selected for Error, gets displayed. 

    Image Modified
  5. To add a customized icon, click Custom tab. 

    Image Modified

  6. Click Browse Files button to select an image from your local drive. You can even drag and drop the customized image file directly, without any fuss. 

    Image Modified
    The customized image appears under the category of Custom Images.  

    Note

    If you upload a customized icon for the form item, ensure that you restart the app server, after saving the form. Make sure to log out from Canvas Studio and close the Studio application, before restarting the app server. If you do not restart the app server, the uploaded custom icon will not appear as the assigned icon for the selected form item.



    Image Modified

Selected
19

Multilingual input allowed

Selected: Supports the multilingual characters to be entered into the form items.
De-Selected: Supports only the default language (English).

De-Selected

20

Switch

Enables you to switch from one form item to another form item along with the applicable properties and their values. To switch from one form item to another form item, execute the steps that follow:

  1. Select the form item in the form designer area.
  2. Click the Switch icon (  ) on the primary ribbon.
  3. Select another form item to switch the existing form item.

NA

21

Clone

Enables you to create a duplicate of the selected form item along with its applicable properties except for the Item ID.

2

22

Full Screen Indicator

Selected: Displays the look up window in full screen.
De-Selected: Does not display the look up window in full screen.

De-Selected

23

Widget ID

Displays the Widget ID selected for the Look UpLookup form item.

De-Selected

24Event Wiring

The Event Wiring option enables you to assign various events for different set of actions. For detailed information on Event Wiring, refer Form Items Event Wiring.