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.
Preface
...
7Chapter 1 Accessing Utilities for AppXtender Server Monitors
...
11Introduction to Utilities for Monitoring Servers
...
11Starting ApplicationXtender Administrator
...
11Information about Logging into AppXtender Admin
...
12Monitoring Components
...
12Viewing Registered Components
...
12Unregistering a Registered Component
...
13Accessing the ApplicationXtender Web Access .NET Administrator
...
13Chapter 2 Monitoring the ApplicationXtender Web Access Server
...
17Monitoring AppXtender Web Server Using AppXtender Admin
...
17Monitoring AppXtender Web.NET Server Using AppXtender Web.NET Administrator
...
20Monitoring AppXtender Web Server Using Audit Trail
...
23Chapter 3 Monitoring ApplicationXtender Rendering Server
...
25Monitoring AppXtender Rendering Server Using AppXtender Admin
...
25Viewing Current Activity on the AppXtender Rendering Server
...
25Managing the AppXtender Rendering Server Service
...
26Monitoring AppXtender Rendering Server Using AppXtender Web.NET Administrator
...
27Monitoring AppXtender Rendering Server Using WMI
...
28Chapter 4 Monitoring the ApplicationXtender Index Server
...
31Monitoring AppXtender Index Server Using the AppXtender Index Server Monitor
...
31Monitoring Jobs on One Queue
...
31Monitoring Jobs on All Queues
...
32Viewing the Log File
...
33Keeping the AppXtender Index Server Monitor on Top
...
34Monitoring AppXtender Index Server Using AppXtender Queue Manager
...
34Starting AppXtender Queue Manager
...
35Logging into Data Sources
...
36Viewing the Contents of a Data Source
...
36Creating a New Queue
...
37Viewing the Properties of a Queue
...
38Viewing Jobs in a Queue
...
38Unlocking a Queue
...
39Viewing the Properties of a Job
...
40Viewing Elements of a Job
...
41Deleting Jobs
...
42Deleting all Jobs in a Queue
...
42Deleting a Queue
...
43Monitoring AppXtender Index Server Using AppXtender Admin
...
43Monitoring AppXtender Index Server Using AppXtender Web.NET Administrator
...
44Chapter 5 Monitoring ApplicationXtender Reports Management Server
...
47Monitoring AppXtender Reports Mgmt Server Using AppXtender Admin
...
47Chapter 6 Monitoring ApplicationXtender File Access Manager Server
...
51Monitoring AppXtender File Access Manager Server Using AppXtender Admin
...
51Viewing Current Activity on the AppXtender File Access Manager Server
...
51Managing the AppXtender File Access Manager Service
...
52Appendix A Using Audit Trails
...
55Introduction to Audit Trail
...
55Starting an Audit Trail
...
56Configuring Audit Trail Settings
...
57Configuring the Global Audit Settings for All AppXtender Applications
...
58Global Audit Trail Settings for all AppXtender Applications
...
59Enabling Global Audit Trail Options
...
62Configuring the Audit Trail Settings for a Single AppXtender Application
...
63Audit Settings for an AppXtender Application
...
64Enabling Audit Trail Options for an Application
...
67Figure 1. AppXtender Web.NET Login Page
...
14Figure 2. ApplicationXtender Web Access .NET Monitor
...
20Figure 3. ApplicationXtender Rendering Server Monitor
...
27Figure 4. AppXtender Index Server Monitor: Jobs Tab
...
32Figure 5. AppXtender Index Server Monitor: Jobs Tab: All Queues
...
33Figure 6. AppXtender Index Server Monitor: Log Tab
...
34Figure 7. AppXtender Queue Manager
...
35Figure 8. AppXtender Queue Manager Listing Contents
...
36Figure 9. New Queue Dialog Box
...
37Figure 10. AppXtender Queue Manager: Properties Dialog Box: Queue
...
38Figure 11. Viewing Queues
...
39Figure 12. Viewing Jobs
...
39Figure 13. AppXtender Queue Manager Message: Unlock Queue?
...
40Figure 14. AppXtender Queue Manager: Properties Dialog Box: Job
...
41Figure 15. Elements of a Job
...
41Figure 16. AppXtender Queue Manager Message: Purge Queue?
...
43Figure 17. ApplicationXtender Index Server Monitor
...
45Figure 18. Audit Trail Tab with the Audit Trail Turned Off
...
56Figure 19. Audit Trail Tab with the Audit Trail Turned On
...
57Figure 20. Audit Trail Tab with the Audit Trail Turned On
...
58Figure 21. Global Audit Trail
...
60Figure 22. Application Audit Trail Tab
...
64Figure 23. Audit Trail Tab for an AppXtender Application
...
65List of Tables
Table 1. ApplicationXtender Web Access Server Status Entries
...
17Table 2. ApplicationXtender Web Access .NET Server Status Entries
...
20Table 3. ApplicationXtender Rendering Server Status Entries
...
26Table 4. ApplicationXtender Rendering Server Status Entries
...
28Table 5. WMI WxRS Class Format
...
29Table 6. WMI WxRSControl Class Format
...
29Table 7. ApplicationXtender Index Server Status Entries
...
44Table 8. ApplicationXtender Index Server Status Entries
...
45Table 9. ApplicationXtender Reports Management Server Print Stream Processor Entries
...
47Table 10. ApplicationXtender Reports Management Server Report Processor Class Data
...
48Table 11. ApplicationXtender File Access Manager Server Status Entries
...
52Table 12. Global Audit Trail Settings
...
60Table 13. Global Audit Buttons for Configuring All Applications
...
62Table 14. Per-Application Audit Trail Settings
...
65Table 15. Check Box Appearance in Application Audit Trail Tabs
...
67This 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 athttp://Powerlink.EMC.com. 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 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
www.adobe.com. 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
http://Powerlink.EMC.com.
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 Description
Chapter 1, Accessing Utilities for AppXtender Server Monitors
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.
Chapter 2, Monitoring the ApplicationXtender Web Access Server
This chapter describes how to monitor an ApplicationXtender Web Access server using ApplicationXtender Administrator, ApplicationXtender Web Access Administrator, WMI, and Audit Trail.
Chapter 3, Monitoring ApplicationXtender Rendering Server
This chapter describes how to monitor an ApplicationXtender Rendering Server using the ApplicationXtender Administrator, ApplicationXtender Web Access Administrator, and WMI.
Chapter 4, Monitoring the ApplicationXtender Index Server
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.
Chapter 5, Monitoring ApplicationXtender Reports Management Server
Chapter 6, Monitoring ApplicationXtender File Access Manager Server
This chapter describes how to monitor an ApplicationXtender File Access Manager Server using ApplicationXtender Administrator.
Appendix A, Using Audit Trails
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 toChapter 2, Monitoring the ApplicationXtender Web Access ServerandChapter 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, seeInformation about Logging into AppXtender Admin, page 12.
4. Click Login. AppXtender Admin appears. For instructions on viewing or unregistering components within AppXtender Admin, seeMonitoring 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
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:
http://<Server>/<alias>/login.aspx
• 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
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.
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 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, seeStarting ApplicationXtender Administrator, page 11.
2. 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 Description
Anonymous Requests Number of requests utilizing anonymous authentication
Entry Description
Cache API Entries Total number of entries within the cache added by the user
Cache API Hit Ratio Ratio of hits called from user code Cache API Hit Ratio Base Cache API Hit Ratio Base
Cache API Hits Number of hits from user code
Cache API Misses Number of cache misses called from user code Cache API Turnover Rate Number of additions and removals to the API
cache per second
Cache Total Entries Total number of entries within the cache (both internal and user added)
Cache Total Hit Ratio Ratio of hits from all cache calls Cache Total Hit Ratio Base Cache Total Hit Ratio Base
Cache Total Hits Total number of hits from the cache Cache Total Misses Total number of cache misses
Cache Total Turnover Rate Number of additions to and removals from the total cache per second
Compilations Total Number of .asax, .ascx, .ashx, .asmx, or .aspx source files dynamically compiled
Debugging Requests Number of debugging requests processed Errors During
Compilation
Number of errors that have occurred during compilation
Errors During Execution Number of errors that have occurred during the processing of a request
Errors During Preprocessing
Number of errors that have occurred during parsing and configuration
Errors Total Total number of errors that occurred Errors Total/Sec Rate of error occurrence
Errors Unhandled During Execution
Number of errors not handled by user code, but by the default error handler
Errors Unhandled During Execution/Sec
Rate of unhandled errors
Output Cache Entries Current number of entries in the output cache Output Cache Hit Ratio Ratio of hits to requests for output cacheable
requests Output Cache Hit Ratio
Base
Output Cache Hit Ratio Base
Output Cache Misses Total number of output cacheable requests not served from the output cache
Output Cache Turnover Rate
Number of additions to and removals from the output cache per second
Pipeline Instance Count Number of active pipeline instances Request Bytes In Total The total size, in bytes, of all requests
Request Bytes Out Total The total size, in bytes, of responses sent to a client. This does not include standard HTTP response headers.
Requests Executing The number of requests currently executing Requests Failed Total number of failed requests
Requests In Application Queue
The number of request in the application request queue
Requests Not Authorized The number of requests failed due to unauthorized access
Requests Not Found The number of requests for resources that were not found
Requests Succeeded The number of requests that executed successfully Requests Timed Out The number of requests that timed out
Requests Total The total number of requests since the application was started
Requests/Sec The number of requests executed per second Session SQL Server
connections total
The total number of connections to the SQL Server used by session state
Session State Server connections total
The total number of connections to the State Server used by session state
Sessions Abandoned The number of sessions that have been explicitly abandoned
Sessions Active The number of sessions currently active Sessions Timed Out The number of sessions timed out
Sessions Total Total number of sessions since the application was started
Transactions Aborted The number of transactions aborted Transactions Committed The number of transactions committed Transactions Pending The number of transactions in progress Transactions Total The total number of transactions since the
application was started
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, seeAccessing the ApplicationXtender Web Access .NET Administrator, page 13.
2. 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 Description
Anonymous Requests Number of requests using anonymous authentication Anonymous Requests/Sec Number of requests per second using anonymous
Cache Total Entries Total number of entries within the cache (both internal and user added)
Cache Total Entries Cache Total Entries
Cache Total Hits Total number of hits from the cache Cache Total Misses Total number of cache misses Cache Total Hit Ratio Ratio of hits from all cache calls Cache Total Hit Ratio Base Cache Total Hit Ratio Base
Cache API Entries Total number of entries within the cache added by the user
Cache API Turnover Rate Number of additions and removals to the API cache per second
Cache API Hits Number of hits from user code
Cache API Misses Number of cache misses called from user code Cache API Hit Ratio Ratio of hits called from user code
Cache API Hit Ratio Base Cache API Hit Ratio Base
Output Cache Entries Current number of entries in the output cache Output Cache Turnover
Rate
Number of additions to and removals from the output cache per second
Output Cache Hits Total number of output cacheable requests served from the output cache
Output Cache Misses Total number of output cacheable requests not served from the output cache
Output Cache Hit Ratio Ratio of hits to requests for output cacheable requests Output Cache Hit Ratio
Base
The base used to determine the output cache hit ratio
Compilations Total Number of .asax, .ascx, .ashx, .asmx, or .aspx source files dynamically compiled
Debugging Requests Number of debugging requests processed Errors During
Preprocessing
Number of errors that have occurred during parsing and configuration
Errors During Compilation
Number of errors that have occurred during compilation
Errors During Execution Number of errors that have occurred during the processing of a request
Errors Unhandled During Execution
Number of errors not handled by user code, but by the default error handler
Errors Unhandled During Execution/Sec
Rate of unhandled errors
Entry Description
Errors Total/Sec Rate of error occurrence
Pipeline Instance Count Number of active pipeline instances Request Bytes In Total The total size, in bytes, of all requests
Request Bytes Out Total The total size, in bytes, of responses sent to a client. This does not include standard HTTP response headers.
Requests Executing The number of requests currently executing Requests Failed Total number of failed requests
Requests In Application Queue
The number of requests in the application request queue
Requests Not Authorized The number of requests failed due to unauthorized access
Requests Not Found The number of requests for resources that were not found
Requests Succeeded The number of requests that executed successfully Requests Timed Out The number of requests that timed out
Requests Total The total number of requests since the application was started
Requests/Sec The number of requests executed per second
Cache Total Turnover Rate Number of additions to and removals from the total cache per second
Output Cache Entries Current number of entries in the output cache Output Cache Hit Ratio Ratio of hits to requests for output cacheable requests Output Cache Hit Ratio
Base
Output Cache Hit Ratio Base
Output Cache Hits Total number of output cacheable requests served from the output cache
Output Cache Misses Total number of output cacheable requests not served from the output cache
Output Cache Turnover Rate
Number of additions to and removals from the output cache per second
Session SQL Server connections total
The total number of connections to the SQL Server used by session state
Session State Server connections total
The total number of connections to the State Server used by session state
Sessions Abandoned The number of sessions that have been explicitly abandoned
Sessions Total Total number of sessions since the application was started
Transactions Aborted The number of transactions aborted Transactions Committed The number of transactions committed Transactions Pending The number of transactions in progress
Transactions Total The total number of transactions since the application was started
Transactions/Sec 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
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
Monitoring ApplicationXtender
Rendering Server
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, seeStarting ApplicationXtender Administrator, page 11.
2. In the AppXtender Admin tree, expand the Monitor node and then select AppXtender Rendering Server.
Status entries appear for the items listed in the following table.
Table 3. ApplicationXtender Rendering Server Status Entries
Entry Description
ConfigurationTimestamp The timestamp for the session when the
AppXtender Rendering Server configuration was last modified.
CurrentConversions The total number of conversions occurring at the time of monitoring.
DiskFullPercent The percentage of the AppXtender Rendering Server cache disk used at the time of monitoring. LastGCCount The total number of items removed from cache
when the last garbage collection occurred. LastGCSizeMB The total number of megabytes of items removed
from cache when the last garbage collection occurred.
ServerStatus The status of the AppXtender Rendering Server service at the time of monitoring.
StartTime The time that the AppXtender Rendering Server service was last started.
StopTime The time that the AppXtender Rendering Server service was last started.
TotalEntries The total number of items rendered by the AppXtender Rendering Server.
TotalForeignFiles The total number of foreign files rendered by the AppXtender Rendering Server.
TotalImageFiles 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, seeStarting ApplicationXtender Administrator, page 11.
2. In the AppXtender Admin tree, expand the Monitor node and then select AppXtender Rendering Server.
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, seeAccessing the ApplicationXtender Web Access .NET Administrator, page 13.
2. In the Admin window, select View> Monitor ApplicationXtender Rendering Server. The ApplicationXtender Rendering Server Monitor appears.
Figure 3. ApplicationXtender Rendering Server Monitor
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 Description
ConfigurationTimestamp The timestamp for the session when the
AppXtender Rendering Server configuration was last modified
CurrentConversions The total number of conversions occurring at the time of monitoring
DiskFullPercent The used percentage of the AppXtender Rendering Server cache disk at the time of monitoring
LastGCCount The total number of items removed from cache when the last garbage collection occurred
LastGCSizeMB The total number of megabytes of items removed from cache when the last garbage collection occurred
ServerStatus The status of the AppXtender Rendering Server service at the time of monitoring
StartTime The time that the AppXtender Rendering Server service was last started
StopTime The time that the AppXtender Rendering Server service was last started
TotalEntries The total number of items rendered by the AppXtender Rendering Server
TotalForeignFiles The total number of foreign files rendered by the AppXtender Rendering Server
TotalImageFiles The total number of images rendered by the AppXtender Rendering Server
Monitoring AppXtender Rendering Server
Using 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 Description
WorkstationName Name of workstation
ConfigurationTimes-tamp
Time of last configuration
UpdateTime Time of last update
StartTime Time AppXtender Rendering Server was started StopTime Time AppXtender Rendering Server was stopped ServerStatus Current status of AppXtender Rendering Server (e.g.,
running, suspended, stopped) TotalImageFiles Total number of image files rendered TotalForeignFiles Total number of foreign files rendered TotalPDFFiles Total number of PDF files rendered TotalThumbnails Total number of thumbnails rendered TotalEntries Total number of entries
TotalSize Total size in megabytes
CurrentConversions Number of current file conversions LastGCTime Time of last garbage collection LastGCCount Count of last garbage collection
LastGCSizeMB Size of last garbage collection in megabytes DiskFullPercent Cache disk full percentage
Table 6. WMI WxRSControl Class Format
Property Description
WorkstationName Name of workstation
ClearCacheRequest When set to 1, the cache clears
Property Description
GarbageCollectionFileSetSize Current file size set for garbage collection
GarbageCollectionReduction-Percent
Current garbage collection reduction percentage
GarbageCollectionFrequency Frequency of garbage collection in seconds MaximumCacheEntries Maximum number of cache entries
MaximumCacheKilobytes Maximum cache size in kilobytes
QueuePollingInterval Interval for polling queues in milliseconds LoggingEnabled When set to 1, the AppXtender Rendering
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, seeKeeping 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.
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.
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.
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.
• 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
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, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36. 3. 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
You can create a new queue in AppXtender Queue Manager.
To create a new queue:
1. Start AppXtender Queue Manager. For instructions, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36.
3. Make sure that the contents of a data source are listed on the right. For instructions, seeViewing the Contents of a Data Source, page 36.
4. 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
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, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36.
3. Make sure that the contents of a data source are listed on the right. For instructions, seeViewing the Contents of a Data Source, page 36.
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 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
1. Start AppXtender Queue Manager. For instructions, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36.
3. Make sure that the contents of a data source are listed on the right. For instructions, seeViewing the Contents of a Data Source, page 36.
4. 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
To unlock a queue:
1. Start AppXtender Queue Manager. For instructions, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36.
3. Make sure that the contents of a data source are listed on the right. For instructions, seeViewing the Contents of a Data Source, page 36.
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 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, seeViewing Jobs in a Queue, page 38.
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, seeViewing Jobs in a Queue, page 38.
2. 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.
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, seeViewing Jobs in a Queue, page 38.
2. 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, seeViewing Jobs in a Queue, page 38.
2. 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, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36.
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, seeStarting AppXtender Queue Manager, page 35.
2. Log in to the data source. For instructions, seeLogging into Data Sources, page 36.
3. Make sure that the contents of a data source are listed on the right. For instructions, seeViewing the Contents of a Data Source, page 36.
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 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
To monitor current activity on an AppXtender Index Server:
1. Start AppXtender Admin. For instructions, seeStarting ApplicationXtender Administrator, page 11.
2. 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 Description
IndexServer The name of the AppXtender Index Server nDocIndexed The number of documents successfully indexed nDocIndexFailed The number of document indexing attempts that
failed
nDocOcred The number of documents successfully OCR processed
nDocOcrFailed The number of document OCR attempts that failed strFTQueues The name of the active full text queue
strOcrQueues 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, seeAccessing the ApplicationXtender Web Access .NET Administrator, page 13.
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 Description
IndexServer The name of the AppXtender Index Server nDocIndexed The number of documents successfully indexed nDocIndexFailed The number of document indexing attempts that
failed
nDocOcred The number of documents successfully OCR processed
nDocOcrFailed The number of document OCR attempts that failed
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, seeStarting ApplicationXtender Administrator, page 11.
3. 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 Description
GetPrintStreamProcStatus Status of the Print Stream Processor.
Entry Description
GetPrintStreamProcTimeS-tamp
Time of the last update to the Print Stream Processor instance.
GetPrintStreamName User-generated name of the current print stream.
GetPrintStreamProcInstan-ceID
Unique ID of the current Print Stream Processor instance.
Table 10. ApplicationXtender Reports Management Server Report Processor Class Data
Property Description
STATUS Status of the most recent instance of the Report Processor.
MESSAGE Message log of the most recent Report Processor instance.
REPORTTYPE Name of the report being processed.
INSTANCEID Unique ID associated with the current instance of the Report Processor.
TIMESTAMP The date and time the Report Processor started processing.
INSTANCEID Unique ID associated with the current report.
REPORTTYPE Name of the report that is currently being handled by the Report Processor.
STATUS Status of the report.
STEP Stage of processing, such as Extract, of the current report.
PAGES Number of pages in the report. INDEXRECS Extracted index records in the report. UPLOADRECS Uploaded index records in the report. SOURCE Source file of the current report. SOURCELEN Size (in bytes) of the source file.
RESTARTS Number of times that the report had to restart processing.
ERRORS Number of errors in the report.
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, seeStarting ApplicationXtender Administrator, page 11.
2. 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.)
Table 11. ApplicationXtender File Access Manager Server Status Entries
Entry Description
ExpungeData Determines whether data is expunged from the staging path during garbage collection when documents are under retention.
GCDatabaseEvery 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.
GCHighWater The maximum disk space percentage (high water mark) to be used for staging files.
GCInterval Specifies how often the garbage collection process should run.
GCReduceBy The percentage by which the emergency garbage collection process reduces disk space usage when the high water mark is reached.
GCStagingEvery 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, seeStarting ApplicationXtender Administrator, page 11.
2. 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.)
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.
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.
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.