EMC ApplicationXtender Server

Transcription

1 EMC ApplicationXtender Server 6.5 Monitoring Guide P/N A01 EMC Corporation Corporate Headquarters: Hopkinton, MA

2 Copyright EMC Corporation. All rights reserved. Published March 2010 EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice. THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Use, copying, and distribution of any EMC software described in this publication requires an applicable software license. For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. All other trademarks used herein are the property of their respective owners.

3 Table of Contents Preface... 7 Chapter 1 Accessing Utilities for AppXtender Server Monitors Introduction to Utilities for Monitoring Servers Starting ApplicationXtender Administrator Information about Logging into AppXtender Admin Monitoring Components Viewing Registered Components Unregistering a Registered Component Accessing the ApplicationXtender Web Access.NET Administrator Chapter 2 Monitoring the ApplicationXtender Web Access Server Monitoring AppXtender Web Server Using AppXtender Admin Monitoring AppXtender Web.NET Server Using AppXtender Web.NET Administrator Monitoring AppXtender Web Server Using Audit Trail Chapter 3 Monitoring ApplicationXtender Rendering Server Monitoring AppXtender Rendering Server Using AppXtender Admin Viewing Current Activity on the AppXtender Rendering Server Managing the AppXtender Rendering Server Service Monitoring AppXtender Rendering Server Using AppXtender Web.NET Administrator Monitoring AppXtender Rendering Server Using WMI Chapter 4 Monitoring the ApplicationXtender Index Server Monitoring AppXtender Index Server Using the AppXtender Index Server Monitor Monitoring Jobs on One Queue Monitoring Jobs on All Queues Viewing the Log File Keeping the AppXtender Index Server Monitor on Top Monitoring AppXtender Index Server Using AppXtender Queue Manager Starting AppXtender Queue Manager Logging into Data Sources Viewing the Contents of a Data Source Creating a New Queue Viewing the Properties of a Queue Viewing Jobs in a Queue Unlocking a Queue Viewing the Properties of a Job Viewing Elements of a Job Resubmitting a Job ApplicationXtender Server Monitoring Guide 3

4 Table of Contents Deleting Jobs Deleting all Jobs in a Queue Deleting a Queue Monitoring AppXtender Index Server Using AppXtender Admin Monitoring AppXtender Index Server Using AppXtender Web.NET Administrator Chapter 5 Monitoring ApplicationXtender Reports Management Server Monitoring AppXtender Reports Mgmt Server Using AppXtender Admin Chapter 6 Monitoring ApplicationXtender File Access Manager Server Monitoring AppXtender File Access Manager Server Using AppXtender Admin Viewing Current Activity on the AppXtender File Access Manager Server Managing the AppXtender File Access Manager Service Appendix A Using Audit Trails Introduction to Audit Trail Starting an Audit Trail Configuring Audit Trail Settings Configuring the Global Audit Settings for All AppXtender Applications Global Audit Trail Settings for all AppXtender Applications Enabling Global Audit Trail Options Configuring the Audit Trail Settings for a Single AppXtender Application Audit Settings for an AppXtender Application Enabling Audit Trail Options for an Application Glossary ApplicationXtender Server Monitoring Guide

5 Table of Contents List of Figures Figure 1. AppXtender Web.NET Login Page Figure 2. ApplicationXtender Web Access.NET Monitor Figure 3. ApplicationXtender Rendering Server Monitor Figure 4. AppXtender Index Server Monitor: Jobs Tab Figure 5. AppXtender Index Server Monitor: Jobs Tab: All Queues Figure 6. AppXtender Index Server Monitor: Log Tab Figure 7. AppXtender Queue Manager Figure 8. AppXtender Queue Manager Listing Contents Figure 9. New Queue Dialog Box Figure 10. AppXtender Queue Manager: Properties Dialog Box: Queue Figure 11. Viewing Queues Figure 12. Viewing Jobs Figure 13. AppXtender Queue Manager Message: Unlock Queue? Figure 14. AppXtender Queue Manager: Properties Dialog Box: Job Figure 15. Elements of a Job Figure 16. AppXtender Queue Manager Message: Purge Queue? Figure 17. ApplicationXtender Index Server Monitor Figure 18. Audit Trail Tab with the Audit Trail Turned Off Figure 19. Audit Trail Tab with the Audit Trail Turned On Figure 20. Audit Trail Tab with the Audit Trail Turned On Figure 21. Global Audit Trail Figure 22. Application Audit Trail Tab Figure 23. Audit Trail Tab for an AppXtender Application Figure 24. Audit Trail Settings Legend Dialog Box ApplicationXtender Server Monitoring Guide 5

6 Table of Contents List of Tables Table 1. ApplicationXtender Web Access Server Status Entries Table 2. ApplicationXtender Web Access.NET Server Status Entries Table 3. ApplicationXtender Rendering Server Status Entries Table 4. ApplicationXtender Rendering Server Status Entries Table 5. WMI WxRS Class Format Table 6. WMI WxRSControl Class Format Table 7. ApplicationXtender Index Server Status Entries Table 8. ApplicationXtender Index Server Status Entries Table 9. Table 10. ApplicationXtender Reports Management Server Print Stream Processor Entries ApplicationXtender Reports Management Server Report Processor Class Data Table 11. ApplicationXtender File Access Manager Server Status Entries Table 12. Global Audit Trail Settings Table 13. Global Audit Buttons for Configuring All Applications Table 14. Per-Application Audit Trail Settings Table 15. Check Box Appearance in Application Audit Trail Tabs Table 16. Audit Buttons for Configuring an Application ApplicationXtender Server Monitoring Guide

