Error: Invalid spaceKey on retrieving a related space config.

Configuration settings A-B

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, click Full screen in the upper-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 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 settings (A-B)

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 ...

SettingDescriptionServer group configuration Maps to
Access-Control-Allow-Credentials
(Component name: com.bmc.arsys.server.shared)

This setting indicates whether credentials are allowed in a cross-origin request.

Valid values:

  • True — Credentials are allowed.
  • False Credentials are not allowed.
No

AR System Administration Console > System > General > Centralized Configuration

Access-Control-Expose-Headers
(Component name: com.bmc.arsys.server.shared)

(Optional) This setting indicates the HTTP request headers that are exposed to the browser for cross-origin requests.

Valid values:

  • * — All HTTP request headers are allowed.
  • Comma separated header names — Describe the comma separated header list . For exanple, Content-Type, Authorization.
NoAR System Administration Console > System > General > Centralized Configuration
Access-Control-Allow-Headers
(Component name: com.bmc.arsys.server.shared)

This setting indicates the HTTP request headers that are allowed for cross-origin requests.

Valid values:

  • * — All HTTP request headers are allowed.
  • Comma separated header names — Describe the comma separated header list . For exanple, Content-Type, Authorization.
NoAR System Administration Console > System > General > Centralized Configuration
Access-Control-Allow-Methods
(Component name: com.bmc.arsys.server.shared)

This setting indicates the HTTP methods that are allowed for cross-origin requests.

Valid values:

  • * — All HTTP methods are allowed.
  • Comma separated method names — Describe the comma separated methods list . For exanple, GET,POST,PUT,OPTIONS.
NoAR System Administration Console > System > General > Centralized Configuration

Access-Control-Allow-Origin
(Component name: com.bmc.arsys.server.shared)

A header that indicates cross-origin requests are allowed.

This setting indicates the origins that can make REST API calls on the AR System Server. An origin consists of a protocol, host, and port number.

Valid values:

  • * — All domains are allowed (Not recommended)
  • Comma separated origins — Describe the comma separated list of multiple origins. For exanple, http://localhost:8080,http://www.example.com
NoAR System Administration Console > System > General > Centralized Configuration
Active-Link-Dir

Directory in which active link server run processes are stored. Only commands in the specified directory can be run. This is a security feature that ensures clients or API programs use only a safe set of server processes.

No

AR System Administration Console > System > General > Server Information > Advanced > Security section > Active Link Run Process Directory.

(See Setting performance and security options.)

Active-Link-Shell

(UNIX only) Parent shell of any active link server process. This parameter causes the server to start the shell with the specified process as a parameter. This is a security feature. The specified shell might be a security shell that verifies a path or runs with a user ID other than the one the server uses. For example, if the server runs as root and an administrator specifies a shell that runs as a lower user privilege, an active link invokes the shell that runs as a user instead of as root. Because the AR System server passes the shell command to the Active-Link-Shell as a single string without any other command-line arguments, the command parameters can often be interpreted incorrectly. As AR System server does not know which custom shell must be used for active link processing, it cannot supply all of the necessary arguments. To avoid this and use the Active-Link-Shell Feature correctly, follow the steps listed below:

  1. Determine what your desired shell is, and how to invoke it passing a single command line. If the desired shell is /bin/csh, the correct way to invoke with a single command line is

    "/bin/csh" "-c" "process command"
  2. Write a /bin/shscript that invokes your custom shell in the required manner, as shown below:

    #!/bin/sh
    # Usage:
    #    /path/to/arsystem-csh-helper process-command
    # Pass process-command as a command line to /bin/csh.
    #
    # use "$*" preserve argument as a single string
    exec /bin/csh -c "$*"
  3. Put the script in a location where the AR System server will be able to call it. For example, local utilities are often installed in a directory named /usr/local or /usr/local/bin. Another good location might be the AR System server installation directory. Be sure to mark the new program executable:

    # cp arsystem-csh-helper /usr/local/arsystem-csh-helper
    # chmod 755 /usr/local/arsystem-csh-helper
  4. In the AR System server configuration, change the Active-Link-Shell to be the new program /usr/local/arsystem-csh-helper.
No AR System Administration Console > System > General > Server Information > Advanced > Security section > Active Link Run Process Shell.(See Setting performance and security options.)
Admin-Only-Mode

Flag indicating whether only administrators and subadministrators can access the server.

Valid values:

  • T — Admin-only mode is on.
  • F(Default) Admin-only mode is off.
No 

AR System Administration Console > System > General > Server Information > Configuration > Administrator-Only Mode.

(See Setting administrative options.)

AE-Log-Enabled

(Component name: com.bmc.arsys.assignment)

Flag indicating whether the Assignment Engine logging is enabled.

Valid values:

  • 1(Default) Assignment Engine logging is disabled.
  • 0 — Assignment Engine logging is enabled.
No

Assignment Engine Administration Console > Sever Settings > Enable Assignment Engine Logs.

AE-Log-File

(Component name: com.bmc.arsys.assignment)

File name for assignment engine logs.

Restart Required — No

 Assignment Engine Administration Console > Sever Settings > Log File Name

AE-Logging-Level

(Component name: com.bmc.arsys.assignment)

Indicates the type of logging level.

Valid values:

  • (Default) INFO
  • DEBUG — The maximum logging level
  • ERROR —  The minimum logging level
 
No 

Assignment Engine Administration Console > Sever Settings > Log File Level.

AE-Max-Log-File-Backups

(Component name: com.bmc.arsys.assignment)

Indicates the 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. 

Default value: 0

 

 

No 

Assignment Engine Administration Console > Sever Settings > Max Back-up Index.

(See Configuring the Assignment Engine server settings ).

