Change Triggered Cache Manager Object Dependency Graph Description (QzhtChgTCMODGDesc) 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 request variable Output Char(*)
2 length of request variable Input Binary(4)
3 request 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 QzhthgTCMODGDesc API changes object dependency graph (ODG) descriptions associated with triggered cache manager servers. Changes made to object dependency graph descriptions are utilized by all trigger handler descriptions referencing them the next time the servers are started.

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

Authorities and locks

Required parameter group

request variable
INPUT: CHAR(*)

The variable used to pass information used to change an object dependency graph description.

length of request variable
INPUT: BINARY(4)

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

request variable format
CHAR(8)

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

  • OGDP0100: Basic information format for an object dependency graph description.
server name
INPUT: CHAR(32)

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

description name
INPUT: CHAR(32)

The name used to identify which object dependency graph (ODG) description is changed (left justified and padded with blanks if necessary).

error code
I/O: CHAR(*)

The structure in which to return error information.

OGDP0100 format

Offset Type Field
Dec Hex
0 0 Char(32) Server name
32 20 Char(32) Object dependency graph description name
64 40 Binary(4) Default property
68 44 Binary(4) Allow API updates

OGDP0100 format field descriptions

Allow API updates
Specifies whether APIs are allowed to update the object dependency graph described by the object dependency description. The value must be one of the special values described below. The default value is 1 (QZHT_YES).

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The object dependency graph is updating using APIs via the triggered cache manager server, as well as from trigger handler publish parsing.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The object dependency graph may not be updated using APIs via the triggered cache manager server. Only updates as a result of trigger handler publish parsing are allowed.
-1 QZHT_DEFAULT: The default value is used.
-2 QZHT_NO_CHANGE: The current value is not changed.
Default property
Specifies whether the description is to become the default object dependency graph description graph description for the triggered cache manager server specified in Server name. The value must equal one of the special values described below. If the value equals 1 (QZHT_YES) and the description is not currently the default description, the default property for the current default object dependency graph description, is set to 0 (QZHT_NO) and this description takes over the default role. The default value is –2 (QZHT_NO_CHANGE).

Special values and their meanings are as follows:

1 QZHT_YES, QZHT_TRUE, QZHT_ENABLED: The description is to become the default object dependency graph description for this server.
-1 QZHT_DEFAULT: The default value is used.
-2 QZHT_NO_CHANGE: The current value is not changed.
Note: Trigger handler descriptions, added or changed using the *DEFAULT special value, reference the object dependency graph description designated as default at the time they are added or changed.
Object dependency graph description name
The name used by the object dependency graph description (left justified and padded with blanks if necessary). The value must be a description name, or one of the special values described below.

Special values and their meanings are as follows:

*SAME
QZHT_NO_CHANGE_CHAR: The current name is not changed.
Note: Object dependency graph description names must be unique for each triggered cache manager server. If the name is changed while the description is referenced by trigger handler descriptions, they too are changed to reference the new name.
Server name
The name used to identify the triggered cache manager server with which the description is associated (left justified and padded with blanks if necessary). The value must be a server name, or one of the special values described below. If a server name is specified which is different than the one with which the description is currently associated, it is removed from its current association and added for the new server.

Special values and their meanings are as follows:

*SAME
QZHT_NO_CHANGE_CHAR: The current server association is not changed.
Note: An escape message is sent if the description is removed from its current association while it is being referenced by other descriptions.

Error messages

TCM7001 E
User &1 is not authorized.
TCM7030 E
Severe error occurred while addressing parameter list.
TCM7031 E
Request variable format is not valid.
TCM7033 E
Length of request variable is not valid for the format specified.
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.
TCM7293 E
A &1 using the name &2 already exists for triggered cache manager server &3.
TCM72C0 E
Triggered cache manager &1 name is not valid.
TCM72C3 E
Value passed at offset &1 is not valid.
TCM7401 E
User QTCM is not authorized to server data for triggered cache manager server &1.
TCM74C0 E
Triggered cache manager server name is not valid.
TCM7701 E
User QTCM is not authorized to object dependency graph data for triggered cache manager server &1.