This documentation supports the 9.0 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

Configuration settings C-D

The centralized configuration forms store configuration settings as name value pairs in the following format:

<Setting Name>: <Setting Value>

Each setting represents a particular configuration option. The associated value represents the current setting for the option. All numeric values are in a base 10 system. Default behavior occurs either when an option is set to the default value or when the option is not in the centralized form.

You can modify the settings 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.

The following table lists the options available for centralized configuration.   

Tip

  • If you cannot view all the columns, click the icon on the top-right corner of the page to open it in full screen mode. Alternatively, use the scroll bar at the bottom of the table.
  • 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 Next-ID-Block-Size parameter, select it from the Option list, or type the parameter name 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 Configuration in the description, type Configuration in the Description text box.

Configuration options (C-D)

Oops, it seems that you need to place a table or a macro generating a table within the Table Filter macro.

The table is being loaded. Please wait for a bit ...

OptionDescription

Sever group

configuration 

Maps to
Cache-Display-Properties  2

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:

  • T — (Default) Cache all form-display properties.
  • F — Cache only server-display properties. (This can negatively impact the
    performance of the server if a form is changed, but it reduces the amount
    of memory used in the server cache.)
No  
Cache-Mode

The valid value for Cache-Mode is,

0 — (Default)

Note: You should always set the value for Cache-Mode to 0.  

 No

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.

Cancel-Query-Option  2

Flag indicating whether the cancel query functionality in a browser is enabled.
Valid values:

  • 0 — Inactive
  • 1 — (Default) Active
 No 
Changed-By-Another-Check

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:

  • T — (Default) Perform the check and issue a warning.
  • F — Do not perform the check.
 No 
Client-Managed-Transaction-Timeout

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.

No 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.)
Clustered-Index

Flag indicating whether indexes for the database are clustered. Valid values:

  • T — (Default) Use a clustered index.
  • F — Do not use a clustered index.

    You must set this option before you start the BMC Remedy AR System server.
No  

com.bmc.arsys.emaildaemon.level 2

Specifies the log level for email engine based on which the logs are generated
in the email.log file

Valid values:

  • Off
  • Severe (Default)
  • Warning
  • Info
  • Config
  • Fine
  • Finer
  • Finest

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No 

com.bmc.arsys.emaildaemon.
ARSystemHandler.level 2

Specifies the log level for email engine based on which the logs are saved in the
 AR System Email Error Logs form

Valid values:

  • Off (Default)
  • Severe
  • Warning
  • Info
  • Config
  • Fine
  • Finer
  • Finest

Related functionality: Incoming and Outgoing

Related protocol: All Supported

 No 
 com.bmc.arsys.emaildaemon.logfileName Enables users to specify the log file path

Note: Once the user specifies a file path, email engine logs that
user defined file only when it connects to AR server. if any error occurred before connecting to
Centralized configuration form then logs will be stored into default log file path.

Default value: emailEngineInstallDir/AREmail/Logs/email.log

 

 No 

com.bmc.arsys.emaildaemon.logfilesize

 

Specifies the maximum size of the log file in bytes

If the file size exceeds this limit, a new file is created.

Default value: Unlimited 

No  

com.bmc.arsys.emaildaemon.
AdditionalMailHeaders 2

Specifies additional email headers. Separate the additional email headers with commas.
See Adding extra custom headers to outgoing SMTP emails.

Default value: X-Loop-Detect

Related functionality: Outgoing

Related protocol: SMTP

No  

com.bmc.arsys.emaildaemon.ARDATE 2

Specifies the date and time format that the BMC Remedy Email Engine
uses for parsing date and time strings given in the incoming mails.
MMMMM dd, yyyy HH:mm:ss z is equivalent to December 21, 2009 12:08:56 PDT.

Related functionality: Incoming

Related protocol: All Supported

 No 

com.bmc.arsys.emaildaemon.ARDATEONLY 2

Specifies the date format that BMC Remedy Email Engine uses for parsing date strings
given in incoming mails. MMMMM dd, yyyy is equivalent to December 21, 2009.

Default value: X-Loop-Detect

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
ARTIMEONLY 2

This setting lets you specify the time format used by BMC Remedy Email Engine
for parsing time strings given in incoming mails. HH:mm:ss z is equivalent to 12:08:56 PDT.