AE-Max-Log-File-Size

(Component name: com.bmc.arsys.assignment)

Indicates the maximum size (in megabytes) for the log file. 

Default value: 10 MB

No 

Assignment Engine Administration Console > Sever Settings > Max Log File Size.

AE-Poll-Interval

(Component name: com.bmc.arsys.assignment)

Interval (in minutes) at which the Assignment Engine polls the BMC Remedy AR System server. If this option is not specified, the polls occur every 4 minutes.

Default value: 4 minutes

No 

Assignment Engine Administration Console > Sever Settings > Polling Interval.

AE-Worker-Threads

(Component name: com.bmc.arsys.assignment)

Indicates the total number of worker threads that process various assignment requests. 

 Default value: 3

No

Assignment Engine Administration Console > Sever Settings > Number of Threads.

(See Configuring the Assignment Engine server settings).

Allow-Backquote-In-Process-String

Option that enables the server to run a process with a backquote in the process name or in its arguments.

Valid values:

  • T — Allows the server to run a process with a backquote.
  • F (Default) — Does not allow the server to run a process with a backquote.
NoAR System Configuration Generic UI form. 
Allow-Guest-Users

Flag indicating whether the BMC Remedy AR System server accepts guest users (users not registered with BMC Remedy AR System in a User form).

Valid values:

  • T(Default) Allow guest users. Unregistered users have no permissions but can perform some basic operations. For example, they can submit requests to forms to which the Public group has access and whose fields allow any user to submit values.
  • F — Do not allow guest users. Unregistered users have no access to the system.

The default value is set to F.

No 

AR System Administration Console > System > General > Server Information > Configuration > Allow Guest Users.

(See Setting administrative options.)

Allow-Unqual-Queries

(Component name: com.bmc.arsys.server)

Flag indicating whether unqualified searches can be performed on the BMC Remedy AR System server. Unqualified searches are ARGetListEntry or ARGetListEntryWithFields calls in which the qualifier parameter is NULL or has an operation value of 0 (AR_COND_OP_NONE ). Such searches can cause performance problems because they return all requests for a form. This is especially problematic for large forms.

Valid values:

  • T (Default) Allow unqualified searches.
  • F — Do not allow unqualified searches.

The default value is set to F.

 NoAR System Administration Console > System > General > Server Information > Configuration > Allow Unqualified Searches. (See Setting administrative options.)

Alternate-Approval-Reg2

(Component name: com.bmc.arsys.approval)

Flag indicating how applications such as Approval Server or Reconciliation Engine listen for the BMC Remedy AR System server's signal.

Valid values:

  • T(Default) Listen for the application dispatcher to signal.
    If your application relies on the application dispatcher, set this option to T. To verify that arsvcdsp is configured to start with the BMC Remedy AR System server, check the armonitor.cfg (armonitor.conf ) file.
  • F — Listen for the server's signal directly.

Note:

  • The BMC Remedy AR System server installation creates this entry and sets the value to T.
  • You should change the value to F only when the application dispatcher is not working. This provides an alternative method to receive signals from the AR System server.
No AR System Configuration Generic UI form. 

AlwaysOn-Log-History

 

Number of Always On log file backups that you need to store.

Default value: 2

Yes 

AR System Administration Console > System > General > Server Information > Always On Logging > Maximum Backups.

(See Setting Always On logging.)   

API-Log-File

Full path name of the file to use if API logging is on (see Debug-mode).

No 

AR System Administration Console > System > General > Server Information > Log Files > API Log.

(See Setting log files options.)

API-Recording-Client-Type

Indicates the client types for which you want to monitor the API calls. By default, this field does not have any value set which means that the calls from all client types are monitored.
Use this format:

<clientType>;<ipAddressExpression>;<clientType>;<ipAddressExpression>
  • clientType — Indicates the client type to be monitor. This takes an integer value and a * value in this field indicates that API calls from any client type are monitored. For information on supported client types and their values, see Client types.
  • ipAddressExpression — Indicates a regular expression used to match the source address. This is an optional value to specify. If you do not specify any value, all source addresses are matched by default.
    For example, you might add the following values:
    • 0;1;2 — API calls from client types 0, 1, and 2 (all source addresses are matched).
    • 0 ^10\..;1;2* — API calls from client types 1 and 2 included (all source addresses are matched as the regular expression is not specified). API calls from client type 0 included if the source address is from an IP address starting with 10.
    • 0;* ^(?!10\.) — API calls from client type 0 ("unknown") are recorded (all source addresses are matched as the regular expression is not specified). API calls from all clients with a source address that does not start with 10 are included.
    • ^(?!10\.)(?!11\.) — API calls from all clients with a source address that does not start with 10 or 11 are included.
NoAR System Configuration Generic UI form. 
API-Recording-Enable

Specifies whether you want to enable the system for monitoring API calls.

Valid values:

  • Yes —  Indicates that monitoring is enabled.
  • No — (Default) Indicates that monitoring is disabled.
NoAR System Configuration Generic UI form.  
Application-Enable

This override flag allows to rename the application pending system form.

Default value — false



Approval-Debug-Type2

(Component name: com.bmc.arsys.approval)

This setting specifies the log level for approval server. Values are:

  • 0 — (Default) The minimum logging level for BMC Remedy Approval Server is NORMAL (or INFO).
  • 1 — The highest logging level for BMC Remedy Approval Server is ALL (or DEBUG).
NoAR System Configuration Generic UI form.  

Approval-Defn-Check-Interval 2

(Component name: com.bmc.arsys.server)

Interval (in seconds) at which Approval Server checks for changed or updated data in the data definition forms. NoAR System Configuration Generic UI form.  

Approval-Due-Soon2

