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 A-B

Entries in this file contain the following fields separated by a space or tab:

<parameter>: <value>

Each parameter represents a particular configuration option. The available configuration options and their settings are described in the following table. Lines that do not begin with one of these options are ignored.

The associated value represents the current setting for the option. All numeric values are in a base 10 system.

Default behavior occurs either when an option is set to the default value or when the option is not in the file.

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.

Lines with a pound sign (# ) in column 1 are treated as comments and ignored.

The following tables lists the options available for the ar.cfg (ar.conf) file. Unless otherwise denoted by the table's footnotes, you can also set these options in the AR System Administration: Server Information form.

This section of the table includes the options for the ar.cfg (ar.conf) file that begin with the letters A and B.

Note

All options in this file can be manually modified. Entries are case- and space-sensitive, so be careful when editing this file.

ar.cfg (ar.conf) file options (A-B)

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 Active-Link-Shell 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 API parameters, type API 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 Guest Users in the description, type Guest Users 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
Active-Link-Dir

Directory in which active link server run processes are stored.
Only commands in the specified directory can be run.
This is a security feature that ensures clients or API programs use only a safe set of server processes.

The Security area on the Advanced tab
of the AR System Administration:
Server Information form.
(See Setting performance and security options.)
Active-Link-Shell

(UNIX only) Parent shell of any active link server process.
This parameter causes the server to start the shell with the specified process as a parameter.
This is a security feature. The specified shell might be a security shell that verifies a path
or runs with a user ID other than the one the server uses. For example,
if the server runs as root and an administrator specifies a shell that runs as a lower user privilege,
an active link invokes the shell that runs as a user instead of as root.
Because the AR System server passes the shell command to the Active-Link-Shell
as a single string without any other command-line arguments, the command parameters
can often get interpreted incorrectly. The AR System server does not know which custom
shell is supposed to be used for active link processing, so it does not know how to supply
all of the necessary arguments. In order to avoid this and use the Active-Link-Shell Feature correctly,
follow the steps listed below:

  1. Determine what your desired shell is, and how to invoke it passing a single command line.
    If the desired shell is /bin/csh, the correct way to invoke with a single command line is

    "/bin/csh" "-c" "process command"
  2. Write a /bin/sh script that invokes your custom shell in the required manner,
    as shown below:

    #!/bin/sh
    # Usage:
    #    /path/to/arsystem-csh-helper process-command
    # Pass process-command as a command line to /bin/csh.
    #
    # use "$*" preserve argument as a single string
    exec /bin/csh -c "$*"
  3. Put the script in a location where the AR System server will be able to call it.
    For example, local utilities are often installed in a directory named
    /usr/local or /usr/local/bin.
    Another good location might be the AR System server installation directory.
    Be sure to mark the new program executable:

    # cp arsystem-csh-helper /usr/local/arsystem-csh-helper
    # chmod 755 /usr/local/arsystem-csh-helper
  4. In the AR System server configuration, change the Active-Link-Shell to be the
    new program /usr/local/arsystem-csh-helper
The Security area on the Advanced tab
of the AR System Administration:
Server Information form.
(See Setting performance and security options.)
Admin-Only-Mode

Flag indicating whether only administrators and subadministrators can access the server.
Values are

  • T — Admin-only mode is on.
  • F — (Default) Admin-only mode is off.

The Administrator-Only Mode field on the
Configuration tab of the AR System Administration:
Server Information form.
(See Setting administrative options.)

AE-Poll-Interval 2Interval (in minutes) at which the Assignment Engine polls the
BMC Remedy AR System server. If this option is not specified,
the polls occur every 5 minutes.
 
AE-Worker-ThreadIndicates the total number of worker threads that process various assignment requests.
(See Configuring the Assignment Engine).
 

Alert-Ignore-Actual-Client-IP 2

 

Flag indicating how the server connects to alert clients registered with the

server.

Values are

  • T — The server uses the IP address that the client indicated when it
    registered with the server.
  • F — (Default) The server uses the IP address from which the

registration call came, which might be different in an environment with

a load balancer or firewall.

Environments in which alert clients connect to the server through a load

balancer must set this option to T to prevent the server from using the load

balancer IP address to connect to alert clients.

See Considerations for configuring load balancers with AR System servers and Load balancer configuration examples.
Allow-Backquote-In-Process-StringOption that enables the server to run a process with a backquote in the process name
or in its arguments. Values are T and F (default). For more information, see ARGetServerInfo.
 
Allow-Guest-Users

Flag indicating whether the BMC Remedy AR System server accepts guest users
(users not registered with BMC Remedy AR System in a User form). Values are

  • T — (Default) Allow guest users. Unregistered users have no permissions
    but can perform some basic operations. For example, they can submit requests
    to forms to which the Public group has access and whose fields
    allow any user to submit values.
  • F — Do not allow guest users. Unregistered users have no access to the system.
The Allow Guest Users field on the
Configuration tab of the AR System Administration:
Server Information form.
(See Setting administrative options.)
Allow-Unqual-Queries

Flag indicating whether unqualified searches can be performed on the
BMC Remedy AR System server. Unqualified searches are 
ARGetListEntry
 or ARGetListEntryWithFields calls in which the qualifier parameter
is NULL or has an operation value of 0 (AR_COND_OP_NONE ).
Such searches can cause performance problems because they return all requests for a form.
This is especially problematic for large forms. Values are

  • T — (Default) Allow unqualified searches.
  • F — Do not allow unqualified searches.
The Allow Unqualified Searches field on the
 Configuration tab of the AR System Administration:
Server Information form.
(See Setting administrative options.)
Alternate-Approval-Reg 2

Flag indicating how applications such as Approval Server or Reconciliation Engine
listen for the BMC Remedy AR System server's signal. Values are

  • T — (default) Listen for the application dispatcher to signal.
    If your application relies on the application dispatcher, set this option to T.
    To verify that arsvcdsp is configured to start with the BMC Remedy AR System server,
    check the armonitor.cfg (armonitor.conf) file.
  • F — Listen for the server's signal directly.
 
API-Log-File

Full path name of the file to use if API logging is on (See Debug-mode).

The API Log field on the Log Files tab
of the AR System Administration:
Server Information form.
(See Setting log files options.)
API-SQL-Stats-Control

A bit mask value indicating options selected.

  • Bit 1 — Enable Console Display
  • Bit 2 — Enable Exception Logging

For more information, see Setting server statistics options.

This option was added in Service Pack 1 for version 8.1.00.

 
API-SQL-Stats-Max-Saved-Long-OperationsMaximum number of longest API and SQL operations saved in memory.
The default is 20 of each type. The highest value allowed is 100.

This option was added in Service Pack 1 for version 8.1.00.

The Number of Saved Operations field on the Server Statistics tab of the AR system Administration: Server Information form. (See Setting server statistics options.)
API-SQL-Stats-Flush-To-DB-IntervalTime, in minutes, between flushing the longest operations from memory to the forms.
A value of 0 (the default) means that there is no automatic flushing.

This option was added in Service Pack 1 for version 8.1.00.

The Auto Save and Purge Interval (min) field on the Server Statistics tab of the AR system Administration: Server Information form. (See Setting server statistics options.)
API-SQL-Stats-Minimum-Elapsed-TimeMinimum elapsed time an operation must have to qualify for recording.
The default is 5000 milliseconds (or 5 seconds).

This option was added in Service Pack 1 for version 8.1.00.

The Minimum Elapsed Time (mSec) field on the Server Statistics tab of the AR system Administration: Server Information form. (See Setting server statistics options.)
Approval-Defn-Check-Interval 2Interval (in seconds) at which Approval Server checks for changed or
updated data in the data definition forms.
 
Approval-Debug-Type 

Type that specifies the logging level for the approval logs of the Approval server.

Values are

  • NORMAL— Use this value to set the minimum logging level for approval logs.
    Note: When Approval-Debug-Type is set to NORMAL, only severe issues are written to the logs.
  • ALL— Use this value to set the maximum logging level for the approval logs.

Default value: Normal

The Logging Settings area on the Basic tab of the AP:Admin-ServerSettings form. (See Configuring server settings for BMC Remedy Approval Server logging and loopback calls)

 

Approval-Log-File 2Full path of the Approval Server log file. 
Approval-Notify 2Flag indicating whether approval notifications are configured from the
Server Settings dialog box. An Approval-Notify entry exists for each ID.
The syntax is Approval-Notify: ID value Do not change this option in the
ar.cfg (ar.conf) file. Instead, from the AP:Administration form,
click the Server Settings link to open a dialog box with configuration
settings for the Approval Server.
 
Approval-Polling-IntervalInterval at which the Approval Server polls the AR System server for pending work.
This setting is intended as a backup method, not the primary contact method.
Under normal circumstances, the AR System server or the Application Dispatcher
(depending on the configuration) contacts the Approval Server when work is pending.
When this option is specified, the Approval Server polls the AR System server
only if it does not receive a signal from the AR System server in the specified time.
Specify the interval in seconds. Minimum is 30 seconds. Maximum is 3600 seconds (one hour).
 
Approval-RPC-Socket 2RPC Program Number that Approval Server uses when contacting BMC Remedy AR System.
This enables you to specify a private BMC Remedy AR System server for Approval Server.
 
AppSignal logging

Flag indicating whether logging for the appsignal library is enabled or disabled.
By default, logging is disabled. To enable logging, add the following entry
in the ar.cfg (ar.conf) file:AppSignal logging : T

Note: If this entry is missing from the file, the default value (AppSignal logging: F)
is considered.

When you enable logging, the following log files are created in the db directory
(installationDirectory/db for UNIX and installationDirectory\Arserver\db for Windows):

  • For Approval Server: appSignalAPlog.log
  • For Assignment Engine: appSignalAElog.log
  • For Distributed Server Option (DSO): appSignalDSOlog.log
 
AR-Max-Attach-Size 2

Maximum size (in bytes) of compressed attachments that can be sent to the
AR System database from the AR System server. By preventing large attachments
from being sent to the database, you can prevent excessive memory growth
and reduce transmission time. This limit does not apply to attachments retrieved
from the database by the AR System server. This option applies to all databases.

Note: To limit the size of compressed attachments that the server can retrieve from
Oracle databases, use 
Db-Max-Attach-Size.

 
ARDBC-LDAP-Base-DN

Base distinguished name (DN) to use instead of the root DN as the starting point
for discovering vendor tables when you design vendor forms. For example:
ARBDC-LDAP-Base-DN: CN=Users, DC=ldapesslab, DC=com

The Base DN For Discovery field
on the ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
ARDBC-LDAP-Cache-MaxSize

Size limit (in bytes) for the cache. For no size limit, set this to 0.
The default is 32768 bytes.

The Maximum Size field in the 
ARDBC Plugin Cache
 box on the
ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
ARDBC-LDAP-Cache-TTL

Time limit (in seconds) that data remains cached. For no time limit, set this to 0.
The default is 60 seconds.

The Time To Live field in the
 ARDBC Plugin Cache box on the
ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
ARDBC-LDAP-Cert-DB

Directory name of the certificate database. The cert8.db or cert7.db and
key3.db certificate database files are in this directory. If the directory is not specified,
the LDAP plug-in looks in the BMC Remedy AR System installation directory for these files.
The path in this option is used only when ARDBC-LDAP-UsingSSL is set to T.

The Certificate Database field
on the ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
ARDBC-LDAP-Cert-Name 2Not yet implemented. 
ARDBC-LDAP-Chase-Referrals 2

Flag that enables automatic referral chasing by LDAP clients. Values are

  • T — Referrals are chased.
  • F — (Default) Referrals are not chased.

This option is for Microsoft Active Directories only.

 
ARDBC-LDAP-Connect-Timeout 2Number of seconds that the plug-in waits for a response from the
directory service before it fails. The minimum value is 0,
in which case the connection must be immediate.
The maximum value is the External-Authentication-RPC-Timeout setting.
If a value is not specified, this option is set to the value of the 
External-Authentication-RPC-Timeout
 option (by default, 40 seconds).
 
ARDBC-LDAP-DN-Timeout 2Number of seconds that the plug-in retains the base distinguished name (DN)
used to access an LDAP ARDBC vendor form after the user becomes inactive.
The default is 3600 seconds.
 
ARDBC-LDAP-Drop-Large-Values 2Obsolete in version 7.0.00 and later. 
ARDBC-LDAP-Hostname

Host name of the system on which the directory service runs.
If the host name is not specified, the ARDBC LDAP plug-in uses localhost
as the host name.
For example: ARDBC-LDAP-Hostname: server1.eng.remedy.com

The Host Name field on the
ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)

