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

37 Monitoring the ApplicationXtender Index Server Creating a New Queue You can create a new queue in AppXtender Queue Manager. To create a new queue: 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 Make sure that the contents of a data source are listed on the right. For instructions, see Viewing the Contents of a Data Source, page From the list of queues and applications on the right, right-click any queue or application. A shortcut menu appears. From the shortcut menu, select New Queue. The New Queue dialog box appears. Figure 9. New Queue Dialog Box 5. In the Name text box, type a name for the new queue. 6. From the Type drop-down list, select a queue type. You have the following choices: If you want to create a queue for submitting full-text jobs to the AppXtender Index Server, select FULLTEXT. If you want to create a queue for OCR jobs, select OCR. 7. In the Description text box, you can type a description for the new queue. 8. Click OK. The new queue is added to the list of queues. Note: If the new queue does not appear in the list of queues on the left, select Refresh from the View menu. 9. If the newly created queue is for OCR jobs or full-text jobs, you must add the queue to the AppXtender Index Server s Processing Queues list. Jobs sent to the queue are not processed until the queue has been added to the Processing Queues list. For more information, refer to the "Adding Queues to be Processed" section of theapplicationxtender Index Server Administrator s Guide. ApplicationXtender Server Monitoring Guide 37

38 Monitoring the ApplicationXtender Index Server Note: Once you have created an OCR or full-text queue and configured the AppXtender Index Server, make sure that the AppXtender Desktop workstations on which users need to submit jobs to these queues are configured to allow OCR or full-text processing. These configurations are performed on the OCR tab and Full Text tab of the AppXtender Desktop Configuration dialog box. For more information, refer to the ApplicationXtender Desktop Installation Guide. Viewing the Properties of a Queue You can view the properties of a queue in AppXtender Queue Manager. To view the properties of a queue: 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 Make sure that the contents of a data source are listed on the right. For instructions, see Viewing the Contents of a Data Source, page If the existing queues are not listed on the right, select View Queues from the View menu. 5. From the list on the right, right-click a queue name. A shortcut menu appears. From the shortcut menu, select Properties. The Properties dialog box appears, providing the queue s name, description, type, status, and number of jobs. Figure 10. AppXtender Queue Manager: Properties Dialog Box: Queue Viewing Jobs in a Queue You can view the jobs in a queue in AppXtender Queue Manager. 38 ApplicationXtender Server Monitoring Guide

39 Monitoring the ApplicationXtender Index Server To view the jobs in a queue: 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 Make sure that the contents of a data source are listed on the right. For instructions, see Viewing the Contents of a Data Source, page If the existing queues are not listed on the right, select View Queues from the View menu. Figure 11. Viewing Queues 5. From the list on the right, double-click a queue name. A list of jobs in the queue appears on the right. For each job, information is provided including a JobID number, a UserID number, a priority number, a date and time submitted, a date and time started, a date and time finished, and a job status. Figure 12. Viewing Jobs Note: Depending on configuration in the AppXtender Index Server, jobs may be removed from the job listing upon successful completion. For more information, refer to the "Remove Job from Queue when Finished" section of theapplicationxtender Index Server Administrator s Guide. Unlocking a Queue If AppXtender Queue Manager indicates (in the status column) that a queue is locked, you can unlock the queue. If a queue is locked, it does not accept any new jobs. Unlocking the queue allows the queue to accept jobs normally. Note: If the status column does not indicate that the queue is locked, do not attempt to unlock the queue. ApplicationXtender Server Monitoring Guide 39

40 Monitoring the ApplicationXtender Index Server To unlock a queue: 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 Make sure that the contents of a data source are listed on the right. For instructions, see Viewing the Contents of a Data Source, page If the existing queues are not listed on the right, select View Queues from the View menu. 5. From the list on the right, right-click a queue name. A shortcut menu appears. From the shortcut menu, select Unlock queue. A message appears, requesting confirmation. Figure 13. AppXtender Queue Manager Message: Unlock Queue? 6. Click Yes. Viewing the Properties of a Job You can view the properties of a job in AppXtender Queue Manager. To view the properties of a job: 1. Make sure that a list of jobs appears on the right. For instructions, see Viewing Jobs in a Queue, page Right-click a job. A shortcut menu appears. From the shortcut menu, select Properties. The Properties dialog box appears, providing the Job ID number, the date and time submitted, the user name of the user who submitted the job, the date and time started, the date and time finished, and a job status. 40 ApplicationXtender Server Monitoring Guide

41 Monitoring the ApplicationXtender Index Server Figure 14. AppXtender Queue Manager: Properties Dialog Box: Job 3. If you want to see more details in the text box below the job status, click Details. Viewing Elements of a Job You can view elements of a job in AppXtender Queue Manager. The elements of the job include index number, AppID number, DocID number, page number, page version, status, and description. To view elements of a job: 1. Make sure that a list of jobs appears on the right. For instructions, see Viewing Jobs in a Queue, page Double-click a job. The elements of the job appear on the right, including index number, AppID number, DocID number, page number, page version, status, and description. Figure 15. Elements of a Job ApplicationXtender Server Monitoring Guide 41