(Component name: com.bmc.arsys.approval)

The duration after which the approval requests that are due for action are highlighted on Approval Central.

 NoAR System Configuration Generic UI form.  

Approval-Log-File 2

(Component name: com.bmc.arsys.server)

Full path of the Approval Server log file. NoAR System Configuration Generic UI form.  
Approval-Notify 2
(Component name: com.bmc.arsys.approval)

Flag indicating whether approval notifications are configured from the Server Settings dialog box. An Approval-Notify entry exists for each ID.

Warning: Do not change this option in the AR System Configuration Component Setting form. Instead, from the AP:Administration form, click the Server Settings link to open a dialog box with configuration settings for the Approval Server.

 NoAR System Configuration Generic UI form.  

Approval-Polling-Interval 2

(Component name: com.bmc.arsys.approval)

Interval at which the Approval Server polls the AR System server for pending work. This setting is intended as a backup method, not the primary contact method. Under normal circumstances, the AR System server or the Application Dispatcher (depending on the configuration) contacts the Approval Server when work is pending. When this option is specified, the Approval Server polls the AR System server only if it does not receive a signal from the AR System server in the specified time. Specify the interval in seconds. Minimum is 30 seconds. Maximum is 3600 seconds (one hour).

 NoAR System Configuration Generic UI form.  

Approval-Recent-History2

(Component name: com.bmc.arsys.approval)

The duration within which a user can see in the recent history an approval request that was submitted or acted upon. NoAR System Configuration Generic UI form.  

Approval-RPC-Socket 2

(Component name: com.bmc.arsys.server)

RPC Program Number that Approval Server uses when contacting BMC Remedy AR System. This enables you to specify a private BMC Remedy AR System server for Approval Server. NoAR System Configuration Generic UI form. 

AR-Max-Attach-Size 2

(Component name: com.bmc.arsys.server)

Maximum size (in bytes) of compressed attachments that can be sent to the AR System database from the AR System server. By preventing large attachments from being sent to the database, you can prevent excessive memory growth and reduce transmission time. This limit does not apply to attachments retrieved from the database by the AR System server. This option applies to all databases.

Note: To limit the size of compressed attachments that the server can retrieve from Oracle databases, use Db-Max-Attach-Size.

 NoAR System Configuration Generic UI form.  

ARDBC-LDAP-Base-DN 

(Component name: com.bmc.arsys.ldap.ardbc)

 

Base distinguished name (DN) to use instead of the root DN as the starting point for discovering vendor tables when you design vendor forms. For example: ARBDC-LDAP-Base-DN: CN=Users, DC=ldapesslab, DC=com.

 

 

No

AR System Administration Console > System > LDAP > ARDBC Configuration > Base DN For Discovery. 

(See Configuring the ARDBC LDAP plug-in.)

ARDBC-LDAP-Cache-MaxSize 

(Component name: com.bmc.arsys.ldap.ardbc)

Size limit (in bytes) for the cache. For no size limit, set this to 0.

Default value: 32768 bytes

No 

AR System Administration Console > System > LDAP > ARDBC Configuration > ARDBC Plugin Cache section > Maximum Size.

(See Configuring the ARDBC LDAP plug-in.) 

ARDBC-LDAP-Cache-TTL

(Component name: com.bmc.arsys.ldap.ardbc) 

Time limit (in seconds) that data remains cached. For no time limit, set this to 0.

Default value: 60 seconds

No

AR System Administration Console > System > LDAP > ARDBC Configuration > ARDBC Plugin Cache section > Time To Live.

(See Configuring the ARDBC LDAP plug-in.) 

ARDBC-LDAP-Cert-DB 

(Component name: com.bmc.arsys.ldap.ardbc)

Directory name of the certificate database. The cert8.db or cert7.db and key3.db certificate database files are in this directory. If the directory is not specified, the LDAP plug-in looks in the BMC Remedy AR System installation directory for these files. The path in this option is used only when ARDBC-LDAP-UsingSSL is set toT.

No 

AR System Administration Console > System > LDAP > ARDBC Configuration > Certificate Database.

(See Configuring the ARDBC LDAP plug-in.)

ARDBC-LDAP-Cert-Name 2

(Component name: com.bmc.arsys.ldap.ardbc)

Not yet implemented.  

ARDBC-LDAP-Chase-Referrals 2

(Component name: com.bmc.arsys.ldap.ardbc)

Flag that enables automatic referral chasing by LDAP clients.

Valid values:

  • T — Referrals are chased.
  • F — (Default) Referrals are not chased.

This option is for Microsoft Active Directories only.

No AR System Configuration Generic UI form

ARDBC-LDAP-Connect-Timeout 2

(Component name: com.bmc.arsys.ldap.ardbc)

Number of seconds that the plug-in waits for a response from the directory service before it fails. The minimum value is 0, in which case the connection must be immediate. The maximum value is the External-Authentication-RPC-Timeout setting. If a value is not specified, this option is set to the value of the External-Authentication-RPC-Timeout option (by default, 40 seconds).No AR System Configuration Generic UI form.

ARDBC-LDAP-DN-Timeout 2

(Component name: com.bmc.arsys.ldap.ardbc)

Number of seconds that the plug-in retains the base distinguished name (DN) used to access an LDAP ARDBC vendor form after the user becomes inactive.

Default: 3600 seconds

No AR System Configuration Generic UI form. 

ARDBC-LDAP-Drop-Large-Values 2

(Component name: com.bmc.arsys.ldap.ardbc)

Obsolete in version 7.0.00 and later.  

ARDBC-LDAP-Hostname 

(Component name: com.bmc.arsys.ldap.ardbc)