7 Preface This document provides instructions on how to monitor the following ApplicationXtender (AppXtender) servers: ApplicationXtender Web Access Server ApplicationXtender Rendering Server ApplicationXtender Index Server ApplicationXtender Reports Management Server ApplicationXtender File Access Manager Server As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes. If a product does not function properly or does not function as described in this document, please contact your EMC representative. Audience The information in this document is intended for system administrators who are responsible for installing software and maintaining the servers and clients on a network. Operators who monitor the daily backups may also find this manual useful. Related Documentation Post-release information is contained in the Release Notes for this product. This document is available at Refer to the web site periodically to view the latest Release Notes. Related documents include: ApplicationXtender Concepts Guide ApplicationXtender Core Components Administrator s Guide ApplicationXtender Desktop Installation Guide ApplicationXtender Web Access Administrator s Guide ApplicationXtender Index Server Administrator s Guide ApplicationXtender Server Monitoring Guide 7

8 Preface ApplicationXtender Reports Management Administrator s Guide Retention Manager for ApplicationXtender Integration Guide All documents are in Adobe Acrobat Portable Document Format (PDF), and can be viewed by downloading and installing the Adobe Acrobat Reader. The Reader is available from Adobe at To install and use the Reader on the preferred platform, refer to the instructions on the Adobe web site. Where to get help EMC support, product, and licensing information can be obtained as follows. Product information For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at Technical support For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account. The following table summarizes each chapter in this guide: Guide Summary Chapter Chapter 1, Accessing Utilities for AppXtender Server Monitors Chapter 2, Monitoring the ApplicationXtender Web Access Server Chapter 3, Monitoring ApplicationXtender Rendering Server Chapter 4, Monitoring the ApplicationXtender Index Server Chapter 5, Monitoring ApplicationXtender Reports Management Server Description You can use ApplicationXtender Administrator to monitor ApplicationXtender Servers. If you are using ApplicationXtender Web Access.NET, you can also use the ApplicationXtender Web Access.NET Administrator. This chapter describes how to access these utilities. This chapter describes how to monitor an ApplicationXtender Web Access server using ApplicationXtender Administrator, ApplicationXtender Web Access Administrator, WMI, and Audit Trail. This chapter describes how to monitor an ApplicationXtender Rendering Server using the ApplicationXtender Administrator, ApplicationXtender Web Access Administrator, and WMI. This chapter describes how to monitor an ApplicationXtender Index Server using the ApplicationXtender Index Server Monitor, ApplicationXtender Queue Manager, ApplicationXtender Administrator, and ApplicationXtender Web Access Administrator. This chapter describes how to monitor an ApplicationXtender Reports Management server using ApplicationXtender Administrator. 8 ApplicationXtender Server Monitoring Guide

9 Preface Chapter Chapter 6, Monitoring ApplicationXtender File Access Manager Server Appendix A, Using Audit Trails Description This chapter describes how to monitor an ApplicationXtender File Access Manager Server using ApplicationXtender Administrator. This appendix describes how to configure the Audit Trail feature, which allows you to track user activities. ApplicationXtender Server Monitoring Guide 9

10 Preface 10 ApplicationXtender Server Monitoring Guide

11 Chapter 1 Accessing Utilities for AppXtender Server Monitors This chapter describes how to access ApplicationXtender Administrator and ApplicationXtender Web Access.NET Administrator: Introduction to Utilities for Monitoring Servers, page 11 Starting ApplicationXtender Administrator, page 11 Accessing the ApplicationXtender Web Access.NET Administrator, page 13 Introduction to Utilities for Monitoring Servers A variety of utilities, such as ApplicationXtender Administrator (AppXtender Admin) and Windows Management Instrumentation (WMI), can be used to monitor AppXtender Servers. (WMI is a component of the Microsoft Windows operating system.) If you are using AppXtender Web.NET, you can also use the AppXtender Web Administrator to monitor AppXtender servers. Additional utilities are available for monitoring the AppXtender Web Server and AppXtender Index Server. Refer to Chapter 2, Monitoring the ApplicationXtender Web Access Server and Chapter 4, Monitoring the ApplicationXtender Index Server, respectively. Starting ApplicationXtender Administrator The first time you start ApplicationXtender Administrator (AppXtender Admin), some configuration is required. For details, refer to the Starting AppXtender Admin the First Time section of the ApplicationXtender Core Components Administrator s Guide. Subsequently, starting AppXtender Admin requires fewer steps. To start AppXtender Admin: 1. From the Windows Start menu, select Programs> ApplicationXtender Desktop > AppXtender Admin. A login dialog box appears. 2. In the User Name text box, type an administrative user name. For details, see Information about Logging into AppXtender Admin, page In the Password text box, type the password for the user name you entered. ApplicationXtender Server Monitoring Guide 11

