This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Running the plug-in server

The plug-in server is set up in the armonitor configuration to start automatically at system startup. It stops and restarts with the rest of the AR System services controlled by armonitor, the AR System UNIX daemon, or the Windows service.

To start the plug-in server manually, run the pluginsvrstartup command in the pluginsvr directory. This command file (pluginsvrstartup.sh for UNIX or pluginsvrstartup.bat for Windows) is customized for your installation. To change command-line options, see Configuring the Java plug-in server.

In this topic:

Logging plug-in information

Plug-ins can write information to the plug-in server log file. C plug-ins can use the ARPluginSetProperties function to call the plug-in log function:

typedef int (*AR_PLUGIN_LOG_FUNCTION)(
ARPluginIdentificationasdfasdfasdfas*id,
intasdfasdfasdfasdfasdfaassdfasdfasdfasdfalogLevel,
charasdfasdfasdfasdfasdfaasdfasdfasdfasdfa*text);

Argument

Description

id

The plug-in type, name, and version.

logLevel

The log level to which the information applies:

  • AR_PLUGIN_LOG_OFF (10000) — No plug-in messages are logged. (Some plug-ins may ignore this setting.)
  • AR_PLUGIN_LOG_SEVERE (1000) — Messages that report fundamental problems that prevent a plug-in from working (for example, the inability to open a required resource during plug-in initialization).
  • AR_PLUGIN_LOG_WARNING (900) — Messages that might be precursors to severe problems or identify incorrect configuration settings (for example, for a bad configuration setting, a plug-in might log a warning and reverts to a default value).
  • AR_PLUGIN_LOG_INFO (800) — Messages that identify intermittent milestones or events that do not have negative repercussions. This should not be used for information that is likely to occur frequently.
  • AR_PLUGIN_LOG_CONFIG (700) — Messages that describe the current configuration settings of the plug-in.
  • AR_PLUGIN_LOG_FINE (600) — Messages that identify the result of every decision made throughout processing. This level, along with the FINER and FINEST log levels, is primarily used while resolving problems.
  • AR_PLUGIN_LOG_FINER (500) — Supporting data that supplements FINE messages.
  • AR_PLUGIN_LOG_FINEST (400) — Messages that contain information to help users who have plug-in source code in front of them. At this level, messages can reference internal function names or structures. (All messages logged at higher levels should have meaning for users who might not have access to the source code.)
  • AR_PLUGIN_LOG_ALL (100) — All plug-in messages are logged.
    You can specify a log level for each situation. This enables the plug-in to write different information to the log file depending on the log level configured for the plug-in server The information is not written to the log file unless the plug-in server log level is equal to or lower than the value of logLevel.

text

The message that is written to the plug-in server log file.

The C plug-in log function has no return value.

Set the log level for the C-based plug-in server using the Plugin_Log_Level option on the Log Files tab of the AR System Administration: Server Information form. For more information, see Setting log files options.

Java plug-ins can log messages using the logMessage method of their ARPluginContext object. See the Java plug-in API online documentation located at ARSystemServerInstallDir\ARserver\api\javaplugins\arpluginsdocVerNum.jar for details.

The Java plug-in server uses the log4j utility. Set the log level and other logging configuration in the log4j_pluginsvr.xml file. Comments in the sample file describe the log configuration options.

Logging exceptions for calls to Java plug-ins

When a run-time exception or an ARException class error occurs during a Java plug-in server call to a Java plug-in, the following information is now recorded in the ARServerInstallDir\Arserver\Db\arjavaplugin.log file:

  • The name of the plug-in
    This name matches the name of the corresponding plug-in library registered in the Java plug-in configuration file, pluginsvr_config.xml. For example, if the library is registered as <name>DSO.FILTERCONFIGURATION</name>, the plug-in name in the log file is DSO.FILTERCONFIGURATION.
  • The method that the server tried to call in the plug-in
  • (Runtime exceptions only) The exception stack trace

In addition, when a run-time exception occurs, users receive Error 8753: Error in plugin: pluginName.

When an ARException occurs, users receive the usual message associated with the exception.

Note

When you restart the AR System server, the arjavaplugin.log might log warnings that look similar to this:

2009-10-14 11:07:12,573 WARN pool-2-thread-1
com.bmc.arsys.pluginsvr.plugins.ARPluginContext (?:?) -
<ARSYS.ARF.REGISTRY>Null registry location

You can safely ignore these messages. If you want to use the Registry, then enter the Registry location in the AR System Administration Console. For more information, see Registering a web service.

About C plug-in exception handling

Exception handling in the C plug-in server now produces a stack trace. The stack trace includes the names of the operation, vendor, and plug-in library. It is written to the arerror.log file.

Was this page helpful? Yes No Submitting... Thank you

Comments