Host name of the system on which the directory service runs. If the host name is not specified, the ARDBC LDAP plug-in uses localhost as the host name. For example:ARDBC-LDAP-Hostname: server1.eng.remedy.com

No 

AR System Administration Console > System > LDAP > ARDBC Configuration > Host Name. 

(See Configuring the ARDBC LDAP plug-in.) 

ARDBC-LDAP-Key-DB 2Not yet implemented.  
ARDBC-LDAP-Key-Password 2Not yet implemented.  

ARDBC-LDAP-Page-Size 2

(Component name: com.bmc.arsys.ldap.ardbc)

Page size in the pagedResultsControl of the ARDBC LDAP plug-in search request. This specifies the number of entries to return per page from the external directory server to the client when processing a search request containing the pagedResultsControl. The maximum value is 100,000. The minimum value is 100. (See Using the ARDBC LDAP plug-in.)

Default value: 10,000

No AR System Configuration Generic UI form.  

ARDBC-LDAP-Port

(Component name: com.bmc.arsys.ldap.ardbc)

Port number on which the directory service listens for clients.

No 

AR System Administration Console > System > LDAP > ARDBC Configuration > Port Number.

(See Configuring the ARDBC LDAP plug-in.)

ARDBC-LDAP-Time-Format 2

(Component name: com.bmc.arsys.ldap.ardbc)

Format of LDAP date and time data.

Valid values:

  • 0--Generalized Time Format (YYYYMMDDHHMMSSZ ) This format is recognized by all LDAP servers and is recommended.
  • 1--AD Generalized Time Format (YYYYMMDDHHMMSS.0Z ) This format is recognized by Microsoft Active Directory servers only.
  • 2--UTC Time Format (YYMMDDHHMMSSZ )

This historical format does not indicate the century. It is not recommended.

No AR System Configuration Generic UI form.   

ARDBC-LDAP-Use-Cache 2

(Component name: com.bmc.arsys.ldap.ardbc)

Flag that enables caching of search requests. Values are T and F. After caching is enabled, search requests issued via the ARDBC plug-in are cached. Subsequent matching search requests are satisfied from the cache.NoAR System Configuration Generic UI form.   

ARDBC-LDAP-User-DN 

(Component name: com.bmc.arsys.ldap.ardbc)

Distinguished name (DN) of the user account that the ARDBC LDAP plug-in uses to search and modify the contents of the directory service. For example: ARDBC-LDAP-User-DN: server1\admin

No 

AR System Administration Console > System > LDAP > ARDBC Configuration > Bind User.

(See Configuring the ARDBC LDAP plug-in.) 

ARDBC-LDAP-UsingSSL

(Component name: com.bmc.arsys.ldap.ardbc)

Flag indicating whether to establish a secure socket layer (SSL) connection to the directory service. Values are T and F. If you use LDAP over SSL, you must also specify the file name of the certificate database used to establish the connection.

No 

AR System Administration Console > System > LDAP > ARDBC Configuration > Using Secure Socket Layer.

(See Configuring the ARDBC LDAP plug-in.) 

ARJdbc-Script-Execution-Status

(Component name: com.bmc.arsys.server.shared)

Flag indicating whether the scripts required for defining the database functions by using the AR System JDBC:Generic Db Functions form ran successfully. The AR System Server checks this value during startup and runs the scripts if the value is not set to Done.

Valid values:

  • Started—Indicates that the scripts execution has started and is in progress.
  • Done—Indicates that the scripts ran successfully.
  • Error—Indicates that the scripts failed due to an error.
YesAR System Administration Console > System > General > Centralized Configuration

AREA-LDAP-Bind-Password 

(Component name: com.bmc.arsys.ldap.ardbc)

Password of the user account that the AREA LDAP plug-in uses to find the user object when using the User Search filter. If the distinguished name (DN) is not specified, the AREA LDAP plug-in uses an anonymous login to find the user object. If the target directory service does not allow anonymous access, you must specify a DN and password; otherwise, the plug-in cannot determine the DN of the user.

 

AREA-LDAP-Bind-User 

(Component name: com.bmc.arsys.ldap.area)

Distinguished name (DN) of the user account that the AREA LDAP plug-in uses to find the user object when using the User Search filter. If the DN is not specified, the AREA LDAP plug-in uses an anonymous login to find the user object. If the target directory service does not allow anonymous access, you must specify a DN and password; otherwise, the plug-in cannot determine the DN of the user. For example: AREA-LDAP-Bind-User: ldapesslab\admin

No 

AREA-LDAP-Cert-DB 

(Component name: com.bmc.arsys.ldap.area)

Directory name of the certificate database. The cert8.db or cert7.db and key3.db certificate database files are in this directory. If the directory is not specified, the LDAP plug-in looks in the BMC Remedy AR System installation directory for these files. This path is used only when ARDBC-LDAP-UsingSSL is set to T.

No 

AR System Administration Console > System > LDAP > AREA Configuration > Directory Service Information section > Certificate Database.

(See Configuring the AREA LDAP plug-in.)

AREA-LDAP-Chase-Referral  2

(Component name: com.bmc.arsys.ldap.area)

Flag that specifies whether referral chasing is performed by the AD server or the AREA LDAP plug-in.

Valid values:

  • T — Referral chasing is performed by the AD server.
  • F — (Default) Referral chasing is performed by the AREA LDAP plug-in (via the third-party LDAP library).

This option is for Microsoft Active Directories only.

Note: To force referral chasing logic to be disabled, you must also specify the AREA-LDAP-Disable-Referral option.

No

AR System Administration Console > System > LDAP > AREA Configuration > Directory Service Information section > Chase Referral.

(See Configuring the AREA LDAP plug-in.)

AREA-LDAP-Connect-Timeout 

