Configuration settings N-R
The centralized configuration for troubleshooting installer failure during upgrades 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.
The following table lists the settings available for centralized configuration.
Configuration options (N-R)
Setting | Description | Server group configuration | Restart required | Maps to |
---|---|---|---|---|
Next-ID-Commit2 (Component name: com.bmc.arsys.server) | Flag indicating whether to perform a new commit transaction when the system generates the next ID for a record in the database. Valid values:
Next-ID-Block-Size replaced Next-ID-Commit, but Next-ID-Commit is available for backward compatibility. | No | No | AR System Configuration Generic UI form |
Next-ID-Block-Size (Component name: com.bmc.arsys.server) | 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 15000. 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, especially in a multi-server environment where servers share a database. As a result, request IDs might not align with the submit date or follow a strict sequence if the Next-ID Block Size is greater than 1. This behavior is by design to improve system performance. The BMC Remedy AR System server does not malfunction because of this gap, and it should not be considered a defect. | No | No | System > General > Server Information > Configuration > Next Request ID Block Size. |
Notification-Web-Path (Component name: com.bmc.arsys.server) | 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 | 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 Configuring-how-AR-System-server-manages-cache. Important: After you start AR System server, the server ignores the value that is defined for the number of segments in the Num-Preload-Schema-Segments parameter and instead starts with 150 segments. | No | 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 Configuring-how-AR-System-server-manages-cache. Important: After you start AR System server, the server ignores the value that is defined for the number of threads in the Num-Preload-Threads parameter and instead starts with 10 threads. | No | No | System > General > Server Information > Advanced > Number of Preload Threads. |
Num-selector-threads2 (Component name: com.bmc.arsys.server) | 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 | No | System > General > Server Information > Ports and Queues > Number of Selector Threads. |
Operating-Mode (Component name: com.bmc.arsys.server) | This parameter indicates if BMC Helix Innovation Suite or applications upgrade is in progress. This parameter prevents the replication of metadata changes to other servers, also also deprioritizes some background processes to speed up the upgrade process. Valid values:
Important: | No | No | N/A |
Oracle-Bulk-Fetch-Count2 (Component name: com.bmc.arsys.server) | 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 | 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 | No | AR System Configuration Generic UI form |
Oracle-Cursor-Sharing2 (Component name: com.bmc.arsys.server) | Database setting that matches the setting in the Oracle initialization file (initARS.ora if the AR System database SID is ARS). With 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 | No | AR System Configuration Generic UI form |
Oracle-DoP | Defines the number of DB parallel threads. By default, for queries using a parallel hint, the degree of parallelism is set to 12. | Yes |
| AR System Configuration Generic UI form |
Oracle-Search-On-Clob2 (Component name: com.bmc.arsys.server) | Flag indicating whether CLOBs can be searched. Valid values:
CLOBs can use the operator LIKE, but not =. | No | No | AR System Configuration Generic UI form |
Oracle-SID1 (Component name: com.bmc.arsys.server) | (Oracle databases only) System ID for the underlying database. | No | Yes | AR System Configuration Generic UI form |
Oracle-Service1 (Component name: com.bmc.arsys.server) | (Oracle databases only) Service Name for the underlying database. | No | Yes | AR System Configuration Generic UI form |
Oracle-Sort-Null-First | (Oracle databases only) Sorts the NULL values to the top when set to True - T. By default, it is set to False - F, when the NULL values appear at the bottom. | No | No | AR System Configuration Generic UI form |
Outbound-Http-Client-Read-Timeout (Component name: com.bmc.arsys.server.shared) | This parameter defines the time interval when any outbound HTTP/REST call, including the AR System webhook callback from the AR System server to an external HTTP server waits to respond before displaying the j ava.net .SocketTimeoutException exception. Default value—60 seconds You must restart the AR System server after you modify the value of this setting. | Yes | No | AR System Configuration Generic UI form |
Overlay-mode2 (Component name: com.bmc.arsys.server) | 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 | No | AR System Configuration Generic UI form |
Per-Thread-Logging (Component name: com.bmc.arsys.server) | Flag indicating whether to create per-thread log files. Valid values:
| No | No | AR System Configuration Generic UI form |
Peer-listener-port1 (Component name: com.bmc.arsys.server) | Defines the port number where all the cache instances from different servers communicate with each other. Default value: 40001 | No | No | System > General > Server Information > Ports and Queues > C ache 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 |
|
Plugin2 (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 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 | No | AR System Configuration Generic UI form |
Plugin-ARDBC-Threads2
| Number of threads dedicated to handling ARDBC requests from the 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 Plugin-ARDBC-Threads: <minimumNumberOfThreads [<maximumNumberOfThreads>] By default, 1 thread is initiated if this option is not specified. 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-Threads2 | Number of threads dedicated to handling AREA requests from the 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 Plugin-AREA-Threads: <minimumNumberOfThreads> [<maximumNumberOfThreads>] By default, 1 thread is initiated if this option is not specified. 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-Threads2 | Number of threads dedicated to handling AR System Filter API requests from the 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 Plugin-Filter-API-Threads: <minimumNumberOfThreads> [maximumNumberOfThreads>] 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 (Component name: com.bmc.arsys.server) | Full path name of the file to use if plug-in logging is on (see Debug-mode). | No | No | AR System Configuration Generic UI form |
Plugin-Log-Level (Component name: com.bmc.arsys.server) | Option that specifies the type of information printed to plug-in log files. Valid values:
| No | No | AR System Configuration Generic UI form |
Plugin-Loopback-RPC-Socket2 (Component name: com.bmc.arsys.server) | 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 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 | No | System > General > Server Information > Ports and Queues > Plugin Loopback RPC Program Number. |
Plugin-Password (Component name: com.bmc.arsys.server) | Plug-in password. If this option is specified, the plug-in server accepts connections only from 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 AR System servers that are not configured to use a plug-in password. | No | No | AR System Configuration Generic UI form |
Plugin-Port2 (Component name: com.bmc.arsys.server) | The port number on which the plug-in server waits for incoming requests. | No | No | AR System Configuration Generic UI form |
Postgres-Sort-Null-First
| (Postgres databases only) Sorts the NULL values to the top when set to True - T . By default, it is set to False - F , when the NULL values appear at the bottom. | No | No | AR System Configuration Generic UI form |
Preference-Server-Option (Component name: com.bmc.arsys.server) | Option that specifies whether users must use centralized preferences. Valid values:
| No | No | System > General > Server Information > Advanced > Preference Server Option. (See Setting-performance-and-security-options) |
Preferred-User-Locale (Component name: com.bmc.arsys.server) | Sets the global locale for all users of the tenant. It takes precedence over user locale set by using My Preferences and browser locale. When the global locale is not set, the user's locale from the My Preferences setting is applied, If none of the preferences are defined, then the browser locale is used for the user session. If the user logs in to BMC Helix Innovation Studio by using multiple sessions and updates the locale by using the Preferred-User-Locale or My Preferences > Preferred Language setting, the locale is set only after the user logs out from all the active sessions.
| No | No | AR System Configuration Generic UI form |
Process-History-Level (Component name: com.bmc.arsys.server) | Controls whether to enable or disable the activity history of a process instance. If Process-History-Level is set to 0, the process start time and end time will be the same. For instances that are still active, the create date of the Process Context record is the start time and its end time will be null. Valid values:
| No | No | AR System Configuration Generic UI form |
Process-Log-File (Component name: com.bmc.arsys.server) | Full path name of the file to use if PROCESS logging is on. Following is the default file where the log entries are created: arprocess.log | No | No | AR System Configuration Generic UI form |
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 | 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 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 |
pv.enable_attachment_on_delete_confirmation (Component name: arsystem.bmc.arsys.midtier > arsystem.bmc.arsys.midtier-DockerMTClusterUser)
| Enables display of a confirmation message when users remove an attachment on Progressive Web Application (PWA) screens. The default value for this option is false, which means the application does not display a message when attachments are removed. As an administrator, you can set this option to true to enable confirmation messages when PWA users remove attachments. | No | No | AR System Configuration Generic UI form |
pv.show_transparent_loader (Component name: com.bmc.arsys.server) | Enables the display of a loader on PWA screens when you run the following command: ENABLE-WAIT-CURSOR-ON-LONG-RUNNING-PROCESS 2 Valid values:
To learn more about this command, see Process commands. | No | No | AR System Configuration Generic UI form |
RBEMaxTries (Component name: arsystem.bmc.arsys.itsm) | Enables Rule Based Email to attempt to process email messages more than once. Set this option to values between 0 and 3 based on the number of times you want the Rule Based Email to retry processing the email messages. | No | No | AR System Configuration Generic UI form |
RE-Log-File-Location2 (Component name: com.bmc.arsys.server) | Location of the Reconciliation Engine log file. | No | No | AR System Configuration Generic UI form |
Record-Object-Relationships (Component name: com.bmc.arsys.server) | Flag indicating whether the AR System server records the relationships between workflow objects. 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 BMC Helix 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 AR System server before a change to this option takes effect. 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-related-objects. | No | No | System > General > Server Information > Configuration > Record Object Relationships. |
Record-Server-Events (Component name: com.bmc.arsys.server) | 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 Capturing-server-events-for-workflow-or-API-calls. | No | No | AR System Configuration Generic UI form |
Register-With-Portmapper (Component name: com.bmc.arsys.server) | Flag that prevents the 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 | No | System > General > Server Information > Ports and Queues > Register with Portmapper. |
Registry-Admin-Password (Component name: com.bmc.arsys.server) | Password of the BMC Atrium Web Services Registry admin user. Used by workflow for the BMC Remedy AR System Web Services Registry form. | No | No | AR System Configuration Generic UI form |
Registry-Admin-User (Component name: com.bmc.arsys.server) | 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 | No | AR System Configuration Generic UI form |
Registry-Location (Component name: com.bmc.arsys.server) | URL of the BMC Atrium Web Services Registry. Used by workflow for the BMC Remedy AR System Web Services Registry form. | No | 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 AR System server. | No | No | System > General > Server Information > Connection Settings > Application Service Password. (See Specifying-passwords-and-properties-for-connecting-services-to-the-server.) |
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 | 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 | No | System > General > Server Information > Configuration > Required Field Identifier. |
REST-API-Payload-Escape-Global | Controls how the escaping of dynamic characters is handled in static JSON in REST API filter. Valid values:
You can also add escaping to specific fields on the form by using the ESCAPE keyword. For example, $ESCAPE.fieldname$. | No | No | AR System Configuration Generic UI form |
REST-API-Payload-Escape-Special-Characters-List | Important: The REST-API-Payload-Escape-Global must be set to T to use this setting. Controls escaping of specific characters in static JSON in REST API filter. Allowed characters ";/;\t;\b;\r;\n;\f | No | No | AR System Configuration Generic UI form |
Rest-Authentication-Token-Timeout | REST token timeout. Determines for how long the REST API token is valid. Default value —3600 seconds | Yes | No |
|
Restrict-Logging | Controls which type of logging restriction is enabled. The value of the Restrict-Logging parameter depends on the combination of logging restrictions that you select. Possible values of the restriction parameters are as follows:
You can have combinations of Users, Client Type, and RPC Queues restrictions. For example, if you select Users and Client Type restrictions, the value of the Restrict-Logging parameter is set to 9 (1+8). The default value of Restrict-Logging parameter is 0. |
| No | AR System Configuration Generic UI form |
Restrict-Log-Users (Component name:com.bmc.arsys.server) | A list of semicolon-separated user names. Restricts the logging only for specified users. For example, Allen;Mike |
| No |
|
Restrict-Process-Name-Log (Component name: com.bmc.arsys.server.shared) | A list of semicolon separated process names for which logging is restricted. |
| No |
|
Rls-Autodiscovery-Minimum-Elapsed-Time (Component name: com.bmc.arsys.server.shared) | Represents the minimum time required to fetch results from a Row-level Security (RLS) query. The RLS query is logged in the AR System:RLS Autodiscovery form, if th e Subquery algorithm is not enabled on the forms where the RLS query runs. Default value —5 seconds Valid value —Integer value > 0 |
| No | AR System Administration Console > System > General > Centralized Configuration |
RMIRegistryPort (Component name: com.bmc.arsys.flashboardServer) | Port number for the Remote Method Invocation (RMI) of the selected Flashboards server. |
| No | AR System Administration Console > System > General > Flashboard Server Configuration > RMI Registry Port. (See Configuring-the-Flashboard-server-settings-at-a-global-level.) |
RPC-Client-XDR-Size-Limit | This option sets the External Data Representation (XDR) for all clients connecting to the AR System Server. Use this option to frame data encoding and for transferring data from clients to the AR System Server. This operation is performed at layer 6 of the OSI model and is negotiated on the initial connection of a client to the AR System Server. If you are using any form in encryption, set the value to 450000 to avoid issues that may occur while transferring large files or records. Default Value: (Not set/visible) |
| No |
|
RPC-QUEUE-BY-CLIENT-TYPE | Forces API calls to use the private queue specified for the client type. Syntax: RPC-QUEUE-BY-CLIENT-TYPE: Client-Type Private RPC Queue Example: RPC-QUEUE-BY-CLIENT-TYPE: 0 390685 | Yes | No | System > General > Server Information > Ports and Queues > Client Type to RPC Restriction Mapping. |
RSSO-External-URL (Component name: com.bmc.arsys.server.shared) | Stores the URL of the BMC Helix Single Sign-On server that is used to authenticate a user. Developer Studio passes the URL to the BMC Helix Single Sign-On server. | No | No | AR System Configuration Generic UI form |
RSSO-Internal-URL | Specify this setting only when Common Access Cards (CAC) method is used to authenticate an end user. Use this setting when the certificate-based authentication process is configured in BMC Helix Single Sign-On. For more information, see Configuring certificate-based authenticationin BMC Helix Single Sign-On online documentation. | No | No | AR System Configuration Generic UI form |
RSSO-Client-Secret (Component name: com.bmc.arsys.server.shared) | The BMC Helix Single Sign-On Administrator needs to register Developer Studio. After the Administrator completes the registration, BMC Helix Single Sign-On provides a client ID and a client secret. Developer Studio needs to query the client ID and the secret. The format is Client Type;Client ID;Client Secret. The Client Type is 36. The administrator can get the values for Client ID and Client Secret from the BMC Helix Single Sign-On server. The administrator must enter the values in the same sequence as specified in the format. | No | No | AR System Configuration Generic UI form |
Run-Process-Command-WhiteList | Lists commands that are allowed to be executed from workflow objects by using run process actions. Multiple commands are separated by the pipe (|) character. | No | No | AR System Configuration Generic UI form |
Run-Process-Environment-Variable-WhiteList | Lists environment variables available to a process which is started by using a run process action in workflow objects. Multiple variables are separated by the pipe (|) character. | No | No | AR System Configuration Generic UI form |
Run-Process-White-List | Lists all commands that are trusted and can be safely executed by using the Run Process action. The Run-Process-White-List setting includes the following list of out-of-the-box commands: "../artools/arexport.sh" | "./artools/arexport.bat" | "pdp.sh" | "./artools/pdp.bat" | "remoteaction/remoteaction.sh" | "remoteaction\remoteaction.bat" | "DMLDataImport.bat" | "DMLDataImport.sh" | "../AtriumCore/cmdb/utils/DashboardDataGenerator/rundashboardutil.cmd" | "../AtriumCore/cmdb/utils/DashboardDataGenerator/rundashboardutil.sh" | "/opt/bmc/ARSystem/db/mkdir.sh" Important:
| No |
| AR System Configuration Generic UI form |
|
|
|
|
|
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.