Configuration settings S-Z
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.
The following table lists the settings available for centralized configuration.
Configuration options (S-Z)
Setting | Description | Server group configuration | Restart required | Maps to |
|---|---|---|---|---|
Save-Login (Component name: com.bmc.arsys.server) | Flag indicating whether users must log in to client tools. This option enables users to save a previous login of their choice. Valid values:
This option does not apply to the mid tier. | No | No | AR System Configuration Generic UI form. |
SCC-Comment-Checkin (Component name: com.bmc.arsys.server) | Flag indicating whether a source code control integration requires you to enter a comment at checkin. Valid values:
| No | No | AR System Configuration Generic UI form. |
SCC-Comment-Checkout (Component name: com.bmc.arsys.server) | Flag indicating whether a source code control integration requires you to enter a comment at checkout. Valid values:
| No | No | AR System Configuration Generic UI form. |
SCC-Enabled (Component name: com.bmc.arsys.server) | Flag indicating whether a source code control system is being used with AR System. Valid values:
| No | No | AR System Configuration Generic UI form. |
SCC-Integration-Mode (Component name: com.bmc.arsys.server) | Flag indicating the level of source code control integration. Valid values:
| No | No | AR System Configuration Generic UI form. |
SCC-Provider-Name (Component name: com.bmc.arsys.server) | Name of the source code control provider. For example: Visual Source Safe. | No | No | AR System Configuration Generic UI form. |
SCC-Target-Dir (Component name: com.bmc.arsys.server) | Character string for the source code control system target directory. If none is present, this value is NULL. This string is limited to 255 characters. | No | No | AR System Configuration Generic UI form. |
Select-Query-Hint2 (Component name: com.bmc.arsys.server) | Text to use in a query hint in the WITH clause of a SELECT statement when queries are supplied to Microsoft SQL Server databases. This option works only for queries triggered by GLE, GLEWF, and GME API calls. If this option is an empty string or is not present, no WITH clause is generated. To determine the appropriateness of using this feature in your environment, consult your SQL Server documentation. This option is commonly used with a NOLOCK setting for allowing queries to execute without being blocked by simultaneous updates, thereby improving performance. For example, to allow SQL Server to read data being updated and avoid blocking, use this syntax:Select-Query-Hint: NOLOCK | No | Yes | AR System Configuration Generic UI form. |
Send-JMS-User-Property-Change | Configuration to decide if a user property change should be replicated to other servers via JMS or only rely on ehcache RMI replication. Enable this configuration by setting the value to “T” in shared component in CCS in case you are seeing issues in user properties replication across servers in a server group. Acceptable value is “T” or “F”. Default value: “F”. | Yes | No | |
Service-Log-File | Full path name of the file to use if service tracing is on. Following is the default file where the log entries are created: arservice.log | No | AR System Configuration Generic UI form. | |
ServerConnectAttempts (Component name:com.bmc.arsys.flashboardServer) | Number of attempts, the Flashboards server tries to connect to the AR System server. Flashboardswaits for the AR System server to start up and tries to connect. If the connection fails, the flashboard keeps on retrying for the connection, based on number of attempts value. Default value: 10 | AR System Administration Console > System > General > Flashboard Server Configuration > Server Reconnect Attempts. (See Configuring-the-Flashboard-server-settings-at-a-global-level.) | ||
Session-Absolute-Timeout (Component name: com.bmc.arsys.server) | The maximum time after which the current session expires in BMC Helix Innovation Studio. The default value is 86400 seconds (24 hours). When the session exceeds this time interval, you must log in to BMC Helix Innovation Studio again. Default value: 86400 seconds (24 hours) | No | No | AR System Configuration Generic UI form. |
Session-Idle-Timeout (Component name: com.bmc.arsys.server) | The maximum time for which a user can remain idle in BMC Helix Innovation Studio. If a user does not perform any activity within the Session-Idle-Timeout interval, BMC Helix Innovation Studio prompts a message (if the user wants to continue or not). Default value: 3600 seconds | No | AR System Configuration Generic UI form. | |
Server-Connect-Name2 (Component name: com.bmc.arsys.server) | New name for a server in a server group. By default, a server in a server group uses a fully qualified server name with domain to identify itself. Others servers in the group use this name to communicate. To change the server name, add this option to the configuration file: Server-Connect-Name: <myServerName> If a common server alias is specified, this option is required. | No | Yes | AR System Configuration Generic UI form. |
Server-directory2 (Component name: com.bmc.arsys.server) | Full path name of the AR System data directory. This directory contains support and log files for the AR System server. | No | No | AR System Configuration Generic UI form. |
Service-Entry-Use-Old-Flow (Component name: com.bmc.arsys.server) | Enables the AR System server to function like AR System server version 8.x. For example, for a service entry API, the AR System server fetches data from database for current transaction even if the entry ID is provided in the transaction. Default value: F | No | No | AR System Configuration Generic UI form. |
Server-Group-Email-Admin-Port2 (Component name: com.bmc.arsys.server) | Port number (RMIPort ) for email administration in Email Engine. If RMIPort is different from the default (1100 ), set this option to the new, port number to enable the server to communicate email administration information to Email Engine during server group processing. For example, in a single Email Engine configuration, use this syntax: Server-Group-Email-Admin-Port: 2020 If multiple Email Engines are configured for the server, each engine must have a unique RMIPort. For a multiple Email Engine configuration, use semicolons to separate the RMIPort numbers. For example: Server-Group-Email-Admin-Port: 2020;2030;2040 | No | No | AR System Configuration Generic UI form. |
Server-Group-Flashboards-Admin-Port2 (Component name: com.bmc.arsys.server) | Port number (RMIRegistryPort ) for Flashboards administration in the Flashboards server. If the default Flashboards port number is changed, set this option to the new port number to enable the server to communicate Flashboards administration information to the Flashboards server during server group processing. For example: Server-Group-Flashboards-Admin-Port: 2021 | No | No | AR System Configuration Generic UI form. |
Server-Group-Log-File (Component name: com.bmc.arsys.server) | Name and location of the server group trace log file. The default name is arsrvgrp.log. For example: Server-Group-Log-File: c:\temp\servgroup.log | No | No | AR System Configuration Generic UI form. |
Server-Group-Member (Component name: com.bmc.arsys.server) | Flag indicating whether the server is a member of a server group. Valid values: T and F (default). | No | Yes | System > General > Server Information > Configuration > Server Group Member. (See Setting-administrative-options.) |
Server-Name (Component name: com.bmc.arsys.server) | An alias that is always interpreted as the current server. This option is used in multiple server installations to differentiate servers. If you specify a value for this option, enter the value after the -h option when you use the command-line utility. Do not specify a fully qualified name for this option. For example, use alpha instead of alpha.remedy.com. If this server belongs to a server group and you use a common server alias, you must also specify the Server-Connect-Name option. | No | No | AR System Configuration Generic UI form. |
Server-Plugin-Alias2 (Component name: com.bmc.arsys.server) | Alias of a plug-in server. When the AR System server calls a plug-in server, it must determine whether the plug-in server name is an alias. Aliases can direct the AR System server to access a plug-in server running on a different host or listening at a specified port number. The syntax is Server-Plugin-Alias: <aliasName> <realName> <hostName>[:<portNumber>] Workflow (that is, references to AR Filter API and ARDBC plug-ins) references a plug-in name. This name can be an alias. This enables you to run a plug-in on a remote host or to run more than one instance of a plug-in on a host. For example, to run the RMDY.ARDBC.XML plug-in on the remote host foo at port number 12345, add the following entry to the AR System server configuration file: Server-Plugin-Alias: RMDY.ARDBC.XML RMDY.ARDBC.XML foo:12345 The alias and real plug-in names can be identical if you run the plug-in on a remote host. To run more than one instance of the plug-in on the same or different hosts, create different aliases that reference the same plug-in on its respective hosts. | No | No | AR System Configuration Generic UI form. |
Server-Plugin-Default-Timeout (Component name: com.bmc.arsys.server) | Number of seconds in which the plug-in server must respond to a call before an error is returned. The minimum value is 0. The maximum is 600. Default: 60 | No | No | AR System Configuration Generic UI form. |
Server-Plugin-Target-Password (Component name: com.bmc.arsys.server) | Encrypted password used to call a plug-in server. The AR System server uses this password whenever it communicates with a plug-in server running on the specified host and port. The syntax is {{Server-Plugin-Target-Password: <hostName>:<portNumber>: <encryptedPassword> | No | No | AR System Configuration Generic UI form. |
Server-Side-Table-Chunk-Size (Component name: com.bmc.arsys.server) | For server-side table fields, the number of requests (or size of the chunk) that the server retrieves at one time from the database and stores in memory to process during filter or filter guide actions. The server then retrieves, stores, and processes the next chunk until all requests are processed. The value 0 causes the server to retrieve an unlimited number of requests. The default is 1000 requests. Specifying a lower value causes the server to process smaller chunks, which reduces server memory use but results in slower processing because the server must access the database many times, especially for large tables. Specifying a higher value causes the server to retrieve and process large chunks of data and access the database fewer times. This results in improved performance at the cost of increased memory use. | No | No | System > General > Server Information > Configuration > Server Table Field Chunk Size.(See Setting-administrative-options.) |
Server-Stats-Rec-Interval (Component name: com.bmc.arsys.server) | Interval (in seconds) at which the server records server statistics. Default: 60 seconds | No | No | AR System Configuration Generic UI form. |
Server-Stats-Rec-Mode (Component name: com.bmc.arsys.server) | Server statistics recording mode. This option determines what information is recorded in the server statistics form. Valid values:
To see the statistics, open the Server Statistics form. | No | No | AR System Configuration Generic UI form. |
Server-Temp-Table-Threshold | This parameter creates a temporary table when the following conditions are true:
The AR System server populates the temporary table with these static values and uses this temporary table in the database query. Default value: 200 Maximum value: 10000 | Yes | No | AR System Configuration Generic UI form. |
Set-Process-Timeout (Component name: com.bmc.arsys.server) | Number of seconds the AR System server waits before ending a Set Fields process that did not finish. Values are 1 through 60. Default value: 5 | No | No | AR System Configuration Generic UI form. |
SQL-Log-File (Component name: com.bmc.arsys.server) | Full path name of the file to use if SQL logging is on (see Debug-mode). | No | No | AR System Configuration Generic UI form. |
SQL-Secure-Connection (Component name: com.bmc.arsys.server) | (Microsoft SQL Server only) Flag indicating the type of authentication to use to connect AR System to a Microsoft SQL Server database. Valid values:
| No | No | AR System Configuration Generic UI form. |
SQL-Server-Always-On (Component name: com.bmc.arsys.server) | To enable the multi-subnet failover parameter for Microsoft SQL server database failover
| No | No | AR System Configuration Generic UI form. |
SQL-Server-Set-ANSI-Defaults2 (Component name: com.bmc.arsys.server) | An option that causes the server to issue a SET ANSI_NULLS ON command. | No | No | AR System Configuration Generic UI form. |
Stale-Data-Cleanup-Cron-Job-Schedule (Component name: com.bmc.arsys.server.shared) | Schedule the Data clean-up utility run in your environment. Default value — 0 0 0 * * MON-SUN By default, the Data clean-up utility is scheduled to run every day at midnight. We recommend changing the default value. You must schedule the Data clean-up utility run during non-business hours.
| Yes | No | AR System Configuration Generic UI form. |
Submitter-Mode (Component name: com.bmc.arsys.server) | Flag indicating whether the Submitter field can be changed and whether the submitter of a request must have a write license to modify it. Valid values:
| No | Yes | AR System Configuration Generic UI form. |
Suppress-Logoff-Signals (Component name: com.bmc.arsys.server) | Flag indicates whether other servers in the server group are notified when a user logs off from a server in a server group. Accordingly, the license is released back to the license pool.
| No | AR System Configuration Generic UI form. | |
Suppress-warnings2 (Component name: com.bmc.arsys.server) | A series of zero or more message numbers (separated by spaces) that identify informational or warning messages that the system should suppress. Only server warnings and notes can be suppressed. | No | No | AR System Configuration Generic UI form. |
System-Logging-Options2 (Component name: com.bmc.arsys.server) | Bitmask that sets logging options for the operating system. Valid values:
| No | No | AR System Configuration Generic UI form. |
System-Messages-Displayed (Component name: com.bmc.arsys.server) | Flag to specify whether system messages appear in the prompt bar or a pop-up box. Valid values:
Alternatively, you can specify how system messages appear by changing the value in the Use Prompt Bar For field on the Configuration tab of the Server Information form. | No | No | AR System Configuration Generic UI form. |
TCD-Specific-Port (Component name: com.bmc.arsys.server) | TCP port for the arserver process. If this option is not set, the dispatcher is randomly assigned to an available port. (TCD stands for transaction control daemon.) | No | Yes | System > General > Server Information > Ports and Queues > Server TCP/IP Port. (See Setting ports and RPC numbers.) |
Thread-Log-File (Component name: com.bmc.arsys.server) | Full path name of the file to use if thread logging is on (see Debug-mode). | No | No | AR System Configuration Generic UI form. |
Track-API-Status (Component name: com.bmc.arsys.server.shared) | Determine whether to track the status of import definition APIs through the AR Metadata API Status log form. For more information about the AR Metadata API Status log form, see Viewing-the-API-status-of-import-definitions. Valid values:
| Yes | No | AR System Configuration Generic UI form |
Timeout-Queries-From-Get-Calls-Only (com.bmc.arsys.server.shared) | All SELECT queries from the GET call have a timeout same as the API timeout. For example, If the GET API call has a timeout of two minutes, the call to the database also times out in two minutes. Valid values:
| Yes | No | AR System Configuration Generic UI form |
Flag indicating whether the AR System server populates progress information (if any) during long-running administrative operations, such as definition imports. Valid values:
To retrieve the progress information, clients can use the GetServerInfo function with the AR_SERVER_INFO_ADMIN_OP_PROGRESS request tag. | No | No | AR System Configuration Generic UI form. | |
Translation-Service-Provider (Component name: com.bmc.arsys.server) | Specifies the provider that you want to use for real-time-translation in a chatbot or custom application. Valid values:
| No | No | AR System Configuration Generic UI form. |
Trust-Insecure-Connection (Component name: com.bmc.arsys.server) | Flag indicating whether or not self-signed sites can register for BMC Helix Digital Workplace Advanced, BMC Helix Digital Workplace Catalog, and Skype for Business. Valid values: T—Self-signed sites can register F—(Default) Self-signed sites cannot register | No | No | AR System Configuration Generic UI form. |
Two-Digit-Year-Cutoff2 (Component name: com.bmc.arsys.server) | Integer that specifies the cutoff year for interpreting a two-digit year as a four-digit year. For example, if the two-digit cutoff year is 2040:
If a two-digit year cutoff is not specified, a rolling two-digit year is used: Two-digit years are the years between the current year plus 29 years and the current year minus 70 years. For example, if the current year is 2002, two-digit years are the years between 1922 and 2031. | No | No | AR System Configuration Generic UI form. |
Use-Enum-Field-Recompute | Flag indicating whether to update the database table ALL_ENUM_VALUES if any of the Enum values are updated on any of the AR System forms. Valid values:
| Yes | No | AR System Administration Console > System > General > Centralized Configuration |
Use-FTS-In-Workflow (Component name: com.bmc.arsys.server) | Controls whether the server will use full text searches when executing queries during workflow that have full text indexed fields in the qualification. If this option is not used, the server will use the search capability of the database. The options are T (use FTS in workflow) and F (do not use FTS in workflow). | No | No | System > General > Server Information > FTS > Use FTS in Workflow. |
Use-Old-Get-List-Group (Component name: com.bmc.arsys.server.shared) | Enables the AR System server to override the GLG API restriction. Valid values:
| No | No | AR System Configuration Generic UI form. |
Use-Password-File (Component name: com.bmc.arsys.server) | Validation mechanism for unregistered AR System users. To set this value, use the Authenticate Unregistered Users check box in the EA tab of the AR System Administration: Server Information form. Windows Indicates whether the Windows domain service is used to validate users not registered with AR System. Valid values:
UNIX and Linux Indicates whether the /etc/passwd file is used to validate users not registered with AR System. Valid values:
| No | No | AR System Configuration Generic UI form. |
Use-Server-Connect-Name-In-Stats2 (Component name: com.bmc.arsys.server) | Flag indicating whether the server name specified by the Server-Connect-Name option is used as the value for the Server Name field when Server Statistics form entries are created. Valid values:
If the Server-Connect-Name is not configured, the default behavior occurs.
When a common server alias is specified for all servers in a server group, the same server name is used for the servers, effectively combining the statistics for all servers in the group. | No | No | AR System Configuration Generic UI form. |
Use-SHA256 | You cannot disable encryption once you enable it. Valid value:
| No | No | AR System Configuration Generic UI form.
|
User-Log-File (Component name: com.bmc.arsys.server) | Full path name of the file to use if user logging is on (see Debug-mode). | No | No | AR System Configuration Generic UI form. |
useARUserPreferenceForDateTimeFormat (Component name arsystem.bmc.arsys.midtier-DockerMTClusterUser) | Use the date and time format set for Display Date/Time Style (Web) in the Web tab of the User Preference form as the first priority for the forms with Progressive View enabled. The date and time format that the application users see are based on this setting. Valid values:
To learn more abut the values, see Web-client-preferences. | No | No | AR System Configuration Generic UI form. |
visualizer.renderer | Use this setting to select either HTML rendering or Flash rendering. Valid values:
| No | AR System Configuration Generic UI form. | |
VersionControl-Object-Modification-Log-Mode (Component name: com.bmc.arsys.server) | Option indicating whether the object modification log is enabled or disabled. When the log is enabled, it records every change to AR SystemAR System objects in your system (see Version-control-in-AR-System). Valid values:
You can also set this option by using the Object Modification Log field on the Version Control tab in the AR System Administration: Server Information form. See Setting-version-control-options. | No | No | AR System Configuration Generic UI form. |
VersionControl-Object-Modification-Log-Save-Definition-Files (Component name: com.bmc.arsys.server) | Option indicating whether the AR System server writes a definition file each time an object is created or changed (see Version-control-in-AR-System). This option is effective only when the object modification log is enabled. Valid values:
You can also set this option by using the Save Definition Files field on the Version Control tab in the AR System Administration: Server Information form. See Setting-version-control-options. | No | No | AR System Configuration Generic UI form. |
VersionControl-Object-Modification-Save-Definition-Files (Component name: com.bmc.arsys.server) | Controls whether the AR System serverwrites a definition file each time an object is created or changed. This option is effective only when the object modification log is enabled. Valid values:
| No | AR System Configuration Generic UI form. | |
VersionControl-Object-Reservation-Mode (Component name: com.bmc.arsys.server) | Option indicating whether object reservation is enforced or disabled. When object reservation is enforced, users can reserve server objects, and AR System prevents other users from modifying the reserved objects (see Version-control-in-AR-System). Valid values:
You can also set this option by using the Object Reservation field on the Version Control tab in the AR System Administration: Server Information form. See Setting-version-control-options. | No | No | AR System Configuration Generic UI form. |
Webhook-Callback-Max-Retries (Component name: com.bmc.arsys.server) | This parameter defines the maximum number of attempts to retry processing of the records that are failed due to external application connectivity issues. Default value: 288 times After the maximum number of attempts, if any of the pending object fails, then all the pending records are marked as failed. These records are not retried further. | Yes | No | AR System Configuration Generic UI form. |
Webhook-Callback-Retry-Interval (Component name: com.bmc.arsys.server) | This parameter defines an interval to retry processing of the records that are not processed because the external application is not reachable. Default value: 5 minutes | Yes | No | AR System Configuration Generic UI form. |
Webhook-Max-Field-Value-Size (Component name: com.bmc.arsys.server.shared) | Specifies the maximum size in bytes for an individual field value. When set, any data in a field exceeding this limit on all registered webhooks is truncated. Default value: 255 bytes Example: If you set the default value as 255 bytes, data in all fields across all registered webhooks is truncated to 255 bytes. | No | ||
Webhook-Max-Payload-Size (Component name: com.bmc.arsys.server.shared) | Sets the maximum payload size, in bytes, for all the registered webhooks. Default value: 0 bytes By default, no maximum size limit is set on the webhook payload. | No | ||
Webhook-Pending-Polling-Interval (Component name: com.bmc.arsys.server) | This parameter defines the time interval for the selector thread to wait for a signal to process the records pending on the AR System Webhook pending form. Default value: 300 seconds | Yes | No | AR System Configuration Generic UI form. |
Webhook-Worker-Thread-Count (Component name: com.bmc.arsys.server) | This parameter defines the number of worker threads to process webhook callbacks. Default value: 10 | Yes | No | AR System Configuration Generic UI form. {{/confluence_table-filter}} |
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.