ARDBC-LDAP-Key-DB 2Not yet implemented. 
ARDBC-LDAP-Key-Password 2Not yet implemented. 
ARDBC-LDAP-Page-Size 2Page size in the pagedResultsControl of the ARDBC LDAP plug-in search request.
This specifies the number of entries to return per page from the
external directory server to the client when processing a search request containing
the pagedResultsControl. The maximum value is 100,000. The minimum value is 100.
The default value is 10,000. (See Using the ARDBC LDAP plug-in.)
 
ARDBC-LDAP-Port

Port number on which the directory service listens for clients.

The Port Number field on the
ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
ARDBC-LDAP-Time-Format 2

Format of LDAP date and time data. Values are

  • 0--Generalized Time Format (YYYYMMDDHHMMSSZ )
    This format is recognized by all LDAP servers and is recommended.
  • 1--AD Generalized Time Format (YYYYMMDDHHMMSS.0Z )
    This format is recognized by Microsoft Active Directory servers only.
  • 2--UTC Time Format (YYMMDDHHMMSSZ )

This historical format does not indicate the century. It is not recommended.

 
ARDBC-LDAP-Use-Cache 2Flag that enables caching of search requests. Values are T and F.
After caching is enabled, search requests issued via the ARDBC plug-in are cached.
Subsequent matching search requests are satisfied from the cache.
 
