This documentation applies to the 8.1 version of Remedy Action Request System, which is in "End of Version Support."

To view the latest version, select the version from the Product version menu.

ar.cfg or ar.conf options N-R

This section of the table includes the options for the ar.cfg (ar.conf) file that begin with the letters N through 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 Plugin parameters, type Plugin 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 Advanced in the description, type Advanced in the Description text box.

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

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

Note: 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 BMC Remedy 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-PathBase 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-Preload-Schema-Segments 

Total number of preload segments loaded by the preload threads when preload threads are configured.
(See Setting the Preload Tables Configuration option.)

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 Setting the Preload Tables Configuration option.)

The Number of Preload Threads field on the Advanced tab of the AR System Administration:
Server Information form. (See Setting performance and security options.)
Oracle-Bulk-Fetch-Count 2Number 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 BMC Remedy AR System database SID is ARS). Values are

  • FORCE — Use this value if the initARS.ora file includes the following line:
    CURSOR_SHARING=FORCE
    .
  • SIMILAR — Use this value if your Oracle database is set for SIMILAR.
  • EXACT — Use this value if your Oracle database is set to perform case insensitive search
    (by setting the value of Db-Case-Insensitive to T, in the ar.cfg (ar.conf) file).
    For more information, see Db-Case-Insensitive.
 
Oracle-Dblink-Character-Set2

Option that enables BMC Remedy 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 Security administration.

 
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. 
Oracle-Two-Task 1(Oracle databases only) Two-task environment setting for the underlying database. 
Overlay-mode2

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

 
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  2File 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.
 
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

Plugin-ARDBC-Threads: <minimumNumberOfThreads> 
[<maximumNumberOfThreads>]

 

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

 
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

Plugin-AREA-Threads: <minimumNumberOfThreads> 
[<maximumNumberOfThreads>]

 

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

 
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 BMC Remedy 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 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

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

 

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

 
Plugin-Log-FileFull path name of the file to use if plug-in logging is on (See Debug-mode). 
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 ).
 
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 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.

The Plugin Loopback RPC Program Number field on the Ports and Queues tab of the AR System Administration: Server Information form.
Plugin-PasswordPlug-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.
 
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: UNIX

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

 

Windows

Plugin-Path: C:\Program Files\AR System\arserver;
C:\Program Files\BMC Remedy AR System\common\xyz
 
Plugin-Port  2The port number on which the plug-in server waits for incoming requests. 
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 Setting the Preload Tables Configuration option.

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
BMC Remedy AR System Workflow Debugger. To make any private queue a debug queue,
use this syntax:Private-RPC-Socket: rpcNumberDebug 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 Configuring Reconciliation Engine system parameters.

 
Read-Only-Tran-Off 2

Option that causes BMC Remedy AR System not to create database transactions when only reading data.

The default value is (T) true.

This setting is applicable for SQL Server and Sybase databases only.

 
Record-Object-Relationships 

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 s
etting 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 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 client 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.

  • F — (Default) The server does not record relationships.

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

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 Understanding the Server Events form.

 
Register-With-Portmapper

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. 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-PasswordPassword of the BMC Atrium Web Services Registry admin user.
Used by workflow for the BMC Remedy AR System Web Services Registry form.
 
Registry-Admin-UserUser name of the BMC Atrium Web Services Registry admin user.
Used by workflow for the BMC Remedy AR System Web Services Registry form.
 
Registry-LocationURL of the BMC Atrium Web Services Registry. Used by workflow for the
BMC Remedy AR System Web Services Registry form.
 
Remedy-App-Service-Password

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

The Application Service Password field on the Connection Settings tab of the AR System Administration: Server Information form. (See Setting server passwords, RPC options, and plug-in timeouts.)
Remote-Workflow-Password

Password that another BMC Remedy AR System server uses to access a BMC Remedy AR System server through workflow. If you change this password, you must also change the appropriate remote workflow target password on any server containing workflow that connects to this server.

See Setting server passwords, RPC options, and plug-in timeouts.
Remote-Workflow-Target-PasswordPassword to use when the BMC Remedy AR System server accesses the specified remote server through workflow. This occurs when an active link contains an SQL or Process command against the remote server and is activated by a non administrator user. If the remote server specifies a workflow password, you must register that server and password, or you cannot access that server through workflow.See Setting server passwords, RPC options, and plug-in timeouts.
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.)
RPC-Non-Blocking-IO 2

Flag that enables BMC Remedy 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. Important:
To enable your system to use this feature, you must install the following patches.
If these patches are not installed, you see an error message or most of your RPC calls are blocked.

HP

  • PHNE_29210 - HPUX 11.0 or later
  • PHNE_29211 - HPUX 11i or later

Solaris

  • 108993-38 - Solaris 8 or later
  • 113319-19 - Solaris 9 or later

IBM Does not specify a patch number. Multiple file sets might be required.
(If you do not obtain an IBM® patch, your server might crash.)

  • Fix for Authorized Problem Analysis Report (APAR) IY61602 - AIX 5.3 or later
  • Fix for APAR IY61409 - AIX 5.2 or later
  • Fix for APAR IY61598 - AIX 5.1 or later
  • Fix for APAR IY71557 - AIX 5.2 or later
  • Fix for APAR IY71632 - AIX 5.3 or later
 
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.

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments

  1. Lj Longwing

    I was searching the docs for 'Oracle-Two-Task' setting and could not find it, could not find it, I then decided to look for ar.conf, and go to the page that contains 'o'...and found it, but I couldn't 'search' for it because it's

    Oracle-Two-

    Task

    on two separate lines.  I think something needs to be fixed in the search engine to allow for this sort of thing to be found

    May 29, 2014 09:14
    1. Bhakti Paranjpe

      Hi Lj,

      Thank you for your comment. We are looking into this issue and will get back to you as soon as possible.

      Thanks,

      Bhakti

       

       

       

      May 30, 2014 05:44
    1. Bhakti Paranjpe

      Hi Lj,

      We investigated the issue and verified that the phrase ‘Oracle-Two-Task’ is on one line without any hard enter between the words. When trying to search for some other phrases, at times, inconsistent results are displayed across users and spaces. This issue seems to be related to how the search engine retrieves the result. We are working towards improving the search experience. Thanks for your patience.

      Regards,
      Bhakti

      Jun 17, 2014 01:25
  2. Thomas Miskiewicz

    I'm missing the description of the Remote-Workflow-Password and Remote-Workflow-Target-Password.

    Mar 22, 2016 09:55
    1. Poonam Morti

      Hi Thomas,

      I have updated the topic with the parameters.

      Thanks,

      Poonam

      Mar 30, 2016 02:32
      1. Thomas Miskiewicz

        Thank you, good job! BTW, where in the documentation can I find more information about the Remote Workflow thing?

        Mar 30, 2016 03:30