configuration.properties

This configuration file primarily allows you to define how the communication between the Automation Engine and the AWI server, and AWI and its clients runs. This topic covers the parameters that you might need to modify for your local setup.

This page includes the following:

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 CA Automic for optimum performance and so you should not modify them unless expressly advised to do so by CA Automic Support consultants.

Related components

The AWI framework.

File location

When you have installed the AWI, you find this configuration file in your application server, in the folder ...\<AWI>\config.

To Define the Configuration

  1. In your application server go to the folder ...\<AWI>\config.

  2. Open the configuration.properties file and update the configurations by adding the parameters that you need. Use the table that follows as a guide.

    The changes take effect after logging out and back in again.

Structure

The following table lists the parameters of the configuration.properties file that you might want to define for your local setup. There are several categories of properties:

General Properties

maxOpenBulkActions

If users want to open multiple objects/tasks at a time, they can select them in bulk, right-click and select Open. This opens as many tabs or windows as selected objects/tasks.

By default, the maximum number of tabs or windows that can be opened in one bulk selection is limited to 50, however you can change this limit using this parameter.

wfDisplaySettings

By default, tasks in a Workflow (whether on the editor in the Process Assembly perspective or on the monitor in the Process Monitoring perspective), display the name of the task first and its title (if available) beneath it. In addition to the Name and the Title, users can also assign it an Alias.

This parameter determines the information that is available at the top of the task boxes in the Workflow editor (Process Assembly perspective) and in the Workflow monitor (Process Monitoring perspective).

The tables below describe the behavior of the name, the title or the alias depending on how you set this parameter:

Connection Settings

automationEngineOpenConnectionTimeoutMilliseconds

If you have only one connection to the AE, this parameter specifies the timeout interval for the connection between the AWI and the CP.

If you have several connections to the AE, this parameter specifies the time interval for attempting to connect to the next CP in case the previous connection fails.

Default: 10000 (10 seconds)

Tip: Increase the timeout if you have a slow connection between Tomcat and the Automation Engine

Note: You define the connections to the AE in the uc4config.xml configuration file.

Home Dashboards

defaultHomeDashboard

The name of the Dashboard (DASH) object for the default AWI Home Dashboard for your installation. Change this if you want to replace the delivered default with a company-defined standard dashboard.

Note: 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 Setting Up Dashboards.

Default: DASHBOARDS

Import of Large and Complex *.xml Files

Importing large *.xml files or *.xml files that contain many objects can take a few minutes. While this process takes place in the background, it can cause an AWI timeout while you are waiting for the import to finish, and receive the confirmation.

The following parameters specify the AWI timeouts, on waiting for these background AE operations to finish. You can increase them if you are getting AWI timeouts:

automationEngineOpenConnectionTimeoutMilliseconds

asyncLoadingTimeoutMilliseconds

automationEngineTimeoutMilliseconds

xRequestExecutorTimeoutMilliseconds

Default:180000 (180 seconds)

Note: All four values should be changed to the same value.

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). This is used to autofill fields the next time the login screen is displayed.

Allowed values: true / false

Default value: true

Login Settings

sso.enabled

Specifies whether single sign-on (SSO) can be used for AWI log in. This allows users to use the domain name and password they use to log into their computer also to log into AWI.

Possible values:

When users first log in, they have to provide their sign-on information and select the Kerberos sign-in, see Setting up Single Sign-On. For information about the full setup and details about the login options this approach provides, see Configuring Automic Web Interface.

parameter_login.enabled

Specifies whether the AWI login window opens, the parameters for Connection, Client, Name, Department and Language are already filled in. Users need to enter only their password.

Possible values:

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&language=MyLanguage

Note: If your browser is not accessing AWI over an SSL protocol, your URL will start with http://.

automationEngine.index

Also referred to as multi-connection support, this parameter 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 uc4config.xml and would appear in a drop-down on the login page.

Possible values:

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.

Possible values:

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!

Online Help

helpUrl.pattern

Pattern for the context-sensitive help URL. The parameters are placeholders and are defined as follows:

{0} Language, for example {german}

{1} Version, for example {12.2}

{2} Product, which is {CDA%20Guides} or {AWA%20Guides}.

{3} CSHID

Default value: https://docs.automic.com/documentation/webhelp/{0}/ALL/components/DOCU/{1}/{2}/#CSHID={3}

If your company security policy does not allow Internet access to your users, you can provide the help on your company's secured intranet:

  1. Load the online help onto your intranet.

    1. Download the most recent documentation bundle from https://downloads.automic.com/.
    2. Go to Automation.Platform/Documentation/Guides/webhelp, where .zip files with the documentation in English (en), German (de) and French (fr) are available.
    3. Unzip the file content to a place on your local intranet that your AWI user clients have access to.

  2. Modify the URL manually to lead to the help.htm file at this location. For example:

    • For the English AWA documentation:

      https://localhost:8080/documentation/english/AWA/help.htm#CSHID={3}

    • For the French AWA documentation:

      https://localhost:8080/documentation/french/AWA/help.htm#CSHID={3}

    • For the German AWA documentation:

      https://localhost:8080/documentation/german/AWA/help.htm#CSHID={3}

    • For the CDA documentation (which is available in English only):

      https://localhost:8080/documentation/english/CDA/help.htm#CSHID={3}

Notes:

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 = DASHBOARDS

sso.enabled = true

helpUrl.pattern=http://localhost:8080/documentation/english/help.htm#CSHID={3}

promptset.valid = false

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.

Possible values: