1. Troubleshooting & Traceability AA201 Eric Hu, Software QA Engineer Jeanie Conner, Software QA Engineer

2. Presentation Agenda Laserfiche Server Architecture Error Logging Troubleshooting Laserfiche 8 Diagnostic Tools

3. Laserfiche Server Architecture Overview of Laserfiche Systems

4. Repository Architecture 101 A Laserfiche 8 repository consists of: -A database: stores folder structure, volume definitions, template definitions and field values, security information -The volumes: store the contents of documents e.g. text, images, and electronic documents -The search/index files: stores the indexing information, allowing documents to be full-text searchable.

5. Laserfiche Architecture 101 The Core Laserfiche Architecture consists of three components: -Client -Server -Database Management System (DBMS)

6. Laserfiche 7 Architecture LFS LFEng File SystemDBMS Clients LFRO/DCOMLFAPI LFRO Full-Text Search

7. Laserfiche 8 Architecture LFS LFROServHTTPServLFCRWMI Content Repository (CR) File SystemDBMS Clients WMIHTTPLFRO/DCOMLFAPI Full-Text Search Service

8. Laserfiche 8 Server Architecture The Laserfiche 8 Server is organized into 5 modules: -LFS.exe -CR.dll (Content Repository) -HTTPServ.dll -LFROServ.dll -LFCRWMI.dll

9. LFS What is LFS? -The executable file that starts the server -Does not contain much application logic What does LFS do? -Loads the other modules

10. Content Repository (CR) What is CR? -The actual logic behind the 8 server -Analog in Laserfiche 7: Actual logic was contained in LFEng.dll What does CR do? -The only module that talks directly with the database and the volumes

11. Content Repository Architecture CR has two parts: -CLI (or call-level interface): the API that other modules use to communicate with CR -The “kernel”: contains the core logic of the server What does each part do? -CLI: argument decoding and verification, security checking -The “kernel”: database commands, file I/O

12. Laserfiche 8 Architecture LFS LFROServHTTPServLFCRWMI Content Repository (CR) File SystemDBMS Clients WMIHTTPLFRO/DCOMLFAPI Full-Text Search Service

13. LfroServ What is LfroServ? -Interface for communication with 7 Clients -Analog in Laserfiche 7: This interface was contained in LfEng.dll What does LfroServ do? -The module used by CR to communicate with 7 Clients (through LFSO72) using DCOM

14. HttpServ What is HttpServ? -Implements an HTTP/WebDAV server What does HttpServ do? -The module used by CR to communicate with 8 Clients (through LFSO80) using HTTP

15. WMI What is WMI? -Stands for Windows Management Instrumentation -Allows management information to be shared between applications What does WMI do? -Interface that provides ability to list, create, delete, attach, and detach repositories

16. Laserfiche 8 Architecture LFS LFROServHTTPServLFCRWMI Content Repository (CR) File SystemDBMS Clients WMIHTTPLFRO/DCOMLFAPI Full-Text Search Service

17. Effects of Changes to Architecture HTTP to communicate with 8 Clients -No longer need to worry about DCOM! -No configuration required to get past firewalls Search Engine/Indexer as a separate service -You can restart the search/indexer service independently from the 8 server! -Don’t delete indexing files in SEARCH folder! No more expansion databases! -Word location data and page thumbnails are now stored in the volumes

18. Error Logging Changes with Laserfiche 8

19. Laserfiche 7 Error Logging LfStartup.txt - Errors during startup of Laserfiche server service LfS.log - Errors during repository loading and server startup Error.log - Errors during repository use 7050 or 6000 error - Generic database layer error

20. Laserfiche 8 Error Logging Event Viewer -All errors are now written to the Windows Event Viewer Benefits of Event Viewer error logging -Centralized error logging -No more giant text files to parse through -Filtered (look for LFS or LFFTS)

21. Common Error Codes Laserfiche 7Laserfiche 8 Permission denied. [7332]Permission denied. [6317] Entry locked [7390]Entry locked. [9014] Error executing SQL command. [7050] Error executing SQL command. [9008] Server not found. [6505]General WMI error. [1328] Client: 6000s Server: 7000sServer: 9000s

22. Troubleshooting Laserfiche 8 Compatibility with Laserfiche 7

23. Installation Compatibility The 8 server CANNOT be installed on the same machine as a legacy server. 8 clients CAN be installed on the same machine as legacy clients. Legacy clients CAN be used with the 8 server.

24. Effects of New Features New features in 8 that present compatibility concerns -Changes to security -New template field types and properties -Briefcase and Volume Compatibility

25. Changes to Security Completely New Rights -Bypass Browse, Purge Entries -Change Entry Owner, Delete Child Entry, Delete Document Pages Eliminated Rights -Rename, Create Shortcut, Delete Shortcut Re-mapped Rights -Manage Metadata -Access Control

26. Changes to Templates and Fields Fields as its own entity -Independent fields -Fields belonging to multiple templates New Field Types -Time, Number, Binary Multivalue Fields -Fields can hold multiple values

27. Briefcase and Volume Compatibility New annotation types and new field types -Exporting from legacy Client will retain the Laserfiche 8-specific information -Volumes can be exported in legacy formats now!

28. Recommendations Troubleshooting tip for legacy Clients: -Perform the same task using 8 Client When using legacy Clients: -Good for using, but not recommended for administrating -Be aware of the new features