(Component name: com.bmc.arsys.ldap.area)

Number of seconds that the plug-in waits to establish a connection with the directory service. The minimum value is 0, in which case the connection must be immediate. The maximum value is the External-Authentication-RPC-Timeout setting. If a value is not specified, this option is set to the value of the External-Authentication-RPC-Timeout option (by default, 40 seconds).

No

AR System Administration Console > System > LDAP > AREA Configuration > Directory Service Information section > Failover Timeout.

(See Configuring the AREA LDAP plug-in.)

AREA-LDAP-Disable-Referral  2

(Component name: com.bmc.arsys.ldap.area)

Flag that disables all referral processes by the AREA LDAP plug-in.

Valid values:

  • T— Referrals are disabled.

    Note: This overrides the AREA-LDAP-Chase-Referral setting.

  • F — (Default) Referrals are not disabled. For information about how the referrals are processed, see ar.cfg or ar.conf options A-B. The referral option is for Microsoft Active Directories only. When connecting to a non-Microsoft Active Directory, BMC recommends disabling referral processing.
NoAR System Configuration Generic UI form.   

AREA-LDAP-Email 2

(Component name: com.bmc.arsys.ldap.area)

Name of the attribute that specifies the email address of the user. This attribute corresponds to the Email Address field in the BMC Remedy AR System User form. If the attribute is not specified, the specified default or a system default is applied.NoAR System Configuration Generic UI form.   

AREA-LDAP-Email-Default 2

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-Email parameter is not specified or has no value for the user.NoAR System Configuration Generic UI form.   

AREA-LDAP-Group-Base 

(Component name: com.bmc.arsys.ldap.area)

Base of the LDAP directory to search groups from. To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$ — User's distinguished name. This applies only to the Group Base Name and Group Search Filter. It does not apply to the User Base name and User Search filter.
  • $\AUTHSTRING$ — Value that users enter into the Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client accessing the AR System server.
No 

AR System Administration Console > System > LDAP > AREA Configuration > User and Group Information section > Group Base.

(See Configuring the AREA LDAP plug-in.)

AREA-LDAP-Group-Default 2

(Component name: com.bmc.arsys.ldap.area)

Default groups to which the user belongs if no group information is available from the directory service. If the user belongs to multiple groups, use a semicolon to separate them.No AR System Configuration Generic UI form.  

AREA-LDAP-Group-Filter 

(Component name: com.bmc.arsys.ldap.area)

LDAP search filter used to locate the groups to which the user belongs. To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$--- User's distinguished name. This only applies to the Group Base Name and Group Search Filter. It does not apply to the User Base Name and User Search Filter.
  • $\AUTHSTRING$ — Value that users enter into the Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client accessing the AR System server.
No 

AR System Administration Console > System > LDAP > AREA Configuration > User and Group Information section > Group Search Filter. 

(See Configuring the AREA LDAP plug-in.) 

AREA-LDAP-Hostname 

(Component name: com.bmc.arsys.ldap.area)

Host name of the system on which the directory service runs. If no value is specified, the AREA LDAP plug-in uses localhost as the host name.

No 

AR System Administration Console > System > LDAP > AREA Configuration > Directory Service Information section > Host Name.

(See Configuring the AREA LDAP plug-in.)

AREA-LDAP-Lic 2

(Component name: com.bmc.arsys.ldap.area)

Name of the attribute that identifies the type of write license issued. This attribute corresponds to the License Type field in the BMC Remedy AR System User form. If the attribute is not specified, the specified default or a system default is applied.NoAR System Configuration Generic UI form.   

AREA-LDAP-Lic-Default 2

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-Lic attribute is not specified or has no value for the user.NoAR System Configuration Generic UI form.  

AREA-LDAP-LicApp 2

(Component name: com.bmc.arsys.ldap.area)

Name of the attribute that identifies the type of application license issued. If the attribute is not specified, the specified default or a system default is applied.NoAR System Configuration Generic UI form.  

AREA-LDAP-LicApp-Default 2

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicApp attribute is not specified or has no value for the user.NoAR System Configuration Generic UI form.   

AREA-LDAP-LicFTS 

(Component name: com.bmc.arsys.ldap.area)

Name of the attribute that identifies the type of FTS license assigned to the user. If the attribute is not specified, the specified default or a system default is applied. No 

AR System Administration Console > System > LDAP > AREA Configuration > Defaults and Mapping Attributes to User Information section > Full Text Search License. 

(See Configuring the AREA LDAP plug-in.) 

 

AREA-LDAP-LicFTS-Default 

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicFTS attribute is not specified or has no value for the user. No AR System Configuration Generic UI form.   

AREA-LDAP-LicMask 

(Component name: com.bmc.arsys.ldap.area)

Attribute that specifies how to mask the license information returned from the AREA LDAP plug-in. Values are

  • 0--No licenses returned from the AREA LDAP plug-in are used.
  • 1--Write license from the plug-in is used.
  • 4--Reserved license from the plug-in is used.
  • 5--Reserved license and Write license from the plug-in are used.
  • 8--Application license from the plug-in is used.
  • 9--Application and Write licenses from the plug-in are used.
  • 12--Application and Reserved licenses from the plug-in are used.
  • 13--All licenses from the plug-in are used.

If the license is not used from the plug-in, the license information in the user's User entry is used.

No

AR System Administration Console > System > LDAP > AREA Configuration > Defaults and Mapping Attributes to User Information section > License Mask. 

(See Configuring the AREA LDAP plug-in.) 

AREA-LDAP-LicMask-Default 2

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicMask attribute is not specified or has no value for the user.No AR System Configuration Generic UI form.   

AREA-LDAP-LicRes1 2

(Component name: com.bmc.arsys.ldap.area)

