Amount
Amount form item is a numeric decimal text box which auto-formats the values as per the preferred currency code.
- Form Items >Data Entry>Amount.
- To specify the currency code for the value in the Amount item click the SETTINGS pop-up and type the required currency code in the Currency Column as shown in the following image. You can indicate whether the currency code must be prefixed or suffixed by selecting the Prefix Currency or Suffix Currency in the SETTINGS pop-up. You can also add positive (Amount) and negative value (Negative) for an amount.
Adding the Currency symbol for Amount form item
To add the currency symbol for the Amount form item, perform the following steps:
Specify the appropriate currency format with the relevant Unicode value in the amountformats.xml file present within your application source folder, e.g (D:\SVN_REPO\20.1.10.0\Sources\CTModelHouse\Sources\CTModelHouseResources\src\main\resources\cuser-amountformats.xml), as shown in the following code snippet:
<format Id = "###,###,###,###,###.###" description = "Indian Currency Format" groupSeparator = "," decimalSeparator = "." groupSize = "3" negativeSignPosition = "PREFIX" leadingGroupSize = "3" isEnabled = "true" currencySymbol="'\u20b9'"/> <!-- \u20b9 is the Unicode of the Indian Rupee Currency -->
To add the currency symbol for the Amount form item to reflect globally at the application level, ensure that you specify the env option for displaying the currency symbol in the form's listener file, as shown in the following code snippet:
It is essential that you must make appropriate changes in the FORM_ITEM_DEFINITION table in your Canvas schema, as per the information provided in the third step.
ct.env.options.form.showCurrencySymbol = true
Specify the appropriate JSON structure of the currency symbol in the APPLICATION_CONFIG column present in the FORM_ITEM_DEFINITION table in the Canvas schema, as shown in the following code snippet:
{"currencySymbol":"true"}
Before you proceed to make changes in the FORM_ITEM_DEFINITION table in your Canvas schema, ensure that you have enabled the Prefix/Suffix Currency option in Settings for the Amount form item in the configured form on Canvas Studio.
The sample DB entries to be provided in the FORM_ITEM_DEFINITION table for adding a currency symbol to the Amount form item are listed as follows:
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 NamesColumn ValuesAPPLICATION_ID MODELHOUSE FORM_ID AMOUNT_FORM ITEM_ID AMOUNT_FIELD PARENT_ID AMOUNT_FORM POSITION 1 ITEM_TYPE 2 DISPLAY_NM_KEY (NULL) PLAIN_LBL Amount Field LAYOUT (NULL) ANCHOR 100 BUNDLE_KEY common MIN_LENGTH 0 MAX_LENGTH 1000 MAX_NUM_LINES (NULL) MAX_CHAR_PER_LINES (NULL) TOTAL_COLS (NULL) ROW_SPAN (NULL) COL_SPAN (NULL) VALIDATION_TYPE POSITIVE
RAW_KEYS (NULL) RAW_VALUES (NULL) INCLUDE_SELECT_IND N CONTAINER_IND N VISIBLE_IND Y EDITABLE_IND Y READ_ONLY_IND N REQUIRED_IND N LOOKUP_IND N COLLAPSIBLE_FIRST_IND N DS_VIEW_IND (NULL) DS_KEY_COLUMN_ID (NULL) DS_VAL_COLUMN_ID (NULL) WIDGET_ID (NULL) CONDITIONAL_IND N CACHE_DATA_IND N VALIDATE_ON_SWITCH_IND N CRITERIA_ID_REQ_IND N CONTEXT_CONTAINER_IND N HIDE_LABEL N MULTI_LANG_IND N UPLOAD_FILE_FORMATS (NULL) RESIZABLE_IND N LINKED_CURR_COL (NULL) LABEL_ALIGN_TYPE top APPEND_CURRENCY_MODE SUF_CODE INITIAL_MULTIPLICITY (NULL) PRINT_REQUIRED_IND Y TOGGLE_IND N CHANNEL_ID A LABEL_CHAR_COUNT (NULL) HELP_ICON_IND N COPY_PASTE_IND N PRODUCT (NULL) SUB_PRODUCT (NULL) FUNCTION_CODE (NULL) INPUT_ACTION (NULL) APPLICATION_CONFIG {"currencySymbol":"true"} EVENT_CONFIG (NULL) VALIDATION_CONFIG (NULL) LOV_CATEGORY (NULL) LOV_PARENT_ID (NULL) LST_UPD_DT 2021-11-01 19:43:22
The following screen shot showcases an amount form item with the currency symbol in the functional application, Modelhouse:
The following table provides information about the properties that are applicable to the Amount form item:
# | Property | Description | Sample Value |
---|---|---|---|
1 | Form ID | Unique ID of the Form on which you want to place the Form Item. | FORM_TRAN_PURCHINVOICE |
2 | Item ID | Unique ID to the Form item. | AMT_INVOICE |
3 | Item Type | To identify the item type in a form. | AMOUNT |
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. | payments |
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. Display Name Key is the property-driven label key for the form item. 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 | INVOICE AMOUNT | |
8 | Edit | Selected: Renders the Form in edit enabled mode. | Selected |
9 | Visibility | Selected: Shows the form item on the Form. | Selected |
10 | Help | Selected: Renders the form item with a help icon. | Selected |
11 | Anchor | Defines the size of the form item in terms of percentage (without % symbol). | 50 |
12 | Selected: Allows printing the form item while printing the form. | Selected | |
13 | Column Span | Occupies the specified number of item spaces horizontally for the current item. | 2 |
14 | Label Alignment | Indicates the alignment of the labels of the form items. | Top |
15 | Hide Label | Selected: Hides 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. | 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. | De-Selected |
18 | Add Icon | 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:
| De-Selected |
19 | Minimum Input Size | Indicates the minimum number of characters within the text controls. | 3 |
20 | Maximum Input Size | Indicates the maximum number of characters within the text controls. | 6 |
21 | Multilingual input allowed | Selected: Supports the multilingual characters to be entered into the form items. | - |
22 | 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:
| NA |
23 | Clone | Enables you to create a duplicate of the selected form item along with its applicable properties except for the Item ID. | 2 |
24 | Event 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. |
By default, the Amount form item allows only digits and decimal as input.