The plug-in environment is contained in a directory structure under the installation directory <RuntimeWebAppsDir> of the Software AG Runtime. The document Basic Operations describes the location of this directory.
Under <RuntimeWebAppsDir>\PluggableUI we have the following structure:
WEB-INF/
classes/
log4j.xml
lib/ //JARs
cis/
HTMLBasedGUI/
PluggableUI
plugin.xml
*.html
accesspath/
xml/ // layout definitions
images/
CentraSiteControl
plugin.xml
*.html
*_SWT.xml
accesspath/
xml/ // layout definitions
images/ // icons
lib/ // JARs
classes/ // class files
MyPlugIn
plugin.xml
*.html
*_SWT.xml
accesspath/
xml/ // layout definitions
images/ // icons
lib/ // JARs
classes/ // class files
The structure includes a sample user-written plug-in MyPlugIn for illustration purposes.
A plug-in should be provided as a ZIP archive with the directory structure as given in the section Directory Structure.
The following actions need to be performed when installing a plug-in manually:
Check for availability of other plug-ins being a prerequisite.
Copy files (except the plugin.xml configuration file) into the directory structure shown in the section Directory Structure.
Compile layout definitions.
Note:
Using the plug-in may require a restart of Software AG Runtime.
The following actions need to be performed to uninstall a plug-in manually:
Before you uninstall a plug-in, ensure that it is not required by another plug-in.
Remove the plug-in configuration file plugin.xml.
Remove the plug-in directory, for example MyPlugIn as shown in the section Directory Structure.
Note:
It might not be possible to remove files if they are in use, for
example, while the application server is running.
A separate Plug-In Management perspective offers the following functions:
| Function | Description | Invoke via... |
|---|---|---|
| Install Plug-In | Import a ZIP-file containing all required files for a plug-in | Button in toolbar |
| Table of Plug-ins | Similar to the dialog | Select a node in the topic |
| Uninstall Plug-In |
Check which other plug-ins rely on the plug-in to be uninstalled. If there are no dependencies, the plug-in is uninstalled. |
Select the plug-in in the table and select the command from the context menu |
| Compile Layouts | Required when the underlying Application Designer runtime is upgraded | Select plug-in in table and select command from context menu |
| Start the Application Designer layout editor | Button in toolbar |
The Plug-In Management perspective is not visible by default. It is
only visible if you set the preferred plug-in using
PLUGIN=com.softwareag.cis.plugin in the URL that is used to start
the GUI.
Example:
http://localhost:53307/PluggableUI/servlet/StartCISPage?PAGEURL=/PluggableUI/Login.html&PLUGIN=com.softwareag.cis.plugin&LOCALE=en
