Settings in the config.properties file
This topic describes the settings in the config.properties file.
The config.properties file is located at <MidtierInstallDirectory>\WEB-INF\classes.
Settings | Centralized configuration setting | Description |
---|---|---|
arsystem.activelinks.allow_permission_check | Yes | Determines if you can access a form via an active link. Displays an error message if the active link does not have permission to access a particular form. The next active link is not processed if the error message is displayed. Default value — true Needs restart? — Yes Note: You must clear form cache every time you change the property value. |
arsystem.allow_rtf_css_style_tags | Yes | Determines the applicable style for the content in the Rich Text Field. Default value — True Needs restart — No Note: When you change the value of this setting in Centralized Configuration, the change is implemented only after you log out of the Mid Tier and login again. |
arsystem.disable_popup_blocker | No | Disables popup blocker messages when this property is set to true. Default value — false |
arsystem.disable_webservice_caching | Yes | Use this property so that the Mid Tier caches the WSDL content on the first request and uses the cached object for future requests. If set to true, the Mid Tier will request the WSDL content each time the web service is called. Default value — false Needs restart? — No |
arsystem.dst_tz_info | This property is used as a fallback when the timezone or DST information is missing from the MomentJS library, used by Remedy Mid Tier. Needs restart? — Yes | |
arsystem.exclude_table_autorefresh_for_sessiontimeout | Yes | Excludes table auto refresh calls while calculating session timeout. If this is set to true then session times out despite the table auto refresh in ON. If this is false then table auto refresh calls will take part and reset the session timeout. Default value — true |
arsystem.search_chunk_size | Yes (Only if explicitly configured for Mid-Tier) | This property controls the result list default chunk size and helps to improve the performance. Default value — 1000 Needs restart? — Needs restart if parameter value is changed in the config.properties file. Restart is not required if you change the parameter value from Centralize Configuration. |
arsystem.table_autoRefreshMinInterval | No | Use this property to set the minimum value allowed for the table auto refresh interval rate. This is applicable for the entire table. If the system administrator sets the arsystem.table_autoRefreshMinInterval property to true in the config.properties file, then the global refresh rate set by the system administrator is applicable. Default value — 0 Needs restart? — No |
arsystem.usdst_tz_info | This property is used as a fallback when the timezone or DST information is missing from the MomentJS library, used by Remedy Mid Tier. Needs restart? — Yes | |
arsystem.view_server_stats_base_path | Yes | This property indicates the path of the view server stats base directory where view server statistics are generated. When Mid Tier starts, the server statistics are collected from the path mentioned in this property. Mid Tier uses the same path to build the cache. Needs restart? — Yes |
arsystem.compression_index | Property to handle Backchannel and Metadata (content) compression. Values are:
| |
arsystem.host.header_list | No | Note: The following procedure is applicable only for BMC Remedy AR System 9.1.00.001 and later. Perform the following steps before applying BMC Remedy AR System 9.1 Patch 001.
Proceed with the patch installation. |
arsystem.session_timeout | Yes | Number of minutes for which the current logon session remains inactive. When the time exceeds the arsystem.session_timeout value, you must log on again. For security guidelines see, Security planning in Remedy Deployment online documentation.
Needs restart? — No |
arsystem.licenserelease_timeout | Yes | Number of seconds before BMC Remedy Mid Tier releases an AR System license for a user, if the user does not log out of mid tier correctly. Needs restart? — No |
arsystem.arservers.<serverName>.admin_password | No | Password for an AR System account with administrative privileges. This password must match the Mid Tier Administration Password on the Connection Settings tab in the AR System Administration: Server Information form. Needs restart? — No |
arsystem.arservers.<serverName>.domain | No | Domain name for the AR System server. Needs restart? — No |
arsystem.arservers.<serverName>.port | No | Port number that the user previously configured to access the AR System server. If you have not configured a port number, leave this field blank. Needs restart? — No |
arsystem.arservers.<serverName>.rpc | No | Remote Procedure Call (RPC) protocol number that the AR System server uses. The RPC protocol number is used for connection to a private server. If you have not configured an RPC number, leave this field blank. Needs restart? — No |
arsystem.arservers.<serverName>.useshort | No | Indication that the BMC Remedy Mid Tier always uses the short name of an AR System server. Needs restart? — No |
arsystem.arservers.<serverName>.preload | No | Indication that preloading of the forms has been enabled for this AR System server. Values are:
Needs restart? — No |
arsystem.preference_servers_list | Yes | Name of the AR System server designated as a preference server. If you need multiple preference servers to support different departments or business units, you can specify multiple server names. When you enter more than one preference server, the system searches the list until it finds the first server that matches the user name and uses that server as the preference server. Needs restart? — No |
arsystem.authentication_server | Yes | Server that the mid tier uses to authenticate a user. If an authentication server is specified, the mid tier authenticates with the specified server. The authentication server must already be in the list of mid tier servers on the AR Server Settings page.
Needs restart? — No |
arsystem.arservers_list | Yes | List of AR System servers that are added to the selected mid tier on the AR Server Settings page. Needs restart? — No |
arsystem.homepage_server | Yes | AR System server that contains the home page that you want to open when the user logs on
Needs restart? — No |
arsystem.plugin_servers_list | Yes | Name of the AR System server designated as a data visualization module server. You can specify additional servers as backup servers in case the first module server goes down. Needs restart? — No |
arsystem.show_waiting_cursor | No | Indication that the wait cursor should be shown. Values are:
|
arsystem.log_level | Yes | Level of detail for logging information. Values are:
Note: You can see the pre-load start and end timestamp when you set the log level to Info or Warning. Irrespective of the logging level, mid tier logs the pre-load start and end time. Needs restart? — No |
arsystem.log_viewer | Yes | Method by which you want to view the log files. Values are:
Needs restart? — No |
arsystem.log_category | Yes | Type of information that should be stored in the log file. Values are:
Default value — All categories except Flashboards are selected by default. Needs restart? — No |
arsystem.log_format | Yes | Log output, which is generated using the standard Java 1.5 logging API, including Simple and XML formatting. Values are:
Needs restart? — No |
arsystem.log_filename | No | Name of the file with which the log file will be generated. Needs restart? — No |
arsystem.log_filepath | Yes | Directory in which the log files are stored. Note: You cannot change the log file name. Needs restart? — No |
arsystem.log_filesize | Yes | Maximum size (in kilobytes) a file can reach before a backup copy is automatically made. When the log file reaches this limit, a backup copy is made with the same file name and an incremental number (for example, armidtierN.log). Default value — 10240 KB Needs restart? — No |
arsystem.log_backups | Yes | Maximum number of backup files that the system will generate when the log file size exceeds the limit specified in the Maximum Log File Size (arsystem.log_filesize). Needs restart? — No |
arsystem.log_user | Yes | User name for which statements are logged. Needs restart? — No |
arsystem.pooling_max_ | Yes | Maximum number of connections in the AR System server Java API connection pooling. Needs restart? — Yes |
arsystem.use_connectionpooling | No | Indication whether the AR Server connection pooling should be used. Values are:
Needs restart? — Yes |
arsystem.cache_update_interval | No | Interval (in seconds) at which the cache information will be automatically updated. Note: For Development cache mode, the value must be 0. For Production cache mode, the value must be greater than 0. Needs restart? — No |
arsystem.cache_update_needed | No | Indication that the cache is updated automatically. You can still update the cache manually by clicking the Sync / Flush Cache button.
|
arsystem.crt_working_dir | No | Working directory where the BMC Remedy Mid Tier saves the report definitions. These report definitions are collected by the relevant report engine (Web, AR System). Needs restart? — No |
arsystem.ws_anonymous_user | No | User name for an anonymous web service user. Needs restart? — No |
arsystem.ws_anonymous_pwd | No | Password for an anonymous web service user. Needs restart? — No |
arsystem.browser_version_error | No | Flag that indicates whether browser version error message is on or off. If you use an unsupported browser, you can use this setting to turn the error message on or off.
Needs restart? — No |
arsystem.authenticator | No | Fully qualified class name of the login authentication module to be used, such as DefaultAuthentication or AtriumSSOAuthenticator. Needs restart? — Yes |
arsystem.authenticator.sso.enckey | No | Encryption key, if SSO Authentication is used Needs restart? — Yes |
arsystem.security_iframe_allowfromurls | This property specifies URLS that are allowed to embed mid tier within an iframe. Needs restart? — Yes | |
arsystem.securitytoken_enable | This property allows enabling or disabling CSRF token validation for security purpose. Default value — True Needs restart? — Yes | |
ardev.webwriter.comments | No | Comments that are added to the generated HTML that is cached by the mid tier to make the workflow debugger output more readable. Values are:
Needs restart? — No |
ardev.webwriter.whitespace | No | White space that is added to comments in the generated HTML that is cached by mid tier to make the workflow debugger output more readable. Values are:
Needs restart? — No |
ardev.webwriter.indent | No | Indentation that is added to comments in the generated HTML that is cached by mid tier to make workflow debugger output more readable. Values are:
Needs restart? — No |
arsystem.workflow_action.trim_leading_trailing_spaces | This property specifies the push-field-action values. Determines whether to trim or preserve the leading and trailing spaces. Default value — False Needs restart? — Yes | |
ardev.jswriter.comments | No | Comments that are added in the generated JS that is cached by mid tier to make workflow debugger output more readable. Values are:
Needs restart? — No |
ardev.jswriter.whitespace | No | White space that is added in the generated JS that is cached by mid tier to make workflow debugger output more readable. Values are:
Needs restart? — No |
ardev.jswriter.indent | No | Indentation that is added in the generated JS that is cached by mid tier to make workflow debugger output more readable. Values are:
Needs restart? — No |
ardev.allow_unconfigured_servers | No | Indication that server information for an AR System server that is not configured in mid tier can be retrieved. Values are:
Needs restart? — Yes |
arsystem.js_profile | No | Indication that the javascript generated from active links should be profiled and shown in the workflow logs. Values are:
Needs restart? — Yes |
arsystem.image.spinnerup | No | Name of the image from resources folder to use as the UP spinner for an integer field. Needs restart? — Yes |
arsystem.image.spinnerdown | No | Name of the image from resources folder to use as the DOWN spinner for an integer field. Needs restart? — Yes |
arsystem.image.diary | No | Name of the image from resources folder to use as an icon for a diary field. Needs restart? — Yes |
arsystem.image.calendar | No | Name of the image from resources folder to use as an icon for a calendar. Needs restart? — Yes |
arsystem.image.currency | No | Name of the image from resources folder to use as an icon for a currency field. Needs restart? — Yes |
arsystem.image.menu | No | Name of the image from resources folder to use as an icon for a menu. Needs restart? — Yes |
arsystem.image.text | No | Name of the image from resources folder to use as an icon for a character field. Needs restart? — Yes |
arsystem.image.time | No | Name of the image from resources folder to use as an icon for a time field. Needs restart? — Yes |
arsystem.image.tablechunkleft | No | Name of the image from resources folder to use as an icon for a left chunk image in a table field. Needs restart? — Yes |
arsystem.image.tablechunkdown | No | Name of the image from resources folder to use as an icon for a down chunk image in a table field. Needs restart? — Yes |
arsystem.image.tablechunkright | No | Name of the image from resources folder to use as an icon for a right chunk image in a table field. Default value — chunking_sprite.png Needs restart? — Yes |
arsystem.image.open | No | Name of the image from resources folder to use as an icon for a file upload button. Needs restart? — Yes |
arsystem.image.edit | No | Name of the image from resources folder to use as an icon for an edit button. Needs restart? — Yes |
arsystem.image.rtf | No | Name of the image from resources folder to use as an icon for an RTF button. Default value — field_rtf.gif Needs restart? — Yes |
arsystem.flash.image.spinnerup | No | Name of the image from resources folder to show UP spinner for an integer field in flashboards. Needs restart? — Yes |
arsystem.flash.image.spinnerdown | No | Name of the image from resources folder to show DOWN spinner for an integer field in flashboards. Needs restart? — Yes |
arsystem.flash.image.diary | No | Name of the image from resources folder to be shown as an icon for a diary field in flashboards. Needs restart? — Yes |
arsystem.flash.image.calendar | No | Name of the image from resources folder to be shown as an icon for a calendar in flashboards. Needs restart? — Yes |
arsystem.flash.image.currency | No | Name of the image from resources folder to be shown as an icon for a currency field in flashboards. Needs restart? — Yes |
arsystem.flash.image.menu | No | Name of the image from resources folder to be shown as an icon for a menu in flashboards. Needs restart? — Yes |
arsystem.flash.image.text | No | Name of the image from resources folder to be shown as an icon for a character field in flashboards. Default value — field_text.gif Needs restart? — Yes |
arsystem.flash.image.time | No | Name of the image from resources folder to be shown as an icon for a time field in flashboards. Needs restart? — Yes |
arsystem.flash.image.tablechunkleft | No | Name of the image from resources folder to be shown as an icon for left chunk image in a table field in flashboards. Needs restart? — Yes |
arsystem.flash.image.tablechunkdown | No | Name of the image from resources folder to be shown as an icon for down chunk image in a table field in flashboards. Needs restart? — Yes |
arsystem.flash.image.tablechunkright | No | Name of the image from resources folder to be shown as an icon for right chunk image in a table field in flashboards. Needs restart? — Yes |
arsystem.flash.image.open | No | Name of the image from resources folder to be shown as an icon for file upload button in flashboards. Needs restart? — Yes |
arsystem.scale_factor_X | No | Amount of space to be left for setting margins in table cells. Needs restart? — Yes |
arsystem.scale_factor_Y | No | Amount of space to be left for setting margins in table cells. Needs restart? — Yes |
arsystem.enableHttpTrace | No | Flag that enables recording of an http trace by a web server for every request in mid tier. Values are:
Needs restart? — Yes |
arsystem.resource_expiry_interval | No | Time limit (in seconds) for which resources (such as images, .css files, and JavaScript files) can be used Needs restart? — No |
arsystem.formhtmljs_expiry_interval | No | Time limit (in seconds) for which a form's generated html and JS data can be used Needs restart? — No |
arsystem.prefer_native_views | No | Default view, standard or web view, for the view type selection Note: This setting is evaluated when the system progresses through the view selection algorithm.
Needs restart? — No |
arsystem.ehcache.overflowToDisk | No | Flag that indicates whether the mid tier cache persists items to disk so that they survive between JVM restarts
Needs restart? — Yes |
arsystem.ehcache.overflowToDiskTemp | No | Flag that indicates whether the mid tier cache can overflow cache items temporarily to disk Note: Setting this property to True might create duplicate cache items.
Needs restart? — Yes |
arsystem.ehcache.maxElementsOnDisk | No | Maximum number of objects to be kept in the mid tier cache's disk storage Needs restart? — Yes |
arsystem.ehcache.diskcache.maxElementsInMemory | No | Maximum number of objects to be kept in memory for the disk cache component of the mid tier cache. When the number of total objects in the disk cache goes beyond this limit,cache disk flush invokes, keeping the cache files in sync. Default value — 250 Needs restart? — Yes |
arsystem.ehcache.memoryStoreEvictionPolicy | No | Policy with which objects are swapped between memory and disk Needs restart? — Yes |
arsystem.ehcache.midTierCacheDir | No | Indication that when the arsystem.ehcache.midTierCacheDir setting is blank, the default cache for BMC Remedy Mid Tier is the mid tier installation directory or cache. Needs restart? — Yes |
arsystem.ehcache.midTierCacheTempDir | No | Indication that when the arsystem.ehcache.midTierCacheTempDir setting is blank, the default temporary cache for BMC Remedy Mid Tier is the mid tier installation directory or cache. Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum elements in the memory You can use this property to override the arsystem.ehcache.maxElementsInMemory setting. Needs restart? — Yes |
arsystem.ehcache.referenceMaxElementsIn | No | Default maximum element weight for form images cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElementsIn | No | Default maximum element weight for activelinks cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for groups cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for roles cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for JS cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for displayed fields cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for fieldmaps cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for sysdata cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for compiled forms cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for forms cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for html cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for form fields images cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for shared resources cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for sync relationships cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for actor view cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for actor views mapping cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for hash cache Needs restart? — Yes |
arsystem.ehcache.referenceMaxElements | No | Default maximum element weight for ref count cache To get the exact number of objects in the memory, you must multiply the value of this setting with the value of the arsystem.ehcache.referenceMaxElementsInMemory setting. Needs restart? — Yes |
arsystem.ehcache.peerListener.scheme | No | Replication scheme with which the selected listeners interact. Each peer provider has a scheme name that can be used by caches to specify a replication type.
Note: This setting is used by ehCache internally. Needs restart? — Yes |
arsystem.ehcache.timeToLiveSeconds | No | Time limit (in seconds) for which an object can exist in the cache irrespective of its use. Default value – 0 Needs restart? - Yes |
arsystem.ehcache.timeToIdleSeconds | No | Time limit (in seconds) for which an object can exist in the cache without being used. Default value - 0 Needs restart? - Yes |
arsystem.ehcache.eternal | No | This attribute overrides the timeToLive and timeToIdle parameters. When this parameter is set to true, the object is not expired from the cache. Values are: True – The object is not expired from the cache. False – The object does not remain in the cache forever. Needs restart? – Yes |
arsystem.ehcache.diskExpiryThreadIntervalSeconds | No | Time interval (in seconds) between runs of the disk expiry thread. Default value – 600 seconds Needs restart? - Yes |
arsystem.ehcache.enableStats | No | Flag that indicates whether the cache statistics records cache hits and misses
Needs restart? — Yes |
arsystem.enable_Animation | No | Flag that indicates whether animation in Javascript should be enabled. This applies to animations, such as open dialog and flashboard.
Needs restart? — No |
arsystem.xmlhttp.get | No | Flag that indicates whether the AJAX calls made within the Backchannel requests use the http GET or POST method while sending requests to BMC Remedy Mid Tier
Needs restart? — No |
arsystem.windowiis.installed | No | Flag that indicates whether mid tier is running on the IIS server. This setting is used to display the information on the configuration overview page.
Needs restart? — No |
flashboards.showgraphinflash | No | Indication that charts are drawn by.using either Flash (interactive) or JFreeChart (image) in Flashboards Default value — 1 Needs restart? — Yes |
flashboards.min_flex_width | No | Minimum width of a chart in Flashboards Needs restart? — No |
flashboards.min_flex_height | No | Minimum height of a chart in Flashboards Needs restart? — No |
arsystem.searches.maxAllowed | No | Maximum number of search qualifications that can be stored for a user Needs restart? — Yes |
arsystem.enableMidTierPerfMBean | No | Flag that indicates whether the mid tier performance Mbean is deployed on startup and whether mid tier can provide additional monitoring parameters through JMX
Needs restart? — Yes |
arsystem.max_number_of_prefetch_thread | No | Maximum number of threads spawned during the preload operation. This parameter is per AR System server. Needs restart? — Yes |
arsystem.response.hostip | No | Flag that indicates whether the ARRESPONSEHOSTIP header is added to every response that goes out from the mid tier.
Needs restart? — No |
arsystem.allow.returnback.url | No | Flag that indicates whether direct access URL through LoginServlet is allowed
Needs restart? — Yes For security guidelines see, Security planning in Remedy Deployment online documentation. |
arsystem.daemonthread_priority | No | Priority for the daemon threads spawned from BMC Remedy Mid Tier for background threads, such as preload and synch Needs restart? — Yes |
arsystem.serverinfo.alertschema.update.interval | No | Time interval to verify whether the server information cached in mid tier is considered old. If this value is reached or exceeded, the server information is recached. Default value — 604800 Needs restart? — No |
arsystem.plugin_securitycheck | No | Flag that indicates whether the cross-site script attack detection should be checked for plugins
Needs restart? — No |
arsystem.use_connectionpooling | No | Flag that indicates whether to use connection pooling for the AR System server
Needs restart? — Yes |
arsystem.loginpage.enable_accessible_mode | Yes | Flag that indicates whether the Accessible mode field is enabled in the login page. Values are:
Needs restart? — |
arsystem.maxRetrieveForAutoCompleteMenu | No | Maximum number of items returned from a menu expand query Needs restart? — No |
arsystem.autoCompleteTypingTimeout | No | Timeout value for the auto complete functionality after which the auto complete menu will disappear Needs restart? — No |
arsystem.min_entries_for_streaming | No | Minimum number of entries retrieved in a native report after which the information is transferred to the browser Needs restart? — No |
arsystem.emit_X_UA_compatible_mode | No | Flag that indicates whether to emit compatible mode for browsers Property to set the document mode for the BMC Remedy Mid Tier forms or pages. You must flush Mid Tier cache after setting this property. Values are:
Note: This property is exclusively used for Internet Explorer. Needs restart? — Yes |
arsystem.nativereport.onscreen_max_entries | No | Maximum number of entries that will be displayed on the screen for native reports |
arsystem.FileExport_max_entries | No | Maximum number of entries that will be displayed for native reports while exporting to a file Needs restart? — No |
arsystem.webreport.onscreen_max_entries | No | Maximum number of entries that will be displayed on the screen for web (BIRT) reports Default value — 2000 Needs restart? — No |
arsystem.objectlist | No | Flag that indicates whether the object list is enabled on mid tier Values are:
Note: When set to true, ensure that the corresponding form to display object the list is imported on the AR System server. Needs restart? — No |
arsystem.enableSkins | No | Flag that indicates whether skins are enabled on the mid tier. Values are:
Needs restart? — No |
arsystem.inclusion_attachment_extensions | No | Comma-separated list of all file extensions that are allowed for attachments. Note: Attachment security must be defined on the server side for this property to have any effect. For more information, see Setting-security-restrictions-on-file-uploads. Needs restart? — No |
arsystem.inclusion_goto_urls | No | Comma-separated list of URLs that are allowed in the goto request parameter of LoginServlet and LogoutServlet so that the user is automatically redirected to the specified URL. Needs restart? — No |
arsystem.myreport.report_cache_limit | No | Maximum number of reports that will be saved for quick reports. Default value — 20 Needs restart? — No |
arsystem.host.header_list | No | Perform the following steps before applying BMC Remedy AR System 9.1 Patch 001.
Proceed with the patch installation.
|
arsystem.ehcache.midTierBackupCacheDir | No | Absolute path of the folder that contains the good copy of the backed up cache |
arsystem.xss_render_html | Yes | Use this setting to select the display type for HTML elements. 0 — All HTML elements are displayed as it is. The elements are not rendered.
2 — Displays tool tip with no security restrictions or limitations. Needs restart? — Yes |
visualizer.renderer | Use this setting to select either HTML rendering or Flash rendering. Valid values:
Needs restart? — Yes Important: If you are using Harman browser, set the value of the visualizer.renderer property to 1. |