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.
Best practice
The following table lists the settings available for centralized configuration.
Tips
- 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 (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 | 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. The likelihood of this occurring increases with the use of multiple servers that share a database. The 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 (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 | 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 | 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 | System > General > Server Information > Advanced > Number of Preload Threads. |
Num-selector-threads 2 (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 | System > General > Server Information > Ports and Queues > Number of Selector Threads. |
Operating-Mode (Component name: com.bmc.arsys.server) | 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:
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 on operating mode, see https://community.bmc.com/s/news/aA33n000000CfdjCAC/operating-mode . | No | N/A |
Oracle-Bulk-Fetch-Count 2 (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 | 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 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 | 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-Clob 2 (Component name: com.bmc.arsys.server) | 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 (Component name: com.bmc.arsys.server) | (Oracle databases only) System ID for the underlying database. | No | AR System Configuration Generic UI form |
Oracle-Service 1 (Component name: com.bmc.arsys.server) | (Oracle databases only) Service Name for the underlying database. | No | 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 | AR System Configuration Generic UI form |
Oracle-Use-Bind-Variables-In-Case-Insensitive-DB | Determines if select queries to the database should execute with variable binding if the Db-Case-Insensitive setting is enabled. Valid values: | 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 Default value—60 seconds You must restart the AR System after you modify the value of this setting. | Yes | AR System Configuration Generic UI form |
Overlay-mode 2 (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 | 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 | AR System Configuration Generic UI form |
Peer-listener-port 1 (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 | 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 | ||
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 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 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. 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 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. 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 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
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 | 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 | AR System Configuration Generic UI form |
Plugin-Loopback-RPC-Socket 2 (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 | 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 server s 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 server s 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 |
Postgres-Index-Concurrently-Max-Retries (Component name: com.bmc.arsys.server.shared) | This property is available only if the Enable-Non-Blocking-Index-Build property is set to The maximum number of attempts to perform create or drop index operations on the PostgreSQL database. Default value — 3 | Yes | AR System Configuration Generic UI form |
Postgres-Index-Concurrently-Retry-Interval (Component name: com.bmc.arsys.server.shared) | This property is available only if the Enable-Non-Blocking-Index-Build property is set to The maximum time interval between two attempts of create or drop index operations on the PostgreSQL database. Default value — 5000 milliseconds | Yes | 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 | 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 | 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 | 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 | 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 | 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 | 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 |
RE-Log-File-Location 2 (Component name: com.bmc.arsys.server) | 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 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. We recommend 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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 | 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. |
Rest-Authentication-Token-Timeout (Component name: com.bmc.arsys.server.shared) | The maximum time for which a user can remain idle in BMC Helix Innovation Suite . If a user does not perform any activity within the Rest-Authentication-Token-Timeout interval, BMC Helix Innovation Suite prompts a message (if the user wants to continue or not). Default value — 3600 seconds Maximum value — 28800 seconds You must restart the AR System server after you modify the value of this setting. | Yes | |
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. | 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 | ||
Restrict-Process-Name-Log (Component name: com.bmc.arsys.server.shared) | A list of semicolon-separated process names for which logging is restricted. | ||
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 | 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. | AR System Administration Console > System > General > Flashboard Server Configuration > RMI Registry Port. (See Configuring the Flashboard server settings at a global level.) | |
Role-Based-Sig-Generate | Generates signatures based on the roles and user names. Valid values:
| ||
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) | ||
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 | 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 | 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 The page ._ars_common_LinkLibrary v21.3 was not found -- Please check/update the page name used in the MultiExcerpt-Include macroin BMC Helix Single Sign-On online documentation. | 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 | AR System Configuration Generic UI form |
Run-Process-Command-WhiteList | Allowlists all commands that are trusted and can be safely executed by using the Run Process action. The Run-Process-Command-WhiteList 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 |
Run-Process-Environment-Variable-WhiteList (Component name: com.bmc.arsys.server.shared) | Controls the allowlisting of environment variables available to processes that run in a filter action. The environment variables in the allowlist are separated by a pipe character (|) The default environment variables are as follows:
The hard-coded environment variables that you cannot use even if they are a part of allowlist are as follows:
| 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.
Comments
The Setting "Run-Process-White-List" is wrong - must be "Run-Process-Command-White-List"
Hello Uwe,
Thanks for brining this to our notice.
We have updated the parameter name, Run-Process-Command-WhiteList.
Regards,
Anagha
Log in or register to comment.