ARDBC-LDAP-User-DN

Distinguished name (DN) of the user account that the ARDBC LDAP plug-in
uses to search and modify the contents of the directory service. For example:
ARDBC-LDAP-User-DN: server1\admin

The Bind User field on the
ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
ARDBC-LDAP-UsingSSL

Flag indicating whether to establish a secure socket layer (SSL)
connection to the directory service. Values are T and F.
If you use LDAP over SSL, you must also specify the file name of the
certificate database used to establish the connection.

The Using Secure Socket Layer field
on the ARDBC LDAP Configuration form.
(See Configuring the ARDBC LDAP plug-in.)
AREA-LDAP-Bind-Password

Password of the user account that the AREA LDAP plug-in uses to find
the user object when using the User Search filter. If the distinguished name (DN)
is not specified, the AREA LDAP plug-in uses an anonymous login to find the user object.
If the target directory service does not allow anonymous access,
you must specify a DN and password; otherwise,
the plug-in cannot determine the DN of the user.

The Bind Password field on the
AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Bind-User

Distinguished name (DN) of the user account that the AREA LDAP plug-in
uses to find the user object when using the User Search filter.
If the DN is not specified, the AREA LDAP plug-in uses an anonymous login
to find the user object. If the target directory service does not allow anonymous access,
you must specify a DN and password; otherwise,
the plug-in cannot determine the DN of the user. For example:
AREA-LDAP-Bind-User: ldapesslab\admin

