friedkiwi/ibm-information-center
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzaie_5.4.0.1/rzaieapi_qzhtrtvtcmtriggerhandlerdesc.htm

664 lines
31 KiB
HTML
Raw Permalink Normal View History

Add readme and dist folders
2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="topic" />
<meta name="DC.Title" content="Retrieve Triggered Cache Manager Trigger Handler Description (QzhtRtvTCMTriggerHandlerDesc) API" />
<meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rzaieapi_qzhtrtvtcmtriggerhandlerdesc" />
<meta name="DC.Language" content="en-us" />
<!-- 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. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Retrieve Triggered Cache Manager Trigger Handler Description (QzhtRtvTCMTriggerHandlerDesc)
API</title>
</head>
<body id="rzaieapi_qzhtrtvtcmtriggerhandlerdesc"><a name="rzaieapi_qzhtrtvtcmtriggerhandlerdesc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Retrieve Triggered Cache Manager Trigger Handler Description (QzhtRtvTCMTriggerHandlerDesc)
API</h1>
<div><div class="important"><span class="importanttitle">Important:</span> Information
for this topic supports the latest PTF levels for HTTP Server for i5/OS .
It is recommended that you install the latest PTFs to upgrade to the latest
level of the HTTP Server for i5/OS. Some of the topics documented here are
not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" class="figborder" frame="void" border="0" rules="none"><tbody><tr><td colspan="4" valign="top">Required Parameter Group:</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">1</td>
<td valign="top" width="31.313131313131315%">receiver variable</td>
<td valign="top" width="31.060606060606062%">Output</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">2</td>
<td valign="top" width="31.313131313131315%">length of receiver variable</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Binary(4)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">3</td>
<td valign="top" width="31.313131313131315%">receiver variable format</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(8)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">4</td>
<td valign="top" width="31.313131313131315%">server name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">5</td>
<td valign="top" width="31.313131313131315%">description name</td>
<td valign="top" width="31.060606060606062%">Input</td>
<td valign="top" width="31.313131313131315%">Char(32)</td>
</tr>
<tr><td align="right" valign="top" width="6.313131313131313%">6</td>
<td valign="top" width="31.313131313131315%">error code</td>
<td valign="top" width="31.060606060606062%">I/O</td>
<td valign="top" width="31.313131313131315%">Char(*)</td>
</tr>
<tr><td colspan="4" valign="top">Library Name/Service Program: QTCM/QZHTINCONF</td>
</tr>
<tr><td colspan="4" valign="top">Threadsafe: Yes</td>
</tr>
</tbody>
</table>
</div>
<p>Use the QzhtRtvTCMTriggerHandlerDesc API to retrieve information from trigger
handlers associated with triggered cache manager servers. The API is a callable
service implemented as an ILE entry point within the QZHTINCONF *SRVPGM in
the QTCM *LIB. </p>
<p>The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.</p>
</div>
<div class="nested1" id="authoritylocks"><a name="authoritylocks"><!-- --></a><h2 class="topictitle2">Authorities and locks</h2>
<div><ul><li>*IOSYSCFG special authority</li>
</ul>
</div>
</div>
<div class="nested1" id="required"><a name="required"><!-- --></a><h2 class="topictitle2">Required parameter group</h2>
<div><dl><dt class="dlterm"><strong>receiver variable</strong></dt>
<dd>OUTPUT: CHAR(*) <p>The variable used to return trigger handler description
information.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>length of receiver variable</strong></dt>
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
for Receiver variable. This value must be greater than or equal to 8.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>receiver variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of Receiver variable data. The following
values must be used:</p>
<ul><li>THDG0100: Basic information format for a trigger handler description.</li>
<li>THDG0200: Detailed information format for an *UPDATE type trigger handler
description.</li>
<li>THDG0300: Detailed information format for a *PUBLISH type trigger handler
description.</li>
</ul>
</dd>
</dl>
<dl><dt class="dlterm"><strong>server name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify the server for which information
is retrieved (left justified and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>description name</strong></dt>
<dd>INPUT: CHAR(32) <p>The name used to identify which trigger handler description
information is retrieved (left justified and padded with blanks if necessary).</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>error code</strong></dt>
<dd>I/O: CHAR(*) <p>The structure in which to return error information.</p>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="thdg0100_format"><a name="thdg0100_format"><!-- --></a><h2 class="topictitle2">THDG0100 format</h2>
<div><div class="p">When the trigger handler description type is unknown, use the THDG0100
format and the basic information (including trigger handler type) is returned.
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e181">Offset</th>
<th rowspan="2" valign="top" id="d0e183">Type</th>
<th rowspan="2" valign="top" id="d0e185">Field</th>
</tr>
<tr><th valign="top" id="d0e188">Dec</th>
<th valign="top" id="d0e190">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e181 d0e188 ">0</td>
<td valign="top" headers="d0e181 d0e190 ">0</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Bytes returned</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">4</td>
<td valign="top" headers="d0e181 d0e190 ">4</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Bytes available</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">8</td>
<td valign="top" headers="d0e181 d0e190 ">8</td>
<td valign="top" headers="d0e183 ">Char(32)</td>
<td valign="top" headers="d0e185 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">40</td>
<td valign="top" headers="d0e181 d0e190 ">28</td>
<td valign="top" headers="d0e183 ">Char(32)</td>
<td valign="top" headers="d0e185 ">Trigger handler description name</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">72</td>
<td valign="top" headers="d0e181 d0e190 ">48</td>
<td valign="top" headers="d0e183 ">Char(10)</td>
<td valign="top" headers="d0e185 ">Trigger handler type</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">82</td>
<td valign="top" headers="d0e181 d0e190 ">52</td>
<td valign="top" headers="d0e183 ">Char(2)</td>
<td valign="top" headers="d0e185 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">84</td>
<td valign="top" headers="d0e181 d0e190 ">54</td>
<td valign="top" headers="d0e183 ">Char(32)</td>
<td valign="top" headers="d0e185 ">Data source</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">116</td>
<td valign="top" headers="d0e181 d0e190 ">74</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">offset to cache targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">120</td>
<td valign="top" headers="d0e181 d0e190 ">78</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Length of cache targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">124</td>
<td valign="top" headers="d0e181 d0e190 ">7C</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Offset to ack targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">128</td>
<td valign="top" headers="d0e181 d0e190 ">80</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Length of ack targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">132</td>
<td valign="top" headers="d0e181 d0e190 ">84</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Offset to nack targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">136</td>
<td valign="top" headers="d0e181 d0e190 ">88</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Length of nack targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">140</td>
<td valign="top" headers="d0e181 d0e190 ">8C</td>
<td valign="top" headers="d0e183 ">Binary(4)</td>
<td valign="top" headers="d0e185 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">&nbsp;</td>
<td valign="top" headers="d0e181 d0e190 ">&nbsp;</td>
<td valign="top" headers="d0e183 ">Char(*)</td>
<td valign="top" headers="d0e185 ">Cache targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">&nbsp;</td>
<td valign="top" headers="d0e181 d0e190 ">&nbsp;</td>
<td valign="top" headers="d0e183 ">Char(*)</td>
<td valign="top" headers="d0e185 ">Ack targets</td>
</tr>
<tr><td valign="top" headers="d0e181 d0e188 ">&nbsp;</td>
<td valign="top" headers="d0e181 d0e190 ">&nbsp;</td>
<td valign="top" headers="d0e183 ">Char(*)</td>
<td valign="top" headers="d0e185 ">Nack targets</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="nested1" id="thdg0100_field_descriptions"><a name="thdg0100_field_descriptions"><!-- --></a><h2 class="topictitle2">THDG0100 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Ack targets</strong></dt>
<dd>A list of acknowledgment target descriptions referenced by the new trigger
handler description and used, at server startup, to obtain information as
to where successful process completion messages are sent. Descriptions must
be listed by name, where each name is separated by one or more spaces (left
justified and padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> If a null list is returned,
Offset to ack targets must equal 0 (QZHT_NONE), indicating no acknowledgment
target descriptions are currently referenced. Messages concerning successful
process completion of triggers referencing this handler are sent to all listed
acknowledgment targets.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Bytes available</strong></dt>
<dd>The number of information bytes available for return to the caller of
the API.<div class="note"><span class="notetitle">Note:</span> If this value is greater than the value of Bytes returned, the
receiver was not large enough to return all information.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Bytes returned</strong></dt>
<dd>The number of information bytes returned to the caller of the API.</dd>
</dl>
<dl><dt class="dlterm"><strong>Cache targets</strong></dt>
<dd>The list of cache target descriptions referenced by the trigger handler
descriptions and used, at server startup, to obtain information about the
cache targets to which the trigger handler sends data. Returned descriptions
must be listed by name, where each name is separated by one or more spaces,
left justified, and padded with blanks if necessary.<div class="note"><span class="notetitle">Note:</span> If a null list is
returned, Offset to cache targets must equal 0 (QZHT_NONE), indicating no
cache target descriptions are currently referenced. Data processed by this
trigger handler is sent to all listed cache targets.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Data source</strong></dt>
<dd>The name of a data source description referenced by the new trigger handler
description and used, at server startup, to obtain information about the data
source from which the trigger handler retrieves data. The value must be a
data source description name (left justified and padded with blanks if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of ack targets</strong></dt>
<dd>The length of the information returned for the Ack targets entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of cache targets</strong></dt>
<dd>The length of the information returned for the Cache targets entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of nack targets</strong></dt>
<dd>The length of the information returned for the Nack targets entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Nack targets</strong></dt>
<dd>The list of acknowledgment target descriptions referenced by the new trigger
handler description and used, at server startup, to obtain information as
to where failed process completion messages are sent. Descriptions must be
listed by name, where each name is separated by one or more spaces, left justified,
and padded with blanks if necessary.<div class="note"><span class="notetitle">Note:</span> If a null list is specified, Offset
to nack targets must equal 0 (QZHT_NONE), indicating no acknowledgment target
descriptions are currently referenced. Messages concerning failed trigger
processes, referencing this handler, are sent to all listed acknowledgment
targets.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Number of threads</strong></dt>
<dd>The number of concurrent threads the triggered cache manager server spawns
when processing triggers that are sent to this trigger handler. The value
must be greater that 0 and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>).</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to ack targets</strong></dt>
<dd>The offset from the beginning of the receiver variable to the Ack targets
data, in bytes. The value must be greater than 0, or equal to one of the special
values described below. <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NONE: A null list is specified for Ack targets
indicating no acknowledgment target descriptions are currently referenced.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to cache targets</strong></dt>
<dd>The offset from the beginning of the receiver variable to the Cache targets
data, in bytes. The value must be greater than 0, or equal to one of the special
values described below. <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NONE: A null list is specified for Cache targets
indicating no cache target descriptions are currently referenced.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to nack targets</strong></dt>
<dd>The offset from the beginning of the receiver variable to the Nack targets
data, in bytes. The value must be greater than 0, or equal to one of the special
values described below. <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NONE: A null list is specified for Nack targets
indicating no acknowledgment target descriptions are currently referenced.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name used to identify the triggered cache manager server for which
the description is associated (left justified and padded with blanks if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Trigger handler description name</strong></dt>
<dd>The name of the trigger handler description (left justified and padded
with blanks if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Trigger handler type</strong></dt>
<dd>The trigger handler description type (left justified and padded with blanks
if necessary). The value must be one of the special values described below. <p>Special
values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*UPDATE</strong></dt>
<dd>QZHT_UPDATE_TYPE</dd>
</dl>
<dl><dt class="dlterm"><strong>*PUBLISH</strong></dt>
<dd>QZHT_PUBLISH_TYPE</dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="thdg0200_format"><a name="thdg0200_format"><!-- --></a><h2 class="topictitle2">THDG0200 format</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><thead align="left"><tr><th colspan="2" valign="top" id="d0e537">Offset</th>
<th rowspan="2" valign="top" id="d0e539">Type</th>
<th rowspan="2" valign="top" id="d0e541">Field</th>
</tr>
<tr><th valign="top" id="d0e544">Dec</th>
<th valign="top" id="d0e546">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e537 d0e544 ">0</td>
<td valign="top" headers="d0e537 d0e546 ">0</td>
<td valign="top" headers="d0e539 ">&nbsp;</td>
<td valign="top" headers="d0e541 ">Everything from THDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e537 d0e544 ">144</td>
<td valign="top" headers="d0e537 d0e546 ">90</td>
<td valign="top" headers="d0e539 ">Binary(4)</td>
<td valign="top" headers="d0e541 ">Cache request queue priority</td>
</tr>
<tr><td valign="top" headers="d0e537 d0e544 ">148</td>
<td valign="top" headers="d0e537 d0e546 ">94</td>
<td valign="top" headers="d0e539 ">Binary(4)</td>
<td valign="top" headers="d0e541 ">Trigger queue collapse policy</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="thdg0200_field_description"><a name="thdg0200_field_description"><!-- --></a><h2 class="topictitle2">THDG0200 format field description</h2>
<div><dl><dt class="dlterm"><strong>Cache request queue priority</strong></dt>
<dd>Specifies the trigger handler priority value when submitting requests
to the cache targets. Lower values indicate higher priority. The value must
be greater that 0 and less than 2<sup>31</sup> (or 2.147x10<sup>9</sup>).<div class="note"><span class="notetitle">Note:</span> Triggered
cache manager servers queue the trigger handler requests to the cache targets
and process them according to queue priority. Requests from trigger handlers
with higher priority are processed before requests from trigger handlers with
lower priority. The trigger handler queue priority can be changed while servers
are active by using the <em>-chspriority</em> command in a trigger message.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Trigger queue collapse policy</strong></dt>
<dd>Specifies if identical triggers waiting on the request queue, for this
trigger handler, are collapsed. The value must equal one of the special values
described below. <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>1</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Identical triggers,
waiting on the request queue for this trigger, are collapsed.</td>
</tr>
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Identical triggers
are not collapsed.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> Only triggers using the <em>-objects</em> keyword can be collapsed.
Identical triggers are those having an identical set of listed objects. The
order of the listed objects is not important. Once a trigger handler begins
processing a trigger, it is not collapsed.</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="thdg0300_format"><a name="thdg0300_format"><!-- --></a><h2 class="topictitle2">THDG0300 format</h2>
<div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top">Offset</td>
<td valign="top">&nbsp;</td>
<td valign="top">Type</td>
<td valign="top">Field</td>
</tr>
<tr><td valign="top">Dec</td>
<td valign="top">Hex</td>
<td valign="top">&nbsp;</td>
<td valign="top">&nbsp;</td>
</tr>
<tr><td valign="top">0</td>
<td valign="top">0</td>
<td valign="top">&nbsp;</td>
<td valign="top">Everything from THDP0100 format</td>
</tr>
<tr><td valign="top">14</td>
<td valign="top">90</td>
<td valign="top">Char(32)</td>
<td valign="top">Object dependency graph</td>
</tr>
<tr><td valign="top">176</td>
<td valign="top">B0</td>
<td valign="top">Char(32)</td>
<td valign="top">Rule set</td>
</tr>
<tr><td valign="top">208</td>
<td valign="top">D0</td>
<td valign="top">Binary(4)</td>
<td valign="top">Offset to traversal edge name</td>
</tr>
<tr><td valign="top">212</td>
<td valign="top">D4</td>
<td valign="top">Binary(4)</td>
<td valign="top">Length of traversal edge name</td>
</tr>
<tr><td valign="top">216</td>
<td valign="top">D8</td>
<td valign="top">Binary(4)</td>
<td valign="top">Offset to default included file</td>
</tr>
<tr><td valign="top">220</td>
<td valign="top">DC</td>
<td valign="top">Binary(4)</td>
<td valign="top">Length of default included file</td>
</tr>
<tr><td valign="top">224</td>
<td valign="top">E0</td>
<td valign="top">Binary(4)</td>
<td valign="top">Include dependency information</td>
</tr>
<tr><td valign="top">228</td>
<td valign="top">E4</td>
<td valign="top">Binary(4)</td>
<td valign="top">Include triggered file information</td>
</tr>
<tr><td valign="top">22C</td>
<td valign="top">E8</td>
<td valign="top">Binary(4)</td>
<td valign="top">Include cached file information</td>
</tr>
<tr><td valign="top">&nbsp;</td>
<td valign="top">&nbsp;</td>
<td valign="top">Char(*)</td>
<td valign="top">Traversal edge type</td>
</tr>
<tr><td valign="top">&nbsp;</td>
<td valign="top">&nbsp;</td>
<td valign="top">Char(*)</td>
<td valign="top">Default included file</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="thdg0300_field_descriptions"><a name="thdg0300_field_descriptions"><!-- --></a><h2 class="topictitle2">THDG0300 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Default included file</strong></dt>
<dd>The name of a file the trigger handler includes, by global default, as
a replacement for included files that have not been triggered (when a local
default file is not specified or available). The file name must be left justified
and padded with blanks if necessary.<div class="note"><span class="notetitle">Note:</span> If the value is null, Offset to
default included file must equal 0 (QZHT_NONE), indicating that a global default
file name is not specified for this trigger handler description. The file
specified as a global default must be triggered (at runtime) before it can
be used.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Include cached file information</strong></dt>
<dd>Specifies if a list of names for all files sent to cache targets, as a
result of handling original trigger requests, is included in successful process
completion messages. The value must equal one of the special values described
below. <p>Special values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>1</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: A list of names is
included.</td>
</tr>
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: A list of names
is not included.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Include dependency information</strong></dt>
<dd>Specifies if information concerning all dependent files, assembled into
triggered files as a result of handling original trigger request, is included
in successful process completion messages. The value must equal one of the
special values described below. <p>Special values and their meanings are as
follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>1</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Information is included.</td>
</tr>
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Information is not
included.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Include triggered file information</strong></dt>
<dd>Specifies if a list of names for all files triggered, as a result of handling
original trigger requests, is included in successful process completion messages.
The value must equal one of the special values described below. <p>Special
values and their meanings are as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>1</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: A list of names is
included.</td>
</tr>
<tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: A list of names
is not included.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of default included file</strong></dt>
<dd>The length of information for the Default included file entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of traversal edge type</strong></dt>
<dd>The length of the information returned for the Traversal edge type entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Object dependency graph</strong></dt>
<dd>The name of an object dependency graph description referenced by the trigger
handler description and used, at server startup, to identify which object
dependency graph is used by the handler to record and obtain object dependency
information. The value must be an object dependency graph description name
(left justified and padded with blanks if necessary).</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to default included file</strong></dt>
<dd>The offset from the beginning of the request variable to the Default included
file data, in bytes. The value must be greater than 0, or equal to one of
the special values described below.<p>Special values and their meanings are
as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="border" border="1" rules="all"><tbody><tr><td valign="top" width="15.228426395939088%"><strong>0</strong></td>
<td valign="top" width="84.77157360406092%">QZHT_NONE: The value is null for Default included file.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to traversal edge type</strong></dt>
<dd>The offset from the beginning of the request variable to the Traversal
edge type data, in bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Rule set</strong></dt>
<dd>The name of a rule set referenced by the trigger handler description and
used, at server startup, to identify which publishing rules are used by the
handler. The value must be a rule set name, or one of the special values described
below (left justified and padded with blanks if necessary). <p>Special values
and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*NONE</strong></dt>
<dd>QZHT_NONE_CHAR: No rule set is referenced by the trigger handler.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> Triggers that specify files that do not match any publishing
rules, in the specified rule set, are processed according to the default publishing
rule. That is, they are read from the data source and sent to all cache targets
(they are not parsed). An empty rule set has the same affect as not specifying
a rule set at all.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Traversal edge type</strong></dt>
<dd>The name of an object dependency graph (ODG) edge type used by the trigger
handler to determine object dependencies when assembling files. The edge type
name must be left justified and padded with blanks if necessary.<div class="note"><span class="notetitle">Note:</span> Only
edges of the specified type are traversed by this trigger handler to determine
object dependencies.</div>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="error"><a name="error"><!-- --></a><h2 class="topictitle2">Error messages</h2>
<div><dl><dt class="dlterm"><strong>TCM7001 E</strong></dt>
<dd>User &amp;1 is not authorized.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7030 E</strong></dt>
<dd>Severe error occurred while addressing parameter list.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7032 E</strong></dt>
<dd>Receiver variable format is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7034 E</strong></dt>
<dd>Length of receiver variable is not valid for the specified format.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7035 E</strong></dt>
<dd>Server parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7036 E</strong></dt>
<dd>Description parameter is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM703E E</strong></dt>
<dd>Error code parameter is not valid</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM70F0 E</strong></dt>
<dd>Unknown error occurred while processing request.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7101 E</strong></dt>
<dd>User QTCM is not authorized to the configuration file for triggered cache
manager server &amp;1.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7190 E</strong></dt>
<dd>A configuration file for triggered cache manager server &amp;1 was not
found.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7290 E</strong></dt>
<dd>A &amp;1 and &amp;2 was not found for triggered cache manager server &amp;3.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink