Font Size:

App Import & Export Aware Plugin

Introduction

This plugin type marked a plugin aware of app import & export event.

Commons Use Cases:

  • Extract some used values in the app and export & import it together.

  • Import additional data

  • Adding post processing after import or export

App Import & Export Aware Plugin Class

Interface

  • org.joget.apps.app.model.AppImportExportAwarePlugin

    • This plugin interface can used together with other plugin types

    • The plugin implemented this interface will aware of the app import and export event.

    • CustomBuilderCallback plugin interface is refactored to extends this interface

org.joget.apps.app.model.AppImportExportAwarePlugin

Methods

  • String importAppConfigHtml()

    • Used to inject html into the import app configuration page

  • void importAppPostProcessing(AppDefinition appDef, byte[] zip)

    • To do some post processing after import based on the import app definition and the zip file

  • String exportAppConfigHtml();

    • Used to inject html into the export app configuration page

  • void exportAppPostProcessing(AppDefinition appDef, ZipOutputStream zip)

    • To do some post processing to the exported zip based on the app definition

Sample Plugin

For testing purposes, this plugin inject a line to the config page and adding/reading a txt file to/from the .jwa

 

Created by Debanraj Last modified by Debanraj on Apr 17, 2025