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

765 lines
38 KiB
HTML
Raw Blame History

<?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="Add Triggered Cache Manager Trigger Handler Description (QzhtAddTCMTriggerHandlerDesc) 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_qzhtaddtcmtriggerhandlerdesc" />
<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>Add Triggered Cache Manager Trigger Handler Description (QzhtAddTCMTriggerHandlerDesc)
API</title>
</head>
<body id="rzaieapi_qzhtaddtcmtriggerhandlerdesc"><a name="rzaieapi_qzhtaddtcmtriggerhandlerdesc"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<!--Java sync-link--><h1 class="topictitle1">Add Triggered Cache Manager Trigger Handler Description (QzhtAddTCMTriggerHandlerDesc)
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%">request variable</td>
<td valign="top" width="31.060606060606062%">Input</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 request 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%">request 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%">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 QzhtAddTCMTriggerHandlerDesc API to add new trigger handler descriptions
to the configurations of triggered cache manager servers. New trigger handler
descriptions are utilized by the triggered cache manager servers after they
are restarted. 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>request variable</strong></dt>
<dd>INPUT: CHAR(*) <p>The variable used to pass the information used to add
a new trigger handler description.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>length of request variable</strong></dt>
<dd>INPUT: BINARY(4) <p>The number of bytes that the calling program provides
for Request variable.</p>
</dd>
</dl>
<dl><dt class="dlterm"><strong>request variable format</strong></dt>
<dd>INPUT: CHAR(8) <p>The format name of the Request variable data. The following
values must be used:</p>
<ul><li>THDP0100: Basic information format for a trigger handler description.</li>
<li>THDP0200: Detailed information format for an *UPDATE type trigger handler
description.</li>
<li>THDP0300: Detailed information format for a *PUBLISH type trigger handler
description.</li>
</ul>
</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="thdp0100_format"><a name="thdp0100_format"><!-- --></a><h2 class="topictitle2">THDP0100 format</h2>
<div><div class="note"><span class="notetitle">Note:</span> When using this format, trigger handler description are added using
default values for all unspecified values (according to the type specified
by <em>Trigger handler type</em>). See other trigger handler description formats
for details regarding these default values.</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="d0e148">Offset</th>
<th rowspan="2" valign="top" id="d0e150">Type</th>
<th rowspan="2" valign="top" id="d0e152">Field</th>
</tr>
<tr><th valign="top" id="d0e155">Dec</th>
<th valign="top" id="d0e157">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e148 d0e155 ">0</td>
<td valign="top" headers="d0e148 d0e157 ">0</td>
<td valign="top" headers="d0e150 ">Char(32)</td>
<td valign="top" headers="d0e152 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">32</td>
<td valign="top" headers="d0e148 d0e157 ">20</td>
<td valign="top" headers="d0e150 ">Char(32)</td>
<td valign="top" headers="d0e152 ">Trigger handler description name</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">64</td>
<td valign="top" headers="d0e148 d0e157 ">40</td>
<td valign="top" headers="d0e150 ">Char(10)</td>
<td valign="top" headers="d0e152 ">Trigger handler type</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">74</td>
<td valign="top" headers="d0e148 d0e157 ">4A</td>
<td valign="top" headers="d0e150 ">Char(2)</td>
<td valign="top" headers="d0e152 ">Reserved</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">76</td>
<td valign="top" headers="d0e148 d0e157 ">4C</td>
<td valign="top" headers="d0e150 ">Char(32)</td>
<td valign="top" headers="d0e152 ">Data source</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">108</td>
<td valign="top" headers="d0e148 d0e157 ">6C</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Offset to cache targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">112</td>
<td valign="top" headers="d0e148 d0e157 ">70</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Length of cache targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">116</td>
<td valign="top" headers="d0e148 d0e157 ">74</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Offset to ack targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">120</td>
<td valign="top" headers="d0e148 d0e157 ">78</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Length of ack targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">124</td>
<td valign="top" headers="d0e148 d0e157 ">7C</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Offset to nack targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">128</td>
<td valign="top" headers="d0e148 d0e157 ">80</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Length of nack targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">132</td>
<td valign="top" headers="d0e148 d0e157 ">84</td>
<td valign="top" headers="d0e150 ">Binary(4)</td>
<td valign="top" headers="d0e152 ">Number of threads</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">&nbsp;</td>
<td valign="top" headers="d0e148 d0e157 ">&nbsp;</td>
<td valign="top" headers="d0e150 ">Char(*)</td>
<td valign="top" headers="d0e152 ">Cache targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">&nbsp;</td>
<td valign="top" headers="d0e148 d0e157 ">&nbsp;</td>
<td valign="top" headers="d0e150 ">Char(*)</td>
<td valign="top" headers="d0e152 ">Ack targets</td>
</tr>
<tr><td valign="top" headers="d0e148 d0e155 ">&nbsp;</td>
<td valign="top" headers="d0e148 d0e157 ">&nbsp;</td>
<td valign="top" headers="d0e150 ">Char(*)</td>
<td valign="top" headers="d0e152 ">Nack targets</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="thdp0100_field_descriptions"><a name="thdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">THDP0100 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>Ack targets</strong></dt>
<dd>A list of acknowledgment target descriptions associated with the triggered
cache manager server referenced by the new trigger handler description and
used later, 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, and padded with blanks
if necessary. The default setting is to reference the descriptions currently
designated as default acknowledgment target descriptions for the triggered
cache manager server. If there are no descriptions currently designated as
default, a null list is used. A null list indicates successful process completion
messages are not sent.<div class="note"><span class="notetitle">Note:</span> If a null list is specified, Offset to ack targets
must equal 0 (QZHT_NONE), or -1 (QZHT_DEFAULT). See Offset to ack targets
for more details. Messages concerning successful process completion of triggers
referencing this handler are sent to all listed acknowledgment targets. An
escape message is sent if any referenced description does not currently exist.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Cache targets</strong></dt>
<dd>A list of cache target descriptions associated with the triggered cache
manager server referenced by the new trigger handler description and used
later, at server startup, to obtain information about the cache targets to
which the trigger handler sends data. Descriptions must be listed by name,
where each name is separated by one or more spaces, and padded with blanks
if necessary. The default setting is to reference the descriptions currently
designated as default cache target descriptions for the triggered cache manager
server. If there are no descriptions currently designated as default, a null
list is used. A null list indicates data is not sent to cache targets.<div class="note"><span class="notetitle">Note:</span> If
a null list is specified, Offset to ack targets must equal 0 (QZHT_NONE),
or -1 (QZHT_DEFAULT). See Offset to ack targets for more details. Data processed
by this trigger handler is sent to all listed cache targets. An escape message
is sent if any referenced description does not currently exist.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Data source</strong></dt>
<dd>The name of a data source description associated with the triggered cache
manager server referenced by the new trigger handler description and used
later, at server startup, to obtain information about the data source from
which the trigger handler receives data. The value must be a data source description
name, or one of the special values described below (left justified and padded
with blanks if necessary). The default setting references the description
currently designated as the default data source description for the triggered
cache manager server.<p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
<dd>QZHT_DEFAULT_CHAR: The default value is referenced.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if the referenced description
does not currently exist, or if *DEFAULT is specified and there is currently
no default data source description for the server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of ack targets</strong></dt>
<dd>The length of the information for the Ack targets entry.<div class="note"><span class="notetitle">Note:</span> If <em>Offset
to ack targets</em> equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT), this value
must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of cache targets</strong></dt>
<dd>The length of the information for the Cache targets entry.<div class="note"><span class="notetitle">Note:</span> If Offset
to cache targets equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT), this value must
equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of nack targets</strong></dt>
<dd>The length of the information for the Nack targets entry.<div class="note"><span class="notetitle">Note:</span> If Offset
to nack targets equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT), this value must
equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Nack targets</strong></dt>
<dd>A list of acknowledgment target descriptions associated with the triggered
cache manager server referenced by the new trigger handler description and
used later, 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, and padded with blanks if necessary.
The default setting is to reference the descriptions currently designated
as default acknowledgment target descriptions for the triggered cache manager
server. If there are no descriptions currently designated as default, a null
list is used. A null list indicates failed process completion messages are
not sent.<div class="note"><span class="notetitle">Note:</span> If a null list is specified, Offset to nack targets must equal
0 (QZHT_NONE), or -1 (QZHT_DEFAULT). See Offset to nack targets for more details.
Messages concerning failed trigger process completion referencing this handler
are sent to all listed acknowledgment targets. An escape message is sent if
any referenced description does not currently exist.</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 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>), or equal to
one of the special values described below. The default value is 10.<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.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to ack targets</strong></dt>
<dd>The offset from the beginning of the request 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.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: A null list is specified for Ack targets
indicating successful process completion messages are not sent.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default descriptions, if any, are
referenced for Ack targets.</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 request 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.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: A null list is specified for Cache targets
indicating data is not sent to cache targets.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default descriptions, if any, are
referenced for Cache targets.</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 request 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.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: A null list is specified for Nack targets
indicating failed process completion messages are not sent.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default descriptions, if any, are
referenced for Nack targets.</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 new 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 used by the new trigger handler description (left justified and
padded with blanks if necessary).<div class="note"><span class="notetitle">Note:</span> Trigger handler description names must
be unique for each triggered cache manager server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Trigger handler type</strong></dt>
<dd>The trigger handler 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: A *UPDATE type is described.</dd>
</dl>
<dl><dt class="dlterm"><strong>*PUBLISH</strong></dt>
<dd>QZHT_PUBLISH_TYPE: A *PUBLISH type is described.</dd>
</dl>
</dd>
</dl>
</div>
</div>
<div class="nested1" id="thdp0200_format"><a name="thdp0200_format"><!-- --></a><h2 class="topictitle2">THDP0200 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="d0e523">Offset</th>
<th rowspan="2" valign="top" id="d0e525">Type</th>
<th rowspan="2" valign="top" id="d0e527">Field</th>
</tr>
<tr><th valign="top" id="d0e530">Dec</th>
<th valign="top" id="d0e532">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e523 d0e530 ">0</td>
<td valign="top" headers="d0e523 d0e532 ">0</td>
<td valign="top" headers="d0e525 ">&nbsp;</td>
<td valign="top" headers="d0e527 ">Everything from THDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e523 d0e530 ">136</td>
<td valign="top" headers="d0e523 d0e532 ">88</td>
<td valign="top" headers="d0e525 ">Binary(4)</td>
<td valign="top" headers="d0e527 ">Cache request queue priority</td>
</tr>
<tr><td valign="top" headers="d0e523 d0e530 ">140</td>
<td valign="top" headers="d0e523 d0e532 ">8C</td>
<td valign="top" headers="d0e525 ">Binary(4)</td>
<td valign="top" headers="d0e527 ">Trigger queue collapse policy</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="thdp0200_field_description"><a name="thdp0200_field_description"><!-- --></a><h2 class="topictitle2">THDP0200 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>),
or equal to one of the special values described below. The default value is
2<sup>31</sup> (the lowest priority). <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.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</td>
</tr>
</tbody>
</table>
</div>
<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. The default value is 1 (QZHT_YES). <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.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Identical triggers
are collapsed.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Identical triggers
are not collapsed.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</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="thdp0300_format"><a name="thdp0300_format"><!-- --></a><h2 class="topictitle2">THDP0300 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="d0e648">Offset</th>
<th rowspan="2" valign="top" id="d0e650">Type</th>
<th rowspan="2" valign="top" id="d0e652">Field</th>
</tr>
<tr><th valign="top" id="d0e655">Dec</th>
<th valign="top" id="d0e657">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e648 d0e655 ">0</td>
<td valign="top" headers="d0e648 d0e657 ">0</td>
<td valign="top" headers="d0e650 ">&nbsp;</td>
<td valign="top" headers="d0e652 ">Everything from THDP0100 format</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">136</td>
<td valign="top" headers="d0e648 d0e657 ">88</td>
<td valign="top" headers="d0e650 ">Char(32)</td>
<td valign="top" headers="d0e652 ">Object dependency graph</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">168</td>
<td valign="top" headers="d0e648 d0e657 ">A8</td>
<td valign="top" headers="d0e650 ">Char(32)</td>
<td valign="top" headers="d0e652 ">Rule set</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">200</td>
<td valign="top" headers="d0e648 d0e657 ">C8</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Offset to traversal edge name</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">204</td>
<td valign="top" headers="d0e648 d0e657 ">CC</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Length of traversal edge name</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">208</td>
<td valign="top" headers="d0e648 d0e657 ">D0</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Offset to default included file</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">212</td>
<td valign="top" headers="d0e648 d0e657 ">D4</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Length of default included file</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">216</td>
<td valign="top" headers="d0e648 d0e657 ">D8</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Include dependency information</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">220</td>
<td valign="top" headers="d0e648 d0e657 ">DC</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Include triggered file information</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">224</td>
<td valign="top" headers="d0e648 d0e657 ">E0</td>
<td valign="top" headers="d0e650 ">Binary(4)</td>
<td valign="top" headers="d0e652 ">Include cached file information</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">&nbsp;</td>
<td valign="top" headers="d0e648 d0e657 ">&nbsp;</td>
<td valign="top" headers="d0e650 ">Char(*)</td>
<td valign="top" headers="d0e652 ">Traversal edge type</td>
</tr>
<tr><td valign="top" headers="d0e648 d0e655 ">&nbsp;</td>
<td valign="top" headers="d0e648 d0e657 ">&nbsp;</td>
<td valign="top" headers="d0e650 ">Char(*)</td>
<td valign="top" headers="d0e652 ">Default include file</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="thdp0300_field_description"><a name="thdp0300_field_description"><!-- --></a><h2 class="topictitle2">THDP0300 format field description</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. The default value is null, indicating
that a global default file name is not specified for this trigger handler
description.<div class="note"><span class="notetitle">Note:</span> If the value is null, Offset to default included file must
equal 0 (QZHT_NONE), or -1 (QZHT_DEFAULT). See Offset to default included
file for more details. 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. The default value is 0 (QZHT_NO).<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.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: A list of names is
included.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: A list of names
is not included.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</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. The default value is 0 (QZHT_NO).<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.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Information is included.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Information is not
included.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</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. The default
value is 0 (QZHT_NO).<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.306122448979592%"><strong>1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: A list of names is
included.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: A list of names
is not included.</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value is used.</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.<div class="note"><span class="notetitle">Note:</span> If
Offset to traversal edge type equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT),
this value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Object dependency graph</strong></dt>
<dd>The name of an object dependency graph description associated with the
triggered cache manager server referenced by the new trigger handler description
and used later, 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, or one of the
special values described below (left justified and padded with blanks if necessary).
The default setting is to reference the description currently designated as
the default object dependency graph description for the triggered cache manager
server. <p>Special values and their meanings are as follows:</p>
<dl><dt class="dlterm"><strong>*DEFAULT</strong></dt>
<dd>QZHT_DEFAULT_CHAR: The default is referenced.</dd>
</dl>
<div class="note"><span class="notetitle">Note:</span> An object dependency graph description is required. An
escape message is sent if the referenced description does not currently exist,
or if *DEFAULT is specified and there is currently no default object dependency
graph description for the server.</div>
</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.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value for <em>Default included
file</em> is used.</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. 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.306122448979592%"><strong>0</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.306122448979592%"><strong>-1</strong></td>
<td valign="top" width="84.6938775510204%">QZHT_DEFAULT: The default value for <em>Traversal edge
type</em> is used.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Rule set</strong></dt>
<dd>The name of a rule set associated with the triggered cache manager server
referenced by the new trigger handler description and used later, 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>*DEFAULT</strong></dt>
<dd>QZHT_DEFAULT_CHAR: The default rule set currently associated with the
triggered cache manager server is referenced.</dd>
</dl>
<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. An escape message is sent if the referenced description
does not currently exist, or if *DEFAULT is specified and there is currently
no default Rule Set for the server.</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. The default
name is <strong>composition</strong>.<div class="note"><span class="notetitle">Note:</span> If the value is null, Offset to traversal
edge type must equal 0 (QZHT_NONE), or -1 (QZHT_DEFAULT). 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>TCM7031 E</strong></dt>
<dd>Request variable format is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7033 E</strong></dt>
<dd>Length of request variable is not valid for the specified format.</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>TCM7222 E</strong></dt>
<dd>A default &amp;1 is not designated for triggered cache manager server
&amp;2.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM7293 E</strong></dt>
<dd>A &amp;1 using the name &amp;2 already exists for triggered cache manager
server &amp;3.</dd>
</dl>
<dl><dt class="dlterm">TCM72C0 E</dt>
<dd>Triggered cache manager &amp;1 name is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C1 E</strong></dt>
<dd>Triggered cache manager &amp;1 type is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C2 E</strong></dt>
<dd>Triggered cache manager description type &amp;1 cannot be specified when
using data format &amp;2.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM72C3 E</strong></dt>
<dd>Value passed to offset &amp;1 is not valid.</dd>
</dl>
<dl><dt class="dlterm"><strong>TCM74C0 E</strong></dt>
<dd>Triggered cache manager server name is not valid.</dd>
</dl>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink