Skip to main content

# WebUI Configuration

You can configure the Avantra WebUI runtime environment by setting the values for multiple parameters. Some of the parameters can be adjusted while the WebUI is running and others require a restart. If there is a refresh icon beside the parameter you need to restart the Avantra WebUI service before changes will take effect.

1. Select Administration > Settings from the top-level menu.
2. Choose Avantra UI.
3. Click on the Edit icon and change the value or on the Refresh icon to restore the default.
4. Click Save.

## WebUI Parameters​

### a5-listener-port​

Set a fixed listener port for Avantra WebUI. Set this port if you want to define a fixed port that is used for Avantra Server to Avantra WebUI communication. Make sure that this port is available! If this port is not set, a dynamic port is used. Set this port if your Avantra Server and Avantra WebUI are not running on the same host and a firewall prevents dynamic ports.

Default Value | Not set
Unit | Integer

### availabilities.downtimewindow​

The maximum downtime window in seconds for availability processing of Composite Checks and Business Services.

If downtime is greater than this value an Unknown record is written, otherwise, the old record is extended.

Default Value | 120
Unit | Seconds

### BusinessServicesOverview.ShowTooltips​

Defines whether or not tooltips are displayed in the Business Service overview.

Default Value | yes
Unit | Boolean

### clientcertusermapping​

See Using client certificates for login for a description.

Default Value |
Unit | String

### customer.label-1 to customer.label-5​

Defines the name of customizable additional fields.

When the name of the field is defined, the field is shown in the Customer pages (see also Defining Customers). When the name of the field is missing, the field is not displayed.

Default Value |
Unit | String

### customer.length-1 to customer.length-5​

Defines the length of fields defined through customer.label-1 to customer.label-5 values (maximum 1024).

Default Value | 128
Unit | Integer

### defaultMonitoringOffTime​

Defines the time in hours and minutes (in format HH:MM) used as Default Values for the Monitor off until date and Monitor off until time field once monitoring is turned off.

Default Value | 12:00
Unit | Hours

### defaultRtmConfirmTime​

Defines the time in hours and minutes (in format HH:MM) used as Default Values for the Confirm until date and Confirm until time field once monitoring is turned off.

Default Value | 12:00
Unit | Hours

### help-public-access​

Defines whether this document is accessible without login from Avantra WebUI.

Default Value | no
Unit | Boolean

### LogLevel​

Defines the level of messages to be logged in Avantra WebUI log files in `C:\Program Files\syslink\xangui\log` (on Microsoft Windows operating systems) or `/syslink/xangui/log` (on Unix-like operating systems)

Default Value | WARN
Unit | Enum

### logon.lockTimeMinutes​

The number of minutes a user is locked after a defined number of failed login attempts.

Default Value | 5
Unit | Minutes

### logon.maxFailedLoginTries​

The number of login attempts a user has before being temporarily locked. 0 means an infinite number of login attempts.

Default Value | 3
Unit | Number

### MaintWindowDefaultMoniSwitch​

Allows you to set a default value for creating Maintenance Windows to monitoring on or off.

Default Value | off
Unit | Enum

### ntf-test.timeout​

Defines the timeout for testing Notification Actions.

Default Value | 30
Unit | Seconds

### prefix​

Defines the content of the title tag of Avantra WebUI HTML pages.

Default Value | Avantra
Unit | String

### remember-me​

Defines if or if not the Remember Me checkbox is shown on the login page.

Default Value | yes
Unit | Enum

### reset-password​

Defines if or if not the Forgot Password link is shown on the login page.

Default Value | yes
Unit | Enum

### RTMControlCenterDashboard​

The Name of the Dashboard that shall be used as RTM Control Center, i.e. which is accessible by Monitoring > RTM Control Center.

Unit | String

### SAPCAR​

The full path to the SAPCAR utility used to extract files during automated kernel upgrades, e.g. `/syslink/sapcar/SAPCAR_1320-80000935.EXE`.