42 Monitoring the ApplicationXtender Index Server Resubmitting a Job You can resubmit a job in AppXtender Queue Manager. The resubmit function is useful if you believe a previous job has failed. Even if the job was processed successfully, resubmitting it results in no action, so there is no consequence to resubmitting a successful job. In addition, multiple jobs can be resubmitted at the same time, if appropriate. To resubmit a job: 1. Make sure that a list of jobs appears on the right. For instructions, see Viewing Jobs in a Queue, page Right-click a job. A shortcut menu appears. From the shortcut menu, select Resubmit. The job is resubmitted. Deleting Jobs You can delete jobs in AppXtender Queue Manager. You may delete jobs individually or select multiple jobs and delete them all at once. Note: Do not attempt to delete a job that is currently processing. To delete jobs: 1. Make sure that a list of jobs appears on the right. For instructions, see Viewing Jobs in a Queue, page From the list of jobs on the right, select one or more jobs for deletion. Note: To select two or more jobs in sequence, select the first job, then press and hold the [SHIFT] key while selecting the last job. To select two or more jobs out of sequence, press and hold the [CTRL] key while selecting jobs. 3. Right-click the selection. A shortcut menu appears. From the shortcut menu, select Delete. The selected jobs are deleted from the queue. Deleting all Jobs in a Queue You can delete all of the jobs in a queue in AppXtender Queue Manager. Note: Do not attempt to purge a queue containing currently processing jobs. To delete all of the jobs in a queue: 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 Make sure that the contents of a data source are listed on the right. For instructions, see Viewing the Contents of a Data Source, page ApplicationXtender Server Monitoring Guide

43 Monitoring the ApplicationXtender Index Server 4. If the existing queues are not listed on the right, select View Queues from the View menu. 5. From the list on the right, right-click a queue name. A shortcut menu appears. From the shortcut menu, select Purge queue. A message appears, requesting confirmation. Figure 16. AppXtender Queue Manager Message: Purge Queue? 6. Click Yes. All jobs in the queue are deleted. Deleting a Queue You can delete an empty queue in AppXtender Queue Manager. Note: A queue must be empty before you can delete it. If you want to delete a full queue, you must first purge the queue, and then you may delete it using the following procedure. To delete a queue: 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 Make sure that the contents of a data source are listed on the right. For instructions, see Viewing the Contents of a Data Source, page If the existing queues are not listed on the right, select View Queues from the View menu. 5. From the list on the right, right-click a queue name. A shortcut menu appears. From the shortcut menu, select Delete. A message appears, requesting confirmation for the deletion. 6. Click Yes. The queue is removed from the list of queues. Note: If the deletion is not reflected in the list of queues on the left, select Refresh from the View menu. Monitoring AppXtender Index Server Using AppXtender Admin You can use AppXtender Admin to view information related to the operation of an AppXtender Index Server that is stored in the WMI repository on the AppXtender Index Server. ApplicationXtender Server Monitoring Guide 43

44 Monitoring the ApplicationXtender Index Server To monitor current activity on an AppXtender Index 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 Index Server. 3. To select the AppXtender Index 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 7. ApplicationXtender Index Server Status Entries Entry IndexServer ndocindexed ndocindexfailed ndococred ndococrfailed strftqueues strocrqueues Description The name of the AppXtender Index Server The number of documents successfully indexed The number of document indexing attempts that failed The number of documents successfully OCR processed The number of document OCR attempts that failed The name of the active full text queue The name of the active OCR queue Monitoring AppXtender Index Server Using AppXtender Web.NET Administrator You can track current AppXtender Index Server activity using the AppXtender Web.NET Administrator. To monitor current AppXtender Index Server activity: 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 Index Server. The ApplicationXtender Index Server Monitor appears. 44 ApplicationXtender Server Monitoring Guide

45 Monitoring the ApplicationXtender Index Server Figure 17. ApplicationXtender Index Server Monitor 3. To select the AppXtender Index 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 8. ApplicationXtender Index Server Status Entries Entry IndexServer ndocindexed ndocindexfailed ndococred ndococrfailed strftqueues strocrqueues Description The name of the AppXtender Index Server The number of documents successfully indexed The number of document indexing attempts that failed The number of documents successfully OCR processed The number of document OCR attempts that failed The name of the active full text queue The name of the active OCR queue ApplicationXtender Server Monitoring Guide 45

46 Monitoring the ApplicationXtender Index Server 46 ApplicationXtender Server Monitoring Guide

47 Chapter 5 Monitoring ApplicationXtender Reports Management Server This chapter describes how to monitor an ApplicationXtender Reports Management (AppXtender Reports Mgmt) server using various utilities: Monitoring AppXtender Reports Mgmt Server Using AppXtender Admin, page 47 Monitoring AppXtender Reports Mgmt Server Using AppXtender Admin You can use AppXtender Admin to view information related to the operation of an AppXtender Reports Mgmt server that is stored in the WMI repository on the AppXtender Reports Mgmt server. To monitor current activity on an AppXtender Reports Mgmt Server: 1. Make sure that AppXtender Reports Mgmt is configured to provide WMI data. You can configure the Report Processor, the Print Stream Processor, or both to provide WMI data, depending on what you want to monitor. For instructions, refer to the ApplicationXtender Reports Management Administrator s Guide. 2. Start AppXtender Admin. For instructions, see Starting ApplicationXtender Administrator, page In the AppXtender Admin tree, expand the Monitor node and then select AppXtender Reports Mgmt Servers. 4. To select the AppXtender Reports Mgmt Server to monitor, choose the name of the server from the Select component list or type the computer name or IP address in the text box. (To refresh the list of components to reflect newly registered components, select Refresh.) Status entries appear for the items listed in the following tables. Table 9. ApplicationXtender Reports Management Server Print Stream Processor Entries Entry GetPrintStreamProcStatus GetPrintStreamProcMessage Description Status of the Print Stream Processor. Message log of the most recent Print Stream Processor instance. ApplicationXtender Server Monitoring Guide 47

48 Monitoring ApplicationXtender Reports Management Server Entry GetPrintStreamName GetPrintStreamProcTimeStamp GetPrintStreamProcInstanceID Description Time of the last update to the Print Stream Processor instance. User-generated name of the current print stream. Unique ID of the current Print Stream Processor instance. Table 10. ApplicationXtender Reports Management Server Report Processor Class Data Property STATUS MESSAGE REPORTTYPE INSTANCEID TIMESTAMP INSTANCEID REPORTTYPE STATUS STEP PAGES INDEXRECS UPLOADRECS SOURCE SOURCELEN RESTARTS STARTTIME ENDTIME STEPTIME STEPERRORS Description Status of the most recent instance of the Report Processor. Message log of the most recent Report Processor instance. Name of the report being processed. Unique ID associated with the current instance of the Report Processor. The date and time the Report Processor started processing. Unique ID associated with the current report. Name of the report that is currently being handled by the Report Processor. Status of the report. Stage of processing, such as Extract, of the current report. Number of pages in the report. Extracted index records in the report. Uploaded index records in the report. Source file of the current report. Size (in bytes) of the source file. Number of times that the report had to restart processing. Time that the report started processing. Time that the report finished processing. Length of processing time of the current step. Number of errors in the current step. 48 ApplicationXtender Server Monitoring Guide