Name of the attribute that specifies the type of reserved license issued. If the attribute is not specified, the specified default or a system default is applied.No AR System Configuration Generic UI form.  

AREA-LDAP-LicRes1-Default 2

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-LicRes1 attribute is not specified or has no value for the user.NoAR System Configuration Generic UI form.   

AREA-LDAP-Notify-Meth 2

(Component name: com.bmc.arsys.ldap.area)

Name of the attribute that specifies the default notification mechanism for the user. This attribute corresponds to the Default Notification Mechanism field in the AR System User form. If the attribute is not specified, the specified default or a system default is applied.NoAR System Configuration Generic UI form.  

AREA-LDAP-Notify-Meth-Default 2

(Component name: com.bmc.arsys.ldap.area)

Value that the AREA LDAP plug-in uses if the AREA-LDAP-Notify-Meth attribute is not specified or has no value for the user.No AR System Configuration Generic UI form.   

AREA-LDAP-Port 

(Component name: com.bmc.arsys.ldap.area)

Port number on which the directory service listens for clients.

 

AR System Administration Console > System > LDAP > AREA Configuration > Directory Service Information section > Port Number.

(See Configuring the AREA LDAP plug-in.) 

AREA-LDAP-SSL-AUTH-OPTION 2

(Component name: com.bmc.arsys.ldap.area)

Flag indicating how the secure connection is established. By default, AREA-LDAP-SSL-AUTH-OPTION is set to true and will continue to authenticate the server certificate when opening the secure connection. If you set AREA-LDAP-SSL-AUTH-OPTION to false, the server certificate is not authenticated and multiple secure server connections can be established concurrently.No AR System Configuration Generic UI form.   

AREA-LDAP-Use-Groups

(Component name: com.bmc.arsys.ldap.area)

 

Flag indicating whether to retrieve group information from the LDAP server. If this parameter is not set, group information from the AR System Group form is used.

 

No 

AR System Administration Console > System > LDAP > AREA Configuration > User and Group Information section > Group Membership.

(See Configuring the AREA LDAP plug-in.)

AREA-LDAP-User-Base 

(Component name: com.bmc.arsys.ldap.area)

User base in the LDAP directory to search for the user. To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$ — User's distinguished name. This only applies to the Group Base Name and Group Search Filter. It does not apply to the User Base Name and User Search Filter.
  • $\AUTHSTRING$ — Value that users enter into the Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client accessing the AR System server.
No 

AR System Administration Console > System > LDAP > AREA Configuration > User and Group Information section > User Base.

(See Configuring the AREA LDAP plug-in.) 

AREA-LDAP-User-Filter 

(Component name: com.bmc.arsys.ldap.area)

LDAP search filter used to locate the user in the directory from the base that the AREA-LDAP-User-Base option specifies. To determine the option's values at runtime, use these keywords:

Note: The backslash (\) is required.

  • $\USER$ — User's login name.
  • $\DN$ — User's distinguished name. This only applies to the Group Base Name and Group Search Filter. It does not apply to the User Base Name and User Search Filter.
  • $\AUTHSTRING$ — Value that users enter into the Authentication String field when they log in.
  • $\NETWORKADDR$ — IP address of the AR System client accessing the AR System server.
No 

AR System Administration Console > System > LDAP > AREA Configuration > User and Group Information section > User Search Filter.

(See Configuring the AREA LDAP plug-in.) 

AREA-LDAP-UseSSL 

(Component name: com.bmc.arsys.ldap.area)

Flag indicating whether to establish a secure socket layer (SSL) connection to the directory service. Values are T and F. If you use LDAP over SSL, you must also specify the file name of the certificate database used to establish the connection.

 

No 

AR System Administration Console > System > LDAP > AREA Configuration > Directory Service Information section > Use Secure Socket Layer.

(See Configuring the AREA LDAP plug-in.) 

Arerror-Exception-List 2

 

List of errors that trigger a dump of the current stack in the arerror.log file. Separate each error number with a semicolon (for example, 123;345;). NoAR System Configuration Generic UI form.   

ARF-Java-VM-Options 2

 

Java command options for a virtual machine (VM). The options are documented in the online AR System Java API documentation. NoAR System Configuration Generic UI form.   

Archive-Interval

 

Specifies the number of hours scheduled to run the global archive for all forms.

In a server group environment:

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

For information about setting, archive interval, see Setting global archive interval for forms.

Yes 

AR System Administration Console > System > General > Server Information > Configuration > Archive Interval.

(See Setting global archive interval for forms.)   

arsystem.authentication_server Server that the BMC Remedy Mid Tier uses to authenticate a user. If an authentication server is specified, the mid tier authenticates with the specified server. The authentication server must already be in the list of mid tier servers on the AR Server Settings page.  No 

Mid Tier Configuration Tool > General Settings > Preference Servers.

(See Configuring the General Settings page.) 

arsystem.enableSkinsFlag that indicates whether skins are enabled on the BMC Remedy Mid Tier.

Valid values:

  • true (Default)
  • false
No Mid Tier Configuration Tool > AR Server Settings   > Edit AR Server > Enable Skins. 
arsystem.homepage_server BMC Remedy AR System server that contains the home page that you want to open when the user logs on. The home page URL is: http://midTierServer/contextPath/home The home page server must be added to the list of mid tier servers in the AR Server Settings page. The mid tier searches the designated server for the home page. If you have not selected a home page server in the AR System User Preference form, the home page server specified in the AR Server Settings page is used globally. A home page server specified in the AR System User Preferences form takes precedence over the server set in the AR Server Settings page. No 

Mid Tier Configuration Tool > General Settings > Homepage Server.

(See Configuring the General Settings page.) 