The Bind User field on the
AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Cert-DB

Directory name of the certificate database. The cert8.db or cert7.db and
key3.db certificate database files are in this directory.
If the directory is not specified, the LDAP plug-in looks in the
BMC Remedy AR System installation directory for these files.
This path is used only when ARDBC-LDAP-UsingSSL is set to T.

The Certificate Database field in the 
Directory Service Information
 area on the
AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Chase-Referral  

Flag that specifies whether referral chasing is performed by the AD server
or the AREA LDAP plug-in. Values are

  • T — Referral chasing is performed by the AD server.
  • F — (Default) Referral chasing is performed by the AREA LDAP plug-in
    (via the third-party LDAP library).

This option is for Microsoft Active Directories only.

Note: To force referral chasing logic to be disabled, you must also specify
the AREA-LDAP-Disable-Referral option. (See ar.cfg or ar.conf options A-B.)

The Chase Referral  field in the Directory Service Information area on the
AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Connect-Timeout 

Number of seconds that the plug-in waits to establish a
connection with the directory service. The minimum value is 0,
in which case the connection must be immediate. The maximum value is the
 External-Authentication-RPC-Timeout setting.
If a value is not specified, this option is set to the value of the
External-Authentication-RPC-Timeout option (by default, 40 seconds).

The Failover Timeout field in the 
Directory Service Information
 area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Disable-Referral  2

