ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/QFVRTVCD.htm

966 lines
30 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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>Retrieve Change Request Description (QFVRTVCD) 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. -->
<!-- COMM4 SCRIPT A converted by B2H R4.1 (346) (CMS) by V2DCIJB at -->
<!-- RCHVMW2 on 1 Jun 1999 at 17:32:50 -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!--File Edited December, 2001 =========================================== -->
<!--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>Retrieve Change Request Description (QFVRTVCD) API</h2>
<div class="box" style="width: 80%;">
<br>
&nbsp;&nbsp;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%">Receiver variable</td>
<td align="left" valign="top" width="20%">Output</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of receiver variable</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Format</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(8)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Qualified change request description name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(20)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Activity name</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(10)</td>
</tr>
<tr>
<td align="center" valign="top">6</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>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Retrieve Change Request Description (QFVRTVCD) API retrieves either general change request description information, or information pertaining to a single activity within the change request description.</p>
<br>
<h3>Authorities and Locks</h3>
<dl>
<dt><em>Change request description authority</em></dt>
<dd>*USE</dd>
<dt><em>Change request description lock</em></dt>
<dd>*SHRRD</dd>
</dl>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Receiver variable</strong></dt>
<dd>OUTPUT; CHAR(*)
<p>The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold. See <a href="#TBLXXW1">Table 1</a> and <a href="#TBLXXW2">Table 2</a> for descriptions of the formats.</p>
</dd>
<dt><strong>Length of receiver variable</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.</p>
</dd>
<dt><strong>Format</strong></dt>
<dd>INPUT; CHAR(8)
<p>The format of the data to return. The possible formats are:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>CRQD0100</em></td>
<td valign="top">Returns general change request description information.</td>
</tr>
<tr>
<td align="left" valign="top"><em>CRQD0200</em></td>
<td valign="top">Returns specific activity information for the specified change request description.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Qualified change request description name</strong></dt>
<dd>INPUT; CHAR(20)
<p>The qualified name of the change request description to retrieve information for. The Format is:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>name</em></td>
<td valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="left" valign="top"><em>library</em></td>
<td valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="left" valign="top">&nbsp;</td>
<td valign="top">Possible values: *LIBL, *CURLIB, library name.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Activity name</strong></dt>
<dd>INPUT; CHAR(10)
<p>The name of the activity to retrieve information for. This is ignored when the format parameter is CRQD0100.</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>CRQD0100 Format</h3>
<p>See <a href="#HDRVFRTDF">Field Descriptions</a> for descriptions of the fields in this format.</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%">BIN(4)</td>
<td align="left" valign="top" width="60%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">8</td>
<td align="center" valign="top" width="10%">8</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Qualified change request description name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">18</td>
<td align="center" valign="top" width="10%">12</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Qualified change request description library name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">28</td>
<td align="center" valign="top" width="10%">1C</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Owner's profile</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">38</td>
<td align="center" valign="top" width="10%">26</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">User profile to run under</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">48</td>
<td align="center" valign="top" width="10%">30</td>
<td align="left" valign="top" width="20%">CHAR(6)</td>
<td align="left" valign="top" width="60%">Sequence number</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">54</td>
<td align="center" valign="top" width="10%">36</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Problem ID</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">64</td>
<td align="center" valign="top" width="10%">40</td>
<td align="left" valign="top" width="20%">CHAR(21)</td>
<td align="left" valign="top" width="60%">Problem origin</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">85</td>
<td align="center" valign="top" width="10%">55</td>
<td align="left" valign="top" width="20%">CHAR(50)</td>
<td align="left" valign="top" width="60%">Text description</td>
</tr>
</table>
<br><br>
<h3>CRQD0200 Format</h3>
<p>See <a href="#HDRVFRTDF">Field Descriptions</a> for descriptions of the
fields in this format.</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%">BIN(4)</td>
<td align="left" valign="top" width="60%">Bytes returned</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">4</td>
<td align="center" valign="top" width="10%">4</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Bytes available</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">8</td>
<td align="center" valign="top" width="10%">8</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Qualified change request description name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">18</td>
<td align="center" valign="top" width="10%">12</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Activity name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">28</td>
<td align="center" valign="top" width="10%">1C</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Qualified change request description library name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">38</td>
<td align="center" valign="top" width="10%">26</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Activity type</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">48</td>
<td align="center" valign="top" width="10%">30</td>
<td align="left" valign="top" width="20%">CHAR(40)</td>
<td align="left" valign="top" width="60%">Start time</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">88</td>
<td align="center" valign="top" width="10%">58</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Hold</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">98</td>
<td align="center" valign="top" width="10%">62</td>
<td align="left" valign="top" width="20%">CHAR(1)</td>
<td align="left" valign="top" width="60%">Destination of *LCL</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">99</td>
<td align="center" valign="top" width="10%">63</td>
<td align="left" valign="top" width="20%">CHAR(50)</td>
<td align="left" valign="top" width="60%">Activity text</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">149</td>
<td align="center" valign="top" width="10%">95</td>
<td align="left" valign="top" width="20%">CHAR(3)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">152</td>
<td align="center" valign="top" width="10%">98</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">CCSID of activity text description</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">156</td>
<td align="center" valign="top" width="10%">9C</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Offset to node list name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">160</td>
<td align="center" valign="top" width="10%">A0</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Number of nodes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">164</td>
<td align="center" valign="top" width="10%">A4</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Offset to destination nodes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">168</td>
<td align="center" valign="top" width="10%">A8</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Number of conditions</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">172</td>
<td align="center" valign="top" width="10%">AC</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Offset to conditions</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">176</td>
<td align="center" valign="top" width="10%">B0</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Length of function parameters.</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">180</td>
<td align="center" valign="top" width="10%">B4</td>
<td align="left" valign="top" width="20%">BIN(4)</td>
<td align="left" valign="top" width="60%">Offset to function parameters.</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">184</td>
<td align="center" valign="top" width="10%">B8</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="60%">Reserved</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">See note</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Node list name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">See note</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(10)</td>
<td align="left" valign="top" width="60%">Node list library name</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">See note</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">Array of CHAR(20)</td>
<td align="left" valign="top" width="60%">Destination nodes</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">See note</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">Array of CHAR(32)</td>
<td align="left" valign="top" width="60%">Conditions list</td>
</tr>
<tr>
<td align="center" valign="top" width="10%">See note</td>
<td align="center" valign="top" width="10%">&nbsp;</td>
<td align="left" valign="top" width="20%">CHAR(*)</td>
<td align="left" valign="top" width="60%">Function parameters</td>
</tr>
<tr>
<td align="left" valign="top" colspan="4"><strong>Note:</strong> The offset varies. This field is either optional or variable length. The offset is specified in a previous field. The data is left-justified with a blank pad at the end. The array of destination nodes and the array of conditions are returned in the same sequence they were entered.</td>
</tr>
</table>
<br><br>
<h3><a name="HDRVFRTDF">Field Descriptions</a></h3>
<p><strong>Activity name.</strong> The name of the activity for which information is retrieved.</p>
<p><strong>Activity text.</strong> The text description of the activity specified.</p>
<p><strong>Activity type.</strong> The name of the activity type for this activity.</p>
<p><strong>Bytes available.</strong> The number of bytes of data available to the calling program. The receiver variable could get this much data from this format if the receiver variable was this large or larger.</p>
<p><strong>Bytes returned.</strong> The number of bytes of data that were returned to the calling program in the receiver variable. If this value is smaller than bytes available, there was more data than there was room for.</p>
<p><strong>CCSID of activity text description.</strong> The coded character set identifies (CCSID) used for the activity text description.</p>
<p><strong>Conditions list.</strong> The list of conditions that must be met before the activity can run. This is an array of up to 5 elements. The number of elements is specified by the number of conditions field. There can be up to 5 elements. If this data is not present, number of conditions and offset to conditions is 0.</p>
<p>Each element has the following format:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>activity</em></td>
<td valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Activity name</em></td>
<td valign="top">Possible values are: *PRV, user specified name.</td>
</tr>
<tr>
<td align="left" valign="top"><em>relation</em></td>
<td valign="top">CHAR(3)
<p>The relational operator. Possible values are:</p>
<p>*EQ, *GT, *LT, *GE, *LE, *NE.</p></td>
</tr>
<tr>
<td align="left" valign="top"><em>reserved</em></td>
<td valign="top">CHAR(3)</td>
</tr>
<tr>
<td align="left" valign="top"><em>code</em></td>
<td valign="top">BIN(4)
<p>The end code of conditioning activity. Valid values are 0-99. The following special values are also supported:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>-1(*SUCCESS)</em></td>
<td valign="top">The end code is any value from 0-9</td>
</tr>
<tr>
<td align="left" valign="top"><em>-2(*FAIL)</em></td>
<td valign="top">The end code is any value from 10-89</td>
</tr>
<tr>
<td align="left" valign="top"><em>-3 (*NOTRUN)</em></td>
<td valign="top">The end code is any value from 90-99.</td>
</tr>
<tr>
<td align="left" valign="top"><em>-4 (*ANY)</em></td>
<td valign="top">The end code is any value from 0-99.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>mode</em></td>
<td valign="top">CHAR(10)
<p>Condition mode. Valid values are:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>*ALLNODES</em></td>
<td valign="top">All nodes of the conditioning activity must meet the completion criteria before this condition is considered met.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SAMENODE</em></td>
<td valign="top">Nodes of the conditioned activity need only wait for the same node of the conditioning activity to meet the completion criteria before this condition is considered met.</td>
</tr>
</table>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>reserved</em></td>
<td valign="top">CHAR(2).
<p>Reserved for boundary alignment.</p></td>
</tr>
</table>
<p><strong>Destination is *LCL.</strong> Whether the destination for this activity is the local system. Possible values are Y and N.</p>
<p><strong>Destination nodes.</strong> An array of elements. The number of elements is specified by the number of nodes field. There can be up to 50 elements. If number of nodes is 0, this field will not exist.</p>
<p>Each element has the following format:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Network ID</em></td>
<td valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Control point</em></td>
<td valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Reserved</em></td>
<td valign="top">CHAR(4)</td>
</tr>
</table>
<p><strong>Function parameters.</strong> The structure is defined by the calling program.</p>
<p><strong>Hold.</strong> Whether the activity is held when the change request is submitted. Possible values are:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*YES</em></td>
<td valign="top">The activity is held when the change request is submitted. The user must release the activity before it will run.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NO</em></td>
<td valign="top">The activity is not held when the change request is submitted.</td>
</tr>
</table>
<p><strong>Length of function parameters.</strong> The length of the function parameters.</p>
<p><strong>Node list name.</strong> The name of the node list. If no node list name exists, the offset to node list name is 0.</p>
<p><strong>Node list library name.</strong> The library name of the node list.</p>
<p><strong>Number of conditions.</strong> The number of conditions that must be satisfied before the activity can run. Possible values are 0 to 5. If no conditions are present, number of conditions and the offset to conditions are 0.</p>
<p><strong>Number of nodes.</strong> The number of nodes in the destination nodes field. The possible values are 1 to 50.</p>
<p><strong>Offset to conditions.</strong> If no conditions are present, number of conditions and the offset to conditions are 0.</p>
<p><strong>Offset to destination nodes.</strong> The offset to the list of destination nodes.</p>
<p><strong>Offset to function parameters.</strong> The offset to the function parameters.</p>
<p><strong>Offset to node list name.</strong> Offset to the node list name. If this is 0, the node list name is not present.</p>
<p><strong>Owner's profile.</strong> User profile that created the change request description object.</p>
<p><strong>Problem ID.</strong> The ID of the problem associated with the change request description retrieved.</p>
<p><strong>Problem origin.</strong> The origin system of the problem ID. The Format is:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>Origin type</em></td>
<td valign="top">CHAR(1)
<p>Currently, the only value supported is A, which indicates the transport type is APPN.</p></td>
</tr>
<tr>
<td align="left" valign="top"><em>Network ID</em></td>
<td valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Control point</em></td>
<td valign="top">CHAR(8)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Reserved</em></td>
<td valign="top">CHAR(4)</td>
</tr>
</table>
<p><strong>Qualified change request description name.</strong> The qualified name of the change request description object for which data is retrieved. The Format is:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>Name</em></td>
<td valign="top">CHAR(10)</td>
</tr>
<tr>
<td align="left" valign="top"><em>Library</em></td>
<td valign="top">CHAR(10)</td>
</tr>
</table>
<p><strong>Sequence number.</strong> The sequence number that is used to generate a generic activity name at the time an activity is added to the change request description.</p>
<p><strong>Start time.</strong> The date and time window during which this activity can be started. The current date and time values and next date values are determined when the change request is submitted. The format is:</p>
<table cellpadding="3">
<!-- cols="15 85" -->
<tr>
<td align="left" valign="top"><em>Start after time</em></td>
<td valign="top">CHAR(10)
<p>The time after which this activity may be started. Special values supported:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td valign="top">This activity may start any time on or after the time at which the change request was submitted.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td valign="top"><em>Start after date</em></td>
<td valign="top">CHAR(10)
<p>The date after which this activity may be started. Special values supported:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td valign="top">This activity may start on any date on or after the date on which the change request was submitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NEXT</em></td>
<td valign="top">This activity may start on any date after the date on which the change request was submitted.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>Start before time</em></td>
<td valign="top">CHAR(10)
<p>The time before which the activity must be started. If the activity cannot be started before this time then it is never started. Special values supported:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td valign="top">The activity may start any time on or after the start time.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td valign="top">The activity must start before the time the change request was submitted on the date specified on the start before date field.</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td align="left" valign="top"><em>Start before date</em></td>
<td valign="top">CHAR(10)
<p>The date before which the activity must be started. If the activity cannot be started by this date then it is never started. Special values supported:</p>
<table cellpadding="3">
<tr>
<td align="left" valign="top"><em>*ANY</em></td>
<td valign="top">The activity may start at any date on or after the start date.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*CURRENT</em></td>
<td valign="top">The activity must start on the date the change request
was submitted.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*NEXT</em></td>
<td valign="top">The activity must start by the day after the date the change request was submitted.</td>
</tr>
</table>
</td>
</tr>
</table>
<p>The format of time is HHMMSS, where:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>HH</em></td>
<td valign="top">Hour. Value: 00-23</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td valign="top">Minute. Value: 00-59</td>
</tr>
<tr>
<td align="left" valign="top"><em>SS</em></td>
<td valign="top">Second. Value: 00-59</td>
</tr>
</table>
<p>The format of date is CYYMMDD, where:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>C</em></td>
<td valign="top">Century, where 0 indicates years 19<em>xx</em> and 1 indicates years 20<em>xx</em>.</td>
</tr>
<tr>
<td align="left" valign="top"><em>YY</em></td>
<td valign="top">Year. Value: 00-99</td>
</tr>
<tr>
<td align="left" valign="top"><em>MM</em></td>
<td valign="top">Month. Value: 01-12</td>
</tr>
<tr>
<td align="left" valign="top"><em>DD</em></td>
<td valign="top">Day. Value: 01-31</td>
</tr>
</table>
<p><strong>Text description.</strong> Text description of the change request description specified.</p>
<p><strong>User profile to run under.</strong> Whether the authority checking done while this change request is running is based on the user who submitted the change request or the owner of the change request description. Possible values are:</p>
<table cellpadding="3">
<!-- cols="10 90" -->
<tr>
<td align="left" valign="top"><em>*OWNER</em></td>
<td valign="top">Change request runs under the user profile of the owner of the change request description.</td>
</tr>
<tr>
<td align="left" valign="top"><em>*SBM</em></td>
<td valign="top">Change request runs under the submitter of the change request.</td>
</tr>
</table>
<br><br>
<h3>Error Messages</h3>
<p>The following messages are possible as either escape messages or return codes.</p>
<table width="100%" cellpadding="3">
<!-- cols="15 85" -->
<tr>
<th align="left" valign="top">Message ID</th>
<th align="left" valign="top">Error Message Text</th>
</tr>
<tr>
<td align="left" valign="top">CPF2150 E</td>
<td valign="top">Object information function failed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF2151 E</td>
<td valign="top">Operation failed for &amp;2 in &amp;1 type *&amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF24B4 E</td>
<td valign="top">Severe error while addressing parameter list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C19 E</td>
<td valign="top">Error occurred with receiver variable specified.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C21 E</td>
<td valign="top">Format name &amp;1 is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C24 E</td>
<td valign="top">Length of the receiver variable is not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3C90 E</td>
<td valign="top">Literal value cannot be changed.</td>
</tr>
<tr>
<td align="left" valign="top">CPF3CF1 E</td>
<td valign="top">Error code parameter not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF8100 E</td>
<td valign="top">All CPF81xx messages could be returned. xx is from 01 to FF.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9693 E</td>
<td valign="top">Activity &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9694 E</td>
<td valign="top">Activity name required.</td>
</tr>
<tr>
<td align="left" valign="top">CPF969E E</td>
<td valign="top">Internal processing error occurred.</td>
</tr>
<tr>
<td align="left" valign="top">CPF96A2 E</td>
<td valign="top">CRQD library name &amp;1 not valid.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9801 E</td>
<td valign="top">Object &amp;2 in library &amp;3 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9802 E</td>
<td valign="top">Not authorized to object &amp;2 in &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9803 E</td>
<td valign="top">Cannot allocate object &amp;2 in library &amp;3.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9804 E</td>
<td valign="top">Object &amp;2 in library &amp;3 damaged.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9807 E</td>
<td valign="top">One or more libraries in library list deleted.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9808 E</td>
<td valign="top">Cannot allocate one or more libraries on library list.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9810 E</td>
<td valign="top">Library &amp;1 not found.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9820 E</td>
<td valign="top">Not authorized to use library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9830 E</td>
<td valign="top">Cannot assign library &amp;1.</td>
</tr>
<tr>
<td align="left" valign="top">CPF9872 E</td>
<td valign="top">Program or service program &amp;1 in library &amp;2 ended. Reason code &amp;3.</td>
</tr>
</table>
<br>
<hr>
API introduced: V3R1
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a
href="netmg.htm">Network Management APIs</a> | <a href="aplist.htm">APIs
by category</a></td>
</tr>
</table>
</center>
</body>
</html>