Default value: X-Loop-Detect

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
ContentTypeWithCharset 2

This setting indicates whether to send the charset property in the
Content-Type header of an outgoing message. If you do not want the charset string
to be present in the Content-Type header, set this property to False.

Valid values:

  • True (Default)
  • False

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
ChunkSize 2

Specifies the number of entries to return when the BMC Remedy Email Engine
makes a call to the AR System server.

Default value: 100

Note: The maximum value is also 100.

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
CommaValidAddressSeparator 2

Specifies whether you can use a comma as a separator when entering multiple addresses
in the To and CC fields. If user names in the mail server contain commas,
set this property to false (usually needed only when using the MAPI protocol).
For example, if names are stored on the mail server as:
Smith, John and
Cho, Rick
You would need to use semicolons to separate the addresses:
Smith, John; Cho, Rick

Valid values:

  • True (Default)
  • False

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No 

com.bmc.arsys.emaildaemon.
Exchange-Wait-Time 2

Specifies the amount of time in milliseconds for which the BMC Remedy Email Engine
waits before processing the next incoming message, when there are more messages
residing on the Exchange Server.

Default value: 1

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
FetchUserGroupInfoOnDemand 2

Specifies whether to fetch the user and group information about demand as opposed
to loading all users and groups at startup. If there are many users or groups,
you might want to set this property to true to reduce the startup time for email.

Valid values:

  • True
  • False (Default)

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
getReplyToWithFromAddress 2

Determines whether the outgoing message header should contain the Reply To field
and what its value should be.getReplyToWithFromAddress is not used by default.
If you want the email engine to use this property, you must add it to
EmailDaemon.properties and set its value to true. If you add the
property but do not specify a value, it is considered as false.
The effect of using this property is as follows:

  • If no values are provided in the Reply To Address field of the outgoing mailbox
    configuration form and the Reply To field of the messages form, and the value of this property is:
    • false (or not provided) — The Reply To field is not included in the outgoing message header.
    • true — The Reply To field is included in the outgoing message header,
      and its value is the address in the From field of the messages form.
  • If the Reply To Address field of the outgoing mailbox configuration form or the
    Reply To field of the messages form contains a value, the message header
    will contain the Reply To header value as set in the message, regardless of value of this property.

Valid values:

  • True (Default)
  • False

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
IncomingConnectionRecycleSize 2

Specifies the default number of email messages the email engine receives before
the connection is closed and reopened. In the 5.1 and 5.1.1 releases of the email engine,
the connection with the mail server was closed only after reading all incoming messages.
Consequently, if the email engine crashed or hung before the connection was closed,
it was possible that messages marked for deletion would not be deleted from the mail server.
This property helps you avoid that situation.

Default value: 100

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
IncomingMessagesQueueSize 2

Specifies the message queue size (number of emails). The Receiver module
writes messages to the queue, and the Execution module reads messages from this
queue to parse and execute. The Receiver module still writes messages to the server in
AR System Email Messages form, but the Execution module reads the message from the
message queue instead of from the server. This reduces the traffic to the AR System server
and improves the performance.

Default value: 100

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
instructionCacheSize 2

Specifies the number of instructions to be stored in the cache, which is used to improve performance.
If the value of this property is set to 15, the cache already contains 15 instructions,
and another instruction is to be added, then the oldest instruction is removed to
accommodate the newest one.

Note: If any changes are made to the BMC Remedy AR System Email Instructions form,
the instruction cache is flushed based on the setting of the serverName.Interval property.

Default value: 20

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.Mailboxes 2

If you run multiple instances of the email engine on a single server, this property specifies
which mailboxes should the email engine process. The value of this property should contain
comma-separated mailbox names; the email engine only processes these mailboxes.
If you do not specify a value, the email engine processes all of the mailboxes configured for the server.

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
MailboxPollingUnitIsMinutes 2

Specifies whether the polling interval is to be considered in minutes (as configured in
AR System Email Mailbox Configuration form) or seconds. The email engine interprets
the value of this property as follows:

  • true — Consider the polling interval in minutes.
  • false — Consider the polling interval in seconds.

Note: Whatever measure of unit you select applies to all configured mailboxes that are enabled.

Valid values:

  • True (Default)
  • False

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
MaxAttachSize
and com.bmc.arsys.
emaildaemon
.MaxAttachSizeFileExtensions 2