49 Monitoring ApplicationXtender Reports Management Server Property ERRORS PROCESSLENGTH Description Number of errors in the report. Length of time, in seconds, that it took the current report to process. ApplicationXtender Server Monitoring Guide 49

50 Monitoring ApplicationXtender Reports Management Server 50 ApplicationXtender Server Monitoring Guide

51 Chapter 6 Monitoring ApplicationXtender File Access Manager Server This chapter describes how to monitor the AppXtender File Access Manager Server using the following utility: Monitoring AppXtender File Access Manager Server Using AppXtender Admin, page 51 Monitoring AppXtender File Access Manager Server Using AppXtender Admin The AppXtender File Access Manager Server subnode of the Monitor node allows you to view current activity on the AppXtender File Access Manager Server. It also lets you start and stop the AppXtender File Access Manager service. For more information, see the following sections: Viewing Current Activity on the AppXtender File Access Manager Server, page 51 Managing the AppXtender File Access Manager Service, page 52 Viewing Current Activity on the AppXtender File Access Manager Server You can use AppXtender Admin to view information related to the operation of an AppXtender File Access Manager Server. To monitor current activity on the AppXtender File Access Manager Server: 1. Start AppXtender Admin. For instructions, see Starting ApplicationXtender Administrator, page In the AppXtender Admin tree, expand the Monitor node and then select File Access Manager Server. 3. Choose the AppXtender File Access Manager Server from the Select component list, if necessary. (To refresh the component list to reflect a newly registered component, select Refresh.) Status entries appear for the items listed in the following table. ApplicationXtender Server Monitoring Guide 51

52 Monitoring ApplicationXtender File Access Manager Server Table 11. ApplicationXtender File Access Manager Server Status Entries Entry ExpungeData GCDatabaseEvery GCHighWater GCInterval GCReduceBy GCStagingEvery Description Determines whether data is expunged from the staging path during garbage collection when documents are under retention. The number of days a job queue entry (for example, a Centera read or write request) is kept in the database before the garbage collection process removes it. The maximum disk space percentage (high water mark) to be used for staging files. Specifies how often the garbage collection process should run. The percentage by which the emergency garbage collection process reduces disk space usage when the high water mark is reached. The number of days a file is kept in the staging area (UNC path) before the garbage collection process removes it. Managing the AppXtender File Access Manager Service You can also manage the service status for the AppXtender File Access Manager Server. IMPORTANT: You must restart the AppXtender File Access Manager service after performing any of the following tasks: create, modify, or remove a data source for retention-enabled applications; or create, modify, or remove a retention-enabled application. This action is necessary to activate the change and avoid Event log errors. To manage the File Access Manager 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 File Access Manager Server. 3. Choose the AppXtender File Access Manager Server from the Select component list, if necessary. (To refresh the component list to reflect a newly registered component, select Refresh.) 4. To start the service if it is stopped, select Start. You are prompted to confirm that the service should be started; select Yes. 52 ApplicationXtender Server Monitoring Guide

53 Monitoring ApplicationXtender File Access Manager Server 5. To stop the service if it is running, click Stop. You are prompted to confirm that the service should be stopped; select Yes. ApplicationXtender Server Monitoring Guide 53

54 Monitoring ApplicationXtender File Access Manager Server 54 ApplicationXtender Server Monitoring Guide

55 Appendix A Using Audit Trails This appendix describes the Audit Trail capability: Introduction to Audit Trail, page 55 Starting an Audit Trail, page 56 Configuring Audit Trail Settings, page 57 Introduction to Audit Trail The Audit Trail capability allows you to track user activities on a global or per-application basis. Audit events, such as the creation, use, or deletion of documents, document pages, batches, queries, ODMA operations, and various AppXtender tools, can be tracked for each AppXtender application. In addition, activity related to the creation and deletion of users, groups, and applications can be tracked on a system-wide basis. Use of queues and import tools can also be tracked. The Audit Trail capability also supports compliance with the Health Insurance Portability and Accountability Act of 1996 (HIPAA). You specify which user activities you want to track using the Audit Trail tab in AppXtender AppGen. Each option on this tab represents one audit event. When a user activity triggers an audit event, details of the audit event are recorded in the location you specify. 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. You can configure global audit trail options to track the creation, deletion, and modification of applications, users, and groups. On the global Audit Trail tab, you can also enable tracking of users logging into and out of AppXtender components, and tracking of the use of import tools with AppXtender. In addition to tracking system-wide changes such as those listed above, you can use the global Audit Trail tab to configure default audit settings for user activities within AppXtender applications. When you set options globally for user activities within applications, you set audit defaults for all applications. You can then choose to either use the default settings for user activities within applications, or you can configure specific audit settings for user activities within each application on each individual ApplicationXtender Server Monitoring Guide 55

