Once you have verified that the essential installation starts, you may
wish to alter some configuration settings to suit your deployment.All of the common configuration settings are in .properties files residing in the \WEB-INF\config\ folder.
If you change the configuration properties, you must restart ARCHIBUS on the application server in order for your changes to take effect.
By default, Web Central enables only the single language that matches the server operating system locale. If your locale is “fr-FR”, Web Central will enable French. Loading fewer languages at startup speeds the start-up process.
Enabling Multiple Languages
However, you can enable multiple languages if you have users that speak different languages or if you wish to switch between languages. To do so:
WEB-INF\config\context\compatibility\afm-config.xml configuration file.Schema\mssql\MsSql_Schema.MDF or Projects\Hq\mssql\hq_zh-cn.mdf rather than schema.mdf or hq.mdf). You do not need to do this for Sybase or Oracle as these databases contain all languages in UTF-8 encoded form.Enabling Multiple Locales
All users can change their Locale in their My Profile form. For instance, they can change from "English (United States)" to "English (United Kingdom)", "French (France)", or "French (Canadian)". Doing so lets the user choose both the language they prefer as well as the other locale conventions, such as the area, date, and default local currency.
To enable a locale, the ARCHIBUS Administrator must enable the language corresponding to the locale in web-inf\config\context\compatibility\afm-config.xml\afm-config.xml. For instance, to enable the "French (France)" [fr_FR] and "French (Canadian)" [fr_CA] locales, the ARCHIBUS administrator must set the French (fr) entry in the <languages /> tag to enabled="true".
If you need a locale for a language that you do not have installed, such as "Korean" [ko_KR], you can still enable that language. Any or all missing strings will just default to their English equivalent.
ARCHIBUS ties together locale and language information in this way so that the ARCHIBUS Administrator can centrally administrate consistent language and locale features for all users. With these features, users can have the language and locale they prefer with one selection; however, all data from all users -- regardless of language, locale, locale date format, local units, etc. -- can enter data that correlates consistently on the central server.
See also: Adding Languages and Locales to the afm-config.xml File
ARCHIBUS can automatically send email notification messages when certain events occur. For example, the Move Management application sends email to a move coordinator when a move is requested. The Service Desk application sends notices when requests must be approved, must be scheduled, or have been escalated. The ARCHIBUS Administration application automatically sends account notifications to all ARCHIBUS users in bulk mailings, and so forth.
The mail.properties file holds the name, port and, optionally, the username and password of the account that ARCHIBUS should use to send these email notifications.
It also holds the generic email addresses that the system uses for certain actions:
administrator Is the administrator account that receives new password requests from the Sign In form or from which the system sends bulk notices, such as notices to large groups of new users that each should log in and change their password.
maintmgr Is the address of the maintenance manager used in the Technologies / User Interface Add-Ins / Assemblies with Tabs / Work Request Creation Wizard example. It is not used in the Service Desk or Building Operations products.
The other email addresses in this file are for compatibility with older versions of ARCHIBUS and are not used in the newer applications.
You may need to configure your email server to grant permissions to the server hosting ARCHIBUS to relay mail. This will likely be the case if the email server will be forwarding the mail to mailboxes on other servers, or if you have some users who auto-forward email to other addresses.
If you have a small company for which all mail boxes are hosted on a single mail server (or mail cluster) and all mail terminates at the receiving server, then you do not have to configure your mail server to allow the Web Central server to relay mail.
If you do enter a mail server account password, and if you do wish to encrypt this password in the file:
The smartclient.properties file holds preferences for all Smart Client programs that sign in to this application server.
If the reinstall property is true, the Smart Client will prompt the user to reinstall their software if the user is running a Smart Client version earlier than the one specified in the reinstall.version preference.
The projects\remote-client-install\smartclient.install.properties file holds a preference used by the remote Smart Client-Only installation program to set the default application server location that they all should sign in to, e.g.:
smartClient.applicationServerLocation=http://myappserver:8080/archibus/
The security.properties file controls ARCHIBUS security.
guestUserID. Is the ARCHIBUS User account name for the Guest account, which is accessed from the Sign In form.
systemUserID. Is the ARCHIBUS User account used to run scheduled rules. ARCHIBUS signs into this account automatically when it starts up.
useHierarchicalSecurity Controls whether ARCHIBUS enables hierarchical security.
sessionTimeout Is not used. See the web.xml deployment descriptor file topic below.
security.groups Specify what security group membership a user must have before they are able to perform certain sensitive operations, such as being able to edit views seen by all people, run actions such as Replace Column that edit data in bulk, or alter the data dictionary schema.
removeUnlicensedActivitiesOnStartup If true, the server application removes any unlicensed applications from the afm_userprocs and afm_roleprocs tables for all users and roles. Unlicensed applications are those that either do not exist, or are disabled in the stock ARCHIBUS license file (ai-licenses.bin) or in the add-in third-party license files.
The core.properties file holds preferences for the server application.
runScheduledRules Dictates whether this instance of the application will run the scheduled rules. In a cluster, you need only one application server to run the scheduled rules.
preloadFileIndex Dictates whether the ARCHIBUS application will scan the folder of application files and build an index for finding these files. Doing so slows startup but speeds overall performance thereafter.
If you are troubleshooting or if you are creating add-ins for ARCHIBUS, you may wish to set the debug.properties values. These should not be used in production.
debug. If true, sets the logging to archibus.log to capture additional information about requests to the application server and the database.
autoLogin. If set, these preferences allow you to have Web Central log in for you.
validateView. If true, this preference will validate the XML of your view files (.axvw files) against the ARCHIBUS XML schema.
The WEB-INF\web.xml deployment descriptor file relays information about the ARCHIBUS application to the application server that runs it. While this file holds many settings, the two that you may wish to set pertain to the length of the user session.
session-timeout Controls how long idle application server sessions last if they are idle before expiring automatically. Sites with large numbers of users often set this to a lower value (e.g. 5 minutes) to preserve server resources.
scriptSessionTimeout Controls how long the Ajax direct Web remoting script session lasts when idle. Set this slightly longer (e.g. 5 minutes 15 seconds) than the session-timeout.
You typically do not need to adjust the defaults as the Standard Single-User Installation program updates the \WEB-INF\config\jetty-service.conf file that controls the Jetty application server. In particular it holds:
The \WEB-INF\config\context\* folders hold other configuration files that control the ARCHIBUS server application.
The cases in which you would want to change these files are:
absoluteAppPath) in \WEB-INF\config\context\compatibility\afm-config.xmlThe Package and Deploy Wizard migrates the settings in the .properties files mentioned above. If you change other XML files, be certain to migrate those manually if you move your files to another server or upgrade to another version of ARCHIBUS.