12 Accessing Utilities for AppXtender Server Monitors 4. Click Login. AppXtender Admin appears. For instructions on viewing or unregistering components within AppXtender Admin, see Monitoring Components, page 12. Information about Logging into AppXtender Admin When you log into AppXtender Admin, you are logging into all of the data sources in AppXtender Admin simultaneously. If all of the data sources in AppXtender Admin are using either the CM security provider or the Windows security provider, the user account that you use to log into AppXtender Admin must meet the following criteria: It must exist on all data sources. It must have the same password on all data sources. It must have the AppXtender Admin user privilege on each data source. (This criterion does not apply to SYSOP.) However, if more than one security provider is being used in AppXtender Admin (for example, if one data source is using a directory service security provider and the rest are using the CM security provider), only SYSOP may log in to AppXtender Admin. In this case, SYSOP must have the same password on all data sources. For more details, refer to the Information about Logging into AppXtender section of the ApplicationXtender Core Components Administrator s Guide. Monitoring Components You can use AppXtender Admin to verify that ApplicationXtender content management components have been correctly registered for the data group being managed through that AppXtender Admin installation. You can also monitor performance on the servers through AppXtender Admin. For more information, see the following sections: Viewing Registered Components, page 12 Unregistering a Registered Component, page 13 Monitoring AppXtender Web Server Using AppXtender Admin, page 17 Monitoring AppXtender Rendering Server Using AppXtender Admin, page 25 Monitoring AppXtender Index Server Using AppXtender Admin, page 43 Monitoring AppXtender Reports Mgmt Server Using AppXtender Admin, page 47 Monitoring AppXtender File Access Manager Server Using AppXtender Admin, page 51 Viewing Registered Components You can view a list of registered components and view activity for each component. 12 ApplicationXtender Server Monitoring Guide

13 Accessing Utilities for AppXtender Server Monitors To view registered components for the data source group: 1. In the AppXtender Admin tree, expand the Monitor node and then select Registered Components. 2. A list of components currently registered with this data source group appears in the right pane. 3. To refresh the list of components to reflect newly registered components, select Refresh (at the bottom of the right pane). 4. To view current activity on a component, select the component in the list. Any activity detail appears in the lower half of the right pane. Unregistering a Registered Component If you unregister a registered component, that component is no longer used by the data source group, even if it is still installed and running. To re-register components that have been unregistered, you need to run the Component Setup Wizard for that component again on the computer where the component is installed. Note: For more information on running Component Setup Wizard for a component, refer to the installation information for that component in the appropriate guide, such as the ApplicationXtender Web Access Administrator s Guide. To unregister a registered component: 1. In the AppXtender Admin tree, expand the Monitor node and then select Registered Components. 2. Select the component in the list and select the Unregister button at the bottom of the pane. A message appears asking you to confirm that you want to unregister the component. 3. Select Yes to remove the component from the data source group by unregistering it; select No to cancel the request without unregistering the component. Accessing the ApplicationXtender Web Access.NET Administrator You can access administrative functions through the AppXtender Web.NET client browser interface if you have administrative permissions. To access the AppXtender Web.NET Administrator through a browser: 1. Enter the website address for AppXtender Web.NET in your browser Address text box. The format for the website URL is as follows: The placeholder <Server> represents the IP address or domain of the IIS server. The placeholder <alias> represents the AppXtender Web.NET server alias you specified when installing AppXtender Web.NET. By default the alias is AppXtender. Note: If you do not know the name of the AppXtender Web.NET server, contact your AppXtender Web.NET administrator for assistance. ApplicationXtender Server Monitoring Guide 13

14 Accessing Utilities for AppXtender Server Monitors The Login page appears. Figure 1. AppXtender Web.NET Login Page 2. To use a data source other than the default data source, on the AppXtender Web.NET Login dialog box, select the desired data source from the Data Source drop-down list. The selected data source is considered the active data source for the session. All of the data sources available to you appear in the Data Source drop-down list. If you choose Default, you are logged into either the data source that your AppXtender Web.NET administrator set as default or the data source that you set as default in a previous session. 3. Type your ApplicationXtender login user name and password in the corresponding text boxes. 4. If the Request Full Text Search Support check box is not checked, select the box by clicking it. A check mark appears in the box. If you do not have full text privileges, a message indicating this will appear as you log in. Also, if the maximum number of full-text licenses has been exceeded, a warning message will appear during login. In both cases, the Full-Text Query Criteria section will not appear on the search criteria page. 5. Click Login. The ApplicationXtender Web Access Applications window opens. 6. Select Edit> Administration. The ApplicationXtender Web Access.NET Administrator window opens. 14 ApplicationXtender Server Monitoring Guide

15 Accessing Utilities for AppXtender Server Monitors For instructions on using the ApplicationXtender Web Access.NET Administrator to monitor AppXtender servers, see the following sections: Monitoring AppXtender Web.NET Server Using AppXtender Web.NET Administrator, page 20 Monitoring AppXtender Rendering Server Using AppXtender Web.NET Administrator, page 27 Monitoring AppXtender Index Server Using AppXtender Web.NET Administrator, page 44 ApplicationXtender Server Monitoring Guide 15

