Error: Invalid spaceKey on retrieving a related space config.

Setting plugin server configuration options

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

  1. In a browser, open the BMC Remedy AR System Administration Console, and click System > General > Plugin Server Configuration.
  2. Select a Plugin Server Instance.
  3. Click the Plugin Server Configuration tab.
  4. Edit the options listed in the following table, as needed:
Area nameField nameDescription
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.

Note: 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:

  • 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

Note: This option is for internal use only.  

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

Encryption Configurations



Encryption policy

Determines whether the plug-in server allows or requires encrypted communication with the AR System server

Valid values:

  • 0 - Allowed but not required
  • 1 - Required
  • 2 - Not allowed (default)
Data Encryption Algorithm

Determines the network data encryption algorithm that the plug-in server uses to communicate with its clients

Valid values:

  • 1 - 56-bit Data Encryption Standard (DES) that uses Cipher Block Chaining (CBC) mode
  • 2 - 128-bit RC4 key. It does not comply with FIPS and is available with Performance Security.
  • 3 - 256-bit RC4 key. It does not comply with FIPS and is available with Premium Security.
  • 6 - 128-bit AES CBC key. It does not comply with FIPS and is available with Performance Security.
  • 7 - 256-bit AES CBC key. It does not comply with FIPS and is available with Premium Security.
  • 8 - 128-bit AES CBC key. It complies with FIPS and is available with Performance Security.
  • 9 - 256-bit AES CBC key. It complies with FIPS and is available with Premium Security.

Notes:

If the value of Encryption Policy is set to 2, this option is ignored.

The configuration of Data Encryption Algorithm in Plug-in server should be the same as the configuration of Encrypt-Data-Encryption-Algorithm in AR server.

Data Key Expiry

Specifies the expiration time for the network data encryption key

Valid value is any positive integer. The default is 2700 (in seconds).

Note: If the value of Encryption Policy is set to 2, this option is ignored.

Public Key Algorithm

Specifies the publickey-privatekey encryption algorithm that the plug-in server uses to communicate with its clients

Valid values:

  • 4 - RSA low encryption, modulus 512 bits (default)
  • 5 - RSA medium encryption, modulus 1024 bits (requires BMC Remedy Encryption Performance Security)
  • 6 - RSA high encryption, modulus 2048 bits (requires BMC Remedy Encryption Premium Security)

Note: If the value of Encryption Policy is set to 2, this option is ignored.

Public Key Expiry

Specifies the expiration time for public key

Valid value: Any positive integer
Default: 86400 (seconds)

Note: If the value of Encryption Policy is set to 2, this option is ignored.

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

Note: 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:

To understand the concept of configuring plug-in server logging, see  BMC Remedy AR System Plugin server logging feature and its value. .

For a quick demo on how to configure plug-in server logging, see  BMC Remedy AR System Plugin server logging feature. .

To understand how to enable debug logs for AR plug-in server , see   BMC Remedy AR System Plugin server logging feature. .

Note: The videos are recorded using the earlier version of BMC Remedy AR System. So the UI displayed in the videos may differ than the UI available for BMC Remedy 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

Note: You can change the name of the log file.

Parameters added to the pluginsvr_config.xml file: pluginSvrLogFile

Log LevelThis setting determine the types of messages that are logged for the calls. The following different types of log levels are available
  • TRACE
  • DEBUG
  • INFO
  • WARN
  • ERROR
  • FATAL

Parameters added to the pluginsvr_config.xml file: pluginSvrLogLevel

Maximum Log File SizeThe 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 HistoryThe 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 ConfigurationsEnable Native Bridge

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

Valid values:

  • True
  • False (default)

Always On  

Log File

The absolute path and the name of the log file.

For example, C:\temp\ao.log

Note: You can change the name of the log file.

Buffer Size

Size of the log file in bytes.

Note:

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

Number of CopiesNumber of backup files that you need to store

  1. To save the changes, click Apply, or click Reset to restore the default values.

  2. (Optional) To copy the global settings for the selected plug-in server, click Copy Global.

Note

  • When you configure plugin 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. 

Related topics

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

Comments