Specifies the attachment types that you want to permit in an email message and the
maximum size of each attachment. MaxAttachSize specifies the maximum size limit
for attachments, whereas MaxAttachSizeFileExtensions specifies the file types by
using comma-separated extensions. These properties must be used together to impose limits
on email attachments of specific file types. For example, to set the maximum size of
.doc, .pdf, and .xls attachments to 1000000 bytes (1 MB), use the following syntax: com.bmc.arsys.emaildaemon.MaxAttachSize=1000000 com.bmc.arsys.emaildaemon. MaxAttachSizeFileExtensions=doc,pdf,xls The size limit is not imposed on files
whose extensions are not specified by using MaxAttachSizeFileExtensions.
Email messages with attachments that exceed this limit are logged to the
AR System Email Error Logs form. Optionally, you can create workflow for this form
to process such messages separately.

Valid values:

  • True
  • False (Default)

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
MBOXFromLineWith-At-The-Rate-Sign 2

The email engine interprets the value of this property as follows:

  • true — BMC Remedy Email Engine fetches only those messages that contain
    the @ sign in the "from line" (from address).
  • false — BMC Remedy Email Engine fetches all the messages.

Valid values:

  • True
  • False (Default)

Related functionality: Incoming and Outgoing

Related protocol: MBOX

No  

com.bmc.arsys.emaildaemon.Monitor 2

Specifies the interval in minutes between checks to see if all the threads are functioning properly.

Note: If the monitoring system detects that a thread has failed, it restarts the thread.

Default value: 30 minutes

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
NumberOfSenderThreads 2

Specifies the number of sender threads that the email daemon uses for each outgoing mailbox.
The optimum number of threads depends on many factors including the number of mailboxes,
the hardware configuration, and so on.

Valid values: 1 through 20

Default value: 4

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
OutgoingMessagesQueueSize 2

Specifies the size of the queue that the email daemon maintains for outgoing messages.
The optimum number of message queue size to be specified depends on the load on the email daemon.

Note: This value is used to determine when to query the database. If you set a very high value,
the database is queried too often, which might reduce the performance.

Default value: 100

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
SaveSentItem 2

Specifies whether to retain messages in the Email Messages form after sending.
To delete sent messages from the Email Messages form, set this property to False.

Valid values:

  • True (Default)
  • False

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
securityCacheSize 2

Specifies the number of security keys to be stored in the cache. If the value of this property
is set to 15, the cache already contains 15 security keys, and another key is to be added,
then the oldest key is removed to accommodate the newest one.

Note: If any changes are made to the BMC Remedy AR System Email Security form,
the security cache is flushed based on the setting of the serverName.Interval property.

Default value: 20

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No 

com.bmc.arsys.emaildaemon.
SendEmailSetSize 2

Specifies the number of outgoing emails to query at a time.

Default value: 100

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
SMTPTimeout 2

Specifies whether to wait before cancelling an attempt to connect to the mail server and
generating an error. In case of an SMTP timeout, the email engine waits for the timeout interval
and then marks the queued message as erroneous.SMTPTimeout is not used by default.
If you want the email engine to use this property, you must add it to EmailDaemon.properties
and set its value to true. If you add the property but do not specify a value, it is considered as false.

Valid values:

  • True 
  • False (Default)

Related functionality: Outgoing

Related protocol: SMTP

No  

com.bmc.arsys.emaildaemon.
SMTPTimeoutPeriod 2

Specifies the duration in number of seconds to wait before cancelling an attempt to
connect to the mail server and generating an error. In case of an SMTP timeout,
the email engine waits for this interval and then marks the queued message as an
erroneous. SMTPTimeoutPeriod is not used by default. If you want the email engine to
use this property, you must add it to EmailDaemon.properties and set its value to
any positive integer (upper limit depends on the platform). If you add the property
but do not specify a value, it is considered as half the polling interval that is set for outgoing mailboxes.

Note:SMTPTimeoutPeriod is dependent on SMTPTimeout ; it works only when
SMTPTimeout
is set to true.

Related functionality: Outgoing

Related protocol: SMTP

No 

com.bmc.arsys.emaildaemon.SortMessages 2

Specifies whether to process messages with a higher priority setting first.

Valid values:

  • True 
  • False (Default)

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
StoreInstructions 2

