Remove Collector Notification (QypsRmvCollectorNotification) API

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:

• The collector cycle interval is reached.
• The collector is ended or stopped.
• The default data collection interval is reached.
• The category data collection interval is reached.

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:

• *APPN
• *CMNBASE
• *CMNSAP
• *CMNSTN
• *DISK
• *HDWCFG
• *IOPBASE
• *IPCS
• *JOBMI
• *JOBOS
• *LCLRSP
• *POOL
• *POOLTUNE
• *SNA
• *SNADS
• *SUBSYSTEM
• *SYSBUS
• *SYSCPU
• *SYSLVL
• *TCPBASE
• *TCPIFC
• *USRTNS

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