Error: Invalid spaceKey on retrieving a related space config.

ar.cfg or ar.conf options S-Z

Note

BMC recommends to use the AR System Configuration Generic UI form to modify the configuration settings. You should not use the ar.cfg file to modify the configuration settings available on the AR System Configuration Generic UI form. See Configuration Settings S-Z.

This section of the table includes the options for the ar.cfg (ar.conf ) file that begin with the letters S and Z. 

ar.cfg (ar.conf) file options (S-Z)

Tips

  • Press F to view the table in full screen mode. Press Esc to exit full screen mode.
  • To easily search for a specific parameter in the below table, select the parameter from the Option list. Alternatively, type the name of the parameter in the Option text box.
    For example, to search for the SCC-Enabled parameter, select it from the Option list, or type the parameter name in the Option text box.
  • To search for all parameters having a specific text string in the name, type the text string in the Option text box.
    For example, to search for all SCC parameters, type SCC in the Option text box.
  • To search for the parameters which have a specific text string in the description, type the string in the Description text box.
    For example, to search for the parameters which have NOLOCK in the description, type NOLOCK in the Description text box.

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

OptionDescriptionMaps to
Save-Login

Flag indicating whether users must log in to client tools. This option enables users to save a previous login of their choice. Values are

  • 0 — (Default) Login is controlled by user.
  • 1 — Do not force a login controlled by the administrator.
  • 2 — Force a login controlled by the administrator.

This option does not apply to the mid tier.

The default values is set to 2.

 
SCC-Comment-Checkin

Flag indicating whether a source code control integration requires you to enter a comment at checkin. Values are

  • 0 — (Default) No comment is required.
  • 1 — A comment is required.
 
SCC-Comment-Checkout

Flag indicating whether a source code control integration requires you to enter a comment at checkout. Values are

  • 0 — (Default) No comment is required.
  • 1 — A comment is required.
 
SCC-Enabled

Flag indicating whether a source code control system is being used with BMC Remedy AR System. Values are

  • 0 — (Default) Source code control system is disabled.
  • 1 — Source code control system is in use.
 
SCC-Integration-Mode

Flag indicating the level of source code control integration. Values are

  • 0 — (Default) Advisory level.
  • 1 — Enforced level.
 
SCC-Provider-NameName of the source code control provider. For example: Visual Source Safe. 
SCC-Target-DirCharacter string for the source code control system target directory. If none is present, this value is NULL. This string is limited to 255 characters. 
Select-Query-Hint 2Text 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 

Server-Connect-Name 2

Name of the computer where the AR System server is installed. 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: <mycomputername>
Server-Connect-Name: <myComputerName.domain.com>

If a common server alias is specified, this option is required. 

This name must be resolvable by DNS and is used exactly as specified. (See Configuring server groups.)

 
Server-directory1Full path name of the AR System data directory. This directory contains support and log files for the AR System server. Support files are the lock files (.lck) created by the AR System server. 
Server-Group-Email-Admin-Port 2

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
 
Server-Group-Flashboards-Admin-Port 2

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
 
Server-Group-Log-FileName 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 

Server-Group-Member 3

Flag indicating whether the server is a member of a server group. Values are T (default) and F.

The Server Group Member field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Server-Name

An alias that is always interpreted as the current server. This option is used in multiple server installations to differentiate servers. In a server group, Server-Name refers to the load balancer name.

If you specify a value for this option, enter the value after the -h option when you use thearreload command-line utility. Otherwise, arreload uses the default server name rather than the name specified by this option. Do not specify a fully qualified name for this option. For example, use alpha instead of alpha.remedy.com.

Note: If this server belongs to a server group and you use a common server alias, you must also specify the Server-Connect-Name option. (See Server-Connect-Name.)

 
Server-Plugin-Alias  2

Alias of a plug-in server. When the BMC Remedy AR System server calls a plug-in server, it must determine whether the plug-in server name is an alias. Aliases can direct the BMC Remedy 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:12345The 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.

 
Server-Plugin-Default-Timeout 

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. The default is 60.

The default value is set to 120 seconds.

 
Server-Plugin-Target-PasswordEncrypted password used to call a plug-in server. The BMC Remedy 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> 
Server-Side-Table-Chunk-Size 

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.

The Server Table Field Chunk Size field on the Configuration tab of the AR System Administration: Server Information form. (See Setting administrative options.)
Server-Stats-Rec-Interval

Interval (in seconds) at which the server records server statistics. The default is 60 seconds.

The Recording Interval field on the Server Statistics tab of the AR System Administration: Server Information form.
Server-Stats-Rec-Mode

Server statistics recording mode. This option determines what information is recorded in the server statistics form. Values are

  • 0 — (Default) Recording is off.
  • 1 — The server records only cumulative queue statistics (the sum of all the individual queue statistics).
  • 2 — The server records both cumulative and individual queue statistics. One entry is written for the cumulative statistics and a separate entry is written for each queue.

To see the statistics, open the Server Statistics form. (See Server statistics for baseline data.)

The Server Recording Mode field on the Server Statistics tab of the AR System Administration: Server Information form.
Set-Process-TimeoutNumber of seconds the BMC Remedy AR System server waits before ending a Set Fields process that did not finish. Values are 1 through 60. The default value is 5. 
SLM-Collector-Suspended

In a server group environment, the AR System server automatically sets the value of this parameter. The parameter value is based on the corresponding operational rankings and ownership.

Valid values:

— Indicates that the SLM Collector operation is not currently owned by the local AR System server and the server does not process SLM Collector requests.

F — Indicates that the SLM Collector is currently owned by the local AR System server and the server processes SLM Collector requests.

Warning:

If you change this setting manually, the AR System server may overwrite the manual setting.


SQL-Server-Always-On

To enable the multi-subnet failover parameter for Microsoft SQL server database failover

  • T- Set the multi-subnet failover parameter.
  • F- Disabled (Default)
 
SQL-Log-FileFull path name of the file to use if SQL logging is on (See Debug-mode). 
SQL-Secure-Connection

Flag indicating the type of authentication to use to connect BMC Remedy AR System to a Microsoft SQL Server database. Values are

  • T — Windows Authentication
  • F — SQL Authentication

For information about using this parameter on Oracle, see the SSL Encryption for AR to Oracle Connections with Remedy article on BMC Communities.

 
SQL-Server-Set-ANSI-Defaults 2Option that causes the server to issue a SET ANSI_NULLS ON command. 
Submitter-Mode

Flag indicating whether the Submitter field can be changed and whether the submitter of a request must have a write license to modify it. Values are

  • 1 — Locked mode. The Submitter field cannot be changed after a request is submitted. If the Submitter group has change permission, the request can be modified by submitters with a read or write license but not by users with a restricted read license.
  • 2 — (Default) Changeable mode. The Submitter field can be changed after a request is submitted. If the Submitter group has change permission, the submitter must have a write license to modify the request.

The default values is set to 1.

 
Suppress-warnings 2A 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. 
Sybase-Character-Set 1(Sybase databases only) Alternative character set to use for communications between BMC Remedy AR System and the underlying database. 
Sybase-Server-Name 1(Sybase and Microsoft SQL Server only) Logical server name of the underlying database. The default value is SYBASE. 
System-Logging-Options 2

Bitmask that sets logging options for the operating system. Values are

  • 0 — (Default) Use normal operating system logging.
  • Bit 1 (value = 1 ) — Suppress logging to the operating system log file.
 
System-Messages-Displayed

Flag to specify whether system messages appear in the prompt bar or a pop-up box. Values are

  • 0 — (Default) Notes and warnings appear in the prompt bar, but errors will appear in a pop-up box.
  • 1 — All system messages willl appear in the prompt bar.
  • 2 — No messages will appear in a prompt bar. All messages will appear in a pop-up box.

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.

The default value is set to 2.

 
TCD-Specific-Port 

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

The Server TCP/IP Port field on the Ports and Queues tab of the AR System Administration: Server Information form. (See Setting ports and RPC numbers.)
Thread-Log-FileFull path name of the file to use if thread logging is on (See Debug-mode). 
Track-Admin-Op-Progress 2

Flag indicating whether the BMC Remedy AR System server populates progress information (if any) during long-running administrative operations, such as definition imports.

  • T — Track progress.
  • F — (Default) Do not track progress.

To retrieve the progress information, clients can use the GetServerInfo function with theAR_SERVER_INFO_ADMIN_OP_PROGRESS request tag.

 
Two-Digit-Year-Cutoff 2

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:

  • Two-digit years fall between 1941 and 2040.
  • 1/1/55 is interpreted as 1/1/1955.
  • 1/1/30 is interpreted as 1/1/2030.

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.

 
Use-FTS-In-Workflow

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

The Use FTS in Workflow field on the FTS tab of the AR System Administration: Server Information form. (See FTS tab configuration options.)
Use-Password-File

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 BMC Remedy AR System. Values are

  • T — Use domain service. Users in the Windows domain are considered valid users of BMC Remedy AR System and are assigned to the Public group.
  • F — (Default) Do not use domain service.

UNIX and Linux Indicates whether the /etc/passwd file is used to validate users not registered with BMC Remedy AR System. Values are

  • T — (Default) Use password file. Users in /etc/passwd are considered valid users of BMC Remedy AR System and are assigned to a group identified by the UNIX group ID.
  • F — Do not use password file.
 
Use-Server-Connect-Name-In-Stats 2

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

  • T — Use the Server-Connect-Name. This provides server-specific statistics when the server runs in a server group because the server enters a unique server name into the Server Statistics form.

If the Server-Connect-Name is not configured, the default behavior occurs.

  • F — (Default) Use the host name (or server alias if configured) with the domain name appended.

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.

 
User-Log-FileFull path name of the file to use if user logging is on (See Debug-mode). 
VersionControl-Object-Modification-Log-Mode

Option indicating whether the object modification log is enabled or disabled. When the log is enabled, it records every change to AR System objects in your system (See Version control in BMC Remedy AR System). Values are

  • 0 — (Default) Disabled
  • 10 — Enabled
The Object Modification Log field on the Version Control tab in the AR System Administration: Server Information form. (See Setting version control options.)
VersionControl-Object-Modification-Log-Save-Definition-Files

Option indicating whether the AR System server writes a definition file each time an object is created or changed (See Version control in BMC Remedy AR System). This option is effective only when the object modification log is enabled. Values are

  • 0 — (Default) Yes, a definition file is created.
  • 10 — No, a definition file is not created.
The Save Definition Files field on the Version Control tab in the AR System Administration: Server Information form. (See Setting version control options.)
VersionControl-Object-Reservation-Mode

Option indicating whether object reservation is enforced or disabled. When object reservation is enforced, users can reserve server objects, and BMC Remedy AR System prevents other users from modifying the reserved objects (See Version control in BMC Remedy AR System). Values are

  • 0 — (Default) Disabled
  • 10 — Enforced
The Object Reservation field on the Version Control tab in the AR System Administration: Server Information form. (See Setting version control options.)

 Workflow-Encryption-Algorithm

BMC Remedy Developer Studio provides the ENCRYPT and DECRYPT functions to encrypt and decrypt data in filters and escalations, securing the operations. By default, only the 56-bit DES algorithm is used for encryption, but you can specify the 256-bit AES algorithm for better security. To enable the 256-bit AES algorithm, add this parameter with the value that identifies the algorithm:

  • Workflow-Encryption-Algorithm:— Enter 1 to use the 56-bit DES algorithm. The 56-bit DES algorithm is available without installing additional products.
  • Workflow-Encryption-Algorithm:7 — Enter 7 to use the 256-bit AES algorithm. The 256-bit AES algorithm is available only if an additional BMC premium encryption is installed.

This algorithm is applied only when you use ENCRYPT function in BMC Remedy Developer Studio.

Note: BMC recommends that you use the 256-bit AES algorithm for better security.

 

XML-VUI-Export-Default-Is-Localized

Flag indicating whether to export localized views when forms are exported in XML definition format.

Values are T and F.

Default value: F

 
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.
3. This option is deprecated.
Was this page helpful? Yes No Submitting... Thank you

Comments