ARGetServerInfo

Synopsis

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

requestList

A list of one or more server options to return (see the Server options section that follows).

Return values

serverInfo

The information retrieved from the server (see the Server options section that follows). The system returns NULL (AR_DATA_TYPE_NULL) for server options not retrieved due to error.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.

Server options

The server options represent server information about a specific server. The following server options can be retrieved using the ARGetServerInfo. If the option is not marked ( get only ), then the server option can be set with the ARSetServerInfo function.

• AR_SERVER_INFO_ACTLINK_DIR: The name of a directory where all external processes to be run by active links must reside. If the value is NULL, active links can run processes located anywhere.
• AR_SERVER_INFO_ACTLINK_SHELL: The name of a shell to use when running external processes from an active link. If the value is NULL, processes are run from /bin/sh (UNIX) or without a shell (Windows).
• AR_SERVER_INFO_ADMIN_ONLY: A flag that indicates whether the server is in Administrator Only mode ( T ) or not (F). When not in Administrator Only mode, subadministrators can also perform administrator duties. The default value is F (Not in Administrator Only mode).
• AR_SERVER_INFO_ADMIN_OP_PROGRESS (get only): A flag that indicates whether to report the progress of administrative operations, such as importing. A setting of 0 (the default) means that no progress information is provided, and 1 means that progress is provided. A program can view (but not set) this call. Its value contains progress indicator string if an administrative operation (such as importing) provides one and if AR_SERVER_INFO_ADMIN_OP_TRACKING was previously set to 1. Otherwise the value for AR_SERVER_INFO_ADMIN_OP_PROGRESS is empty.
  This is a read-only setting. Its value usually remains as an empty string. If AR_SERVER_INFO_ADMIN_OP_TRACKING was set to 1 previously; then, during an administrative operation, the server might periodically provide a progress indicator string value here. AR System API client programs can poll for this setting to track progress of long running operations.
• AR_SERVER_INFO_ADMIN_OP_TRACKING: A flag that indicates whether to provide any progress indicative information while an administrative operation (such as import) is taking place. A setting of 0 (the default) means that no progress information is provided, and 1 means that progress information is provided.
• AR_SERVER_INFO_ALLOW_BACKQUOTE_IN_PROCESS: A flag that indicates whether backquotes are allowed in a run process command string. A setting of 1 means backquotes are allowed. A setting of 0 means they are disallowed.
• AR_SERVER_INFO_ALLOW_GUESTS: A flag that indicates whether the server accepts guest users. Guest users are users not registered with the AR System. If allowed, guest users have no permissions but are allowed to perform some basic operations. Guest users can submit entries to forms for which permission has been given to the Public group and enter data in fields that have been defined as allowing any user to submit. If not allowed, unregistered users have no access to the system. Values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (allow guest users).
• AR_SERVER_INFO_AP_DEFN_CHECK: The length of time in seconds between checks by an application service to verify that definitions it is using from the AR System are correct. The value can be from 0 to 3600 seconds (1 hour). A value of 0 means to check definitions with each command. A larger value means a slight delay in recognizing changes to some definition, while a smaller value means the significant overhead of checking the definitions often. The default value is 300 seconds (5 minutes).
• AR_SERVER_INFO_AP_LOG_FILE: The name of the file to use if approval tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_AP_RPC_SOCKET: The RPC program number that the approval server uses when contacting the AR System. This allows you to define a specific AR System server for private use by the approval server.
• AR_SERVER_INFO_API_LOG_FILE: The name of the file to use if API tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_APP_SERVICE_PASSWD: The Application Service password. During a get action, this option returns a NULL if there is no password and returns an empty string if there is a password. For security reasons, the actual password string is not returned.
• AR_SERVER_INFO_APPL_PENDING (get only): The name of the form that contains the pending list of application commands to be processed. This form is specific to the use of Application-Commands.
• AR_SERVER_INFO_ARKFORK_LOG_FILE: The name of the file to use if arkfork tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).

• AR_SERVER_INFO_CACHE_DISP_PROP: An integer that indicates whether the server caches just server-only or all display properties by default.
• The default value is bits 1 and 2 (cache both VUI and field display properties). The AR_OPROP_CACHE_DISP_PROP property overrides AR_SERVER_INFO_CACHE_DISP_PROP for a specific schema.
• AR_SERVER_INFO_CASE_SENSITIVE (get only): A value that indicates whether the underlying database is case-sensitive. Valid values for this option are 0 (case-sensitive) and 1 (case-insensitive). The default value is 1 (case-insensitive).
  AR_SERVER_INFO_CLUSTERED_INDEX: A value that indicates whether a clustered index is created on the Entry-Id field when a new form is created. Valid values for this option are 1 (create a clustered index) and 0 (create a unique index). The default value is 1 (clustered), but you can override this in the AR System configuration file.