Flag that disables all referral processes by the AREALDAP plug-in. Values are

  • T— Referrals are disabled.
    Note: This overrides the AREA-LDAP-Chase-Referral setting.

  • F — (Default) Referrals are not disabled.
    For information about how the referrals are processed,
    see ar.cfg or ar.conf options A-B. The referral option is for
    Microsoft Active Directories only. When connecting to a non-Microsoft Active Directory,
    BMC recommends disabling referral processing.
 
AREA-LDAP-Email 2Name of the attribute that specifies the email address of the user.
This attribute corresponds to the Email Address field in the
BMC Remedy AR System User form. If the attribute is not specified,
the specified default or a system default is applied.
 
AREA-LDAP-Email-Default 2Value that the AREA LDAP plug-in uses if the AREA-LDAP-Email
parameter is not specified or has no value for the user.
 
AREA-LDAP-Group-Base

Base of the LDAP directory to search groups from.
To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$ — User's distinguished name. This applies only to the
    Group Base Name and Group Search Filter. It does not apply to the
    User Base name and User Search filter.
  • $\AUTHSTRING$ — Value that users enter into the
    Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client
    accessing the AR System server.
The Group Base field in the
User and Group Information area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Group-Default 2Default groups to which the user belongs if no group information is
available from the directory service. If the user belongs to multiple groups,
use a semicolon to separate them.
 
AREA-LDAP-Group-Filter 

LDAP search filter used to locate the groups to which the user belongs.
To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$--- User's distinguished name. This only applies to the
    Group Base Name and Group Search Filter.
    It does not apply to the User Base Name and User Search Filter.
  • $\AUTHSTRING$ — Value that users enter into the
    Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client
    accessing the AR System server.
The Group Search Filter field in the
User and Group Information area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Hostname

Host name of the system on which the directory service runs.
If no value is specified, the AREA LDAP plug-in uses localhost as the host name.

The Host Name field in the
Directory Service Information area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-Lic 2Name of the attribute that identifies the type of write license issued.
This attribute corresponds to the License Type field in the
BMC Remedy AR System User form. If the attribute is not specified,
the specified default or a system default is applied.
 
AREA-LDAP-Lic-Default 2Value that the AREA LDAP plug-in uses if the AREA-LDAP-Lic
attribute is not specified or has no value for the user.
 
