Plugins

 

 

Plugins offer you the possibility to integrate custom functions and / or user interfaces into the application (see IDA). A plugin always refers to exactly one business object type (several plugins can be included for different business objects) and all iterations. In the development of a plugin, iteration-specific processes can be implemented.

 

In order to allow a high degree of flexibility and independency, plugins can be developed and integrated by yourself (no processing by us is required, so there are no additional costs for you). Of course, you can also commission the development of plugins (for a fee).

 

Plugin Development

 

The plugins are developed in Java. The used Java version can be found in your instance of the application in the administration settings. We recommend to develop you own plugins based on the Reference Plugin. We also recommend a suitable development environment (Eclipse or similar). TheĀ Reference Plugin was created with Eclipse 2018-12.

 

A plugin must implement certain interfaces to be integrated into the application. The following classes form the basic framework of plugins:

 

  • CustomBusinessObjectSettings: This interface must always be implemented (per plugin exactly once), it bundles all functions and user interfaces of the plugin
  • PluginFunction: Defines a function / background process and is assigned to the plugin via CustomBusinessObjectSettings
  • UIPlugin: Defines a user interface and is assigned to the plugin via CustomBusinessObjectSettings

 

The documentation (Javadoc) of the interfaces can be found in the Documentation section. The interfaces themselves are defined in the following package:

 

ida-utils.jar

 

Documentation

 

The following file contains the documentation of the relevant interfaces.

 

Javadoc.zip

 

Reference Plugin

 

This section describes how to develop your own plugin based on the reference project.

 

  1. Download the reference project and unzip the archive locally (preferably in your workspace folder):
  2. Import the unpacked project into your development environment (the reference project was created with Eclipse 2018-12)
  3. Complete the tasks described in the TODOs of all defined classes, in particular MyCustomBusinessObjectSettings.java, since this class is the starting point of the plugin and defines for which business object the plugin applies. Customize the methods / user interfaces according to your needs.
  4. Create a .jar file from your project
  5. Upload the .jar file in the Administration settings as follows:
    • Field “Class”: Enter the name of the class (IMPORTANT: must include the name of the package) that implements the CustomBusinessObjectSettings-Interface
    • Field “Plugin”: Select the .jar file from step 4
  6. If the plugin defines new UIs, you must restart the application, so that the interfaces can be integrated
  7. Now the plugin functions and user interfaces are ready to be used