Specifies whether to store instructions and instruction parameters in the AR System server.
If set to true, the email engine retains data in the Email Instructions and
Instruction Parameters forms for troubleshooting. Then, you must delete this data explicitly.
The Execution module in the BMC Remedy Email Engine handles both the
parsing and execution of messages. There will be one message queue created for
each Incoming mailbox. By default, instructions are not stored in the server.

Valid values:

  • True 
  • False (Default)

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
SynchronizedLoggingMode 2

This property is not available by default. You can add it if required. If this property is not present in EmailDaemon.properties, or if it is present but set to false, the bulk
API logging mode is used. If this property is present in EmailDaemon.properties
and its value set to true, then the synchronized logging mode is used.

Note: The email engine's performance might degrade when synchronized logging is enabled,
because all the email engine threads are suspended while processing the synchronized logs.
Synchronized logging continues to occur periodically, and control is restored
to the threads only after the logging is over.

Valid values:

  • True 
  • False (Default)

Related functionality: Incoming and Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
templateCacheSize 2

Specifies the number of email templates to be stored in the cache to
improve the performance. If the value of this property is set to 15,
the cache already contains 15 templates, and another template is to be added,
then the oldest template is removed to accommodate the newest one.

Note: If any changes are made to the BMC Remedy AR System Email Templates form,
the templates cache is flushed based on the setting of the serverName.Interval property.

Default value: 20

Related functionality: Incoming

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
URLWithHrefTag 2

Specifies whether an <a href> tag is placed around a URL in an HTML message.
If the setting is true, the <a href> tag is used. If the setting is false,
the URL is not enclosed in an <a href> tag.

Valid values:

  • True (Default)
  • False

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
UseNameIfNoEmailAddress 2

Specifies whether to retain display names that do not have email addresses associated
with them in the To, CC, or BCC fields. If the setting is true, the display names are
not removed from the To, CC, or BCC fields. If the setting is false,
the display names are removed from the To, CC, or BCC fields.

Note: The email engine checks for email addresses associated with display names
only on the User form and not on the Exchange server.

Valid values:

  • True (Default)
  • False

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
UserChunkSize 2

Specifies the number of users (records from the User form) to retrieve
from the AR System server at one time. This setting can be used to tune the
email engine's performance.

Default value: 5000

Related functionality: Outgoing

Related protocol: All Supported

No  

com.bmc.arsys.emaildaemon.
AdminAddresses 2

Specifies the email address of the administrator. If a database transaction fails
while storing an incoming message, the email engine forwards the original mail to
this email address, so that it is retained. An example of a transaction failure could be
when the database is full and cannot save anymore incoming email messages.
You can specify multiple addresses separated by commas.

Note: This property can be used only when the BMC Remedy Email Engine
does not capture the error out incoming email messages in the
BMC Remedy AR System Email Error Messages Form.

Default value: Default value is set to the administrator address specified during installation.

Related functionality: Incoming

Related protocol: All Supported

No  
Configuration-Name  2

Name of the component.

AR System server uses this option to identify the active component in the database.

No  
Create-Entry-DeadLock-Retries  2Number of times to retry the ARCreateEntry() function during deadlock situations.
Value is an integer.
No  
Create-Entry-DeadLock-Retries-Delay 2Delay, in seconds, between each retry of a deadlocked ARCreateEntry() function.
Value is an integer.
No  
Crossref-Blank-Password

Flag indicating how the system responds when a user's logon name is not assigned
a password in the User form. Valid values:

  • T — The system tries to validate the password in the Windows server domain
    (or through the External Authentication API if external authentication is on)
    or against the UNIX server /etc/passwd file.
  • F — (Default) Blank passwords are not cross-referenced.

    This option enables you to manage group membership and other support information
    with AR System while managing passwords with the /etc/passwd file
    (UNIX) or the server domain security model (Windows).