AREA-LDAP-LicApp 2Name of the attribute that identifies the type of application license issued.
If the attribute is not specified, the specified default or a system default is applied.
 
AREA-LDAP-LicApp-Default 2Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicApp attribute
is not specified or has no value for the user.
 
AREA-LDAP-LicMask 

Attribute that specifies how to mask the license information returned from the
AREA LDAP plug-in. Values are

  • 0--No licenses returned from the AREA LDAP plug-in are used.
  • 1--Write license from the plug-in is used.
  • 4--Reserved license from the plug-in is used.
  • 5--Reserved license and Write license from the plug-in are used.
  • 8--Application license from the plug-in is used.
  • 9--Application and Write licenses from the plug-in are used.
  • 12--Application and Reserved licenses from the plug-in are used.
  • 13--All licenses from the plug-in are used.

If the license is not used from the plug-in, the license information
in the user's User entry is used.

The License Mask field in the
 Defaults and Mapping Attributes
to User Information
 area on the
AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-LicMask-Default 2Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicMask
attribute is not specified or has no value for the user.
 
AREA-LDAP-LicRes1 2Name of the attribute that specifies the type of reserved license issued.
If the attribute is not specified, the specified default or a system default is applied.
 
AREA-LDAP-LicRes1-Default 2Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicRes1
attribute is not specified or has no value for the user.
 
AREA-LDAP-Notify-Meth 2Name of the attribute that specifies the default notification mechanism for the user.
This attribute corresponds to the Default Notification Mechanism field in the
AR System User form. If the attribute is not specified, the specified default
or a system default is applied.
 
AREA-LDAP-Notify-Meth-Default 2Value that the AREA LDAP plug-in uses if the AREA-LDAP-Notify-Meth
attribute is not specified or has no value for the user.
 
AREA-LDAP-Port

Port number on which the directory service listens for clients.

The Port Number field in the
Directory Service Information area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-SSL-AUTH-OPTION 2Flag indicating how the secure connection is established. By default, 
AREA-LDAP-SSL-AUTH-OPTION
 is set to true and will continue to
authenticate the server certificate when opening the secure connection.
If you set AREA-LDAP-SSL-AUTH-OPTION to false,
the server certificate is not authenticated and multiple secure server
connections can be established concurrently.
 
AREA-LDAP-Use-Groups

Flag indicating whether to retrieve group information from the LDAP server.
If this parameter is not set, group information from the AR System Group form is used.

The Group Membership field in the
 User and Group Information area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-User-Base

User base in the LDAP directory to search for the user.
To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$ — User's distinguished name. This only applies to the
    Group Base Name and Group Search Filter.
    It does not apply to the User Base Name and User Search Filter.
  • $\AUTHSTRING$ — Value that users enter into the
    Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client
    accessing the AR System server.
The User Base field in the User and Group
Information
 area on the
AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-User-Filter

LDAP search filter used to locate the user in the directory from the
base that the AREA-LDAP-User-Base option specifies.
To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$ — User's distinguished name. This only applies to the
    Group Base Name and Group Search Filter.
    It does not apply to the User Base Name and User Search Filter.
  • $\AUTHSTRING$ — Value that users enter into the
    Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client
    accessing the AR System server.
The User Search Filter field in the
User and Group Information area
on the AREA LDAP Configuration form.
(See Configuring the AREA LDAP plug-in.)
AREA-LDAP-UseSSL

Flag indicating whether to establish a secure socket layer (SSL)
connection to the directory service. Values are T and F.
If you use LDAP over SSL, you must also specify the file name
of the certificate database used to establish the connection.

The Use Secure Socket Layer? field
in the Directory Service Information area
on the AREA LDAP Configuration form. (See Configuring the AREA LDAP plug-in.)
Arerror-Exception-List 2List of errors that trigger a dump of the current stack in the arerror.log file.
Separate each error number with a semicolon (for example, 123;345;).
 