56 Using Audit Trails application s Audit Trail tab. When you enable or disable an auditing option on an individual application s Audit Trail tab, that setting overrides the global setting for that option, but only for that application. Note: Only users with the User Security Maint privilege can modify global audit trail settings. To modify each application s audit trail settings, the user must have the Modify App privilege on that application. Starting an Audit Trail The Audit Trail capability is accessed through AppXtender AppGen s tree structure. To use the Audit Trail, either globally or per-application, you must first turn on the global Audit Trail option. The default for the global Audit Trail option is off and no audit events are enabled. Once the global Audit Trail option is turned on, you can configure audit trails globally for all AppXtender applications or for each individual application, on a per-application basis. Note: If you want an audit event to be automatically written to the audit log each time a document is filed into or disposed of from Records Manager, the global Audit Trail option must be enabled. It is not necessary to check an item in the Audit Trail tree to enable these audit events. For more information, refer to the Retention Manager for ApplicationXtender Integration Guide. To enable the global Audit Trail option: 1. Start AppXtender AppGen. For instructions, refer to Starting AppXtender AppGen in the ApplicationXtender Core Components Administrator s Guide. 2. From the AppXtender AppGen tree structure, select Audit Trail. The Audit Trail tab appears. Figure 18. Audit Trail Tab with the Audit Trail Turned Off 56 ApplicationXtender Server Monitoring Guide

57 Using Audit Trails The global audit settings and command buttons become available, with the exception of the Browse button. (The Browse button becomes available if you enable logging to a file.) 3. Click within the Audit Trail check box to enable it. Figure 19. Audit Trail Tab with the Audit Trail Turned On If an application node is expanded in the tree structure, AppXtender AppGen collapses the node and adds the Audit Trail tab and node to each application in the AppXtender AppGen tree structure. Note: You can stop the auditing process at any time. To do so, disable the Audit Trail option in the global Audit Trail tab. You must have the User Security Maint privilege to disable the global Audit Trail option. Once audit trails are disabled on the global Audit Trail tab, the Audit Trail node is removed from the tree structure in all AppXtender applications. If the Reason Code option is enabled for any application, the global Audit Trail option is enabled automatically and cannot be disabled. Configuring Audit Trail Settings You can configure an audit trail two ways: globally for all AppXtender applications or individually, on a per-application basis. If you configure the audit trail settings globally, all AppXtender applications inherit the global audit trail settings as default settings. You can override global audit trail settings for a particular application on the application s Audit Trail tab by enabling audit trail options specifically for that application. However, to configure audit trail settings for a particular AppXtender application, you must first turn on the Audit Trail option on the global Audit Trail tab, and then activate the application s Audit Trail tab to configure auditing options for that specific application. ApplicationXtender Server Monitoring Guide 57

58 Using Audit Trails Note: The global Audit Trail option controls access to the per-application Audit Trail options. If the global Audit Trail is not turned on, the Audit Trail tab for each AppXtender application will not be accessible. For more information, see the following sections: Configuring the Global Audit Settings for All AppXtender Applications, page 58 Configuring the Audit Trail Settings for a Single AppXtender Application, page 63 Configuring the Global Audit Settings for All AppXtender Applications The Audit Trail capability allows you to define specific global audit settings for all AppXtender applications. You can also specify where to store the audit log (for example, database, log file, or both) for all AppXtender applications. The default is to a table in the AppXtender database. The database table name is always AE_AUDIT. If you choose to log to a file, the file name is always AxAudit.log. Note: You must have the User Security Maint privilege to modify global audit trail settings. To configure the global audit settings: 1. From the AppXtender AppGen tree structure, select Audit Trail. The global Audit Trail tab appears. The global audit settings and command buttons become available, with the exception of the Browse button. (The Browse button becomes available if you enable logging to a file.) 2. If you have not already done so, click to enable the Audit Trail check box. Figure 20. Audit Trail Tab with the Audit Trail Turned On 58 ApplicationXtender Server Monitoring Guide

59 Using Audit Trails Each option that is checked in the global Audit Trail tree is audited for all AppXtender applications (unless you choose to disable the setting on specific applications Audit Trail tabs). Any option that is not checked in the global Audit Trail tree is not audited for any AppXtender applications (unless you choose to enable the setting on specific applications Audit Trail tabs). Note: For a definition of what user activity is tracked by each of the global audit settings, see Global Audit Trail Settings for all AppXtender Applications, page Enable the options that you want to use. For instructions, see Enabling Global Audit Trail Options, page Specify at least one location to log audit events: If you want to log the audit events to the AppXtender database table, leave the Log to the database table option enabled. The database table name is always AE_AUDIT. If you want to log the audit events to a log file, enable the Log to the file located at option. The Log to the file located at text box and Browse button are enabled. Type the directory name to store the log file, or use the Browse button or drop-down arrow to locate the directory to store the audit trail. The file name is always AxAudit.log. Note: All users must have write access to the log file path. It is recommended that the path be on the network so all users have write access. Locating the log file on the database server is also recommended, because all users already have access to that server to access AppXtender. Ensure that the location of the log file is shared in a way that provides write access to all users. Note: If you set the log file write path to a local hard drive (for example, C:\Temp or C:\Log), a log file is written on each user s local machine. Note: When using AppXtender Audit Trail for AppXtender Web tracking purposes, do not enable the Log to File check box. Instead, you should enable only the Log to Database option to log AppXtender Web activity. 5. Click Apply to automatically set the global audit settings for all applications. Global Audit Trail Settings for all AppXtender Applications There are eight global audit settings: Audit Trail, Application, User, Group, Queue, Generic Import Tools, License Server, and Create/Delete/Modify Annotation Groups. Global audit trail settings are non-application specific settings you can apply to all AppXtender applications. The information logged to the audit trail log or table depends on the action being tracked. Some or all of the following items may be logged: The user ID or user name for the user performing the action The workstation ID for the workstation where the action is performed The workstation name for the workstation where the action is performed The time stamp (in GMT format) indicating the time when the action is performed The event ID or event description for the action being performed The application ID for the application where the action is performed (if applicable) The document ID for the document where the action is performed (if applicable) ApplicationXtender Server Monitoring Guide 59