No  
Currency-Ratio-Client-Refresh-Interval  2Number of minutes between each refresh of currency conversion ratios on the client.No  
Db-Case-Insensitive 1

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:

  • T — Performs case-insensitive search. Setting this parameter in the ar.cfg (ar.conf)
    file causes special session parameters (NLS_SORT and NLS_COMP) to be set to
    support case-insensitive searches and invalidate existing database indexes.
    By default, the AR System server creates regular indexes when you add an index to a form.
    To support case-insensitive searches on Oracle databases, functional indexes
    are required instead of regular indexes. 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.
    The Db-Functional-Index parameter is ignored if Db-Case-Insensitive is set to F
    or if it is absent from the ar.cfg file.
    The Db-Case-Insensitive and Db-Functional-Index parameters handle new indexes.
    In the database (outside of the AR System server), you must manually convert any
    existing indexes to functional indexes. BMC provides an unsupported
    OracleFunctionalIndexHelper.bat
    utility to manage these existing indexes
    and to convert them from regular to functional indexes. You can find this unsupported utility in the ARServerInstallDirectory\Arserver\api\lib folder.
    Due to known issue with Oracle, set cursor sharing to EXACT so that the
    query optimizer can use functional indexes for LIKE queries. For help,
    see your database administrator.

    Note: While running the OracleFunctionalIndexHelper.bat utility for existing forms,
    you might see the following error:
    Error message ERROR (552): The SQL database operation failed.; ORA-00942:
    table or view does not exist.

    This occurs because indexes are not applicable on vendor, view, display-only, and join forms.
  • F (the default) — Performs case-sensitive queries.

For optimal performance when using database indexes for case-insensitive searches on Oracle,
ensure that:

  • The database administrator sets cursor sharing to EXACT for the functional indexes that
    Oracle Optimizer will use (otherwise, performance can be severely degraded due to full table scans).

Note: Depending on the volume of data, creating functional indexes may take a long time.

No  
Db-Character-Set  2

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:

  • Unicode (UTF-16) — UTF-16 UCS-2
  • Unicode (UTF-8) — UTF-8

Note: The installer sets this option's value.

No  
Db-Connection-Retries  2Number 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 15 seconds up to the specified number of times. For example,
when this option is set to 100, the server retries the connection once every 15 seconds for a duration of 25 minutes.
No  
Db-Custom-Conn-Props

Use this optional property to set the custom connection properties on a database connection. This property is database-specific. For example, Cipher suites, trustStore.

Format

Db-Custom-Conn-Props: key1=value1;key2=value2

Example

Db-Custom-Conn-Props: encrypt=true;trustServerCertificate=true

When you specify the Oracle-JDBC-URL parameter, the BMC Remedy AR System server ignores this option. For more information, see Configuring Oracle databases .

NoAR System Configuration Generic UI form
Db-Host-Name  2Logical server name of the underlying database.No 
Db-Max-Attach-Size  2

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.