16 Accessing Utilities for AppXtender Server Monitors 16 ApplicationXtender Server Monitoring Guide

17 Chapter 2 Monitoring the ApplicationXtender Web Access Server This chapter describes how to monitor ApplicationXtender Web Access (AppXtender Web) using various utilities: Monitoring AppXtender Web Server Using AppXtender Admin, page 17 Monitoring AppXtender Web.NET Server Using AppXtender Web.NET Administrator, page 20 Monitoring AppXtender Web Server Using Audit Trail, page 23 Monitoring AppXtender Web Server Using AppXtender Admin You can use AppXtender Admin to view information related to the operation of an AppXtender Web server that is stored in the WMI repository on the AppXtender Web server. To monitor current activity on the AppXtender Web Server: 1. Start AppXtender Admin. For instructions, see Starting ApplicationXtender Administrator, page In the AppXtender Admin tree, expand the Monitor node and then select AppXtender Web. 3. To select the AppXtender Web Server to monitor, choose the name of the server from the Select component list. (To refresh the list of components to reflect newly registered components, select Refresh.) Status entries appear for the items listed in the following table. Table 1. ApplicationXtender Web Access Server Status Entries Entry Anonymous Requests Anonymous Requests/Sec Description Number of requests utilizing anonymous authentication Number of requests per second utilizing anonymous authentication ApplicationXtender Server Monitoring Guide 17

18 Monitoring the ApplicationXtender Web Access Server Entry Cache API Entries Cache API Hit Ratio Cache API Hit Ratio Base Cache API Hits Cache API Misses Cache API Turnover Rate Cache Total Entries Cache Total Hit Ratio Cache Total Hit Ratio Base Cache Total Hits Cache Total Misses Cache Total Turnover Rate Compilations Total Debugging Requests Errors During Compilation Errors During Execution Errors During Preprocessing Errors Total Errors Total/Sec Errors Unhandled During Execution Errors Unhandled During Execution/Sec Output Cache Entries Output Cache Hit Ratio Output Cache Hit Ratio Base Output Cache Hits Description Total number of entries within the cache added by the user Ratio of hits called from user code Cache API Hit Ratio Base Number of hits from user code Number of cache misses called from user code Number of additions and removals to the API cache per second Total number of entries within the cache (both internal and user added) Ratio of hits from all cache calls Cache Total Hit Ratio Base Total number of hits from the cache Total number of cache misses Number of additions to and removals from the total cache per second Number of.asax,.ascx,.ashx,.asmx, or.aspx source files dynamically compiled Number of debugging requests processed Number of errors that have occurred during compilation Number of errors that have occurred during the processing of a request Number of errors that have occurred during parsing and configuration Total number of errors that occurred Rate of error occurrence Number of errors not handled by user code, but by the default error handler Rate of unhandled errors Current number of entries in the output cache Ratio of hits to requests for output cacheable requests Output Cache Hit Ratio Base Total number of output cacheable requests served from the output cache 18 ApplicationXtender Server Monitoring Guide

19 Monitoring the ApplicationXtender Web Access Server Entry Output Cache Misses Output Cache Turnover Rate Pipeline Instance Count Request Bytes In Total Request Bytes Out Total Requests Executing Requests Failed Requests In Application Queue Requests Not Authorized Requests Not Found Requests Succeeded Requests Timed Out Requests Total Requests/Sec Session SQL Server connections total Session State Server connections total Sessions Abandoned Sessions Active Sessions Timed Out Sessions Total Transactions Aborted Transactions Committed Transactions Pending Transactions Total Transactions/Sec Description Total number of output cacheable requests not served from the output cache Number of additions to and removals from the output cache per second Number of active pipeline instances The total size, in bytes, of all requests The total size, in bytes, of responses sent to a client. This does not include standard HTTP response headers. The number of requests currently executing Total number of failed requests The number of request in the application request queue The number of requests failed due to unauthorized access The number of requests for resources that were not found The number of requests that executed successfully The number of requests that timed out The total number of requests since the application was started The number of requests executed per second The total number of connections to the SQL Server used by session state The total number of connections to the State Server used by session state The number of sessions that have been explicitly abandoned The number of sessions currently active The number of sessions timed out Total number of sessions since the application was started The number of transactions aborted The number of transactions committed The number of transactions in progress The total number of transactions since the application was started Transactions started per second ApplicationXtender Server Monitoring Guide 19

20 Monitoring the ApplicationXtender Web Access Server Monitoring AppXtender Web.NET Server Using AppXtender Web.NET Administrator You can track the current AppXtender Web.NET Server status using the AppXtender Web.NET Administrator. To monitor current activity on the AppXtender Web.NET Server: 1. Access the AppXtender Web.NET Administrator. For instructions, see Accessing the ApplicationXtender Web Access.NET Administrator, page In the Admin window, select View> Monitor ApplicationXtender Web Access.NET. The ApplicationXtender Web Access.NET Monitor appears. Figure 2. ApplicationXtender Web Access.NET Monitor 3. To select the AppXtender Web.NET Server to monitor, enter the name of the server in the Server Name text box. 4. To refresh the status entries to reflect new activity, select Refresh. Status entries appear for the items listed in the following table. Table 2. ApplicationXtender Web Access.NET Server Status Entries Entry Anonymous Requests Anonymous Requests/Sec Description Number of requests using anonymous authentication Number of requests per second using anonymous authentication 20 ApplicationXtender Server Monitoring Guide

