Configuration settings E-M
The centralized configuration forms store the configuration settings. All the numeric values for the settings are in base 10 system. You can modify the settings by using the AR System Configuration Generic UI form. The settings are case- and space-sensitive. See Updating configuration settings by using the AR System Configuration Generic UI form.
Note
BMC recommends that you use the AR System Configuration Generic UI form to modify the configuration settings. Do not use the ar.cfg file to modify the configuration settings on the AR System Configuration Generic UI form.
The following table lists the settings available for centralized configuration.
Tip
- If you cannot view all the columns, view the page in full screen mode. Alternatively, use the scroll bar at the bottom of the table.
- Press F11 to view the table in full screen mode. Press F11 to exit full screen mode.
- To easily search for a specific parameter in the table, select the parameter from the Setting list. Alternatively, type the name of the parameter in the Setting text box. For example, to search for the Next-ID-Block-Size parameter, select it from the Setting list, or type the parameter name in the Setting text box.
- To search for the parameters which have a specific text string in the description, type the string in the Description text box. For example, to search for the parameters which have Configuration in the description, type Configuration in the Description text box.
Configuration options (E-M)
Setting | Description | Server group configuration | 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. Check out a video on using CCS for Email Engine here - https://youtu.be/EX1IuC1Wr6g | No | AR System Configuration Generic UI form |
Email-Timeout 2 | Maximum time that arserverd waits for a return value from sendmail. This option was valid in AR System versions 4.5.1 through 5.0.1 but became obsolete when the Email Engine was introduced in version 5.1.0. | No | AR System Configuration Generic UI form |
Enable-Unlimited-Log-Line-Length | Flag indicating whether log files display complete lines into log files or not. Values are:
| No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
Encrypt-Public-Key-Algorithm | Integer indicating the encryption algorithm of the public key. Values are
For more information, see the Encryption Security section. | No | AR System Configuration Generic UI form |
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). | No | AR System Configuration Generic UI form |
Encrypt-Security-Policy | Integer indicating whether encryption is on or off. Values are
For more information, see the Encryption Security section. | No | AR System Configuration Generic UI form |
Encrypt-Session-Hash-Entries 2 | Size of the hash table that holds the encrypted session information. The default is 509; there is no maximum. | No | AR System Configuration Generic UI form |
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). | No | AR System Configuration Generic UI form |
Errors-Triggering-AlwaysOnLog-Dump | The error codes separated by semicolon, which will automatically dump the Always On Logging buffer, if the specified error codes occur during the execution.
| Yes | AR System Administration Console > System > General > Server Information > Always On Logging > Errors Triggering Log. (See Setting Always On logging.) |
Escalation-Log-File | Full path name of the file to use if escalation logging is on (see Debug-mode). | No | AR System Configuration Generic UI form |
Exception-Diagnostic-Option 2 | Integer value controlling the diagnostic output when the server crashes. Values are
| No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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
By default, bit 1 to 5 are set. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
External-Authentication-RPC-Timeout | RPC timeout (in seconds) used when calling the authentication (AREA) server. The default value is 40 seconds. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
Filter-Log-File | Full path name of the file to use if filter logging is on (see Debug-mode). | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
Filter-Max-Total | Maximum number of filters that the server executes for a given operation. The default value is 10000. | No | AR System Configuration Generic UI form |
Force-RSSO-Authentication | This setting accepts a semicolon (;) separated list of client types. The client application reads this setting and if it is listed there, the client application enforces an RSSO authentication. Only the Remedy Developer Studio can read this setting. | No | AR System Configuration Generic UI form |
Flush-Log-Lines | Flag indicating whether logged lines are buffered or written directly to disc. Values are:
| No | AR System Configuration Generic UI form |
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
| No | AR System Configuration Generic UI form |
Full-Text-Collection-Directory1 (Component name: com.bmc.arsys.server) | Location in the file system where search engine index files are stored. | No | AR System Configuration Generic UI form |
Full-Text-Configuration-Directory (Component name: com.bmc.arsys.server) | 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. | No | AR System Configuration Generic UI form |
Full-Text-Disable-Indexing | Flag indicating whether the server processes pending indexing tasks. Values are
| No | AR System Configuration Generic UI form |
Full-Text-Disable-Searching | Flag indicating whether the server uses the full text search engine for searching. Values are
| No | AR System Configuration Generic UI form |
Full-Text-Indexer-Log-File | Full path name of the file to use if full text indexer logging is on (see Debug-mode). | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
Full-Text-Match-Option | The way the server modifies qualifications from the client. Values are
| No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
GetListEntry-Server-Date-Format 2 | Flag indicating where to format the GetListEntry date. This option is used mainly for backward compatibility purposes. Values are
| No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
GUID-Prefix 2 | Character string used as a prefix for GUID strings generated by filters. | No | AR System Configuration Generic UI form |
Hierarchical-Groups-Chunk-Size (Component name: com.bmc.arsys.server.shared) | This parameter specifies the number of records processed during the bulk computation of Hierarchial groups. You cannot set value less than 1000. Default value: 1000 | Yes | AR System Configuration Generic UI form |
Hierarchical-Groups-Interval (Component name: com.bmc.arsys.server.shared) | Allows you to configure compute delay (in seconds) for hierarchical groups. Default value: 300 seconds | Yes | AR System Configuration Generic UI form For details on hierarchical groups parameters, see Controlling access to requests for hierarchical groups. |
Hierarchical-Groups-Threads (Component name: com.bmc.arsys.server.shared) | Allows you to configure the number of threads that will be used for computation of hierarchical groups. Default value: 3 | Yes | AR System Configuration Generic UI form For details on hierarchical groups parameters, see Controlling access to requests for hierarchical groups. |
Homepage-Form (Component name: com.bmc.arsys.server) | Path to the system wide default home page. This home page is used only if
Or
And
| No | AR System Configuration Generic UI form |
Internal-User-Info-Hash-Lists 2 | 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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
Jmx-port1 | Defines the JMX port number that enables administrators to connect to JVM by using Java Messaging Extensions (JMX). Default value: 61500 | No | System > General > Server Information > Ports and Queues > JMX Port. |
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. | No | AR System Configuration Generic UI form |
Locale-List (Component name: com.bmc.arsys.server) | The installed language packs. Some sample values are
| No | AR System Configuration Generic UI form |
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 | No | AR System Configuration Generic UI form |
Localized-Server (Component name: com.bmc.arsys.server) | Flag indicating whether the server is running in localized support mode. Values are
In 9.1.02, the default value is set to T. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
log_backups (Component name:com.bmc.arsys.flashboardServer) | Maximum number of backup (.bak) log files for the BMC Remedy Flashboards server to be allowed, when the log file reaches the Maximum File Size value and a new log file is created. Default value: 10 | No | AR System Administration Console > System > General > Flashboard Server Configuration > Maximum Backups. (See AR System Administration - Flashboard Server Configuration.) |
log_category (Component name:com.bmc.arsys.flashboardServer) | Type of information to be stored in the BMC Remedy Flashboards server log file. Values are:
Default value: All | No | AR System Administration Console > System > General > Flashboard Server Configuration > Log Category. (See AR System Administration - Flashboard Server Configuration.) |
log_default_format (Component name:com.bmc.arsys.flashboardServer) | Format for the BMC Remedy Flashboards sever log output when log_level parameter for BMC Remedy Flashboards server is set to BASIC or INFO. The log output is generated using Java log4j pattern layout. For more information on log4j pattern layout, see Pattern layout. | No | AR System Administration Console > System > General > Flashboard Server Configuration > Log Format. (See AR System Administration - Flashboard Server Configuration.) |
log_detail_format (Component name:com.bmc.arsys.flashboardServer) | Format for the BMC Remedy Flashboards sever log output when log_level parameter for BMC Remedy Flashboards server is set to DEBUG. Default value: <%t> <%c> <%d> <%l> <%m> %n For more information on log4j pattern layout, see Pattern layout. | No | AR System Configuration Generic UI form |
log_filename (Component name:com.bmc.arsys.flashboardServer) | Name of the BMC Remedy Flashboards server log file. Default value: arfbserver.log | No | AR System Administration Console > System > General > Flashboard Server Configuration > Log File Name. (See AR System Administration - Flashboard Server Configuration.)
|
log_filepath (Component name:com.bmc.arsys.flashboardServer) | The path for the BMC Remedy Flashboards server log file. Default value: . | No | AR System Configuration Generic UI form |
log_filesize (Component name:com.bmc.arsys.flashboardServer) | Maximum size (in kilobytes) for the BMC Remedy Flashboards server log file. Default value: 100 KB | No | AR System Administration Console > System > General > Flashboard Server Configuration > Maximum File Size. (See AR System Administration - Flashboard Server Configuration.) |
log_level (Component name:com.bmc.arsys.flashboardServer) | The level of logging for the BMC Remedy Flashboards server. Values are: | No | AR System Administration Console > System > General > Flashboard Server Configuration > Log Level. (See AR System Administration - Flashboard Server Configuration.) |
log_null_value (Component name:com.bmc.arsys.flashboardServer) | The value to represent a null value in the BMC Remedy Flashboards logs. Default value: -
| No | AR System Configuration Generic UI form |
log_viewer (Component name:com.bmc.arsys.flashboardServer) | The method by which you want to view BMC Remedy Flashboards log files. Values are:
Default value: FILE | No | AR System Configuration Generic UI form |
Log-DSO-Errors-To-Form | Flag indicating whether to log failed pending distributed operations to the Distributed Pending Errors form. Values are
| No | AR System Configuration Generic UI form |
Log-File-Append | Flag indicating whether to create a separate *.bak file or to append to the existing log file. Values are
| No | AR System Configuration Generic UI form |
Log-Form-Selected (Component name: com.bmc.arsys.server) | 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:
| No | AR System Configuration Generic UI 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 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 no log form is created for their corresponding applications:
| No | AR System Configuration Generic UI form |
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:
| No | AR System Configuration Generic UI form |
Max-AlwaysOn-Buffer-Size | The size of the memory buffer in bytes to store the logs in memory for always on logging feature.
Default value: 5242880 bytes (5 MB) | Yes | AR System Administration Console > System > General > Server Information > Always On Logging > BufferSize. (See Setting Always On logging.) |
Max-Inactivity-Duration | The maximum inactivity duration in seconds. The Inactivity monitoring is disabled when set to a value < = 0. Max-Inactivity-Duration: 30 | No | AR System Configuration Generic UI form |
Max-Inactivity-Duration-Inital-Delay | Max-Inactivity-Duration-Inital-Delay: 120 Note: Max-Inactivity-Duration-Inital-Delay: 300 | No | AR System Configuration Generic UI form |
Max-Entries-Per-Query (Component name: com.bmc.arsys.server) | 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. In 9.1.02, the default value is set to 2000. | No | AR System Configuration Generic UI form |
Max-Log-File-Size (Component name: com.bmc.arsys.server) | 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. | No | AR System Configuration Generic UI form |
Max-Log-History (Component name: com.bmc.arsys.server) | 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. | No | AR System Configuration Generic UI form |
Max-Notify-Mail-Line-Len 2 | Maximum number of bytes that can be in a line of a mail notification. | No | AR System Configuration Generic UI form |
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 marked INVALID. 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 Configuration settings C-D. See also the description for error 624. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
MaxWorkerThreads (Component name:com.bmc.arsys.flashboardServer) | The maximum number of worker threads allowed for BMC Remedy Flashboards server. Default value: 2 | AR System Configuration Generic UI form | |
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. | No | AR System Configuration Generic UI form |
MFS-Environment-Field-Weight | Indicates the relevancy weight for the Environment field of a form in a multiple-form search. The value can be any number between 0 and 2000. Valid values:
For more information, see Configuring forms for multi-form FTS. | No | AR System Configuration Generic UI form |
MFS-Keywords-Field-Weight | Indicates the relevancy weight for the Keywords field of a form in a multiple-form search. The value can be any number between 0 and 2000. Valid values:
For more information, see Configuring forms for multi-form FTS. | No | AR System Configuration Generic UI form |
MFS-Title-Field-Weight | Indicates the relevancy weight for the Title field of a form in a multiple-form search. The value can be any number between 0 and 2000. Valid values:
For more information, see Configuring forms for multi-form FTS. | No | AR System Configuration Generic UI form |
Mid-Tier-Service-Password (Component name: com.bmc.arsys.server) | Password that administrators use to access the mid tier. | No | AR System Configuration Generic UI form |
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.) | No | AR System Configuration Generic UI form |
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. | No | AR System Configuration Generic UI form |
MinWorkerThreads (Component name:com.bmc.arsys.flashboardServer) | The minimum number of worker threads allowed for BMC Remedy Flashboards server. Default value: 2 | AR System Configuration Generic UI form | |
Multiple-ARSystem-Servers (Component name: com.bmc.arsys.server) | Flag indicating whether other AR System servers can run on this server's host computer. Valid values:
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 to T. Otherwise, the 7.5.00 or later server installation will fail. | No | AR System Configuration Generic UI form |
Multiple-Assign-Groups 2 | 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. Valid values:
| No | AR System Configuration Generic UI form |
Options you can view (but not set) using the AR System Administration: Server Information form.
Options you cannot set or view using the AR System Administration: Server Information form.
Comments