No 
Db-Max-Text-Size  2(Oracle, 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.
No 
Db-name 1For 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.
No 
Db-password(Microsoft SQL Server, 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.
No 
Db-Type  1

The type of database the AR System server is connecting to. Valid values:

  • Microsoft SQL Server
  • Oracle
  • Mysql
No 
Db-user 1(Microsoft SQL Server, Oracle) User name that AR System uses
to access the underlying database. The default is ARAdmin.
No 
Dev-Studio-ThreeWay-Recon-PackingListContains name of the packing list used by BMC Remedy Developer Studio for 3-way reconciliation changed objects.NoAR System Configuration Generic UI form
Debug-GroupIdName 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.
No  
Debug-mode

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.

  • Bit 1 (value = 1 ) — (SQL databases only) Turns on SQL logging in the
    default arsql.log file. To specify a different file, use the SQL-Log-File option.
  • Bit 2 (value = 2 ) — Turns on filter logging in the default arfilter.log file.
    To specify a different file, use the Filter-Log-File option.
  • Bit 3 (value = 4 ) — Turns on user logging in the default aruser.log file.
    To specify a different file, use the User-Log-File option.
  • Bit 4 (value = 8 ) — Turns on escalation logging in the default arescl.log file.
    To specify a different file, use the Escalation-Log-File option.
  • Bit 5 (value = 16 ) — Turns on API logging in the default arapi.log file.
    To specify a different file, use the API-Log-File option.
  • Bit 6 (value = 32 ) — Turns on thread logging in the default arthread.log file.
    To specify a different file, use the Thread-Log-File option.
  • Bit 7 (value = 64 ) — Turns on alert logging in the default aralert.log file.
    To specify a different file, use the Alert-Log-File option.
  • Bit 9 (value = 256 ) — Turns on server group logging in the default arsrvgrp.log file.
    To specify a different file, use the Server-Group-Log-File option.
  • Bit 10 (value = 512 ) — Turns on logging for full text indexing in the default arftindx.log file.
    To specify a different file, use the Full-Text-Indexer-Log-File option.
  • Bit 16 (value = 32768 ) — Turns on DSO server logging in the default ardist.log file.
    To specify a different file, use the Distrib-Log-File option.
  • Bit 17 (value = 65536 ) — Turns on Approval Server logging.
    To specify the location for the arapprov.log file, use the
    Approval Menu > Server Settings > AP: Admin-Server Settings form.
  • Bit 18 (value = 131072 ) — Turns on plug-in logging in the default arplugin.log file.
    To specify a different file, use the Plugin-Log-File option.
 No 
Default-Allowable-CurrenciesDefault allowable currency types for currency fields in clients. No 
Default-Functional-CurrenciesDefault functional currency types for currency fields in clients. No 
Default-Order-By  2

Flag indicating whether to apply the default sort order to search results. Valid values:

  • T — (Default) Use the default sort order, which is to sort by request ID.
  • F — No default sort order exists, and no order by clause is added to
    the command if a sort order is not specified.
 No 
Default-Web-Path

URL to the directory path for the default web server pointing to the
BMC Remedy AR System server.

 NoThe Default Web Path field on the Advanced tab of the AR System Administration: Server Information form. (See Setting performance and security options.)
Delay-Recache-Time   2

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.

 NoThe Recache Delay field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Dev-Studio-Development-Mode

Indicates whether you can use BMC Remedy Developer Studio in the Best Practice Mode,
Base Mode or both. Valid values:

1 — Allows you to work in the Base Mode

— (Default) Allows you to work in the Best Practice mode

3 — Enable both the modes

 No 
Disable-Admin-Ops

Flag indicating whether administrative operations are allowed on the server. Valid values:

  • F — Enabled (Default)
  • T — Disabled  

If the Server Groups 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.

 NoThe Disable Admin Operations field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-Admin-Ops-Global

Flag indicating whether administrative operations are allowed on all the servers.
Valid values:

  • F — Enabled (Default)
  • T — Disabled

In a server group environment:

  • This configuration setting is shared among all the servers.
  • If you set this parameter on any of the servers, it will be applicable for all the servers.

For non-server group environment, this parameter is same as Disable-Admin-Ops.
If you configure this parameter, Disable-Admin-Ops is automatically updated with the same value.

You can set the parameter value from the AR System Administration Console
using the following steps:

  1. Open AR System administration console.
  2. Click System > General > Centralized Configuration.
  3. Select com.bmc.arsys.server.shared > shared. The list of already
    added shared parameters appears.
  4. Add new parameter with name Disable-Admin-Ops-Global and set the
    value as F or T to enable or disable admin operations.

Note: You can also update the parameter using these steps, if it already exists.

 Yes 
Disable-Alerts

Flag indicating whether alerts are sent when alert events are created. Valid values:

  • T — No threads are started in the alert queue, and no alerts are sent.
  • F — (Default) Alerts are enabled.

    Changes to this setting do not take effect until the server is restarted.
No The Disable Alerts field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-Archive  2

Switch that disables (T ) or enables (F ) the archive when the server starts.

No The Disable Archive field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-Archive-Global

Switch that disables (T ) or enables (F - default) the archive when the server starts.

In a server group environment:

  • This configuration setting is shared among all the servers.
  • If you set this parameter on any of the servers, it will be applicable for all the servers.

For non-server group environment, this parameter is same as Disable-Archive.
If you configure this parameter, Disable-Archive is automatically updated with the same value.

You can set the parameter value from the AR System Administration Console
using the following steps:

  1. Open AR System administration console.
  2. Click System > General > Centralized Configuration.
  3. Select com.bmc.arsys.server.shared > shared. The list of already added
    shared parameters appears.
  4. Add the parameter with name Disable-Archive-Global and set the value as F or T
    to enable or disable archive operations.

Note: You can also update the parameter using these steps, if it already exists.

 Yes 
Disable-ARSignals   2

Flag indicating whether automatic signals triggered by changes to the following data
on a server group's administrative server are disabled:

  • Archive definitions
  • Escalation definitions
  • Group information from the database

    The signals can be generated by arsignald or the database.
    Signals triggered by changes to user, licensing, and computed group information
    are not disabled. Valid values:
  • T — The specified signals are disabled.
  • F — (Default) Automatic signaling remains in effect for all object definition changes.

    To send the disabled signals manually, use the arsignal program
    (see arsignal.exe or arsignal). See Signaling mechanism in a server group.
 NoThe Disable ARSignals field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-Audit-Only-Changed-Fields

Flag indicating whether to audit all records (T ), or to audit only those records
whose field values have changed (F, the default).

 NoThe Disable Audit Only Changed Fields field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-Client-Operation
  2

Option that restricts time-consuming operations (such as reporting) during busy times,
improving overall performance. The syntax is

Disable-Client-Operation: <tagNumberToDisable> 
[[<startTime>]-[<stopTime>]] [<groupIDList>]
  • The tag number identifies the client whose operations are restricted.
    It is defined in the ar.h file. See the list at the end of this description.
  • (Optional) To specify start and stop times for the restriction,
    enter them in 24-hour format (hh:mm ). The times are include times.
    For example, 00:00-13:59 disables the operations from midnight until 1:59 P.M.

    If you do not specify a start or stop time, the syntax looks like this:
    Disable-Client-Operation: 2 18:00- 10

    To disable operations from midnight until 6:00 A.M., enter this:
    Disable-Client-Operation: 2 -6:00 10

    If no start and stop times are specified, the operations are disabled all the time.
  • (Optional) The groupIDList is a list of groups whose users can run
    the operations during the specified time period. For example,
    you can allow only the administrator to run reports during busy hours.
    Enter none, one, or multiple group IDs delimited by spaces. For example,
    to exempt group 10, enter this: Disable-Client-Operation: 1 13:00-17:59 10
    If no groups are specified, all users are barred from running the operations
    during the specified time period. You can enter multiple Disable-Client-Operation lines.

    Following are the Disable-Client-Operation tag numbers:
  • 1 — AR System clients prior to the 5.0 version
  • 2 — BMC Remedy Administrator (pre-7.5.00)
  • 4 — BMC Remedy Import (pre-7.5.00)
  • 5 — AR System Distributed Server Option
  • 6 — AR System ODBC
  • 7 — AR System Approval Server
  • 8 ---AR System web server (waserver)
  • 9 — Mid tier (version 5.0 and later)
  • 10 — Palm Pilot
  • 11 — Flashboards
  • 12 — Flashboards mid tier
  • 13 — Enterprise integration
  • 14 — arreload
  • 15 — arcache
  • 16 — ardist
  • 17 — runmacro
  • 18 — armaild, armailex (pre-5.1)
  • 20 — Report creator plug-in
  • 36 — BMC Remedy Developer Studio
  • 4000 — Driver (sample program)
  • 4001 — Distributor of application
  • 4002 — arhelp
  • 4003 — arjanitor
  • 4004 — armenu
  • 4005 — arstruct
  • 4006 — artext
  • 4007 — arsqled
  • 4008 — archgsel
 No 
Disable-Escalations

Switch that disables (T ) or enables (F - default) the escalations when the server starts.
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.

 NoThe Disable Escalations   field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-Escalations-Global

Switch that disables (T ) or enables (F - default) the escalations when the server starts..

In a server group environment:

  • This configuration setting is shared among all the servers.
  • If you set this parameter on any of the servers, it will be applicable for all the servers.

For non-server group environment, this parameter is same as Disable-Escalations.
If you configure this parameter, Disable-Escalations
is automatically updated with the same value.

You can set the parameter value from the AR System Administration Console
using the following steps:

  1. Open AR System administration console.
  2. Click System > General > Centralized Configuration.
  3. Select com.bmc.arsys.server.shared > shared.
    The list of already added shared parameters appears.
  4. Add new parameter with name Disable-Escalations-Global and set the
    value as F or T to enable or disable escalations.

Note: You can also update the parameter using these steps, if it already exists.

Yes  
Disable-New-RLS-Implementation

(Version 9.0.01 onwards) This parameter specifies the RLS implementation used. This parameter improves the performance of SQL queries for applying row level security.

Valid values:

  • T — Turns off "New" RLS implementation.
  • F — (Default) Turns on "New" RLS implementation.
YesAR System Configuration Generic UI form
Disable-Non-Unicode-Clients

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:

  • T — Unicode servers refuse requests from non-Unicode clients.
  • F — (Default) Unicode and non-Unicode clients can contact Unicode servers.
 NoThe Disallow Non Unicode Clients field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Disable-User-Cache-Utilities

Flag that prevents unauthorized users from using User Cache commands. Valid values:

  • T — The *arreload* and arcache utilities are disabled for the AR System server.
  • F — (Default) Cache utilities are enabled.
 No 
Dispatch-Log-File 

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:

  1. In a browser, open the BMC Remedy AR System Administration Console, and click System > General > Centralized Configuration.
  2. In the AR System Configuration Generic UI form, from the Component Name list,
    select com.bmc.arsys.server > <servername>.
  3. Click Add.
  4. Enter the name of the setting that you want to add and its value.
    For example, Dispatch-Log-File and the location to the log file.
  5. Click Apply and Close.
  6. To invoke this setting, restart arserver.
    The armonitor restarts the dispatcher logging and locates the log file on the specified location.
NoAR System Configuration Generic UI form
Display-General-Auth-Message 2

Flag indicating whether to display a message when user authentication fails. Valid values:

  • T— (Default) A generic message is displayed for user name and password errors:
    • ARERR 623 Authentication failed
    • ARERR9388Authentication failed
  • F— Each authentication error displays a different message:
    • ARERR 624 User account locked out due to too many bad password attempts
    • ARERR9381 No such user is registered with this server
    • ARERR9382Invalid password or authentication string for existing user

This parameter can be used in conjunction with Max-Password-Attempts. See Configuration settings E-M.

 No 
Distrib-Log-FileFull path name of the file to use if DSO server logging is on (see Debug-mode). No 
Domain-Name 2New 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.
 No 
DSO-Cache-Check-Interval

Number of seconds between occurrences of these operations:

  • DSO checks for changes to the source and target forms
  • Updates of cached DSO mapping information

    By default, this option is set to 1800 seconds (30 minutes).
    The maximum value is 43200 seconds (12 hours).
 No 
DSO-Error-Retry-Option

DSO server retry behavior after an error:

  • 0 — (Default) Retry after standard connection and transmission errors.
  • 1 — Never retry after any error.
  • 2 — Retry after every error.
  • 3 — Retry after standard connection and transmission errors and
    after database errors.
 No 
DSO-Local-RPC-Socket

RPC program number that DSO uses. This setting is optional.

 NoThe 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.)
DSO-Log-Level

Level of logging for all DSO logs (ardist.log, ardist.log.default, ardist. poolName.log,
and ardist.log. poolName ):

  • 0 — Logs only errors. Includes contextual information.
  • 1 — Logs errors and warnings. Includes contextual information.
  • 2 — Logs errors, warnings, and other information to provide a
    step-by-step record of DSO activities.
 No 
DSO-Main-Thread-Polling-IntervalInterval 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).
 No 
