ar.cfg or ar.conf options N-R

This section of the table includes the options for the ar.cfg (ar.conf) file that begins with the letters N through R:

Best practice
We recommend that you use the  AR System Configuration Generic UI  form to modify the configuration settings. You should not use the  ar.cfg  file to modify the configuration settings available on the  AR System Configuration Generic UI  form. See  Configuration Settings N-R.

ar.cfg (ar.conf) file options (N-R)

Tips

  • Press F to view the table in full screen mode. Press Esc to exit full screen mode.
  • To easily search for a specific parameter in the below table, select the parameter from the Option list. Alternatively, type the name of the parameter in the Option text box.
    For example, to search for the Next-ID-Block-Size parameter, select it from the Option list, or type the parameter name in the Option text box.
  • To search for all parameters having a specific text string in the name, type the text string in the Option text box.
    For example, to search for all ID parameters, type ID in the Option 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.

Option

Description

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.

Values are:

  • T—Perform a new commit transaction. To increase efficiency and for debugging, use this value.
  • F—(Default) Include the transaction to generate the next ID in the create entry transaction.

Next-ID-Block-Size  replaced  Next-ID-Commit , but  Next-ID-Commit  is available for backward compatibility.

 

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 25. (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.
This setting is always disabled on the Distributed Pending form so that DSO can operate correctly.

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 will not malfunction because of this gap, and it should not be considered a defect.

The  Next Request ID Block Size field on the Configuration tab of the AR System Administration: Server Information form. (See Setting-administrative-options.)

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.)

 

Num-Archive-Threads

(Component name: com.bmc.arsys.server.shared)

Sets the number of threads for archiving in the AR System server.

Default value: 1

 

Num-Preload-Schema-Segments  

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.

The  Number of Preload Segments field on the   Advanced tab of the AR System Administration: Server Information form. (See Setting-performance-and-security-options.)

Num-Preload-Threads  

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.

The  Number of Preload Threads field on the   Advanced tab of the AR System Administration: Server Information form. (See Setting-performance-and-security-options.)

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

 

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.

 

Oracle-Clob-Storage-In-Row

(Oracle databases only) Flag controlling Oracle CLOB storage.

Values are:

  • T—CLOBs are created "in row." In-row CLOBs can degrade CPU performance.
  • F—(Default) CLOBs are created "out row." Out-row CLOBs can cause the database to grow rapidly.

 

Oracle-Cursor-Sharing 2

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-Cursor-Sharing parameter to the following:

  • If you are using case-sensitive database, set it to EXACT for all 9.x versions.
  • If you are using case-insensitive database, for the 9.1.04.002 version and the later versions, set it to EXACT.

 

Oracle-Dblink-Character-Set 2

Option that enables AR System to support remote databases with different character sets. You can enter this option multiple times in the configuration file for multiple view forms on different remote databases with different link names. The syntax is Oracle-Dblink-Character-Set: linkName charset

  • linkName should match LINK in OWNERNAME.TABLENAME@LINK in the table name of the view form on the remote database.
  • charset can be utf-8, utf-16, ucs-2, euc, and shift-jis.

For example: Oracle-Dblink-Character-Set: eng.remedy.com shift-jis 

For information about view forms, see View-forms.

 

Oracle-JDBC-URL

(Oracle databases only) Used to configure AR System to support Oracle Data Guard.

The following syntax is used:

Oracle-JDBC-URL: jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=OFF)(FAILOVER=ON)(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=primarydb_host)(PORT=primarydb_port))(ADDRESS=(PROTOCOL=TCP)(HOST=standbydb_host)(PORT=standbydb_port)))(CONNECT_DATA=(SERVICE_NAME=ORADG.BMC.COM)(SERVER=DEDICATED)))

When you specify the Oracle-JDBC-URL parameter, the AR System server ignores the following parameters:

  • Oracle-Service
  • Db-Host-Name
  • Db-Server-Port
  • Oracle-SID
  • Db-Custom-Conn-Props
  • SQL-Secure-Connection

 

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.

 

Oracle-Search-On-Clob 2

Flag indicating whether CLOBs can be searched.

Values are:

  • T—(Default) Allow searches on CLOBs. When a search is performed, the qualification can include all the diary and character fields stored in the database as CLOB columns. Including these fields affects performance, and indexes cannot be used for this type of query.
  • F—Searching on diary and character fields stored in the database as CLOB columns returns an error.

CLOBs can use the operator LIKE, but not =.

 

Oracle-SID 1

(Oracle databases only) System ID for the underlying database.

When you specify the Oracle-JDBC-URL parameter, the AR System server ignores this option. For more information, see Setting up an Oracle database.

 

Oracle-Service

(Oracle databases only) Service Name for the underlying database.

When you specify the Oracle-JDBC-URL parameter, the AR System server ignores this option. For more information, see Setting up an Oracle database.

 

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.

  • 0—Clients will only retrieve and operate on origin objects. Custom objects and overlays of origin objects will not be visible to clients, and the server will execute only origin filters and escalations. In this mode, customizations are ignored.
  • 1—Clients will retrieve non-overlaid origin objects, overlays, and custom objects. All customizations will be visible, and the server will execute non-overlaid escalations, overlays of escalations, and custom escalations.

See Ignoring-overlay-and-custom-objects-at-runtime.

When you want to use the Subquery algorithm to fetch data from the database, ensure that the value of the Overlay-mode  p arameter is not zero.

 

Peer-listener-port 1

Defines the port number where all the cache instances from different servers communicate with each other.

Default value: 40001

 

Per-Thread-Logging

Flag indicating whether to create per-thread log files.

Values are:

  • T—Create per-thread log files.
  • F—(Default) Do not create per-thread log files.

 

Plugin 2

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.

This parameter is for the running C plugins in the C plugin server.

 

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:

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.

 

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:

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.

 

Plugin-Disable-Remote 2

Flag indicating whether the plug-in server accepts calls from remote servers.

Values are:

  • T—The plug-in server accepts calls only from an AR System server running on the local computer.
  • F—(Default) The plug-in server accepts call from remote servers.

 

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

Plugin-Filter-API-Threads:  <minimumNumberOfThreads> [maximumNumberOfThreads>]

By default, 1 thread is initiated if this option is not specified.

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.

 

Plugin-Log-File

Full path name of the file to use if plug-in logging is on (see Debug-mode).

This parameter is for C plugin server. For more  information on Java plugin logging, see   Setting plug-in server options .

 

Plugin-Log-Level  

Option that specifies the type of information printed to plug-in log files.

Values are:

  • 10000—No information (ARPLUGIN_OFF ).
  • 1000—(Default) Only severe messages (ARPLUGIN_SEVERE ).
  • 900—Severe and warning messages (ARPLUGIN_WARNING ).
  • 800—Status, severe, and warning messages (ARPLUGIN_INFO ).
  • 700—Configuration, status, severe, and warning messages (ARPLUGIN_CONFIG ).
  • 600—Internal exceptions (ARPLUGIN_FINE ).
  • 500—Trace logs that log tasks as they are executed (ARPLUGIN_FINER ).
  • 400—Code-level information (ARPLUGIN_FINEST ).
  • 100—All log information (ARPLUGIN_ALL ).

This parameter is for C plugin server. For more  information on Java plugin logging, see   Setting plug-in server options .

 

Plugin-Loopback-RPC-Socket 

RPC socket number for the private server queue to which loopback plug-in API calls should be directed. Values are in the following ranges:

  • 390621-390634         
  • 390636-390669         
  • 390680-390694         

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.

The  Plugin Loopback RPC Program Number field on the Ports and Queues tab of the AR System Administration: Server Information form.

Plugin-Password

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.

 

Plugin-Path 2

Search path used to load a plug-in. The path is appended to the current value of LD_LIBRARY_PATH (AIX, Linux, Oracle Solaris), SHLIB_PATH (HPUX), or PATH (WINNT). Multiple paths can be specified for this option; each path is appended in the order it appears in the configuration file. The syntax is:

Plugin-Path:  <pathName> [<delimiter>]\[<pathName>]

Insert no spaces between the delimeter and the path. For example, on UNIX, enter:

Plugin-Path: /usr/ar/bin:/usr/ar/common/xyz

On Windows, enter:

Plugin-Path: C:\Program Files\AR System\arserver;
C:\Program Files\Remedy AR System\common\xyz

This parameter is for C plugin server. For more  information on Java plugin logging, see Setting plug-in server options .

 

Plugin-Port 2

The port number on which the plug-in server waits for incoming requests.

This parameter is for C plugin server. For more  information on Java plugin logging, see Setting plug-in server options .

 

Preference-Server-Option

Option that specifies whether users must use centralized preferences.

Values are:

  • 1—Users can choose to use a preference server if one is available.
  • 2—Users must use the specified preference server.
  • 3—Users must use a preference server, but they cannot use this server as a preference server. If users choose a server that is not a preference server, a warning is returned.

The  Preference Server Option field on the   Advanced tab of the AR System Administration: Server Information form. (See Setting-performance-and-security-options.)

Preload-At-Init-Only  

Flag indicating when preload threads (if configured) are used.

Values are:

  • T—Preload threads are used only during server startup.
  • F—(Default) Preload threads are used whenever the cache is loaded from the database.

For information about how to determine whether to use preload threads, see Configuring-how-AR-System-server-manages-cache.

The  Preload Tables At Init Only field on the   Advanced tab of the AR System Administration: Server Information form. (See Setting-performance-and-security-options.)

Private-RPC-Socket

RPC program number that determines the type of queue to which requests are routed and the number of threads running on that queue.

The  Server Queue field on the Ports and Queues tab of the AR System Administration: Server Information form. (See Setting ports and RPC numbers.)

Private-RPC-Socket (for debug queue)

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.

 

RE-Log-File-Location 2

Location of the Reconciliation Engine log file.

For more information on modifying the reconciliation engine system parameters, see Reconciliation Engine configuration settings.

 

Reconciliation-Engine-Suspended

In a server group environment, the AR System server automatically sets the value of this parameter. The parameter value is based on the corresponding operational rankings and ownership.