Default Value | empty
Unit | String

### SAPLogonSSOEnabled​

Enables Single Sign-On (SSO) for the SAP Logon.

Default Value | no
Unit | Boolean

### schedule-wait-time​

Defines a delay (in seconds) between each group of update-simultaneous-downloads update schedules.

Default Value | 60
Unit | Integer

### showunassignedchanges​

Defines whether or not the number of unassigned Changes is displayed in the Avantra WebUI toolbar.

Default Value | yes
Unit | Boolean

### slr.appendid​

Defines whether or a unique identifier is appended to a Service Level Report once it's published.

Default Value | yes
Unit | Boolean

### ticket.attachmentsToDelete​

Defines file extensions of attachments that are removed from Tickets in status Closed after the retention period defined in ticket.daysToKeepAttachments is expired. Separate multiple extensions with a space. wildcards * and ? are allowed. This parameter is only effective if ticket.daysToKeepAttachments is set to a value different from 0.

Default Value | `.log .zip .tar.gz .tmp .rar .tar .tgz`
Unit | String

### ticket.daysToKeepAttachments​

Defines how long to keep attachments of Tickets in status Closed before they get deleted automatically. If set to 0 attachments are not deleted automatically. Use ticket.attachmentsToDelete to define a list of file extensions that this parameter is effective for.

Default Value | 180
Unit | Days

### ticket.sendemail​

Defines whether emails are sent automatically to Ticket callers and owners after a new ticket log is written. The options are: Always, Never, and Ask.

Default Value | Ask
Unit | List

### ticket.updateindex​

Defines how often the Ticket list index is updated automatically. The value 0 means no automatic update. Automatic updates are only necessary if Tickets are created through Notification Actions.

Default Value | 60
Unit | Minutes

### ui-master-protocol​

Use a5 or a5s as a protocol for communication between Avantra WebUI and Avantra Server. Set this option to a5s when your Avantra WebUI and Avantra Server are not running on the same host.

|Protocol|Description| |a5|plain communication| |a5s|SSL/TLS secured communication|

Default Value | a5
Unit | Enum

### update-simultaneous-downloads​

There is a limit of simultaneous scheduled agent updates. Avantra WebUI will only schedule the defined number of updates at a time in order to restrict the number of concurrent download attempts for the Agent Self Updates.

If more updates are actually requested than defined, the Avantra Server waits schedule-wait-time seconds before scheduling the next ones, etc.

Default Value | 8
Unit | Integer

### url-replacement​

Defines the URL prefix used in the links contained in mails generated.

By default (i.e. empty) the mails contain links as displayed in the browsers location bar.

If you define a URL prefix, the relative UI URL will be appended to this value.

|Unit|String

### webservice​

Defines if the Webservice is available. See Enable/Disable the Avantra Web Service.

Default Value | false
Unit | Boolean

### HttpProxyHost​

Set an outgoing proxy. If set, this proxy is used for outgoing calls (Notifications, Cloud Services, Activation).

If you need a different proxy for the Activation, use the LicenseActivationHttpProxyHost, LicenseActivationHttpProxyUser and LicenseActivationHttpProxyPassword setting instead.

Format: host. Leave this field empty if no proxy is required.

|Unit|String

### HttpProxyUser​

Defines the user name in case the proxy defined in HttpProxyHost requires authentication.

### HttpProxyPassword​

Defines the password corresponding to HttpProxyUser.

### LicenseActivationHttpProxyHost​

Set an outgoing proxy for the Activation. You must only set this if you have different proxies and your primary proxy defined in HttpProxyHost cannot be used for Activation.

Format | `host`. Leave this field empty if no proxy is required.
Unit | String

### LicenseActivationHttpProxyUser​

Defines the user name in case the proxy defined in LicenseActivationHttpProxyHost used for Activation requires authentication.

### LicenseActivationHttpProxyPassword​

Defines the password corresponding to LicenseActivationHttpProxyUser.