Annotation Service Test

Annotation service stores and manages comments against the context of a dashboard, report, report widget, or report element that is made accessible through IBM Cognos Workspace. These comments persist across multiple versions of a report. The annotation service also supports comments associated with tasks in My Inbox in IBM Cognos Connection. The annotation service also supports IBM Cognos Workspace features and features related to human tasks in IBM Cognos Connection when it receives requests from reportDataService. If too many requests failed, the service will not be able to fetch the comments from the IBM Cognos Workspace. As a result, administrators may not know the critical information about the features and the comments entered for the elements that are accessible through IBM Cognos Workspace. To avoid request failures, administrators should continuously keep vigil on the status and request processing capability of the annotation service. For this purpose, administrators can use the Annotation Service test.

This test monitors the annotation service and reports the current status of the service. This test also throws light on the number of annotation service requests that successful/failed. This test helps administrators initiate troubleshooting to determine the reason for request failures and resolve the same at the earliest.

Target of the test : An IBM Cognos Business Intelligence

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for the target IBM Cognos Business Intelligence suite being monitored

Configurable parameters for the test

Parameter	Description
Test period	How often should the test be executed .
Host	The host for which the test is to be configured.
Port	The port number at which the specified host listens. By default, this is NULL.
JMX Remote Port	Here, specify the port at which the JMX listens for requests from remote hosts. Ensure that you specify the same port that you configured in the p2pd.deploy_defaults.properties file available in the <IBM_COGNOS_BI_HOME>\webapps\p2pd\WEB-INF folder used by the target application server.
JMX User, JMX Password, and Confirm Password	By default, JMX requires no authentication or security (SSL). This is why, by default, the JMX User and JMX Password parameters are set to none. If JMX requires authentication only (but no security), then ensure that the JMX User and JMX Password parameters are configured with the credentials of an authorized user with access to JMX using the JMX Remote Port. Confirm the password by retyping it in the Confirm Password text box.

Measurements made by the test

Measurement	Description	Measurement Unit	Interpretation
Status	Indicates the current status of the service.		The values that this measure can report and their corresponding numeric values are listed in the table below: Measure Value Numeric Value Available 100 Unavailable 0 Note: By default, this measure reports the Measure Values listed in the table above to indicate the current status of the service. In the graph of this measure however, the same is represented using the numeric equivalents only i.e., 0 or 100.
Processed requests	Indicates the number of requests that were processed during the last measurement period.	Number
Successful requests	Indicates the number of service requests that were successful during the last measurement period.	Number	A high value is desired for this measure.
Percentage of successful requests	Indicates the percentage of processed requests that were successful during the last measurement period.	Percent	A value close to 100 percent denotes that most of the requests were processed successfully.
Failed requests	Indicates the number of service requests that failed during the last measurement period.	Number	A high value is a cause of concern. Administrators must analyze why the requests are failing frequently and initiate troubleshooting measures at the earliest.
Percentage of failed requests	Indicates the percentage of processed requests that failed during the last measurement period.	Percent	A value close to 100 is a cause of concern. A sudden / gradual increase in the value of this measure warrants administrators to initiate troubleshooting at the earliest.
Successful requests per second	Indicates the rate at which the requests were processed successfully during the last measurement period.	Requests/sec