60 Using Audit Trails The status description for the action being performed The module where the action takes place Figure 21. Global Audit Trail The following table describes the information that can be tracked for each global audit setting: Table 12. Global Audit Trail Settings If You Enable this Item Audit Trail Application>Create/Delete/ Modify Application>Document>Add Application>Document>Delete Application>Document>Index>Create Application>Document>Index>Delete Application>Document>Index>Modify Application>Document>Page>Add Application>Document>Page>Delete This Information Will Be Logged Tracks enabling and disabling of global audit trails and changes in audit trail settings. Tracks all creation, deletion, and modification of applications. Tracks addition of documents. Tracks deletion of documents. Tracks creation of a document index. Tracks deletion of a document index. Tracks modification of a document index. Tracks addition of a page to a document. Tracks deletion of a page from a document. 60 ApplicationXtender Server Monitoring Guide

61 Using Audit Trails If You Enable this Item Application>Document>Page>View/Print/Export/Mail Application>Document>Page>Version>Add Application>Document>Page>Version>Delete Application>Document>Page>Version>Annotate Application>Document>Page>Version>OCR/Text view Application>Batch>Create Application>Batch>Delete Application>Batch>Batch import/scan Application>Batch>index Application>Batch>Batch Page>Add Application>Batch>Batch Page>Delete Application>Batch>Batch Page>Attach to a document Application>Query>Save Application>Query>Delete Application>Query>Execute Application>Query>Modify Application>ODMA operations Application>Tools>Import utilities Application>Tools>Archive Wizard This Information Will Be Logged Tracks when a document page or document page s text view is displayed; a document page, document (all pages), or list of document pages are printed; a document page or document page s OCR text is exported; and a document page, document reference, or document (all pages) is mailed. Tracks addition of a page version. Tracks deletion of a page version. Tracks additions and modifications of annotations. Tracks the changes to OCR/Text view of a page version. Tracks creation of a batch. Tracks deletion of a batch. Depending on the event, logs user s account data, delete event, batch name, file status and index data, batch name, batch ID, and module. Tracks batch import/scan of batch open and close. Tracks indexing of a batch. Tracks addition of a batch page. Tracks deletion of a batch page. Tracks saving a batch page in a document. Tracks saving of a query. Tracks deletion of a query. Tracks execution of a query. Tracks modification of a query. Tracks execution of ODMA operations. Tracks import operations for the Index Image Import, Auto Index Import, and Key Reference Import wizards. Tracks when a document page is archived. ApplicationXtender Server Monitoring Guide 61

62 Using Audit Trails If You Enable this Item Application>Tools>Migration Wizard User>Login/Logout User>Create/Delete/ Modify Group>Create/Delete/ Modify Queue>Create/Delete Generic Import Tools License Server Create/Delete/Modify Annotation Groups This Information Will Be Logged Tracks when a document is migrated to a destination database or when a source document is deleted from the source database (that is, the Delete source document option is selected). Tracks user login/logout activity. Tracks when a new user is created, a user is deleted, or a user s settings are changed in a user s profile. Tracks when a new group is created, a group is deleted, and group settings are changed in a group profile. Tracks creation, deletion, and modification of a queue. Tracks generic bulk-load operation. Tracks all changes to the License Server settings in Application Generator. Tracks the creation, deletion, and modification of annotation groups. Note: The following retention-related actions are always tracked: filing a document for retention, placing a retention hold on a document, removing a retention hold, and deleting an expired document under retention. Enabling Global Audit Trail Options You can use two methods to enable options on the Audit Trail tree. Enable individual options as needed by selecting each option that you would like to enable in the Audit Trail tree. Selecting a disabled (blank) option enables it; selecting an enabled (checked) option disables it. Use the command buttons to the right of the Audit Trail tree to quickly enable or disable auditing of actions in all AppXtender applications. The following table describes the command buttons: Table 13. Global Audit Buttons for Configuring All Applications Button Set Default Description When selected, the following settings are enabled: Application>Create/Delete/Modify Document>Delete Index>Delete Page>Delete 62 ApplicationXtender Server Monitoring Guide

63 Using Audit Trails Button Description Version>Delete Version>Annotate Batch>Delete Batch>Batch import/scan Batch>Batch index Batch Page>Delete Query>Save Query>Delete User>Create/Delete/Modify Clear All Select All Group>Create/Delete/Modify Disables any enabled audit event settings. Enables all audit event settings. Configuring the Audit Trail Settings for a Single AppXtender Application The Audit Trail capability allows you to define specific audit settings for each individual AppXtender application. You can also specify the log device to store the audit log (for example, database, log file, or both) on an application-by-application basis. The database table name is always AE_AUDIT and the file name is always AxAudit.log. Note: To modify an application s audit trail settings, you must have the Modify App privilege on that application. To configure audit trail settings for an individual AppXtender application: 1. From the Applications tree, select an application and then Audit Trail. The Audit Trail tab for the application appears. Note: The global Audit Trail option controls access to the per-application Audit Trail options. If the global Audit Trail is not turned on, the Audit Trail tab for each AppXtender application does not appear. ApplicationXtender Server Monitoring Guide 63

64 Using Audit Trails Figure 22. Application Audit Trail Tab Note: For a complete explanation of the application audit settings, see Audit Settings for an AppXtender Application, page Enable the options that you want to use. For instructions, see Enabling Audit Trail Options for an Application, page Specify at least one location to log audit events: If you want to log the audit events to an AppXtender database table, enable the Log to the database table option. The database table name is always AE_AUDIT. If you want to log the audit events to a log file, enable the Log to the file located at option. The Log to the file located text box and Browse button are enabled. Type the directory name to store the log file, or use the Browse button or drop-down arrow to locate the directory to store the audit trail. The file name is always AxAudit.log. Note: All users who are using the application must have write access to the log file path. It is recommended that the path be on the network so all users have access. Locating the log file on the database server is recommended, because all users already have access to that server to access AppXtender. Be sure that the location of the log file is shared in a way that provides write access to all users. Note: If you set the log file write path to a local hard drive (for example, C:\Temp or C:\Log), a log file is written on each user s local machine. 4. Click Apply to automatically set the audit settings for the indicated application. Audit Settings for an AppXtender Application You can configure the audit settings for the document, index, page, batch, batch page, query, ODMA operations, and tools on a per-application basis. 64 ApplicationXtender Server Monitoring Guide

