853 lines
26 KiB
HTML
853 lines
26 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
|
|
<title>Register Collector Data Category (QypsRegCollectorDataCategory)
|
|
API</title>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- All rights reserved. Licensed Materials Property of IBM -->
|
|
<!-- US Government Users Restricted Rights -->
|
|
<!-- Use, duplication or disclosure restricted by -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- GSA ADP Schedule Contract with IBM Corp. -->
|
|
<!-- Change History: -->
|
|
<!-- YYMMDD USERID Change description -->
|
|
<!-- created by janet brauckman on 23 nov 1999 -->
|
|
<!-- End Header Records -->
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
|
</head>
|
|
<body>
|
|
<a name="Top_Of_Page"></a>
|
|
<!--java sync-link-->
|
|
<script type="text/javascript" language="javascript" src="../rzahg/synch.js">
|
|
</script>
|
|
|
|
<h2>Register Collector Data Category (QypsRegCollectorDataCategory) API</h2>
|
|
|
|
<div class="box" style="width: 80%;">
|
|
<br>
|
|
Required Parameter Group:<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
<table width="100%">
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">1</td>
|
|
<td align="left" valign="top" width="50%">Collector name</td>
|
|
<td align="left" valign="top" width="20%">I</td>
|
|
<td align="left" valign="top" width="20%">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">2</td>
|
|
<td align="left" valign="top">Category name</td>
|
|
<td align="left" valign="top">I</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">3</td>
|
|
<td align="left" valign="top">Collector definition</td>
|
|
<td align="left" valign="top">I</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">CCSID</td>
|
|
<td align="left" valign="top">I</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">5</td>
|
|
<td align="left" valign="top">Data collection program attributes</td>
|
|
<td align="left" valign="top">I</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">6</td>
|
|
<td align="left" valign="top">Category attributes</td>
|
|
<td align="left" valign="top">I</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">7</td>
|
|
<td align="left" valign="top">Error Code</td>
|
|
<td align="left" valign="top">I/O</td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
Service Program Name: QYPSCOLL<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Default Public Authority: *EXCLUDE<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
Threadsafe: Yes<br>
|
|
<!-- iddvc RMBR -->
|
|
<br>
|
|
</div>
|
|
|
|
<p>The Register Collector Data Category (QypsRegCollectorDataCategory) API adds
|
|
a user-defined data category to one or more collector definitions of the
|
|
Collection Services function of Management Central.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Authorities and Locks</h3>
|
|
|
|
<dl>
|
|
<dt><em>API Public Authority</em></dt>
|
|
|
|
<dd>*EXCLUDE<br>
|
|
<br>
|
|
</dd>
|
|
</dl>
|
|
|
|
<p>API caller must have at least *USE authority to the user profile specified
|
|
in the Data collection program attributes parameter.</p>
|
|
|
|
<p>The user profile specified in the Data collection program attributes
|
|
parameter must have at least *USE authority to the specified job
|
|
description.</p>
|
|
|
|
<h3>Required Parameter Group</h3>
|
|
|
|
<dl>
|
|
<dt><strong>Collector name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The name of the collector where the user-defined data category will be
|
|
added. The only currently supported value is:<br>
|
|
<br>
|
|
</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*PFR</em></td>
|
|
<td align="left" valign="top">Performance Collector</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Category name</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The unique name of the user-defined data category. The category name must be
|
|
a valid *NAME (basic name) and all uppercase. See ELEM (Element) Statement in
|
|
CL Reference for more information about *NAME. Names of user-defined data
|
|
categories registered by IBM products start with "Q". Non-IBM applications are
|
|
discouraged from prefixing names of user-defined categories with "Q".</p>
|
|
</dd>
|
|
|
|
<dt><strong>Collector definition</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(10)
|
|
|
|
<p>The collector definition that the user-defined data category will be added
|
|
to. Only one collector definition may be specified. Specifying *STANDARD
|
|
registers the category to the *STANDARD, *STANDARDP and *CUSTOM definitions.
|
|
Specifying *STANDARDP registers the category to the *STANDARDP and *CUSTOM
|
|
definitions. Specifying *CUSTOM registers the category to the *CUSTOM
|
|
definition only. The possible values are:</p>
|
|
|
|
<ul>
|
|
<li>*CUSTOM</li>
|
|
|
|
<li>*STANDARD</li>
|
|
|
|
<li>*STANDARDP</li>
|
|
</ul>
|
|
</dd>
|
|
|
|
<dt><strong>CCSID</strong></dt>
|
|
|
|
<dd>INPUT; BINARY(4)
|
|
|
|
<p>The coded character set identifier (CCSID) for the user-defined data
|
|
category. Refer to specific field descriptions to determine where the CCSID is
|
|
applicable. The CCSID will be validated by the API. The default value is 0.</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Use the current job default CCSID.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>CCSID</em></td>
|
|
<td align="left" valign="top">A valid CCSID number. The valid range for this
|
|
parameter is 1 through 65533.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
</dd>
|
|
|
|
<dt><strong>Data collection program attributes</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)
|
|
|
|
<p>The attributes of the data collection program associated with the category.
|
|
For more information on the format of the attributes, see <a href=
|
|
"#FORMAT_DATA_COLLECTION">Format of Data Collection Program Attributes</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Category attributes</strong></dt>
|
|
|
|
<dd>INPUT; CHAR(*)<br>
|
|
<br>
|
|
|
|
|
|
<p>Additional attributes associated with the category. For more information on
|
|
the format of the category attributes, see <a href="#FORMAT_CATEGORY">Format of
|
|
Category Attributes</a>.</p>
|
|
</dd>
|
|
|
|
<dt><strong>Error code</strong></dt>
|
|
|
|
<dd>I/O; CHAR(*)
|
|
|
|
<p>The structure in which to return error information. For the format of the
|
|
structure, see <a href="../apiref/error.htm#hdrerrcod">Error Code Parameter</a>.</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="FORMAT_DATA_COLLECTION">Format of Data Collection Program
|
|
Attributes</a></h3>
|
|
|
|
<p>For detailed descriptions of the fields in this table, see <a href=
|
|
"#DATA_COLLECTION">Data Collection Program Attributes Field
|
|
Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
<td align="left" valign="top" width="60%">Size of fixed portion of
|
|
attributes</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
<td align="left" valign="top">Program type</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">14</td>
|
|
<td align="center" valign="top">E</td>
|
|
<td align="left" valign="top">Char(8)</td>
|
|
<td align="left" valign="top">Parameter format</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">22</td>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="left" valign="top">Char(10)</td>
|
|
<td align="left" valign="top">User profile</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">32</td>
|
|
<td align="center" valign="top">20</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
<td align="left" valign="top">Qualified job description name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">52</td>
|
|
<td align="center" valign="top">34</td>
|
|
<td align="left" valign="top">Char(20)</td>
|
|
<td align="left" valign="top">Qualified (service) program name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">72</td>
|
|
<td align="center" valign="top">48</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Size of work area</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">76</td>
|
|
<td align="center" valign="top">4C</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Offset to service program entry point name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">80</td>
|
|
<td align="center" valign="top">50</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Length of service program entry point name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">84</td>
|
|
<td align="center" valign="top">54</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Offset to Java class name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">88</td>
|
|
<td align="center" valign="top">58</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Length of Java class name</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">92</td>
|
|
<td align="center" valign="top">5C</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Offset to Java class path</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">96</td>
|
|
<td align="center" valign="top">60</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Length of Java class path</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">100</td>
|
|
<td align="center" valign="top">64</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Offset to category parameter string</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">104</td>
|
|
<td align="center" valign="top">68</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Length of category parameter string</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">108</td>
|
|
<td align="center" valign="top">6C</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Offset to Java options array</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">112</td>
|
|
<td align="center" valign="top">70</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Number of entries in Java options array</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">116</td>
|
|
<td align="center" valign="top">74</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="DATA_COLLECTION">Data Collection Program Attributes Field
|
|
Descriptions</a></h3>
|
|
|
|
<p><strong>Overview of Offset/Length usage of variable length character
|
|
data</strong> The variable length character data will follow the
|
|
fixed portion of the Data collection program attributes structure and reside
|
|
with the same address space. The offset to the variable length character data
|
|
specified in the fixed portion of the structure is the offset in bytes from the
|
|
beginning of the attribute structure to the first byte of the character
|
|
data.</p>
|
|
|
|
<p><strong>Length of category parameter string</strong> The length
|
|
of the string passed in for the category parameter string. If 0 is specified
|
|
then the null parameter string will be passed to the data collection
|
|
program.</p>
|
|
|
|
<p><strong>Length of Java class name</strong> The length of the
|
|
string passed in for the Java class name. This parameter must be set to 0 if
|
|
Program type is not *JVAPGM.</p>
|
|
|
|
<p><strong>Length of Java class path</strong> The length of the
|
|
string passed in for the Java class path. This parameter must be set to 0 if
|
|
Program type is not *JVAPGM.</p>
|
|
|
|
<p><strong>Length of service program entry point name</strong> The
|
|
length of the string passed in for the service program entry point name. This
|
|
parameter must be set to 0 if Program type is not *SRVPGM.</p>
|
|
|
|
<p><strong>Number of entries in Java Options Array</strong> The
|
|
number of entries in the Java Options Array (see Format of Java Options Array
|
|
below). If set to 0, no options will be passed to the Java Virtual Machine
|
|
(JVM). This parameter must be set to 0 if Program type is not *JVAPGM.</p>
|
|
|
|
<p><strong>Offset to category parameter string</strong> The offset
|
|
of the string passed in for the category parameter string. The category
|
|
parameter string is a character string which is passed to the data collection
|
|
program to customize its processing. The category parameter string must contain
|
|
character data. The CCSID is applicable to the category parameter string. If 0
|
|
is specified then a null parameter string will be passed to the data collection
|
|
program.</p>
|
|
|
|
<p><strong>Offset to Java class name</strong> The offset in bytes
|
|
to the string passed in for the Java class name. This parameter must be set to
|
|
0 if Program type is not *JVAPGM. The Java class name is the name of a Java
|
|
class which implements the data collection program interface for this category.
|
|
Refer to the Java section of the iSeries Information Center for more
|
|
information on Java class name format. The CCSID is applicable to the Java
|
|
class name.</p>
|
|
|
|
<p><strong>Offset to Java class path</strong> The offset in bytes
|
|
to the string passed in for the Java class path. This parameter must be set to
|
|
0 if Program type is not *JVAPGM. Refer to the Java section of the iSeries
|
|
Information Center for more information on the Java class path format. The
|
|
CCSID is applicable to the Java class path.</p>
|
|
|
|
<p><strong>Offset to Java options array</strong> The offset of the
|
|
Java Options Array (see Format of Java Options Array below). The Java Options
|
|
Array is an array of options passed to the JVM. If the offset is set to 0, no
|
|
options will be passed to the JVM. This parameter must be set to 0 if Program
|
|
type is not *JVAPGM. All options are character strings and the CCSID is
|
|
applicable to them.</p>
|
|
|
|
<p><strong>Offset to service program entry point name</strong> The
|
|
offset in bytes to the string passed in for the service program entry point
|
|
name. This parameter must be set to 0 if Program type is not *SRVPGM. The
|
|
service program entry point name is the name of an entry point in a service
|
|
program which implements the data collection program for this category.</p>
|
|
|
|
<p><strong>Parameter format</strong> This field defines the format
|
|
of the parameters passed to the data collection program when it is called by
|
|
Collection Services to collect data for the category. The only format currently
|
|
supported is PMDC0100.</p>
|
|
|
|
<p><strong>Qualified job description name</strong> The job
|
|
description which will be used by the Collection Services secondary job to run
|
|
the data collection program. The first 10 characters contain the job
|
|
description name and the next 10 characters contain the library name. The
|
|
following special values can be used for the job description name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="10 90" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*JOB</em></td>
|
|
<td align="left" valign="top">Use the job description associated with the
|
|
current job. The specified library parameter is ignored and must be filled with
|
|
blank spaces or hex zeros.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*USER</em></td>
|
|
<td align="left" valign="top">Use the job description associated with the
|
|
current user. The specified library parameter is ignored and must be filled
|
|
with blank spaces or hex zeros.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>The following special values can be used for the library name:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*CURLIB</em></td>
|
|
<td align="left" valign="top">The current library of the job executing this
|
|
API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">Search the library list to find the specified job
|
|
description.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Qualified (service) program name</strong> The qualified
|
|
name of a program object if Program type is *PGM or the qualified name of a
|
|
service program object if Program type is *SRVPGM. The first 10 characters
|
|
contain the program or service program name and the next 10 characters contain
|
|
the library name. This parameter must be set to 0 if Program type is
|
|
*JVAPGM.</p>
|
|
|
|
<p><strong>Size of fixed portion of attributes</strong> The size in
|
|
bytes of the fixed portion of the Data collection program attribute
|
|
structure.</p>
|
|
|
|
<p><strong>Size of work area</strong> The size in bytes of a work
|
|
area Collection Services will provide to the data collection program to save
|
|
state information between the calls. This parameter must be set to 0 if Program
|
|
type is *JVAPGM.</p>
|
|
|
|
<p><strong>User profile</strong> User profile which will be used by
|
|
Collection Services to run the data collection program. The API caller must
|
|
have at least *USE authority to this user profile.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Format of Java Options Array</h3>
|
|
|
|
<p>For detailed descriptions of the fields in this table, see <a href=
|
|
"#JAVA_OPTIONS">Java Options Array Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
<td align="left" valign="top" width="60%">Offset to Java option 1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Length of Java option 1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Offset to Java option 2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Length of Java option 2</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">...</td>
|
|
<td align="left" valign="top"> </td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
<td align="left" valign="top">Java option 1</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="center" valign="top"> </td>
|
|
<td align="left" valign="top">Char(*)</td>
|
|
<td align="left" valign="top">Java option 2</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
|
|
<p>The Java options array contains an array of option settings which will be
|
|
passed to the Java Virtual Machine (JVM) at Java initialization time. The
|
|
number of elements in this array is determined by the Number of entries in Java
|
|
options array field in the Data collection program attributes structure. This
|
|
array is optional and is ignored when Program type is not *JVAPGM.</p>
|
|
|
|
<p>Java options are not validated and are passed to the JVM exactly as
|
|
specified for the Registration API.</p>
|
|
|
|
<br>
|
|
<h3><a name="JAVA_OPTIONS">Java Options Array Field Descriptions</a></h3>
|
|
|
|
<p><strong>Length of Java option N</strong> </p>
|
|
|
|
<p>The length in bytes of the string passed in for the Nth Java option.</p>
|
|
|
|
<p><strong>Offset to Java option N</strong> </p>
|
|
|
|
<p>The offset in bytes from the beginning of the Java Options Array to the
|
|
string passed in for the Nth Java option. All Java options are character
|
|
strings and the CCSID applies to them.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3><a name="FORMAT_CATEGORY">Format of Category attributes</a></h3>
|
|
|
|
<p>For detailed descriptions of the fields in this table, see <a href=
|
|
"#CATEGORY_ATTRIBUTES">Category attributes Field Descriptions</a>.</p>
|
|
|
|
<table border width="80%">
|
|
<tr>
|
|
<th align="center" valign="bottom" colspan="2">Offset</th>
|
|
<th align="left" valign="bottom" rowspan="2">Type</th>
|
|
<th align="left" valign="bottom" rowspan="2">Field</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<th align="center" valign="bottom">Dec</th>
|
|
<th align="center" valign="bottom">Hex</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="center" valign="top" width="10%">0</td>
|
|
<td align="left" valign="top" width="20%">Binary(4)</td>
|
|
<td align="left" valign="top" width="60%">Size of attribute structure</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="center" valign="top">4</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Minimum collection interval</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="center" valign="top">8</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Maximum collection interval</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">12</td>
|
|
<td align="center" valign="top">C</td>
|
|
<td align="left" valign="top">Binary(4)</td>
|
|
<td align="left" valign="top">Default collection interval</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">16</td>
|
|
<td align="center" valign="top">10</td>
|
|
<td align="left" valign="top">Char(27)</td>
|
|
<td align="left" valign="top">Qualified message file and message
|
|
identifier</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">43</td>
|
|
<td align="center" valign="top">2B</td>
|
|
<td align="left" valign="top">Char(50)</td>
|
|
<td align="left" valign="top">Text description</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="center" valign="top">93</td>
|
|
<td align="center" valign="top">5D</td>
|
|
<td align="left" valign="top">Char(3)</td>
|
|
<td align="left" valign="top">Reserved</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
<br>
|
|
|
|
|
|
<h3><a name="CATEGORY_ATTRIBUTES">Category attributes Field
|
|
Descriptions</a></h3>
|
|
|
|
<p><strong>Default collection interval</strong> </p>
|
|
|
|
<p>The default interval to use when collecting data for a category in seconds.
|
|
This may be specified as one of 15, 30, 60, 300, 900, 1800, or 3600 seconds.
|
|
The following special value is allowed:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="5 95" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>0</em></td>
|
|
<td align="left" valign="top">Use the collector definition of the collector
|
|
that the category is registered to.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Minimum collection interval</strong> </p>
|
|
|
|
<p>The minimum interval this user-defined data category should be collected at.
|
|
In other words, this represents the smallest interval of data collection. This
|
|
may be specified as one of 15, 30, 60, 300, 900, 1800, or 3600 seconds.
|
|
Specifying 0 represents no restriction on the minimum collection interval.</p>
|
|
|
|
<p><strong>Maximum collection interval</strong> </p>
|
|
|
|
<p>The maximum interval this user-defined data category should be collected at.
|
|
In other words, this represents the largest interval of data collection. This
|
|
may be specified as one of 15, 30, 60, 300, 900, 1800, or 3600 seconds.
|
|
Specifying 0 represents no restriction on the maximum collection interval.</p>
|
|
|
|
<p><strong>Qualified message file and message
|
|
identifier</strong> </p>
|
|
|
|
<p>The qualified message file and message identifier of the text description of
|
|
the category. The first 10 characters contain the message file name, the next
|
|
10 characters contain the library name of the message file, and the final 7
|
|
characters contain the message identifier. If the text description is specified
|
|
as a character string (in Text description field), this field should be set to
|
|
all blanks or hex zeros. The possible values for the library are:</p>
|
|
|
|
<table cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<td align="left" valign="top"><em>*LIBL</em></td>
|
|
<td align="left" valign="top">Search the library list for the first occurrence
|
|
of the message file.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top"><em>Library name</em></td>
|
|
<td align="left" valign="top">The name of the library the message file resides
|
|
in.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><strong>Size of attribute structure</strong> </p>
|
|
|
|
<p>The size in bytes of the category attribute structure.</p>
|
|
|
|
<p><strong>Text description</strong> </p>
|
|
|
|
<p>The text description associated with the category. The supplied CCSID will
|
|
be applied to the text description. This parameter is ignored and must be
|
|
filled with blank spaces or hex zeros if a qualified message file and message
|
|
identifier has been specified.</p>
|
|
|
|
<br>
|
|
|
|
|
|
<h3>Error Messages</h3>
|
|
|
|
<table width="100%" cellpadding="5">
|
|
<!-- cols="15 85" -->
|
|
<tr>
|
|
<th align="left" valign="top">Message ID</th>
|
|
<th align="left" valign="top">Error Message Text</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td width="15%" valign="top">CPF24B4 E</td>
|
|
<td width="85%" valign="top">Severe error while addressing parameter list.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF222E E</td>
|
|
<td align="left" valign="top">&1 special authority is required.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C1E E</td>
|
|
<td align="left" valign="top">Required parameter &1 omitted.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3C3C E</td>
|
|
<td align="left" valign="top">Value for parameter &1 not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF1 E</td>
|
|
<td align="left" valign="top">Error code parameter not valid.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF3CF2 E</td>
|
|
<td align="left" valign="top">Error(s) occurred during running of &1
|
|
API.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9802 E</td>
|
|
<td align="left" valign="top">Not authorized to object &2 in &3.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9810 E</td>
|
|
<td align="left" valign="top">Library &1 not found.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPF9820 E</td>
|
|
<td align="left" valign="top">Not authorized to use library &1.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB537 E</td>
|
|
<td align="left" valign="top">Error found in parameter &1 at offset
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB538 E</td>
|
|
<td align="left" valign="top">Error found in parameter &1 at offset
|
|
&2.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB94C E</td>
|
|
<td align="left" valign="top">Collection interval value must be one of 15, 30,
|
|
60, 300, 900, 1800, or 3600 seconds.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td align="left" valign="top">CPFB94D E</td>
|
|
<td align="left" valign="top">Category name &1 aleady exists.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<br>
|
|
|
|
<hr>
|
|
<p>Introduced: V5R2</p>
|
|
|
|
<hr>
|
|
<table cellpadding="2" cellspacing="2" align="center">
|
|
<tr align="center">
|
|
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
|
|
"perfmgmt.htm">Performance Management</a> | <a href="aplist.htm">APIs by
|
|
category</a></td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|
|
|