21 Monitoring the ApplicationXtender Web Access Server Entry Cache Total Entries Cache Total Entries Cache Total Hits Cache Total Misses Cache Total Hit Ratio Cache Total Hit Ratio Base Cache API Entries Cache API Turnover Rate Cache API Hits Cache API Misses Cache API Hit Ratio Cache API Hit Ratio Base Output Cache Entries Output Cache Turnover Rate Output Cache Hits Output Cache Misses Output Cache Hit Ratio Output Cache Hit Ratio Base Compilations Total Debugging Requests Errors During Preprocessing Errors During Compilation Errors During Execution Errors Unhandled During Execution Errors Unhandled During Execution/Sec Errors Total Description Total number of entries within the cache (both internal and user added) Cache Total Entries Total number of hits from the cache Total number of cache misses Ratio of hits from all cache calls Cache Total Hit Ratio Base Total number of entries within the cache added by the user Number of additions and removals to the API cache per second Number of hits from user code Number of cache misses called from user code Ratio of hits called from user code Cache API Hit Ratio Base Current number of entries in the output cache Number of additions to and removals from the output cache per second Total number of output cacheable requests served from the output cache Total number of output cacheable requests not served from the output cache Ratio of hits to requests for output cacheable requests The base used to determine the output cache hit ratio Number of.asax,.ascx,.ashx,.asmx, or.aspx source files dynamically compiled Number of debugging requests processed Number of errors that have occurred during parsing and configuration Number of errors that have occurred during compilation Number of errors that have occurred during the processing of a request Number of errors not handled by user code, but by the default error handler Rate of unhandled errors Total number of errors that occurred ApplicationXtender Server Monitoring Guide 21

22 Monitoring the ApplicationXtender Web Access Server Entry Errors Total/Sec Pipeline Instance Count Request Bytes In Total Request Bytes Out Total Requests Executing Requests Failed Requests In Application Queue Requests Not Authorized Requests Not Found Requests Succeeded Requests Timed Out Requests Total Requests/Sec Cache Total Turnover Rate Output Cache Entries Output Cache Hit Ratio Output Cache Hit Ratio Base Output Cache Hits Output Cache Misses Output Cache Turnover Rate Session SQL Server connections total Session State Server connections total Sessions Abandoned Sessions Active Sessions Timed Out Description Rate of error occurrence Number of active pipeline instances The total size, in bytes, of all requests The total size, in bytes, of responses sent to a client. This does not include standard HTTP response headers. The number of requests currently executing Total number of failed requests The number of requests in the application request queue The number of requests failed due to unauthorized access The number of requests for resources that were not found The number of requests that executed successfully The number of requests that timed out The total number of requests since the application was started The number of requests executed per second Number of additions to and removals from the total cache per second Current number of entries in the output cache Ratio of hits to requests for output cacheable requests Output Cache Hit Ratio Base Total number of output cacheable requests served from the output cache Total number of output cacheable requests not served from the output cache Number of additions to and removals from the output cache per second The total number of connections to the SQL Server used by session state The total number of connections to the State Server used by session state The number of sessions that have been explicitly abandoned The number of sessions currently active The number of sessions timed out 22 ApplicationXtender Server Monitoring Guide

23 Monitoring the ApplicationXtender Web Access Server Entry Sessions Total Transactions Aborted Transactions Committed Transactions Pending Transactions Total Transactions/Sec Description Total number of sessions since the application was started The number of transactions aborted The number of transactions committed The number of transactions in progress The total number of transactions since the application was started Transactions started per second Monitoring AppXtender Web Server Using Audit Trail You can track AppXtender Web events using AppXtender Audit Trail. AppXtender Audit Trail allows you to track user activities such as user login/logout, viewing and deletion of documents and pages, addition and deletion of annotations, batch indexing, printing, and queries. The events to be audited are configured through AppXtender Application Generator (AppXtender AppGen), and can be enabled or disabled for an application, user, or group. When user activity triggers an audit event, details of the event are recorded in the audit trail. Each line in the audit trail represents a single audit event. Depending on the configuration, the audit trail can contain status information for each application and global audit events. Note: AppXtender Desktop and Web audit trail logs cannot be separated. If Audit Trail is enabled and AppXtender Web is installed, both AppXtender Web and AppXtender Desktop events will be tracked. Caution: When using AppXtender Audit Trail for AppXtender Web tracking purposes, you should never select the Log to File check box in AppXtender AppGen. Instead, you should only enable the Log to Database option to log AppXtender Web activity. After audit settings are configured, you can choose to store audit trail events in the AppXtender audit trail database table (AE_AUDIT) or in a log file (AxAudit.log), or both. ApplicationXtender Audit Trail encodes the time column tsstamp in the AE_AUDIT table in Greenwich Mean Time (GMT) format. This allows the audit table entries to maintain consistency when workstations are located in multiple time zones. You can calculate your local time by applying your time zone offset. For example, Eastern Standard Time (EST) is -5 hours. Note: If you have configured Audit Trail to log tracking information to the database table, be aware that the database will expand as the number of user transactions grows. If your system is heavily used, you should plan a scheduled maintenance of the records in the AE_AUDIT table of your database. For information about configuring Audit Trail in AppXtender AppGen, see Appendix A, Using Audit Trails. ApplicationXtender Server Monitoring Guide 23

