Import Tool

The Import Tool allows users to import bulk data from CSV, XLS, or XLSX files into a specific form's table in Joget DX. It simplifies data migration and bulk data entry by enabling column-to-field mapping and supporting various import modes.

Configure import

To configure Import, drag and drop the Tool element onto the canvas in Process Builder,  click on it, and select Mapping.

When adding Import in field Tools, you will see the following fields available for configuration:

• File Upload Form: Specify the source Form where the File Upload element resides.
• Upload Field ID: Select the File Upload element ID in the specified form.
• Store Data To Form: Specify where to store the data by choosing a target form.
  
  How does storing work?
  The target form's data store will be called upon for data storage.
  Post Form Submission Processing
  Tools mapped here trigger after each record update or creation, regardless of the Run Tool on attribute.
• Column Mappings: Map the source file's CSV values to the target form fields.
  • Column Number: Index of the column in the source CSV (starts from 0).
  • Field ID: ID of the form field in the target form.
  • Use Formatted Value: Optionally use pre-formatted values.
• Key Column Number: Column containing primary key values.
  If undefined, a UUID is generated for each imported record.
• Start From Row Number: Specify the row number to start importing data (starts from 0).
• Foreign Keys: Define associations or hard-coded values not in the CSV. Use field IDs and values, including hash variables.
  
  • Field Id: Field id in the target form.
  • Value: Value to be set. Hash Variable is accepted.
• Import Mode:
  • Import new record or update existing record
  • Import new record only
  • Delete record
• Validate Data?: Validate imported data against form field validations.
• UTF-8 Encoding Checking: Verify if the file is UTF-8 encoded.
• Custom CSV Delimiter Character: Define the separator symbol.
• Custom CSV Quote Character: Set the quote character.
• Debug Mode: Print useful debugging information in the server log when enabled.

Import status

Introduced in Joget Workflow Enterprise version 5.0.7 and later. It provides clarity on import execution results.

• Store to Workflow Variables: Map imported data to workflow variables.

• Store to File Upload Form: Save import status data to the originating file's form data table.