• AR_SERVER_INFO_CONFIG_FILE (get only): The path name of the AR configuration file.
• AR_SERVER_INFO_CURR_PART_DATE_STR (get only): The currency date string.
• AR_SERVER_INFO_CURR_PART_TYPE_STR (get only): The currency type string.
• AR_SERVER_INFO_CURR_PART_VALUE_STR (get only): The currency value string.
• AR_SERVER_INFO_CURRENCY_INTERVAL: The time interval, in minutes, before client programs refreshes currency ratios. A value of zero means never refresh.
• AR_SERVER_INFO_DB_CHAR_SET (get only): The character set of the AR System database.
• AR_SERVER_INFO_DB_CONNECTION_RETRIES: An integer that indicates the number of times the AR System server tries to connect to the database.
• AR_SERVER_INFO_DB_MAX_ATTACH_SIZE: The maximum size (in bytes) allowed for attached files in an Oracle database. The maximum valid value for this option depends on the database server operating system and configuration. The default value is 2 GB.
• AR_SERVER_INFO_DB_MAX_TEXT_SIZE: The maximum size (in bytes) allowed for long character text data in an Oracle, Microsoft SQL Server database. For an Oracle database, this value is also used for memory allocation during the processing of long text data, so if it is set too high, the database storage used by long text data might be very large. The default value for Oracle is 1 MB. For SQL Server the default and maximum values are 2,147,483,647 bytes.
• AR_SERVER_INFO_DB_NAME (get only): The name of the underlying SQL database (not applicable to Oracle databases). The default value is ARSystem.
• AR_SERVER_INFO_DB_TYPE (get only): The underlying database type (character string).
• AR_SERVER_INFO_DB_USER (get only): The user name AR System uses to access the underlying database.
• AR_SERVER_INFO_DB_VERSION (get only): The underlying database version (character string).
• AR_SERVER_INFO_DBCONF (get only): The complete contents of the db.conf (ardb.cfg ) file.
• AR_SERVER_INFO_DBHOME_DIR (get only): The home directory for the underlying SQL database.

• AR_SERVER_INFO_DEBUG_MODE: A bitmask that indicates the server debug modes.
• AR_SERVER_INFO_DEFAULT_ORDER_BY: An integer ( 1 or 0 ) that indicates the default order of requests in a form when issuing ARGetListEntry calls, so that the sorting is done on the database and before the results are returned. Valid values for this option are 0 (no sort order) or 1 (use EntryId order). The default value is 1.
• AR_SERVER_INFO_DELAYED_CACHE: A flag that indicates whether to disable recaching of the shared cache after a time-out (T) or not (F). The default value is F (delayed recache not disabled).
• AR_SERVER_INFO_DFLT_ALLOW_CURRENCIES: Default list of allowable currencies when new currency fields are created.
• AR_SERVER_INFO_DFLT_FUNC_CURRENCIES: Default list of functional currencies when new currency fields are created.
• AR_SERVER_INFO_DISABLE_ADMIN_OPERATIONS: The value that indicates whether certain operations performed only by administrators and subadministrators are disabled. Valid values for this option are 1 (Disabled) and 0 (Enabled).
• AR_SERVER_INFO_DISABLE_ARCHIVE: The value that indicates whether archiving is disabled. Valid values for this option are 1 (Disabled) and 0 (Enabled).
• AR_SERVER_INFO_DISABLE_FTS_INDEXER: The value that indicates whether the full text search (FTS) indexer is disabled. Valid values for this option are 1 (Disabled) and 0 (Enabled).

• AR_SERVER_INFO_DISABLE_NON_UNICODE_CLIENTS: A flag that indicates whether a Unicode server declines calls from non-Unicode clients. Regardless of the setting, however, calls from BMC Alert* and Developer Studio are always accepted. Valid values are as follows:

  The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
  This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
  * BMC Alert is no longer shipped with AR System.

• AR_SERVER_INFO_DS_LOG_FILE: The name of the file to use if distributed server tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).Valid values for this option are 1 (TRUE) and 0 (FALSE).
• AR_SERVER_INFO_DS_MAPPING (get only): The name of the form that contains distributed mapping definitions (only applicable to DSO only).
• AR_SERVER_INFO_DS_PENDING (get only): The name of the form that contains the pending operation list (only applicable to DSO).
• AR_SERVER_INFO_DS_RPC_SOCKET: The specific server socket to use for the distributed server. Valid values for this option are 390600 and 390680 through 390694. Any other value causes the distributed server to use the default server.
• AR_SERVER_INFO_DS_SVR_LICENSE: The distributed server license type (character string).
• AR_SERVER_INFO_DSO_DEST_PORT: The TCP port that the distributed server option uses to communicate with the AR System server.

