ar.cfg or ar.conf options E-M
This section of the table includes the options for the ar.cfg (ar.conf) file that begin with the letters E through M.
ar.cfg (ar.conf) file options (E-M)
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 Escalation-Log-File 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 Email parameters, type Email 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 Security in the description, type Security in the Description text box.
Option | Description | Maps to |
---|---|---|
Email-Notify-From 2 | Sender name to use for filter-generated email notifications in which no subject is specified. The value is limited to 29 characters. | |
Email-Timeout2 | Obsolete in version 5.1.0 and later. | |
Enable-Unlimited-Log-Line-Length | Flag indicating whether log files display complete lines into log files or not. Values are:
For more information, see BMC Knowledge Base article KA308638. | |
Encrypt-Data-Encryption-Algorithm | Integer indicating the encryption algorithm of the data key. Use the following values. Standard Security
Performance Security
Premium Security
For more information, see the Encryption Security section. | |
Encrypt-Public-Key-Algorithm | Integer indicating the encryption algorithm of the public key. Values are
For more information, see the Encryption Security section. | |
Encrypt-Public-Key-Expire | Integer specifying the life span (in seconds) of the public key. At the end of the specified time, the key expires, and the server generates a new key. The default is 86400 seconds (24 hours). | |
Encrypt-Security-Policy | Integer indicating whether encryption is on or off. Values are
For more information, see the Encryption Security section. | |
Encrypt-Session-Hash-Entries 2 | Size of the hash table that holds the encrypted session information. The default is 509; there is no maximum.
| |
Encrypt-Symmetric-Data-Key-Expire | Integer specifying the life span (in seconds) of the data key. At the end of the specified time, the key expires, and a new key exchange occurs. The default is 2700 seconds (45 minutes). | |
Escalation-Log-File | Full path name of the file to use if escalation logging is on (See Debug-mode). | |
Event-Channel-Enabled1 | Enables the subscriber to receive the event as soon as a CI is created, updated, or modified. | |
Exception-Diagnostic-Option 2 | Integer value controlling the diagnostic output when the server crashes. Values are
| |
External-Authentication-Group-Mapping 2 | Mapping of LDAP groups to BMC Remedy AR System groups for external authentication. The value of this option consists of one or more pairs of group names separated by semicolons. For example:"LDAP-1" "ARS-1";"LDAP-2" "ARS-2";"LDAP-3" "ARS-3" Use mapping as an alternative to creating an BMC Remedy AR System group corresponding to each LDAP group. You can map each LDAP group to an BMC Remedy AR System group (as in the example) or multiple LDAP groups to a single BMC Remedy AR System group. If you try to map a single LDAP group to multiple BMC Remedy AR System groups, only the first mapping expression is valid. This option can be used with the External-Authentication-Ignore-Excess-Groups option. | |
External-Authentication-Ignore-Excess-Groups 2 | Flag used by AR System during external authentication. Values are
This option can be used with the External-Authentication-Group-Mapping option. | |
External-Authentication-Return-Data-Capabilities 2 | Bit mask that specifies the return data capabilities for the current AREA plug-in. This option does not control the AREA plug-in; it merely describes the behavior of the plug-in, enabling server optimization. Values are
| |
External-Authentication-RPC-Socket | RPC socket number on which an external authentication server awaits requests for authentication. The default value is 0 (external authentication is not used). The RPC program number for the plug-in server is 390695. | |
External-Authentication-RPC-Timeout | RPC timeout (in seconds) used when calling the authentication (AREA) server. The default value is 40 seconds. | |
External-Authentication-Sync-Timeout | Internal timeout (in seconds) that the BMC Remedy AR System server uses to invoke the external authentication server's AREANeedToSyncCallback() function periodically. This function instructs the BMC Remedy AR System server to renew its internally stored user information in case the source used to authenticate users is changed. A value of 0 means that the BMC Remedy AR System server does not invoke the call to the AREA server. The default value is 3600 seconds. | |
Filter-Api-Timeout | Time limit (in seconds) for the Filter API RPC to respond to the server's request before an error is returned. The minimum value is 1. The maximum is 300. The default is 40. | |
Filter-Log-File | Full path name of the file to use if filter logging is on (See Debug-mode). | |
Filter-Max-Stack | Maximum number of recursion levels allowed for an operation. The data modification performed by an AR_FILTER_ACTION_FIELDP filter action might trigger a second set, or level, of filters, one of which might trigger a third level of filters and so on. This option limits the number of times such recursion can happen, preventing the server crash that would occur if the recursion continued indefinitely. The default value is 25. | The Maximum Stack of Filters field in the Filters area on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options) |
Filter-Max-Total | Maximum number of filters that the server executes for a given operation. The default value is 10000. | The Maximum Filters for an Operation field in the Filters area on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options) |
Flush-Log-Lines | Flag indicating whether logged lines are buffered or written directly to disc. Values are:
| |
Full-Text-Case-Option | Flag indicating whether full text searching is case sensitive or case insensitive. This setting affects all fields indexed for full text search and affects how the indexes are built. Therefore, changes to this setting trigger an automatic re-index. Values are
| The Case field in the Filters area on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options) |
Full-Text-Collection-Directory 1 | Location in the file system where search engine index files are stored. | The FTS Collection Directory field on the AR System Administration FTS Configuration form and on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options and FTS Configuration form in the AR System Administration Console.) |
Full-Text-Configuration-Directory | Location in the file system where search engine configuration files are stored. Note: If you change the directory in this option, update the pluginsvr_config.xml file with the correct directory path. This file is in ARSystemInstallDir\pluginsvr\fts. | The FTS Configuration Directory field on the AR System Administration FTS Configuration form and on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options and FTS Configuration form in the AR System Administration Console.) |
Full-Text-Disable-Indexing | Flag indicating whether the server processes pending indexing tasks. Values are
| The Disable Full Text Indexer field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Disable-Searching | Flag indicating whether the server uses the full text search engine for searching. Values are
| The Disable Full Text Searching field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Index-Commit-Interval (This option is added in Patch 1 for version 9.0.00) | Time, in milliseconds, used by the FTS Lucene index commit thread to decide the interval after which an index for an entry is committed in Lucene collections folder. Default value is 60000 milliseconds (or 1 minute). For example, consider Lucene commit thread runs at 10:45:23 AM. If the first entry is created at 10:45:24 AM, the second entry is created at 10:45:45 AM and the third entry is created at 10:46:21 AM. Then all the three entries are committed to Lucene collections folder at 10:45:23 AM; that is 1 minute after the last entry is created. Note: If the value of the Full-Text-Index-Commit-Interval is set to less than 2000 milliseconds (or 2 seconds), then the default value is set to 2000 milliseconds (or 2 seconds). | |
Full-Text-Indexer-Log-File | Full path name of the file to use if full text indexer logging is on (See Debug-mode). | |
Full-Text-Index-Scheduler-Interval (Starting from BMC Remedy AR System 9.0 Service Pack 1) | Delay in milliseconds before the scheduler provides a wakeup signal to the FTS controller to check for pending FTS entries that should be processed. For more information, see How FTS indexing works. Default value: 120000 milliseconds (120 seconds) If the Full-Text-Index-Scheduler-Interval is set to a value less than 60000 milliseconds (1 minute), the Full-Text-Index-Scheduler-Interval is reverted to a default value of 60000 milliseconds. | |
Full-Text-Indexer-Recovery-Interval | Number of minutes that the server waits between periodic attempts to index entries that failed to index for an unexpected reason in a prior attempt. The default value is 60 minutes. | The Indexing Failure Recovery Interval field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Match-Option | The way the server modifies qualifications from the client. Values are
| The Search Options field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Search-Threshold | The maximum number of search results returned from the search engine. The default value is 10,000. To limit the number of search results (because of constraints on the computer where the search engine is running), reduce the threshold. If you change this option, you must restart the BMC Remedy AR System server for the change to take effect. | The Full Text Search Threshold field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Search-Threshold-High | During the processing of search results, the server combines results from subqueries to arrive at the final result set. If the number of rows created during processing exceeds this value, the server returns an error message indicating the search is too complex. The default value is 1,000,000. | The Complex Search Threshold field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Search-Threshold-Low | While processing search results, the server creates a temporary table if the number of FTS matches reaches this value. If the number of FTS matches is under this value, the server uses the SQL IN operator for a query on an existing table. The default value is 200. | The Temporary Table Threshold field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
Full-Text-Signal-Delay | (Server groups only) Number of seconds before a signal is sent to the server that owns the full text indexing operation (if no signal is pending). When a server is not the owner of the full text indexing operation and generates indexing work, that server signals the server that is the owner of indexing. To reduce the frequency of signals sent, the signaling is conducted on a delayed basis. When indexing is generated, the server checks whether a signal is pending. If a signal is pending, the server does not need to take any action. If a signal is not pending, the server creates a pending signal to be sent in the specified amount of time. If the full text signal delay configuration value is changed, the duration of any pending delay interval does not change. The change takes effect the next time a delay interval is started. The default number of seconds for Full-Text-Indexer-Signal-Delay is 10 seconds. The minimum is 1 second; there is no maximum. | The Indexer Server Group Signal Delay field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.) |
GetListEntry-Server-Date-Format 2 | Flag indicating where to format the GetListEntry date. This option is used mainly for backward compatibility purposes. Values are
| |
Guest-Restricted-Read | Flag indicating whether guest users receive a restricted read license when they log in to BMC Remedy AR System. Values are
If this option is not specified, guest users receive a read license. | The Give Guest Users Restricted Read field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
GUID-Prefix 2 | Character string used as a prefix for GUID strings generated by filters. | |
Homepage-Form | Path to the systemwide default home page. This home page is used only if
Or
And
Note: If the home page is deleted, this option is cleared, and the default home page must be reentered. | The Default Home Form field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
Informix-DBServer-Name 1 | (Informix databases only) Name of the server where the underlying database is located. | |
Informix-Relay-Module 1 | (Informix databases only) Environment setting for the path for the Informix relay module. | |
Informix-TBConfig 1 | (Informix databases only) Name of the configuration file for the underlying database. The default name is onconfig. | |
Internal-User-Info-Hash-Lists2 | Number of shared, linked lists that hold all user-related information. This number must be a power of 2. The default setting is 128. The minimum number is 2. There is no maximum. Note: BMC Remedy AR System does not verify that this number is a power of 2. If the number is not a power of 2, the AR System server might behave in unexpected ways. | |
Internal-User-Instance-Timeout 2 | Time, in minutes, that the AR System server waits before removing inactive user instances from its internal memory cache. Use this option in an LDAP environment to reduce the frequency of checks against an outside authenticator (if a user's record is in server memory, the server does not need to check the user's password outside the system). The default is 2 hours (120 minutes), and the minimum is 30 minutes. Note: This value must be greater than or equal to the value of the Floating License Timeout on the AR System Administration: Server Information form's Timeouts tab (by default, 2 hours). If you specify a value that is less than the Floating License Timeout, you will not receive an error. Inactive user instances, however, will not be removed in less than the time specified by the Floating License Timeout. If you do not set this option, the persistence of inactive user instances is controlled by the Floating License Timeout. | |
IP-Name | Option used to specify that a server has multiple names. This option can appear in the configuration file more than once. When checking workflow and connections against itself, the server compares its server name, host name, IP aliases, and any names specified by this option to the name passed to it. If the name matches any of those names, the server concludes that the workflow or connection is for itself. This option can be used for servers with variable length domains or for servers on computers with multiple internet addresses. For example, to connect to a computer named tix as tix,tix.company.com, or tix.eng.company.com, an administrator would create three IP-Name entries, one for each connection name. To connect to a computer with multiple internet addresses such as tix.company.com, tix.biggercompany.com, and tix.evenbigger.com, an administrator would create an IP-Name entry for each of those addresses. | |
Jmx-port1 | Defines the JMX port number that enables administrators to connect to JVM by using Java Messaging Extensions (JMX). Default value: 61500 | |
Large-Result-Logging-Threshold | Allows you to monitor large memory allocations Default value 1000000 | |
License-Timeout | Number of hours the BMC Remedy AR System server waits before disconnecting inactive users. If a user is holding a floating license, the system also frees the license. The default value is two hours. | |
Locale-List | The installed language packs. Some sample values are
| |
Localized-Messages-To-Cache | A semicolon-separated list of message numbers used to modify the server's default caching behavior for localized system messages. To cache all localized system messages the first time they are retrieved from the AR System Message Catalog form (the default), do not use this option in the configuration file. To not cache any localized system messages, use this option without any message numbers, for example: Localized-Messages-To-Cache: To restrict the caching of localized system messages to a specific subset of message numbers, use this option with a semicolon-separated list of message numbers, for example: Localized-Messages-To-Cache: 66;72;302;314 | |
Localized-Server | Flag indicating whether the server is running in localized support mode. Values are
| The Localize Server field on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options.) |
Locked-Workflow-Log-Mode 2 | Mode that causes the server to record locked workflow actions in workflow logs. These actions are written as encrypted strings. | |
Log-DSO-Errors-To-Form | Flag indicating whether to log failed pending distributed operations to the Distributed Pending Errors form. Values are
| |
Log-DSO-Field-Values 2 | Flag indicating whether to include a list of source entry field/value pairs for errors and warnings in the DSO log files when the DSO log level is set to Error or Warning. Values are
| |
Log-File-Append | Flag indicating whether to create a separate *.bak file or to append to the existing log file. Values are
| |
Log-Form-Selected | Bitmask indicating the type of information to log in the common log form (AR System Log:ALL). To activate one bit, set this option to its value (values are listed under the Debug-mode option). To activate two or more bits, add their values, and set this option to the total. For example, to activate bits 1 and 3, set this option to 5 because bit 1 has a value of 1 and bit 3 has a value of 4. To deactivate a bit, subtract its value from the value of this option. This option does not apply to the following bits because information about their corresponding applications is not logged to a form:
| |
Log-To-Form | Bitmask indicating the information to log in predefined forms (for example, AR System Log: API and AR System Log: Filter). To activate one bit, set this option to its value (values are listed under theDebug-mode option). To activate two or more bits, add their values, and set this option to the total. For example, to activate bits 1 and 3, set this option to 5 because bit 1 has a value of 1 and bit 3 has a value of 4. To deactivate a bit, subtract its value from the value of this option. This option does not apply to the following bits because no log form is created for their corresponding applications:
| |
Long-Running-Escalation-Logging-Threshold | The minimum number of seconds to complete an escalation before a line is added to the thread log to detail how long the escalation ran. See Using logs to identify long-running escalations. | |
Map-IP-Address 2 | IP address mappings that enable alerts to work through firewalls when Network Address Translation (NAT) is on. You must set up a mapping for each client computer that has access through the firewall where the client IP address is translated from an internal address to a valid external address. In addition, a mapping is required for the AR System server IP address if the host where the server resides is also translated. Here is a multiple line example:
| |
Max-Entries-Per-Query | Maximum number of requests returned by a search. Because users can also specify the maximum number of requests returned through Search Preferences in the BMC Remedy AR System User Preference form, the actual maximum is the lower of these values. The default value is no server-defined maximum. BMC recommends always setting a value for this parameter as unqualified searches can yield enormous results resulting in unpredictable system behavior. | The Max Entries Returned by GetList field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
Max-Log-File-Size | Maximum size in bytes for system log files. If the maximum is reached, the logging cycle restarts at the beginning of the file, overwriting existing information. The default value is 0 (no limit). This option does not apply to the Arfork-Log-File. | |
Max-Log-History | Maximum number of backup (.bak) log files to be allowed when the log file reaches the Max-Log-File-Size value and a new log file is created. By default, the number of backup log files allowed is 1 and the maximum number of backup log files allowed is 999. | |
Max-Notify-Mail-Line-Len 2 | Maximum number of bytes that can be in a line of a mail notification. | |
Max-Password-Attempts | Maximum number of consecutive bad password retries a user can make. If this option is set to 3, the user has 3 chances to log in. If all 3 attempts have bad passwords, the user account is markedINVALID. Values are 0 (which turns this feature off) and all positive integers. This parameter can be used in conjunction with Display-General-Auth-Message. (See ar.cfg or ar.conf options C-D. See also the description for error 624.) | The Max Number of Password Attempts field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
Max-Recursion-Level | For forms that contain hierarchical data, such as manager and employee relationships, the maximum number of levels in the hierarchy that a recursive query retrieves. Values are any integer greater than 0. The default is 25. (See ARGetListEntryWithMultiSchemaFields.) | The Maximum Depth for Hierarchical Query field on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options.) |
Max-Vendor-Temp-Tables | Maximum number of temporary tables that can exist on an AR System server for a single vendor form. The ARGetListEntryWithMultiSchemaFields function stores data from vendor data sources in these tables. By default, only one temporary table can exist for each vendor form. This setting applies to all vendor forms on the server. It is overridden by the value of an individual vendor form's Maximum Vendor Temp Tables property. Enter any integer greater than 0. (See ARGetListEntryWithMultiSchemaFields.) | The Maximum Vendor Temp Tables field on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options.) |
Max-Log-History | Allows you to create maximum eight backup log files. Each log file will be of the size defined in the Max-Log-File-Size parameter. Default value:8 | |
Max-Log-File-Size | Allows you to set the size of backup file. Default value: 134217728 | |
Maximum-Concurrent-Client-Managed-Transactions | Maximum number of concurrent client-managed transactions. The default is 10, and the maximum value you can enter is 100. | |
Mid-Tier-Service-Password | Password that administrators use to access the mid tier. | The Mid-Tier Administrator 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.) |
Minimum-API-Version | Oldest API version with which the server communicates. The default value is 0, which means that the server communicates with all API versions. If the client's API version is less than the specified value, the server refuses to talk with the client, and the client receives a decode error. (A AR System client is any program that accesses the AR System server through API calls, for example, BMC Remedy Developer Studio, plug-ins loaded by the plug-in server, and so on.) | Maps to: The Minimum API Version field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
Minimum-CMDB-API-Version | Oldest CMDB API version with which the server communicates. The default value is 3. If the version of a CMDB call is less than the specified value, the server refuses the call. This option is independent of the Minimum-API-Version option. | |
Multiple-ARSystem-Servers | Flag indicating whether other AR System servers can run on this server's host computer. Values are
To run multiple servers on the same host computer, this option must be set to T in the configuration file of each server. Note: To add a 7.5.00 or later AR System server to an environment in which a 7.1.00 or earlier AR System server is already installed, you must first change the value of this option from F toT. Otherwise, the 7.5.00 or later server installation will fail. | |
Multiple-Assign-Groups | Flag indicating whether multiple assignee groups can be stored in row-level security field ID 112. This enables users from multiple groups to access the same request. In the past, only one group could be stored in Field 112. Values are
| The Enable Multiple Assign Groups field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.) |
is-ZDT (Starting from BMC Remedy AR System 9.0 Service Pack 1) | You need to add this parameter to perform zero downtime upgrade of the platform components.
|
1. Options you can view (but not set) using the AR System Administration: Server Information form. 2. Options you cannot set or view using the AR System Administration: Server Information form |
Comments
Please can add documentation for the new is-ZDT parameter?
https://docs.bmc.com/docs/display/public/brid90/Preparing+for+zero+downtime+upgrade#Preparingforzerodowntimeupgrade-BMCRemedyARSystemconfigurationchangesbeforeperformingzerodowntimeupgrade
Hi Andreas,
Thanks for your comment.
I have updated the document.
-Hemant