Configuration settings N-R
The centralized configuration forms store the configuration settings. All the numeric values for the settings are in base 10 system. You can modify the settings by using the AR System Configuration Generic UI form. The settings are case- and space-sensitive. See Updating configuration settings by using the AR System Configuration Generic UI form.
Note
BMC recommends that you use the AR System Configuration Generic UI form to modify the configuration settings. Do not use the ar.cfg file to modify the configuration settings on the AR System Configuration Generic UI form.
The following table lists the settings available for centralized configuration.
Tip
- If you cannot view all the columns, view the page in full screen mode. Alternatively, use the scroll bar at the bottom of the table.
- Press F11 to view the table in full screen mode. Press F11 to exit full screen mode.
- To easily search for a specific parameter in the table, select the parameter from the Setting list. Alternatively, type the name of the parameter in the Setting text box. For example, to search for the Next-ID-Block-Size parameter, select it from the Setting list, or type the parameter name in the Setting text box.
- To search for the parameters which have a specific text string in the description, type the string in the Description text box. For example, to search for the parameters which have Configuration in the description, type Configuration in the Description text box.
Configuration options (N-R)
Setting | Description | Server group configuration | Maps to |
---|---|---|---|
Next-ID-Commit 2 | Flag indicating whether to perform a new commit transaction when the system generates the next ID for a record in the database. Valid values:
Note: Next-ID-Block-Size replaced Next-ID-Commit, but Next-ID-Commit is available for backward compatibility. | No | AR System Configuration Generic UI form |
Next-ID-Block-Size | Option that allocates next IDs in blocks instead of one at a time. Allocating in blocks increases performance during create operations. Values are any positive number up to 1000. The default value is 100. (A value of 1 disables the feature.) You can also disable it by removing it from the configuration file. You do not need to restart the server for the change to take effect. Warning: The use of this option might result in unpredictably large Next-ID sequence gaps. The likelihood of this occurring increases with the use of multiple servers that share a database. The BMC Remedy AR System server does not malfunction because of this gap, and it should not be considered a defect. | No | System > General > Server Information > Configuration > Next Request ID Block Size. |
Notification-Web-Path | Base URL that appears in email notifications. If this option is not used, the Default-Web-Path option is used. (Notification-Web-Path is available because the Default-Web-Path is specified for other applications such as Flashboards, and it might be different from the mid tier web path for opening requests in a notification.) | No | AR System Configuration Generic UI form |
Num-Preload-Schema-Segments (Component name: com.bmc.arsys.server) | Total number of preload segments loaded by the preload threads when preload threads are configured. See Setting the Preload Tables Configuration option. | No | System > General > Server Information > Advanced > Number of Preload Segments. |
Num-Preload-Threads (Component name: com.bmc.arsys.server) | Number of preload threads to use when preload threads are configured. A value of 0 indicates that preload threads are not used. The maximum value is 30 or twice the number of preload segments, whichever is lower. See Setting the Preload Tables Configuration option. | No | System > General > Server Information > Advanced > Number of Preload Threads. |
Num-selector-threads 1 | Defines the number of threads that can be used to monitor all the live client socket connections for IO activity. When the thread detects any activity, it forwards the call to the appropriate queue. Default value: 1 | No | System > General > Server Information > Ports and Queues > Number of Selector Threads. |
Operating-Mode | Parameter to indicate to the AR System server if upgrade is in progress so that some of the background processes are disabled to speed up upgrade. Valid values:
Note: The value for this parameter is set by the upgrade installer only. This is not an option, you are suppose to set directly. For more information, see
Troubleshooting installer failure during upgrade
For more information on operating mode, see https://communities.bmc.com/community/bmcdn/bmc_remedy_ar_system/blog/2018/02/27/upgrade-mode | No | N/A |
Oracle-Bulk-Fetch-Count 2 | Number of data rows simultaneously fetched from the result set when an Oracle database is queried. The minimum is 1, the maximum is 100, and the default is 50. The higher the value, the more memory is used during data retrieval. | No | AR System Configuration Generic UI form |
Oracle-Clob-Storage-In-Row (Component name: com.bmc.arsys.server) | (Oracle databases only) Flag controlling Oracle CLOB storage. Valid values:
| No | AR System Configuration Generic UI form |
Oracle-Cursor-Sharing 2 (Component name: com.bmc.arsys.server) | Database setting that matches the setting in the Oracle initialization file (initARS.ora if the BMC Remedy AR System database SID is ARS). With Remedy AR System, we recommend setting the Oracle parameter Oracle-Cursor-Sharing to EXACT for all 9.x versions if you are using case-sensitive database or case-insensitive database. | No | AR System Configuration Generic UI form |
Oracle-Search-On-Clob 2 | Flag indicating whether CLOBs can be searched. Valid values:
CLOBs can use the operator LIKE, but not =. | No | AR System Configuration Generic UI form |
Oracle-SID 1 | (Oracle databases only) System ID for the underlying database. | No | AR System Configuration Generic UI form |
Oracle-Service 1 | (Oracle databases only) Service Name for the underlying database. | No | AR System Configuration Generic UI form |
Overlay-mode 2 | Specifies the default overlay group for the server. Clients that use the default overlay group (all clients other than Developer Studio) will retrieve and use objects from the default group. Valid values:
| No | AR System Configuration Generic UI form |
Per-Thread-Logging | Flag indicating whether to create per-thread log files. Valid values:
| No | AR System Configuration Generic UI form |
Peer-listener-port 1 | Defines the port number where all the cache instances from different servers communicate with each other. Default value: 40001 | No | System > General > Server Information > Ports and Queues > Cache Peer Listener Port. |
Peer-Remote-Object-Port | Defines the remote object port number where all ehcache instances from different servers communicate with each other. Default value — 40002 | No | |
Plugin 2 (Component name: com.bmc.arsys.server) | File name of one or more plug-ins that the plug-in server loads. The file name of the DLL or shared object is provided. The file name might be an absolute file name or might be relative to the BMC Remedy AR System installation directory. Add as many entries for this option to the server configuration file as needed, but specify only one file name in each option. | No | AR System Configuration Generic UI form |
Plugin-ARDBC-Threads 2 | Number of threads dedicated to handling ARDBC requests from the BMC Remedy AR System server. You must specify a minimum number. Optionally, you can also specify a maximum number (the plug-in server increases the number of threads for a plug-in as needed up to the specified maximum). The syntax is
By default, 1 thread is initiated if this option is not specified. Note: Plugin-ARDBC-Threads parameter is used by the C plugin server. This parameter is not used by Java plugin servers. For Java plugin server, you can change the number of threads by changing the value of the numCoreThreads tag in pluginsvr_config.xml file. | No | AR System Configuration Generic UI form |
Plugin-AREA-Threads 2 | Number of threads dedicated to handling AREA requests from the BMC Remedy AR System server. You must specify a minimum number. Optionally, you can also specify a maximum number (the plug-in server increases the number of threads for a plug-in as needed up to the specified maximum). The syntax is
By default, 1 thread is initiated if this option is not specified. Note: Plugin-AREA-Threads parameter is used by the C plugin server. This parameter is not used by Java plugin servers. For Java plugin server, you can change the number of threads by changing the value of the numCoreThreads tag in pluginsvr_config.xml file.
| No | AR System Configuration Generic UI form |
Plugin-Filter-API-Threads 2 | Number of threads dedicated to handling BMC Remedy AR System Filter API requests from the BMC Remedy AR System server. You must specify a minimum number. Optionally, you can also specify a maximum number (the plug-in server increases the number of threads for a plug-in as needed up to the specified maximum). The syntax is
By default, 1 thread is initiated if this option is not specified. Note: Plugin-Filter-API-Threads parameter is used by the C plugin server. This parameter is not used by Java plugin servers. For Java plugin server, you can change the number of threads by changing the value of the numCoreThreads tag in pluginsvr_config.xml file. | No | AR System Configuration Generic UI form |
Plugin-Log-File | Full path name of the file to use if plug-in logging is on (see Debug-mode). | No | AR System Configuration Generic UI form |
Plugin-Log-Level | Option that specifies the type of information printed to plug-in log files. Valid values:
| No | AR System Configuration Generic UI form |
Plugin-Loopback-RPC-Socket 2 | RPC socket number for the private server queue to which loopback plug-in API calls should be directed. Values are in the following ranges:
Loopback plug-ins (such as the Report Creator plug-in) that call back into BMC Remedy AR System use this number to determine the queue to request. By default, plug-in API calls are directed to a queue that corresponds to the call type. To be effective, the server must be configured to have a designated private queue for this option. | No | System > General > Server Information > Ports and Queues > Plugin Loopback RPC Program Number. |
Plugin-Password | Plug-in password. If this option is specified, the plug-in server accepts connections only from BMC Remedy AR System servers whose Server-Plugin-Target-Password option is set to the same password. If this option is not specified, the plug-in server accepts connections from BMC Remedy AR System servers that are not configured to use a plug-in password. | No | AR System Configuration Generic UI form |
Plugin-Port 2 (Component name: com.bmc.arsys.server) | The port number on which the plug-in server waits for incoming requests. | No | AR System Configuration Generic UI form |
Preference-Server-Option | Option that specifies whether users must use centralized preferences. Valid values:
| No | System > General > Server Information > Advanced > Preference Server Option. (See Setting performance and security options.) |
Private-RPC-Socket (Component name: com.bmc.arsys.server) | RPC program number that determines the type of queue to which requests are routed and the number of threads running on that queue. | No | System > General > Server Information > Ports and Queues > Server Queue. |
Private-RPC-Socket (for debug queue) (Component name: com.bmc.arsys.server) | Option that designates debug queues. A debug queue is a type of private queue used by the BMC Remedy AR System Workflow Debugger. To make any private queue a debug queue, use this syntax:Private-RPC-Socket: rpcNumber Debug For example: Private-RPC-Socket: 390666 Debug Alternatively, you can make a private queue a debug queue by selecting its Debug check box in the list of queues in the Ports and Queues tab of the Administration Console. | No | AR System Configuration Generic UI form |
RE-Log-File-Location 2 | Location of the Reconciliation Engine log file. | No | AR System Configuration Generic UI form |
Record-Object-Relationships (Component name: com.bmc.arsys.server) | Flag indicating whether the BMC Remedy AR System server records the relationships between workflow objects. Note: If using a server group, all servers within the same server group must have the same setting for this option. If they do not, the servers in the group inconsistently populate and un-populate the object relationship database should they be the highest ranked server for the Administration operation when they are restarted. Only the highest ranked server for the Administration operation in the server group will perform the required object relationship actions when restarted. Valid values:
When you set this option to T and restart the server, it records the relationships of all server objects before it accepts connections from clients. Therefore, the first time you restart the server after selecting this option, you cannot connect to the server with any clent for a period of time, depending on how many objects are defined on the server. With a large number of objects, such as with an ITSM application installed, this could take as long as an hour depending on the performance of the database. (Subsequent server startups are not affected by this setting.) When you can connect, the recording of object relationship data is complete.
When you set this option to F or remove it and restart the server, all the recorded relationships are removed from the database. You must restart the BMC Remedy AR System server before a change to this option takes effect. Note: BMC recommends that you set this option by using the Record Object Relationships option on the Configuration tab of the BMC Remedy AR System Administration: Server Information form instead of setting it manually in the configuration file. See Viewing and sorting related objects. | No | System > General > Server Information > Configuration > Record Object Relationships. |
Record-Server-Events | Server events to log in the Server Events form, which makes server-related changes available to workflow and API programs. Enter the following values, separated by semicolons, for the events to record.
For example:Record-Server-Events: 4;8;9;12;14; For information about the Server Events form, viewing recorded server events, and using server events in workflow, see Understanding the Server Events form. | No | AR System Configuration Generic UI form |
Register-With-Portmapper (Component name: com.bmc.arsys.server) | Flag that prevents the BMC Remedy AR System server from registering with a portmapper. Use this feature in conjunction with setting specific ports to enable you to run servers on computers that do not have a portmapper. Valid values:
No more than one server should try to register with AR System Portmapper in an environment with multiple servers on one computer. | No | System > General > Server Information > Ports and Queues > Register with Portmapper. |
Registry-Admin-Password | Password of the BMC Atrium Web Services Registry admin user. Used by workflow for the BMC Remedy AR System Web Services Registry form. | No | AR System Configuration Generic UI form |
Registry-Admin-User | User name of the BMC Atrium Web Services Registry admin user. Used by workflow for the BMC Remedy AR System Web Services Registry form. | No | AR System Configuration Generic UI form |
Registry-Location | URL of the BMC Atrium Web Services Registry. Used by workflow for the BMC Remedy AR System Web Services Registry form. | No | AR System Configuration Generic UI form |
Remedy-App-Service-Password (Component name: com.bmc.arsys.server) | Encrypted password that AR System application services such as Approval Server use to access the BMC Remedy AR System server. | No | System > General > Server Information > Connection Settings > Application Service Password. (See Setting server passwords, RPC options, and plug-in timeouts.) |
Required-Field-Identifier (Component name: com.bmc.arsys.server) | Character to add to the label of a field whose entry mode is Required. The default is an asterisk. | No | The Required Field Identifier field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
Required-Field-Identifier-Location (Component name: com.bmc.arsys.server) | Position to add the character that identifies a Required field. Valid values:
| No | System > General > Server Information > Configuration > Required Field Identifier. |
RMIRegistryPort (Component name: com.bmc.arsys.flashboardServer) | Port number for the Remote Method Invocation (RMI) of the selected BMC Remedy Flashboards server. | AR System Administration Console > System > General > Flashboard Server Configuration > RMI Registry Port. (See AR System Administration - Flashboard Server Configuration.) | |
RPC-QUEUE-BY-CLIENT-TYPE | This option specifies a private queue for a Client type. The option forces the API calls made by the Client Types to use this private queue. The syntax is: RPC-QUEUE-BY-CLIENT-TYPE: Client-Type Private RPC Queue. For example: RPC-QUEUE-BY-CLIENT-TYPE: 0 390685. | Yes | System > General > Server Information > Ports and Queues > Client Type to RPC Restriction Mapping. |
1. Options you can view (but not set) using the AR System Administration: Server Information form.
2. Options you cannot set or view using the AR System Administration: Server Information form.
Comments
Please can you review the Private-RPC-Socket setting description. It does not match
https://docs.bmc.com/docs/display/public/ars91/Defining+queues+and+configuring+threads
and i think the description got somehow mixed up with the one from Plugin-Loopback-RPC-Socket 2.
Hello Andreas,
The description for Private-RPC-Socket setting is correct. There was some discrepancy in the Plugin-Loopback-RPC-Socket setting. I have updated the topic.
Thanks,
Prachi
Hello Prachi,
Thanks for the update.
If you follow https://docs.bmc.com/docs/display/public/ars91/Defining+queues+and+configuring+threads but omit step 7 (because debugging is not needed) then an Private-RPC-Socket entry is created in ar.conf without Debug parameter.
So the Private-RPC-Socket option does not ONLY create a debug queue while the description indicates so.
Also the description lacks the valid ranges - similar/same to Plugin-Loopback-RPC-Socket 2 or can I use any number with 9.1?
Br,
Andreas
I miss the new paramters "oracle-service" and "Db-Server-Port".
Hello Stefan,
We are sorry for the delay in response. The parameter Oracle-Service is documented on ar.cfg or ar.conf options N-R topic.
And the parameter Db-Server-Port is documented on ar.cfg or ar.conf options C-D topic.
Thanks,
Prachi
Why not here? I see it and can edit it.
Hello Stefan,
I got this confirmed from the SME and have updated the topic with the Oracle-Service and Db-Server-Port parameter.
Thanks,
Prachi
Oracle-Two-Task is no longer used
Hello Stefan,
I am verifying the parameter Oracle-Two-Task. I will get back to you soon.
Thanks,
Prachi
any progress?
Hello Stefan,
The
Oracle-Two-Task
parameter is no longer used. I removed the parameter from the list.We are sorry for the inconvenience.
Thanks,
Prachi
RPC-Non-Blocking-IO option has been deprecated in version 9.x. The AR Server uses the Java NIO package which is non-blocking by default.
Hello Team,
As mentioned by Robert above and as per the defect: SW00525637 the parameter RPC-Non-Blocking-IO is no longer applicable since we use the Java code in the AR Server. Please check the defect's details as it states that the docs in 9.x should have been updated and at Support we still receiving queries about the usage of this parameter.
Thanks in advance.
Jaime