Web Interface

Some aspects of the Monitor web interface can be configured by the administrator. Configuration for these items is performed in the licmon.swd/config/web.cfg file. The complete list of customizable items is shown below.

### Global checkout data origin to use for historical reports
# Default is "samples"
# Legal values are:
#   "samples"  lmstat
#   "logs"     debug logs
#   "merged"   merger of samples and debug logs
# set VOVLM(origin) "samples"

### CSV export
# Set delimiter character for CSV exports (for tab use "\t")
# set VOVLM(delimiter,csv) ","

### Custom footer message, printed above Altair Engineering copyright statement
# VovCGI::setFooter "Company Confidential"

### Adding a custom tab/menu/page
# VovCGI::addTab  <tab>  <url> [options]
# VovCGI::addMenu <menu> <url> [options]
# VovCGI::addPage <page> <url> [options]
#
# Tabs/menus/pages that contain a space must be enclosed within double quotes.
#
# Options:
# -access <rule>      Set tab/menu/page visibility and access, see access rule
#                     section below for more information.
# -autorefresh <0|1>  Enables autorefresh and control, for menus only.
# -class <class>      Show a page type icon next to the page link, for
#                     pages only. Classes are: heatmap, histogram, plot,
#                     statplot, and table.
# -disabled <0|1>     Disables the tab/menu/page link and displays it with
#                     strikethrough.
# -msg <txt>          Message to display for disabled items.
# 
# Example of adding a custom tab with menu and pages:
# VovCGI::addTab  "My Tab"    "/cgi/mycgi.cgi"          -access "user=joe"
# VovCGI::addMenu "My Menu 1" "/cgi/mycgi.cgi?option=1" -autorefresh 1
# VovCGI::addPage "My Page 1" "/cgi/mycgi.cgi?option=2" -class table
# VovCGI::addPage "Google"    "http://www.google.com"
#
# Custom CGI scripts can be placed into either the $VOVDIR/local/cgi directory
# (for all products) or the $SWD/cgi directory (for LM specifically).
# 
# Example of adding a custom menu to an existing tab:
# VovCGI::setTab  "Current"
# VovCGI::addMenu "My Menu 2" "/cgi/mycgi1.cgi?option=1" -autorefresh 1
#
# Example of adding a custom page to an existing menu:
# VovCGI::setMenu "Current"   "Checkouts"
# VovCGI::addPage "My Page 2" "/cgi/mycgi2.cgi?option=1" -class table

### Changing an existing tab/menu/page
# VovCGI::setTabOption <tab> <option> <value>
# VovCGI::setMenuOption <tab> <menu> <option> <value>
# VovCGI::setPageOption <tab> <menu> <page> <option> <value>
#
# Options and possible values are listed in the previous section.

### Web UI tab/menu/page/component visibility and access
# VovCGI::setTabOption <tab> access <access-rule>
# VovCGI::setMenuOption <tab> <menu> access <access-rule>
# VovCGI::setPageOption <tab> <menu> <page> access <access-rule>
# VovCGI::setComponentOption <component> access <access-rule>
#
# Tabs/menus/pages/components that contain a space must be enclosed within double quotes.
#
# Access rules:
# 1. role=<role>
#   Roles are: admin | leader | user | readonly
# 2. group=<group1>,<group2>,<groupN>...
#   Groups are defined via the vovusergroup utility (see docs)
# 3. user=<user1>,<user2>,<userN>...
#   Users who are logged into LM
# 4. disabled
#   Disabled altogether, even admin role cannot access.
#
# Enclose multiple access rules withing double quotes, separated by spaces.
# The most restrictive access rule wins.
#
# Components:
#   homeutil    - the current utilization section on the home page
#   homewait    - the current wait section on the home page
#   homeview    - the my view section on the home page
#   homeservers - the current servers section on the home page
#   lmremove    - the ability to use lmremove on the current checkouts page
#                 default: user
#                 note: if individual users are added, these users may also
#                 remove checkouts from other users
#   usernames   - any display or control of usernames
#   emails      - and display of email addresses
#
# Examples:
# VovCGI::setTabOption Current access "role=admin group=itmgrs"
# VovCGI::setMenuOption History Denials user=joe,mary
# VovCGI::setPageOption History Usage "Checkout Details" access group=grp1,grp2
# VovCGI::setComponentOption usernames access role=admin
#
# Note:
# Access applied to the Home > Alerts page affects the alerts status area in
# the page banner at the top of the screen.

###### Home page view settings
# Establish a default view for all users who do not have one
# set VOVLM(view,default,owner) lmadmin
# set VOVLM(view,default,name)  globalview
#
### Set the number of rows shown in the view on the home page
# set VOVLM(view,default,limit) 200
#
# Set the default sorting for the view on the home page
# Default is "inuse"
# Available sort values are:
#   "name"     - the filter name
#   "tags"     - matched tag(s)
#   "features" - matched feature(s)
#   "inuse"    - current number in-use
#   "total"    - total capacity available
#   "percent"  - current percentage of in-use/capacity
# set VOVLM(view,default,sortby) total
#
### Set default sorting direction for the view on the home page
# Leave commented out or set to 0 for descending, set to 1 for ascending
# set VOVLM(view,default,ascend) 1

###### Mailto links
### Set delimiter character for e-mail addresses in mailto links
# set VOVLM(delimiter,emails) ","
#
### Set domain suffix for mailto links
# set VOVLM(domain) "mycompany.com"
#
#
### Use LDAP for e-mail addresses instead of user name
# set VOVLM(ldapEmail) 1
#
# Set default subjects and bodies
# set VOVLM(subject,current,checkouts,individual)       ""
# set VOVLM(body,current,checkouts,individual)          ""
# set VOVLM(subject,current,checkouts,summary)          ""
# set VOVLM(body,current,checkouts,summary)             ""
# set VOVLM(subject,current,features,individual)        ""
# set VOVLM(body,current,features,individual)           ""
# set VOVLM(subject,current,features,summary)           ""
# set VOVLM(body,current,features,summary)              ""
# set VOVLM(subject,history,checkoutstats,individual)   ""
# set VOVLM(body,history,checkoutstats,individual)      ""
# set VOVLM(subject,history,checkoutstats,summary)      ""
# set VOVLM(body,history,checkoutstats,summary)         ""
# set VOVLM(subject,history,checkoutdetails,individual) ""
# set VOVLM(body,history,checkoutdetails,individual)    ""
# set VOVLM(subject,history,denialstats,individual)     ""
# set VOVLM(body,history,denialstats,individual)        ""
# set VOVLM(subject,history,denialstats,summary)        ""
# set VOVLM(body,history,denialstats,summary)           ""
# set VOVLM(subject,history,denialdetails,individual)   ""
# set VOVLM(body,history,denialdetails,individual)      ""
# set VOVLM(subject,history,usagetrends,individual)     ""
# set VOVLM(body,history,usagetrends,individual)        ""
# set VOVLM(subject,history,usagetrends,summary)        ""
# set VOVLM(body,history,usagetrends,summary)           ""