29. Diagnostic Tools for LF8

30. Performance Counters and Monitoring diagnosing performance issues

31. Performance Monitor What: Tracker for aspects of both basic computer performance and LF specific items that affect performance. When: Any time performance is sluggish. Why: Pinpoint the cause of performance issues.

32. What is Performance Monitor? Microsoft Utility – used to help locate and diagnose performance bottlenecks. LF specific counters. Used to view system loads and create logs. –Can be sent to support for diagnosing problems. –Can be used as evidence to back up requests for hardware upgrades or additional servers.

33. Performance Counters in LF8 Default counters –memory, hard disk, processor load. LF counters –Server Performance Object licenses, sessions, mounted repositories. –Repository Performance Object Can select one or multiple repositories. read/write/total sessions, pages/documents/entries/CLI calls per second. –Search Counters Concurrent searches, pages/docs/words per second

34. Running Performance Monitor Accessible through Administrative Tools. Can be added as a snap-in to Admin Console. See “Using Microsoft Performance Monitor” white paper.

36. Event Tracing Utilities detailed information about events

37. Event Tracing What: A record of each action (and information associated with that action) of the item being traced. When: Non-simple problems. Why: Tracing makes diagnosing problems simpler because of the detail it provides.

38. Events - and why we use Event Tracing. Event – any action taken by the application. Usefulness of Event Tracing –Diagnosing performance problems. –Reason for error codes being returned. –Provides in-depth detail on each event.

39. Event Tracing in LF8 Event Tracing in LF7 was limited Event Tracing in LF8: –MOST SERVER EVENTS –LFFTS –LFSO8 –WinHTTP LF8 Server uses Event Tracing for Windows infrastructure to create event trace files (*.etl). –Viewable through Event Trace Viewer tool (ViewLFETL.exe).

40. Server and LFFTS Event Tracing Server Event Classes –LFAPI, LFRO, HTTP –Repository, Trustee, Entry, Session –Others LFFTS Events

41. Laserfiche 8 Architecture LFS LFROServHTTPServLFCRWMI Content Repository (CR) File SystemDBMS Clients WMIHTTPLFRO/DCOMLFAPI Full-Text Search Service

42. Server and LFFTS Event Tracing Enabling Tracing: –Performance Monitor All classes for Server/LFFTS –Tracelog Individual event classes –Logman Interface to performance monitor Can be scheduled/automated All classes

44. Event Tracing of LFSO8 Why: Can isolate problems caused only by the client. Events traced: Actions taken by single instance of LF Client (or other LF applications using LFSO8). Turned on and off using Toolkit. Output – text file.

45. Event Tracing of WinHTTP Why: tracing WinHTTP will let you see what requests the client is making to the server WinHTTP has its own built-in support for tracing. Events traced: all HTTP requests and server responses. WinHttpTraceCrf.exe –Utility that ships with Windows Server 2003 Resource Kit.

46. Event Tracing - Summary Event Tracing – powerful tool to collect a large and varied amount of data about events. ONLY recommended to be used during troubleshooting – will have detrimental impact on performance. https://support.laserfiche.com/ow.aspx?ServerT raceFileshttps://support.laserfiche.com/ow.aspx?ServerT raceFiles

47. LfSCPCfg Laserfiche Service Connection Point Configuration

48. LFSCPCfg What: Utility that retrieves/manages server connection information. When: Client/MakeLfRp can’t get the list of servers when creating/attaching a repository. Why: –Can find the port information of the server to assume matching between set up and what the client is looking for. –Can get connection information even when server is not running.

49. LF8 – SCP Objects in Active Directory LF8 – Service Connection Point Objects. –Previous versions of LF required an active server instance to find out what servers were available. No way to know about the existence of non-running servers –Active Directory: directory service used to store information about network resources across a domain. Clients query the directory to locate LF. –LF8 – uses SCP Objects residing in Active Directory to determine what servers are available. Created on server install, updated each time server is restarted.

50. LfSCPCfg – what and where is it? LfSCPCfg –Allows administrators to list, query, publish, and delete LF SCP objects in AD. –Located in server directory. –Run from command line in server directory.

52. ADPlus, LFDiagnostics Additional Diagnostic Tools

53. ADPlus What: Console based VB script that comes with WinDBg. When: LF Server is crashing or freezing. Why: Records exactly what is happening at the time of crash/freeze.

54. Generating memory dumps with ADPlus LF Server quits unexpectedly –‘crash mode’ - must start ADPlus before the crash occurs. –Can use –notify to tell an administrator or a computer in the event of a crash. LF Server stops responding or consumes 100% CPU –‘hang mode’ - must wait until process stops responding before running ADPlus. Dump and Debug files are generated in unique folder. https://support.laserfiche.com/kb/KBArticle.aspx?ArticleID=101098 6https://support.laserfiche.com/kb/KBArticle.aspx?ArticleID=101098 6 https://support.laserfiche.com/ow.aspx?ADPlus http://support.microsoft.com/default.aspx?scid=kb;en-us;286350

56. LFDiagnostics Comprehensive diagnostics tool currently used by support. Currently Version 7.2.1 (8.0 will be available). –Recently updated version, xml file. Records detailed LF and computer-specific information. –LF file and registry information, error logs, crash dumps. –Computer settings, Windows services. –IIS settings and log files. https://support.laserfiche.com/kb/KBArticle.aspx?ArticleID=1011900