Add Triggered Cache Manager Object Dependency Graph Description (QzhtAddTCMODGDesc) 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 Input Char(*)
2 length of request variable Input Binary(4)
3 request variable format Input Char(8)
4 error code I/O Char(*)
Library Name/Service Program: QTCM/QZHTINCONF
Threadsafe: Yes

The QzhtAddTCMODGDesc API adds new object dependency graph (ODG) descriptions to the configuration of triggered cache manager servers. New object dependency graph descriptions are referenced subsequently, but name, from trigger handler descriptions associated with the same server. New object dependency graph descriptions are utilized by all 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 add a new object dependency graph description.

length or request variable
INPUT: BINARY(4)

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

request variable format
INPUT: 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.
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

Field descriptions

Allow API updates
Specifies whether APIs are allowed to update the object dependency graph described by the new object dependency graph 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 updated using APIs via the triggered cache manager server, as well as from trigger handler process parsing.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The object dependency graph may not be updated using APIs through 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.
Default property
Specifies whether the new description is to become the default object dependency 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), 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 0 (QZHT_NO).

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.
0 QZHT_NO, QZHT_FALSE, QZHT_DISABLED: The description is not to become the default object dependency graph description.
-1 QZHT_DEFAULT: The default value is used.
Note: Trigger handler descriptions added or changed using the *DEFAULT special value references the object dependency graph description designated as default at the time the trigger handler descriptions are added or changed.
Object dependency graph description name
The name used by the new object dependency graph description (left justified and padded with blanks if necessary).
Note: Object dependency graph description names must be unique for each triggered cache manager server. They are referenced, by name, from trigger handler descriptions associated with the same server.
Server name
The name used to identify the triggered cache manager server with which the new 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.
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.
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.
TCM74C0 E
Triggered cache manager server name is not valid.