65 Using Audit Trails Figure 23. Audit Trail Tab for an AppXtender Application The information logged to the audit trail log or table depends on the action being tracked. Some or all of the following items may be logged: The user ID or user name for the user performing the action (If the data source is using Windows security provider, the user domain is also tracked. If the data source is using a directory service security provider, the "Name Attribute" name is tracked.) The workstation ID for the workstation where the action is performed The workstation name for the workstation where the action is performed The time stamp (in GMT format) indicating the time when the action is performed The event ID or event description for the action being performed The application ID for the application where the action is performed (if applicable) The document ID for the document where the action is performed (if applicable) The status description for the action being performed The module where the action takes place The following table describes the information that can be tracked for a specified AppXtender application: Table 14. Per-Application Audit Trail Settings If You Enable this Item Audit Trail Document>Add Document>Delete This Information Will Be Logged Changes in audit trail settings Addition of documents Deletion of documents ApplicationXtender Server Monitoring Guide 65

66 Using Audit Trails If You Enable this Item Document>Page>Add Document>Index>Create Document>Index>Delete Document>Index>Modify Document>Page>Delete Document>Page>View/ Print/Export/ Mail Document>Page>Version>Add Document>Page>Version>Delete Document>Page>Version>Annotate Document>Page>Version>OCR/Text view Batch>Create Batch>Delete Batch>Batch import/scan Batch>index Batch>Batch Page>Add Batch>Batch Page>Delete Batch>Batch Page>Attach to a document Query>Save Query>Delete Query>Execute Query>Modify ODMA operations Tools>Import utilities This Information Will Be Logged Creation of a document index Deletion of a document index Modification of a document index Addition of a page to a document Deletion of a page from a document When a document page (and/or full-text and OCR information) is displayed, printed, exported, or sent by Addition of a page version Deletion of a page version Addition and modification of annotations Changes to OCR/Text View of a page version Creation of a batch Deletion of a batch Importing/scanning of batch Indexing of a batch Addition of a batch page Deletion of a batch page Attaching of a document to a batch page Saving of a query Deletion of a query Execution of a query Modification of a query Execution of ODMA operations Import operations for the Index Image Import, Auto Index Import, and Key Reference Import wizards 66 ApplicationXtender Server Monitoring Guide

67 Using Audit Trails If You Enable this Item Tools>Archive Wizard Tools>Migration Wizard This Information Will Be Logged Archival of a document page version Movement or deletion of documents in AppXtender data sources Note: The following retention-related actions are always tracked: filing a document for retention, placing a retention hold on a document, removing a retention hold, and deleting an expired document under retention. Enabling Audit Trail Options for an Application When you open an application s Audit Trail tab for the first time, the check box next to each option is dimmed. This is because application audit trail profiles inherit the global audit trail settings by default. A dimmed option, whether checked or unchecked, inherits the audit setting for that option in the global Audit Trail tab. Options that are enabled based on global settings are checked and dimmed on the Audit Trail tab of each application. Options that are disabled based on global settings are dimmed on the Audit Trail tab of each application. When a global audit trail setting is modified on the global Audit Trail tab, the modification is reflected in the audit trail configuration for any application that has that option dimmed on the application s Audit Trail tab. If necessary, you can override the global audit setting for an option for an individual application. The following table explains how the appearance of each option s check box corresponds to the status of the option: Table 15. Check Box Appearance in Application Audit Trail Tabs This Appearance Indicates this Option Status This option is not audited for the application, regardless of the global audit trail setting for the option. This option is audited for the application, regardless of the global audit trail setting for the option. This option is not audited for the application based on the global audit trail setting for the option. If the option is enabled in the global audit trail settings, the option is automatically enabled here as well. This option is audited for the application based on the global audit trail setting for the option. If the option is disabled in the global audit trail settings, the option is automatically disabled here as well. ApplicationXtender Server Monitoring Guide 67

68 Using Audit Trails You can use several methods to enable options on the Audit Trail tree. Enable individual options as needed by selecting each option that you would like to enable in the Audit Trail tree. Selecting a dimmed option (whether checked or unchecked) disables it and causes it to no longer inherit global audit trail settings (the check box is unchecked and clear); Selecting a locally disabled (unchecked and clear) option enables it, but does not cause it to inherit global audit trail settings (the check box is checked and clear); Selecting a locally enabled (checked) option causes it to inherit global audit trail settings (the check box is dimmed and checked or unchecked depending on the global audit trail settings for that option clear). Use the command buttons to the right of the Audit Trail tree to quickly enable or disable auditing of actions in all AppXtender applications. The following table describes the command buttons: Table 16. Audit Buttons for Configuring an Application Button Set Default Clear All Select All Legend Description Click this button to set the audit trail settings for the application to match the default settings defined in the global Audit Trail tab. When an application s audit trail settings are configured to match the global audit settings, whenever an option is enabled or disabled in the global audit trail settings, the change is reflected in the application s audit trail settings. When you first open an application s Audit Trail tab, all options are set to match the global audit trail settings. Click this button to disable all audit trail options for an application. Note that when you use this button to clear all options, you remove the connection between the settings for this application and the global audit trail settings. Click this button to enable all audit trail options for an application. Note that when you use this button to enable all options, you remove the connection between the settings for this application and the global audit trail settings. Click this button to display a legend that explains how the appearance of each check box corresponds to the option status. The Audit Trail Settings Legend dialog box appears. 68 ApplicationXtender Server Monitoring Guide

69 Using Audit Trails Figure 24. Audit Trail Settings Legend Dialog Box ApplicationXtender Server Monitoring Guide 69

70 Using Audit Trails 70 ApplicationXtender Server Monitoring Guide