24 Monitoring the ApplicationXtender Web Access Server The following AppXtender Web activities can be tracked using Audit Trail: Modification (including annotations) of documents Modification of document indexes Viewing of document pages Printing of documents and pages Addition, deletion, annotation, OCR/Text-view of a page version Batch indexing Adding, deleting, or attaching pages to a batch document Deleting or adding memos to batches Executing queries User login and logout of the AppXtender Web system Note: AppXtender Web print processes are tracked by AppXtender Audit Trail as long as they are performed using AppXtender Web client commands (Print from Result Set, Print from Interactive Client, and so on). Printing documents using browser print commands are not tracked, however, as AppXtender Web printing is performed completely on the AppXtender Web client without server or database interaction. 24 ApplicationXtender Server Monitoring Guide

25 Monitoring ApplicationXtender Rendering Server Chapter 3 This chapter describes how to monitor AppXtender Rendering Servers using various utilities: Monitoring AppXtender Rendering Server Using AppXtender Admin, page 25 Monitoring AppXtender Rendering Server Using AppXtender Web.NET Administrator, page 27 Monitoring AppXtender Rendering Server Using WMI, page 28 Monitoring AppXtender Rendering Server Using AppXtender Admin The AppXtender Rendering Server subnode of the Monitor node allows you to view current activity on the AppXtender Rendering Server. It also lets you start and stop the AppXtender Rendering Server service. For more information, see the following sections: Viewing Current Activity on the AppXtender Rendering Server, page 25 Managing the AppXtender Rendering Server Service, page 26 Viewing Current Activity on the AppXtender Rendering Server You can use AppXtender Admin to view information related to the operation of an AppXtender Rendering Server that is stored in the WMI repository on the AppXtender Rendering Server. To monitor current activity on the AppXtender Rendering Server: 1. Start AppXtender Admin. For instructions, see Starting ApplicationXtender Administrator, page In the AppXtender Admin tree, expand the Monitor node and then select AppXtender Rendering Server. 3. To select the AppXtender Rendering Server to monitor, choose the name of the server from the Select component list. (To refresh the list of components to reflect newly registered components, select Refresh.) ApplicationXtender Server Monitoring Guide 25

26 Monitoring ApplicationXtender Rendering Server Status entries appear for the items listed in the following table. Table 3. ApplicationXtender Rendering Server Status Entries Entry ConfigurationTimestamp CurrentConversions DiskFullPercent LastGCCount LastGCSizeMB ServerStatus StartTime StopTime TotalEntries TotalForeignFiles TotalImageFiles Description The timestamp for the session when the AppXtender Rendering Server configuration was last modified. The total number of conversions occurring at the time of monitoring. The percentage of the AppXtender Rendering Server cache disk used at the time of monitoring. The total number of items removed from cache when the last garbage collection occurred. The total number of megabytes of items removed from cache when the last garbage collection occurred. The status of the AppXtender Rendering Server service at the time of monitoring. The time that the AppXtender Rendering Server service was last started. The time that the AppXtender Rendering Server service was last started. The total number of items rendered by the AppXtender Rendering Server. The total number of foreign files rendered by the AppXtender Rendering Server. The total number of images rendered by the AppXtender Rendering Server. Managing the AppXtender Rendering Server Service You can also manage the service status for the selected AppXtender Rendering Server. To manage the service status: 1. Start AppXtender Admin. For instructions, see Starting ApplicationXtender Administrator, page In the AppXtender Admin tree, expand the Monitor node and then select AppXtender Rendering Server. 3. To select the AppXtender Rendering Server to monitor, choose the name of the server from the Select component list. (To refresh the list of components to reflect newly registered components, select Refresh.) 26 ApplicationXtender Server Monitoring Guide

27 Monitoring ApplicationXtender Rendering Server 4. To start the service if it is stopped, select Start. You are prompted to confirm that the service should be started; select Yes. 5. To stop the service if it is running, click Stop. You are prompted to confirm that the service should be stopped; select Yes. Monitoring AppXtender Rendering Server Using AppXtender Web.NET Administrator You can view the current status of the AppXtender Rendering Server using AppXtender Web.NET Administrator. To monitor AppXtender Rendering Server status: 1. Access the AppXtender Web.NET Administrator. For instructions, see Accessing the ApplicationXtender Web Access.NET Administrator, page In the Admin window, select View> Monitor ApplicationXtender Rendering Server. The ApplicationXtender Rendering Server Monitor appears. Figure 3. ApplicationXtender Rendering Server Monitor 3. To select the AppXtender Rendering Server to monitor, enter the name of the server in the Server Name text box. ApplicationXtender Server Monitoring Guide 27

