Customizing Web Monitor
Applies To: Intelligent Application Gateway (IAG), Unified Access Gateway
Forefront Unified Access Gateway (UAG) Web Monitor enables you to view, monitor, and filter Forefront UAG related events.
This topic describes how you can customize the following Web Monitor settings:
Preferences and window appearance. See Modifying Web Monitor pages.
The layout of charts displayed in Web Monitor. See Customizing Web Monitor charts.
The appearance of the toolbar at the top of the Web Monitor. See Customizing the appearance of the top monitor strip.
Style definitions, such as font and color. See Customizing Web Monitor style definitions.
The files located in the \Microsoft Forefront Unified Access Gateway\von\Monitor folder affect changes you make to these pages. The following table lists the folders located under the Monitor folder and their functions.
Folder | Contents |
---|---|
Monitor/css |
Default style definitions |
Monitor/css/CustomUpdate |
Custom style definitions |
Monitor/Images/CustomUpdate |
Custom image files |
Monitor/inc |
Default preference definitions |
Monitor/inc/CustomUpdate |
Custom preference definitions |
Monitor/Samples |
Sample content definitions |
Modifying Web Monitor pages
Before you begin customization, you should always prepare the relevant files as described here, or customizations will be overwritten if the system is upgraded. Files and folder names are not case sensitive.
The following sections describe how to prepare files for customization, how to customize Web Monitor pages, and the customizable files and parameters.
To prepare files for customization
Copy the file that you want to customize, from the folder under which it is installed by default, to the CustomUpdate subfolder that is nested under it.
If you want your changes to apply to all trunks, copy the file without renaming it. You should always do this for Web Monitor changes, because the Web Monitor monitors all the trunks in Forefront UAG, and you cannot make changes per trunk.
Make the required changes in the file you copied. These changes will not be overwritten when Forefront UAG is upgraded.
To customize Web Monitor pages
Open the relevant sample .inc file (located in the \Microsoft Forefront Unified Access Gateway\von\Monitor\samples folder), or create a new .inc file.
Customize files and parameters by modifying the relevant .inc file, as described in the Customizable files and parameters table below.
Save the customized.inc files in the relevant CustomUpdate folders.
Notes
If you create your own files, ensure that you use the same parameter names as those in the supplied .inc files. If the names are not identical, the definitions may not be effective.
When you modify a graphic (.gif) file, the name of the file must correlate to the name defined in the LogMonitor.inc file. Change the path of the .gif file in the LogMonitor.inc file to point to the Images\CustomUpdate folder. Ensure that you make changes in the LogMonitor.inc files located in the inc\CustomUpdate folder.
Customizable files and parameters
Usage | File | (ID) and Parameter (ID correlates to the ID used in the sample customDefault.inc file) | Save custom file in |
---|---|---|---|
Web Monitor preferences: first day of the week. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(1) weekStartDay. Specify 0 for Sunday, or 1 for Monday. This affects the Web Monitor session monitor, application monitor and user monitor statistics windows, and the event query windows. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: date format. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(2) dateFormat. Specify 0 for a date in the format dd/MM/yyyy. Specify 1 for a date in the format MM/dd/yyyy. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: Refresh rate (in seconds) of the session monitor, application monitor, and user monitor current status window. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(3) monitorChartsRefreshRate |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: Refresh rate (in minutes) of the session monitor, application monitor, and user monitor active windows. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(4) monitorListsRefreshRate |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: Refresh rate (in seconds) of the line charts generated from the session monitor, application monitor, and user monitor current status windows. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(5) lineGraphRefreshRate |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: number of intervals that are displayed on a single page in the default view of the query results (in the session monitor and application monitor statistics windows), and in the Monitor Over Time windows, accessed from the session monitor, application monitor, and user monitor current status windows. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(6) lineGraphPoints |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: maximum number of intervals that can be queried in the session monitor and application monitor statistics windows. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(7) statisticsLimit |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: Refresh rate (in seconds) of the Event Viewer. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(8) eventViewRefreshRate |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: maximum number of items that can be viewed in the column charts generated from the application monitor or the current status and statistics windows. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(9) chartLimit |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Web Monitor preferences: Determines whether the application ID is displayed in the Application Monitor current status window. |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\customDefault |
(10) showAppID |
\Microsoft Forefront Unified Access Gateway\von\WebMonitor\inc\CustomUpdate |
Customizing Web Monitor charts
You can customize the appearance of Web Monitor charts in the file chartParams.inc, as shown in the following graphic.
Figure 15. Customizable Aspects of Web Monitor Charts
The following table lists the corresponding parameters in the chartParams.inc file.
ID Parameter Name | Description |
---|---|
1. * |
threeD |
2. |
plotAreaColor plotAreaGradient plotAreaSecondaryColor |
3. |
gridColor |
4. |
labelColor |
5. |
lineColor |
6. |
titleColor |
7. |
font |
* The numerals correlate to those that are used in the chartParams.inc file.
Customizing the appearance of the top monitor strip
You can customize the top monitor strip in the LogoMonitor.inc file, replace the default graphic files used in the strip at the top of the monitor windows, or add graphics to the display. Place the custom graphic files under this folder:
\Microsoft Forefront Unified Access Gateway\von\Monitor\Images\CustomUpdate
Note
When you use a custom graphic file, note the following:
- The name of the graphic file must correlate to the name in the
LogoMonitor.inc
file.
- Change the path of the graphic file in the
LogoMonitor.inc
file to theImages\CustomUpdate
folder. Make sure you make changes to theLogoMonitor.inc
file in theinc\CustomUpdate
folder.
Customizing Web Monitor style definitions
You can modify style definitions such as fonts and colors in template files that you place in this folder:
\Microsoft Forefront Unified Access Gateway\von\Monitor\css\CustomUpdate
Note the following:
The file
monitor.css
holds definitions that apply to all browsers.The file
monitor_ie.css
holds definitions that apply to Windows Internet Explorer browsers only.
Note
Changing the style definitions requires a working knowledge of cascading style sheets.
You can use the files under this folder as a basis for your changes:
\Microsoft Forefront Unified Access Gateway\von\Monitor\css