• AR_SERVER_INFO_DSO_ERROR_RETRY: An integer that specifies the error retry behavior for DSO.
• AR_SERVER_INFO_DSO_MAX_QUERY_SIZE: The maximum number of entries that the Distributed Server Option (DSO) retrieves in a single query to the server. The minimum value for this option is 1, and there is no upper boundary.
• AR_SERVER_INFO_DSO_MERGE_STYLE: An integer ( 1 or 0 ) that indicates the merge style to use for the DSO. A 0 indicates the new style; 1 indicates the old style. The default is 0. For a 1 value (old style), the merge style overwrites entries; for a 0 value (new style), a true merge is performed according to the rules of the DSO setup. For backward compatibility, this server option can be set to 1.
• AR_SERVER_INFO_DSO_RPCPROG_NUM: The RPC program number settings that DSO uses to access the local server. The ranges available for private queues are:
  • 390600
  • 390621 to 390634
  • 390636 to 390669
  • 390680 to 390694
• AR_SERVER_INFO_DSO_TARGET_PASSWD: The password for the target DSO server. During a get action, this option returns a list of servers that have been assigned a password. For security reasons, the actual password strings are not returned.
• AR_SERVER_INFO_DSO_TIMEOUT_NORMAL: The number of seconds the DSO server waits before disconnecting inactive clients. The range of values is 60 to 21600 (60 seconds to 6 hours). The default value is 120.
• AR_SERVER_INFO_DSO_USER_PASSWD: The password for the DSO server. During a get action, this option returns a NULL if there is no password and returns an empty string if there is a password. For security reasons, the actual password string is not returned.
• AR_SERVER_INFO_EA_GROUP_MAPPING: Specifies mapping of LDAP groups to AR System groups for the purpose of external authentication. The value of this option consists of one or more pairs of group names separated by semicolons, as shown in the following 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 combined with AR_SERVER_INFO_EA_IGNORE_EXCESS_GROUPS, if desired.
• AR_SERVER_INFO_EA_IGNORE_EXCESS_GROUPS: A flag used by AR System during external authentication. A value of 0 indicates that the user is authenticated when there is a match between every LDAP group to which the user belongs and a corresponding group in AR System. A value of 1 indicates that the user is authenticated when any single LDAP group to which the user belongs matches a group in AR System, and the excess LDAP groups are ignored. The default value is 0.
  This option can be combined with AR_SERVER_INFO_EA_GROUP_MAPPING, if desired.
• AR_SERVER_INFO_EA_RPC_SOCKET: The RPC socket number on which an external authentication server awaits requests for authentication. A 0 value means external authentication is not used. This attribute persists in the ar.cfg /ar.conf file. The default value is 0.
• AR_SERVER_INFO_EA_RPC_TIMEOUT: The RPC timeout (seconds) used when making calls to the authentication (AREA) server (for example, 30 seconds). This attribute persists in the ar.cfg/ar.conf file. The default value is 30 seconds.
• {{id name="ARGetServerInfo-sync_timeout"/}}
  
  AR_SERVER_INFO_EA_SYNC_TIMEOUT: The interval (seconds) that AR System server uses to periodically call the AREANeedToSyncCallback() function on the external authentication server, which instructs the AR System server to renew its internally stored user information in the event there are changes made to the source used to authenticate users. A 0 value means that the AR System server does not call the external authentication (AREA) server. This attribute persists in the ar.cfg /ar.conf file. The default value is 3600 seconds.
• {{id name="ARGetServerInfo-salt"/}}
  
  AR_SERVER_INFO_AUTH_TOKEN_SIGNATURE_SALT: The authenticatin token's salt used while signing the token. The value is auto-generated by AR System server. During a get action, this option returns an empty string if there is a value. For security reasons, the actual value string is not returned. During a set action, the AR System server generates a new value.
• AR_SERVER_INFO_EMAIL_AIX_USE_OLD_EMAIL: A flag that indicates whether to use the old email or the new Email engine. A zero (0) setting indicates that the new email is used. A setting of one (1) indicates that the old email is used. (AIX only)
• AR_SERVER_INFO_EMAIL_FROM: The sender name to use for filter-generated email notifications where no subject is specified. Only trusted email users can use this name (see documentation about the /etc/sendmail.cf file for more information about trusted users). (UNIX only)
• AR_SERVER_INFO_EMAIL_IMPORT_FORM: A flag that indicates whether to enable or disable the import of the email forms. If set to zero (0), the forms are not imported. If set to one (1), the forms are imported.
• AR_SERVER_INFO_EMAIL_LINE_LEN: The maximum line length of e-mail messages.
• AR_SERVER_INFO_EMAIL_SYSTEM: A character string that indicates the email system on UNIX.
• AR_SERVER_INFO_EMAIL_TIMEOUT: (UNIX only) The length of time in seconds before the system closes the pipe to sendmail to unblock the AR System server. Valid values for this option are from 1 to 300. The default value is 10.
• AR_SERVER_INFO_EMBEDDED_SQL (get only): A value that indicates whether the underlying SQL database is embedded (bundled with AR System). Valid values for this option are 0 (not embedded) and 1 (embedded).
• AR_SERVER_INFO_ERROR_EXCEPTION_LIST: A list of error codes that cause diagnostic output to be written to the error log when the server encounters the errors.
• AR_SERVER_INFO_ESCALATION_LOG_FILE: The name of the file to use if escalation tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_EXCEPTION_OPTION: A value that indicates the diagnostic output option for exceptions. A setting of 0 indicates that a stack trace is to be included. A setting of 1 indicates that a stack trace is not to be included.