71 Glossary This glossary contains terms related to ApplicationXtender (AppXtender) components. Many of these terms are used in this manual. accessible security Accessible security grants access to the users in the group for only documents with index field values matching the secured value list. (See also Document Level Security.) annotation An annotation is a note or a shape added to a document or batch page, typically to focus attention on a particular part of the page. Users can use annotations to comment on the contents of a page, block areas of the page from view, or highlight important information. When a user creates an annotation, it is associated with the AppXtender page on which he or she created it. Annotations are edited and stored separately from the image, but they are displayed along with the image in ApplicationXtender Document Manager and Web Access. The types of annotations available include text, highlighting, lines, arrows, shapes, and rubber stamps. annotation group Annotation groups allow you to create associations between users, groups, and specific annotations. You can specify which users and groups can view or modify specific annotations, and which users and groups can hide or modify specific redactions. appender An appender allows you to select the specific ApplicationXtender Web Access.NET or Rendering Server information you want to log and to publish that information to a specific reporting venue. application An AppXtender application is an index-driven data storage structure where documents can be stored and retrieved. An AppXtender application is based on an index that is composed of one or many fields. AppXtender applications are created in ApplicationXtender Application Generator (AppXtender AppGen). application security profile Application security profiles, like global security profiles, allow you to grant a particular set of privileges to a user or group of users. You can define different privileges for a user or group of users in each application. When a profile is application-specific, however, the privilege settings are not carried over to a new application when it is created. If a group of users has an application-specific profile for a certain application, but no global profile, then when a new application is created, the ApplicationXtender Server Monitoring Guide 71

72 Glossary members of the group will not be able to access the new application. Application-specific security settings override global security settings. ApplicationXtender Auto Index Import AppXtender Auto Index Import allows use of the <F7> key to import index values from a text file, so users adding documents can automatically populate indexes using the imported data. Auto Index is ideal for the import of index records that are applicable to only one document. In an Auto Index Import table, once a record (or a group of index values) has been used to index a document, the record is deleted. ApplicationXtender Index Image Import AppXtender Index Image Import allows you to import index data and document files in a single step. A text file is required which contains a line of text for each document to be imported, with a value for each index field and a reference to the location of the file to be imported. No manual document indexing is required. ApplicationXtender Index Server ApplicationXtender Index Server is an optional module that adds full-text indexing and OCR functionality to AppXtender systems. ApplicationXtender Key Reference Import AppXtender Key Reference Import allows use of the <Tab> key to import index values from a text file. Key Reference is most effectively used in situations where each imported record may describe several documents. Key Reference Import maintains the index records in the Key Reference table even after records have been used to index documents. Any change made to a record in the Key Reference table is reflected in the indexes of all documents described by that record. audit trail The Audit Trails feature allows you to track user activity within the AppXtender system. System-wide activities such as the creation, modification, and deletion of applications, users, and groups can be tracked. You can also track user activity in applications by tracking items such as the creation and deletion of documents, the addition of pages, and the modification of index information for documents. By default, AppXtender logs audit trail events to a table in the AppXtender database. You can configure audit trails to log to this table, to a log file, or to both locations. authentication Authentication requires all users to enter a valid user name and password to access software modules. Authentication ensures that each user is who he or she claims to be. authorization Authorization is the granting of specific access privileges according to the user name. Security profiles contain information pertaining to a user s specific privileges within the AppXtender system. check in/check out mode When an AppXtender application or an AppXtender Document Manager workstation is in check in/check out mode, use of revision control with AppXtender documents is mandatory. 72 ApplicationXtender Server Monitoring Guide

73 Glossary Users must check out a document in order to modify it. If they do not check the document out, it is opened in read-only mode and it cannot be modified. COLD COLD (computer output to laser disk) data is report data generated for existing applications. COLD data can be added to AppXtender as documents through the use of ApplicationXtender Reports Management (AppXtender Reports Mgmt). collection A collection is a K2 full-text database. data source A data source is the means by which AppXtender accesses data from a database. When a data source is defined, an OLE DB data provider is configured to access the database. All of these characteristics in combination where the data is stored, the format of the data stored, and the data provider used to access the data comprise the data source. data source group A data source group in ApplicationXtender Administrator (AppXtender Admin) associates a list of data sources with everything that has been configured in AppXtender Admin, such as ApplicationXtender Web Access (AppXtender Web) settings and connections to License Server computers. This feature provides convenience in that the work of configuration does not have to be repeated every time you create a data source. database A database is a collection of data tables of a particular database format (such as Oracle or Microsoft SQL Server). AppXtender uses databases to store application information. When an application is created, details such as the field definitions and security information are stored in database tables. Once documents are added to an application, index information is stored in a table, as are the pointers to the location of the documents. document A document is a page or group of pages stored in an application and identified by index information. Each page of a document is comprised of a single object such as a scanned image file or a word processing document. To create a new document, users add an object to an application and attach index information to it. Subsequent objects can be added as additional pages of the same document. Document Level Security Document Level Security (DLS) pinpoints user access within an AppXtender application. With DLS, you can deny a group of users access to any classified or sensitive document(s), without restricting access to other documents in the application. DLS can also be configured to grant a group of users access to only a specific set of documents in an application. ERM ERM (enterprise report management) data is report data generated for existing applications. ERM data can be added to AppXtender as documents through the use of ApplicationXtender Reports Management (AppXtender Reports Mgmt). ApplicationXtender Server Monitoring Guide 73

