ar.cfg or ar.conf options A-B
Entries in this file contain the following fields separated by a space or tab:
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 when an option is set to the default value or when the option is not in the file.
Lines with a pound sign (#) in column 1 are treated as comments and ignored.
The following table lists the options that begin with the letters A and B in 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.
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)
Option | Description | Maps 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:
| 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
| The Administrator-Only Mode field on the Configuration tab of the AR System Administration: Server Information form. (See Setting-administrative-options.) |
Allow-Backquote-In-Process-String | Option 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). |
|
Allow-Guest-Users | Flag indicating whether the AR System server accepts guest users (users not registered with AR System in a User form). Values are
| 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 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
| The Allow Unqualified Searches field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
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. Values are:
| The Enable Console Display and Enable Exception Logging fields on Server Statistics tab of the AR System Administration: Server Information form. (See Enabling-and-viewing-statistics-about-long-running-SQL-and-API-calls.) |
API-SQL-Stats-Max-Saved-Long-Operations | Maximum number of longest API and SQL operations saved in memory. The default is 20 of each type. The highest value allowed is 100. |
|
API-SQL-Stats-Flush-To-DB-Interval | Time, 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. |
|
API-SQL-Stats-Minimum-Elapsed-Time | Minimum elapsed time an operation must have to qualify for recording. The default is 5000 milliseconds (or 5 seconds). |
|
Approval-Defn-Check-Interval2 | Interval (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:
Default value: Normal | The Logging Settings area on the Basic tab of the AP:Admin-ServerSettings form. (See Configuring-server-settings-for-Approval-Server-logging-and-loopback-calls.) |
Approval-Due-Soon1 | Specifies the Due-Soon Interval in hours or days for the approval requests that are displayed when an approver logs in to Approval Central. |
|
Approval-Log-File2 | Full path of the Approval Server log file. |
|
Approval-Notify2 | Flag 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-Interval | Interval 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). If the interval value is not specified, the default value (1800 seconds or 30 minutes) is considered. |
|
Approval-Recent-History1 | Specifies the Recent History Interval in hours or days for the approval requests that are displayed in the My Approval History section of Approval Central for an approver. |
|
Approval-RPC-Socket2 | RPC Program Number that Approval Server uses when contacting AR System. This enables you to specify a private AR System server for Approval Server. |
|
Approval-Server-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. Valid values:
Warning: If you change this setting manually, the AR System server may overwrite the manual setting. |
|
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 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):
|
|
AR-Max-Attach-Size2 | 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 AR System installation directory for these files. The path in this option is used only when ARDBC-LDAP-UsingSSL is set toT. | The Certificate Database field on the ARDBC LDAP Configuration form. (See Configuring-the-ARDBC-LDAP-plug-in.) |
ARDBC-LDAP-Cert-Name2 | Not yet implemented. |
|
ARDBC-LDAP-Chase-Referrals2 | Flag that enables automatic referral chasing by LDAP clients. Values are:
This option is for Microsoft Active Directories only. |
|
ARDBC-LDAP-Connect-Timeout2 | Number 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-Timeout2 | Number 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-Values2 | Obsolete 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-DB2 | Not yet implemented. |
|
ARDBC-LDAP-Key-Password2 | Not yet implemented. |
|
ARDBC-LDAP-Page-Size2 | Page 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-Format2 | Format of LDAP date and time data. Values are:
This historical format does not indicate the century. It is not recommended. |
|
ARDBC-LDAP-Use-Cache2 | Flag 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 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-Referral2 | Flag that specifies whether referral chasing is performed by the AD server or the AREA LDAP plug-in. Values are:
This option is for Microsoft Active Directories only. To force referral chasing logic to be disabled, you must also specify the AREA-LDAP-Disable-Referral option. | 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-Referral2 | Flag that disables all referral processes by the AREALDAP plug-in. Values are:
|
|
AREA-LDAP-Email2 | Name of the attribute that specifies the email address of the user. This attribute corresponds to the Email Address field in the AR System User form. If the attribute is not specified, the specified default or a system default is applied. |
|
AREA-LDAP-Email-Default2 | Value 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:
The backslash (\) is required. | 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-Default2 | Default 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:
The backslash (\) is required. | 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-Lic2 | Name of the attribute that identifies the type of write license issued. This attribute corresponds to the License Type field in the AR System User form. If the attribute is not specified, the specified default or a system default is applied. |
|
AREA-LDAP-Lic-Default2 | Value 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-LicApp2 | Name 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-Default2 | Value 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
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-Default2 | Value 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-LicRes12 | Name 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-Default2 | Value 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-Meth2 | Name 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-Default2 | Value 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-OPTION2 | Flag 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:
The backslash (\) is required. | 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:
The backslash (\) is required. | 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-List2 | List 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-Path2 | Obsolete as of version 7.5.00. |
|
ARF-Java-VM-Options2 | Java command options for a virtual machine (VM). The options are documented in the online AR System Java API documentation. |
|
ASJ-Thread-Count | Specifies the total number of worker threads that process various approval requests. The minimum value is 1. The maximum value is 4. The default value is 4. If the specified value is not within the maximum and minimum value, the default value is applied. If a value is not specified, this option is set to the default value. |
|
Assignment-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:
Warning: If you change this setting manually, the AR System server may overwrite the manual setting. |
|
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. 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, iIf 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 are allowed for field ID 90104 on the AR System Publish Report form, even if PDF attachments are disallowed globally. A 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 in the Attachment exception list field as follows: AR System Publish Report (90104), AR System Resource Definitions (41103) For more information, see Restricting-users-from-uploading-and-viewing-files-with-specific-extensions. |
|
Attachment-Ext-Filter | Specifies the type of attachment criteria, which restricts users from uploading and viewing files with certain extensions in Mid Tier. Valid values:
| The Attachment criteria field on Attachment Security tab on the AR System Administration: Server Information form. |
Attachment-Ext-List | List of file extensions that allows or restricts as per the type of Attachment criteria the AR System users to upload and view files in 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. |
Attachment-System-Exception-List1 | Defines the attachments that cannot be attached in an entry operation. There is no difference between the Attachment-Exception-List parameter and the Attachment-System-Exception-List parameter at runtime. If a field on a form is defined under any of these parameters, it is skipped from validation. However, the only difference is that BMC adds an out-of-the-box list of fields on forms under the Attachment-System-Exception-List parameter and can overwrite this any time during the upgrade. The Attachment-Exception-List parameter is to be used by the customers and the installer does not modify it. |
|
Authentication-Chaining-Mode | Mode that enables the administrator to use more than one type of authentication on the same system. Values are:
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. The default value is set to 1. | |
Auth-Token-Signature-Salt1 | Defines the encryption key to be used for authentication token. Usually not to be changed unless invalid tokens are being received. |
|
ARSYS.ARF.ATSSOCONFIRMPWD | Name of a plugin used by the AR System to confirm the user password information from the BMC Atrium Single Sign-On server. |
|
Business-Rules-Engine-Suspended | In a server group environment, the AR System 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 Business Rule Engine operation is not currently owned by the local AR System and the server does not process Business Rules requests. F—Indicates that the Business Rule Engine operation is currently owned by the local AR System and the server processes Business Rules requests. Warning: If you change this setting manually, the AR System may overwrite the manual setting. |
|
1. Options you can view (but not set) using the AR System Administration: Server Information form. |