Application plug-in properties
This section provides a breakdown of each element in the application plug-in file, with accepted values, to help you create the plug-in file for your own application.
- SocketProcessFactory elements
- PluginLink elements
- SupportedClients elements
SocketProcessFactory elements
The SocketProcessFactory elements provide application startup information.
Any property not listed in the table below should not be changed by the developer.
| Name | Description |
|---|---|
| application Registry Mandatory |
Defines the application registry that the process factory will register. If none is defined, the process factory will not be available for use. |
| license Manager Mandatory |
Defines the license manager responsible for licensing of the specified application. The default license manager allows unrestricted access to the application. Third-party application plug-ins can define their own license manager to handle custom licensing requirements. |
| application
Mandatory |
Defines the ID of the application that identifies the corresponding executable. This should be unique across all applications defined on the PureWeb server, or the server will error on startup and the plug-in will not load. |
| description
Mandatory |
Defines the name of the application that will be displayed to users. |
| directory
Optional |
Defines the directory from which the application will be started. Applications that need to be started in a particular directory must specify an appropriate value in this property. This property is optional for applications that do not need to be started in a specific directory. If not specified, the working directory will be the PureWeb server's bin folder. |
| executable
Mandatory |
Defines the full path to the application's main executable program. This program will be started with the specified environment, options and command line arguments when a request for the application is received. |
| available
Optional |
Controls the availability of the specified application. This can be used so that the specified application is not listed among available applications and cannot be requested by clients. |
| defaultProcess
Optional |
Controls startup of the specified application. One application may be configured as the default process and the PureWeb server will start instances of this process in all available user sessions to avoid delays associated with process startup. Note that only one default process may be defined, otherwise only the first will be activated and subsequent process factory definitions will be ignored. This property only works if a single application is configured to run on the server. A value of “true” indicates that this is the default process. |
| connectionTimeout
Optional |
The length of time that a service has to establish a socket connection with the PureWeb server before timeout occurs. If not specified, this value defaults to 30 seconds. |
| environment
Optional |
Defines additional environment variables required by the application executable. This property expects a map of key-value pairs. Do not add a DISPLAY environment variable in this property. |
| options
Optional |
Defines the command line options that the application must be started with. This property expects a map of key-value pairs.
The plug-in file for the sample Java service, JavaSamples-plugin.xml, contains an example of this. You'll find this file in the [install_path]\tomcat-server\conf directory. |
| arguments
Optional |
Defines the command line arguments that the application must be started with, in the order that they must appear. This property expects a list of values. |
| Name | Description | Mandatory? |
|---|---|---|
| applicationRegistry | Defines the application registry that the process factory will register. If none is defined, the process factory will not be available for use. | Yes |
| licenseManager |
Defines the license manager responsible for licensing of the specified application. The default license manager allows unrestricted access to the application. Third-party application plug-ins can define their own license manager to handle custom licensing requirements. |
Yes |
| application |
Defines the ID of the application that identifies the corresponding executable. This should be unique across all applications defined on the PureWeb server, or the server will error on startup and the plug-in will not load. |
Yes |
| description | Defines the name of the application that will be displayed to users. | Yes |
| directory |
Defines the directory from which the application will be started. Applications that need to be started in a particular directory must specify an appropriate value in this property. This property is optional for applications that do not need to be started in a specific directory. If not specified, the working directory will be the PureWeb server's bin folder. |
No |
| executable | Defines the full path to the application's main executable program. This program will be started with the specified environment, options and command line arguments when a request for the application is received. | Yes |
| available |
Controls the availability of the specified application. This can be used so that the specified application is not listed among available applications and cannot be requested by clients. |
No |
| defaultProcess |
Controls startup of the specified application. This property is deprecated and will likely be removed from future releases. One application may be configured as the default process and the PureWeb server will start instances of this process in all available user sessions to avoid delays associated with process startup. Only one default process may be defined, otherwise only the first will be activated and subsequent process factory definitions will be ignored. This property only works if a single application is configured to run on the server. A value of “true” indicates that this is the default process. |
No |
| connectionTimeout | The length of time that a service has to establish a socket connection with the PureWeb server before timeout occurs. If not specified, this value defaults to 30 seconds. | No |
| environment |
Defines additional environment variables required by the application executable. Do not add a DISPLAY environment variable in this property. This property expects a map of key-value pairs, for example: <property name="environment">
<map>
<entry key="LD_LIBRARY_PATH" value="."/>
</map>
</property>
|
No |
| options |
Defines the command line options that the application must be started with. This property expects a map of key-value pairs, for example: <property name="options">
<map>
<entry key="-c" value="server"/>
</map>
</property>
|
No |
| arguments | Defines the command line arguments that the
application must be started with, in the order that they
must appear.
This property expects a list of values, for example:
<list>
<value>arg1</value>
<value>arg2</value>
</list> |
No |
SupportedClients elements
The SupportedClients elements provide information about the clients for the application.
| Name | Description |
|---|---|
| supportedClients
Mandatory |
Defines the client map that this application will register with. If no client map is defined the application will not be available for use. |
| application
Mandatory |
Defines the ID of the application that identifies the corresponding client. |
| clientMap
Mandatory |
Defines the name of the client file (relative to the webapp folder). Use “html5”. |
| Name | Description | Mandatory? |
|---|---|---|
| supportedClients | Defines the client map that this application will register with. If no client map is defined the application will not be available for use. | Yes |
| application | Defines the ID of the application that identifies the corresponding client. | Yes |
| clientMap |
Defines the name of the client file (relative to the webapp folder). Use "html5". |
Yes |
PluginLink elements
Your application will not appear in the list of available applications on the server's Apps page until you add the necessary links; this is done in the PluginLink bean.
| Name | Description |
|---|---|
|
registry Mandatory |
Defines the application registry that the process factory will register. If none is defined, the process factory will not be available for use. |
| supportedClients
Mandatory |
Defines the client map that this application will register with. If no client map is defined the application will not be available for use. |
| name
Mandatory |
The name that the server's interface will present as the applications name. |
|
description Mandatory |
A detailed description of the application displayed for the end-user. |
| path
Optional |
This value will be used as the Launch link. Ensure that this property is not commented out, and that the client parameter in the path points to the desired client. |
| image
Mandatory |
The icon used to launch the application. |
| role
Mandatory |
The role allowed to view the link when logged into the PureWeb server. |
| Name | Description | Mandatory? |
|---|---|---|
| registry | Defines the application registry that the process factory will register. If none is defined, the process factory will not be available for use. | Yes |
| supportedClients | Defines the client map that this application will register with. If no client map is defined the application will not be available for use. | Yes |
| name | The name that the server's interface will present as the applications name. | Yes |
| description | A detailed description of the application displayed for the end-user. | Yes |
| path |
This value will be used as the Launch link. Ensure that this property is not commented out, and that the client parameter in the path points to the desired client. |
No |
| image | The icon used to launch the application. | Yes |
| role | The role allowed to view the link when logged into the PureWeb server. | Yes |