Values are:

  • T—Indicates that the Reconciliation Engine operation is not currently owned by the local AR System server and the server does not process Reconciliation requests.
  • F—Indicates that the Reconciliation Engine is currently owned by the local AR System server and the server processes Reconciliation requests.

Warning: If you change this setting manually, the AR System server may overwrite the manual setting.

 

Record-Object-Relationships  

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.

Values are:

  • T—The server creates entries in a database table to track the relationships between many types of workflow objects. When you set this option to T, the server records the relationships of all server objects before it accepts connections from clients. Therefore, the first time you set the value to T, you cannot connect to the server by using any client temporarily. The more the number of objects defined on the server, the more time it takes to connect to the server. With a large number of objects, such as with an BMC Helix ITSM application installed, and depending on the performance of the database, this could take up to an hour. When you can reconnect to the server, the recording of object relationship data is complete.
  • F—(Default) The server does not record relationships. When you set this option to F or clear it, all the recorded relationships are deleted from the database.

BMC recommends that you set this option by using the Record Object Relationships option on the Configuration tab of the AR System Administration: Server Information form instead of setting it manually in the configuration file. (See  Viewing-related-objects .)

The  Record Object Relationships field on the Configuration tab of the AR System Administration: Server Information form. (See Setting-administrative-options.)

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.

  • 1—Form
  • 2—Field
  • 3—Menu
  • 4—Filter
  • 5—Import
  • 6—Active link
  • 7—Escalation
  • 8—View
  • 9—Container
  • 10—User
  • 11—Group
  • 12—Server setting
  • 14—Archive
  • 15—Server group actions

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.

 

Register-With-Portmapper

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. Values are

  • T—(Default) Register with portmapper.
  • F—Do not register with portmapper.

No more than one server should try to register with AR System Portmapper in an environment with multiple servers on one computer.

The  Register with Portmapper field on the Configuration tab of the AR System Administration: Server Information form. (See Setting ports and RPC numbers.)

Registry-Admin-Password

Password of the BMC Atrium Web Services Registry admin user. Used by workflow for the AR System Web Services Registry form.

 

Registry-Admin-User

User name of the BMC Atrium Web Services Registry admin user. Used by workflow for the AR System Web Services Registry form.

 

Registry-Location

URL of the BMC Atrium Web Services Registry. Used by workflow for the AR System Web Services Registry form.

 

Rejected-By-Others-Interval 1

Specifies the interval in months or days for which a user wants to see all the requests rejected by others.

 

Remedy-App-Service-Password

Encrypted password that AR System application services such as Approval Server use to access the AR System server.

The  Application Service Password field on the Connection Settings tab of the AR System Administration: Server Information form. (See Specifying-passwords-and-properties-for-connecting-services-to-the-server.)

Required-Field-Identifier

Character to add to the label of a field whose entry mode is Required. The default is an asterisk.

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

Position to add the character that identifies a Required field.

Values are:

  • 0—Add the character to the beginning of the field label.
  • 1—(Default) Add the character to the end of the field label.

The  Required Field Identifier field on the Configuration tab of the AR System Administration: Server Information form. (See Setting-administrative-options.)

Restrict-Log-Client-Type

A list of semicolon-separated client types (or IDs if the client type is not known). Restricts logging only for specified client types.

For example:

Mid-tier;Developer Studio;AR System Administrator

 

Restrict-Log-RPC-Queue

Restrictions are applied to the API, SQL, and Filter logs only for specified RPC Queues.
For example:

390600;390680;390620

 

Restrict-Log-Users

A list of semicolon-separated user names (for example, Allen;Mike). Restricts the logging only for specified users.

 

 

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:

  • Users— 1
  • Client Type—2
  • RPC Queues—8

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).

Default value: 0.

The Restrict-Logging parameter has an additional reserved value of 4.

 

RPC-Non-Blocking-IO 2

Flag that enables AR System on compliant systems to receive remote procedure calls in a nonblocking mode. The mode prevents:

  • Remote attackers from disabling RPC services.
  • Invalid or corrupt packets from temporarily disabling the arserverd process.

Values are:

  • T—Run in RPC nonblocking mode. The system can process multiple headers at the same time.
  • F—(Default) The server must receive an entire RPC header before processing a different one.

To make value changes take effect, restart your AR System server. Windows and Linux operating systems do not support this feature.

 

Run-Process-Command-WhiteList

Lists the commands that are allowed to be executed by workflows that use Run Process actions. Multiple commands are separated by the pipe (|) character. In cloud deployments, only SaaS admins can change the values of this option.

Example:
PERFORM-ACTION-SET-AUTOCOMPLETE-KEYSTROKE|PERFORM-ACTION-TABLE-ADD-ROW|PERFORM-ACTION-TABLE-CLEAR

 

Run-Process-Environment-Variable-WhiteList

Lists the environment variables that are available to a process started by workflows that use Run Process actions. Multiple variables are separated by the pipe (|) character.  In cloud deployments, only SaaS admins can change the values of this option.

Example:
ARDATE|ARDATEONLY|ARCONFIGDIR

 

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.

 

 

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