arsystem.licenserelease_timeout 

Number of seconds before BMC Remedy Mid Tier releases an AR System license for a user, if the user does not log out of mid tier correctly.

Note: To log out correctly, the user must close the last browser window associated with the current HTTP session or navigate away from the mid tier.

Default value: 60 seconds

No 

Mid Tier Configuration Tool > General Settings > License Release Timeout.

(See Configuring the General Settings page.) 

arsystem.log_backupsMaximum number of BMC Remedy Mid Tier backup log files that the system will generate when the log file size exceeds the limit specified in the Maximum Log File Size (arsystem.log_filesize).
Default value: 100
No Mid Tier Configuration Tool > Log Settings > Maximum Number of Log Files.  
arsystem.log_category 

Type of information that should be stored in the BMC Remedy Mid Tier log file.

Valid values:

  • Reporting — Messages related to reporting
  • Cache — Messages related to definitions, such as forms and active links in the cache
  • Session Management — Messages related to user session construction and expiration, such as logon, logout, or timeout
  • Configuration — Messages related to the config.properties file, such as when it is loaded and changed
  • Flashboards — Messages related to Flashboards
  • Web Services — Messages related to web services
  • Field — Messages related to fields
  • Workflow — Messages related to compilation of workflow (primarily active link actions), such as invalid active links
  • Performance — Messages related to performance, including duration of operations
  • Qualifications and Expressions — Messages related to parsing and compilation of expressions, for example, in active links
  • Servlet — Messages related to servlet handling of http requests, primarily for reporting results of back-channel requests
  • Internal — Internal logging messages
  • ARServer (API/Filter/Database) — Messages related to APIs, filters, and databases. Selecting the ARServer (API/Filter/Database) option, overrides the API logging option and all API logging is redirected to the mid tier log file.
  • Data Visualization Module — Messages related to the data visualization module
Default value: All categories except Flashboards are selected by default. 
No Mid Tier Configuration Tool > Log Settings > Log Categories. 
arsystem.log_filesize

Maximum size (in kilobytes) a BMC Remedy Mid Tier log file can reach before a backup copy is automatically made. When the log file reaches this limit, a backup copy is made with the same file name and an incremental number (for example, armidtierN.log).

Default value: 10240 KB 

No Mid Tier Configuration Tool > Log Settings > Maximum Log File Size. 
arsystem.log_format

BMC Remedy Mid Tier log output, which is generated using the standard Java 1.5 logging API, including Simple and XML formatting.

Valid values:

  • FastText — (Default) A basic text file for faster performance, it does not include stack trace information except in the case of Severe log messages.
  • Text — A text file containing details such as JAVA class names and methods.
  • XML— A file in XML format. 
No Mid Tier Configuration Tool > Log Settings > Log Format.  
arsystem.log_filepath

Directory in which the BMC Remedy Mid Tier log files are stored. To change the log directory, enter the absolute (complete) path for the new directory.

Note: You cannot change the log file name.
Default value: C:\Program Files\BMC Software\ARSystem\midtier\logs 

No Mid Tier Configuration Tool > Log Settings > Log Directory. 
arsystem.log_level log settings 

Level of detail for logging information for BMC Remedy Mid Tier.

Valid values:

  • Fine — The highest level of detail, including the client's IP address
  • Info — Less detail than Fine, but includes the client's IP address
  • Warning — A moderate level of detail. Warnings plus those errors included in the Severe level are logged.
  • Severe — (Default) The lowest level of detail; only server start time and error messages are logged

Note: You can see the pre-load start and end timestamp when you set the log level to Info or Warning. Irrespective of the logging level, mid tier logs the pre-load start and end time.

 
No Mid Tier Configuration Tool > Log Settings > Log Level.
arsystem.log_viewer log settings 

Method by which you want to view the BMC Remedy Mid Tier log files.

Valid values:

  • Console — The log entries are directed to the stderr (System.err) of your servlet engine.
  • File — (Default) Data is saved to a file in the specified log directory.
 
No Mid Tier Configuration Tool > Log Settings > Log Viewer. 
arsystem.objectlist

Flag that indicates whether the object list is enabled on BMC Remedy Mid Tier.

Valid values:

  • true (Default)
  • false

Note: When set to true, ensure that the corresponding form to display object the list is imported on the AR System server.

 
No Mid Tier Configuration Tool > General Settings > Enable object list.  
arsystem.preference_servers_list 

Indication that preloading of the forms has been enabled for this AR System server.

Valid values:

  • true
  • false (Default)
 
No 

Mid Tier Configuration Tool > General Settings > Preference Servers.

(See Configuring the General Settings page.) 

arsystem.pooling_max_connections_per_server

Maximum number of connections in the AR System server JavaAPI connection pooling.
Default value: 80

 
NoMid Tier Configuration Tool > Connection Settings > Connection Pool Settings > Maximum Connections per Server.

arsystem.security_iframe_allowfromurls 

This parameter controls;
  • whether your web-page can be loaded in <iframe>, <frame>, <object>, <embed>, or <applet> tags.
  • on what domains the web page is loaded.

This parameter has the following options:

  • Self (Default) Enables the current site to render the content.
  • URI Allow the specified URI to frame the page.
    You can pass multiple URIs. The URIs must be space-separated.
    For example, http://www.example.com/ http://www.example2.com
  • None Prevents any domain from rendering the content.

AR System Administration Console > System > General > Centralized Configuration
arsystem.session_timeout Number of minutes for which the current logon session remains inactive. When the time exceeds the arsystem.session_timeout value without any activity in an application on the BMC Remedy Mid Tier, you must log on again.
Default value: 90 minutes 
No

Mid Tier Configuration Tool > General Settings > Session Timeout.

