xMonitor User Guide
Transcription
xMonitor User Guide
xMonitor – User Manual Table of Contents List of Figures .................................................................................................................................... 4 1 Introduction .............................................................................................................................. 5 2 xMonitor Features ..................................................................................................................... 6 3 2.1 Login to xMonitor............................................................................................................... 6 2.2 Home Screen...................................................................................................................... 7 2.2.1 Menu ......................................................................................................................... 7 2.2.2 Dashboard .................................................................................................................. 8 2.2.3 Watch List ................................................................................................................ 15 2.3 Creating a Server Group ................................................................................................... 17 2.4 Creating a Server.............................................................................................................. 18 2.5 Monitor Types .................................................................................................................. 20 Monitors.................................................................................................................................. 21 3.1 Windows Monitors........................................................................................................... 21 3.1.1 Service Monitors ...................................................................................................... 21 3.1.2 Process Monitors ...................................................................................................... 21 3.1.3 Event Monitors ......................................................................................................... 21 3.2 File Monitors .................................................................................................................... 21 3.3 InputAccel Monitors ......................................................................................................... 22 3.3.1 Batch Monitors ......................................................................................................... 22 3.3.2 Module Monitors ..................................................................................................... 22 3.4 Database Monitors ........................................................................................................... 23 3.4.1 Database Monitors ................................................................................................... 23 3.5 Web Monitors .................................................................................................................. 23 3.6 Linux Monitors ................................................................................................................. 23 3.6.1 File Monitors ............................................................................................................ 23 3.6.2 Process Monitors ...................................................................................................... 23 3.7 CMIS Monitors ................................................................................................................. 24 3.7.1 Client Transactions Monitor ...................................................................................... 24 3.7.2 CMIS Misc. Monitor .................................................................................................. 24 3.8 Documentum Monitors .................................................................................................... 25 3.8.1 Client Transactions with Documentum Foundation Classes (DFC) .............................. 25 3.8.2 Client Transactions with Documentum Foundation Services (DFS) ............................. 25 xMonitor 1 xMonitor – User Manual 4 3.8.3 xPlore Indexing Monitor............................................................................................ 25 3.8.4 Accelerated Content Server (ACS) Monitor ................................................................ 26 3.8.5 Business Process Service (BPS) Monitor .................................................................... 26 3.8.6 Content Intelligence Service (CIS) Monitor ................................................................ 27 3.8.7 Java Method Server (JMS) Monitor ........................................................................... 27 3.8.8 Data Transformation Service (DTS) Monitor .............................................................. 27 3.8.9 Content server monitor ............................................................................................ 28 3.8.10 DFS Miscellaneous Monitor ...................................................................................... 28 Profiles .................................................................................................................................... 29 4.1 Server Profiles .................................................................................................................. 29 4.2 Module Profile ................................................................................................................. 29 4.3 Batch Profile .................................................................................................................... 30 4.3.1 Batch Monitor Thresholds: ....................................................................................... 30 4.3.2 Step Monitors:.......................................................................................................... 30 4.3.3 Batch Locks Monitor ................................................................................................. 31 4.3.4 Batch Count Monitor ................................................................................................ 31 4.3.5 Batch Creation Monitor ............................................................................................ 31 4.4 5 Windows Event Profile ..................................................................................................... 32 Reports .................................................................................................................................... 33 5.1 Server Side Reports .......................................................................................................... 33 5.1.1 CPU Utilization Report .............................................................................................. 33 5.1.2 Disk space Report ..................................................................................................... 33 5.1.3 Physical memory Report ........................................................................................... 34 5.1.4 Virtual Memory Report ............................................................................................. 35 5.1.5 Server Downtime Report ........................................................................................... 36 5.2 Documentum Reports ...................................................................................................... 37 5.2.1 State of Docbase Report ........................................................................................... 37 5.2.2 Transaction Response Report.................................................................................... 38 5.2.3 Connection Broker Report ......................................................................................... 39 5.2.4 Jobs Report .............................................................................................................. 39 5.2.5 Login Report ............................................................................................................. 40 5.2.6 Total Sessions Report ............................................................................................... 40 5.2.7 User Active Sessions Report...................................................................................... 40 5.2.8 Active Sessions Report.............................................................................................. 40 xMonitor 2 xMonitor – User Manual 5.2.9 5.3 7 8 9 Notification Reports ......................................................................................................... 41 5.3.1 Recent Notification Reports ...................................................................................... 41 5.3.2 Calendar ................................................................................................................... 41 5.4 6 Object Growth Report .............................................................................................. 40 InputAccel Reports ........................................................................................................... 42 5.4.1 Batch Reports ........................................................................................................... 42 5.4.2 Batch Age Report...................................................................................................... 42 5.4.3 InputAccel License Report ......................................................................................... 49 5.4.4 Connection Report .................................................................................................... 50 5.4.5 Module Report.......................................................................................................... 51 5.4.6 SLA for Batch Completion Report .............................................................................. 52 5.4.7 Task Level Report...................................................................................................... 52 InputAccel Utilities................................................................................................................... 54 6.1 Batch Analyzer ................................................................................................................. 54 6.2 Batch Utilities ................................................................................................................... 55 6.3 IA Upgrade Utility ............................................................................................................. 56 6.4 Batch Search Utility .......................................................................................................... 57 Service Level Agreements ........................................................................................................ 59 7.1 SLA for Availability: .......................................................................................................... 59 7.2 SLA for Diagnostics: .......................................................................................................... 63 Managing Users ....................................................................................................................... 67 8.1 Users................................................................................................................................ 67 8.2 User Profile ...................................................................................................................... 67 8.3 Change Password ............................................................................................................. 67 Acronyms ................................................................................................................................ 68 xMonitor 3 xMonitor – User Manual List of Figures Figure 2 Home Screen ....................................................................................................................... 7 Figure 3 Menubar .............................................................................................................................. 7 Figure 4 Configuration Menu ............................................................................................................. 8 Figure 5 Reports Menu ...................................................................................................................... 8 Figure 6 Dashboard status legend ...................................................................................................... 9 Figure 7 xMonitor Services Status Tile ............................................................................................... 9 Figure 8 xMonitor Service Manager ................................................................................................... 9 Figure 9 xMonitor Server Status ...................................................................................................... 10 Figure 10 xMonitor Server Manager ................................................................................................ 10 Figure 11 xMonitor CPU Utilization Tile ........................................................................................... 11 Figure 12 xMonitor CPU Usage Statistics.......................................................................................... 11 Figure 14 xMonitor Memory Usage Statistics ................................................................................... 12 Figure 16 xMonitor Offline Servers Tile ............................................................................................ 13 Figure 17 xMonitor Servers in Error State Tile .................................................................................. 14 Figure 18 xMonitor Hung Batches Tile ............................................................................................. 14 Figure 19 xMonitor Recent Error Table ............................................................................................ 14 Figure 20 xMonitor Watch List ......................................................................................................... 15 Figure 21 xMonitor View Status ....................................................................................................... 16 Figure 22 Server Groups Screen ....................................................................................................... 17 Figure 23 Add Server Group Screen ................................................................................................. 17 Figure 24 Add New Server Screen .................................................................................................... 18 Figure 25 New Server Screen ........................................................................................................... 19 Figure 26 CPU Utilization Report...................................................................................................... 33 Figure 27 Disk Space Report ............................................................................................................ 34 Figure 28 Physical Memory Report .................................................................................................. 35 Figure 29 Virtual Memory Report .................................................................................................... 36 Figure 30 Server Downtime Report .................................................................................................. 37 Figure 31 State of Docbase Report ................................................................................................... 38 Figure 32 Transaction Response Report ........................................................................................... 39 Figure 33 Recent Notifications Report ............................................................................................. 41 Figure 34 xMonitor's Calendar ......................................................................................................... 42 Figure 35 Batch Age Report ............................................................................................................. 43 Figure 36 Batch Count Report .......................................................................................................... 44 Figure 37 Batch Created Report ....................................................................................................... 45 Figure 38 Batch Completed Report .................................................................................................. 46 Figure 39 Batch Hung Report ........................................................................................................... 46 Figure 40 Batch Locks Report ........................................................................................................... 47 Figure 41 Batch Status Report ......................................................................................................... 48 Figure 42 Batch Error Report ........................................................................................................... 49 Figure 43 InputAccel License Report ................................................................................................ 50 Figure 44 InputAccel Connection Report .......................................................................................... 51 Figure 45 InputAccel Module Report ............................................................................................... 51 Figure 46 SLA for Batch Completed Report ...................................................................................... 52 Figure 47 Task Level Report ............................................................................................................. 53 xMonitor 4 xMonitor – User Manual Figure 48 InputAccel Upgrade Utility ............................................................................................... 57 Figure 49 InputAccel Batch Search Utility......................................................................................... 58 Figure 50 Availability SLA ................................................................................................................. 61 Figure 51 SLA Availability Overview by Server .................................................................................. 61 Figure 52 SLA Availability Detailed View. ......................................................................................... 62 Figure 53 More Details on Availability SLA when clicked on Server .................................................. 62 Figure 54 Servers that met SLA by Date ........................................................................................... 63 Figure 55 Diagnostics SLA options .................................................................................................... 64 Figure 56 Servers that Met/Failed the SLA ....................................................................................... 65 Figure 57 Diagnostics SLA Report ..................................................................................................... 65 Figure 58 Diagnostics SLA Detailed View per Server ......................................................................... 66 Figure 59 Diagnostics Server SLA Overview by Date ......................................................................... 66 1 Introduction xMonitor is an agentless monitoring tool for EMC Captiva InputAccel built on modern technology stack. xMonitor is an essential tool for monitoring any Captiva and ECM solution. It oversees, tracks and reports the current state of your entire content management system in real-time. xMonitor allows you to proactively monitor the performance and status of your InputAccel and enterprise content management (ECM) solution across multiple servers simultaneously. Operating system processes supporting InputAccel and the ECM are also monitored. This provides a complete picture of the imaging and ECM’s health. xMonitor is meant to be configured for System Administrators to receive alerts in the event of module downtime and batch processing errors. This notification module allows System Administrators the ability to monitor the solution 100% of the time without dedicating 100% of their time. xMonitor also has a suite of diagnostic tools with the ability to uncover potential problems. These diagnostic tools are targeted at the InputAccel and ECM solution. The tools help guide the System Administrator to understand existing and potential problems and provide the direction to resolve any issues discovered. With the integrated diagnostic toolset, even a System Administrator new to InputAccel and ECM can provide a well-maintained solution. xMonitor minimizes downtime and maximizes the efficiency of your content management system, allowing the re-allocation of valuable resources to suit organizational objectives. xMonitor frees up your resources, including your System Administrator. xMonitor 5 xMonitor – User Manual 2 xMonitor Features 2.1 Login to xMonitor Figure 1 Login Screen xMonitor starts with a login page. Enter a proper username and password to proceed further. xMonitor 6 xMonitor – User Manual 2.2 Home Screen Figure 2 Home Screen The home screen includes a watch list and a dashboard. The dashboard consists of tiles and a list of top recent messages. 2.2.1 Menu The xMonitor Menu consists of 3 Main menu items Figure 3 Menubar The configuration menu contains options that allows creating servers,monitors,users and configuring preferences in xMonitor. xMonitor 7 xMonitor – User Manual Figure 4 Configuration Menu The reports menu contains reports for all types of monitoring that xMonitor handles. Figure 5 Reports Menu 2.2.2 Dashboard A Dashboard is shown as soon as the user logs in to xMonitor in the home page alongside a tree that shows every monitor in xMonitor per server that are added to a group. The Dashboard has tiles that update information on the current statuses of the servers and is refreshed every 30 sec. The link on the tiles displays detailed relevant information about the servers by type and statistics of the servers including charts. The tiles in the dashboard show 2 kinds of details Issues Count Charts The Count of issues notifies the frequencies of the issues that occur while the Chart displays such information in a vivid and easy representation. The tiles are coloured based on the severity of issue. They change dynamically based on the status that the monitors are in. The Status of the tiles are explained with the legend shown in the below figure. xMonitor 8 xMonitor – User Manual Figure 6 Dashboard status legend Let’s look into some information that each tile shown in xMonitor Services This tile displays information about xMonitor services that are running. If any xMonitor Service Fails to run, this tile will notify the users and allow him to start the service right from the dashboard. 2.2.2.1 Figure 7 xMonitor Services Status Tile Clicking on ’Manage’ shows a dialog with all the services and buttons to start and stop them. Figure 8 xMonitor Service Manager xMonitor 9 xMonitor – User Manual Server Monitoring This tile displays the number of servers being monitored and servers that are exempted from being monitored. 2.2.2.2 Figure 9 xMonitor Server Status When clicked on Manage, a popup shows detailed information of what servers aren’t being monitored and a quick way to enable monitoring those servers. Figure 10 xMonitor Server Manager xMonitor 10 xMonitor – User Manual CPU Utilization This Tile shows CPU status of monitored servers and warns users if they are abnormally high. 2.2.2.3 Figure 11 xMonitor CPU Utilization Tile When clicked on CPU Usages, popup can show CPU utilization statistic of all monitored servers Figure 12 xMonitor CPU Usage Statistics Memory Utilization This Tile shows the memory status of monitored servers and warns users if they are abnormally high. 2.2.2.4 xMonitor 11 xMonitor – User Manual Figure 13 xMonitor Memory Usage Tile When clicked on Memory Usages, popup can show Memory utilization statistic of all monitored servers. Figure 14 xMonitor Memory Usage Statistics Errors Report These are a set of tiles that show the no. of errors that have been encountered by xMonitor based on server type. 2.2.2.5 xMonitor 12 xMonitor – User Manual Figure 15 xMonitor Errors Tile 2.2.2.5.1 IA Errors This mini tile shows a count of all the IA server issues that occurred within the last 10 minutes. A click on IA shows the messages that are sorted up by server so that it would be easy to identify the server with errors. 2.2.2.5.2 DCTM Errors This mini tile shows a count of all the Documentum server issues that occurred within the last 10 minutes. A click on DCTM shows the messages that are sorted up by server so that it would be easy to identify the server with errors. 2.2.2.5.3 OS Errors This mini tile shows a count of all the Operating System issues that occurred within the last 10 minutes for all servers. A click on OS shows the messages that are sorted up by server so that it would be easy to identify the server with errors. 2.2.2.5.4 MISC Errors This mini tile shows a count of all the issues concerning CMIS, DB monitors, Website and web service monitors that occurred within the last 10 minutes. A click on MISC shows the messages that are sorted up by server so that it would be easy to identify the server with errors. Offline vs. Online Servers This tiles shows a chart of servers that are offline vs. the once that are online. A click on Offline Servers can show the stop times of the unavailable servers 2.2.2.6 Figure 16 xMonitor Offline Servers Tile Error Percentage per Server This tile shows a chart of the servers with the most errors. 2.2.2.7 xMonitor 13 xMonitor – User Manual Figure 17 xMonitor Servers in Error State Tile Batches Hung This tile shows a count of batches that are hung on the monitored IA Servers. A click on Hung can show the hung count and its process details. 2.2.2.8 Figure 18 xMonitor Hung Batches Tile Recent Error Messages The table shows the top ten recent error messages and other details. 2.2.2.9 Figure 19 xMonitor Recent Error Table xMonitor 14 xMonitor – User Manual 2.2.3 Watch List The Watch List shows every monitor in xMonitor grouped under Server groups which is a categorical way to sort out servers in xMonitor. A right click on each item in the watch list gives various options for ease of accessibility. Figure 20 xMonitor Watch List View Statuses: - This provides with brief information of the selected node on the watch list. xMonitor 15 xMonitor – User Manual Figure 21 xMonitor View Status xMonitor 16 xMonitor – User Manual 2.3 Creating a Server Group Figure 22 Server Groups Screen Adding Server Groups can be done via the configuration menu item ‘Manage Servers Group’. All the existing Server Groups appear as a list in the Manage Server Group Screen. To add a new Server group click the ‘New Server Group’ button on the screen. A Server Group is a feature which is used to group different servers for the user’s convenience. Grouping servers helps to keep track of the servers easily. Note: - A server must be added to a group to be shown on the watch list (home screen). Figure 23 Add Server Group Screen A Server group requires a group name and a Description (optional).Give the required details and click on apply or finish to save. xMonitor 17 xMonitor – User Manual 2.4 Creating a Server Figure 24 Add New Server Screen Adding Servers can be done via the configuration menu item ‘Manage Servers’. All the existing Servers appear as a list in the Manage Servers Screen. You will find a ‘New Server’ button at the end of the screen. A Server is a physical machine which is will be monitored by xMonitor. To add a Server, the following details are required Domain Name: - The domain name on which the server is present. Name: - The name of the server or its IP address. Server Type: - Select a type of server being added. CMIS Database Documentum InputAccel Web None Operating System: - Select an operating system of the server being added. OS User: - Enter a valid user name preferably an administrator account. OS Password: - Enter a valid password and confirm password. To ensure all the details are valid, click on ‘Test Connection’ button Remote Caching: - Works only for InputAccel Server type. Enabling this lets xMonitor know that InputAccel Service is installed on the server machine. Enable Monitoring: - The option must be selected in order to monitor the server. Monitoring Profile: - Select a monitoring profile from the list, or create one by clicking on Manage Profiles and this clicking on ‘New Profile’. Primary Drive: - Select a primary drive from the server to be monitored. Email notifications: - Enter the mail ids separated by a “,” to send notifications when issues arise. xMonitor 18 xMonitor – User Manual Figure 25 New Server Screen xMonitor 19 xMonitor – User Manual 2.5 Monitor Types xMonitor has 2 kinds of Monitor types Profiles Monitors Profiles: - Profiles are reusable components of xMonitor. A user can create a profile and utilize it in various similar server types. Monitors: - Monitors are independent tests that you can add specifically to various Server based on their Server Type. Monitors offer Granularity over what test the user wants to perform. Monitors are individually dependent entities of a Sever. Every server has different kinds of monitors. Server Type Monitors Service Monitor, Process Monitor, Event Monitor, File Monitor Windows Batch Monitor, Module Monitor InputAccel Client transaction monitors with DFC and DFS, Content Server specific monitor, Documentum Database CMIS Web Linux xPlore Indexing Monitor, DFS monitors, Accelerated Content Server Monitors, Business Process Service Monitors, Content Intelligence Service Monitors, Java Method Server Monitors, Document Transformation Services Monitors. Database Monitors Client Transactions with CMIS and CMIS Misc. Monitors Website Monitor File Monitors and Process Monitors Monitor options: Every monitor can notify the user in unique ways. This is configured using the “monitor option” field on each of the monitor . Monitors are monitored only if monitor option is not set as disable. Monitor Option Description The component is not monitored Disable The component is monitored and issues are notified in the xMonitor’s Web Console Enable Notify High Priority xMonitor only. The component is monitored; issues are notified in the xMonitor’s Web Console and will be notified via e-mail . The component is monitored; issues are notified in the xMonitor’s Web Console and will be notified via e-mail immediately. 20 xMonitor – User Manual 3 Monitors Monitors are Server Type and OS Type Specific. 3.1 Windows Monitors Windows Monitors are specific to servers who’s OS type is windows only. 3.1.1 Service Monitors Service Monitor enables you to monitor Windows Service Availability. If the Service is stopped, the user is notified. Clicking on ‘Add Service’ gives you a list of service names associated with their display names. You can select one or more service(s) from the list to monitor Note: - Server must not be disabled for monitoring in order to monitor the service. 3.1.2 Process Monitors Process Monitor enables you to monitor Windows Process Availability and performance. If the Service is stopped, the user is notified. Clicking on ‘Add Process Monitor’ gives you some options to add your monitor. This monitor enables you to monitor the windows processes. Process Name: - You can select or type the process name existing on the selected server machine. Process Count: - An integer value to monitor the running processes count. Depending on the monitoring option, issue will be notified if the count of the running processes in windows is greater than the given value. Process CPU Usage: - An integer value to monitor the running processes CPU Usage. Depending on the monitoring option, issue will be notified if the CPU Usage of the running processes in windows is greater than the given value. Process Memory Usage: - An integer value to monitor the running processes Memory Usage. Depending on the monitoring option, issue will be notified if the Memory Usage of the running processes in windows is greater than the given value. Note: - Server must not be disabled for monitoring in order to monitor the service. 3.1.3 Event Monitors Event Monitor can help monitor various kinds of events that occur on remote machines. Clicking on ‘Add Event Monitor’ gives you two fields requesting to select an Event Type and an Event Profile. Event Type: - You can select one of the log types (Security, Application, System, Setup, and Forwarded) as the event type. Event Profile: - Every event monitor must be associated with an event profile. An Event Profile consists of all the monitoring conditions required to monitor. Note: - Server must not be disabled for monitoring in order to monitor the service. 3.2 File Monitors This monitor enables you to monitor the windows File counts. Clicking the “Add File Monitor” requests you to enter a Folder path and File count. Folder Path: - Specify a folder path to monitor the files count in it. File Count: - Specify a file count to monitor in the specified folder path. Depending on the monitoring option, issue will be notified if the File count in the given Folder path of windows is greater than the given value. Note: - Server must not be disabled for monitoring in order to monitor the service. xMonitor 21 xMonitor – User Manual 3.3 InputAccel Monitors You can find all the below monitors in the InputAccel tab of a server. These monitors work only on IA type servers. 3.3.1 Batch Monitors This monitor enables you to monitor the InputAccel Batches. Clicking on ‘Add Batch Monitor’ gives you two fields requesting to select a Process Name and Batch Profile. Process Name: - Specify a process name to monitor the batches in the process. Batch Profile: - Every batch monitor must be associated with a batch profile. A Batch Profile consists of all the monitoring conditions required to monitor a batch. Make sure that selected process and Monitoring profile associated process should be same. Department: - Specify a Department Name (Optional). Note: - Server must not be disabled for monitoring in order to monitor the service. 3.3.2 Module Monitors This monitor enables you to monitor the InputAccel Modules. Clicking on ‘Add Module Monitor’ gives you two fields requesting to select a Module Name and Module Profile. Module Name: - Specify a module name to monitor the module. Module Profile: - Every module monitor must be associated with a module profile. A Module Profile consists of all the monitoring conditions required to monitor a module. Note: - Server must not be disabled for monitoring in order to monitor the service. Module Connections Monitor This Monitor enables you to monitor Modules that have lost or are connected to an InputAccel server at a moment of time. The user is reported of any anomaly that the module encounters based on the monitor specified. Adding a Module Connections Monitor requires you to enter the following: 3.3.2.1 Module Name: - Displays the list of Modules connected to the server at that instance of time. Machine Name: - Displays Machine Names that are connected to the IA Server (Optional). User Name: - Specify a Username from which the Modules were being accessed (Optional). Module Task Processing Monitor This Monitor enables you to monitor Tasks that are being processed by the Modules that are connected to an InputAccel server at a moment of time. The user is reported of any anomaly on the no. of tasks of the module based on the monitor specified. Adding a Module Task Processing Monitor requires you to enter the following: 3.3.2.2 Module Name: - Displays the list of Modules connected to the server at that instance of time. Machine Name: - Displays Machine Names that are connected to the IA Server (Optional). User Name: - Specify a Username from which the Modules were being accessed (Optional). Min Count and Max Count: - Range of minimum and maximum task that the module should be processing. xMonitor 22 xMonitor – User Manual 3.4 Database Monitors You can find all the below monitors in the database tab of a server. 3.4.1 Database Monitors This monitor enables you to monitor the database queries. Clicking on ‘Add Database Monitor’ gives you four fields requesting to select a Query Type, Query/Path, Condition and the Expected Value. Query Type: - You are given two options. Query: - Select if you want to provide a query to monitor. File: - Select if you want to provide a sql file to monitor. Query/Path: - Specify a query or a file path based on the query type selection. Make sure that the query should be a count query ( query should return a single value numeric ) and also Make sure that the file selected must be located on the machine where the xMonitor Services are installed or a UNC path. Condition: - Select a relational operator from the given. Expected Value: - Specify a value that is returned by the query which is monitored. The value should be a numeric. Note: - Server must not be disabled for monitoring in order to monitor the service. 3.5 Web Monitors You can find all the below monitors in the web tab of a server. Web Monitors This monitor enables you to monitor the website. Clicking on ‘Add Web Monitor’ gives you two fields requesting to enter a URL and the Expected Value. 3.5.1.1 URL: - Specify a URL you would like to monitor. Expected Value: - Specify a HTTP status code that is returned by the URL which is monitored. Note: - Server must not be disabled for monitoring in order to monitor the service. 3.6 Linux Monitors You can find all the below monitors in the Linux tab of a server. 3.6.1 File Monitors This monitor enables you to monitor the Linux File counts. Clicking the “Add File Monitor” requests you to enter a Folder path and File count. Folder Path: - Specify a folder path to monitor the files count in it. File Count: - Specify a file count to monitor in the specified folder path. Depending on the monitoring option, issue will be notified if the File count in the given Folder path of Linux is greater than the given value. Note: - Server must not be disabled for monitoring in order to monitor the service. 3.6.2 Process Monitors This monitor enables you to monitor Linux Process Availability and Performance. Clicking on ‘Add Process Monitor’ gives you some options to add your monitor. Process Name: - You can select or type the process name existing on the selected server machine. Process Count: - An integer value to monitor the running processes count. Depending on the monitoring option, issue will be notified if the count of the running processes in Linux is greater than the given value. xMonitor 23 xMonitor – User Manual Process CPU Usage: - An integer value to monitor the running processes CPU Usage. Depending on the monitoring option, issue will be notified if the CPU Usage of the running processes in Linux, is greater than the given value. Process Memory Usage (Megabytes): - An integer value to monitor the running processes Memory Usage. Depending on the monitoring option, issue will be notified if the Memory Usage of the running processes in Linux is greater than the given value. Note: - Server must not be disabled for monitoring in order to monitor the service. 3.7 CMIS Monitors You can find all the below monitors in the CMIS tab of a server. 3.7.1 Client Transactions Monitor This monitor enables you to monitor the various transactions using CMIS on Alfresco and Documentum. Clicking on ‘Add Transaction Monitor’ gives you some options to add your monitor. ECM Type: - Specify your ECM type. (Documentum / Alfresco) CMIS URL: - Specify the CMIS URL. User Name & Password: - Specify the login credentials of the ECM type you selected. Click on the ‘Get Repository’ to get the list of repositories. Ensure the credentials are correct. Repository Name: - Select a repository from the list. Click on Test Login to confirm repository login. CMIS Folder Path: - Specify ECM folder path.(Documentum or Alfresco) Document Name: - Specify a file giving its complete file path. Ensure that the file exists by click on the Test File Path. Transactions: - There are seven transactions that could be monitored. To monitor a transaction select the monitor option code for the corresponding transaction and specify the time in which the transaction could complete (Expected Value). Click on the corresponding Test Button to check the transaction. To check all the transactions at a time click Test All. Transactions list: - Create Folder, Delete Folder, Create Document, Get Document, Delete Document, Checkout Document, Check-in Document. 3.7.2 CMIS Misc. Monitor Clicking on ‘Add Misc. Monitor’ gives you some options to add your monitor. This monitor enables you to monitor the CMIS Query and Login Responses. CMIS URL: - Specify the CMIS URL. User Name & Password: - Specify the login credentials of the ECM type you selected. Click on the ‘Get Repository’ to get the list of repositories. Ensure the credentials are correct. Repository Name: - Select a repository from the list. Click on Test Login to confirm repository login. Login Response Time: - This threshold monitors the time taken for a login. Select a monitor option code, a time value in seconds to monitor the login response time for the given credentials. Query Response Time: - This threshold monitors the time taken to complete a query and to get the query response. Select a monitor option code, specify a query and a time value in seconds to monitor the query response time for the given credentials and the query. xMonitor 24 xMonitor – User Manual 3.8 Documentum Monitors You can find all the below monitors in the Documentum Monitors tab of a server. 3.8.1 Client Transactions with Documentum Foundation Classes (DFC) This monitor enables you to monitor the basic Documentum Transactions and their response times using DFC. Clicking on ‘Add Monitor’ gives you some options to add your monitor. Repository Name: - Select a repository from the list. Selecting a repository you can find the transactions to add them to the monitor. Documentum Folder Path: - Specify a Documentum folder path. Click Test Folder Path and ensure the given path is correct. Document Name: - Specify a file giving its complete file path. Ensure that the file exists in the machine where the xMonitor services are running, by clicking on the Test File Path. Document Type: - Select a Document type to import the selected document to Documentum. Content Type: - Select a Content Type to import the selected document with specified content to Documentum. Transactions: - There are seven transactions that could be monitored. To monitor a transaction select the monitor option code for the corresponding transaction and specify the time in which the transaction could complete (Expected Value). Click on the corresponding Test Button to check the transaction. To check all the transactions at a time click Test All. Transactions list: - Create Folder, Delete Folder, Create Document, Get Document, Delete Document, Checkout Document, Check-in Document. 3.8.2 Client Transactions with Documentum Foundation Services (DFS) This monitor enables you to monitor the basic Documentum Transactions and their response times using DFS. Clicking on ‘Add Monitor’ gives you some options to add your monitor. Repository Name: - Select a repository from the list. Selecting a repository you can find the transactions to add them to the monitor. Documentum Folder Path: - Specify a Documentum folder path. Click Test Folder Path and ensure the given path is correct. Document Name: - Specify a file giving its complete file path. Ensure that the file exists in the machine where the xMonitor services are running, by clicking on the Test File Path. Document Type: - Select a Document type to import the selected document to Documentum. Content Type: - Select a Content Type to import the selected document with specified content to Documentum. Transactions: - There are seven transactions that could be monitored. To monitor a transaction select the monitor option code for the corresponding transaction and specify the time in which the transaction could complete (Expected Value). Click on the corresponding Test Button to check the transaction. To check all the transactions at a time click Test All. Transactions list: - Create Folder, Delete Folder, Create Document, Get Document, Delete Document, Checkout Document, Check-in Document. 3.8.3 xPlore Indexing Monitor This monitor enables you to monitor the xPlore Indexing monitors. Clicking on ‘Add Monitor’ gives you some options to add your monitor. xMonitor 25 xMonitor – User Manual Repository Name: - Select a repository from the list. Selecting a repository you can find the monitors to add. Monitors: xPlore Search Instance: - Checks if xPlore search instance is available. Select a monitor option code, enter a URL and an expected value such as OK, Bad Request to add a xPlore Search Instance monitor. xPlore Content Processing Services(CPS) Instance: - Checks if xPlore CPS instance is available. Select a monitor option code; enter a xPlore host and port, password, the instance name, CPS URL, and the Expected value such as OK, Bad Request to add a xPlore CPS Instance monitor. xPlore Administrator Console: - Checks if xPlore administrator console is available. Select a monitor option code, enter the URL and an expected result such as OK, Bad Request to add a xPlore Administrator monitor. xPlore Index Agent Console Status: - Checks if xPlore indexing agent console is available. Select a monitor option code, enter the URL and an expected result such as OK, Bad Request to add a xPlore Index Agent Console Status monitor. xPlore Index Agent Status: - Checks if xPlore indexing agent JMX Agent attribute for proper operation such as status of running. Select a monitor option code; enter the URL, User Name, Password, Domain/Node Name, Agent Name, Agent Type, expected result such as OK, Bad Request to add a xPlore Index Agent Status monitor. xPlore Index Pending Count: - Checks for xPlore indexing pending count for a Repository. Select a monitor option code, a relational condition and an expected value ( integer only ) to add a xPlore Index Pending Count monitor. xPlore Index Failed Count: - Checks for xPlore indexing failed count for a Repository. Select a monitor option code, a relational condition and an expected value (integer only ) to add a xPlore Index Failed Count monitor. xPlore Index Warning Count: - Checks for xPlore indexing warning count for a Repository. Select a monitor option code, a relational condition and an expected value ( integer only ) to add a xPlore Index Warning Count monitor. xPlore Index Processing Count: - Checks for xPlore indexing processing count for a Repository. Select a monitor option code, a relational condition and an expected value ( integer only ) to add a xPlore Index Processing Count monitor. 3.8.4 Accelerated Content Server (ACS) Monitor This monitor enables you to monitor the ACS features of Documentum. Clicking on ‘Add Monitor’ gives you some options to add your monitor. Monitors: ACS Server Status: - Checks for ACS status is in proper operation. Select a monitor option code, enter a URL and an expected value such as OK, Bad Request to add an ACS server status monitor. ACS Server Failure Count: - Checks for ACS JMX Agent attribute or method for proper ACS operation such as threshold for failed transactions processed by ACS server Select a monitor option code, enter the URL, User Name, Password, Domain/Node Name, Agent Name, Agent Type, a relational condition operator and an expected value (Integers only) to add an ACS Failure Count monitor. 3.8.5 Business Process Service (BPS) Monitor Clicking on ‘Add Monitor’ gives you some options to add your monitor. This monitor enables you to monitor the BPS features. Monitors: xMonitor 26 xMonitor – User Manual Inbound Active Listeners:- Validates inbound listeners serving a Repository for inbound FTP/HTTP/Email/JMS requests. Select a monitor option code, enter Host and Port, an expected value such as 200 for OK, 400 for Bad Request to add an Inbound Active Listeners monitor. Outbound Active Listeners: - Validates outbound listeners serving a Repository for outbound FTP/HTTP/Email/JMS/BOF/Web service requests. Select a monitor option code, enter Host and Port, an expected value such as 200 for OK, 400 for Bad Request to add an Outbound Active Listeners monitor. 3.8.6 Content Intelligence Service (CIS) Monitor This monitor enables you to monitor the CIS features. Clicking on ‘Add Monitor’ gives you some options to add your monitor. Monitors: CIS Document Sets Processed: - Checks for number of processed document sets. Select a monitor option code, enter a relational condition operator an expected value (Integers only) to add a CIS Document Sets Processed monitor. CIS Document Sets Failed: - Checks for number of failed document sets. Select a monitor option code; enter a relational condition operator and an expected value (Integers only) to add a CIS Document Sets Failed monitor. CIS Server Status: - Checks for CIS Server Status. Select a monitor option code, enter the JMX URL, User Name, Password, Domain/Node Name, Agent Name, Agent Type and an expected result such as OK, Bad Request to add an CIS Server Status monitor. 3.8.7 Java Method Server (JMS) Monitor This monitor enables you to monitor the JMS features. Clicking on ‘Add Monitor’ gives you some options to add your monitor. Monitors: JMS Operating Status: - Checks for JMS operating status. Select a monitor option code; enter a URL and an expected value such as Documentum ‘Java Method Server’ to add a JMS Operating Status monitor. JMS Servlet Execution: - Checks JMS ability to execute a Documentum servlet. Select a monitor option code; select a servlet and an expected value such as Documentum ‘Java Method Server’ to add a JMS Servlet Execution monitor. 3.8.8 Data Transformation Service (DTS) Monitor Clicking on ‘Add Monitor’ gives you some options to add your monitor. This monitor enables you to monitor the DTS features. Monitors: DTS Total Task Count: - Select a monitor option code, a relational condition and an expected value (integer only) to add a DTS Total Task Count monitor. DTS Queued Task Count: - Select a monitor option code, a relational condition and an expected value (integer only) to add a DTS Queued Task Count monitor. DTS Profiles Availability: - Select a monitor option code and an available profile from the list to add a DTS Profiles availability monitor. xMonitor 27 xMonitor – User Manual 3.8.9 Content server monitor In this monitor we can configure different types sub monitors related to Content Server. Session Monitors Total Sessions:- Checks for total no. of sessions to the repository. You can click on test button to get total sessions present in the content server at that point of time. You will be notified with a message whenever condition failed. Active Sessions: Checks for total no. of active sessions to the repository. You can click on test button to get total active sessions present in the content server at that point of time…. Active User Sessions: Checks for total no. of active sessions per user to the repository. From the list of users provided, you can select a user and see the active sessions for that user. Response Monitors Logon Repository: -Checks login response times for the repository. You can click on test button to know whether you are able to log on to the repository or not. You have to provide response time in order to add this sub monitor. You will be notified when the repository login exceeds the response time provided. Connection Broker: - Checks if the connection broker exist. This sub-monitor check for docbroker availability on specific host: port. If the connection broker exceeds response time provided, you will be notified. Query Response Time: - Check for Query Response time. This sub monitor executes the given query and checks with the response time. Search in Query Response: - Searches for a keyword in result of the query. This sub monitor executes the given query and checks for the search string provided in the search box. You will be notified when no match found in the query result. Object Growth: - The number of documents created in the given interval is Object Growth. Alerts when Documentum object count when exceeded. For this monitor you have to select a document type and the interval in the given lists. By clicking on test you can know how many documents were created in the given interval. You will be notified when the object growth exceeds the expected result. Job Status: - You can know a job response time using this monitor. For this you have to select a job. By clicking on test you will know the recent job ran status and you will be notified if the selected job took more time than expected completion time. 3.8.10 DFS Miscellaneous Monitor In order to add Documentum Foundation Services (DFS) monitor you have to select a repository. DFS miscellaneous monitor contains the following sub monitors. Search Service: - By clicking on test you will get the repository list present in the server. You can fill the expected result filed from the test result. You will be notified when no match is found. Schema Service: - Clicking on test invokes the schema service web service method and returns the repository metadata information. You can fill the expected result from the test result. You will be notified when no match found. Qualification String: - Query specified is to be executed. After specifying the string, click on test to get the result. You can provide the expected result from the test result. You will get notifications when no match is found. Query Service: - Using this sub monitor you can verify whether a query is running successfully or not. You have to provide the query in the given text area. By clicking on the test will give you the result of the query entered. You can provide the expected result from the test result. You will get notifications when no match is found. Workflow Service: - This sub monitor obtains a list of installed process templates in the repository. If the Folder Path is passed, only the process templates within the Folder Path are returned. By clicking xMonitor 28 xMonitor – User Manual on the test button you will get all the installed process templates. You can enter the expected result from the test result. You will get notifications when no match is found. 4 Profiles 4.1 Server Profiles General Details Name: -Specify name for the profile. Description:-Specify the description about the profile (optional). Monitoring Thresholds CPU (percentage):- An integer value to monitor the CPU usage. Based on the monitor option, the issue will be notified if the average CPU usage calculated for a period specified in ‘CPU Time Span’ field in Preferences page from current time is greater than the specified value. Memory Time Span Disk Space (percentage):- An integer value to monitor free disk space. Based on the monitor option, the issue will be monitored if the free disk space at the monitored time is less than the specified value. Memory (Mega Bytes):- An integer value to monitor memory usage. Based on the monitor option, the issue will be notified if the average memory usage calculated for a period specified in ‘Memory Time Span’ field in Preferences page from current time is greater than the specified value. Server Downtime (minutes):- An integer value to monitor server downtime. Based on the monitor option, the issue will be notified if the downtime will be greater than the specified value. 4.2 Module Profile Clicking on ‘New Profile’ gives you some options to add your monitor. This monitor enables you to monitor the IA module properties. General Details: Name: -Specify name for the profile. Description:-Specify the description about the profile (optional). Module Monitor Thresholds: Active: - An integer value to monitor count of all active tasks. The issue will be notified based on the specified monitor option code and monitor option. Done: - An integer value to monitor count of all tasks in the done state. The issue will be notified based on the specified monitor option code and monitor option. Error: - An integer value to monitor count of all tasks in the error state. The issue will be notified based on the specified monitor option code and monitor option. Offline: - An integer value to monitor count of all offline tasks. The issue will be notified based on the specified monitor option code and monitor option. Queued: - An integer value to monitor count of all queued tasks. The issue will be notified based on the specified monitor option code and monitor option. Sent: - An integer value to monitor count of all tasks that have been sent for processing. The issue will be notified based on the specified monitor option code and monitor option. Working: - An integer value to monitor count of all working tasks. The issue will be notified based on the specified monitor option code and monitor option. Note: - The task counts monitored are the counts of all the departments specified in the processes and batches for the monitored module and monitor option. xMonitor 29 xMonitor – User Manual 4.3 Batch Profile Clicking on ‘New Profile’ gives you some options to add your monitor. This monitor enables you to monitor the IA batch properties. General Details: Name: -Specify name for the profile. Description:-Specify the description about the profile (optional). InputAccel Server: - Select IA server from the list of displayed IA servers. Process: - Select Process from the list of processes displayed for the selected server. Completion Step: - Select completion step from the displayed steps of the selected process for calculation of batch completion time. This field will be enabled only if ‘Completion Time’ field monitor option is not in Disabled state. 4.3.1 Batch Monitor Thresholds: Age (minutes): - An integer value to monitor age of the batch. Batch age is difference between creation and present time. This issue will be notified based on the specified monitor option code and monitor option. Completion Time (minutes): - An integer value to monitor batch completion time. Batch completion time is compared with the given value and based on the monitor option code and monitor option; issue for that batch is notified. Priority: - An integer value to monitor priority of the batch. Batch priority is compared with the specified value and based on the monitor option code and monitor option; issue for that batch is notified. Total Tasks: - An integer value to monitor the batch tasks count. Total batch tasks count is compared with the specified value and based on the monitor option code and monitor option; issue is notified to user. Status: - Check one or more batch statuses which need to be monitored. All the batches for the selected process whose status is in checked list will be monitored and notified based on the monitor option. Note: - Please click on the Apply tab before adding step monitors. 4.3.2 Step Monitors: Clicking on ‘Add Step Configuration’ gives you option to select the step to monitor. Step (Module):- Select Step that needs to be monitored from the list of steps for given process. Clicking on ‘Configure’ gives you some options to add your monitor. This monitor enables you to monitor the batch step properties. Monitor Thresholds: Hung Time (minutes): - An integer value to monitor the batch hung time. Depending on the monitor option, this issue will be notified if the batch is hung in this step for the time greater than the given value. Active: - An integer value to monitor the step task counts that are in active state. The issue will be notified based on the specified monitor option code and monitor option. Done: - An integer value to monitor the step task counts that are in done state. The issue will be notified based on the specified monitor option code and monitor option. Error: - An integer value to monitor the step task counts that are in error state. The issue will be notified based on the specified monitor option code and monitor option. xMonitor 30 xMonitor – User Manual Offline: - An integer value to monitor the step task counts that are in offline state. The issue will be notified based on the specified monitor option code and monitor option. Queued: - An integer value to monitor the step task counts that are in queued state. The issue will be notified based on the specified monitor option code and monitor option. Sent: - An integer value to monitor the step task counts that are in sent state. The issue will be notified based on the specified monitor option code and monitor option. Working: - An integer value to monitor the step task counts that are in working state. The issue will be notified based on the specified monitor option code and monitor option. 4.3.3 Batch Locks Monitor Batch Locks monitor check for no. of batches under locked state. Any change from the specified threshold is reported. The following details are entered. Maximum Batch Locks: - The Threshold value of locks beyond which is reported to the user Filters:-Advanced options (Optional) Include Batches : - Batches to include (comma separated) Exclude Batches : - Batches to ignore (comma separated) Ignore Batches younger than: - Batches created before a particular age in minutes to be ignored. Batch Priority: - Filter only batches by a particular value or a Condition (> or <) or a Range of values. 4.3.4 Batch Count Monitor The Batch Count Monitor check for exceeding count of batches based on a particular threshold value set by the User. The following details need to be entered Maximum Batch Count : - The Batch count threshold which when exceeded is reported to the user. Filters:-Advanced options (Optional) Include Batches : - Batches to include (comma separated) Exclude Batches : - Batches to ignore (comma separated) Batch Status: - Filter batches with one of the Following statuses (Batch Error, Batch Hold, Done, Not Ready, Ready, Sent, Task Error and Working). Batch Priority: - Filter only batches by a particular value or a Condition (> or <) or a Range of values. 4.3.5 Batch Creation Monitor This Monitor ensures that batches are being created within a specified monitoring interval. If no batches are created within the specified threshold, the activity is reported to the user. Batch Interval: - The Interval at which batches need to be created in Minutes or hours. Filters:-Advanced options (Optional) Include Batches : - Batches to include (comma separated) Exclude Batches : - Batches to ignore (comma separated) Batch Status: - Filter batches with one of the Following statuses (Batch Error, Batch Hold, Done, Not Ready, Ready, Sent, Task Error and Working). Batch Priority: - Filter only batches by a particular value or a Condition (> or <) or a Range of values. xMonitor 31 xMonitor – User Manual 4.4 Windows Event Profile Clicking on ‘New Profile’ gives you some options to add your monitor. This monitor enables you to monitor the Windows Events. General Details Name: -Specify name for the profile. Description:-Specify the description about the profile (optional). Monitoring Thresholds Source: - Specify the Event Source for the corresponding Event Level (any of Information, Error, Warning, Failure Audit and Success Audit) that needs to be monitored. Event Code: - Specify the Event ID for the corresponding Event Source and Event Level. Error Message: - Specify either part or full Event message for the corresponding Event Code, Source and Event Level. Depending on the monitor option, the event messages that consist of part or full Error Message for the corresponding Event Code, Source, Event Level and Event Type will be notified. Note: - Select the type of profile that is associated for the corresponding event type. Types of Event Type (log type) - Security, Application, System, Setup and Forwarded. Types of Event Level (level) - Information, Error, Warning, Failure Audit and Success Audit. xMonitor 32 xMonitor – User Manual 5 Reports 5.1 Server Side Reports 5.1.1 CPU Utilization Report The CPU utilization report gives the details of the CPU usage of the monitoring Servers of the past twenty four hours by default (without filters). Filters: Server Group: - Select a server group to filter the server list. Server: - Selecting a particular server. Timespan: - Select a time interval to load data between the selected dates. Figure 26 CPU Utilization Report 5.1.2 Disk space Report The Disk space report gives the details of the Disk space of the monitoring Servers of the past twenty four hours by default (without filters). Filters: Server Group: - Select a server group to filter the server list. Server: - Selecting a particular server. Timespan: - Select a time period to load data between the selected dates. Disk space: - Enter a value to filter the disk space usage above the given value. xMonitor 33 xMonitor – User Manual Figure 27 Disk Space Report 5.1.3 Physical memory Report The Physical memory report gives the details of the physical memory of the monitoring Servers of the past twenty four hours by default (without filters). Filters: Server Group: - Select a server group to filter the server list. Server: - Selecting a particular server. Timespan: - Select a time period to load data between the selected dates. Disk space: - Enter a value to filter the disk space usage above the given value. xMonitor 34 xMonitor – User Manual Figure 28 Physical Memory Report 5.1.4 Virtual Memory Report The Virtual Memory report gives the details of the Virtual Memory of the monitoring Servers of the past twenty four hours by default (without filters). Filters: Server Group: - Select a server group to filter the server list. Server: - Selecting a particular server. Timespan: - Select a time period to load data between the selected dates. Disk space: - Enter a value to filter the disk space usage above the given value. xMonitor 35 xMonitor – User Manual Figure 29 Virtual Memory Report 5.1.5 Server Downtime Report The Server Downtime report gives the details of the server crash count of the monitoring Servers of the past twenty four hours by default (without filters). Filters: Server Group: - Select a server group to filter the server list. Server: - Selecting a particular server. Timespan: - Select a time period to load data between the selected dates. xMonitor 36 xMonitor – User Manual Figure 30 Server Downtime Report 5.2 Documentum Reports 5.2.1 State of Docbase Report The State of Docbase report gives the details of the last ran status of the State of Docbase Job. Most content Servers usually Documents by Type: - Gives the details of the top ten document type and their corresponding counts. The rest are grouped under others. Documents by Format: - Gives the details of the top ten document format and their corresponding counts. The rest are grouped under others. Documents by Storage: - Gives the details of the top ten documents by storage area and their corresponding counts. The rest are grouped under others. Content size (KB) by Format: - Gives the details of the top ten total content sizes by format and their corresponding sizes in KB. The rest are grouped under others. Content size (KB) by Renditions: - Gives the details of the top ten total content sizes by rendition and their corresponding sizes in KB. The rest are grouped under others. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. xMonitor 37 xMonitor – User Manual Figure 31 State of Docbase Report 5.2.2 Transaction Response Report The Transaction response report gives the details of the transactions response times of DFC and DFS Transactions Folder Creation: - The time taken to create a folder. Document Creation: - The time taken to import and create a document Get Document: - The time taken to get a document Check-out Document: - The time taken to check-out a document. Check-in Document: - The time taken to check-in a Document. Delete Document: - The time taken to delete a document. Delete Folder: - The time taken to delete a folder. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Transaction Type: - Select a type of transaction (DFC/DFS) xMonitor 38 xMonitor – User Manual Monitor Name: - Select a monitor that is registered to the selected transaction type. Time span: - Select a time period to load data between the selected dates. Figure 32 Transaction Response Report 5.2.3 Connection Broker Report The Connection Broker report gives the details of time taken for xMonitor to connect to a connection broker while monitoring (Docbroker) Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - Select a time period to load data between the selected dates. 5.2.4 Jobs Report The Jobs report gives the details of the response times of the monitored job corresponding to the selected repository. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - Select a time period to load data between the selected dates. xMonitor 39 xMonitor – User Manual 5.2.5 Login Report The Login report gives the details of the login response times of the monitored repository. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - Select a time period to load data between the selected dates. 5.2.6 Total Sessions Report The Total sessions report gives the details of the total no. of sessions of the monitored repository. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - - Select a time period to load data between the selected dates. 5.2.7 User Active Sessions Report The User Active sessions report gives the details of the user’s active sessions of the monitored repository. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - - Select a time period to load data between the selected dates. 5.2.8 Active Sessions Report The Active sessions report gives the details of the active sessions of the monitored repository. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - - Select a time period to load data between the selected dates. 5.2.9 Object Growth Report The Object Growth report gives the details of the documents created for the monitored repositories. Filters: Server: - Selecting a particular server. Repository: - Selecting a particular repository that is registered to the selected Documentum server. Time span: - - Select a time period to load data between the selected dates. xMonitor 40 xMonitor – User Manual 5.3 Notification Reports 5.3.1 Recent Notification Reports The Recent Notification report gives the details of the recent messages issued by xMonitor. Filters: Server: - Selecting a particular server. Monitors: - Selecting a particular monitor that is registered to the selected server. Time span: - Select a time period to load data between the selected dates. Figure 33 Recent Notifications Report 5.3.2 Calendar The Calendar report gives the details of the total messages count per day irrespective of filters. xMonitor 41 xMonitor – User Manual Figure 34 xMonitor's Calendar 5.4 InputAccel Reports 5.4.1 Batch Reports Batch Report elaborates Batch details of monitored InputAccel Servers. 5.4.2 Batch Age Report The Batch Age report gives the details of a batch’s age of the monitored server. BATCH AGE = CURRENT DATE – BATCH CREATED DATE Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Priority: - Set a condition and a value to load data satisfying them. xMonitor 42 xMonitor – User Manual Figure 35 Batch Age Report Batch Count Report The Batch Count report gives the details of the counts of the batches from all the monitored servers by default. 5.4.2.1 Filters: Server: - Selecting a particular server. xMonitor 43 xMonitor – User Manual Figure 36 Batch Count Report Batch Created Report The Batch Created report gives the details of the number of batches created on the monitored server. 5.4.2.2 Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Time span: - Select a time period to load data between the selected dates. xMonitor 44 xMonitor – User Manual Figure 37 Batch Created Report Batch Completed Report The Batch Completed report gives the details of the number of batches completed on the monitored server. 5.4.2.3 Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Time span: - Select a time period to load data between the selected dates. xMonitor 45 xMonitor – User Manual Figure 38 Batch Completed Report Batch Hung Report The Batch Hung report gives the details of the number of batches that are in hung state on the monitored server. HUNG BATCH= BATCHES THAT HAVEN’T FINISHED PROCESSING FROM PREVIOUS MONITORING STATUS. 5.4.2.4 Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Max Step Age: - Enter a value for step age to filter the date. Figure 39 Batch Hung Report xMonitor 46 xMonitor – User Manual Batch Locks Report The Batch Locks report gives the details of the number of batches that are in locked state on the monitored server. 5.4.2.5 Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Figure 40 Batch Locks Report Batch Status Report The Batch Status report gives the details of the current batch status and their counts on the monitored server. 5.4.2.6 Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. xMonitor 47 xMonitor – User Manual Figure 41 Batch Status Report Batch Error Report The Batch Error report gives the details of the number of batches that are in error state on the monitored server. 5.4.2.7 Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. xMonitor 48 xMonitor – User Manual Figure 42 Batch Error Report 5.4.3 InputAccel License Report The InputAccel License report gives the details of the modules and their licensed connections, Licensed Pages, Used Connections, and Used Pages on the monitored server. Filters: Server: - Selecting a particular server. xMonitor 49 xMonitor – User Manual Figure 43 InputAccel License Report 5.4.4 Connection Report The Connection report gives the details of the modules that are currently connected to select IA server on the monitored server. Filters: Server: - Selecting a particular server. xMonitor 50 xMonitor – User Manual Figure 44 InputAccel Connection Report 5.4.5 Module Report The Module report gives the details of the tasks in various states on the selected IA server. Filters: Server: - Selecting a particular server. Module: - Selecting a particular module. Department: - Select a department to filter the data. Figure 45 InputAccel Module Report xMonitor 51 xMonitor – User Manual 5.4.6 SLA for Batch Completion Report The Service Level Agreement for Batch Completion report gives the details of the number of completed batches that missed SLA or met the SLA value that is specified by the user on the selected IA Server. Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Time span: - Select a time period to load data between the selected dates. Interval: - Select an interval, considering which the time period is divided. SLA (minutes): - Enter a value for SLA to filter data. Figure 46 SLA for Batch Completed Report 5.4.7 Task Level Report The Task Level report gives the details of the number of batches and their states on the monitored server. Filters: Server: - Selecting a particular server. Process: - Selecting a particular process that is on the selected server. Step Status: - Select a step status SLA to filter data. xMonitor 52 xMonitor – User Manual Figure 47 Task Level Report xMonitor 53 xMonitor – User Manual 6 InputAccel Utilities InputAccel utilities help analyze performance and manage common IA tasks easily. 6.1 Batch Analyzer Batch Analyzer help users analyses on how the batches are being processed and how each batch’s processing time is based on the monitored data recorded by xMonitor. Figure 48 Batch Analyzer xMonitor 54 xMonitor – User Manual 6.2 Batch Utilities Batch Utilities are a bunch of helpful feature used to manage common batch operation quickly and effortlessly. Figure 49 Batch Priority Resetting The Batch Priority Utility lets users select multiple batches and reset their priority to whatever value the user might want. This utility can be configured to set multiple values per process based on filtering mechanisms like batch statuses and Batch Description. xMonitor 55 xMonitor – User Manual Figure 50 Batch Retriggering Batch Retriggering can be done in xMonitor with ease using the Batch retrigger Utility. This utility allows the user to select batches and steps at which a retrigger is to be invoked. Once a bunch of batches are selected, one can add different retrigger to different steps of different processes and retrigger. XMonitor retriggers each of the selected batch that is specified and clears the task errors. 6.3 IA Upgrade Utility The IA Upgrade utility details on the changes that are reflected when a Captiva 6 machine is upgraded to a Captiva 7 machine. The Report requires a Captiva 6 machine to be selected from a list of Captiva servers. xMonitor 56 xMonitor – User Manual Figure 51 InputAccel Upgrade Utility The Report details the following criteria: Details about the server and server’s license usage. Modules counts based on Deprecation, Custom or Standard Modules. List of all processes with in-depth info on each Step Module with its corresponding Alternative module on Captiva 7 colour coded to Denote module status. 6.4 Batch Search Utility Batch Search utility allows users to filter through batches effortlessly over multiple IA Servers and Departments. Filtering can be done by specifying Modules (Optional) and Processes (Optional) as well. xMonitor 57 xMonitor – User Manual Figure 52 InputAccel Batch Search Utility Once selected,a list of batches with details are displayed specifying their status.Upon selecting a batch a list of Task details per step is illustrated in a table as well as a top down view of all nodes of the Batch are illustrated in a tree table. xMonitor 58 xMonitor – User Manual 7 Service Level Agreements 7.1 SLA for Availability: This report lets users get an overall availability of Servers based on criteria that they specify. Criteria is a series of questions that we ask the user, based on which we deliver the SLA report. Criteria for Server Availability can be the following: Common Server Metric: Server Downtime Threshold (%) Specify an acceptable server downtime Server Downtime Threshold should be greater than the Monitored Value Sum of downtimes for a server based on the criteria given Server Availability Threshold (%) Specify an acceptable server availability Server frequency threshold should be less than or equal to the XMonitor Monitored Value The no. of times server went offline. InputAccel Specific: Batch Availability Threshold (%) Specify an acceptable batch availability Batch Availability Threshold should be less than or equal to the XMonitor Monitored Value Batch availability percent = (No. of batches available * 100) /( Total no. of batch created) Modules Downtime Threshold (%) Specify an acceptable modules downtime module Downtime Threshold should be greater than or equal to the XMonitor Monitored Value Sum of downtimes for a module based on the criteria given Modules Availability Threshold (%) Specify an acceptable modules availability Module Frequency Threshold should be less than or equal to the XMonitor Monitored Value The no. of time the module got disconnected. Documentum Specific: JMS Availability Threshold (%) Specify an acceptable jms downtime Jms Frequency Threshold should be less than or equal to the XMonitor Monitored Value The no. of times jms server went offline. JMS Downtime Threshold (%) Specify an acceptable jms availability Jms Downtime Threshold should be greater than or equal to the XMonitor Monitored Value Sum of downtimes for a jms server based on the criteria given xMonitor 59 xMonitor – User Manual Based on these Criteria the user can either select either for all servers or for a particular server or for a Set of Server Types (IA, DCTM etc…) also he can set the time intervals for which SLA needs to be met. xMonitor 60 xMonitor – User Manual Screenshot 1: - Figure 53 Availability SLA Select criteria from the options for the SLA. Figure 54 SLA Availability Overview by Server This is an overall PIE chart showing the count of the servers that had met and missed the SLA. xMonitor 61 xMonitor – User Manual Figure 55 SLA Availability Detailed View. This table shows the overall details of the criteria selected. A tick mark is shown when a server meets the criteria on every instance of the time period else if a server does not meet the criteria even on a single instance of the time period a cross mark will be display. Figure 56 More Details on Availability SLA when clicked on Server xMonitor 62 xMonitor – User Manual Selecting a server from the table shows criteria of every instance of the time period of the selected server. Figure 57 Servers that met SLA by Date This chart shows the count of server that met and missed sla segregated by the instances of time. 7.2 SLA for Diagnostics: This report lets users see diagnostic info on Servers based on criteria that they specify. Criteria is a series of questions that we ask the user, based on which we deliver the SLA report. Criteria for Server Diagnostics can be the following: Server diagnostics: CPU Usage (%) Percentage CPU usage for each server CPU Usage should be greater than or equal to the XMonitor Monitored Value Disk available (%) Percentage of free disk space for each server Disk Free should be greater than or equal to the XMonitor Monitored Value Memory available (%) Percentage of memory free for each server Memory Free should be greater than or equal to the XMonitor Monitored Value IA diagnostics: Batch count Total batches created. Batches Created should be greater than or equal to the XMonitor Monitored Value Batch error (%) Percentage of batches in error state xMonitor 63 xMonitor – User Manual Batches Error should be greater than or equal to the XMonitor Monitored Value Batch completion (%) Percentage of batches in completed state Batches Completes should be greater than or equal to the XMonitor Monitored Value Documentum diagnostics: Sessions count Average of total session counts that occur while monitoring Session Counts should be greater than or equal to the XMonitor Monitored Value Repository login response time. Average of repository login response times that occur while monitoring Login Time should be greater than or equal to the XMonitor Monitored Value Screenshot 1: - Figure 58 Diagnostics SLA options xMonitor 64 xMonitor – User Manual Select criteria from the options for the SLA. Figure 59 Servers that Met/Failed the SLA This is an overall PIE chart showing the count of the servers that had met and missed the SLA. Figure 60 Diagnostics SLA Report This table shows the overall details of the criteria selected. xMonitor 65 xMonitor – User Manual A tick mark is shown when a server meets the criteria on every instance of the time period else if a server does not meet the criteria even on a single instance of the time period a cross mark will be display. Figure 61 Diagnostics SLA Detailed View per Server Selecting a server from the table shows criteria of every instance of the time period of the selected server. Figure 62 Diagnostics Server SLA Overview by Date This chart shows the count of server that met and missed SLA segregated by the instances of time. xMonitor 66 xMonitor – User Manual 8 Managing Users 8.1 Users Clicking on ‘Add User’ gives you some options to add user. This profile adds a user. 8.2 User Profile User Name & Password: - Specify the user name and password of the user for whom access has to be given. Role: - Specify one of the roles (Administrator, Configurable, Reports and User) from the list which specifies the privileges that need to be given to the user. Enable: - Check this field if user needs to access this application. 8.3 Change Password You will find a dialogue box which allows changing your password. Old Password, New Password & Confirm Password: - Specify your old password, new password and confirm password. Change button enables once all the 3 fields are entered. Clicking on Change button changes your password. xMonitor 67 xMonitor – User Manual 9 Acronyms ACS BPS CIS CMIS CPS CPU CS DCTM DFC DFS Port DFS DTS IA JMS JMX MISC OS RCS SLA URL ACS BPS CIS CMIS xMonitor Accelerated Content Server Business Process Services Content Intelligence Services Content Management Interoperability Services Content Processing Services Central Processing Unit Content Server Documentum Documentum Foundation Classes The port in which Documentum Foundation Service is installed. Documentum Foundation Services Documentum Transformation Services InputAccel Java Method Server Java Management Extensions Miscellaneous Operating System Remote Caching Services Service Level Agreement Uniform Resource Locator Accelerated Content Server Business Process Services Content Intelligence Services Content Management Interoperability Services 68