For products:
Webtrends Log Analyzer Advanced 8.1x
Webtrends Log Analyzer 8.1x
Webtrends Reporting Center 6.1x
Last modified: 1/1/2011
Introduction:
Webtrends software reports are in HTML format. Using the Webtrends Document Utility, the reports can be easily converted to Microsoft Word or Excel documents, a .csv (comma separated value) text file, or to Adobe .pdf format. This makes it easier to include the report information in presentations or other documentation, or in the case of the .csv file for import into a database.
System Requirements:
The workstation running the remote interface (client machine) needs to meet the following criteria for the conversion to work properly:
Windows:
Microsoft Windows XP, Windows 2000, or Windows 2003
Microsoft Office 2000 or XP must be installed (if reports are desired in Microsoft Word or Excel format)
Java 2 Platform, Standard Edition, 1.4.1_03
Macintosh:
Macintosh OS X 10.2
Microsoft Office X (if reports are desired in Microsoft Word or Excel format)
Java 2 Platform, Standard Edition, 1.4.1_03
Note: To be able to view a report for a profile, the user must have access to that profile as well as having the Document Utility installed. If you have questions about your profile access, see your system administrator.
Migration From Previous Versions
Version 6.1 of the Webtrends Document Utility has been rewritten in Java. This allows the Document Utility to run on platforms other than Windows. Because of the change to a Java codebase, the configuration and customization of the Document Utility has changed. In addition to the system-wide configuration/customization that was previously available, per-user configuration/customization is also available. Document Utility versions prior to 6.1 stored configuration settings in the webtrend.ini file located in the Document Utility installation directory. Version 6.1 stores the system-wide configuration settings in the DocUtil.properties file, also in the installation directory. Please refer to the comments within this file if you need to customize settings for your site (e.g., paper size, default charset, etc.).
User-level customizations can be made by overriding the appropriate entries in a DocUtil.properties file located in the following system-specific directories: Windows %USERPROFILE%\Application Data\Webtrends MacOS X $HOME/Library/Webtrends Solaris $HOME/.docutil Audit Logs For troubleshooting purposes, there is a audit log file created for each report that is converted using the 6.1 Document Utility. The audit log is created in the same folder as the exported report and will have the same name as the exported report file with an extension of .log. For example, if you are exporting a PDF file you have named MySiteDaily.pdf, the associated audit log will be created in the same directory and have the file name of MySiteDaily.log.
Known Issues
1. Authentication prompt when using the Document Utility - If you experience a network prompt when exporting a report, you will need to log in using the same user name and password used to access the AdminConsole. This does not occur when using Internet Explorer, with the "Remember my password" option checked when logging in.
2. Network Installation Of Microsoft Office - If Microsoft Office is installed on a network share, rather than installed locally on the client machine, the Windows registry settings that are normally queried are not available. You must modify the Document Utility configuration file to specify the location and version of the Word and Excel programs. For Office 2000, insert the following settings into DocUtil.properties:
Excel.AltExePath = x:\full\path\to\excel.exe
Excel.AltVersion = 9
Word.AltExePath = x:\full\path\to\winword.exe
Word.AltVersion = 9
For Office XP, insert the following settings into DocUtil.properties:
Excel.AltExePath = x:\full\path\to\excel.exe
Excel.AltVersion = 10
Word.AltExePath = x:\full\path\to\winword.exe
Word.AltVersion = 10
3. Office Project Gallery On MacOS X - The Project Gallery that is shown by default upon Microsoft Word and Excel start up must be disabled for the Document Utility to complete the report creation. To disable the Project Gallery, open the Microsoft Word and Excel preferences and select the "General" category, then un-check the box next to "Show Project Gallery at startup." Press the "OK" button to save the changes.
4. Character Sets In PDF Reports - PDF report generation is limited to the following 22 character sets:
ISO-8859-1 Latin1 (default)
ISO-8859-2 Latin2
ISO-8859-3 Latin3
ISO-8859-4 Latin4
ISO-8859-5 Cyrillic
ISO-8859-6 Arabic
ISO-8859-7 Greek
ISO-8859-8 Hebrew
ISO-8859-9 Latin5
ISO-8859-14 Latin8
ISO-8859-15 Latin9
KOI8-R Cyrillic, Russian
CP-874 Windows Thai
CP-1250 Windows Latin2
CP-1251 Windows Cyrillic
CP-1252 Windows Latin1
CP-1253 Windows Greek
CP-1254 Windows Turkish
CP-1255 Windows Hebrew
CP-1256 Windows Arabic
CP-1257 Windows Baltic
CP-1258 Windows Vietnamese
If another character is being used for the reports (e.g. Shift_JIS EUC-KR), a correct PDF report will not be produced. The alternative is to create a Microsoft Word report. Obtaining Updates For users who have report viewing rights only, the Webtrends Document Utility is loaded on to their computer as part of the report conversion process from HTML to Microsoft Word, Excel, CSV, or Adobe PDF format. These users do not have direct access to any updates to the Document Utility since it is loaded directly from the Webtrends Reporting server. To provide updates of the Webtrends Document Utility, Administrators can download the update and install it into the appropriate directory in Webtrends Reporting Center. Users will automatically be prompted to install the updated Document Utility the next time they ask for a Webtrends report in an alternate format.
Installation Instructions (Administrator) - From within Webtrends Reporting Center, the Administrator can check for updates to the Document Utility, and make these updates available to their users.
To check for, and install Document Utility updates, follow the steps below:
1. From the AdminConsole, select Administration > Product Licensing & Updates.
2. From the License/Product Updates tab, click Manual Update. The software checks for all product updates, including the Document Utility.
3. If an update is available, the download page opens in a new browser window. You are prompted to download a .zip file.
4. Unzip it into this directory. You should overwrite the previous files that are there (you can first make back up copies of them if desired): /wwwroot/download
5. If desired, the Administrator can let users know the update is available. The next time users view reports, they will automatically be prompted to install the Document Utility update (see instructions below).
Installation instructions (User) - The Document Utility is automatically downloaded and installed when a user converts reports from HTML to an alternate format:
1. From the AdminConsole, select a profile.
2. From the Profiles menu on the left, click View Reports.
3. You can convert the whole report or just the currently displayed chapter. If you want to report on only a specific chapter, navigate to it now.
4. From the upper-right of the Report Calendar, click the Export icon.
5. Specify the format and content of the report.
6. Click Auto.
Note: On Windows, if you do not already have Sun's Java Virtual Machine (JVM 1.4) installed on your system, an automatic installation wizard will prompt you to download and install it. Macintosh OS X users must go to System Preferences, and use Software Update to install JVM 1.4, if they have not already done so.
7. Follow the additional prompts to complete the installation process. The Webtrends Document Utility is installed (if necessary) and the report is downloaded and converted to the specified format.
Instructions for uninstalling the Document Utility
To uninstall the Document Utility from the client machine, follow the steps below:
1. Browse to the installation directory (i.e. C:\Program Files\Webtrends Document Utility II).
2. Locate uninstall.bat.
3. Double-click this file to completely remove the Document Utility from your machine. |
