Retrieve Triggered Cache Manager Publishing Rule (QzhtRtvTCMPublishingRule) API

Important: 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 http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm Link outside Information Center for more information.
Required Parameter Group:
1 receiver variable Output Char(*)
2 length of receiver variable Input Binary(4)
3 receiver variable format Input Char(8)
4 server name Input Char(32)
5 description name Input Char(32)
6 error code I/O Char(*)
Library Name/Service Program: QTCM/QZHTINCONF
Threadsafe: Yes

The QzhtRtvTCMPublishingRule API retrieves information from publishing rules associated with triggered cache manager servers. The API is a callable service implemented as an ILE entry point within QZHTINCONF *SRVPGM in QTCM *LIB.

The QTCM/H(QZHTINCONF) header file includes ILE C prototypes for this API.

Authorities and locks

Required parameter group

receiver variable
INPUT: CHAR(*)

The variable used to return publishing rule information.

length of receiver variable
INPUT: BINARY(4)

The number of bytes that the calling program provides for receiver variable.

receiver variable format
INPUT: CHAR(8)

The format name of the receiver variable data. The following values must be used:

  • PRDG0100: Basic information format for a publishing rule.
server name
INPUT: CHAR(32)

The name used to identify the server for which information is retrieved (left justified and padded with blanks if necessary).

description name
INPUT: CHAR(32)

The name used to identify the which publishing rule information is retrieved (left justified and padded with blanks if necessary).

error code
I/O: CHAR(*)

The structure in which to return error information.

PRDG0100 format

Offset Type Field
Dec Hex
0 0 Binary(4) Bytes returned
4 4 Binary(4) Bytes available
8 8 Char(32) Server name
40 28 Char(32) Publishing rule name
72 48 Binary(4) Offset to file extensions
76 4C Binary(4) Length of file extensions
80 50 Binary(4) Read from data source
84 54 Binary(4) Send data source version
88 58 Binary(4) Parse and assemble
92 5C Binary(4) Send assembled version
96 60 Binary(4) Offset to new file extension
100 64 Binary(4) Length of new file extension
    Char(*) File extensions
    Char(*) New file extensions

PRDG0100 format field descriptions

Bytes available
The number of information bytes available for return to the caller of the API.
Note: If this value is greater than the value of Bytes returned, the receiver variable was not large enough to return all information.
Bytes returned
The number of bytes of information returned to the caller of the API.
File extensions
A list of file extensions used to identify files that are processed according to the publishing rule. File extensions are listed as a string of characters, where each extension is separated by one space (left justified and padded with blanks if necessary).
Note: File names are compared to file extensions starting at the last period in the file name.
Length of file extensions
The length of the information returned for the File extensions entry.
Length of new file extension
The length of the information returned for the New file extension entry.
New file extension
The string of characters used as a new extension 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).
Note: If the value is null, Offset to new file extension equals 0 (QZHT_NONE), indicating that the triggered cache manager server does not rename files prior to sending them to the cache targets.
Offset to new file extension
The offset from the beginning of the receiver variable to the New file extension data, in bytes. The value returned is greater than 0 or equal to one of the special values described below.

Special values and their meanings are as follows:

0 QZHT_NONE: The value is null for New file extensions.
Offset to file extensions
The offset from the beginning of the request variable to the File extensions data, in bytes.
Parse and assemble
Indicates if files matching this publishing rule are parsed for wrappers and includes, and possibly sent through the page assembler. The returned value equals one of the special values described below.

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Files matching this publishing rule are parsed and possibly sent through the page assembler.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Files matching this publishing rule are not parsed.
Note: Files that are not parsed are not sent through the page assembler.
Publishing rule name
The name of the publishing rule, left justified and padded with blanks if necessary.
Read from data source
Indicates if files matching this publishing rule are read from the data source when triggered. The value returned is one of the special values described below.

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Files matching this publishing rule are read from the data source when triggered.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Files matching this publishing rule are not read from the data source.
Send assembled version
Indicates if the assembled version of files matching this publishing rule are sent to cache targets when triggered and processed. The returned value equals one of the special values described below.

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Assembled versions of files matching this publishing rule are sent to cache targets when triggered and processed.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Assembled versions of files matching this publishing rule are not sent to cache targets.
Send data source version
Indicates 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 returned is one of the special values described below.

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: Data source versions of files matching this publishing rule are sent to cache targets when triggered and processed.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: Data source versions of files matching this publishing rule are not sent to cache targets.
Server name
The name of the triggered cache manager server with which the description is associated (left justified and padded with blanks if necessary).

Error messages

TCM7001 E
User &1 is not authorized.
TCM7030 E
Severe error occurred while addressing parameter list.
TCM7032 E
Receiver variable format is not valid.
TCM7034 E
Length of receiver variable is not valid for the specified format.
TCM7035 E
Server parameter is not valid.
TCM7036 E
Description parameter is not valid.
TCM703E E
Error code parameter is not valid.
TCM70F0 E
Unknown error occurred while processing request.
TCM7101 E
User QTCM is not authorized to the configuration file for triggered cache manager server &1.
TCM7190 E
A configuration file for triggered cache manager server &1 was not found.
TCM7290 E
&1&2 was not found for triggered cache manager server &3.