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.
- Select Administration > Settings from the top-level menu.
- Choose Avantra UI.
- Click on the Edit icon and change the value or on the Refresh icon to restore the default.
- 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 | Enum (yes / no) |
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 fields when monitoring is turned off.
| Default Value | 12:00 |
| Unit | Time (HH:MM) |
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 fields when an RTM check status is confirmed.
| Default Value | 12:00 |
| Unit | Time (HH:MM) |
help-public-access
Defines whether this document is accessible without login from Avantra WebUI.
| Default Value | no |
| Unit | Boolean |
FileBundleLocations
Limits the directories that can be used for externally managed file bundles. Sub-directories of the specified paths are also accepted. Separate multiple directories with a semicolon.
When this setting is empty (the default), externally managed file bundles cannot be created. At least one allowed path must be configured before an externally managed bundle can be saved.
See File Bundles for more information.
| Default Value | Not set |
| Unit | String |
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 | INFO |
| Unit | Enum (TRACE / DEBUG / INFO / WARN / ERROR / FATAL) |
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 | Integer |
MaintWindowDefaultMoniSwitch
Allows you to set a default value for creating Maintenance Windows to monitoring on or off.
| Default Value | OFF |
| Unit | Enum (ON / OFF) |
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 (yes / no) |
reset-password
Defines if or if not the Forgot Password link is shown on the login page.
| Default Value | yes |
| Unit | Enum (yes / no) |
RTMControlCenterDashboard
The Name of the Dashboard that shall be used as RTM Control Center, i.e. which is accessible by Monitoring > RTM Control Center.
| Default Value | Not set |
| 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 | 67 |
| Unit | Seconds |
showunassignedchanges
Defines whether or not the number of unassigned Changes is displayed in the Avantra WebUI toolbar.
| Default Value | no |
| Unit | Boolean |
slr.appendid
Defines whether or not 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 | Enum (Always / Never / Ask) |
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 (a5 / a5s) |
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.
| Default Value | empty |
| Unit | String |
webservice
Defines if the Webservice is available. See Enable/Disable the Avantra Web Service.
| Default Value | false |
| Unit | Boolean |
webservice.gql.introspection
Defines whether GraphQL API introspection is enabled. When disabled, the schema and available queries are not exposed to unauthenticated requests. Recommended to leave disabled in production environments.
| Default Value | no |
| Unit | Enum (yes / no) |
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.
| Default Value | empty |
| Unit | String |
HttpProxyUser
Defines the user name in case the proxy defined in HttpProxyHost requires authentication.
| Default Value | empty |
| Unit | String |
HttpProxyPassword
Defines the password corresponding to HttpProxyUser.
| Default Value | empty |
| Unit | String |
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.
| Default Value | empty |
| Unit | String |
LicenseActivationHttpProxyUser
Defines the user name in case the proxy defined in LicenseActivationHttpProxyHost used for Activation requires authentication.
| Default Value | empty |
| Unit | String |
LicenseActivationHttpProxyPassword
Defines the password corresponding to LicenseActivationHttpProxyUser.
| Default Value | empty |
| Unit | String |
agent-terminal.enable
Enables or disables the agent terminal feature in the Avantra WebUI.
| Default Value | yes |
| Unit | Enum (yes / no) |
DesktopsPerSession
Defines the maximum number of desktops per user session. Use a negative number to set no limit.
| Default Value | 5 |
| Unit | Integer |
DocumentationBaseURL
Defines the base URL used for links to Avantra documentation.
| Default Value | https://docs.avantra.com |
| Unit | String |
FileBundleLocations
Limits the directories that can be used for externally managed file bundles. Sub-directories are also accepted. Separate multiple directories with a semicolon.
| Default Value | empty |
| Unit | String |
GraphQL-MaxQueryComplexity
Defines the maximum query complexity allowed for a GraphQL query. Use a negative number to set no maximum.
| Default Value | 180 |
| Unit | Integer |
GraphQL-MaxQueryDepth
Defines the maximum query depth allowed for a GraphQL query. Use a negative number to set no maximum.
| Default Value | 15 |
| Unit | Integer |
GraphQL-MaxRequestsPerMinute
Defines the maximum number of GraphQL API requests per minute. Use a negative number for unlimited.
| Default Value | 50 |
| Unit | Integer |
Login-MaxRequestsPerMinute
Defines the maximum number of login API requests per minute. Use a negative number for unlimited.
| Default Value | 600 |
| Unit | Integer |
logon.autoUnlockLockedAccount
When enabled, users who are locked after failed login attempts are automatically unlocked after the period defined in logon.lockTimeMinutes. Set to false to permanently lock those users.
| Default Value | true |
| Unit | Boolean |
logon.displayTimeToAccountUnlock
When enabled, the remaining lock time is displayed to users who have been temporarily locked due to failed login attempts.
| Default Value | true |
| Unit | Boolean |
MinPasswordHashingLevel
Defines the minimum password hashing algorithm required for user login. Set to 24.3(Argon2id) to enforce the stronger Argon2id algorithm introduced in Avantra 24.3.
| Default Value | legacy |
| Unit | Enum (legacy / 24.3(Argon2id)) |
RequestsPerSession
Defines the maximum number of concurrent requests per user session. Use a negative number to set no limit.
| Default Value | 5 |
| Unit | Integer |
SOAP-MaxRequestsPerMinute
Defines the maximum number of SOAP API requests per minute. Use a negative number for unlimited.
| Default Value | 50 |
| Unit | Integer |
UIErrorMessageDetail
Defines how much information about errors is displayed in the Avantra WebUI when an error occurs. Use Generic to display no error details (errors are only logged), Summary to display an error message, or Detailed to display the error message and full stack trace.
| Default Value | Generic |
| Unit | Enum (Generic / Summary / Detailed) |