Start a conversation

Understanding and Troubleshooting Chappfile and LockfileEx Errors in Hyperion Enterprise

Hyperion Enterprise - Version: 5.1.1.0.00 - Release: 5.1
Information in this document applies to any platform.

Purpose

This document has been written to guide customers through resolving issues of reoccurring CHappfile and LockfileEx error messages; it covers Hyperion Enterprise 5\6 File-Based applications without Hyperion Data Server Service. Readers of this document should familiarize themselves with the Hyperion Enterprise Release Notes Release 5.x/6.x This document should be read first and fully understood before proceeding.

Questions and Answers

What is a CHappfile Error? 
CHappfile errors, which are recorded in the Hyperion Enterprise application's error.log file, are written by Hyperion Enterprise whenever a file access problem occurs, either for Read or Write. For example, in the event the server or the server service is restarted and workstations are connected with open files, all files opened by the workstation on the server are closed. In this situation, the workstation still has file handles associated with files on the server, but the server has lost its associated file handles. The file handles on the workstation are now invalid and can no longer be used to update files on the server. Error messages can only be written to the error.log if the client is able to re-establish connection to the server and open the error.log. 

Causes of CHappfile Errors 
CHappfile error messages can be traced back to various environmental factors. CHappfile messages do not always indicate the application has integrity issues, but they do indicate some type of disconnects are occurring. CHappfile messages are normally written to the application Error.log file, provided that the client can still connect to the server. If the client cannot connect to the server to write the message, then a pop up message may appear on the client or no message is recorded. The location of the Error.log is based on the User_Path setting in the HYPENT.INI file. It is possible to have multiple Error.log files if users have modified their HYPENT.INI file. 

Examples of CHappfile Errors 
The following are examples of CHappfile errors: 
CHappfile::ReadFromSysFile returned: Reached end of file. 
Error reading free blocks : CPropFileIO::GetFreeArea This is not a CHappfile message but this message has been found in the midst of other CHappfile messages. 
CHappfile::WriteToFile returned: Reached end of file. 
CHappfile::ReadFromSysFile returned: The handle is invalid. 
CHappfile::WriteToFile returned: The process cannot access the file because another process has locked a portion of the file. 
CHappfile::ReadFromSysFile returned: The operation completed successfully. 
CHappfile::ReadFromSysFile returned: The specified network name is no longer available. 
CHappfile::ReadFromSysFile returned: Cannot create a file when that file already exists. 

Possible messages written to client workstation System Event logs: 
Event ID 3009 "The redirector failed to unlock part of a file on server Hyperion_Enterprise_Server_Name." 
Event ID 26 Application popup: System Process - Lost Delayed-Write Data : The system was attempting to transfer file data from buffers to \\Hyperion_Enterprise_Server_Name\Share\551demo\551demo.EXA. The write operation failed, and only some of the data may have been written to the file. 

Windows clients, or Terminal Server RDP clients, don't write events to the event logs. There is currently no way to determine if these clients have experienced these types of issues based on the event logs. 

Interpreting Error.log entries 
When reviewing the Error.log file, it is important to understand this file is an event log as well as an error log. Not all events in the application are logged, but some informational events like consolidation start and complete times, data load and extract start and complete times, report previews and retrieve refreshes are logged. When reviewing the Error.log file, here is a sample of what may be found: 

(User: admin ) An unrecoverable error occurred. 
LockFileEx returned: Time=8:30:11 PM 3/5/02, OS Error Code=0x6, OS Error Message= The handle is invalid. , Module=N:\Hyperion Solutions\Hypent.exe Terminating current session. 

This sample comes from version 5.x\6.x, which includes additional error logging information. The key items to note are the OS Error Code and the OS Error Message. The OS Error Code is what has been returned to the Hyperion Enterprise application. The OS Error Message gives the text meaning of that OS Error Code (Prove this to yourself :on Windows machines open a Command prompt and type net helpmsg 6™. The text return should be The handle is invalid) These are not Hyperion program errors but are OS errors being reported to Enterprise. Prior to 5.x\6.x, here is a sample of the same event: 

(User: admin ) An unrecoverable error occurred. 
LockFileEx returned: The handle is invalid. 
Terminating current session. 

The additional information provided by 5.x\6.x and later versions also includes the Module the user was in and the time the error was reported to the Enterprise program. The time listed does not necessarily mean that the underlying problem occurred at this time. For example, if a user is logged into Enterprise and steps away from their computer and the Enterprise file server is rebooted for some reason, no error will be reported by that user Enterprise program until they return to the workstation and attempt to access the application files. The time stamp of the error could be several hours after the server reboot caused the disconnect. 

What is a LockFileEx Error? 
Like CHappfile errors, LockFileEx Errors recorded in the Hyperion Enterprise application's error.log file indicate that Hyperion Enterprise experienced a problem reading or writing to a file. LockFileEx messages are normally written to the application Error.log file provided that the client can still connect to the server. If the client cannot connect to the server to write the message, then a pop up message may appear on the client or no message is recorded. Also, like CHappfile messages, LockFileEx messages do not always indicate the application has integrity issues, but they do indicate some type of network disconnects happening. 

Examples of common LockFileEx messages found in the Error.log: 
LockFileEx returned: The session was cancelled. 
LockFileEx returned: The handle is invalid. 
LockFileEx returned: An unexpected network error occurred. 
LockFileEx returned: The specified network name is no longer available. 

Possible messages written to client workstation System Event logs: 
Event ID 3013. The redirector has timed out a request to Hyperion_Enterprise_Server_Name. 

Windows clients, or Terminal Server RDP clients, don't write events to the event logs. There is currently no way to determine if these clients have experienced these types of issues based on the event log. 


Current Recommendations 


Please refer first to the Hyperion Enterprise 5\6 Release Notes. The release notes for version 5.5 and later include Appendix A, which listed Suggested Network Guidelines for Hyperion Enterprise. The following information should be considered to complement those sections. Before making any changes to your production environment it is recommended that the changes be fully tested on a non-production system that closely matches the production environment. 

WARNING: Using Registry Editor incorrectly can cause serious, system-wide problems that may require you to reinstall. Use this tool at your own risk. 
Basic environmental recommendations 
These are standard recommendations that should apply to all environments: 
Network Interface Cards (NIC) and switch ports should not be set for Auto Sensing of Speed and Duplex method. These devices should be configured to match both speed and duplex method. 
Running Hyperion Enterprise on Domain Controllers is not recommended 
Clustering technologies like MSCS should not be used in Active mode 
Backups and file copies should not be made with users in an application 
Virus scanning should not be configured to scan the Enterprise application data files in Real-time mode 
All Windows servers and workstations should be on the same Service pack level. 
Hyperion Enterprise Servers Windows and Windows (file servers) 
Disable Opportunistic Locking at the server service level 
Add the following Value: 
\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters 
Value Name: EnableOplocks 
Data Type: REG_DWORD 
Value (decimal): 0 

Disable Remote File Control Blocks (RFCB) caching 
Add the following Value: 
\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters 
Value Name: CachedOpenLimit 
Data Type: REG_DWORD 
Value (decimal): 0 

Windows Terminal Services (with or without Citrix) 
For Windows servers running Terminal Service, the article Q299603 was found to list a few registry modifications to help resolve redirector problems. Although the error mentioned Error reading file is not seen in Enterprise, the registry changes are being recommended as part of the standard troubleshooting process. 
From Q299603:
Choose files or drag and drop files
Was this article helpful?
Yes
No
  1. GKontos

  2. Posted

Comments