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

399 lines
20 KiB
HTML
Raw 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="Add Triggered Cache Manager Publishing Rule (QzhtAddTCMPublishingRule) 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_qzhtaddtcmpublishingrule" />
<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 Publishing Rule (QzhtAddTCMPublishingRule)
API</title>
</head>
<body id="rzaieapi_qzhtaddtcmpublishingrule"><a name="rzaieapi_qzhtaddtcmpublishingrule"><!-- --></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 Publishing Rule (QzhtAddTCMPublishingRule)
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>The QzhtAddTCMPublishingRule API adds new publishing rules to the configurations
of triggered cache manager servers. New publishing rules are referenced subsequently,
by name, from rule sets associated with the same server. New publishing rules
are utilized by all Rule Sets referencing them the next time the servers are
started. The API is a callable service implemented as an ILE entry point within
QZHTINCONF *SRVPGM in 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 information to add a new publishing
rule.</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>PRDP0100: Basic information format for a publishing rule.</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="prdp0100_format"><a name="prdp0100_format"><!-- --></a><h2 class="topictitle2">PRDP0100 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="d0e139">Offset</th>
<th rowspan="2" valign="top" id="d0e141">Type</th>
<th rowspan="2" valign="top" id="d0e143">Field</th>
</tr>
<tr><th valign="top" id="d0e146">Dec</th>
<th valign="top" id="d0e148">Hex</th>
</tr>
</thead>
<tbody><tr><td valign="top" headers="d0e139 d0e146 ">0</td>
<td valign="top" headers="d0e139 d0e148 ">0</td>
<td valign="top" headers="d0e141 ">Char(32)</td>
<td valign="top" headers="d0e143 ">Server name</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">32</td>
<td valign="top" headers="d0e139 d0e148 ">20</td>
<td valign="top" headers="d0e141 ">Char(32)</td>
<td valign="top" headers="d0e143 ">Publishing rule name</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">64</td>
<td valign="top" headers="d0e139 d0e148 ">40</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Offset to file extensions</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">68</td>
<td valign="top" headers="d0e139 d0e148 ">44</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Length of file extensions</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">72</td>
<td valign="top" headers="d0e139 d0e148 ">48</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Read from data source</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">76</td>
<td valign="top" headers="d0e139 d0e148 ">4C</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Send data source version</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">80</td>
<td valign="top" headers="d0e139 d0e148 ">50</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Parse and assemble</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">84</td>
<td valign="top" headers="d0e139 d0e148 ">54</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Send assembled version</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">88</td>
<td valign="top" headers="d0e139 d0e148 ">58</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Offset to new file extension</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">72</td>
<td valign="top" headers="d0e139 d0e148 ">5C</td>
<td valign="top" headers="d0e141 ">Binary(4)</td>
<td valign="top" headers="d0e143 ">Length of new file extension</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">&nbsp;</td>
<td valign="top" headers="d0e139 d0e148 ">&nbsp;</td>
<td valign="top" headers="d0e141 ">Char(*)</td>
<td valign="top" headers="d0e143 ">File extensions</td>
</tr>
<tr><td valign="top" headers="d0e139 d0e146 ">&nbsp;</td>
<td valign="top" headers="d0e139 d0e148 ">&nbsp;</td>
<td valign="top" headers="d0e141 ">Char(*)</td>
<td valign="top" headers="d0e143 ">New file extension</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="nested1" id="prdp0100_field_descriptions"><a name="prdp0100_field_descriptions"><!-- --></a><h2 class="topictitle2">PRDP0100 format field descriptions</h2>
<div><dl><dt class="dlterm"><strong>File extension</strong></dt>
<dd>A list of file extensions used to identify files that are processed according
to this new publishing rule. File extensions must be listed as a string of
characters, where each extension starts with a period character (.) and is
separated by one or more spaces (left justified and padded with blanks if
necessary). There is no default value for this entry.<div class="note"><span class="notetitle">Note:</span> A list of file
extensions is required. The file extensions are used by trigger handlers to
determine when the publishing rule applies. File names are compared to file
extensions starting at the last period in the file name. Therefore, each file
extension must start with a period character (.), otherwise a match is not
made. For example, .html, .gif, or .event.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of file extensions</strong></dt>
<dd>The length of the information for the File extensions entry.</dd>
</dl>
<dl><dt class="dlterm"><strong>Length of new file extension</strong></dt>
<dd>The length of the information for the New file extension entry.<div class="note"><span class="notetitle">Note:</span> If
Offset to new file extension equals 0 (QZHT_NONE), or -1 (QZHT_DEFAULT), this
value must equal 0.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>New file extension</strong></dt>
<dd>A file extension used to rename files after they have been assembled and
before they are sent to the cache targets (left justified and padded with
blanks if necessary). The default value is null, indicating that files are
not renamed.<div class="note"><span class="notetitle">Note:</span> If the value is null, Offset to new file extension must
equal 0 (QZHT_NONE) or -1 (QZHT_DEFAULT). If a new file extension is specified,
file names matching any one of the file extensions listed in File extension
are renamed with the file extension prior to being sent to the cache targets.
An escape message is sent if a new file extension is provided and Send assembled
version equals 0 (QZHT_NO).</div>
</dd>
<dt class="dlterm">Offset to new file extension</dt>
<dd>The offset from the beginning of the request variable to the New file
extension data, in bytes. The value must be greater than 0 or 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.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NONE: Same as -1 (QZHT_DEFAULT).</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used for New file
extension.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if Offset to new file extension is
greater than 0 (indicating that a new file extension has been provided) and
Send assembled version equals 0 (QZHT_NO).</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Offset to file extensions</strong></dt>
<dd>The offset from the beginning of the request variable to the File extension
data, in bytes.</dd>
</dl>
<dl><dt class="dlterm"><strong>Parse and assemble</strong></dt>
<dd>Specifies if files matching this publishing rule are parsed for wrappers
and includes, and possibly sent through the page assembler. If the name is
changed during wrapper parsing, the extension of the new name is used to determine
if the file should be parsed for includes and sent through the page assembler.
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.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Files matching this
publishing rule are parsed and possibly sent through the page assembler.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Files matching this
publishing rule are not parsed.<div class="note"><span class="notetitle">Note:</span> Files that are not parsed are not sent
through the page assembler.</div>
</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if Parse and assemble equals 1 (QZHT_YES)
and Read from data source equals 0 (QZHT_NO).</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Publishing rule name</strong></dt>
<dd>The name used by the publishing rule, left justified and padded with blanks
if necessary.<div class="note"><span class="notetitle">Note:</span> Publishing rule names must be unique for each triggered
cache manager server. They are referenced by name, from Rule Sets associated
with the same server.</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Read from data source</strong></dt>
<dd>Specifies if files matching this publishing rule are read from the data
source when triggered. The value must be 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.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Files matching this
publishing rule are read from the data source when triggered.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Files matching this
publishing rule are not read from the data source.<div class="note"><span class="notetitle">Note:</span> Not reading files
from the data source is useful when triggers specify a file which is purely
symbolic and need not correspond to an actual file, yet causes dependent files
processing.</div>
</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Send assembled version</strong></dt>
<dd>Specifies if the assembled version of files matching this publishing rule
are sent to cache targets when triggered and processed. 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.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Assembled versions
of files matching this publishing rule are sent to cache targets when triggered
and processed.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Assembled versions
of files matching this publishing rule are not sent to cache targets.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if Send assembled version equals 1
(QZHT_YES) and Parse and assemble equals 0 (QZHT_NO).</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Send data source version</strong></dt>
<dd>Specifies if the data source version of files matching this publishing
rule (the version read from the data source prior to assembly) are sent to
cache targets when triggered and processed. The value must equal one of the
special values described below. The default value is 1 (QZHT_YES) when Read
from data source equals 1 (QZHT_YES), and 0 (QZHT_NO) when Read from data
source equals 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.656565656565657%"><strong>1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Data source versions
of files matching this publishing rule are sent to cache targets when triggered
and processed.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>0</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Data source versions
of files matching this publishing rule are not sent to cache targets.</td>
</tr>
<tr><td valign="top" width="15.656565656565657%"><strong>-1</strong></td>
<td valign="top" width="84.34343434343434%">QZHT_DEFAULT: The default value is used.</td>
</tr>
</tbody>
</table>
</div>
<div class="note"><span class="notetitle">Note:</span> An escape message is sent if Send data source version equals
1 (QZHT_YES) and Read from data source equals 0 (QZHT_NO).</div>
</dd>
</dl>
<dl><dt class="dlterm"><strong>Server name</strong></dt>
<dd>The name used to identify the triggered cache manager server to which
the description is associated (left justified and padded with blanks if necessary).</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>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"><strong>TCM72C0 E</strong></dt>
<dd>Triggered cache manager &amp;1 name is not valid.</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 Copy Permalink