• AR_SERVER_INFO_EXPORT_VERSION (get only): An integer that indicates the server's export version number.

• AR_SERVER_INFO_EXT_AUTH_CAPABILITIES: A value that indicates the return data capabilities for the AREA plug-in in use. This setting does not control the AREA plug-in. It only describes the behavior of the plug-in, allowing for server optimization.
• AR_SERVER_INFO_FILT_MAX_STACK: The maximum number of levels of recursion allowed for a given operation. The data modification performed by an AR_FILTER_ACTION_FIELDP filter action could trigger a second set, or level, of filters, one of which could trigger filters a third level down 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.
• AR_SERVER_INFO_FILT_MAX_TOTAL: The maximum number of filters that the server executes for a given operation. The default value is 10000.
• AR_SERVER_INFO_FILTER_API_RPC_TIMEOUT: The time limit, in seconds, for the filter API RPC to respond to the server's request before an error is returned. The default value is 40 seconds. The minimum value is 1, and the maximum value is 300.
• AR_SERVER_INFO_FILTER_LOG_FILE: The name of the file to use if filter tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_FIXED_LICENSE (get only): The number of fixed user licenses (int).
• AR_SERVER_INFO_FLASH_DAEMON: A flag that indicates whether Flashboards is installed (T) or not (F). The default value is 1 if the server has one or more Flashboards licenses, and 0 if the server has no licenses.
• AR_SERVER_INFO_FLOAT_LICENSE (get only): The number of floating write licenses defined.
• AR_SERVER_INFO_FLOAT_TIMEOUT: The number of hours the server waits before disconnecting inactive users. If a user is holding a floating write license token, the system also frees the token at this time. The default value is 2 hours.
• AR_SERVER_INFO_FLUSH_LOG_LINES: A value ( 1 (TRUE) and 0 (FALSE)) that indicates whether the server flushes every line written to a log to disk. If the line is not flushed to disk, the line is buffered by the file system.
• AR_SERVER_INFO_FT_CASE_SENSITIVITY: A flag that specifies case sensitivity for the server's full text option. A value of 0 indicates that full text searching is case-sensitive. A value of 1 indicates that full text searching is not case-sensitive. The default value is 1.
• AR_SERVER_INFO_FT_COLLECTION_DIR: The location in the file system where full text indexes are stored.
• AR_SERVER_INFO_FT_CONFIGURATION_DIR: The location in the file system where search engine configuration files are stored.
• AR_SERVER_INFO_FT_DISABLE_SEARCH: A value that indicates the server's full text searching state. Valid settings are 0 (full text searching enabled) and 1 (full text searching disabled). The default value is 0.
  Disabling full text searching applies only to field-based searching. It does not apply to multi-form searching.
• AR_SERVER_INFO_FT_FORM_REINDEX: A value that specifies reindexing all full text indexed fields on specified forms. When using this option for indexing, supply a character string containing the form names separated by a form-feed character ('\f'). On retrieval, this option returns the list of forms separated by a form-feed character where indexing is still pending. (The AR_SERVER_INFO_FT_REINDEX option specifies reindexing of all of the forms on the server. When re-indexing tasks are pending, there is no distinction between how they originated when returning the operation status.)
• AR_SERVER_INFO_FT_RECOVERY_INTERVAL: The number of minutes the server waits between periodic attempts to index entries that unexpectedly failed to index in a prior attempt. The default value is 60.
• AR_SERVER_INFO_FT_REINDEX: A value that specifies reindexing all of the forms that have full text indexed fields on the server. A setting of 1 initiates the reindex operation. On retrieval, this option is set to 1 if a reindex operation is in progress. Otherwise, the setting is 0. (The AR_SERVER_INFO_FT_FORM_REINDEX option specifies reindexing of all full text indexed fields on specified forms. When re-indexing tasks are pending, there is no distinction between how they originated when returning the operation status.)

• AR_SERVER_INFO_FT_SEARCH_MATCH_OP: The server's match option for full text search match option. Valid settings are as follows:

  The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
  This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
  The default value is 4.

• AR_SERVER_INFO_FT_SIGNAL_DELAY: A value that specifies the number of seconds before a signal that needs an index is sent to the server that owns the full text indexing operation in a server group (if no signal is pending). The default value is 10 seconds.
• AR_SERVER_INFO_FT_STOP_WORDS: A list of words to be ignored during indexing. The words are separated by semicolons.
• AR_SERVER_INFO_FT_SUPPORT_EXACT_MATCH_SEARCH: A flag that specifies if the Full Text Search (FTS) feature of a server supports exact match searches for phrases. The value 0 indicates that an exact match search is not supported, whereas the value 1 indicates that an exact match search is supported. The default value is 0. Enabling an exact match search significantly increases the size of the full text indexes because all words in the Ignore Words List are indexed. The Ignore Words List contains the words that are to be ignored during indexing. An ignore word is a commonly used word (for example, "the") that a search engine ignores, when indexing entries for searching and when retrieving them as the result of a search query.
  For more information, see Configuring-full-text-search-for-a-server-group and Configuring-the-Ignore-Words-List-for-FTS-indexing. 
• AR_SERVER_INFO_FT_TEMP_DIR: The location where temporary files associated with the search engine are stored.
• AR_SERVER_INFO_FT_THRESHOLD_HIGH: During the processing of full text-search data, the server combines results from sub-queries to generate a final set of results. If the number of rows created during processing exceeds this value, the server returns an error that indicates that the search is too complex. The default value is 1,000,000.
• AR_SERVER_INFO_FT_THRESHOLD_LOW: During the processing of full text-search data, the server creates a temporary table if the number of matches equals or exceeds this value. If the number of matches is under this value, the server uses the SQL IN operator for a query on an existing table. The default value is 200.
• AR_SERVER_INFO_FTEXT_FIXED (get only): The number of fixed FTS licenses defined.
• AR_SERVER_INFO_FTEXT_FLOAT (get only): The number of floating FTS licenses defined.
• AR_SERVER_INFO_FTEXT_TIMEOUT: The number of hours the server waits before disconnecting inactive users with FTS licenses. If a user is holding a floating FTS license token, the system also frees the token at this time.
• AR_SERVER_INFO_FTINDEXER_LOG_FILE: The file name used for the full text indexer log.
• AR_SERVER_INFO_FULL_HOSTNAME (get only): The full DNS host name of the server ("long" machine name).
• AR_SERVER_INFO_G_CACHE_CHANGE (get only): The time of the last change to the group cache.
• AR_SERVER_INFO_GUESTS_RESTRICT_READ: Specifies whether guest users are granted a restricted read license. Values for this option are 1 (TRUE) or 0 (FALSE). The default value is 0.
• AR_SERVER_INFO_GUID_PREFIX: The character string used as a prefix for generated GUIDs.
• AR_SERVER_INFO_HARDWARE (get only): The server hardware type (character string).
• AR_SERVER_INFO_HOMEPAGE_FORM: The server homepage form (character string).
• AR_SERVER_INFO_HOSTNAME (get only): The host name of the server ("short" machine name).  

• AR_SERVER_INFO_IP_NAME: A string that contains multiple names for the server, separated by semicolons.
• AR_SERVER_INFO_JAVA_VM_OPTIONS: The Java Virtual Machine (JVM) options.
• AR_SERVER_INFO_LOCALIZED_SERVER: A variable that indicates whether the server is localized. Values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (server is localized).
• AR_SERVER_INFO_LOGFILE_APPEND: A value ( 1 (TRUE) or 0 (FALSE)) that indicates whether to create a separate *.bak file or to append to the existing log file. A 0 value creates a *.bak file; a 1 value indicates that new log information be appended to the existing file. The default value is 0 (creates a *.bak file).
• AR_SERVER_INFO_MAX_ENTRIES: The maximum number of entries returned by a single query. Because users can also specify the maximum number of entries returned (in query preferences), the actual maximum is the lower of these two values. The default value is no (server-defined) maximum.
• AR_SERVER_INFO_MAX_F_DAEMONS=29: Represents the maximum number of fast processes assigned. Obsolete server option.
• AR_SERVER_INFO_MAX_L_DAEMONS=30: Represents the maximum number of list processes assigned. Obsolete server option.
• AR_SERVER_INFO_MAX_LOG_FILE_SIZE: The maximum size for system log files. The default value is 0 (no limit).
• AR_SERVER_INFO_MAX_PASSWORD_ATTEMPTS: The maximum number of times that someone can attempt to log in with an invalid password. If this number is exceeded, the account is locked until the password is reset by the user or an administrator. Valid values are 0 (unlimited) or any positive integer. The default value is 0.
• AR_SERVER_INFO_MAX_SCHEMAS (get only): The maximum number of forms allowed. The default value is 0 (no limit).
• AR_SERVER_INFO_MESSAGE_CAT_SCHEMA (get only): The name of the BMC Message Catalog form.
• AR_SERVER_INFO_MID_TIER_PASSWD: The password that the Mid Tier uses to access the AR System server. During a get action, this option returns a NULL if there is no password and returns an empty string if there is a password. For security reasons, the actual password string is not returned.

• AR_SERVER_INFO_MINIMUM_API_VER: A value that indicates the minimum API version that the server supports. The API versions are:

• AR_SERVER_INFO_MINIMUM_CMDB_API_VER: A value that indicates the minimum CMDB API version that the server supports. The API versions are:
• AR_SERVER_INFO_MULTI_SERVER (get only): An integer (0 /1 ) value that indicates the use of the multi-server option. A 0 value indicates a single server; a 1 value indicates the use of the multi-server option.

• AR_SERVER_INFO_MULTIPLE_ARSYSTEM_SERVERS: A flag that indicates that more than one server is running on the host system. Valid values are 1 (TRUE) and 0 (FALSE). The default value is FALSE.

• AR_SERVER_INFO_NEXT_ID_BLOCK_SIZE: Specifies the block size at which entryID s for all schemas are allocated. This setting is used to enhance the performance of the CREATE ENTRY operation.
  Values for this option are as follows:

  The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
  This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
  The default value is 1. If an invalid setting is encountered, the option is forced to a setting of 1.
  You can override AR_SERVER_INFO_NEXT_ID_BLOCK_SIZE for a specific schema by setting the Next Request ID Block Size form property in Developer Studio.
  AR_SERVER_INFO_NEXT_ID_BLOCK_SIZE does not work on the "distributed pending" schema. Correct operation of Distributed Server Option (DSO) requires entryIDs to be specified in the order in which they were written.
  Use of AR_SERVER_INFO_NEXT_ID_BLOCK_SIZE might result in gaps in the entryID sequence. A gap occurs if an entryID transaction completes successfully, but the remainder of the operation is rolled back. The entryID would be lost because it cannot be returned to the system.

• AR_SERVER_INFO_NEXT_ID_COMMIT: During a CREATE ENTRY operation for a schema, specifies whether to commit the current transaction immediately after an entryID is retrieved and updated, and start a new one for the remainder of the operation. Values are 1 (TRUE) and 0 (FALSE). If this setting is not specified in the ar.conf file, the default value is FALSE.
  If this option is set to TRUE, then during creation of an entry, the existing transaction is committed and a new transaction is started immediately after the entryID has been assigned. This behavior allows other pending transactions to proceed sooner.
  AR_SERVER_INFO_NEXT_ID_COMMIT provides a small performance improvement at the expense of potential gaps in the entryID sequence. A gap occurs if an entryID transaction completes successfully, but the remainder of the operation is rolled back. The entryID would be lost because it cannot be returned to the system.
  Instead of AR_SERVER_INFO_NEXT_ID_COMMIT, you might prefer to use AR_SERVER_INFO_NEXT_ID_BLOCK_SIZE. The latter option is more flexible and offers a more significant enhancement in performance.
• AR_SERVER_INFO_NFY_TCP_PORT: The TCP port that the server uses.
• AR_SERVER_INFO_NOTIFY_WEB_PATH: The default WWW path for URL shortcuts embedded in e-mail notifications.
• AR_SERVER_INFO_ORACLE_BULK_FETCH_COUNT: Defines the number of the rows of data fetched at a time from the result set when querying an Oracle database. The minimum is 1, the maximum is 100, and the default is 50. Higher values cause the AR System server to use more memory but make fewer database fetches during data retrieval.
• AR_SERVER_INFO_ORACLE_CLOB_STORE_INROW: Specifies whether CLOBs in the Oracle database are stored IN ROW. Values for this option are 0 (DISABLE STORAGE IN ROW) and 1 (ENABLE STORAGE IN ROW). The default value is 0.
  It is recommended that diary fields and character fields with unlimited length be created with IN ROW storage disabled.
• AR_SERVER_INFO_ORACLE_SID (get only): The system ID of the Oracle database you are accessing. This option has a value only if you are using an Oracle database.
• AR_SERVER_INFO_ORACLE_TWO_T (get only): The two-task environment setting for remote access to an Oracle database. This option has a value only if you are using an Oracle database.
• AR_SERVER_INFO_OS (get only): A character string that indicates the server operating system that includes the version number.
• AR_SERVER_INFO_PER_THREAD_LOGS: A value ( 1 (TRUE) and 0 (FALSE)) that indicates whether the server creates a log for each worker thread. A value of zero means the worker threads use the shared logs. A value of 1 causes each thread to create its own copy of the shared logs.
• AR_SERVER_INFO_PLUGIN_ALIAS: A list of plug-in aliases.
• AR_SERVER_INFO_PLUGIN_DEFAULT_TIMEOUT: The number of seconds the server waits for a response from the plug-in server. The range of values is 60 to 600 (60 seconds to 10 minutes). The default value is 60.
• AR_SERVER_INFO_PLUGIN_LOG_FILE: The name of the plug-in service log file (see AR_SERVER_INFO_DEBUG_MODE).
  For information about the plug-in logging feature, see Run-the-plug-in-server.
• AR_SERVER_INFO_PLUGIN_LOG_LEVEL: An integer that specifies the logging level for plug-ins. Values range from 100 to 10000. The default value is 10000 (OFF).
  For descriptions of the predefined logging levels, see Run-the-plug-in-server.
• AR_SERVER_INFO_PLUGIN_PASSWD: The plug-in service password. During a get action, this option returns a NULL if there is no password and returns an empty string if there is a password. For security reasons, the actual password string is not returned.
• AR_SERVER_INFO_PLUGIN_PORT: An integer that specifies the port of the plug-in server. A value of 0 for the port means no port was specified.
• AR_SERVER_INFO_PLUGIN_TARGET_PASSWD: The password that the AR System server uses to communicate with a plug-in service that runs at the host name and port number specified. During a get action, this option returns a list of servers that have been assigned a password. For security reasons, the actual password strings are not returned.

• AR_SERVER_INFO_PREF_SERVER_OPTION: An integer that specifies the preference server behavior for this server, to be honored by the client. The default value is 1.
• AR_SERVER_INFO_PS_RPC_SOCKET: The RPC program number and port pairs the private queues use. A value of 0 for the port means no port was specified.
• AR_SERVER_INFO_REGISTER_PORTMAPPER: A flag that indicates whether to register with AR System Portmapper (T) or not (F). The default value is 1.
• AR_SERVER_INFO_REM_SERV_ID (get only): The AR System server ID associated with the license (character string).
• AR_SERVER_INFO_RPC_CLIENT_XDR_LIMIT: An integer that specifies the maximum size in bytes of RPC data a client can send to the AR System server. The default value is 0, which means there is no limit.
• AR_SERVER_INFO_RPC_NON_BLOCKING_IO: A flag that indicates whether the server is in RPC non blocking I/O mode or not. Valid values are 1 (TRUE) and 0 (FALSE). The default value is 0 (FALSE).

• AR_SERVER_INFO_SAVE_LOGIN: A value that indicates whether users must log in to clients.
• AR_SERVER_INFO_SCC_COMMENT_CHECKIN: An integer (0 or 1) value that indicates whether a source code control integration requires you to enter a comment at check-in time. The default 1 value means no comment is required.
• AR_SERVER_INFO_SCC_COMMENT_CHECKOUT: An integer (0 or 1) value that indicates whether a source code control integration requires you to entire a comment at checkout time. A default 1 value means no comment is required.
• AR_SERVER_INFO_SCC_ENABLED: A value that indicates whether a source code control system is being used with the AR System. An F value (default) means a source code control system is not present.
• AR_SERVER_INFO_SCC_INTEGRATION_MODE: An integer (T or F) value that indicates the level of source code control integration. An F (the default) value indicates an advisory level of integration, which means that you can modify and save an object without having it checked out from the source code control application. A T value means enforced integration, which has strict rules for controlling source files (for example, enforced integration means that other administrators are not able to modify and save changes on an object that you have checked out).
• AR_SERVER_INFO_SCC_PROVIDER_NAME: A character string for the source code control system provider name. If none is present, this value is NULL. This string is limited to 255 characters.
• AR_SERVER_INFO_SCC_TARGET_DIR: A 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.
• AR_SERVER_INFO_SERVER_DIR (get only): The data directory for the AR System. This directory contains support files for the underlying SQL database (but no actual database files). For flat file databases, this directory contains both database definition and data files.
• {{AR_SERVER_INFO_SERVER_IDENT }}(get only): The unique identifier for the server (character string).
• AR_SERVER_INFO_SERVER_LANG(get only): The local language setting of the server.
• AR_SERVER_INFO_SERVER_LICENSE(get only): The server license type (character string).
• AR_SERVER_INFO_SERVER_NAME: An alias for the current server name. The AR System server provides this name when it receives a request for the server name. The value for this field is the name without the domain extension. The AR System server automatically appends the current domain name to the name. For example, if the server is in the domain arrow.com, and the value for this setting is alpha, the name is alpha.arrow.com. Note that a setting of alpha.arrow.com results in an unrecognizable name: alpha.arrow.com.arrow.com.
  See also Server-Name in the ar.conf file.
• AR_SERVER_INFO_SERVERGROUP_INTERVAL: The interval (in seconds) for server group checking.
• AR_SERVER_INFO_SERVERGROUP_LOG_FILE: The file name used for the server group log.

• AR_SERVER_INFO_SERVERGROUP_MEMBER: The value that indicates whether the server is a server group member.
• AR_SERVER_INFO_SERVERGROUP_NAME: The server group name.
• AR_SERVER_INFO_SET_PROC_TIME: The number of seconds the server waits before ending a Set Fields process that has not completed. Valid values for this option are 1 through 20. The default value is five seconds.

• AR_SERVER_INFO_SG_AIE_STATE (get only): The server group Atrium Integration Engine state.

• AR_SERVER_INFO_SG_EMAIL_STATE (get only): The server group email state.

• AR_SERVER_INFO_SG_FLASHBOARDS_STATE (get only): The server group flashboards state.
• AR_SERVER_INFO_SQL_LOG_FILE: The name of the file to use if SQL tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_SSTABLE_CHUNK_SIZE: The maximum number of entries fetched during server side table processing. Zero (0) is unlimited.
  AR_SERVER_INFO_STATS_APISQL_CONTROL: An integer bitmask indicating the control options that were chosen. 1 specifies "Display to console ."  
