Versions Compared

Key

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

Table of Contents


Introduction

The userview Import Menu is a feature to import bulk data (in a .csv or Excel file) into a specific Joget form. The Import Menu properties allow you to perform simple column-to-field mapping. When importing records, you can specify the following import mode:

During import, you can click the "Validate data" checkbox to perform data validation based on the form field validation rules.


Image Modified

Import Menu Properties

Configure Import Menu

Figure 1: Import Menu in Userview


NameDescriptionSelect File

Extensions supported are:-

  • csv
  • xls
  • xlsx


    Import Menu Properties

    Configure Import Menu

    Mode

    This would allow you to manage existing records. Choices are:-

    • Import new record only
    • Import new record or update existing record
    • Delete record
    Validate data?When checked, value from source will be validated against the specific form element's validator that it is mapped to in the "Column Mappings" property.

    Image Removed

    Figure 2: Post submission result in Userview

    Image Removed

    Figure 3: Import Menu Properties



    NameDescription
    Custom ID

    Item link slug. Optional field.

    Info
    titleUnique field

    Value defined here must be unique to the rest of the Userview Menus as the first matching name will be called upon.

    Image Added

    Figure 3: Import Menu Properties



    LabelMenu label.
    Form

    Specify on where to store the data by choosing a target form.

    Info
    titleHow storing works?

    The target form's store binder will be called upon for data storage.

    Info
    titlePost Form Submission Processing

    Any Tool mapped under Post Form Submission Processing of the target form will be triggered each time a record updated or created.

    Important: The tool mapped will be triggered regardless of the Run Tool on attribute.
    Image RemovedImage Added

    Column Mapping
    NameDescription
    Column Number

    Column number from the source file. Column number starts from zero.

    Image RemovedImage Added

    Field Name

    Corresponding element ID in the form set above to be mapped to.

    If you are referring to a Subform in the target form, remember to prepend the field name with subform element ID followed by an underscore.

    Info
    titleExample
    Image AddedImage Removed

    Subform ID: subform

    Form ID set in the Subform: child

    Field ID in the subform: name

    Field Name: subform_child_name

    Key Column NumberDefine column number that defines the record id. Column number starts from zero.
    Start From Row NumberDefine which row number to start processing. Row number starts from zero.
    Custom CSV Delimiter CharacterSymbol to represent the delimiter separater.
    Custom CSV Quote CharacterSymbol to represent the regular quote character.


    Figure 4: Import Menu Properties - Actions

    NameDescription
    Confirmation MessageConfirmation Message.
    Message shown when error occurMessage shown when error occur.
    Message shown after data importedMessage shown after data imported.
    Redirection (Hyperlink)URL to redirect.


    Figure 5: Import Menu Properties - UI

    NameDescription
    Custom HeaderCustom Header in HTML.
    Custom FooterCustom Footer in HTML.
    Disable delete record featureDisables the option for end users to delete records.


    Figure 6: Import Menu Properties - Advanced

    NameDescription
    Userview Key Name

    Corresponding element ID in the form set above to be mapped to (same like the mapping in "Column Mapping" above).

    When defined, the Userview Key value will be saved into the field defined here.

    UTF-8 Encoding Checking?When checked, it will check the uploaded file if it is a valid UTF-8 encoded file.


    Panel
    borderColorblue
    borderWidth1
    borderStylesolid

    Example:

    With the configurations above, we will attempt to import the following data in the screenshot below.

    Figure 7: Source data highlighting data that will be imported into the target form's database table (master)


    Figure 8: Data written into the form table (master)


    Figure 9: Source data highlighting data that will be imported into the target form's subform's database table (child)


    Figure 10: Data written into the form table (child)



    Panel
    borderColorpurple
    borderWidth1
    titleBGColor#ddccff
    borderStylesolid
    titlePerformance

    You can configure the Performance settings in this Userview Element which allows one to cache existing content for improved performance and loading speed. Read more at Performance Improvement with Userview Caching.



    Import Joget Users

    The Joget User Mgnt Utility has an import menu to import user records into Joget DX. You can download the app from Joget Marketplace.


    Download Demo App

    Download the following sample app and CSV file to demonstrate the use of Import Menu.

    View file
    nameAPP_jusermanager-user-import-menu.jwa
    height150
      
    View file
    namesample_import_user.csv
    height150



    ...