ARF-Java-Class-Path 2
Obsolete as of release 7.5.00.
 
ARF-Java-VM-Options 2Java command options for a virtual machine (VM).
The options are documented in the online AR System Java API documentation.
 
Arfork-Log-FileFull path name of the file to use if arforkd logging is on
(See Debug-mode). This file is not subject to the maximum file size
specified in the Max-Log-File-Size option.
 
ARSYS.ARF.ATSSOCONFIRMPWDName of a plugin used by the BMC Remedy AR System server
to confirm the user password information from the BMC Atrium Single Sign-On server.
 
ASJ-Thread-Count

Specifies the total number of worker threads that process various approval requests.

 
Attachment-Exception-List

Parameter which allows you to override the Attachment Security functionality implemented in the AR System Administration: Server Information form. To override the attachment restrictions, you can specify the Form name with Field ID and upload attachments only for that field ID.

Note: Field ID is the numeric value of the field that contains an attachment on the form. You can get the value for a Field ID from the Developer Studio.

For example,

If attachments of the type PDF have been disabled in the AR System Administration: Server Information > Attachment Security > Attachment criteria, it should still be possible for PDF based reports to be scheduled and published. To solve such a problem, in the AR System Administration: Server Information > Attachment Security > Attachment exception list, enter form name and field ID combination, such as AR System Publish Report(90104), to override the attachment security setting. The PDF attachments will now be allowed for field ID 90104 on the AR System Publish Report form, even if PDF attachments are disallowed globally. Similar entry can be made for other forms like the AR System Resource Definitions form, and for the field ID 41103 as AR System Resource Definitions(41103).

For multiple form and field ID entries, enter a comma separated list like AR System Publish Report (90104), AR System Resource Definitions(41103) in the Attachment exception list field.

For more information, see Setting security restrictions on file uploads

 
Attachment-Ext-Filter Parameter which specifies the type of Attachment criteria which restricts users from uploading and viewing files with certain extensions in BMC Remedy Mid Tier. Values are

0 -- Allow all attachments

1 -- Allow attachments with following extensions

2 -- Disallow attachments with following extensions 

Default value: 0 (Allow all attachments)

The Attachment criteria field on Attachment Security tab on the AR System Administration: Server Information form. (See Setting security restrictions on file uploads.)

Attachment-Ext-List 

List of file extensions that allows or restricts (as per the type of Attachment criteria)the BMC Remedy AR System users to upload and view files in BMC Remedy Mid Tier. The file extensions are separated using commas.

For example:

Attachment-Ext-Filter: 1 (Allow attachments with following extensions)

Attachment-Ext-List: pdf, doc, txt

Users can only upload files having pdf, doc and txt extensions.

 
The Comma separated list of limit extensions field on Attachment Security tab on the AR System Administration: Server Information form. (See Setting security restrictions on file uploads.)
Authentication-Chaining-Mode

Mode that enables the administrator to use more than one type
of authentication on the same system. Values are

  • 0 (Off) — Use the default behavior. Users are authenticated based
    on the settings of Crossref-Blank-Password and Authenticate-Unregistered Users.
  • 1 (ARS - AREA) — Use internal authentication as the primary method;
    use external authentication via the AREA plug-in as the secondary method.
  • 2 (AREA - ARS) — Use external authentication via the AREA plug-in
    as the primary method; use internal authentication as the secondary method.
  • 3 (ARS - OS- AREA) — If authentication fails in AR System
    (internal authentication), use the operating system authentication
    (for example, NT domain authentication).
    If the operating system fails, try external authentication (AREA).
  • 4 (ARS - AREA - OS) — If authentication fails in AR System,
    try AREA. If AREA fails, try the operating system authentication.

Values 3 and 4 provide greater flexibility. For example,
your external users might be authenticated with an AREA plug-in,
and internal users might be authenticated by the NT domain.

See  Specifying authentication chaining mode.
BR-RPC-Socket

