Setting plug-in server configuration options


Use the Plugin Server Configuration tab to create settings for the plug-in server instance.

  1. In a browser, open the AR System Administration Console and select System > General > Plugin Server Configuration.
  2. Select a plug-in server instance from the Plugin Server Instance list.
    You can select from the out-of-the-box plug-ins and plug-ins specific to the custom applications installed in your environment.
    PluginConfiguration_Separated1.jpg 
  3. Click the Plugin Server Configuration tab.
  4. Edit the options listed in the following table, as needed:

    Area name

    Field name

    Description

    General Configurations

    Plugin Port

    Specifies the TCP port number where the Java plug-in server runs.

    You enter this port when you install the AR System server, which sets the value of the Server-Plugin-Alias property in the ar.cfg or ar.conf file.

    If you have a single plug-in server instance, you can enter this value in the Plug-in Server list on the Connection Settings tab of the AR System Administration:Server Information form.

    Valid values: Unused port numbers from 1024 to 64000

    Default: 9999

    Register With PortMapper

    Specifies whether you want the Java plug-in to register with the portmapper.

    Valid values are:

    • True
    • False (default)

    Masking Implementation

    (Optional) Enables plug-in developers to implement the com.bmc.arsys.pluginsvr.ISignalMasking interface to enable a plug-in server to use custom signals.

    This option is for internal use only.  

    Example: com.bmc.arsys.plugins.signal.SignalMaskForSpecificPlugins

    Threads Configurations

    Max Threads

    The maximum number of worker threads allowed in the thread pool of plug-in servers.

    Valid value: Any positive integer

    Default: 10

    Global default: 30

    Number Of Core Threads

    Specifies the total number of core worker threads that the Java plug-in server initializes to process various RPC requests.

    Valid value: Any positive integer

    Default: 5

    Number Of Selector Threads

    Specifies the total number of selector threads that the Java plug-in server uses to dispatch RPC requests to the core worker thread task queue.

    Valid value: Any positive integer

    Default: 2

    Other Configurations


    Work Queue Monitor Log Interval

    Specifies the interval at which the core worker thread task queue monitor checks whether the tasks in the queue exceed the threshold set for Work Queue Task Threshold.

    Valid value: Any positive integer (milliseconds)

    Default: 0

    Excess Core Threads Idle Keep Alive Time

    Specifies the maximum time that the excess idle threads waits for a new task before terminating.

    Valid value: Any positive integer (milliseconds)

    Default: 0 (unlimited time)

    Reload Delay

    Specifies the interval between adding a plug-in configuration and the system dynamically loading and initiating the plug-in.

    During this interval, you can modify the new plug-in configuration if necessary without restarting the plug-in server. After the system dynamically loads and initiates the plug-in, any changes that you make to the plug-in configuration require a plug-in server restart.

    Valid value: Any positive integer (milliseconds)

    Default: 30000 ms

    Work Queue Task Threshold

    Specifies the threshold for the core worker thread task queue.

    When the tasks in the queue exceed this number, a message is logged in the arjavaplugin.log file.

    Valid value: Any positive integer

    Default: 5

    If the value of Work Queue Monitor Log Interval(mSec) is set to 0, this threshold is ignored.

    Logging Configurations

    To understand more details about logging configuration, see the following videos:


    The videos are recorded using an earlier version of AR System, so the UI displayed in the videos may differ from the UI available for AR System 9.1 and later versions.

    Enable Plugin Log

    The setting that determines whether logging is turned on. The available values are as follows:

    • False
    • True

    To enable logging, select True.

    Parameters added to the pluginsvr_config.xml file:pluginSvrLogEnable

    Log File

    The absolute path and the name of the log file, for example, C:/Program Files/BMC Software/ARSystem/89/ARServer/Db/arjavaplugin.log.

    You can change the name of the log file.

    Parameters added to the pluginsvr_config.xml file:pluginSvrLogFile

    Log Level

    This setting determine the types of messages that are logged for the calls. The following types of log levels are available:

    • TRACE
    • DEBUG
    • INFO
    • WARN
    • ERROR
    • FATAL

    Parameters added to the pluginsvr_config.xml file:pluginSvrLogLevel

    Maximum Log File Size

    The maximum size (in bytes) a log file can reach before an automatic backup copy is made. The backup copy is made with the same file name and an incremental number. By default, this option is disabled. If you want to enable this option, enter a value in the BufferSize (byte) field.  Parameters added to the pluginsvr_config.xml file: pluginSvrLogMaxFileSize

    Log History

    The maximum number of backup files that the system will save. A backup file is generated any time the log file size reaches the limit specified in the Maximum Log File Size parameter. The default value is 10. Parameters added to the pluginsvr_config.xml file: pluginSvrLogMaxHistory

    Native Configurations

    Enable Native Bridge

    Routes the AREAVerifyLogin calls to the Native Plugin Server through a bridge.

    Valid values are:

    • True
    • False (default)

    Always On  

    Log File

    The absolute path and the name of the log file, for example, C:\temp\ao.log.

    You can change the name of the log file.

    Buffer Size

    Size of the log file in bytes.

    If you configure the size to 0 MB, the Always On Logging option gets disabled.

    Number of Copies

    Number of backup files that you need to store.

  5. To save the changes, click Apply, or click Reset to restore the default values.
  6. (Optional) To copy the global settings for the selected plug-in server, click Copy Global.

    When you configure plug-in server logging, the logging parameters are saved in the Pluginsvr_config.xml file. The logging configuration changes are applied immediately; you do not have to restart the plug-in server.

    To apply changes to configuration settings other than logging configuration, you must restart the plug-in server.



Important

  • Encryption-related configurations are removed in version 19.08 because starting from version 19.08, the plug-in server reads the encryption-related configurations from the AR System server.
  • After upgrading AR System server, the plug-in server configuration is reset to the default values.

 

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