• AR_SERVER_INFO_STATS_APISQL_MAX_SAVED: An integer that indicates the maximum number of longest API and SQL operations that can be saved in memory. 
• AR_SERVER_INFO_STATS_APISQL_INTERVAL: An integer that indicates the time in minutes between flushing the longest operations saved in memory to the database.  A value of 0 indicates that no automatic flushing occurs. T
• AR_SERVER_INFO_STATS_APISQL_MIN_TIME: An integer that indicates the minimum elapsed time (in milliseconds) for an operation to qualify for saving. 
• AR_SERVER_INFO_STATS_GET_INCOMPLETE_API: A character value containing a formatted list of the current incomplete API calls.   
• AR_SERVER_INFO_STATS_GET_LONGEST_API: A character value containing a formatted list of the current longest API calls saved in memory. 
• AR_SERVER_INFO_STATS_GET_INCOMPLETE_SQL: A character value containing a formatted list of the current incomplete SQL calls. 
• AR_SERVER_INFO_STATS_GET_LONGEST_SQL: A character value containing a formatted list of the current longest SQL calls saved in memory.
• AR_SERVER_INFO_STRUCT_CHANGE (get only): The last structure change (for this run of the server).
• AR_SERVER_INFO_SUBMITTER_MODE: A value that indicates whether the Submitter field can be changed and whether the submitter of an entry must have a license to modify it. Valid values for this option are 1 (locked) and 2 (changeable). The default value is 2 (changeable).
  In lockedmode:
  • the Submitter field cannot be changed after submit.
  • the submitter with or a read or a write license, but not with a restricted read license, can modify the entry (if the Submitter group has Change permission).
    In changeable mode, the Submitter field can be changed after submit, but the submitter must have a write license to modify the entry (if the Submitter group has Change permission).
• AR_SERVER_INFO_SUPPRESS_WARN: A series of zero or more message numbers (separated by spaces) that identify the informational or warning messages that the system suppresses.

• AR_SERVER_INFO_SVR_EVENT_LIST: A character string that consists of a list of numeric event types separated by semicolons. If this tag is not set or does not include event types, the server does not create an event schema or record schema events. If the server does not recognize an event type, it ignores that element. When this option has a value of NULL, the server removes the event list.
• AR_SERVER_INFO_SVR_STATS_REC_INTERVAL: The time interval, in seconds, that the server records statistics into the server statistics form.

• AR_SERVER_INFO_SVR_STATS_REC_MODE: An integer that specifies the type of recording modes that the server uses to record server statistics. This determines if statistics are recorded in the server statistics form.

• AR_SERVER_INFO_SYS_LOGGING_OPTIONS: A value that indicates the logging options for operating system logging.
• AR_SERVER_INFO_TCD_TCP_PORT: The TCP port that the AR System server uses. The dispatcher is randomly assigned to an available port if you do not specify this option.
• AR_SERVER_INFO_THREAD_LOG_FILE: The name of the file to use if thread tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_TWO_DIGIT_YEAR_CUTOFF: An integer that indicates the two-digit year cutoff.
• AR_SERVER_INFO_U_CACHE_CHANGE (get only): The time of the last change to the user cache.
• AR_SERVER_INFO_UNQUAL_QUERIES: A flag that indicates whether the server allows unqualified queries. Unqualified queries are ARGetListEntry calls in which the qualifier parameter is either NULL or has an operation value of 0 (AR_COND_OP_NONE). These queries can cause performance problems, especially for large forms, because they return all entries for a given form. If not allowed, you can return all form entries by specifying a "dummy" qualification such as 1 = 1. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is TRUE (allow unqualified queries).
• AR_SERVER_INFO_USE_CON_NAME_IN_STATS: A integer that indicates whether to use the default server name or the server connect name in statistics entries. Valid values are 0 (default name) and 1 (connect name). The default value is 0.
• AR_SERVER_INFO_USE_ETC_PASSWD: A flag that indicates whether the /etc/passwd file is used to validate users not registered with the AR System (UNIX only). If so, users in /etc/passwd are considered valid users of the AR System and are assigned to a group identified by the UNIX group ID. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 1 (use password file).
• AR_SERVER_INFO_USER_CACHE_UTILS: A flag that indicates whether the arcache and arreload utilities are enabled. Valid values for this option are 0 (disabled) and 1 (enabled).
• AR_SERVER_INFO_USER_LOG_FILE: The name of the file to use if user tracing is turned on (see AR_SERVER_INFO_DEBUG_MODE).
• AR_SERVER_INFO_VERSION (get only): The AR System server version (character string).
• AR_SERVER_INFO_XREF_PASSWORDS: A flag that indicates whether the /etc/passwd file is cross-referenced if an AR System user has no password (UNIX only). This option enables you to manage group membership and other support information by using the AR System but still manage passwords using the /etc/passwd file. Valid values for this option are 1 (TRUE) and 0 (FALSE). The default value is 0 (blank passwords are not cross referenced).