(See Configuring the General Settings page.)

arsystem.log_userUser name for which statements are logged.
After you enter the user name and save changes, a new log file is started. For log messages displayed on the screen, the filter applies only to new entries. Older entries that existed before the user name was changed will still be displayed on the screen, up to the limit set in the View Logs setting.
If the field is left blank, all logs related to the current session are stored, regardless of who is logged in. You can enter only enter one name in this field. 
No Mid Tier Configuration Tool > Log Settings > Filter Log by User Name.

ASJ-Thread-Count 2
(Component name: com.bmc.arsys.approval)

Specifies the total number of worker threads that process various approval requests. NoAR System Configuration Generic UI form.   

Authentication-Chaining-Mode

 

Mode that enables the administrator to use more than one type of authentication on the same system.

Valid values:

  • 0 (Off)--Use the default behavior. Users are authenticated based on the settings of Crossref-Blank-Password and Authenticate-Unregistered Users.
  • 1 (ARS - AREA) — Use internal authentication as the primary method; use external authentication via the AREA plug-in as the secondary method.
  • 2 (AREA - ARS) — Use external authentication via the AREA plug-in as the primary method; use internal authentication as the secondary method.
  • 3 (ARS - OS- AREA) — If authentication fails in AR System (internal authentication), use the operating system authentication (for example, NT domain authentication). If the operating system fails, try external authentication (AREA).
  • 4 (ARS - AREA - OS) — If authentication fails in AR System, try AREA. If AREA fails, try the operating system authentication.

If the value is not 0, the settings of the Crossref-Blank-Password and Authenticate-Unregistered Users parameters are ignored.

If the value is not 0 and the Crossref-Blank-Password parameter is enabled, users who have a blank password in the User form must provide a valid password (that is, a non-NULL password) during login.

Values 3 and 4 provide greater flexibility. For example, your external users might be authenticated with an AREA plug-in, and internal users might be authenticated by the NT domain.

The default value is set to 1.

 NoAR System Configuration Generic UI form.   

Auth-Token-Signature-Salt1

 

Name of a plugin used by the BMC Remedy AR System server to confirm the user password information from the BMC Atrium Single Sign-On server.

Yes AR System Configuration Generic UI form.   
(Starting from version 9.1.04) Broker-Max-Memory-Usage

Maximum memory usage in MB that ActivqMQ JMS broker can consume. If there are memory issues with ActiveMQ messages, increase the value to above 256 MB.

Default value:  256 MB

No
(Starting from version 9.1.04) Broker-Max-Temp-Storage

Maximum temp storage memory in MB used by ActiveMQ JMS broker. If there are issues with temp storage, increase the value to above 8192 MB.

Default value: 8192 MB

No
(Starting from version 9.1.04) Broker-Send-Failed-No-Space-After-Timeout 

Configuration in seconds indicating the timeout delay before getting the error related to “no space available” for ActiveMQ JMS messages.

Default value: 30 seconds

No
(Starting from version 9.1.04) Broker-Temp-Storage-Directory

Temp storage directory for ActiveMQ JMS broker.

Default value: Empty, meaning system temp folder.

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

  1. Thomas Miskiewicz

    I'm missing the Application-Enable parameter description.

    Aug 28, 2017 06:55
    1. Anagha Deshpande

      Hello Thomas,

      I will check with SME and will update the topic.

      Regards,

      Anagha 

      Aug 28, 2017 10:35
      1. Anagha Deshpande

        Hello Thomas,

        I have added the description.

        Regards,

        Anagha

        Sep 05, 2017 10:10
  2. Stefan Hall

    what about the parameters mentioned in the KA 000142298 (https://bmcsites.force.com/casemgmt/sc_KnowledgeArticle?sfdcid=kA21O000000oTovSAE&type=Solution)

    Broker-Max-Memory-Usage 1024 Broker-Max-Temp-Storage 16384 Broker-Send-Failed-No-Space-After-Timeout 30 Broker-Temp-Storage-Directory /remedy/bmc/ARSystem/db/activemq-data/broker_0/tmp_storage Send-JMS-User-Property-Change T

    Nov 21, 2017 07:44
    1. Stefan Hall

      sorry for the bad formatting, enter doesn't seem to work

      Nov 21, 2017 07:47
      1. Stefan Hall

        what about the parameters mentioned in the KA 000142298 (https://bmcsites.force.com/casemgmt/sc_KnowledgeArticle?sfdcid=kA21O000000oTovSAE&type=Solution)

        Broker-Max-Memory-Usage 1024

        Broker-Max-Temp-Storage 16384

        Broker-Send-Failed-No-Space-After-Timeout 30

        Broker-Temp-Storage-Directory /remedy/bmc/ARSystem/db/activemq-data/broker_0/tmp_storage

        Send-JMS-User-Property-Change T

        Nov 21, 2017 07:47
        1. Anagha Deshpande

          Hello Stefan,

          I will check with the SME and will update the documentation.

          Regards,

          Anagha

          Nov 21, 2017 09:28
        1. Kamalakannan Srinivasan

          Hi Stefan,

          Thank you for your comment. Incorporated the changes in this topic and in the Configuration settings S-Z topic.

          Regards,

          Kamal

          Jan 03, 2018 02:43
      1. Kamalakannan Srinivasan

        Hi Stefan,

        Thank you for your comment. Incorporated the changes in this topic and in the Configuration settings S-Z topic.

        Regards,

        Kamal

        Jan 03, 2018 02:44
    1. Kamalakannan Srinivasan

      Hi Stefan,

      Thank you for your comment. Incorporated the changes in this topic and in the Configuration settings S-Z topic.

      Regards,

      Kamal

      Jan 03, 2018 02:42