Copy File Tool Plugin

Introduction

The Copy File Tool Plugin enables seamless integration by allowing you to copy flat files from the local file system into Joget for further processing.

Plugin information

  • Plugins Available in the Bundle: Copy File Tool
  • Compatible with: Joget DX 8 and onwards.

Get started

Where to get the plugin

You can download the plugin's source code and the latest release from the JogetOSS GitHub Repository.

How to install

  1. Download the plugin JAR file from the releases page.
  2. Go to Settings > Manage Plugins > Upload Plugin.
  3.  You can import the demo app or create the app from scratch.

How to use it

Importing the demo app

For the demo app, go to Joget Home or All Apps and click on Import App to import the downloaded demo app (see another KB - Import a Joget App for more details).

Creating the app from scratch
  1. Create a new form, Action Form, with two fields.
    • Value Field
    • File Path Field
      This form is to enter an existing local system file path.
  2. Go to Settings > Advanced > Post Processing Tool > Copy File Tool.
  3. Configure the plugin (See Configure Copy File Tool section for details).
  4. Create another form called Target Form with the following fields:
    • File Upload Field
    • Name Field
    • Address Field
  5. The copied file will be stored in the File Upload Field.
  6. On the top right corner, click Generate App and generate CRUD operations for both forms.

Run the plugin

  1. Go to Manage Action Form and click New.
  2. Enter the file path and select the file you wish to copy.
  3. In Manage Target, click Edit



    The copied file can be downloaded from the File Upload Field.

Configure copy file tool properties

Copy file tool settings

Configuration of basic settings for file handling.

  • File Path Option: You have two options to set the file path:
    1. Enter File Path
    2. Form Field
  • Enter File Path:
    • File Path: Field to set the file path from the local system.
      File Path
      Using the Enter File Path will only focus on the file path entered in the configuration, ignoring other file paths entered in the main form.
  • Form Field: 
    • Form: Specify the form where the file path is set.
    • Path Field: The field in the form containing the file path.
Form to store file

Set where the copied file should be stored.

  • Form: The form that will store the copied file path.
  • File Field: The form field that will store the copied file.

Expected outcome

At the end of the process, the copied file will be stored in the target form, and you can download it. The process integrates flat files into Joget, enabling further use or manipulation.

Download plugin

Download sample app

Download the demo app for the Copy File Tool Plugin:
Created by Julieth Last modified by Aadrian on Nov 19, 2024