App Management

Joget Apps are packaged files that contain form, list, UI, process definitions, custom plugins, and/or app data. These apps can be exported from another Joget installation or downloaded from the Joget Marketplace. Importing an app into an environment with an existing App ID will create a new App Version. You can retain or override environment variables and plugin default properties by selecting the corresponding checkboxes.

Example:

  • An app with the ID leaveSystem and App Version 2 (Process Version 10) exists in the environment.
  • Importing an app with the same App ID will create an app with the ID leaveSystem and App Version 3 (Process Version 11).

Import a Joget App

Next, follow these steps to import applications in Joget:

  1. Log in to the App Center as an admin or a user with an admin role. For more information, see Managing Users.
  2. Click the Import App button.
  3. Also, You can import apps from the Design App dashboard at http://localhost:8080/jw/web/userview/appcenter/home/_/home and select Import App.
  4. In the Import App popup window, select the app .jwa file from your hard disk and click the Upload button.
  5. Click the Show Advanced Options hyperlink to manage the import options:
    • Override App variables.
    • Override plugin default properties.
    • Do not import participant mapping for existing participants.
    • Do not import tool mapping for existing tools.
    • Do not import plugins.
    • Do not import Form Data.
    • Do not import user groups.


      Note: Import plugins and Import form data apply only to apps exported from Joget.

      If the target environment has an existing version of the app:

      • If override app variables are checked, app variables such as counters (e.g., the running number created by the ID Generator Field) will be overridden.
      • If override app variables are not checked, app variables intended to be overwritten will not carry over.
      • App Resources will be based on the imported App. If you have additional App Resources before importing the App, they will not be retained after importing the App. Instead, it will follow the App resources found in the imported App. 

Publish the app

After importing, publish the app to run it.

  1. Click the Versions button.
  2. In the App Configuration Management window, select the app version radio button and click the Publish button.

    You can also manage the following App management options:

    • New Version: Clone the app into the next version number.
    • Publish: Make the app available for users.
    • Unpublish: Hide the app from users.
    • View: View the app elements in this version.
    • Delete: Permanently delete the app. (Note: App data and process data related to this app will not be deleted. Deletion is irreversible. You can re-import the app or restore it from a database backup, but a restore may affect other apps and Joget data.)
  3. Click the Launch button to run the published app. It will open in a new browser tab.

Import App Form Zipped Folders

This feature is available from Joget DX8 version 8.1 onward only.

Joget DX 8.1 supports importing apps from zipped folders in the app_src folder. To use this feature, follow the steps below:

  1. Go to the installation folder wflow/app_src/<app_name> (such as crm).
  2. Zip one of the app's version folders (such as crm_1).
  3. Import the zipped file.

A new app version for the CRM app should be created (such as Version 2) if it does not already exist.

Export a Joget App

The export option allows you to export the entire app design into a single file, which is useful for backups or transferring the app to another server.

Next, follow the steps to export an app:

  1. Log in to any UI in the current app as an administrator.
  2. In the App Composer, click the Export button at the top left.

A file with a .jwa extension will be generated. This is a zip file that can be opened with any zip utility. You can import this file into another Joget platform.

Export Feature in Joget DX

This feature is available for Enterprise edition only.

Joget DX 8 can include the following data or plugins when exporting apps:

  • The app's transaction data records.
  • The custom plugins used in your app (not available on Joget Cloud).

When the Export Plugins property is checked:

  • If Joget App Git is enabled (default), Joget will search the wflow/app_src/[appId]/[appVersion]/plugins folder for custom plugins to include in the exported app file.
  • If Joget App Git is disabled, Joget will search the app's component definitions to match classpaths.

The selected elements will be compressed and added to the appname.jwa file. When you import this app into a new Joget platform, the data records will be added to the database, and any custom plugins will be added to Joget's *.\wflow\app_plugins* folder.

If the app's transaction records are large, exporting and importing the app could take a long time and affect performance. Use a database utility to perform an SQL dump for large data sets.
For more information, see the Git Configuration - Disabling Git In Joget DX.

Additional resources

For further guidance, you may refer to the following links:

Created by Julieth Last modified by Aadrian on Dec 13, 2024