DSO-Mark-Pending-Retry-Flag

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:

  • T — (Default) Does not set the status to Retry. Instead,
    the status remains set to New. Depending on the number of pending items
    that the DSO server processes, this setting might improve the server's performance.
  • F — Sets the status to Retry. Use this to differentiate items in the queue
    that have never been processed (status = New) from items that were
    processed but failed because of recoverable errors (status = Retry).

    Note: Regardless of this option's value, the pending item is retried
    based on its retry configuration.
 No 
DSO-Max-Pending-Records-Per-QueryMaximum 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.
 No 
DSO-Merge-DupID-Overwrite 2

The way the DSO server behaves when it finds a duplicate request ID on the target server. Valid values:

  • T — Updates mapped fields and sets unmapped fields to NULL.
  • F — (Default) Updates only the mapped fields on the target request.
 No 
DSO-Placeholder-ModeMode 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.
 No 
DSO-Polling-IntervalInterval (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.
 No 
DSO-Source-ServerThe 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.
 No 
DSO-Supress-No-Such-Entry-For-Delete

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:

  • T — Do not log ARERR 302 during distributed deletes.
  • F — (Default) Log ARERR 302 during distributed deletes except
    when the DSO-Error-Retry-Option is set to 2 (retry after every error).

    Note: When this option is set to T, errors caused by valid problems
    might also be omitted from the log.
 No 

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.

Was this page helpful? Yes No Submitting... Thank you

Comments