This documentation supports the 23.3 version of BMC Helix Innovation Suite (AR System and BMC Helix Innovation Studio).

To view an earlier version, select the version from the Product version menu.

Configuration settings E-M

The centralized configuration forms store the configuration settings. All the numeric values for the settings are in the 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.

Best practice

We recommend 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:

Tips

  • If you cannot view all the columns, view the page in full-screen mode.
    Alternatively, use the scroll bar at the bottom of the table.
  • Press F11 to view the table in full-screen mode. Press F11 to exit full-screen mode.
  • To easily search for a specific parameter in the table, select the parameter from the Setting list.
    Alternatively, type the name of the parameter in the Setting text box. For example, to search for the Next-ID-Block-Size parameter, select it from the Setting list, or type the parameter name in the Setting text box.
  • To search for the parameters which have a specific text string in the description, type the string in the Description text box.
    For example, to search for the parameters which have Configuration in the description, type Configuration in the Description text box.

 Configuration options (E-M)

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 

FTS_ELASTICSEARCH_HOSTNAME           

The host name of the Elasticsearch server.

Important: You cannot change the host name after installation.

No
FTS_ELASTICSEARCH_PORT
The port number that enables AR System server to connect to the Elasticsearch server.

Default value—9200

Important: You cannot change the port number after installation.


No
FTS_ELASTICSEARCH_USERNAME

User login name to connect to the Elasticsearch server.

No
FTS_ELASTICSEARCH_USER_PASSWORD

The password that administrators use to access the Elasticsearch server.

No

Elasticsearch-BulkIndex-Size

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

The number of records sent to the Elasticsearch server in one bulk REST API call for indexing.

The minimum value is 100. The maximum value is 1000. The default value is 100.

No

ElasticSearch-Long-Timeout

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

Use this parameter to define the socket timeout for the delete operation on the Elasticsearch server.

Default value — 90 seconds

YesAR System Configuration Generic UI form

ElasticSearch-Normal-Timeout

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

Use this parameter to define the socket timeout for the following operations:

  • Bulk entry
  • Create entry
  • Create index wrapper
  • Delete entry
  • Delete field request
  • Delete index wrapper
  • Get count
  • Get index
  • Set entry

Default value — 50 seconds

YesAR System Configuration Generic UI form

ElasticSearch-Query-Timeout

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

Define the time that Elasticsearch server can retain the search query in the database. 

Default value — 15 seconds

YesAR System Configuration Generic UI form

Email-Notify-From

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

Sender name to use for filter-generated email notifications in which no subject is specified. The value is limited to 29 characters.

Check out a video on using CCS for Email Engine at https://youtu.be/EX1IuC1Wr6g Open link .

No AR System Configuration Generic UI form

Email-Max-Num-Of-Attachments

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

Defines the maximum number of attachments that can be added to an outgoing email.

Example: 5

Default value—0



Email-Max-Attachment-Size

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

Defines the maximum combined size limit for all attachments in an outgoing email.

Example: 5000000 bytes

Default value—0

No AR System Configuration Generic UI form

Email-Timeout

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

Maximum time that arserverd waits for a return value from sendmail. This option was valid in AR System server versions 4.5.1 through 5.0.1 but became obsolete when the Email Engine was introduced in version 5.1.0.

NoAR System Configuration Generic UI form

Enable-Attachment-Validation-Plugin

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

Enable attachment virus scanning program.

Valid values:

  • (Default) True
  • False
YesAR System Configuration Generic UI form

Enable-Unlimited-Log-Line-Length

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

Flag indicating whether log files display complete lines into log files or not. Values are:

  • T—AR System server logs complete lines into log files without truncation.
  • F—(Default) AR System server logs only 255 characters per line.
NoAR System Configuration Generic UI form 

Encrypt-Data-Encryption-Algorithm

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

Integer indicating the encryption algorithm of the data key. Use the following values.

Standard Security

  • 1—56-bit DES using CBC mode (default)

Performance Security

  • 2—128-bit RC4 key (default)
  • 6—128-bit AES CBC key (FIPS noncompliant)
  • 8—128-bit AES CBC key (FIPS compliant)

Premium Security

  • 3—256-bit RC4 key (default)
  • 7—256-bit AES CBC key (FIPS noncompliant)
  • 9—256-bit AES CBC key (FIPS compliant)

For more information, see the Encryption Security section.

No AR System Configuration Generic UI form 

Encrypt-Public-Key-Algorithm

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


Integer indicating the encryption algorithm of the public key. Values are

  • 4—512-bit RSA key (default for Standard Security)
  • 5—2048-bit RSA key (default for Performance Security)
  • 6—4096-bit RSA key (default for Premium Security)

For more information, see the Encryption Security section.

NoAR System Configuration Generic UI form 

Encrypt-Public-Key-Expire

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

Integer specifying the life span (in seconds) of the public key. At the end of the specified time, the key expires, and the server generates a new key. The default is 86400 seconds (24 hours).NoAR System Configuration Generic UI form 

Encrypt-Security-Policy

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

Integer indicating whether encryption is on or off. Values are

  • 0—(Default) Optional: Clients with and without encryption installed can communicate with the server. Network traffic is encrypted only if the client supports the server encryption configuration. Otherwise, network traffic is exchanged in plain text.
  • 1—Required: Only clients with encryption installed can communicate with the server. The encryption level installed on the client (standard, performance, or premium) must be compatible with the encryption algorithms used by the server.
  • 2—Disabled: Whether encryption is installed on a client or not, communication with the server is not encrypted. Network traffic is exchanged in plain text.

For more information, see the Encryption Security section.

NoAR System Configuration Generic UI form 

Encrypt-Session-Hash-Entries

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

Size of the hash table that holds the encrypted session information. The default is 509; there is no maximum.NoAR System Configuration Generic UI form 

Encrypt-Symmetric-Data-Key-Expire

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

Integer specifying the life span (in seconds) of the data key. At the end of the specified time, the key expires, and a new key exchange occurs. The default is 2700 seconds (45 minutes).NoAR System Configuration Generic UI form 

Enforce-Password-Policy

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

Specifies whether the password policy must be enforced.

BMC Helix Innovation SuiteBMC Helix Platform ensures that passwords are always encrypted. To ensure that the passwords are validated and encrypted, a password policy is enforced and forces the users to set a password that cannot be blank.

NoAR System Configuration Generic UI form 

Errors-Triggering-AlwaysOnLog-Dump


The error codes are separated by a semicolon, which will automatically dump the Always On Logging buffer, if the specified error codes occur during the execution.


Yes

AR System Administration Console > System > General > Server Information >  Always On Logging > Errors Triggering Log. (See Setting Always On logging.)

Escalation-Log-File

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

Full path name of the file to use if escalation logging is on (see Debug-mode).NoAR System Configuration Generic UI form 

Exception-Diagnostic-Option

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

Integer value controlling the diagnostic output when the server crashes. Values are

  • 0—AR_EXCEPTION_DIAG_ALL ; includes all diagnostic output when an exception occurs.
  • 1—AR_EXCEPTION_EXCLUDE_STACK ; excludes the stack trace in the diagnostic output when an exception occurs.
NoAR System Configuration Generic UI form 

Execute-Window-Close-Undisplay-Activelinks

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

(Google Chrome version 80 and later) This parameter determines whether to run the active links that run on the  Close Window  events. The values are:

  • True:
    • Mid Tier tries to run the active links with close Window option. This might not work as expected in Google Chrome version 80 and later. However, this might work in other browsers.
    • Active links continue to run on the close Window and Un-display events. It might not fetch the expected results.
    • Mid Tier ignores PERFORM-ACTION-ACTIVE-LINK 65536 ignoreIfEnabledBrowserUnload or PERFORM-ACTION-ACTIVE-LINK 32768 ignoreIfEnabledBrowserUnload actions.
  • (Default) False:
    • Mid Tier does not run active links with close Window and Un-display execution options.
    • Mid Tier continues to support run process PERFORM-ACTION-ACTIVE-LINK 65536 ignoreIfEnabledBrowserUnload or PERFORM-ACTION-ACTIVE-LINK 32768 ignoreIfEnabledBrowserUnload for close Window event.
    • The out-of-the-box (OOTB) active links use ignoreIfEnabledBrowserUnload parameter to avoid executing duplicate active links.
NoAR System Configuration Generic UI form 

External-Authentication-Group-Mapping


Mapping of LDAP groups to AR System groups for external authentication. The value of this option consists of one or more pairs of group names separated by semicolons.

For example:"LDAP-1" "ARS-1";"LDAP-2" "ARS-2";"LDAP-3" "ARS-3" Use mapping as an alternative to creating an AR System group corresponding to each LDAP group. You can map each LDAP group to an AR System group (as in the example) or multiple LDAP groups to a single AR System group. If you try to map a single LDAP group to multiple AR System groups, only the first mapping expression is valid. This option can be used with the External-Authentication-Ignore-Excess-Groups option.

NoAR System Configuration Generic UI form 

External-Authentication-Ignore-Excess-Groups


Flag used by AR System during external authentication. Values are

  • 0—(Default) Users are authenticated when a match exists between every LDAP group to which a user belongs and a corresponding group in AR System.
  • 1—Users are authenticated when any single LDAP group to which a user belongs matches a group in AR System. Excess LDAP groups are ignored.

This option can be used with the External-Authentication-Group-Mapping option.

NoAR System Configuration Generic UI form 

External-Authentication-Return-Data-Capabilities

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

Bit mask that specifies the return data capabilities for the current AREA plug-in. This option does not control the AREA plug-in; it merely describes the behavior of the plug-in, enabling server optimization. Values are

  • 0—(Default) The server tries to retrieve this information from AREA.
  • Bit 1 (value = 1 )—No email address is provided.
  • Bit 2 (value = 2 )—No notify mechanism is provided.
  • Bit 3 (value = 4 )—No group identifiers are provided.
  • 7The server potentially can reduce the number of AREA related calls during notification processing.
  • Bit 4 (value = 8 )—No license information is provided.
  • Bit 5 (value = 16 )—No notification user validation should occur. This enables the server to avoid using AREA for notification user validation and information retrieval. Use this setting for sites using a form of AREA that applies user names as email addresses and where accessing an authentication database provides no benefit.

By default, bit 1 to 5 are set.

NoAR System Configuration Generic UI form 

External-Authentication-RPC-Socket

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

RPC socket number on which an external authentication server awaits requests for authentication. The default value is 0 (external authentication is not used). The RPC program number for the plug-in server is 390695.NoAR System Configuration Generic UI form 

External-Authentication-RPC-Timeout

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

RPC timeout (in seconds) used when calling the authentication (AREA) server. The default value is 40 seconds.NoAR System Configuration Generic UI form 

External-Authentication-Sync-Timeout

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

Internal timeout (in seconds) that the AR System server uses to invoke the external authentication server's AREANeedToSyncCallback() function periodically. This function instructs the AR System server to renew its internally stored user information in case the source used to authenticate users is changed. A value of 0 means that the AR System server does not invoke the call to the AREA server. The default value is 3600 seconds.

NoAR System Configuration Generic UI form 

External-Command-Replace-New-Flow

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

When the AR System server runs an external command with a special character, this setting escapes the special character with a backward slash (\).

Default value—True

YesAR System Configuration Generic UI form 

FieldId-Range

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

The FieldId-Range specifies the limit for values that you can assign (or are assigned automatically if you do not assign any value) to the Field ID. You can assign the value to Field ID within the Field ID range.

You cannot assign the lower limit value of the Field ID range to a field. For example, if the FieldId-Range is 1000:2000, the minimum value that you can assign to a Field ID is 1001. 

NoAR System Configuration Generic UI form 

Filter-Api-Timeout

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

Time limit (in seconds) for the Filter API RPC to respond to the server's request before an error is returned. The minimum value is 1. The maximum is 300. The default is 40.NoAR System Configuration Generic UI form 

Filter-Log-File

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

Full path name of the file to use if filter logging is on (see Debug-mode).NoAR System Configuration Generic UI form 

Filter-Max-Stack

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

Maximum number of recursion levels allowed for an operation. The data modification performed by an AR_FILTER_ACTION_FIELDP filter action might trigger a second set, or level, of filters, one of which might trigger a third level of filters and so on. This option limits the number of times such recursion can happen, preventing the server crash that would occur if the recursion continued indefinitely. The default value is 25.NoAR System Configuration Generic UI form 

Filter-Max-Total

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

Maximum number of filters that the server executes for a given operation. The default value is 10000.NoAR System Configuration Generic UI form 

Force-RSSO-Authentication

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


The value 36 indicates single sign-on is enabled for Developer Studio.

To enable single sign-on for Developer Studio, see Enabling BMC Helix Single Sign-On for Developer Studio.

NoAR System Configuration Generic UI form 

Flush-Log-Lines

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

Flag indicating whether logged lines are buffered or written directly to disc. Values are:

  • T—(Default) Logged lines are written to disc.
  • F—Logged lines are buffered.
NoAR System Configuration Generic UI form 
FTS-Type

Enables you to define the type of full text search.

  • Native(Default) Enables the full text search by using Lucene search.
  • Elastic—Enables the full text search by using Elasticsearch.
No

Full-Text-Case-Option

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

Flag indicating whether full text searching is case sensitive or case insensitive. This setting affects all fields indexed for Full Text Search and affects how the indexes are built. Therefore, changes to this setting trigger an automatic re-index. Values are

  • 0—Full text search is case sensitive
  • 1—(Default) Full Text Search is case insensitive
NoAR System Configuration Generic UI form

Full-Text-Collection-Directory


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

Location in the file system where search engine index files are stored.NoAR System Configuration Generic UI form

Full-Text-Configuration-Directory

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

Location in the file system where search engine configuration files are stored.

Note: If you change the directory in this option, update the pluginsvr_config.xml file with the correct directory path. This file is in ARSystemInstallDir\pluginsvr\fts.

NoAR System Configuration Generic UI form 

Full-Text-Disable-Indexing


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

Flag indicating whether the server processes pending indexing tasks. Values are

  • T—Disable indexing. Pending indexing tasks are recorded for processing later when indexing is enabled.
  • F—(Default) Do not disable indexing.
NoAR System Configuration Generic UI form 

Full-Text-Disable-Searching

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



Flag indicating whether the server uses the full text search engine for searching. Values are

  • T—Disable the Full Text Search engine. The server uses the search capability of the underlying database whether or not a user has a full text license.
  • F—(Default) Use the Full Text Search engine.
