HFMErrorLogViewer.exe utility

Applies to:

Hyperion Financial Management - Version: 9.2.0.1.00 to 11.1.1.3.00 - Release: 9.2 to 11.1
Information in this document applies to any platform.

Purpose

The purpose of this document is to provide some general information regarding the use of the HFMErrorLogViewer.exe utility, which is the primary executable used to review Hyperion Financial Management's (HFM) main log file called hsveventlog.log. 

Scope

This document will describe the purpose of the hsveventlog.log and show some of the features associated with reading and reviewing the HFM entries using the HFMErrorLogViewer.exe utility. It is intended for HFM administrators who maintain and monitor the activities tracked within HFM. 

How to Use HFMErrorLogViewer.exe Utility to Review HFM Log File HsvEventlog.log

I. General Information regarding the Hsveventlog.log:

Hyperion Financial Management (HFM) is a financial consolidation product. The HFMErrorLogViewer utility is the primary executable used to review the file hsveventlog.log. This is the main log that is used to track most HFM activities. They include messages, warnings and errors:

• Messages - include informational messages related to consolidations; data loads; log-in; etc.
• Warnings - include warnings related to subcube size; etc.
• Errors - include errors that may relate to vbscripts; database errors; etc.

The hsveventlog also contains related messages concerning the amount of total physical and virtual memory on the HFM application server as well as the amount of memory that a specific application may be consuming. These types of messages assist Support in reviewing and diagnosing a problem if a specific issue arises for a particular application. Since not all activities are necessarily logged in the hsveventlog, Support may request further information, such as an export of the task audit log and/or a performance monitor trace, to help analyze an issue you may be facing with HFM.

If Support requests a copy of the hsveventlog.log for review, please make sure that you attach the hsveventlog from each HFM application server (if you're using more than 1 server) or extract the database entries to a file. Refer to Document 1084998.1  for more detailed information regarding  extracting database entries to a file.

Due to the amount of records that are being written to the log, it is recommended that the size of the log be monitored to prevent it from getting too large. When the log is too large, it becomes unmanageable and difficult to review. Typically the HFM_ERRORLOG table should be kept under 500,000 records and the Hsveventlog.log should be kept roughly to 100 mb in size. If you rename the log file, it will recreate itself automatically.

II. Different ways to trace and review HFM activity

The easiest way to access and review the hsveventlog is to use the HFMErrorLogViewer executable. This executable not only enables you to automatically open the hsveventlog, but it also allows you to view a saved copy of the file. If you have selected "Consultant Utilities" option during the installation of HFM, you should have this tool readily available to use.

Checking HFM related activities:

1. HFMErrorLogViewer.exe

This executable is used to open or view an hsveventlog.log. This executable is usually saved in the Consultant Utilities folder:

2. HFM_ERRORLOG

This is the name of table that is found in the HFM database. The example below is taken from SQL 2005; however all databases contain this exact table for HFM.

3. Windows Event Viewer

On the HFM application server go to Start>Settings>Control Panel>Administrator Tools>Event Viewer. You will notice that HFM related activities are also logged here. Below is an example:

4. System Messages

In HFM web interface go to Administration>System Messages. You can filter on start and end dates; server names and application names. Below is an example:

III. Using the HFMErrorLogViewer:

Although the options listed above can all be used to review HFM related activities, the best and easiest way to review the information is to use the HFMErrorLogViewer.exe utility. When you initially launch the executable, you will notice that the screen is split. The top half will show the main entries; and the bottom half of the screen will provide more information regarding the line you highlighted. The bottom of the screen will display the version; the "to" and "from" date that the log contains information for; and the amount of records. Please refer to the screenshot below for an example:

The following menu options/features are available within the HFMErrorLogViewer:

• File Menu: - displays the options under the File menu; which include opening a file; printing; and looking up an error description.

                

• Open HFM Log - this will open the hsveventlog.log.
• Open an HFM Error Log File - this allows you to browse to a saved copy of the log.
• Open an Error Log from a Database - this allows you to extract the database entries. You will be prompted for this screen if you click on this option:

                

• Open an NT Event Log - opens the log.
• Open an NT Event Log File - opens the log file.
• Lookup Error Description - this allows you to enter the error number you found in the logs so that you can look up it's description. Below is a screenshot:

                

• Edit Menu: - displays the options under the Edit menu; which contain the very basic Find; Find Next; Find Previous; and Copy options.

                 

• Tools Menu: - displays the options that are available to you within the Tools menu; which include the ability to "Extract Database Entries to File(s)" and the ability to split a log for review.

                

• Extract Database Entries to File(s) - Below is a screenshot of what you will be prompted for if you select this option. If you click on this option, you will be prompted to select a UDL file and choose how  you want the files extracted from the database. (Please refer to doc id: 1084998.1 for detailed information.)

                 

• Truncate Database Entries to File(s) - you select the UDL file and then choose whether to "truncate all entries" or "all entries prior to a specific date."
• Extract Data Entries - allows you to extract consolidation info and memory stats to a log file where you specify the output path.
• Split HFM/NT Error log - this allows you to split a log that may be very large in size. The options allow you to split it by date, number of entries or file size; as shown below:

                 

• View Menu: - displays the different view options that are available for the log. For example, you can choose filters that may only contain errors and warnings OR you can decide to include all errors, warnings, and informational messages. This menu option also allows you to 1) set and highlight a "custom filter"; 2) display the HFM versions found in the log; and 3) allow you to view the log in a "list view" vs "report view." Examples are shown below:

                

• View>Errors/Warnings/Informationals - allows you to filter on the type of entries you want to review in the log. You decide whether or not to include everything or filter the log based on errors, warnings or informational entries.
• Custom Filter - allows you to enter search criteria within the log. Once you apply the filter, the log output will only show those entries that match the criteria you entered. For example: Under the "keyword" field, if you enter the word, "Consolidation", the log will show all entries that contain this keyword. Below is a screenshot:

                

• HFM Versions for this log - displays all versions of HFM that are found in the log.
• List View vs Report View - "List view" displays the entries in a list. This is usually the default. The "Report View" allows you to view the log in a graphical interface. See below:

• Toolbar/Status Bar - allows you to select or deselect these options.
• Refresh - you select this if you want the log to be refreshed to review recent activity.
• Options - contains 3 tabs that you can customize: Startup Options; Settings; and File Types.

                

• Window Menu: - allows you to view/display the logs in your preferred method; which include a cascade or tile view.

                

• Help Menu: - provides the version of the HFM utility.

IV. Conclusion

In conclusion, one of the key items to keep in mind is that monitoring the size of the log is very important. In addition, if you encounter a problem with one of your HFM applications and create a Service Request with Support, please be sure to attach the hsveventlog to the case right away and provide details regarding when your issue occurred. This will make it easier for the analyst to review the logs during a specific time frame rather than waste time reviewing the entire log in search of the problem. Depending on the type of issue reported, you may also be requested to provide an HFM task audit export for further diagnosis of the problem. It is also important to understand that a problem you encountered today may have been caused by events that happened a few days prior which led to the problem. Usually these are due to such things as memory related issues within the application or system resources. Support will not know the root cause of your problems until the logs and relevant information are reviewed and diagnosed.

It is recommended that you launch the HFMErrorLogViewer and review some of the entries in your own hsveventlog.log. This will help you become more familiar with the log itself and see the types of activities that are gathered and reported in your own HFM environment. In general, the settings for the HFMErrorLogViewer can be kept as the default so there is no need to make any changes to them.