Enabling plug-ins

The Action Request System plug-in server allows integration between Action Request System and external programs or environments (data not contained in the AR System server database) by managing the interaction between the plug-in code and the Action Request System server. All plug-ins are registered with the plug-in server, which runs them as needed and coordinates all interactions. 

Related topics

Troubleshooting

Developing-an-API-program

A plug-in is defined by using one of the plug-in APIs to write code to handle the integration with the external program. Plug-in API functions provide the main routine, threading control, and communication with the Action Request System server. In addition, the plug-in function provides the logic for one or more callback routines, defined by the API, that perform operations against the external program or environment.

When a plug-in function is invoked, the Action Request System server makes a call to the plug-in server, requesting a specific plug-in to perform an operation with a set of parameters. The plug-in server passes the parameters to the appropriate callback routine in the external application and awaits a response. When the response is received, it is returned to Action Request System, and the processing continues.

You can use the Action Request System C API or Java API to extend the client functionality. For more information, see Creating-and-executing-AR-System-C-API-programs and AR-System-Java-API-overview.

You can get the class name and setting name information about a plug-in in the AR System server Administration Console.

To view the class name and setting name information:
  1. In a browser, open the AR System server Administration Console, and select System > General > Plugin Server Configuration.
  2. On the Plugin Server Configuration form, click the Plugin Configuration tab.
    Plugin Configuration tab
  3. In the Plugins area, click a plug-in name.
    The class name of the plug-in is displayed in the Plugin Class Name field, and one or more setting names are displayed in the Path Elements area. 

The following table provides information about AR System server plug-ins. AR System server version 9.1 and later supports all Java plug-ins and AR System server version 9.0 and later supports all C plug-ins:

The configurations for all Java plug-ins are available in Centralized Configuration.

 

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