Versions Compared

Key

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

Upload Component is a panel of dedicated items for file upload handling. End users can attach files by drag-and-drop or selecting a file from the file browser.

...

#

Property

Description

Sample Values

1

Form ID

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

CT_TEST_FORM#457

2

Item ID

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

UPLOAD_FIELD1

3

Item Type

To identify the item type in a form.

UPLOADPANEL

4

Channel

Assigns the form item compatibility for various devices.

Desktop / Tablet / Mobile

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

INPUT_DEBIT_ORG_ACC_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 ()

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.

Note

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

18Event 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.


19

Anchor
fileFormatSettings
fileFormatSettings
Settings Menu: List of File Formats to be Supported

This is a mandatory configuration that is used to specify the list of file formats that can be uploaded. Use comma (,) to specify multiple file formats, e.g. PDF, XLS, PNG.

.docx

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

...

Note

To serve the purpose of file upload in Upload Panel, you must ensure that the fm.uploadFile API is called and it is the fm.uploadFile API, which paves the way for the file upload. For detailed information on form and form item APIs, refer Form and Form Item APIs. The following code snippet serves as a sample reference: 


Code Block
languagejs
this.fm.registerHandler(CFEC.FILE_ADD, 'FILTER_upload', function(fm, fieldName, filename, uploadcount, store) {
   alert(success);
   fm.uploadFile('state', function(params) {
      var fileDetails = fm.model.getValue('FILTER_upload');
      if (fileDetails) {
        var fileName = fileDetails[0].filename;
        var refNo = fileDetailsparams.FileData[0].attachmentRefNumber;
      }
   })
});


...