ar.cfg or ar.conf options C-D
Dispatch-Log-File This table contains the options for the ar.cfg (ar.conf) file that begin with the letters C and D.
ar.cfg (ar.conf) file options (C-D)
- 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 Cache-Mode 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 Cache parameters, type Cache 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 ARCreateEntry() in the description, type ARCreateEntry() in the Description text box.
The way that the server caches form display properties. The form display property is the background image of the form view and the display property of each form field. Valid values:
The valid value for Cache-Mode is,
0 — (Default)
Note: You should always set the value for Cache-Mode to 0.
The Development Cache Mode field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Note: You should not change the default value for the Development Cache Mode checkbox.
Flag indicating whether the cancel query functionality in a browser is enabled. Valid values:
Flag indicating whether the system checks whether another user changed an entry after you retrieved the entry. If you try to save modifications to an entry, you receive a warning and must confirm the save. Valid values:
Maximum time (in seconds) to hold a transaction before a timeout occurs. The default is 60 seconds, and there is no maximum. If a timeout occurs, the server automatically rolls the transaction back, and the client receives an error on the next operation that uses the transaction handle.
|The Transaction Timeout (seconds) field in the Transaction Control area on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options.)|
Flag indicating whether indexes for the database are clustered. Valid values:
Specifies the time interval in milliseconds after which the CMDB refreshes its cache in the background.
|CMDB-Cache-Refresh-Interval 2||Frequency, in seconds, at which the BMC Atrium CMDB cache is refreshed. The default value is 300 seconds (5 minutes). For more information about the cache refresh interval, see Setting the cache refresh interval.|
Specifies the time interval in milliseconds after which the data will be treated as orphaned and the memory can be reclaimed by server.
Specifies the time interval in milliseconds to start checking for the orphan data after CMDB server has started.
Specifies the time interval in milliseconds at which the CMDB server should perform the orphan data checks. To disable this parameter set a value to minus -. For example, -1.
|CMDB-CIViewer-Graph-Limit1||Sets the CI viewer graph limit.|
|CMDB-GQRecursion-Limit1||Sets the limit for number of levels of recursion for CMDB graph query.|
|CMDB-Hard-Delete-Only-If-Marked-For-Delete1||Specifies that all the CIs that are Marked As Delete (MAD) are to be deleted.|
|CMDB-Impact-Weight-Default1||Specifies the default weight attached to impact relationship. This value is used in Atrium Impact Simulation.|
|CMDB-Log-File-Location1||Specifies the path on the server where the log file is saved.|
|CMDB-Log-File-Name1||Specifies the name of the CMDB log file.|
|CMDB-Max-Results-Per-Query1||Specifies the maximum number of results that are returned per query. If this value is 0 it means that the maximum results per query are unlimited.|
Specifies the number of backup CMDB log files to be maintained.
|Configure-Log4j1||Indicates whether log4j package should be configured from the external properties file log4j.properties.|
|Configuration-Name1||Defines the name of the component. AR System server uses this option to identify the active component in the database.|
Number of times to retry the ARCreateEntry() function during deadlock situations. Value is an integer.
Default value - 3 (3 retries)
Delay, in seconds, between each retry of a deadlocked ARCreateEntry() function. Value is an integer.
Default value - 0 (Retries happen immediately, without a delay)
Flag indicating how the system responds when a user's logon name is not assigned a password in the User form. Valid values:
|Currency-Ratio-Client-Refresh-Interval 2||Number of minutes between each refresh of currency conversion ratios on the client.|
Flag indicating whether to perform case-insensitive queries on Run If qualifications for active links, filters, and escalations. (For Oracle databases, ensure that this option matches the behavior of your Oracle database so that all queries are consistent.) Valid values:
To learn how to enable case-insensitive search for fixed-length text fields in BMC Remedy AR System version 9.x on Oracle, see the BMC Knowledge Base article KA406947.
Option that initializes an internal variable that the server uses for various purposes, such as informing the ARGetServerInfo function's AR_SERVER_INFO_DB_CHAR_SET server option request or adjusting the database short column size so that the number of characters in a datum does not exceed the number of bytes in the database field. Valid values:
Note: The installer sets this option's value.
|Db-Connection-Retries 2||Number of times the BMC Remedy AR System server tries to reestablish a lost connection to the database. The default is 100. The server retries the connection once every 30 seconds up to the specified number of times. For example, when this option is set to 100, the server retries the connection once every 30 seconds for a duration of 25 minutes.|
|Db-Functional-Index 1|| |
Option to change the AR System server's default behavior for index creation. To change the AR System server's default behavior for index creation, set the Db-Functional-Index parameter to T. Then, when a new index is added to a form, the AR System server creates a functional index for the form. This parameter helps to avoid performance degradation that can result from not using database indexes.
For optimal performance when using database indexes for case-insensitive searches on Oracle, ensure that:
Note: Depending on the volume of data, creating functional indexes may take a long time.
|Db-Host-Name1||Defines the name of the Database Server.|
Maximum size (in bytes) of compressed attachments that the AR System server can retrieve from Oracle databases. The default value is 2 GB. This value is limited by your server operating system and configuration.
Note: To limit the size of compressed attachments that can be sent to the database server from AR System server, see AR-Max-Attach-Size.
|Db-Max-Text-Size2||(Oracle and Microsoft SQL Server) Maximum size for long character text data in databases. For Oracle databases, this value is also used for memory allocation during the processing of long text data; therefore, use it conservatively. The default for an Oracle database is 4,194,308 bytes. For SQL Server, the default is 2,147,483,647 bytes. The maximum value for either database is 2,147,483,647 bytes.|
|Db-name 1||For Oracle, the name of the tablespace that the AR System server uses. For all other supported databases, the name of the underlying SQL database. The default value is ARSystem.|
|Db-password||(Microsoft SQL Server and Oracle) Database password associated with the ARSystem database and table space. The password can be modified by using the ARSetServerInfo function and is stored in encrypted form. If you change the password manually, specify this option by using clear text, and change the password by using the AR System Administration: Server Information form to encrypt it.|
|Db-Server-Port1||Defines the database port number.|
Defines the type of database the AR System server is connecting to.
|Db-user 1||(Microsoft SQL Server and Oracle) User name that AR System uses to access the underlying database. The default is ARAdmin.|
|DB-Database-Alias||DB database alias name for the AR System database.|
|DB-Server-Name||DB database server name.|
|Dbhome-directory 1||(SQL databases on UNIX only) Full path name of the home directory for the underlying database.|
|Debug-GroupId||Name of the group to which a user must belong to use logging options such as API, database, and filter logging in BMC Remedy AR System clients. Logging options are disabled for users who are not members of the specified group. The group name can be Public, Administrator, Sub Administrator, or Browser. You can also set this option in the Client-Side Logging Group field on the Log Files tab.|
Bitmask indicating the server logging modes. To activate one bit, set this option to its value (see the following list). 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. Unless otherwise specified in the following list, this option turns on logging for the arserverd process. Default log files are in the directory specified by the Server-directory option.
|Default-Allowable-Currencies||Default allowable currency types for currency fields in clients.|
|Default-Functional-Currencies||Default functional currency types for currency fields in clients.|
|Default-messaging-port||Specifies port for JMS (Java Messaging Service) used by Java server for asynchronous communication within server or server group. Default value is 61617.|
Flag indicating whether to apply the default sort order to search results. Valid values:
URL to the directory path for the default web server pointing to the BMC Remedy AR System server.
|The Default Web Path field on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options.)|
Number of seconds before the latest cache is made available to all threads. Valid values: 0 to 3600 seconds. If this option is set to 0, every API call gets the latest cache (that is, the cache is copied for every administrator call). Setting the option to 0 causes slower performance for cache operations.
The default value is 5 seconds. The recommended value is 300 (5 minutes).
|The Recache Delay field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Flag indicating whether administrative operations are allowed on the server. Valid values:
|The Disable Admin Operations field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Flag indicating whether alerts are sent when alert events are created. Valid values:
|The Disable Alerts field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Switch that disables (T ) or enables (F ) the archive when the server starts.
|The Disable Archive field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Flag indicating whether automatic signals triggered by changes to the following data on a server group's administrative server are disabled:
|The Disable ARSignals field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Flag indicating whether to audit all records (T ), or to audit only those records whose field values have changed (F, the default).
|The Disable Audit Only Changed Fields field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Option that restricts time-consuming operations (such as reporting) during busy times, improving overall performance. The syntax is
Flag indicating whether escalations are allowed on the server. Valid values: T and F (default). If the Server Group Member check box is selected, this option is ignored. Server groups can be configured in the BMC Remedy AR System Server Group Operation Ranking form to make sure that only one server performs the operation. (See Configuring server groups.)
|The Disable Escalations Setting administrative options.)field on the Configuration tab of the AR System Administration: Server Information form. (See|
Flag indicating whether Unicode servers can refuse requests from non-Unicode clients (for example, not Mid Tier 7.0.00). This option does not affect non-Unicode servers. Valid values:
|The Disable Escalations field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)|
Flag that prevents unauthorized users from using User Cache commands.
Flag that indicates whether the dispatcher logging is enabled. Valid value is location to the log file.
To add the parameter, perform the following steps:
Flag indicating whether to display a message when user authentication fails. Valid values:
This parameter can be used in conjunction with Max-Password-Attempts. (See ar.cfg or ar.conf options E-M.)
|Distrib-Log-File||Full path name of the file to use if DSO server logging is on (See Debug-mode).|
The BMC Remedy AR System server to use for the DSO server. By default, the DSO server runs in queues like any other user.
Obsolete. (See Assigning an RPC program number to DSO.)
|Domain-Name 2||New domain name portion of the fully qualified server name. By default, a server determines the domain name from the network interface. In rare cases, this method does not produce the desired result because of unexpected network card configurations. In those cases, you can use this option to override the domain name derived from the network interface.|
Number of seconds between occurrences of these operations:
DSO server retry behavior after an error:
|DSO-Host-Name 2||Name to use for the From (source) server in distributed mappings. This setting enables you to use an alias for the From server in distributed operations.|
RPC program number that DSO uses. This setting is optional.
|The DSO Local RPC Program Number field in the DSO Server area on the Configuration tab of the AR System Administration: Server Information form. (See Setting server passwords, RPC options, and plug-in timeouts.)|
Level of logging for all DSO logs (ardist.log, ardist.log.default, ardist. poolName.log, and ardist.log. poolName ):
|DSO-Log-Max-Backup-Index 2||Number of indexed backup files saved for each DSO Java log file. If you do not specify a value for this option, 5 indexed backups are saved for each DSO Java log file.|
|DSO-Main-Thread-Polling-Interval||Interval at which the DSO server queries the distributed pending queue for pending distributed items. Enter any integer from 0(no polling) to 3600 seconds (1 hour).|
Flag indicating whether to set the status of items in the DSO distributed pending queue to Retry after an attempt to perform the associated operation fails. (Failure must be due to a recoverable error. Items that fail because of nonrecoverable errors are removed from the queue.) Valid values:
|DSO-Max-Pending-Records-Per-Query||Maximum number of records in the Distributed Pending form that DSO reads in a single database query. Minimum value is 1. Maximum value is unlimited. If no value is specified, the default is 1000.|
The way the DSO server behaves when it finds a duplicate request ID on the target server. Valid values:
|DSO-Placeholder-Mode||Mode that disables the DSO server installed on the same host as the AR System server. Use this when setting up a DSO server outside a firewall to support an AR System server running behind a firewall.|
|DSO-Polling-Interval||Interval (in seconds) at which the DSO server checks the distributed pending queue for pending distributed items. This is used as a backup when no signals are received from workflow. The value can be any integer between 15 and 7200. By default, the backup polling interval is disabled.|
|DSO-Source-Server||The AR System server for a DSO server to support when that AR System server is different from the one installed with the DSO server. Use this when setting up a DSO server outside a firewall to support an AR System server running behind a firewall.|
Note: Use this entry to configure DSO for load balancing.
Flag indicating whether to log AR System server error 302 (entry does not exist in database) in the*arerror.log* file when performing distributed delete operations. Valid values:
Information for the target BMC Remedy AR System server. Use this format:DSO-Target-Connection:serverName:RPCNumber portNumber
|The Target connection settings tables field in the DSO Server area on the Configuration tab of the AR System Administration: Server Information form. (See Setting server passwords, RPC options, and plug-in timeouts.)|
|DSO-Target-Password||Password used to access the target BMC Remedy AR System server through the DSO server. Use this format:DSO-Target-Password: serverName:encryptedPassword|
|DSO-Timeout-Normal||Timeout (in seconds) that the DSO server applies during communication with the AR System server. Enter an integer between60 (1 minute) and 21600 (6 hours). If no value is specified, the system uses the default timeout (120 seconds).|
|DSO-User-Password||Password for the local DSO server user.|
|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.