This configuration file primarily allows you to define how the communication between the Automation EngineDiese Komponente steuert ein Automation Engine-System. Besteht aus verschiedenen Serverprozessen. (AE) and the AWIAutomic-Produkt: Übersichtliche und einfach zu bedienende Weboberfläche, mit welcher der Zugriff auf verschiedene Funktionalitäten der Automation Engine möglich ist. server, and AWI and its clients runs. This topic covers the parameters that you might need to modify for your local setup.
Configuration required?
Only when you want to define custom property settings; otherwise the defaults will be used.Most of these use default values set by Automic for optimum performance and so you should not modify them unless expressly advised to do so by Automic support consultants.
Related components
The AWI framework.
File location
When you have installed the AWI, you find this configuration file in your Tomcat web application server, in the folder ...\webapps\<AWI>\config.
Steps...
Structure
The following table lists the parameters of the configuration.properties file that you might want to define for your local setup.
PARAMETER | DESCRIPTION |
---|---|
There are several categories of properties, as follows: |
|
Home Dashboards |
This helps you manage user-customized versions of home dashboards. |
defaultHomeDashboard |
The name of the dashboard object (DASH) for the default AWI Home Dashboard for your installationnull. Change this if you want to replace the delivered default with a company-defined standard dashboard. Regardless of which dashboard is defined here, users with editing rights to the DASH objects and Dashboards can choose to use another dashboard to be their own home dashboard. Default: DASH.HOME.DEFAULT |
customHomeDashboardsFolder |
The name of the folder path where the dashboard objects for user-customized home dashboards are stored. For more information, see Dashboards in the AWI and Setting Up Home Dashboards for Users. Default: ECCVeralteter Begriff. Ersetzt durch: AWI/DASHBOARDS/HOME |
Cookies | |
autofill.cookie.allowed |
If you set this parameter to "true", a cookie for login information is set at user log in. On log in the following information will be stored: System, client, user name and department (but not the password). Allowed values: "true" or "false" |
LoginAnmeldedaten für Zielsysteme. Auch ein eigener Objekttyp in der Automation Engine. Settings |
|
sso.enabled |
Specifies whether single sign-on (SSO) can be used for AWI log in, so that users can log into AWI with their domain name and password that they log into their computer with. true = SSO enabled false = SSO not enabled (default) When they first log in, they have to provide their sign-on information and select Kerberos sign-in. For information about the full setup and details about the login options this approach provides, see Configuring AWI Login and User Authentication. |
parameter_login.enabled |
Specifies whether the AWI login window opens, the parameters for Connection, Client, Name, and Department are already filled in. Users need to enter only their password. true = login parameters except password are filled in false = no login parameters are filled in (default) If this is enabled, then the AWI startup will recognize login parameters that are added to the start URL in the following format: https://<AWI >/#&system=ConnectionName&client=9999&name=MyUserName&department=Dept Note: If your browser is not accessing AWI over an SSL protocol, your URL will start with http://. For information, see Configuring AWI Login and User Authentication. |
automationEngine.index |
Also referred to as "multi-connection support," this controls whether users can choose an AE connection when logging into this AWI installation or they are restricted to the specified connection. The connections are defined in <connection> elements in the Values are: -1 = Users can choose a connection at login. (Default) 0–n = The number corresponding to the connection element in the Note: If only one connection is defined in the uc4config.xml, then just use the default value here. |
Network Settings |
|
push |
Activates push communication between the AWI clients and the Apache Tomcat web server they run on. Push is the default and recommended communication technology, because it enables faster interaction with the user interface. Values: true = push is active (default) false = push is not used Note: Not all browser types support WebSockets, which push communication uses. If push is active (push = true) and a user logs into AWI on an incompatible browser type, then AWI continues uninterrupted, but it runs all communication over HTTP(S) protocol. Important: See the Troubleshooting: Some antivirus software interferes with WebSocket communication channels. If you find that people are not able to log in, you might have to modify the configuration of your virus scanners to allow WebSocket communications for the AWI. |
AWI Online Help |
|
helpUrl.english * |
The location of the start page of the AWI help in English Default: http://docs.automic.com/documentation/WEBHELP/English/all/components/DOCU/12.0/AWA+Guides |
helpUrl.french * |
The location of the start page of the AWI help in French Default: http://docs.automic.com/documentation/WEBHELP/French/all/components/DOCU/12.0/AWA+Guides |
helpUrl.german * |
The location of the start page of the AWI help in German Default: http://docs.automic.com/documentation/WEBHELP/German/all/components/DOCU/12.0/AWA+Guides |
AWI Object Validation | |
promptset.validation.mandatory |
Controls whether users who define workflows (JOBP objects) must provide values in all required fields in all prompt sets in the workflow before saving the workflow definition. This includes the prompt sets in the JOBP object as well as those in the properties of its workflow tasks (child objects). By default, all required prompt set fields must be defined. Turning this off would allow intermediate saves when building large workflows. No matter how a workflow is saved, when a workflow is executed, all required prompt set fields have to be filled before processing can start. Values:
|
Providing AWI help on a company intranet
When users select the menu item "Open Online Help" in the AWI, the start page of the help opens. The default locationfor each language is the start page of the related online documentation that you find on docs.automic.com. The content is updated periodically, even between releases, to ensure that you and your users can have the latest information that we can provide.
If, however, your company security policy prohibits Internet access, then use the following steps to make the help available to your AWI users on your company's secured intranet:
Load the webhelp onto your intranet.
helpUrl.english=https://our.intranet.com/Automic/ECC/documentation/12/english/help.htm
Note: Download and update the documentation with each service pack.
Help in German and French: When a major or minor release of AWI is made available, only English help is provided. With the first service pack after the major or minor release, the translated German and French versions will be available.
Example
Here is a sample of the configuration.properties file with all parameters defined. Among other specifications, here a folder location has been specified for user-customized home dashboards of users who have authorization to save their modifications to those dashboards.
defaultHomeDashboard = COMPANY_DASHBD
customHomeDashboardsFolder = ECC/DASHBOARDS/HOME
sso.enabled = true
push=true
helpUrl.english=https://our.intranet.com/Automic/ECC/documentation/12/english/help.htm
promptset.validation.mandatory=true