Single threaded.

Note: For single threaded plug-ins, set the number of queue threads to be a maximum of 2. This makes sure that if one thread takes too long and times out, the plugin can connect back in on the second available thread.

 
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. Piotr Sadowski

    Hi, could you add more information about new option API-SQL-Stats-Control (available bit mask values) and related options API-SQL-Stats-* added in SP1 for 8.1.00? Link to related article about SQL and API statistics would be helpful.

    Thanks!

    Jan 03, 2015 06:25
    1. Prachi Kalyani

      Hello,

      Thank you for your comment. I will verify this with the concerned SME and update the topic.

      Thanks,

      Prachi

      Jan 07, 2015 02:43
    1. Prachi Kalyani

      Hello Piotr,

      I have updated the documentation.

      Hope that helps!

      Thanks,

      Prachi

      Mar 05, 2015 12:33
  2. Ivan Pirishanchin

    Could we get some information on the "Approval-Debug-Type" setting? Thank you!

    Jun 19, 2015 10:50
    1. Poonam Morti

      Hi Ivan,

      I will consult this with the SME and get back to you.

      Thanks,

      Poonam

      Jun 22, 2015 05:07
    1. Poonam Morti

      Hi Ivan,

      I have updated the topic with the Approval-Debug-Type setting.

      Thanks,

      Poonam

      Jun 23, 2015 01:39
  3. Thomas Miskiewicz

    What is the Application-Enable option? I can't find the description of it.

    Mar 22, 2016 10:23
    1. Poonam Morti

      Hi Thomas,

      Will you please give us more details on which application enable option you are looking for.

      Thanks,

      Poonam

       

      Apr 07, 2016 01:44
  4. Oludare Ogunmadewa

    Hi,

    We see different behaviors for Authentication-Chaining-Mode:

    When either of options 1-2 is selected, which of Crossref-Blank-Password and Authenticate-Unregistered Users must I check so Active Directory users not in CTM:User form can connect to Remedy?

    If either of options 1-2 is selected, what is/are the impact of Crossref-Blank-Password and Authenticate-Unregistered Users?

    Can you make these statements more clearer?

    Authentication-Chaining-Mode:
    If the value is not 0, the settings of the Crossref-Blank-Password and Authenticate-Unregistered Users parameters are ignored.

    If the value is not 0 and the Crossref-Blank-Password parameter is enabled, users who have a blank password in the User form must provide a valid password (that is, a non-NULL password) during login.

    Apr 04, 2016 02:03
    1. Poonam Morti

      Hi Oludare,

      If you are unable to resolve the issue, please contact BMC Customer Support to log a formal ticket on this issue. To contact customer support click here.

       Thanks,

      Poonam

      Apr 13, 2016 11:27
  5. Oludare Ogunmadewa

    Unregistered users not in CTM:User form can logon to Remedy when valid Remedy "Group Mapping" are added to EA tab regardless if Crossref-Blank-Password and Authenticate-Unregistered Users is/are checked.  That is a violation of the guide/document statements below:

    If the value is not 0, the settings of the Crossref-Blank-Password and Authenticate-Unregistered Users parameters are ignored.

    If the value is not 0 and the Crossref-Blank-Password parameter is enabled, users who have a blank password in the User form must provide a valid password (that is, a non-NULL password) during login.

    Apr 04, 2016 04:09
    1. Poonam Morti

      Hi,

      I will verify this with the SME and get back to you soon.

      Thanks,

      Poonam

      Apr 05, 2016 12:20
    1. Poonam Morti

      Hi Oludare,

      Thanks for bringing this to our notice. I have verified this with the SME, to set the authentication chaining mode, we need to Authenticate Unregistered Users, Cross Reference Blank Password, or both. I have removed the statements from the topic.

      For more information, see Specifying authentication chaining mode.

      Thanks,

      Poonam

       

      Apr 06, 2016 02:37