Remove Collector Notification (QypsRmvCollectorNotification) API


  Required Parameter Group:

1 Collector name Input Char(10)
2 Qualified data queue name Input Char(20)
3 Notification type Input Binary(4)
4 Category list Input Array of Char(10)
5 Category count Input Binary(4)
6 Error Code I/O Char(*)

  Service Program Name: QYPSCOLL

  Default Public Authority: *EXCLUDE

  Threadsafe: Yes

The Remove Collector Notification (QypsRmvCollectorNotification) API removes a notification registration from a collector for a specified data queue and collection event. A collection event occurs when:


Authorities and Locks

API Public Authority
*EXCLUDE

Data Queue Authority
*CHANGE

Library Authority
*EXECUTE


Required Parameter Group

Collector name
INPUT; CHAR(10)

The name of the collector that is removing notification. One of these special values must be used:

*PFR Performance Collector

Qualified data queue name
INPUT; CHAR(20)

The data queue from which the notification is to be removed. The first ten characters contain the data queue name, and the second ten characters contain the data queue library name. The data queue must already exist. You can use these special values for the library name:

*CURLIB The job's current library.
*LIBL The library list.

Notification type
INPUT; BINARY(4)

The type of event notification to remove:

0 Collector - remove the cycle, end, and interval notifications.
1 Cycle - remove the collection cycle event notification.
2 End - remove notification of the end event.
3 Interval - remove notification of the default collection interval event.
4 Category - remove notification for the category event.

Category list
INPUT; ARRAY OF CHAR(10)

List of category names, for which notification is to be removed. This field is only applicable when Notification type is set to category notification (4). Category name can be a system-defined category name or a user-defined category name.

System-defined category name
A 10 character name of a system-defined category. For the *PFR collector system-defined categories are:



Registered user-defined category name
A 10 character name of a user-defined category registered by the Register Collector Data Category (QypsRegCollectorDataCategory) API.

Category count
INPUT; BINARY(4)

The number of categories entered in input field Category list. This field is only applicable when Notification type is set to category notification (4). Category count must have a value of '0' when Notification type is not a category notification (4).

Error code
I/O; CHAR(*)

The structure in which to return error information. For the format of the structure, see Error code parameter.


Error Messages

Message ID Error Message Text
CPF3C1E E Required parameter &1 omitted.
CPF3C3C E Value for parameter &1 not valid.
CPF3CF2 E Error(s) occurred during running of &1 API.
CPF9802 E Not authorized to object &2 in &3.
CPF9820 E Not authorized to use library &1.
CPFB94A E Collector communications error. Reason code &1.


API introduced: V5R2

[ Back to top | Performance Management | APIs by category ]