NoAR System Configuration Generic UI form 

Full-Text-Exclude-List

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

Space separated list of attachment file extensions which must be excluded from FTSindexing.

For example, if the value to this parameter is set to .xla, .xls, .xlsm, .xlsx, .xlt and if you have enabled FTSor MFS for the attachment field, all the attachments with these extensions are ignored while creating FTS index.

If there are other fields that have enabled FTSor MFS index, the entry still gets indexed.

If you change this option, you must restart the AR System server for the change to take effect.

NoAR System Configuration Generic UI form 

Full-Text-Indexer-Log-File

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


NoAR System Configuration Generic UI form 

Full-Text-Indexer-Recovery-Interval

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

Number of minutes that the server waits between periodic attempts to index entries that failed to index for an unexpected reason in a prior attempt. The default value is 60 minutes.NoAR System Configuration Generic UI form 

Full-Text-Ignore-Word-List

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

Contains words to be ignored during FTS. Search results will not contain the words that are added in this list.

Values: Articles (a, an, the), prepositions (in, on, from, front, beside), and so on.

Press Enter to add a new Full path name of the file to use if full text indexer logging is on (see Debug-mode word in this list.

NoAR System Configuration Generic UI form

Full-Text-Match-Option

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

The way the server modifies qualifications from the client. Values are

  • 0—Force leading and trailing wildcards.
  • 1—Ignore leading and force trailing wildcards.
  • 2—Ignore leading wildcards.
  • 3—Remove leading and trailing wildcards.
  • 4—(Default) Leave query unchanged.
NoAR System Configuration Generic UI form 

Full-Text-ReIndex

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

Initiates the re-indexing of all FTS-enabled fields.

Valid values:

  • 0(Default) Re-indexing is not performed.
  • 1Starts re-indexing.
NoAR System Configuration Generic UI form 

Full-Text-Search-Threshold


The maximum number of search results returned from the search engine. The default value is 10,000. To limit the number of search results (because of constraints on the computer where the search engine is running), reduce the threshold. If you change this option, you must restart the AR System server for the change to take effect.

NoAR System Configuration Generic UI form 

Full-Text-Search-Threshold-High

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


During the processing of search results, the server combines results from subqueries to arrive at the final result set. If the number of rows created during processing exceeds this value, the server returns an error message indicating the search is too complex. The default value is 1,000,000.NoAR System Configuration Generic UI form 

Full-Text-Search-Threshold-Low

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

While processing search results, the server creates a temporary table if the number of FTS matches reaches this value. If the number of FTS matches is under this value, the server uses the SQL IN operator for a query on an existing table. The default value is 200.

NoAR System Configuration Generic UI form 

Full-Text-Synonyms

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

Contains synonyms so that when the end user searches for any of these words, resources related to its synonyms also appear in the search results.

For example:

  • PC workstation laptop desktop computer
  • slow sluggish
  • bright shiny

Type a word followed by its synonyms separated by a space. Press Enter to add a new list of synonyms.

NoAR System Configuration Generic UI form 

Gcp-Project-Id

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

The unique identifier for your Google Cloud Platform project.

The Gcp-Project-Id can be any alphanumeric string that is unique across the platform and is provided by the user while creating a project.

The project id created while setting up the Google Cloud Platform account.

For more information, see Configuring cognitive service for a custom application by using BMC Native (Google) classification in BMC Helix Innovation Studio documentation.

NoAR System Configuration Generic UI form

Gcp-Region

The unique identifier for your Google Cloud Platform project.

The Gcp-Project-Id can be any alphanumeric string that is unique across the platform and is provided by the user while creating a project.

The project id created while setting up the Google Cloud Platform account.

For more information, see Configuring cognitive service for a custom application by using BMC Native (Google) classification in BMC Helix Innovation Studio documentation.

NoAR System Configuration Generic UI form

GetListEntry-Server-Date-Format

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


Flag indicating where to format the GetListEntry date. This option is used mainly for backward compatibility purposes. Values are:

  • T—Format date on server.
  • F—(Default) Format date on client.
NoAR System Configuration Generic UI form 

Guest-Restricted-Read

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

Flag indicating whether guest users receive a restricted read license when they log in to AR System. Values are:

  • T
  • F

If this option is not specified, guest users receive a read license.

NoAR System Configuration Generic UI form 

GUID-Prefix

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


Character string used as a prefix for GUID strings generated by filters.NoAR System Configuration Generic UI form 

Guide-Column-Functions-Run-On-All-Rows

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

When using a call guide, this parameter determines whether the Column function to work on the current row of the complete table data.

Valid values:

True: (Default) The function runs on all rows.

False: The function runs on the current row.

YesAR System Configuration Generic UI form

Helix Portal Tenant ID

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

Use this parameter to specify the BMC Helix Portal tenant ID to be used for authentication and integration.

In this parameter, specify the BMC Helix Portal tenant ID to be used for authentication and integration.  This parameter is used to establish integration with BMC Helix Service Monitoring (Powered by AIOps) for Probable Cause Analysis.

Default value: ""

YesAR System Configuration Generic UI form

Helix-Portal-URL

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

The unique URL for BMC Helix Dashboards.
AR System Configuration Generic UI form

Hierarchical-Groups-Chunk-Size 

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

This parameter specifies the number of records processed during the bulk computation of Hierarchical groups. You cannot set value less than 1000. 

Default value: 1000

YesAR System Configuration Generic UI form

Hierarchical-Groups-Interval

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

Allows you to configure compute delay (in seconds) for hierarchical groups.

Default value: 300 seconds

Yes

AR System Configuration Generic UI form 

For details on hierarchical groups parameters, see Controlling access to requests for hierarchical groups.

Hierarchical-Groups-Threads

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

Allows you to configure the number of threads that will be used for computation of hierarchical groups.

Default value: 3

Best practice: If you plan to update the parent group of multiple support groups, which might result in processing a huge number of entries during business hours, we recommend to set the value of this setting to 1.

Yes

AR System Configuration Generic UI form 

For details on hierarchical groups parameters, see Controlling access to requests for hierarchical groups.

Homepage-Form

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

Path to the system wide default home page. This home page is used only if:

  • The current server is designated as the server for the home page in the BMC Remedy AR System User Preference form.

Or

And

  • No home page is specified in the BMC Remedy AR System User Preference form.
    Note: If the home page is deleted, this option is cleared, and the default home page must be re-entered.
NoAR System Configuration Generic UI form 

IFrame_Allowed_Sites

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

A list of URL strings of trusted sites for embedding the BMC Helix Innovation studi views in external applications.

For multiple URL strings, enter the list separated by a space, for example:

https://coke.com https://pepsi.com

NoAR System Configuration Generic UI form 

Ignore-DST-Handling

Indicates whether to consider or ignore Daylight Saving Time (DST) while generating reports in Smart Reporting . The Ignore-DST-Handling parameter is not available out of the box. The possible values are:

  • True — (Default) AR System server ignores DST while generating reports.
  • False — AR System server considers DST while generating reports.

The value specified by a report creator in a report query overrides the value of the Ignore-DST-Handling parameter. 

Important: Before setting this parameter, run the PERFORM-CUSTOM-DB-FUNCTION-CHANGE script from the Java driver. 

YesAR System Administration Console > System > General > Centralized Configuration

Internal-User-Info-Hash-Lists

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

Number of shared, linked lists that hold all user-related information. This number must be a power of 2. The default setting is 128. The minimum number is 2. There is no maximum.

AR System does not verify that this number is a power of 2. If the number is not a power of 2, the AR System server might behave in unexpected ways.

NoAR System Configuration Generic UI form 

Internal-User-Instance-Timeout

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


Time, in minutes, that the AR System server waits before removing inactive user instances from its internal memory cache. Use this option in an LDAP environment to reduce the frequency of checks against an outside authenticator (if a user's record is in server memory, the server does not need to check the user's password outside the system). The default is 2 hours (120 minutes), and the minimum is 30 minutes.

This value must be greater than or equal to the value of the Floating License Timeout on the AR System Administration: Server Information form's Timeouts tab (by default, 2 hours). If you specify a value that is less than the Floating License Timeout, you will not receive an error. Inactive user instances, however, will not be removed in less than the time specified by the Floating License Timeout. If you do not set this option, the persistence of inactive user instances is controlled by the Floating License Timeout.

NoAR System Configuration Generic UI form 

IP-Name

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

Option used to specify that a server has multiple names. This option can appear in the configuration file more than once. When checking workflow and connections against itself, the server compares its server name, host name, IP aliases, and any names specified by this option to the name passed to it.

If the name matches any of those names, the server concludes that the workflow or connection is for itself. This option can be used for servers with variable length domains or for servers on computers with multiple internet addresses. For example, to connect to a computer named tix as tix, tix.company.com, or tix.eng.company.com, an administrator would create three IP-Name entries, one for each connection name. To connect to a computer with multiple internet addresses such as tix.company.com, tix.biggercompany.com, and tix.evenbigger.com, an administrator would create an IP-Name entry for each of those addresses.

NoAR System Configuration Generic UI form 

Jetty-Port 

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

Port for running the Jetty server.

Jetty server provides support for REST API integrations. The Jetty port is required for preparing the REST API URL.

Default value  8008

Example:

<jetty-protocol>://<host-name>:<jetty-port>/api/{resource-locator}

YesAR System Configuration Generic UI form 

Jetty-Protocol

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

Protocol for the Jetty server.

Default value  http

Example:

<jetty-protocol>://<host-name>:<jetty-port>/api/{resource-locator}

YesAR System Configuration Generic UI form 

Jmx-port

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

Defines the JMX port number that enables administrators to connect to JVM by using Java Messaging Extensions (JMX).

Default value: 61500 

No 

System > General > Server Information > Ports and Queues > JMX Port.

(See Setting ports and RPC numbers.)

Jdbc-Row-Limit

The maximum number of rows that can be retrieved from the AR System database.

Default value: 10,000.

When retrieving records from the database, the lower value of the Jdbc-Row-Limit parameter defined in AR System server is considered.  

For example, if  Jdbc-Row-Limit has value 5000 and rowLimit has value 3000, the maximum number of rows that will be retrieved from the database is 3000. Similarly, if Jdbc-Row-Limit has value 4000 and rowLimit has value 5000, the maximum number of rows that will be retrieved from the database is 4000.

YesAR System Administration Console > System > General > Centralized Configuration

License-Timeout

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

Number of hours the AR System server waits before disconnecting inactive users. If a user is holding a floating license, the system also frees the license. The default value is two hours.

NoAR System Configuration Generic UI form 

Locale-List

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

The installed language packs. Some sample values are:

  • en—English
  • fr—French
  • it—Italian
  • ja—Japanese
  • ko—Korean
  • pt_br—Brazilian Portuguese
  • zh_cn—Simplified Chinese
NoAR System Configuration Generic UI form 

Localized-Messages-To-Cache

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

A semicolon-separated list of message numbers used to modify the server's default caching behavior for localized system messages.

To cache all localized system messages the first time they are retrieved from the AR System Message Catalog form (the default), do not use this option in the configuration file.

To not cache any localized system messages, use this option without any message numbers, for example:

Localized-Messages-To-Cache:

To restrict the caching of localized system messages to a specific subset of message numbers, use this option with a semicolon-separated list of message numbers, for example:

Localized-Messages-To-Cache: 66;72;302;314

NoAR System Configuration Generic UI form 

Localized-Server

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

Flag indicating whether the server is running in localized support mode. Values are

  • T—Run in localized support mode, and use localized messages if available.
  • F—(Default) The server does not search for or use localized strings.

In 9.1.02, the default value is set to T.

NoAR System Configuration Generic UI form 

Locked-Workflow-Log-Mode

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

Mode that causes the server to record locked workflow actions in workflow logs. These actions are written as encrypted strings.NoAR System Configuration Generic UI form

log_backups

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

Maximum number of backup (.bak) log files for the Flashboards server to be allowed, when the log file reaches the Maximum File Size value and a new log file is created.

Default value: 10

No 

AR System Administration Console > System > General > Flashboard Server Configuration > Maximum Backups. 

(See Configuring the Flashboard server settings at a global level.)

log_category

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

Type of information to be stored in the Flashboards server log file.

Values are:

  • Alarm— Alarm related logging is stored in the log file.
  • Flashboard Server—Flashboard server calls logging is stored in the log file.
  • Flash Util—Flashboard server classes logging is stored in the log file. 

Default value: All 

No

AR System Administration Console > System > General > Flashboard Server Configuration > Log Category.  

(See Configuring the Flashboard server settings at a global level.)

log_default_format

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

Format for the Flashboards sever log output when log_level parameter for Flashboards server is set to BASIC or INFO. The log output is generated using Java log4j pattern layout.
Default value:  <%t> <%c> <%d> <%l> <%m> %n

For more information on log4j pattern layout, see Pattern Layout Open link .

No 

AR System Administration Console > System > General > Flashboard Server Configuration > Log Format. 

(See Configuring the Flashboard server settings at a global level.)

log_detail_format

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

Format for the Flashboards sever log output when log_level parameter for Flashboards server is set to DEBUG.

Default value: <%t> <%c> <%d> <%l> <%m> %n

For more information on log4j pattern layout, see Pattern Layout Open link .

No AR System Configuration Generic UI form

log_filename

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

Name of the Flashboards server log file.

Default value: arfbserver.log

No

AR System Administration Console > System > General > Flashboard Server Configuration > Log File Name.

(See Configuring the Flashboard server settings at a global level.)


log_filepath

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

The path for the Flashboards server log file.

Default value: .

No AR System Configuration Generic UI form

log_filesize

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

Maximum size (in kilobytes) for the Flashboards server log file.

Default value: 100 KB

No 

AR System Administration Console > System > General > Flashboard Server Configuration > Maximum File Size.

(See Configuring the Flashboard server settings at a global level.) 

log_level

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

The level of logging for the Flashboards server.

Values are:

  • BASICThe minimum log level which logs errors.
  • INFOThe log level which logs errors with information
  • DEBUGThe maximum log level which gives detailed log information.

Default value: BASIC 

No

AR System Administration Console > System > General > Flashboard Server Configuration > Log Level.

 (See  Configuring the Flashboard server settings at a global level. )  

log_null_value

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

The value to represent a null value in the Flashboards logs.

Default value: -


 
No AR System Configuration Generic UI form 

log_viewer

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

The method by which you want to view Flashboards log files. Values are:

  • CONSOLE – The log entries are directed to the stderr (System.err) of your servlet engine.
  • FILE – The log entries are saved to a file in the specified log directory.

Default value: FILE

No AR System Configuration Generic UI form 

Log-DSO-Errors-To-Form

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

Flag indicating whether to log failed pending distributed operations to the Distributed Pending Errors form. Values are

  • T—Log errors to the form.
  • F—Do not log errors to the form.
NoAR System Configuration Generic UI form 

Log-File-Append

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

Flag indicating whether to create a separate *.bak file or to append to the existing log file. Values are

  • T—Append new log information to the existing file.
  • F—(Default) Create a *.bak file.
NoAR System Configuration Generic UI form

Log-Form-Selected

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

Bitmask indicating the type of information to log in the common log form (AR System Log:ALL). To activate one bit, set this option to its value (values are listed under the Debug-mode option). To activate two or more bits, add their values, and set this option to the total. For example, to activate bits 1 and 3, set this option to 5 because bit 1 has a value of 1 and bit 3 has a value of 4. To deactivate a bit, subtract its value from the value of this option. This option does not apply to the following bits because information about their corresponding applications is not logged to a form:

  • Bit 8 (value = 128 ) for ARFORK.
  • Bit 16 (value = 32768 ) for the DSO server.
  • Bit 17 (value = 65536 ) for Approval Server.
  • Bit 18 (value = 131072 ) for the plug-in server.
NoAR System Configuration Generic UI form 

Log-To-Form

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


Bitmask indicating the information to log in predefined forms (for example, AR System Log: API and AR System Log: Filter). To activate one bit, set this option to its value (values are listed under the Debug-mode option). To activate two or more bits, add their values, and set this option to the total. For example, to activate bits 1 and 3, set this option to 5 because bit 1 has a value of 1 and bit 3 has a value of 4. To deactivate a bit, subtract its value from the value of this option. This option does not apply to the following bits because no log form is created for their corresponding applications:

  • Bit 8 (value = 128 ) for ARFORK.
  • Bit 16 (value = 32768 ) for the DSO server.
  • Bit 17 (value = 65536 ) for Approval Server.
  • Bit 18 (value = 131072 ) for the plug-in server.
NoAR System Configuration Generic UI form 

Map-IP-Address

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

IP address mappings that enable alerts to work through firewalls when Network Address Translation (NAT) is on. You must set up a mapping for each client computer that has access through the firewall where the client IP address is translated from an internal address to a valid external address. In addition, a mapping is required for the AR System server IP address if the host where the server resides is also translated. Here is a multiple line example:

Map-IP-Address: 123.45.67.89 10.5.119.83
Map-IP-Address: 123.45.55.90 10.26.55.65
NoAR System Configuration Generic UI form 

Max-AlwaysOn-Buffer-Size



The size of the memory buffer in bytes to store the logs in memory for always on logging feature.

Default value: 5242880 bytes (5 MB)

Yes

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

(See Setting Always On logging.)

Max-Db-Connection-In-Pool

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

The maximum number of database connections that the AR System server can create and maintain in the connection pool.

The value of the Max-Db-Connection-In-Pool setting is defined for each server in the server group.

For example, consider a server group with five servers, and the value of the Max-Db-Connection-In-Pool setting is set to 90. In this case, each server in the server group can open 90 connections. Total there can be 450 connections.

Default value: 120

YesAR System Configuration Generic UI form

Max-Inactivity-Duration

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

The maximum inactivity duration in seconds. The Inactivity monitoring is disabled when set to a value < = 0.

Max-Inactivity-Duration: 30

NoAR System Configuration Generic UI form

Max-Inactivity-Duration-Inital-Delay

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

Max-Inactivity-Duration-Inital-Delay: 120

When JMS error messages are displayed in the arerror.log file, due to heavy load, BMC recommends to set the following value:

Max-Inactivity-Duration-Inital-Delay: 300


NoAR System Configuration Generic UI form

Max-Entries-Per-Query

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

Maximum number of requests returned by a search. Because users can also specify the maximum number of requests returned through Search Preferences in the AR System User Preference form, the actual maximum is the lower of these values. The default value is no server-defined maximum.

BMC recommends always setting a value for this parameter as unqualified searches can yield enormous results resulting in unpredictable system behavior.

In 9.1.02, the default value is set to 2000.

NoAR System Configuration Generic UI form 

Max-Log-File-Size

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

Maximum size in bytes for system log files. If the maximum is reached, the logging cycle restarts at the beginning of the file, overwriting existing information. The default value is 0 (no limit). This option does not apply to the Arfork-Log-File.NoAR System Configuration Generic UI form 

Max-Log-History

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

Maximum number of backup (.bak) log files to be allowed when the log file reaches the Max-Log-File-Size value and a new log file is created. By default, the number of backup log files allowed is 1 and the maximum number of backup log files allowed is 999.NoAR System Configuration Generic UI form 

Max-Notify-Mail-Line-Len

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

Maximum number of bytes that can be in a line of a mail notification.NoAR System Configuration Generic UI form 

Max-Password-Attempts

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

Maximum number of consecutive bad password retries a user can make. If this option is set to 3, the user has 3 chances to log in. If all 3 attempts have bad passwords, the user account is marked INVALID. Values are 0 (which turns this feature off) and all positive integers.

This parameter can be used in conjunction with Display-General-Auth-Message. See Configuration settings C-D See also the description for error 624.

NoAR System Configuration Generic UI form 

Max-Recursion-Level

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

For forms that contain hierarchical data, such as manager and employee relationships, the maximum number of levels in the hierarchy that a recursive query retrieves. Values are any integer greater than 0. The default is 25. See ARGetListEntryWithMultiSchemaFields.NoAR System Configuration Generic UI form 

Max-Unlock-Attempts

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

Number of times the account will be unlocked automatically.

Default value: 5

YesAR System Configuration Generic UI form 

Max-Vendor-Temp-Tables

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

Maximum number of temporary tables that can exist on an AR System server for a single vendor form. The ARGetListEntryWithMultiSchemaFields function stores data from vendor data sources in these tables. By default, only one temporary table can exist for each vendor form. This setting applies to all vendor forms on the server. It is overridden by the value of an individual vendor form's Maximum Vendor Temp Tables property. Enter any integer greater than 0. See ARGetListEntryWithMultiSchemaFields.

NoAR System Configuration Generic UI form 

MaxWorkerThreads

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

The maximum number of worker threads allowed for Flashboards server.

Default value: 2


AR System Configuration Generic UI form 

Maximum-Concurrent-Client-Managed-Transactions

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

Maximum number of concurrent client-managed transactions. The default is 10, and the maximum value you can enter is 100.NoAR System Configuration Generic UI form 

MFS-Environment-Field-Weight

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

Indicates the relevancy weight for the Environment field of a form in a multiple-form search. The value can be any number between 0 and 2000.

Valid values:

  • 0 - 0.9—Reduces the relevancy weight of the Environment field.
  • 1—(Default) No change to the relevancy weight.
  • 1.1 - 2000—Increases the relevancy weight of the Environment field.

For more information, see Configuring forms for multi-form FTS.

NoAR System Configuration Generic UI form 

MFS-Keywords-Field-Weight

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


Indicates the relevancy weight for the Keywords field of a form in a multiple-form search. The value can be any number between 0 and 2000.

Valid values:

  • 0 - 0.9—Reduces the relevancy weight of the Keywords field.
  • 1—(Default) No change to the relevancy weight.
  • 1.1 - 2000—Increases the relevancy weight of the Keywords field.

For more information, see Configuring forms for multi-form FTS.

NoAR System Configuration Generic UI form 

MFS-Title-Field-Weight

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

Indicates the relevancy weight for the Title field of a form in a multiple-form search. The value can be any number between 0 and 2000.

Valid values:

  • 0 - 0.9—Reduces the relevancy weight of the Title field.
  • 1—(Default) No change to the relevancy weight.
  • 1.1 - 2000—Increases the relevancy weight of the Title field.

For more information, see Configuring forms for multi-form FTS.

NoAR System Configuration Generic UI form 

Mid-Tier-Service-Password

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

Password that administrators use to access the mid tier.NoAR System Configuration Generic UI form 

Minimum-API-Version

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

Oldest API version with which the server communicates. The default value is 0, which means that the server communicates with all API versions. If the client's API version is less than the specified value, the server refuses to talk with the client, and the client receives a decode error. (A AR System client is any program that accesses the AR System server through API calls, for example, Developer Studio, plug-ins loaded by the plug-in server, and so on.)

NoAR System Configuration Generic UI form 

Minimum-CMDB-API-Version

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

Oldest CMDB API version with which the server communicates. The default value is 3. If the version of a CMDB call is less than the specified value, the server refuses the call. This option is independent of the Minimum-API-Version option.

NoAR System Configuration Generic UI form 

MinWorkerThreads

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

The minimum number of worker threads allowed for Flashboards server.

Default value: 2


AR System Configuration Generic UI form

Multiple-ARSystem-Servers

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

Flag indicating whether other AR System servers can run on this server's host computer.

Valid values:

  • T—(Default) Other servers can run on this server's host computer.
  • F—Other servers cannot run on this server's host computer.

To run multiple servers on the same host computer, this option must be set to T in the configuration file of each server.

NoAR System Configuration Generic UI form

Multiple-Assign-Groups

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

Flag indicating whether multiple assignee groups can be stored in row-level security field ID 112. This enables users from multiple groups to access the same request. In the past, only one group could be stored in Field 112.

Valid values:

  • T—(Default) Allow multiple groups in field ID 112.
  • F—Do not allow multiple groups in field ID 112.
NoAR System Configuration Generic UI form 

Options you can view (but not set) using the AR System Administration: Server Information form.
Options you cannot set or view using the AR System Administration: Server Information form. 

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

Comments