Creating and modifying Java plug-ins

You can create, view, or modify plug-ins and their configuration settings. When you create a new plug-in, it is loaded dynamically. You do not need to restart the AR System server.

Related topics

Centralized-configuration

Troubleshooting-issues-with-plug-in-servers

To create a Java plug-in

  1. In a browser, open the Remedy AR System Administration Console, and select System > General > Plugin Server Configuration.
  2. On the AR System Administration:Plugin Server Config form, open the Plugin Configuration tab, and click Create to open the Create New Plugin form.
  3. Enter values for the following fields, and click OK:

Field name

Description

Plugin Name

Enter the name of the plug-in.

Plugin Class Name

Enter the name of the Java class that will implement the plug-in.

Value: Any valid class name from the JAR file

Plugin File Name

Enter the name of the file that the plug-in server loads to access the plug-in implementation.

Note: This file is located in the plug-in server class path.

Value: The absolute file name of the JAR file that contains the class that contains the plug-in implementation and all the dependent JAR files

AR Server

Enter the AR System server name where the Server-Plugin-Alias entry will be created.

Create Server Plugin Alias Entry in ARServer

Select the check box to create the Server-Plugin-Alias entry in the AR System Configuration Component Setting form. 

For the AR System server to communicate with the Java plug-in, you must create the Server-Plugin-Alias entry in the AR System Configuration Component Setting form.

Path Elements

Click the plus sign and enter the location of a dependent JAR file or the path to a dependent native library. Each plug-in element can contain zero or more pathelement elements.

User Defined Elements

(Optional) Click the plus sign and enter the user-defined configuration elements:

  • Setting Name—Name of the user defined element.
    The syntax for this element is:
    pluginName    .userDefined.settingName
    If you add two values for the same Setting Name, only the first value is applicable.
    pluginName     is automatically populated based on the value entered in the Plugin Name field.
  • Setting Value—Value for the element.

You must define values for both Setting Name and Setting Value.

To view a Java plug-in

  1. In a browser, open the Remedy AR System Administration Console, and select System > General > Plugin Server Configuration.

  2. On the AR System Administration:Plugin Server Config Form form, open the Plugin Configuration tab.

    Field name

    Description

    Plugins

    Displays the list of available plug-ins

    Plugin Class Name

    Displays the name of the Java class in the JAR file that implements the plug-in

    Plugin File Name

    The name of the file that the plug-in server loads to access the plug-in implementation

    This file is located in the plug-in server class path.

    Enter the absolute file name of the JAR file that contains the class that contains the plug-in implementation and all the dependent jar files.

    Path Elements

    Displays the location of the dependent JAR file or the path of the dependent native library

    User Defined Elements

    (Optional) Displays the user-defined configuration elements for the selected plug-in

To modify a Java plug-in

  1. In a browser, open the Remedy AR System Administration Console, and select System > General > Plugin Server Configuration.
  2. On the AR System Administration: Plugin Server Config form, open the Plugin Configuration tab.
  3. In the Plugins list, select the plug-in that you want to modify.
  4. Click Modify to open the Modify Existing Plugin form.
  5. Modify the data as needed, and click OK.

To delete a Java plug-in

  1. In a browser, open the Remedy AR System Administration Console, and click System > General > Plugin Server Configuration.
  2. On the AR System Administration:Plugin Server Config Form form, open the Plugin Configuration tab.
  3. From the Plugins list, select the plug-in that you want to delete, and click Delete.
  4. In the confirmation box, click Confirm.
  5. Restart the Java plug-in server for these changes to take effect.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*