28 Monitoring ApplicationXtender Rendering Server 4. To refresh the status entries to reflect new activity, select Refresh. Status entries appear for the items listed in the following table. Table 4. ApplicationXtender Rendering Server Status Entries Entry ConfigurationTimestamp CurrentConversions DiskFullPercent LastGCCount LastGCSizeMB ServerStatus StartTime StopTime TotalEntries TotalForeignFiles TotalImageFiles Description The timestamp for the session when the AppXtender Rendering Server configuration was last modified The total number of conversions occurring at the time of monitoring The used percentage of the AppXtender Rendering Server cache disk at the time of monitoring The total number of items removed from cache when the last garbage collection occurred The total number of megabytes of items removed from cache when the last garbage collection occurred The status of the AppXtender Rendering Server service at the time of monitoring The time that the AppXtender Rendering Server service was last started The time that the AppXtender Rendering Server service was last started The total number of items rendered by the AppXtender Rendering Server The total number of foreign files rendered by the AppXtender Rendering Server The total number of images rendered by the AppXtender Rendering Server Monitoring AppXtender Rendering Server Using WMI If you have a large number of rendering sessions to monitor, you may find it more practical to access this log data through WMI. Using a custom application or script, you can use this data to automate your restart, recovery, and maintenance tasks. Before you can access AppXtender Rendering Server data in WMI, you must configure AppXtender Rendering Server to provide WMI data during processing. 28 ApplicationXtender Server Monitoring Guide

29 Monitoring ApplicationXtender Rendering Server To access AppXtender Rendering Server log data in WMI: 1. Install Microsoft WMI CIM Studio on the same computer as AppXtender Rendering Server. For instructions, refer to the Microsoft Online Help. 2. Start WMI CIM Studio. The Connect to namespace dialog box appears. 3. Enter the namespace as follows: root\cimv2\applications\xscm, and then click OK. The WMI CIM Studio Login dialog box appears. 4. Accept all defaults and click OK. The WMI CIM Studio appears. 5. Click the plus sign to the left of the AppXtender Rendering Server class to see its two classes: WxRS and WxRSControl. Click each subclass to see its properties. The properties of the subclasses are listed in the following tables. Table 5. WMI WxRS Class Format Property WorkstationName ConfigurationTimestamp UpdateTime StartTime StopTime ServerStatus TotalImageFiles TotalForeignFiles TotalPDFFiles TotalThumbnails TotalEntries TotalSize CurrentConversions LastGCTime LastGCCount LastGCSizeMB DiskFullPercent Description Name of workstation Time of last configuration Time of last update Time AppXtender Rendering Server was started Time AppXtender Rendering Server was stopped Current status of AppXtender Rendering Server (e.g., running, suspended, stopped) Total number of image files rendered Total number of foreign files rendered Total number of PDF files rendered Total number of thumbnails rendered Total number of entries Total size in megabytes Number of current file conversions Time of last garbage collection Count of last garbage collection Size of last garbage collection in megabytes Cache disk full percentage Table 6. WMI WxRSControl Class Format Property WorkstationName ClearCacheRequest GarbageCollectionEnabled Description Name of workstation When set to 1, the cache clears When set to 1, garbage collection will run ApplicationXtender Server Monitoring Guide 29

30 Monitoring ApplicationXtender Rendering Server Property GarbageCollectionFileSetSize GarbageCollectionReduction- Percent GarbageCollectionFrequency MaximumCacheEntries MaximumCacheKilobytes QueuePollingInterval LoggingEnabled Description Current file size set for garbage collection Current garbage collection reduction percentage Frequency of garbage collection in seconds Maximum number of cache entries Maximum cache size in kilobytes Interval for polling queues in milliseconds When set to 1, the AppXtender Rendering Server logs data to disk 30 ApplicationXtender Server Monitoring Guide

31 Chapter 4 Monitoring the ApplicationXtender Index Server This chapter describes how to monitor the AppXtender Index Server using various utilities: Monitoring AppXtender Index Server Using the AppXtender Index Server Monitor, page 31 Monitoring AppXtender Index Server Using AppXtender Queue Manager, page 34 Monitoring AppXtender Index Server Using AppXtender Admin, page 43 Monitoring AppXtender Index Server Using AppXtender Web.NET Administrator, page 44 Monitoring AppXtender Index Server Using the AppXtender Index Server Monitor The AppXtender Index Server Monitor can be used to view the current status of jobs in the Processing Queues. For more information, see the following sections: Monitoring Jobs on One Queue, page 31 Monitoring Jobs on All Queues, page 32 Viewing the Log File, page 33 Keeping the AppXtender Index Server Monitor on Top, page 34 Note: The AppXtender Index Server Monitor closes automatically when it is not the active window. You can configure the AppXtender Index Server Monitor to remain on top of all open dialog boxes, however. For instructions, see Keeping the AppXtender Index Server Monitor on Top, page 34. Monitoring Jobs on One Queue To monitor the jobs on one queue: 1. Double-click the ApplicationXtender Index Server icon in the status area of the Windows task bar. The AppXtender Index Server Monitor appears. 2. Click the Jobs tab. ApplicationXtender Server Monitoring Guide 31

32 Monitoring the ApplicationXtender Index Server Figure 4. AppXtender Index Server Monitor: Jobs Tab 3. From the Processing Queues drop-down list, select the queue you want to monitor. The Jobs tab of the AppXtender Index Server Monitor displays information about the jobs on that queue that are currently being processed by the AppXtender Index Server. Monitoring Jobs on All Queues To monitor the jobs on all queues: 1. Double-click the ApplicationXtender Index Server Monitor icon in the status area of the Windows task bar. The AppXtender Index Server Monitor appears. 2. Click the Jobs tab. 3. From the Processing Queues drop-down list, select All queues. The Jobs tab of the AppXtender Index Server Monitor displays information about all of the jobs that are currently queued for processing by the AppXtender Index Server. 32 ApplicationXtender Server Monitoring Guide

33 Monitoring the ApplicationXtender Index Server Figure 5. AppXtender Index Server Monitor: Jobs Tab: All Queues Viewing the Log File To view the AppXtender Index Server Monitor Log: 1. Double-click the ApplicationXtender Index Server icon in the status area of the Windows task bar. The AppXtender Index Server Monitor appears. 2. Click the Log tab. The Log tab lists the jobs that have been processed by the AppXtender Index Server. Job errors and job completions are both logged. Each message is identified by a thread ID. ApplicationXtender Server Monitoring Guide 33

34 Monitoring the ApplicationXtender Index Server Figure 6. AppXtender Index Server Monitor: Log Tab Note: If the end of a line of the log extends beyond the edge of the screen, you can open the log file to see the details that cannot be viewed. Keeping the AppXtender Index Server Monitor on Top If you want the AppXtender Index Server Monitor dialog box to remain in front of all other open dialog boxes, use the following procedure: To keep the AppXtender Index Server Monitor on top: 1. Right-click the ApplicationXtender Index Server icon in the status area of the Windows task bar. A shortcut menu appears. 2. From the shortcut menu, select AppXtender Index Server Monitor Always on Top. When the AppXtender Index Server Monitor Always on Top option is checked and when the AppXtender Index Server Monitor is open, the AppXtender Index Server Monitor dialog box remains in front of all other open dialog boxes. Monitoring AppXtender Index Server Using AppXtender Queue Manager AppXtender Queue Manager allows you to manage AppXtender Index Server queues for full-text indexing and OCR processing. AppXtender Queue Manager allows you to manage the queues in all of your AppXtender data sources. Note: Only users with the Administrator privilege in their user profiles may manage queues. 34 ApplicationXtender Server Monitoring Guide

35 Monitoring the ApplicationXtender Index Server For instructions, see the following sections: Starting AppXtender Queue Manager, page 35 Logging into Data Sources, page 36 Viewing the Contents of a Data Source, page 36 Creating a New Queue, page 37 Viewing the Properties of a Queue, page 38 Viewing Jobs in a Queue, page 38 Unlocking a Queue, page 39 Viewing the Properties of a Job, page 40 Viewing Elements of a Job, page 41 Resubmitting a Job, page 42 Deleting Jobs, page 42 Deleting all Jobs in a Queue, page 42 Deleting a Queue, page 43 You can also run saved queries from AppXtender Queue Manager. For instructions, refer to the "Managing Saved Queries" section of the ApplicationXtender Core Components Administrator s Guide. Starting AppXtender Queue Manager The following procedure describes how to start AppXtender Queue Manager. To start AppXtender Queue Manager: 1. From the Windows Start menu, select Programs and then ApplicationXtender Desktop. 2. From the ApplicationXtender Desktop menu, select AppXtender Queue Manager. The AppXtender Queue Manager window appears. Figure 7. AppXtender Queue Manager The left pane of the AppXtender Queue Manager window lists the existing data sources. For instructions on logging into each data source you want to manage, see Logging into Data Sources, page 36. ApplicationXtender Server Monitoring Guide 35

36 Monitoring the ApplicationXtender Index Server Logging into Data Sources Repeat the following procedure for each data source you want to manage. To log into a data source in AppXtender Queue Manager: 1. In the left pane of the AppXtender Queue Manager window, click QueueManager. The existing data sources are listed on the right. From the list on the right, double-click a data source name. The Login dialog box appears. 2. In the User Name text box, type a user name that is valid for the selected data source. Note: Your login procedure may vary depending on the security provider in use for the current data source. For information, refer to the Information about Logging into AppXtender Admin section of the ApplicationXtender Core Components Administrator s Guide. 3. In the Password text box, type your password. 4. Click Login. Once you have successfully logged in, AppXtender Queue Manager lists the contents (the queues and applications) of the data source. Figure 8. AppXtender Queue Manager Listing Contents Viewing the Contents of a Data Source AppXtender Queue Manager can display a list of the queues and applications for each AppXtender data source. To view the contents of a data source: 1. Start AppXtender Queue Manager. For instructions, see Starting AppXtender Queue Manager, page Log in to the data source. For instructions, see Logging into Data Sources, page Once logged in, the contents of the data source appear on the right. If you want to show or hide a list of the queues in the data source, from the View menu, select View Queues. For each queue in the data source (when queues are shown), information is provided including a name, a type, a queue status, an ID number, and a description. If you want to show or hide a list of the applications in the data source, from the View menu, select View Applications. For each application in the data source (when applications are shown), information is provided including a name, a type, an application status, an ID number, and a description. 36 ApplicationXtender Server Monitoring Guide