74 Glossary extended applications Extended applications are AppXtender applications that can be called from within other software applications, adding document storage and processing functions. full-text Users can index documents for full-text searching by submitting them to the AppXtender Index Server. With a full-text search, users can find documents even if they do not know any of the index values. Users can also use full-text searching to refine an index value search. global security profile Global security profiles can be established to automatically assign a uniform set of access privileges for a user or group of users every time a new application is created. When a global profile exists for a user or group of users, the privileges assigned in that profile are automatically assigned for every application created. If a user or group of users does not have a global profile, an application-specific profile must be created for that user or group before they can access an application. grab bar An AppXtender Document Manager docked view has a grab bar. A grab bar is similar to a title bar except that it does not contain a title. impersonation account The AppXtender Index Server impersonation account grants security privileges to AppXtender Index Server and is essential for the AppXtender Index Server to operate properly. AppXtender Index Server uses the AppXtender Index Server impersonation account to access remote and server resources, including AppXtender document paths, the License Server, the registry, and the image repository (in some cases, the DiskXtender Document Server). import specification A specification is a set of rules that AppXtender follows when importing data from an import file using the AppXtender Auto Index Import, Index Image Import, or Key Reference Import wizard. inaccessible security Inaccessible security denies access to the users in the group for documents with index field values matching the secured value list. (See also Document Level Security.) index node An AppXtender index contains a group of fields where descriptive information pertaining to documents can be stored. This group of field definitions is used by AppXtender when storing index information within an application. A node is an element of a tree structure such as in AppXtender Admin, AppGen, Document Manager, or Reports Mgmt. A node can be expanded to reveal subnodes or can be collapsed. 74 ApplicationXtender Server Monitoring Guide

75 Glossary OCR Users can process bi-tonal images using optical character recognition (OCR). This process converts an image of text into text. After a user processes an image using OCR, it can then be submitted to the AppXtender Index Server for full-text searching. ODMA Open Document Management API (ODMA) support allows users to work with AppXtender documents within other ODMA-compliant applications. OLE DB OLE DB is a programming interface for accessing data, and is a fundamental building block for storing and retrieving data using Microsoft s Data Access Components (MDAC). OLE DB provides flexible data architecture that offers applications like AppXtender efficient access to databases. Data is accessed through OLE DB data providers page The word Page typically implies a single entity. Since AppXtender supports multiple object types, the term page is redefined within AppXtender to mean a single object. A very long word processing file is considered a page to AppXtender. A page could also be, for example, a single scanned image, a 30-minute video clip, or an audio recording. Each page of a document has the same index record attached. privileges Privileges govern the ability of a user or group of users to access functions in AppXtender. redaction A redaction is a filled and opaque annotation shape that can be used to secure or hide portions of image and text pages. Users can apply redaction to all available annotations. When applied, the area of the page behind the redaction is not visible. security Security is the combination of authentication and authorization. security mapping When AppXtender Migration is used to migrate documents and security information, the administrator has the option to map users and groups in the source database to users and groups in the destination database. Similarly, when the ApplicationXtender Media Distribution (AppXtender Distribution) Extraction Wizard is used to extract AppXtender documents and security information before the creation of an AppXtender Distribution CD-ROM, the administrator has the option to map users and groups in the source database to users and groups in the database on the CD-ROM (or in the database where the CD-ROM will be reintegrated). security provider Security providers implement authentication, which requires all users to enter a valid user name and password to access most modules. AppXtender Admin offers two pre-packaged security providers (CM and Windows) to ensure that each user is who he or she claims to be. You can also create a directory service security provider, if necessary. ApplicationXtender Server Monitoring Guide 75

76 Glossary write paths Write paths are used to instruct AppXtender where to store documents, annotations, OCR output, and the ProIndex full-text database for a particular AppXtender application. 76 ApplicationXtender Server Monitoring Guide

77 Index A AE_AUDIT table, 23, 55, 58 to 59, 63 to 64 AppXtender File Access Manager Server, monitoring, 51 AppXtender Index Server monitor jobs in all queues, 32 jobs on one queue, 31 keep on top, 34 AppXtender Index Server Monitor log file viewing, 33 AppXtender Index Server, monitoring, 43 AppXtender Queue Manager, starting, 35 AppXtender Rendering Server, monitoring, 25, 51 AppXtender Reports Mgmt Server, monitoring, 47 AppXtender Web Access Server, monitoring, 17 audit trail, 23, 55 configuring global settings, 58 configuring settings, 57 configuring settings for one application, 63 disable all settings, 68 enable all settings, 68 global settings, 59 legend for settings, 68 set all settings as default, 68 settings for one application, 64 starting, 56 authentication monitoring AppXtender Web Access, 17 AxAudit.log, 23, 55, 58 to 59, 63 to 64 C configuring audit trail settings, 57 audit trail settings, global, 58 audit trail settings, single application, 63 creating new queue, 37 D data source logging in to, 36 selecting on login, 14 delete job, 42 all, 42 queue, 43 E elements job, view, 41 F File Access Manager Server, monitoring, 51 G global audit trail settings, 58 GMT format, 23, 55 J job delete, 42 delete all, 42 in a queue, view, 38 resubmit, 42 view elements, 41 properties of, 40 ApplicationXtender Server Monitoring Guide 77

78 Index L log file AppXtender Index Server Monitor, 33 audit trail events, 23, 55, 58 to 59, 63 to 64 login into data sources, 36 M Modify App privilege, 56 monitor jobs in all queues, 32 jobs on one queue, 31 keep on top, 34 monitoring, 12 AppXtender File Access Manager Server, 51 AppXtender Index Server, 43 AppXtender Rendering Server, 25 AppXtender Reports Mgmt Server, 47 AppXtender Web Access Server, 17 N new create queue, 37 P privileges required for audit trail settings, 56 properties job, view, 40 queue, 38 view, 38 Q queue create new, 37 delete, 43 R unlock, 39 view jobs in, 38 properties, 38 remove job, 42 all, 42 queue, 43 resubmit job, 42 S selecting a data source on AppXtender Web Access login, 14 starting AppXtender Queue Manager, 35 summary of chapters, 8 T time stamp format, 23, 55 U unlock queue, 39 User Security Maint privilege, 56 V view elements of a job, 41 jobs in a queue, 38 properties of a job, 40 viewing AppXtender Index Server Monitor log file, ApplicationXtender Server Monitoring Guide