server.init properties
The environmental and server session properties of the Web GUI server are stored in the WEBGUI_HOME/etc/server.init initialization file. This file is an ASCII initialization file that can be edited directly and is read on server startup.
After you edit the server.init file, restart the Dashboard Application Services Hub server.
The properties contained within the server.init file are listed alphabetically.
A
- admin.stylesheets
- System file location - do not modify.
- ael.top.n.mode
- Specifies the top-n mode. Possible values are as follows:
- 1: StateChange will be appended to EV SQL event update requests.
- 0: StateChange will not be appended to EV requests.
- ael.top.n.refresh
- Specifies the type of refresh. Possible values are as follows:
- 1: The EV is only updated with new and updated rows from the ObjectServer. StateChange is enforced to be greater than 0. The running of SQL tools and the checks for discrepancy between the EV and the ObjectServer do not reset StateChange to 0.
- 0: If the number of rows in the EV and the number of rows in the ObjectServer do not match, the EV is refreshed with data from the ObjectServer up to the number of rows specified in the ael.top.n.value property, and StateChange is reset to 0. The running of SQL tools resets StateChange to 0.
- ael.top.n.value
- The Web GUI
supports the TOP keyword in ObjectServer SQL syntax. The ael.top.n.value
property allows Web GUI administrators to
impose a limit on the number of alerts returned to the EV. If this property is set to a value
greater than 0 (zero), EV queries are modified to include a TOP condition. For
example, if an EV filter matches 8000 rows in the ObjectServer, and the
ael.top.n.value value is set to 4000, only the top 4000 alerts are displayed.
Displaying more than 20,000 events in a single EV might impact performance. The EV status bar
displays the total count of alerts for each severity level, and the total count of alerts displayed.
A Top Set to message is also shown above the distribution status bar in the EV
indicating that a TOP condition is being applied. The ael.top.n.value property
can be considered for systems:
- That regularly contain a high volume of events
- Where EV filters match more than 20000 alerts
- Where the number of concurrent EV users is adversely affecting system performance
- aelview.queries.enabled
- When set to true, the user can make advanced queries against the AELView servlet by adding configuration criteria to the URL containing the AEL address.
- alerts.status.sort.displayvalue
- Specifies the fields in the ObjectServer's alert.status table that require sorting by display value, rather than actual value, when retrieved through the Event Data REST Service.
applet.prompt.enabled- Specifies whether the prompt applet used by the Filter Builder
and View Builder to notify the Active Event List and Event Dashboard
applets is enabled. If set to false, no notification is sent to the
Active Event List and Event Dashboard when filters and views are modified.
Instead, these components will automatically detect the changed configuration
when they next synchronize with the server. This may take up to the
configured refresh period. This setting is ignored if
plugin.enabledis set tofalse. In this scenario all applets are disabled.
B
- browser.prp
- System file location - do not modify.
C
cluster.db- The identity of the database to store configuration data. Select one of the following values:
- db2: Db2 is the default value.
- os: ObjectServer
- cluster.hostname
- The identity of the host that the Web GUI server is running on. The value is the host name or its TCP/IP address. Set this property only when cluster.mode is set to on.
- cluster.mode
- Indicates whether the Web GUI server
is operating in a load-balancing cluster. The possible values are
as follows:
- on: The server is part of a cluster.
- off: The server is a stand-alone system.
- cluster.port
- The SSL port that the Web GUI server uses. The value is a numeric port value. Set this property only when cluster.mode is set to on.
- cluster.waapi.notification.delay
- Defines a delay period (in milliseconds) before notifying other nodes in the cluster of configuration changes made using WAAPI command files. The default value is 2000.
- columngrouping.allowedcolumns
- A list of the ObjectServer columns that can be used to group events in the Event
Viewer (Event
Viewer). When users create an event grouping,
only the columns that are specified in this property can be selected. This restriction ensures that
users do not specify columns that are not appropriate for use in grouping. The value is a
comma-separated list of column names.
The default value is:
Acknowledged,AlertGroup,Class,Customer,Location,Node,NodeAlias,
NmosCauseType,NmosManagedStatus,Severity,Service - columngrouping.maximum.columns
- Defines the maximum number of levels that can be defined for column grouping in the View Builder. The default value is 3.
D
- dashboard.allfilters
- When set to true, the Event Dashboard loads all Global Filters by default. When set to false, the Event Dashboard does not load any Monitor Boxes and you must change to edit mode and select the filters to be added to the Event Dashboard.
dashboard.edit.render.mode- Specifies the render mode for the event dashboard widget preferences editor. Possible options
are "applet" to use the Java applet and "lightweight" to use the lightweight render option. Note
that if the
plugin.enabledproperty is set to false, then this option is ignored and all event dashboards are rendered in lightweight mode. 
- Restrict the users from setting refresh time lower than the value of this parameter for Event Dashboard. By default, this value is 30 seconds. If this property is set less than 15, then it would be ignored, and an absolute minimum refresh time (15 seconds) hardcoded is enforced.
- Specifies the render mode for the event dashboard widget. Possible options are "applet" to use
the Java applet and "lightweight" to use the lightweight render option. Note that if the
plugin.enabledproperty is set to false, then this option is ignored and all event dashboards are rendered in lightweight mode. - datasource.failback.delay
- Specifies the time to wait after a failback before the Web GUI switches back to the primary ObjectServer. During this wait period, the backup ObjectServer is used. You can adjust this value depending on the latency of a tiered ObjectServer architecture
- datasource.response.timeout
- The timeout threshold, in milliseconds, for checking the response time of a data source associated with a map.
E
- ee.entitydir
- System file location - do not modify.
- eventlist.information.fields.important
- Fields in this list are displayed at the top of the event list information display, in the order specified. This setting affects AEL, LEL, Event Viewer, and Mobile.
- eventprovider.eventdataservice.threadpool.size
- Specifies the default thread pool size for the Event Data service. If you increase the value of this property beyond the default, performance might be impaired.
- eventprovider.eventsummarydataservice.threadpool.size
- Specifies the default thread pool size for the Event Summary Data service. If you increase the value of this property beyond the default, performance might be impaired.
eventviewer.data.provider.mode- Specifies the download method to use, to download events from the server for the Event Viewer.
- Event Data Services (EDS) mode causes all events to be loaded when the Event Viewer is opened.
- Common UI REST Infrastructure (CURI) mode causes events to be loaded in pages as the Event Viewer is scrolled.
eventviewer.data.provider.mode: 1
eventviewer.numeric.columns.format- This setting configures the formatting of numeric values with comma separators that are displayed in the Event Viewer. Valid options are:
- eventviewer.messages.popup
- This setting is used to enable or disable pop-up messages in Event Viewer. Pop-up messages are used to show information to the user in various situations, such as after running a tool, updating workspace preferences, and when errors occur. Valid options are:
- Restrict the users from setting refresh time lower than the value of this parameter for Event Viewer. By default, this value is 30 seconds. If this property is set less than 15, then it would be ignored, and an absolute minimum refresh time (15 seconds) hardcoded is enforced.
- Specifies the maximum number of event rows that are loaded into an Event Viewer. If the number
of rows exceeds this value, only the number of rows specified by this property are displayed in the
Event Viewer. A value of -1 removes this limit and the Event Viewer displays all
events.Note: If you specify a value that is too large, the server can run out of memory. The possible value for this property depends on the maximum heap size that is set for the host.
- eventviewer.refresh.mode
- This setting is used to control the Event Viewer refresh query. Valid options are:
- eventviewer.tools.command
- This setting is used to enable or disable command tools in Event Viewer. Command tools are used to run commands on the client user's operating system, and this requires the use of a web browser plugin. Valid options are:
eventviewer.tools.showplaceholders- This setting is used to control the display of disabled tools and empty menus in the Event Viewer. Valid options are:
F
- fips.security.key
- The name of the Web GUI security key file. The default value points to the default Dashboard Application Services Hub security key.
G
- groups.reload.mode
- A setting for the algorithm used to request a list of Web GUI groups
from the authentication system. Possible values are as follows:
- 0: All groups are requested.
- 1: Only groups with role names that begin with
ncw_are requested.
I
- illegalchar.file
- This file defines characters that are not permitted in the names of filters, views, and tools, and characters that cannot be used as the initial character in the names of filters, views, and tools.
- internationalisation.cache.enabled
- Specifies whether the Web GUI server caches language resources in memory. When set to false, this prevents caching of localization data, and forces the server to regularly re-read the configuration files for the selected locale.
J
- journal.update.propagate
- Determines if the journal update is sent to all display servers
immediately, or whether the gateways send the update in their own
time.
- true
- Journal updates are sent from the AEL to all display servers immediately.
- false
- Journal updates are sent only to the primary ObjectServer and the user's current display server. Use of gateways should ensure the changes are propagated to the other display servers.
- journal.update.asynchronous
- Determines how the Web GUI journal
dialog operates. The journal dialog will either hang and wait for
the journal update to the server to complete before returning control
to the user, or immediately return control to the user and let the
update operation continue in the background on another thread.
- true
- Journal updates run asynchronously in the AEL client, meaning users can leave the journal dialog before the journal update has completed. This setting might be useful in environments where journal updates take a long time to complete.
- false
- Journal updates run synchronously in the AEL client. The user will only be able to return to the AEL once the journal update has completed. This is the recommended setting in most environments, where journal updates complete quickly.
L
- lel.pagesize.default
- Specifies the number of rows returned per page in the LEL.
- log.count
- The maximum number of log files to retain.
- log.directory
- The directory in JazzSM_WAS_Profile that contains the log and trace files. Do not modify this property.
- log.filename
- The name of the log file. Do not modify.
- log.level
- The minimum severity of events to record in the log file. The
possible values are:
- NONE
- FINEST
- FINER
- FINE
- CONFIG
- INFO
- AUDIT
- WARNING
- SEVERE
- ALL
- log.maxsize
- The maximum size of the log file in megabytes.
- logfile
- System file location - do not modify.
M
- map.editor.mode
-
The display of the map editor depends on how the Administrator configures the value for the property
map.editor.mode:within WEBGUI_HOME/etc/server.init and can be one of the following displays.- If the property value is
map.editor.mode:webstart, then the map editor starts with Java™ Web Start and the map editor runs outside the browser. - If property value is
map.editor.mode:applet, then an applet loads and the map editor runs inside the browser. When this page displays for the first time, the Java Runtime Environment (if present on your system) initiates and you are presented with a security certificate that requests you to authorize a local Java Virtual Machine process. If you are satisfied with the credentials that are described within the certificate, click Yes. The default property value ismap.editor.mode:applet.
- If the property value is
- maplet.noeventcolor
- Specifies the color of active elements that have no associated events. Specify a hexadecimal color value for this parameter, for example 0xDDDDDD for gray or 0xFFFFFF for white. If no value is specified, the color associated with severity 0 is used.
- maplet.plugin.classic
- Specifies HTML markup for embedding map objects:
- If true, the map is embedded with the <APPLET> element, and the default Netscape or Internet Explorer JVM is used.
- If false, the map is embedded with the <OBJECT><EMBED> elements.
map.render.mode- Specifies the default render mode for maps in portlets or SmartPage pages. Valid options are:
- maplet.refresh
- Specifies the time interval, in seconds, between map object refreshes. Do not set the value of this property to a value less than 10. In addition, if your site uses complex maps, use a higher value for this property.
- maps.directory
- System file location - do not modify.
- maxtablesize
- The maximum number of rows allowed in a table.
- metricdataservice.threadpool.size
- Specifies the default thread pool size for the Metric Data service. If you increase the value of this property beyond the default, performance might be impaired.
P
- passwd.file
- System file location - do not modify.
- plugin.classid
- Specifies the version of the Java plug-in used by applets by using the classid attribute of the <OBJECT> tag, and allows you to enforce which plug-in is used. If the maplet.plugin.classic property is set to false, and the user has an older version of the plug-in than shown in the classid attribute of the <OBJECT> element, the user is prompted to download the newer version. If the user has the same or a newer version, that version is used.
clsid:8AD9C840-044E-11D1-B3E9-00805F499D93- plugin.enabled
- Specifies whether the Java plug-in can be used in Web GUI. If set to false, a message will appear in places that were previously occupied by applets. When set to false, this property overrides the Java applet rendering preference in the map widget.
- plugin.iedownload
- Specifies the full URL of a .cab file from which the Java plugin can be installed. This ensures that the client has the appropriate plug-in version. If the plug-in version is not correct, the user is automatically redirected to the latest .cab for the latest version in the family. This is used in the <OBJECT> element for Windows Internet Explorer.
- https://java.sun.com/update/1.7.0/jinstall-7u45-windows-i586.cab
- plugin.page
- Specifies the full URL from which the Java plugin can be downloaded if the appropriate version is not already installed. This is used in the <EMBED> element for Mozilla browsers.
- https://java.sun.com/products/plugin/index.jsp
plugin.separatejvm- Specifies that applets should run in their own JVM instance. This
avoids interference problems from other applets running in the same
JVM. It also helps when applets require dedicated heap memory. Note:
- This property is only effective on JRE 6u10 or later.
- Setting this property to true causes the applets running on the same client machine to lose their singularity characteristic. As a result, the behaviour is similar to running the applets on separate client machines.
- plugin.type
- Specifies the version of the Java plug-in by using the type attribute of the <EMBED> element, and allows you to enforce which plugin is used. If the maplet.plugin.classic property is set to false, and the user has a lower version than specified in this property, then they are prompted to download the newer version. If the user has the same or a higher version, that version is used.
- application/x-java-applet;version=1.5
- profile.count
- The maximum number of profile log files to retain.
- 5
- profile.filename
- The name of the profile log file. Do not modify this property.
- ncw.%g.profile
- profile.maxsize
- The maximum size of the profile log file in megabytes.
- 10
- profilereport.runperiod
- Defines the frequency (in seconds) for generating the profile report.
- 60
- profilereport.startdelay
- Defines the length of time (in seconds) before generating the first profile report.
R
- resources.directory
- System file location. Do not modify.
S
scala.app.keyword- Specifies the names of the IBM® Operations Analytics - Log Analysis custom
apps, which depend on the version of the Tivoli Netcool/OMNIbus Insight
Pack that is used by the IBM Operations Analytics - Log Analysis product
in your environment. Possible values are as follows:
- OMNIbus_SetSearchFilter:
Use this value for V1.1.0.1 of the Insight Pack.
- OMNIbus_KeywordSearch: Use this value for V1.1.0.2 of the Insight Pack.
- scala.app.static.dashboard
- Specifies the names of the IBM Operations Analytics - Log Analysis dashboard
custom apps, which depends on the version of the Tivoli Netcool/OMNIbus Insight
Pack that is used by the IBM Operations Analytics - Log Analysis product
in your environment. Possible values are as follows:
- OMNIbus_Event_Distribution:
Use this value for V1.1.0.1 of the Insight Pack.
- OMNIbus_Static_Dashboard: Use this value for V1.1.0.2 of the Insight Pack.
- scala.datasource
- Specifies the name of the data source for IBM Operations Analytics - Log Analysis. In the IBM Operations Analytics - Log Analysis product, a data source is a source of raw data, usually log files. In the case of integrations with the Tivoli Netcool/OMNIbus product, the data source is events from Tivoli Netcool/OMNIbus. The definition of a data source for the Web GUI is different.
- omnibus
scala.event.search.mode- Specifies the timestamp to use when searching for the event occurrence. Defaults to 0, for first occurrence. To specify last occurrence, use: scala.event.search.mode: 1
- scala.integratedsearch.enabled
- Indicates if integrated log search functions against IBM Operations
Analytics - Log Analysis should be enabled.
- If true, the integrated log search functions will be enabled.
- If false, the integrated log search functions will be disabled.
- scala.password
- The password of the proxy user being used for automated login to IBM Operations Analytics - Log Analysis when performing an integrated log search.
- scala.user
- The name of the proxy user to use for automated login to IBM Operations Analytics - Log Analysis when performing an integrated log search.
- scala.url
- Configures the location of IBM Operations Analytics - Log Analysis.
This setting specifies the location of IBM Operations Analytics - Log Analysis. This must include the protocol (http/https), port (normally 9987), and first part of the URL (normally Unity). This is used for both the launch in context via right click tools and the event search in the event information window. The https protocol must be specified if event search is used.scala.url=<URL> - https://localhost:9987/Unity
- scala.version
- Specifies the version of IBM Operations Analytics - Log Analysis so
that the appropriate search syntax is used for queries. Possible options
are as follows:
- 1.2.0.2
- 1.2.0.3
- server.mode
- Defines whether to make certain Web GUI features
unavailable. The features are defined in the file WEBGUI_HOME/etc/restricted_urls.lst. Possible values are as follows:
- 0: The server runs in normal mode. All Web GUI features are
available.
- 1: The server runs in restricted mode. The URLs that match patterns in the restricted_urls.lst file are not available to users.
T
- tableview.escapehtml
- Prevents rendering of HTML script in Table View fields. If true, HTML script text is treated as simple text in the Table View fields. If false, HTML script text is rendered in the Table View fields.
- tableview.pixelmultiply
- Optional parameter passed to Table Views and for table rendering.
- tableviewparams
- Optional parameters that are passed to Table Views and which govern table rendering.
- timedtasks.default.runperiod
- The run period (in seconds) for configstore update timer tasks.
- timedtasks.default.startdelay
- The start delay (in seconds) for configstore update timer tasks.
- timedtasks.enabled
- Indicates if timed tasks are enabled or disabled. Can be true or false.
- trace.count
- The maximum number of trace files to retain.
- trace.filename
- The name of the trace file. Do not modify this property.
- trace.level
- The minimum severity of events to record in the trace file. The
possible values are:
- NONE
- FINEST
- FINER
- FINE
- PROFILE
- CONFIG
- INFO
- AUDIT
- WARNING
- SEVERE
- ALL
- trace.maxsize
- The maximum size of the log file in bytes. Use the suffixes M or K to indicate megabytes and kilobytes, respectively.
U
- uploadfile.maxsize
- The maximum size of a file that the Page Manager can load, in megabytes.
- users.credentials.sync
- Specifies whether the automatic synchronization of user credentials between VMM and the ObjectServer is enabled. If this property is set to true, synchronization is enabled.
- users.credentials.sync.groupname
- Specifies the name of the user group that is used in the ObjectServer if the automatic synchronization of user credentials between VMM and the ObjectServer is enabled. All synchronized users are members of this group.
- users.global.filter.mode
- Setting for non-administrative user permissions to modify global
filters. Possible values are as follows:
- 0: Non-administrative users cannot add, modify, or delete global filters.
- 1: Non-administrative users can add and modify global filters, but cannot delete them.
- users.global.view.mode
- Setting for non-administrative user permissions to modify global
views. Possible values are as follows:
- 0: Non-administrative users cannot add, modify, or delete global views.
- 1: Non-administrative users can add and modify global views, but cannot delete them.
- users.group.filter.mode
- Determines whether users without administrative privileges can
edit and delete group filters. Possible values are as follows:
- 0: Non-administrative users cannot add, modify or delete group filters.
- 1: Non-administrative users can add, modify group filters, but cannot delete group filters.
- 2: Non-administrative users can add, modify or delete group filters.
- users.reload.mode
- A setting for the algorithm used to request a list of Web GUI users
from the user authentication system. Possible values are as follows:
- 0: All users are requested. This option enables faster data retrieval.
- 1: Only users with role names that
begin with
ncw_are requested. This option can be slow if there is a large number of system users.
- utility.debug
- Sets the debug level, in increasing detail from 0 (critical messages only) to 9 (all messages).
- utility.debug.destination
- Sets the destination for debug messages. The options are:
- stdout: Standard output
- stderr: Standard error output
- log: The log file specified by the log.filename option in server.init
- utility.monitor
- Sets the user monitoring level, in increasing detail from 0 (critical messages only) to 9 (all messages).
- utility.monitor.destination
- Sets the destination for monitor messages. The options are:
- stdout: Standard output
- stderr: Standard error output
- log: The log file specified by the log.filename option in server.init
V
- views.directory
- System file location. Do not modify.
W
- watchlist.map.monitor.onclick.datasources
- Configures whether a click a watch list monitor in a map changes the linked Event Viewer's data
sources to what the watch list filter is configured with. If this property is disabled, the Event
Viewer resets to its configured data sources when you click the watch list monitor. If you select
the watch list filter from the drop-down (instead of clicking the watch list monitor), this function
does not work and the data sources reflect the watch list filter configuration. Watch list filters
that are created before Fix-Pack 10 have their
data sourcesattribute set to thedefault datasource. - Enabled
- watchlist.map.monitor.onclick.view
- Configures whether a click a watch list monitor in a map changes the linked Event Viewers active
view, to the view the watchlist filter is configured with. If this property is disabled, the Event
Viewer resets to its configured view when you click the watch list monitor. If you select the watch
list filter from the drop-down (instead of clicking the watch list monitor), this function does not
work and the view reflects the watch list filter configuration. Watch list filters that are created
before Fix-Pack 10 have their
viewattribute set to theDefault global view. - Enabled
- webtop.fips
- Enables FIPS 140–2 encryption and can be on or off.Remember: If you set this property to on, also enable FIPS 140–2 encryption in Dashboard Application Services Hub.
- off
- webtop.keepalive.interval
- The Web GUI server periodically pings the Dashboard Application Services Hub server to avoid the server timing out when an AEL or Maplet page is still active. This property specifies the time period (in minutes) between each ping operation.
- 3
- webtop.password.encryption
- Sets the passwords stored in server.init to
be encrypted. Possible values are as follows:
- none: Passwords in server.init are not encrypted.
- aes: Passwords in server.init can be encrypted by the ncw_aes_crypt tool.
- fips: Passwords in server.init can be encrypted the ncw_fips_crypt tool.
Note: The only permitted options are none or fips. - none
- webtop.ssl.protocol
- Sets the secure socket layer protocol between the Web GUI and the
ObjectServer. The property values can be one of the following values.
TLSv1.2is the default value, if uncommented.- TLSv1.1
- TLS
- SSL
- webtop.ssl.trustManagerType
- The type of trust manager used. Set this property to IbmX509 if you are using the JRE bundled with Web GUI or an AIX® JRE. Set this property to SunX509 if you are not using the bundled JRE or an AIX JRE.
- webtop.ssl.trustStore
- Sets the location of the SSL truststore used by the Web GUI. If no value is entered, the Dashboard Application Services Hub default truststore is used, which also gives you access to the Dashboard Application Services Hub truststore UI for truststore configuration.
- webtop.ssl.trustStorePassword
- Sets the password used to access the truststore. If left blank, no password is required to access the truststore. For PKCS12 store types (set in webtop.ssl.trustStoreType) a password must be provided. For JKS store types (set in webtop.ssl.trustStoreType), a password is optional.
- webtop.ssl.trustStoreType
- The type of truststore used.