
EntireX	Version 9.7	SEARCH CONTENTS \| PDF PAGE PDF BOOKS \| HOME UP PREV NEXT

— EntireX Broker ACI Programming —

Broker CIS Data Structures

EntireX Broker provides an API for Command and Information Services (CIS) that include the following: shutting down conversations, servers and services; switching trace on and off; retrieving information on clients; registering servers and services.

Command and Information Services can be accessed from any environment from which EntireX Broker can be accessed. The structures for these services are available for the programming languages Assembler, C, Natural and COBOL.

Before referring to the structure tables below, see section Command-line Utilities.

This document describes the Command and Information Services data structures. It covers the following topics:.

Command Request Structure
Command Request Parameter Combinations
Common Header Structure for Response Data
Information Request Structure
Information Reply Structures

Note:
Version numbers in the tables below refer to the CIS interface version and not to the Broker version.

Command Request Structure

The request structure is given in the table below. Note possible combinations under Command Request Parameter Combinations.

Field Name Format CIS
Interface
Version Comment

VERSION I2 1 Interface version.

OBJECT-TYPE

Specifies the object type to which the command applies:

`7`	`BROKER`
`4`	`CONVERSATION`
`18`	`PARTICIPANT` ⁽¹⁾
`9`	`PSF`
`21`	`SECURITY`
`1`	`SERVER`
`6`	`SERVICE`
`14`	`SUBSCRIBER` ⁽¹⁾
`29`	`TRANSPORT`

COMMAND

Valid commands:

`13`	`ALLOW-NEWUOWMSGS`
`20`	`CLEAR-CMDLOG-FILTER`
`88`	`NO-OPERATION`
`17`	`CONNECT-PSTORE`
`28`	`DISABLE-ACCOUNTING`
`24`	`DISABLE-CMDLOG`
`22`	`DISABLE-CMDLOG-FILTER`
`37`	`DISABLE-DYN-WORKER`
`18`	`DISCONNECT-PSTORE`
`27`	`ENABLE-ACCOUNTING`
`23`	`ENABLE-CMDLOG`
`21`	`ENABLE-CMDLOG-FILTER`
`38`	`ENABLE-DYN-WORKER`
`14`	`FORBID-NEWUOWMSGS`
`25`	`PRODUCE-STATISTICS`
`12`	`PURGE`
`29`	`RESET-USER`
`31`	`RESUME`
`19`	`SET-CMDLOG-FILTER`
`8`	`SHUTDOWN`
`33`	`START`
`36`	`STATUS`
`32`	`STOP`
`15`	`SUBSCRIBE` ⁽¹⁾
`30`	`SUSPEND`
`26`	`SWITCH-CMDLOG`
`35`	`TRACE-FLUSH`
`2`	`TRACE-OFF`
`1`	`TRACE-ON`
`34`	`TRAP-ERROR`
`16`	`UNSUBSCRIBE` ⁽¹⁾

OPTION

Possible values:

`3`	`IMMED`
`4`	`QUIESCE`
`11`	`TR_LEVEL1`
`12`	`TR_LEVEL2`
`13`	`TR_LEVEL3`
`14`	`TR_LEVEL4`
`15`	`TR_LEVEL5`
`16`	`TR_LEVEL6`
`17`	`TR_LEVEL7`
`18`	`TR_LEVEL8`

P-USER-ID A28 1 Specifies the internal unique ID which is used to distinguish between several users with the same user ID. Using this field uniquely identifies a single server. The value for this field must be obtained by a previous info request. This field is used as a handle, i.e. no translation is performed.

UOWID A16 2 Selection field. Optional. Specifies the unit of work to be purged.

TOPIC ⁽¹⁾ A96 4 Selection field. Optional. Specifies the topic to be subscribed or unsubscribed to.

UID A32 4 Selection field. Optional. Specifies the user name for subscription/unsubscription and participant shutdown.

TOKEN A32 4 Selection field. Optional. Specifies the token name for subscription/unsubscription and participant shutdown.

SERVER-CLASS A32 5 Selection field. Optional. Specifies the server class name for command log filter addition or removal.

SERVER A32 5 Selection field. Optional. Specifies the server name for command log filter addition or removal.

SERVICE A32 5 Selection field. Optional. Specifies the service name for command log filter addition or removal.

RESERVED A32 5 Reserved for future use.

CONVID A16 7 Optional. Specifies the conversation to be shut down with command SHUTDOWN.

TRANSPORTID A3 7 Optional. Specifies the transport task. Possible values: NET|Snn|Tnn. Required for commands RESUME, START, STATUS, STOP, SUSPEND.

EXCLUDE-ATTACH-SERVERS I1 7 Optional. Exclude attach servers when shutting down a service.

SEQNO I4 7 Optional. Specifies the sequence number of the participant (i.e. client, server, publisher, subscriber) to be shut down. Can be used instead of P-USER-ID.

ERROR-NUMBER I4 7 Specifies the error number to be used with command TRAP-ERROR.

⁽¹⁾ See Writing Applications: Publish and Subscribe.

Command Request Parameter Combinations

The following table shows all valid combinations of parameters:

Object Type	Command	Option	Comment
`BROKER`	`CLEAR-CMDLOG-FILTER`		Remove a command log filter. The command log filter can be identified using the fields `TOPIC`, `UID`, `SERVER-CLASS`, `SERVER` and `SERVICE`.
	`DISABLE-ACCOUNTING`		Disable accounting.
	`DISABLE-CMDLOG`		Disable command logging.
	`DISABLE-CMDLOG-FILTER`		Disable a command log filter. The command log filter can be identified using the fields `TOPIC`, `UID`, `SERVER-CLASS`, `SERVER` and `SERVICE`.
	`DISABLE-DYN-WORKER`		Disable the `DYNAMIC-WORKER-MANAGEMENT`. `DYNAMIC-WORKER-MANAGEMENT=YES` must be configured in the attribute file. The current number of active worker tasks will not be changed until `DYNAMIC-WORKER-MANAGEMENT` is enabled again.
	`ENABLE-ACCOUNTING`		Enable accounting.
	`ENABLE-CMDLOG`		Enable command logging.
	`ENABLE-CMDLOG-FILTER`		Enable a command log filter. The command log filter can be identified using the fields `TOPIC`, `UID`, `SERVER-CLASS`, `SERVER` and `SERVICE`.
	`ENABLE-DYN-WORKER`		Enable the `DYNAMIC-WORKER-MANAGEMENT` again. `DYNAMIC-WORKER-MANAGEMENT=YES` must be configured in the attribute file. `DYNAMIC-WORKER-MANAGEMENT` has been disabled before. Additional worker tasks can be started again, or stopped if not used.
	`PRODUCE-STATISTICS`		Output current statistics to the broker log.
	`SET-CMDLOG-FILTER`		Add a command log filter. The command log filter can be identified using the fields `TOPIC`, `UID`, `SERVER-CLASS`, `SERVER` and `SERVICE`.
	`SHUTDOWN`		Shutdown Broker immediately.
	`SWITCH-CMDLOG`		Force a switch of command logging output files.
	`TRACE-FLUSH`		Flush all trace data kept in internal trace buffers to stderr (`DD:SYSOUT`). The broker-specific attribute `TRMODE=WRAP` is required.
	`TRACE-OFF`		Set trace off in Broker.
	`TRACE-ON`	`LEVEL`	Set `TRACE-LEVEL` on in Broker.
	`TRAP-ERROR`	`error number`	Modifies the setting of the broker-specific attribute `TRAP-ERROR`.
`CONVERSATION`	`SHUTDOWN`	`convid`
`SERVER`	`SHUTDOWN`	`IMMED`	Shutdown server immediately. The server must be uniquely identified using field `P_USER_ID` or `SEQNO`and will be completely removed from the BROKER environment. The following steps will be performed: Error code 00100050 will be replied to the server if it is waiting. All existing conversations will be finished with `EOC`. User will be logged off.
`SERVER`	`SHUTDOWN`	`QUIESCE`	Shutdown server but allow existing conversations to continue. The termination is signaled to the server by error code 00100051. After this, the next call issued must be a `DEREGISTER` for all services (`SC=,SN=,SV=*` if more than one service is active).
PSF	`ALLOW-NEWUOWMSGS`		New UOW messages are allowed.
	`CONNECT-PSTORE`		Connect the persistent store.
	`DISCONNECT-PSTORE`		Disconnect the persistent store.
	`FORBID-NEWUOWMSGS`		New UOW messages are not allowed.
	`PURGE`		Remove a unit of work from the EntireX Broker persistent store. (From version 2.)
	`TRACE-OFF`		Set trace off in the persistent store.
	`TRACE-ON`	`LEVEL`	Set`TRACE-LEVEL` on in the persistent store.
`PARTICIPANT`	`SHUTDOWN`	`IMMED`	Shutdown participant immediately. The participant must be identified, using fields `P-USER-ID`, `UID` or `TOKEN` and will be completely removed from the Broker environment. The following steps will be performed: Error code 00100050 will be replied to the participant, if it is waiting. All existing conversations will be finished with `EOC`. User will be logged off.
		`QUIESCE`	Shutdown participant but allow existing conversations to continue. The termination is signaled to the participant by error code 00100051.
		`seqno`	INFO requests return a `seqno` that can be used here to identify the target.
`SECURITY`	`RESET-USER`		Clear all cached security information for a user. The user must be identified using the field `UID`.
	`TRACE-OFF`		Set trace off in EntireX Security.
	`TRACE-ON`	`LEVEL`	Set `TRACE-LEVEL` on in EntireX Security.
`SERVICE`	`SHUTDOWN`	`IMMED`
		`QUIESCE`
		`class/server/service`
`SUBSCRIBER`	`SUBSCRIBE`		Subscribe a user to a topic.
`SUBSCRIBER`	`UNSUBSCRIBE`		Unsubscribe a user to a topic.
`TRANSPORT`	`RESUME`	`NET \| Snn \| Tnn`	Resume NET transport or a specific SSL or TCP communicator instance.
	`START`	`NET \| Snn \| Tnn`	Start NET transport or a specific SSL or TCP communicator instance.
	`STATUS`	`NET \| Snn \| Tnn`	Show status of NET transport or a specific SSL or TCP communicator instance.
	`STOP`	`NET \| Snn \| Tnn`	Stop NET transport or a specific SSL or TCP communicator instance.
	`SUSPEND`	`NET \| Snn \| Tnn`	Suspend NET transport or a specific SSL or TCP communicator instance.
	`TRACE-OFF`	`COM \| NET \| SSL \| TCP`	Switch trace off for all communicators (COM) or only NET, SSL or TCP communicators.
	`TRACE-ON LEVELn`	`COM \| NET \| SSL \| TCP`	Set trace level for all communicators (COM) or only NET, SSL or TCP communicators.

Common Header Structure for Response Data

This section describes the header structure (Struct HD_CIS), which is used by both the information services and the command service. For command-specific or information-specific structures, see Command Request Structure or Information Request Structure.

The header structure is always the first structure in the receive buffer that comes back from an information or command service request. Even receive buffers obtained with subsequent RECEIVE commands have this structure as the first part of the buffer. The header structure has the following layout, whereby in the Format column I = 4-byte integer value:

Field Name	Format	CIS Interface Version	Comment
`ERROR-CODE`	I4	1	Result of request. Value 0 indicates success. See Broker Command and Information Services Error Codes.
`TOTAL-NUM-OBJECTS`	I4	1	Total number of objects returned in object list.
`CURRENT-NUM-OBJECTS`	I4	1	Number of objects returned within current receive block.
`MAX-SC-LEN`	I4	1	Length of longest `SERVER-CLASS` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `SERVER-CLASS` field.
`MAX-SN-LEN`	I4	1	Length of longest `SERVER-NAME` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `SERVER-NAME` field.
`MAX-SV-LEN`	I4	1	Length of longest `SERVICE` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `SERVICE` field.
`MAX-UID-LEN`	I4	1	Length of longest `USER-ID` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `USER-ID` field.
`MAX-TK-LEN`	I4	1	Length of longest `TOKEN` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `TOKEN` field.
`MAX-TOPIC-LEN`	I4	4	Length of longest `TOPIC` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `TOPIC` field.
`REQUESTTIME`	I4	4	This is the time that the request was received by the Broker kernel.
`ETB-ERROR-CODE`	A8	5	This is any secondary error code from the broker kernel. See Error Messages and Codes.
`ETB-ERROR-TEXT`	A40	5	This is any secondary error text from the broker kernel. See Error Messages and Codes.
`MAX-PPC-LIB-LEN`	I4	6	Length of longest `RPC-LIB` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `RPC-LIB` field.
`MAX-PPC-PGM-LEN`	I4	6	Length of longest `RPC-PGM` value in total object list. This field is only relevant if the object-specific structure for the object list contains the `RPC-PGM` field.

Information Request Structure

The information services can handle many different information structures. Applications use the information request structure to specify which information structure is required. See also Examples of Selection Criteria.

The layout of the information request structure is shown in the following table. Fields BLOCK-LENGTH, VERSION, and OBJECT-TYPE are mandatory. All other fields are optional. Fields of type I or B are considered "not specified" if they contain low value. Fields of type A are considered "not specified" if they contain low value or spaces (according to the caller's character set).

Field Name Format CIS
Interface
Version Opt/
Req Comment

BLOCK-LENGTH I4 1 R Defines the block length of the data packages returned (without length of header.)
(RECEIVE-LENGTH field of ACI not used in order to keep the interfaces independent.)

VERSION I2 1 R Interface version. This describes the kind and amount of information wanted and enables us to extend the information in further versions of INFO services. Valid versions are 1 and above.

OBJECT-TYPE

Specifies the object type for which the information is required. If an object type is specified without additional selection criteria, a list of all active objects of that type is returned in accordance with the information service being addressed (INFO or USER-INFO). Possible values are:

`BROKER`	`7`	Info on this Broker. ⁽¹⁾
`CLIENT`	`2`	Info on active clients
`CMDLOG_FILTER`	`23`	Info on command log filters
`CONVERSATION`	`4`	Info on active conversations
`NET`	`24`	Info on the Entire Net-Work communicator. ⁽¹⁾
`PARTICIPANT`	`18`	Info on participants
`POOL_USAGE`	`25`	Info on Broker pool usage and dynamic memory management. ⁽¹⁾
`PSF`	`9`	Info on a unit of work's status
`PSFADA`	`12`	Info on the Adabas persistent store. ⁽¹⁾
`PSFCTREE`	`20`	Info on the c-tree persistent store. ⁽¹⁾
`PSFDIV`	`11`	Info on the DIV persistent store. ⁽¹⁾
`PSFFILE`	`13`	Info on the B-Tree persistent store (no longer supported)
`PUBLICATION`	`16`	Info on active publications
`PUBLISHER`	`15`	Info on active publishers
`RESOURCE_USAGE`	`26`	Info on Broker resource usage. ⁽¹⁾
`SECURITY`	`21`	Info on EntireX Security. ⁽¹⁾
`SERVER`	`1`	Info on active servers
`SERVICE`	`6`	Info on active services
`SSL`	`22`	Info on SSL communicators. ⁽¹⁾
`STATISTICS`	`27`	Statistics on selected Broker resources. ⁽¹⁾
`SUBSCRIBER`	`14`	Info on active subscribers
`TCP`	`19`	Info on TCP communicators. ⁽¹⁾
`TOPIC`	`17`	Info on active topics
`USER`	`28`	Info on all users of Broker regardless of the user type
`WORKER`	`8`	Info on all workers. ⁽¹⁾
`WORKER_USAGE`	`30`	Info on usage of worker tasks and dynamic worker management. ⁽¹⁾

⁽¹⁾ No additional selection criteria are needed. Other selection criteria fields are ignored.

USER-ID A32 1 O Selection criteria field. This is the user ID of the client or server as specified in the field USER-ID of the EntireX Broker ACI. The value of the field is used to restrict information to related objects of a specific user.

P-USER-ID B28 1 O Selection criteria field. Specifies the internal unique ID which is used to distinguish between several users with the same user ID.
This field uniquely identifies a client or server process. The value for this field must be obtained by a previous info request.
This field is used as a handle, i.e. no translation is performed. Any value different from low value will be treated as selection value.

TOKEN A32 1 O Selection criteria field. Corresponds to the TOKEN field of the EntireX Broker ACI. The value restricts the information to objects of users which have specified this TOKEN value in their Broker calls.

SERVER-CLASS A32 1 O Selection criteria field. Corresponds to field SERVER-CLASS in the EntireX Broker ACI. The value of this field is used to restrict information to objects concerning the services registered with this class.

SERVER-NAME A32 1 O Selection criteria field. Corresponds to field SERVER-NAME in the EntireX Broker ACI. The value of this field is used to restrict information to objects concerning the services registered with this server name.

SERVICE A32 1 O Selection criteria field. Corresponds to field SERVICE in the EntireX Broker ACI. The value of this field is used to restrict information to objects concerning the services registered with this service name.

CONV-ID A16 1 O Selection criteria field. Specifies the conversation ID of a conversation. Using this field uniquely identifies a conversation. The value for this field must be obtained by a previous info request.

RESERVED I2 1 Reserved for future use.

UOWID A16 2 O Selection criteria field. Specifies the unit of work ID.

UOWSTATUS

Selection criteria field. Specifies the unit of work status search criteria:

`1`	`RECEIVED`
`2`	`ACCEPTED`
`3`	`DELIVERED`
`4`	`BACKEDOUT`
`5`	`PROCESSED`
`6`	`CANCELLED`
`7`	`TIMEOUT`
`8`	`DISCARDED`

USERSTATUS A32 2 O Selection field. Specifies the user status selection value.

RECVUID A32 2 O Selection field. Specifies the unit-of-work receiver's user ID.

RECVTOKEN A32 2 O Selection field. Specifies the unit-of-work receiver's token ID.

RECVSERVER A32 2 O Selection field. Specifies the unit-of-work receiver's server name.

RECVSERVICE A32 2 O Selection field. Specifies the unit-of-work receiver's service name.

RECVCLASS A32 2 O Selection field. Specifies the unit-of-work receiver's class name.

TOPIC A96 4 O Selection field. Specifies the topic name.

PUBLICATION-ID A16 4 O Selection field. Specifies the publication ID.

SUBSCRIPTION-TYPE

Selection field. Specifies the subscription type:

`1`	`DURABLE`
`2`	`NON-DURABLE`

CONVERSATION-TYPE

Selection field. Specifies the conversation type:

`1`	`NON-CONVERSATIONAL`
`2`	`CONVERSATIONAL`

Legend

Abbreviation	Long Form / Description
Y	The field is specified.
I	The field is ignored.
N	The field is not specified; information should not be restricted by its value.

Column Abbreviation Table

Abbreviation	Long Form / Description
`UID`	`USER-ID`
`RECV-UID`	`RECEIVER USER-ID`
`PUID`	`P-USER-ID`
`TK`	`TOKEN`
`RECV-TK`	`RECEIVER TOKEN`
`SC`	`SERVER-CLASS`
`RECV-SC`	`RECEIVER SERVER-CLASS`
`SN`	`SERVER-NAME`
`RECV-SN`	`RECEIVER SERVER-NAME`
`SV`	`SERVICE`
`RECV-SV`	`RECEIVER SERVICE`
`CID`	`CONV-ID`
`UOWID`	`UNIT OF WORK ID`
`UWSTAT`	`UNIT OF WORK STATUS`
`USTAT`	`USER STATUS`
`TOPIC`	`TOPIC`
`PBN-ID`	`PUBLICATION-ID`
`SBN-TYP`	`SUBSCRIPTION-TYPE`

Selection Criteria CLIENT Object Type

Selection	PUID	UID	TK	SC	SN	SV	CID
Client ⁽¹⁾	Y	I	I	I	I	I	I
Client ⁽²⁾	N	Y	Y	I	I	I	I
Clients with UID	N	Y	N	I	I	I	I
Clients with TK	N	N	Y	I	I	I	I
all clients	N	N	N	I	I	I	I

Selection Criteria SERVER Object Type

Selection	PUID	UID	TK	SC	SN	SV	CID
Server ⁽¹⁾	Y	I	I	I	I	I	I
Server ⁽²⁾	N	Y	Y	I	I	I	I
Servers with UID	N	Y	N	I	I	I	I
Servers with TK	N	N	Y	I	I	I	I
Servers offering service	N	N	N	Y	Y	Y	I
All Servers	N	N	N	N	N	N	I

Selection Criteria SERVICE Object Type

Selection	PUID	UID	TK	SC	SN	SV	CID
Services offered by this server ⁽¹⁾	Y	I	I	I	I	I	I
Services offered by this server ⁽²⁾	N	Y	Y	I	I	I	I
Services with this SC/SN/SV	N	N	N	Y	Y	Y	I
Services with this SC/SN	N	N	N	Y	Y	N	I
Services with this SC/SV	N	N	N	Y	N	Y	I
Services with this SC	N	N	N	Y	N	N	I
Services with this SN/SV	N	N	N	N	Y	Y	I
Services with this SN	N	N	N	N	Y	N	I
Services with this SV	N	N	N	N	N	Y	I
All services	N	N	N	N	N	N	I

Selection Criteria CONV Object Type

Selection	PUID	UID	TK	SC	SN	SV	CID
Conversations of this client/server ⁽¹⁾	Y	I	I	I	I	I	I
Conversations of this client/server ⁽²⁾	N	Y	Y	I	I	I	I
Conversations of this service	N	N	N	Y	Y	Y	I
The conversation with CID	N	N	N	N	N	N	Y
All Conversations	N	N	N	N	N	N	N

Selection Criteria PSF Object Type (Version 2 and above)

Selection	UOWID	UID	TK	SC	SN	SV	CID
The unit of work	Y	I	I	I	I	I	I
All units of work for the conversation	N	I	I	I	I	I	Y
UOWs with client UID	N	Y	N	N	N	N	N
UOWs with clients having TK	N	N	Y	N	N	N	N
UOWs with the client SC	N	N	N	Y	N	N	N
UOWs with the client SN	N	N	N	N	Y	N	N
UOWs with the client SV	N	N	N	N	N	Y	N
UOWs with the client SC/SN	N	N	N	Y	Y	N	N
UOWs with the client SC/SV	N	N	N	Y	N	Y	N
UOWs with the client SC/SN/SV	N	N	N	Y	Y	Y	N
UOWs with the client SN/SV	N	N	N	N	Y	Y	N
All UOWs	N	N	N	N	N	N	N
UOWs with user status	I	I	I	I	I	N	Y
UOWs with UOW status	I	I	I	I	I	Y	N
UOWs with server ID	Y	N	N	N	N	N	N
UOWs with server having TK	N	N	Y	N	N	N	N
UOWs with the server SC	N	N	N	Y	N	N	N
UOWs with the server SN	N	N	N	N	Y	N	N
UOWs with the server SV	N	N	N	N	N	Y	N
UOWs with the server SC/SN	N	N	N	Y	Y	N	N
UOWs with the server SC/SV	N	N	N	Y	N	Y	N
UOWs with the server SC/SN/SV	N	N	N	Y	Y	Y	N
UOWs with the server SN/SV	N	N	N	N	Y	Y	N
All UOWs	N	N	N	N	N	N	N

Selection Criteria for PUBLISHER Objects (Version 4 and above)

Selection	PUID	UID	TK	TOPIC	PBN-ID
Publisher ⁽¹⁾	Y	I	I	I	I
Publisher ⁽²⁾	N	Y	Y	I	I
Publishers with UID	N	Y	N	I	I
Publishers with TK	N	N	Y	I	I
All publishers	N	N	N	I	I

Selection Criteria for PUBLICATION (Version 4 and above)

Selection	PUID	UID	TK	TOPIC	PBN-ID
Publications of this publisher/subscriber ⁽¹⁾	Y	I	I	I	I
Publications of this publisher/subscriber ⁽²⁾	N	Y	Y	I	I
Publications of this topic	N	N	N	Y	I
The publications with PBN-ID	N	N	N	N	Y
All publications	N	N	N	N	N

Selection Criteria for TOPIC (Version 4 and above)

Selection	PUID	UID	TK	TOPIC	PBN-ID
Topics subscribed to by this subscriber ⁽¹⁾	Y	I	I	I	I
Topics subscribed to by this subscriber ⁽²⁾	N	Y	Y	I	I
Topics with this TOPIC	N	N	N	Y	I
All topics	N	N	N	N	N

Selection Criteria for SUBSCRIBER (Version 4 and above)

Selection	PUID	UID	TK	TOPIC	SBN-TYP
Subscriber ⁽¹⁾	Y	I	I	I	I
Subscriber ⁽²⁾	N	Y	Y	I	I
Subscribers with UID	N	Y	N	I	I
Subscribers with TK	N	N	Y	I	I
All subscribers with SBN-TYP	N	N	N	I	Y
All subscribers with TOPIC	N	N	N	Y	I

Key

⁽¹⁾	if participant is not using TK (token) for authentication
⁽²⁾	if participant is using TK (token) for authentication

Information Reply Structures

The information reply structures are defined and described in the delivered source code. The structures are available for programming languages Assembler, C, Natural and COBOL.

BROKER-OBJECT (Struct INFO_BKR)
CLIENT-SERVER-PARTICIPANT-OBJECT (Struct INFO_CS)
CMDLOG_FILTER-OBJECT (Struct INFO_CMDLOG_FILTER)
CONVERSATION-OBJECT (Struct INFO_CV)
NET-OBJECT (Struct INFO_NET)
POOL-USAGE-OBJECT (Struct INFO_POOL_USAGE)
PSF-OBJECT (Struct INFO_PSF)
PSFADA-OBJECT (Struct INFO_PSFADA)
PSFDIV-OBJECT (Struct INFO_PSFDIV)
PSFCTREE-OBJECT (Struct INFO_PSTCTREE)
PSFFILE-OBJECT (Struct (INFO_PSFFILE)
PUBLICATION-OBJECT (Struct INFO_PUBLICATION)
PUBLISHER-OBJECT (Struct INFO_PUBLISHER)
RESOURCE-USAGE-OBJECT (Struct INFO_RESOURCE_USAGE)
SECURITY-OBJECT (Struct INFO_SECURITY)
SERVICE-OBJECT (Struct INFO_SV)
SSL-OBJECT (Struct INFO_SSL)
STATISTICS-OBJECT (Struct INFO_STATISTICS) (Excerpt of BROKER-OBJECT)
SUBSCRIBER-OBJECT (Struct INFO_SUBSCRIBER)
TCP-OBJECT (Struct INFO_TCP)
TOPIC-OBJECT (Struct INFO_TOPIC)
USER-OBJECT (Struct INFO_USER)
WORKER-OBJECT (Struct INFO_WKR)
WORKER-USAGE-OBJECT (Struct INFO_WORKER-USAGE)

BROKER-OBJECT (Struct INFO_BKR)

Field Name Format CIS
Interface
Version Description / Action

PLATFORM A8 1 Platform dependent.

RUNTIME I4 1 Time since Broker started, in seconds. Computed from current time - Broker start time.

NUM-WORKER-ACT I4 1 Number of active workers.

NUM-LONG I4 1 Number of long buffers defined (see NUM-LONG-BUFFER).

LONG-ACT I4 1 Number of long buffers active (in use).

LONG-HIGH I4 1 Highest number of long buffers active since Broker started.

NUM-SHORT I4 1 Number of short buffers defined (see NUM-SHORT-BUFFER).

SHORT-ACT I4 1 Number of short buffers active.

SHORT-HIGH I4 1 Highest number of short buffers active since Broker started.

LONG-SIZE I4 1 Size of long buffer entry.

SHORT-SIZE I4 1 Size of short buffer entry.

NUM-SERVICE I4 1 Number of services defined (see NUM-SERVICE).

SERVICE-ACT I4 1 Number of services active.

NUM-SERVER I4 1 Number of servers defined (see NUM-SERVER).

SERVER-ACT I4 1 Number of servers active.

SERVER-HIGH I4 1 Highest number of servers active since Broker started.

NUM-CLIENT I4 1 Number of clients defined (see NUM-CLIENT).

CLIENT-ACT I4 1 Number of clients active.

CLIENT-HIGH I4 1 Highest number of clients active since Broker started.

NUM-CONV I4 1 Number of conversations defined (see NUM-CONVERSATION).

CONV-HIGH I4 1 Highest number of conversations active since Broker started.

TRACE-LEVEL I2 1 Actual Trace Level value.

UNUSED1 I2 1 Unused.

LMAXUOWS I4 2 Maximum number of active UOWs.

LMAXUOWMSG I4 2 Maximum number of messages in a UOW.

LUWTIME I4 2 Maximum UOW lifetime

LMAXDELCNT I4 2 Currently not in use. (Count is always zero.)

LMAXMSGSIZE I4 2 Maximum size of a message

LTOTALUOWS I4 2 Number of UOWs.

CSTORE

Store attribute for all UOWs:

`0`	`OFF`
`1`	`BROKER`

CPSTORE

Startup value for persistent store:

`0`	`NO`
`1`	`HOT`
`2`	`COLD`
`4`	`WARM`

CUWSTATP I1 2 UOW status lifetime multiplier (0-255)

CDEFERRED

Default status attribute for all UOWs:

`0`	`NO`
`1`	`YES`

CACCOUNTING

`NO`	Accounting not active
`YES`	Accounting active on UNIX and Windows
`nnn`	SMF Record number on z/OS

CAUTHDEFAULT

Authorization Default:

`0`	`NO`
`1`	`YES`

LSSLPORT I4 3 Port number being used for SSL transport (UNIX and Windows only).

NEW-UOW-MESSAGES

New UOW messages:

`0`	`NO`
`1`	`YES`

SNMP-LICENSED

SNMP licensed:

`0`	`NO`
`1`	`YES`

UNUSED2 I1 3 Unused.

CPLATNAME A32 3 Full platform name where Broker is running

CPSTORETYPE

Persistent store type. It will be one of the following values:

`DIV`	Data-in-Virtual Persistent Store (z/OS only)
`FILE`	B-Tree Store (UNIX and Windows only, no longer supported)
`ADABAS`	Adabas Persistent Store (all platforms)

PUB-SUB

Publish and subscribe:

`0`	`NO`
`1`	`YES`

HIGHEST-API-VERSION I1 4 For example: 0x06.

HIGHEST-CIS-VERSION I1 4 For example: 0x06.

PSTORE-CONNECTED

`0`	`NO`
`1`	`YES`

NUM-TOPIC I4 4 Number of topics defined (see NUM-TOPIC).

TOPIC-ACT I4 4 Number of topics active.

NUM-SUBSCRIBER I4 4 Number of subscribers defined (see NUM-SUBSCRIBER).

SUBSCRIBER-ACT I4 4 Number of subscribers active.

SUBSCRIBER-HIGH I4 4 Highest number of subscribers active since Broker started.

NUM-PUBLISHER I4 4 Number of publishers defined (see NUM-PUBLISHER).

PUBLISHER-ACT I4 4 Number of publishers active.

PUBLISHER-HIGH I4 4 Highest number of publishers active since Broker started.

NUM-PUBLICATION I4 4 Number of publications defined (see NUM-PUBLICATION).

PUBLICATION-HIGH I4 4 Highest number of publications active since Broker started.

ATTACH-MGRS-ACT I4 4 Number of attach servers active.

LUWSTAT-ADD-TIME I4 4 Unit of work status additional lifetime.

PRODUCT-VERSION A16 4 Version, release, service pack, and patch level, e.g. 8.0.1.00.

LICENSE-EXPIRATION-DATE A10 5 License expiration date.

SECURITY-TYPE

Security type:

`0`	None
`1`	SAG
`2`	Light
`3`	Other

ACCOUNTING-ENABLED

`1`	Accounting enabled
`0`	Accounting disabled

NUM-FREE-CCB I4 5 Number of free CCB entries (conversation control block).

NUM-FREE-PCB I4 5 Number of free PCB entries(participant control block).

NUM-FREE-PCBEXT I4 5 Number of free PCBEXT entries (PCB extension).

NUM-FREE-SCB I4 5 Number of free SCB entries (service control block).

NUM-FREE-SCBEXT I4 5 Number of free SCBEXT entries (SCB extension).

NUM-FREE-SUBSCB I4 5 Number of free SUBSCB entries (subscriber control block).

NUM-FREE-TCB I4 5 Number of free TCB entries (topic control block).

NUM-FREE-TCBEXT I4 5 Number of free TCBEXT entries (TCP extension).

NUM-FREE-TOQ I4 5 Number of free TOQ entries (timeout queue).

NUM-FREE-UWCB I4 5 Number of free UWCB entries (UOW control block).

NUM-COM-BUFFER I4 5 Number of communication buffers.

NUM-COM-SLOT I4 5 Number of communication buffer slots.

NUM-COM-SLOT-FREE I4 5 Number of communication buffer slots free.

NUM-CMDLOG-FILTER I4 5 Number of CMDLOG filters.

NUM-CMDLOG-FILTER-ACTIVE I4 5 Number of CMDLOG filters active.

CMDLOG

Reflects status of Broker attribute CMDLOG:

`1`	Command logging features are available for the Broker
`0`	Command logging not available

CMDLOG-ENABLED

Reflects result of commands DISABLE-CMDLOG and ENABLE-CMDLOG:

`1`	Command logging enabled
`0`	Command logging temporarily disabled

NOTUSED3 A2 5 Alignment.

ATTRIBUTE-FILE-NAME A256 5 Attribute file name.

LOG-FILE-NAME A256 5 Name of trace log file.

LOG-FILE-SIZE I4 5 Size of trace log file.

LICENSE-FILE-NAME A256 5 License file name.

CMDLOG-FILE-SIZE I4 5 Max. size of CMDLOG file.

OPEN-CMDLOG-FILE-NAME A256 5 Name of open CMDLOG file.

OPEN-CMDLOG-FILE-SIZE I4 5 Size of CMDLOG file.

CLOSED-CMDLOG-FILE-NAME A256 5 Name of closed CMDLOG file.

CLOSED-CMDLOG-FILE-SIZE I4 5 Size of closed CMDLOG file.

RESERVED I4 5 Reserved for future use.

ACCOUNTING-FILE-NAME A256 5 Name of accounting output file.

ACCOUNTING-FILE-SIZE I4 5 Size of accounting output file.

CONTROL-INTERVAL I4 5 Control interval in seconds.

MAX-TAKEOVER-ATTEMPTS I4 5 Max. number of takeover attempts.

RUN-MODE A16 5 Broker run mode.

PARTNER-CLUSTER-ADDRESS A32 5 Partner Cluster Address.

CMDLOG-SWITCHES-BY-SIZE I4 5 Number of CMDLOG switches by size.

CMDLOG-SWITCHES-BY-CIS I4 5 Number of CMDLOG switches by CIS.

CLIENT-NONACT I4 7 Client timeout in seconds. See broker attribute CLIENT-NONACT.

NUM-WQE I4 7 Number of work queue entries. See broker attribute NUM-WQE.

TOTAL-STORAGE-ALLOCATED I4 7 Size of allocated storage in bytes.

TOTAL-STORAGE-ALLOCATED-HIGH I4 7 Highest size of allocated storage in bytes since Broker started.

TOTAL-STORAGE-LIMIT I4 7 Maximum of storage that can be allocated. See broker attribute MAX-MEMORY.

BROKER-ID A32 7 BROKER-ID. See broker attribute BROKER-ID.

HOST-NAME A256 7 Name of host running broker (on z/OS copied from CVTSNAME).

SYSPLEX-NAME A8 7 Name of SYSPLEX (copied from ECVTSPLX).

CAUTOLOGON

Auto logon:

`0`	`NO`
`1`	`YES`

See broker attribute AUTOLOGON.

CDYNAMIC-MEMORY-MANAGEMENT

Dynamic memory management:

`0`	`NO`
`1`	`YES`

See broker attribute DYNAMIC-MEMORY-MANAGEMENT.

CDYNAMIC-WORKER-MANAGEMENT

Dynamic worker management:

`0`	`NO`
`1`	`YES`

See broker attribute DYNAMIC-WORKER-MANAGEMENT.

CSERVICE-UPDATES

Service updates:

`0`	`NO`
`1`	`YES`

See broker attribute SERVICE-UPDATES.

CTOPIC-UPDATES

Topic updates:

`0`	`NO`
`1`	`YES`

See broker attribute TOPIC-UPDATES.

CTRANSPORT-NET

Was TRANSPORT=NET specified?

`0`	`NO`
`1`	`YES`

See broker attribute TRANSPORT=NET.

CTRANSPORT-SSL

Was TRANSPORT=SSL specified?

`0`	`NO`
`1`	`YES`

See broker attribute TRANSPORT=SSL.

CTRANSPORT-TCP

Was TRANSPORT=TCP specified?

`0`	`NO`
`1`	`YES`

See broker attribute TRANSPORT=TCP.

NTRAP-ERROR I4 7 Value defined for attribute TRAP-ERROR.

CLIENT-SERVER-PARTICIPANT-OBJECT (Struct INFO_CS)

Field Name Format CIS
Interface
Version Description / Action

USER-ID A32 1 Corresponds to USER-ID in the ACI. The maximum length of this field is determined by field MAX-UID-LEN in the header. See Common Header Structure for Response Data.

P-USER-ID B28 1 Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle, i.e. no translation is performed. With CIS commands SHUTDOWN PARTICIPANT and SHUTDOWN SERVER, field SEQNO is provided as unique criterion.

P-USER-ID-CHAR A28 1 No longer used.

TOKEN A32 1 Corresponds to TOKEN in the ACI. The maximum length of this field is determined by MAX-TK-LEN in the header. See Common Header Structure for Response Data.

CHAR-SET

Character set of user's platform:

`34`	EBCDIC IBM
`66`	EBCDIC SNI
`1`	ASCII PC 386
`16`	ASCII PC OS/2
`128`	ASCII 8859-1

ENDIAN

Endian type of user's platform:

`1`	Big endian (high order first)
`0`	Little endian

STATUS

Status of user:

`0`	Not waiting
`5`	Waiting

UNUSED1 I2 1 Unused.

WAIT-CONV-TYPE

A16

Only valid if user is waiting. Indicates what kind of conversation user is waiting for:

`NEW`	User waiting for new conversations
`ANY`	User waiting for any conversation
`OLD`	User waiting for old conversations
`NONE`	User waiting for non-conversational reply
`CONV-ID`	User waiting for specific conversation

WAIT-SERVER-CLASS A32 1 When waiting for ANY, NEW or OLD, the class name of the service to wait for is returned.

WAIT-SERVER-NAME A32 1 When waiting for ANY, NEW or OLD, the server name of the service to wait for is returned.

WAIT-SERVICE A32 1 When waiting for ANY, NEW or OLD, the name of the service to wait for is returned.

CONV-ACT I4 1 Number of active conversations of this user.

SERVICE-ACT I4 1 Number of services active (offered) by this server. This information is available for server only.

LAST-ACTIVE I4 1 Elapsed time since the last activity of the user.

NONACT I4 1 Non-activity time-out value.

WAIT-NEW I4 1 Accumulated time a server waited for new conversations. (Receive with CONVID=NEW or CONVID=ANY). A high value indicates that server has capacity.

NUM-WAIT-NEW I4 1 Number of times a server had to wait for new conversations.

WAIT-OLD I4 1 Accumulated time a server or client waited for messages of existing conversations. (Receive with CONVID=cid or CONVID=OLD.) A high value for a server indicates that server had to wait for the clients. A high value for a client indicates that the server's response was delayed.

NUM-WAIT-OLD I4 1 Number of times a server or client had to wait for messages of existing conversations.

SUM-CONV I4 1 Sum of conversations (including non-conversational requests) for the user since start of User.

LTOTALUOWS I4 2 Number of UOWs.

IP-ADDRESS A16 4 IPv4 address of client/server.

HOST-NAME A256 4 Host name of client/server.

RECV-OPTION I1 4 Receive option.

ATTACH-MGR I1 4 Attach manager indicator.

UNUSED2 I2 4 Unused.

RESERVED_ETBINFO_V73_1 A32 5 Reserved for future use.

APPLICATION-NAME

A64

The name of the executable that called the broker. If the program that issued the broker call is running on a mainframe system, the eight-byte job name is used as application name. If the job name is shorter than eight bytes, it is padded with underscore characters.

If the z/OS program issuing the broker call is running in a TP monitor (except IDMS/DC), a dash sign is set as ninth byte. The following eight bytes from position 10-17 contain monitor-dependent data:

`CICS`	The four-byte transaction ID is set.
`Com-plete`	The eight-byte program name is set.
`IMS`	The four-byte IMS ID is set.

Padding blanks in bytes 10-17 are replaced by underscore characters.

APPLICATION-TYPE A8 5 Application type. This field is used internally. It can be set by other Software AG products, which pass this value to the Broker stub via an unpublished control block. If no value is set, the respective operating system is displayed here.

RESERVED_ETBINFO_V73_3 A32 5 Reserved for future use.

COUNT-AUTHORIZATION-SUCCEEDED I4 5 Counter AUTHORIZ succeeded.

COUNT-AUTHORIZATION-FAILED I4 5 Counter AUTHORIZ failed.

CREATE-TIME I4 5 Creation time.

RPC-LIBRARY-NAME A128 6 Name of the RPC library of the current user request. If the user is inactive at the time of the request and has not issued a request to be processed by the Broker, no RPC information is displayed.

RPC-PROGRAM-NAME A128 6 Name of the RPC program of the current user request. If the user is inactive at the time of the request and has not issued a request to be processed by the Broker, no RPC information is displayed.

SEQNO I4 7 Unique sequence number of client/server. Can be used with CIS command SHUTDOWN.

APPLICATION-VERSION A16 7 Application version. This field is used internally. It can be set by other Software AG products, which pass this value to the Broker stub via an unpublished control block. The value is the version of the program that calls the Broker stub.

IPV6-ADDRESS A46 8 IPv6 address corresponding to attribute HOST in DEFAULTS=SSL|TCP section of Broker attribute file.

CMDLOG_FILTER-OBJECT (Struct INFO_CMDLOG_FILTER)

Field Name Format CIS
Interface
Version Description / Action

UID A32 5 User ID.

SERVER-CLASS A32 5 Class.

SERVER A32 5 Server.

SERVICE A32 5 Service.

TOPIC A96 5 Topic.

SETTER-UID A32 5 User ID of filter setter.

ENABLED

`1`	Enabled
`0`	Disabled

CONVERSATION-OBJECT (Struct INFO_CV)

Field Name Format CIS
Interface
Version Description / Action

CONV-ID A16 1 Unique identification of conversation.

SERVER-USER-ID A32 1 User ID of server - corresponds to USER-ID in the ACI. The maximum length of this field is determined by field MAX-UID-LEN in the header. See Common Header Structure for Response Data.

SERVER-P-USER-ID B28 1 Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle i.e. no translation is performed.

SERVER-P-USER-ID-CHAR A28 1 No longer used.

SERVER-TOKEN A32 1 Partner's additional identification - corresponds to TOKEN in the ACI. The maximum length of this field is determined by MAX-TK-LEN in the header. See Common Header Structure for Response Data.

CLIENT-USER-ID A32 1 Owners name. Corresponds to USER-ID in the ACI.

CLIENT-P-USER-ID B28 1 Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle i.e. no translation is performed.

CLIENT-P-USER-ID-CHAR A28 1 No longer used.

CLIENT-TOKEN A32 1 Owner's additional identification - corresponds to TOKEN in the ACI.

SERVER-CLASS A32 1 Server class of Service of Conversation.

SERVER-NAME A32 1 Server name of Service of Conversation. The maximum length of SERVER-CLASS, SERVER-NAME and SERVICE is determined by fields MAX-SC-LEN, MAX-SN-LEN and MAX-SV-LEN in the header. See Common Header Structure for Response Data.

SERVICE A32 1 Service name of Service of Conversation.

CONV-TIME-OUT I4 1 Conversation timeout (corresponds to CONV-NONACT of the service in the attribute file)

LAST-ACTIVE I4 1 Elapsed time since the last activity for this conversation.

TYPE

Type of conversation:

`0`	conversational
`1`	non-conversational

UNUSED1 I2 2 Unused.

LTOTALUOWS I4 2 Number of UOWs.

CLIENT-RPC-LIBRARY-NAME A128 6 Name of the RPC library that was provided by the RPC client at the start of the conversation, that is, the first SEND that contains both RPC library and RPC program is stored in the conversation.

CLIENT-RPC-PROGRAM-NAME A128 6 Name of the RPC program that was provided by the RPC client at the start of the conversation, that is, the first SEND that contains both RPC library and RPC program is stored in the conversation.

SERVER-RPC-LIBRARY-NAME A128 6 Name of the RPC library that was provided by the RPC server with the first response to clients request, that is, the first SEND that contains both RPC library and RPC program is stored in the conversation.

SERVER-RPC-PROGRAM-NAME A128 6 Name of the RPC program that was provided by the RPC server with the first response to clients request, that is, the first SEND that contains both RPC library and RPC program is stored in the conversation.

NET-OBJECT (Struct INFO_NET)

Field Name Format CIS
Interface
Version Description / Action

CLONE-INDEX I4 5 Clone index.

STATUS I4 5 Status of communicator. Possible values defined as ETB_INFO_COM_STATUS_.

DBID I2 5 DBID.

SVC-NUMBER I2 5 Adabas SVC number.

IUBL I4 5 Maximum buffer length.

TIME I4 5 MPM-12 timeout.

NABS I4 5 Number of attached buffers.

CQES I4 5 Number of CQEs.

FORCE I1 5 DBID table entry overwrite.

LOCAL

`1`	Local node
`0`	Not local

NOTUSED0 A2 5 Alignment.

POOL-USAGE-OBJECT (Struct INFO_POOL_USAGE)

Field Name	Format	CIS Interface Version	Description / Action
`TOTAL-NUM-POOLS`	I4	7	Number of pools currently allocated.
`TOTAL-STORAGE-ALLOCATED`	I4	7	Size of allocated storage in bytes.
`ACCOUNTING-NUM-POOLS`	I4	7	`ACCOUNTING`: Number of pools.
`ACCOUNTING-SIZE-ALL-POOLS`	I4	7	`ACCOUNTING`: Size of all pools in bytes.
`ACCOUNTING-SIZE-ONE-POOL`	I4	7	`ACCOUNTING`: Size of one pool in bytes.
`BLACKLIST-NUM-POOLS`	I4	7	`BLACKLIST`: Number of pools.
`BLACKLIST-SIZE-ALL-POOLS`	I4	7	`BLACKLIST`: Size of all pools in bytes.
`BLACKLIST-SIZE-ONE-POOL`	I4	7	`BLACKLIST`: Size of one pool in bytes.
`BROKER-TO-BROKER-NUM-POOLS`	I4	7	`BROKER-TO-BROKER`: Number of pools.
`BROKER-TO-BROKER-SIZE-ALL-POOLS`	I4	7	`BROKER-TO-BROKER`: Size of all pools in bytes.
`BROKER-TO-BROKER-SIZE-ONE-POOL`	I4	7	`BROKER-TO-BROKER`: Size of one pool in bytes.
`COM-BUFFER-NUM-POOLS`	I4	7	`COM-BUFFER`: Number of pools.
`COM-BUFFER-SIZE-ALL-POOLS`	I4	7	`COM-BUFFER`: Size of all pools in bytes.
`COM-BUFFER-SIZE-ONE-POOL`	I4	7	`COM-BUFFER`: Size of one pool in bytes.
`CMDLOG-NUM-POOLS`	I4	7	`CMDLOG`: Number of pools.
`CMDLOG-SIZE-ALL-POOLS`	I4	7	`CMDLOG`: Size of all pools in bytes.
`CMDLOG-SIZE-ONE-POOL`	I4	7	`CMDLOG`: Size of one pool in bytes.
`CONNECTION-NUM-POOLS`	I4	7	`CONNECTION`: Number of pools.
`CONNECTION-SIZE-ALL-POOLS`	I4	7	`CONNECTION`: Size of all pools in bytes.
`CONNECTION-SIZE-ONE-POOL`	I4	7	`CONNECTION`: Size of one pool in bytes.
`CONVERSATION-NUM-POOLS`	I4	7	`CONVERSATION`: Number of pools.
`CONVERSATION-SIZE-ALL-POOLS`	I4	7	`CONVERSATION`: Size of all pools in bytes.
`CONVERSATION-SIZE-ONE-POOL`	I4	7	`CONVERSATION`: Size of one pool in bytes.
`EXT-SUBSCRIBER-NUM-POOLS`	I4	7	`PSTORE-SUBSCRIBER`: Number of pools.
`EXT-SUBSCRIBER-SIZE-ALL-POOLS`	I4	7	`PSTORE-SUBSCRIBER`: Size of all pools in bytes.
`EXT-SUBSCRIBER-SIZE-ONE-POOL`	I4	7	`PSTORE-SUBSCRIBER`: Size of one pool in bytes.
`EXT-TOPIC-NUM-POOLS`	I4	7	`PSTORE-TOPIC`: Number of pools.
`EXT-TOPIC-SIZE-ALL-POOLS`	I4	7	`PSTORE-TOPIC`: Size of all pools in bytes.
`EXT-TOPIC-SIZE-ONE-POOL`	I4	7	`PSTORE-TOPIC`: Size of one pool in bytes.
`HEAP-NUM-POOLS`	I4	7	`HEAP`: Number of pools.
`HEAP-SIZE-ALL-POOLS`	I4	7	`HEAP`: Size of all pools in bytes.
`HEAP-SIZE-ONE-POOL`	I4	7	`HEAP`: Size of one pool in bytes.
`MSG-BUFFER-LONG-NUM-POOLS`	I4	7	`MSG-BUFFER-LONG`: Number of pools.
`MSG-BUFFER-LONG-SIZE-ALL-POOLS`	I4	7	`MSG-BUFFER-LONG`: Size of all pools in bytes.
`MSG-BUFFER-LONG-SIZE-ONE-POOL`	I4	7	`MSG-BUFFER-LONG`: Size of one pool in bytes.
`MSG-BUFFER-SHORT-NUM-POOLS`	I4	7	`MSG-BUFFER-SHORT`: Number of pools.
`MSG-BUFFER-SHORT-SIZE-ALL-POOLS`	I4	7	`MSG-BUFFER-SHORT`: Size of all pools in bytes.
`MSG-BUFFER-SHORT-SIZE-ONE-POOL`	I4	7	`MSG-BUFFER-SHORT`: Size of one pool in bytes.
`PARTICIPANT-NUM-POOLS`	I4	7	`PARTICIPANT`: Number of pools.
`PARTICIPANT-SIZE-ALL-POOLS`	I4	7	`PARTICIPANT`: Size of all pools in bytes.
`PARTICIPANT-SIZE-ONE-POOL`	I4	7	`PARTICIPANT`: Size of one pool in bytes.
`PARTICIPANT-EXT-NUM-POOLS`	I4	7	`PARTICIPANT-EXT`: Number of pools.
`PARTICIPANT-EXT-SIZE-ALL-POOLS`	I4	7	`PARTICIPANT-EXT`: Size of all pools in bytes.
`PARTICIPANT-EXT-SIZE-ONE-POOL`	I4	7	`PARTICIPANT-EXT`: Size of one pool in bytes.
`PROXY-QUEUE-NUM-POOLS`	I4	7	`PROXY-QUEUE`: Number of pools.
`PROXY-QUEUE-SIZE-ALL-POOLS`	I4	7	`PROXY-QUEUE`: Size of all pools in bytes.
`PROXY-QUEUE-SIZE-ONE-POOL`	I4	7	`PROXY-QUEUE`: Size of one pool in bytes.
`SERVICE-ATTRIBUTES-NUM-POOLS`	I4	7	`SERVICE-ATTRIBUTES`: Number of pools.
`SERVICE-ATTRIBUTES-SIZE-ALL-POOLS`	I4	7	`SERVICE-ATTRIBUTES`: Size of all pools in bytes.
`SERVICE-ATTRIBUTES-SIZE-ONE-POOL`	I4	7	`SERVICE-ATTRIBUTES`: Size of one pool in bytes.
`SERVICE-NUM-POOLS`	I4	7	`SERVICE`: Number of pools.
`SERVICE-SIZE-ALL-POOLS`	I4	7	`SERVICE`: Size of all pools in bytes.
`SERVICE-SIZE-ONE-POOL`	I4	7	`SERVICE`: Size of one pool in bytes.
`SERVICE-EXT-NUM-POOLS`	I4	7	`SERVICE-EXT`: Number of pools.
`SERVICE-EXT-SIZE-ALL-POOLS`	I4	7	`SERVICE-EXT`: Size of all pools in bytes.
`SERVICE-EXT-SIZE-ONE-POOL`	I4	7	`SERVICE-EXT`: Size of one pool in bytes.
`SUBSCRIPTION-NUM-POOLS`	I4	7	`SUBSCRIPTION`: Number of pools.
`SUBSCRIPTION-SIZE-ALL-POOLS`	I4	7	`SUBSCRIPTION`: Size of all pools in bytes.
`SUBSCRIPTION-SIZE-ONE-POOL`	I4	7	`SUBSCRIPTION`: Size of one pool in bytes.
`TIMEOUT-QUEUE-NUM-POOLS`	I4	7	`TIMEOUT-QUEUE`: Number of pools.
`TIMEOUT-QUEUE-SIZE-ALL-POOLS`	I4	7	`TIMEOUT-QUEUE`: Size of all pools in bytes.
`TIMEOUT-QUEUE-SIZE-ONE-POOL`	I4	7	`TIMEOUT-QUEUE`: Size of one pool in bytes.
`TOPIC-ATTRIBUTE-NUM-POOLS`	I4	7	`TOPIC-ATTRIBUTE`: Number of pools.
`TOPIC-ATTRIBUTE-SIZE-ALL-POOLS`	I4	7	`TOPIC-ATTRIBUTE`: Size of all pools in bytes.
`TOPIC-ATTRIBUTE-SIZE-ONE-POOL`	I4	7	`TOPIC-ATTRIBUTE`: Size of one pool in bytes.
`TOPIC-NUM-POOLS`	I4	7	`TOPIC`: Number of pools.
`TOPIC-SIZE-ALL-POOLS`	I4	7	`TOPIC`: Size of all pools in bytes.
`TOPIC-SIZE-ONE-POOL`	I4	7	`TOPIC`: Size of one pool in bytes.
`TOPIC-EXT-NUM-POOLS`	I4	7	`TOPIC-EXT`: Number of pools.
`TOPIC-EXT-SIZE-ALL-POOLS`	I4	7	`TOPIC-EXT`: Size of all pools in bytes.
`TOPIC-EXT-SIZE-ONE-POOL`	I4	7	`TOPIC-EXT`: Size of one pool in bytes.
`TRANSLATION-NUM-POOLS`	I4	7	`TRANSLATION`: Number of pools.
`TRANSLATION-SIZE-ALL-POOLS`	I4	7	`TRANSLATION`: Size of all pools in bytes.
`TRANSLATION-SIZE-ONE-POOL`	I4	7	`TRANSLATION`: Size of one pool in bytes.
`UOW-NUM-POOLS`	I4	7	`UOW`: Number of pools.
`UOW-SIZE-ALL-POOLS`	I4	7	`UOW`: Size of all pools in bytes.
`UOW-SIZE-ONE-POOL`	I4	7	`UOW`: Size of one pool in bytes.
`WORK-QUEUE-NUM-POOLS`	I4	7	`WORK-QUEUE`: Number of pools.
`WORK-QUEUE-SIZE-ALL-POOLS`	I4	7	`WORK-QUEUE`: Size of all pools in bytes.
`WORK-QUEUE-SIZE-ONE-POOL`	I4	7	`WORK-QUEUE`: Size of one pool in bytes.

PSF-OBJECT (Struct INFO_PSF)

Information about individual UOWs, or groups of UOWs, can be obtained through information services.

Field Name Format CIS
Interface
Version Description / Action

UOWID A16 2 Unit of work ID.

CONVID A16 2 Conversation ID.

SENDERUID A32 2 Sender user ID.

SENDERTOKEN A32 2 Sender user token

SENDERSERVER A32 2 Sender server name

SENDERCLASS A32 2 Sender server class

SENDERSERVICE A32 2 Sender service name

RECVRUID A32 2 Receiver user ID.

RECVRTOKEN A32 2 Receiver user token

RECVRSERVER A32 2 Receiver server name

RECVRCLASS A32 2 Receiver server class

RECVRSERVICE A32 2 Receiver service name

USERSTATUS A32 2 User status

UWSTATUS

UOW status:

`1`	`RECEIVED`
`2`	`ACCEPTED`
`3`	`DELIVERED`
`4`	`BACKEDOUT`
`5`	`PROCESSED`
`6`	`CANCELLED`
`7`	`TIMEOUT`
`8`	`DISCARDED`

CEOC

End of conversation state:

`0`	`NO`
`1`	`YES`

CSTORE

Persistence flag:

`0`	none
`1`	off
`2`	Broker

CUOWSTATSTORE

Multiplier used to calculate lifetime for the persistent status of a UOW:

`255`	no persistent status
`1-254`	valid multiplier values

LEOCREASON I4 2 End of conversation reason code.

LATTEMPTCOUNT I4 2 Attempted delivery count.

LMSQCNT I4 2 Number of messages.

LMSQSIZE I4 2 Total message size.

UWSTATUSLIFETIME A32 2 Status lifetime.

UWCREATETIME A32 2 Time UOW created.

UWLIFETIME I4 2 UOW lifetime.

PSFADA-OBJECT (Struct INFO_PSFADA)

Note:
Some of the fields listed in this table are represented by blanks or zeros under Windows. Such fields will not be displayed under Windows because of this limitation.

Field Name	Format	CIS Interface Version	Description / Action
`ADA-INFO-VERS`	I4	3	Adabas persistent store information services version.
`ADA-DBID`	I4	3	Adabas database ID (DBID) where the store is located.
`ADA-FNR`	I4	3	Adabas file number of the store (FNR).
`ADA-FNAME`	A16	3	Adabas file name of the store.
`ADA-FORMAT-TOD`	A16	3	TOD of persistent store last format in YYYMMDDHHMMSST.
`ADA-FORMAT-VERS`	I4	3	Persistent store format version.
`ADA-START-CNT`	I4	3	Number of times the persistent store has been opened.
`ADA-START-TOD`	A16	3	TOD of persistent store last open in YYYMMDDHHMMSST.
`ADA-ATTLEN`	I4	3	Length of attribute data.
`ADA-OID-LEN`	I4	3	Length of object identifier.
`ADA-OID-OFF`	I4	3	Offset of object identifier.
`ADA-ATT-CNT`	I4	3	Number of attributes in the store.
`ADA-OID-CNT`	I4	3	Number of object identifiers in the store.
`ADA-UI-EXTS`	I4	3	Number of upper index extents of the Adabas file used by the store.
`ADA-NI-EXTS`	I4	3	Number of normal index extents of the Adabas file used by the store.
`ADA-AC-EXTS`	I4	3	Number of address converter extents of the Adabas file used by the store.
`ADA-DA-EXTS`	I4	3	Number of data extents of the Adabas file used by the store.
`ADA-INDEX-LVLS`	I4	3	Number of index levels in the Adabas file used by the store.
`ADA-UI-PCT`	I4	3	Percentage of upper index that has been used by the store.
`ADA-NI-PCT`	I4	3	Percentage of normal index that has been used by the store.
`ADA-AC-PCT`	I4	3	Percentage of address converter that has been used by the store.
`ADA-DA-PCT`	I4	3	Percentage of data area that has been used by the store.
`TRACE-LEVEL`	I2	5	PSTORE trace level.
`NOTUSED0`	I2	5	Alignment.

PSFDIV-OBJECT (Struct INFO_PSFDIV)

Information services also provide detailed information on the allocation and usage of the various storage pools that implement the z/OS-DIV persistent store. This information can be used to tune the persistent store.

Note:
Persistent store administration was simplified with EntireX version 9.7 and cell pool services are no longer used. Cell pool information is no longer returned in the PSFDIV-OBJECT; all returned fields from DIV-SH-IXMODULUS to DIV-CX-QUERY-RC contain zeros only.

Field Name	Format	CIS Interface Version	Description / Action
`DIV-INFO-VERS`	I4	2	PSD query structure version.
`DIV-SH-NAME`	A8	2	Persistent store name.
`DIV-SH-FORMAT-TOD`	A16	2	TOD of persistent store last format in YYYYMMDDHHMMSST.
`DIV-SH-FORMAT-VERS`	I4	2	Persistent store format version.
`DIV-SH-HWMARK`	B4	2	Highest address in the data space.
`DIV-SH-START-CNT`	I4	2	Number of times the persistent store has been opened.
`DIV-SH-DS-ALET`	B4	2	ALET (Access List Entry Token) for data space.
`DIV-SH-ATT-LEN`	I4	2	Length of attribute data.
`DIV-SH-OID-LEN`	I4	2	Length of object identifier.
`DIV-SH-OID-OFF`	I4	2	Offset of object identifier.
`DIV-SH-IXMODULUS` ⁽¹⁾	I4	2	Size of array/hash modulus.
`DIV-SH-CP-DEF-CNT` ⁽¹⁾	I4	2	Number of cell pool definitions.
`DIV-CP-NAME` ⁽¹⁾	A8	2	Cell pool name.
`DIV-CP-CELL-SIZE` ⁽¹⁾	I4	2	Cell size.
`DIV-CP-CELL-TOTAL` ⁽¹⁾	I4	2	Total number of cells.
`DIV-CP-CELL-AVAIL` ⁽¹⁾	I4	2	Number of cells available.
`DIV-CP-EXTENT-CNT` ⁽¹⁾	I4	2	Number of cell pool extents.
`DIV-CP-QUERY-RC` ⁽¹⁾	I4	2	Return code from cell pool query.
`DIV-CX-STATUS` ⁽¹⁾	I4	2	Cell pool extent status.
`DIV-CX-EXTENT-ADDR` ⁽¹⁾	B4	2	Address of cell pool extent.
`DIV-CX-EXTENT-LEN` ⁽¹⁾	I4	2	Length of cell pool extent.
`DIV-CX-AREA-ADDR` ⁽¹⁾	B4	2	Address of cell area.
`DIV-CX-AREA-LEN` ⁽¹⁾	I4	2	Length of cell area.
`DIV-CX-CELL-TOTAL` ⁽¹⁾	I4	2	Number of cells in extent.
`DIV-CX-CELL-AVAIL` ⁽¹⁾	I4	2	Number of cells available in extent.
`DIV-CX-QUERY-RC` ⁽¹⁾	I4	2	Return code from cell pool extent query.
`TRACE-LEVEL`	I2	5	PSTORE trace level.
`NOTUSED0`	I2	5	Alignment.

Notes:

Obsolete since EntireX 9.7. Returned field contains zeros only.

PSFCTREE-OBJECT (Struct INFO_PSTCTREE)

Field Name	Format	CIS Interface Version	Description / Action
`FORMAT-VERS`	I4	5	Store version format.
`COLD-START-TIME`	A16	5	YYYYMMDDHHMMSST cold start.
`HOT-STARTS`	I4	5	Hot starts since format.
`MSG-DAT-FILE-NAME`	A256	5	Message data file name.
`MSG-DAT-FILE-SIZE`	I8	5	Message data file size (64-bit).
`MSG-IDX-FILE-NAME`	A256	5	Message index file name.
`MSG-IDX-FILE-SIZE`	I8	5	Message index file size (64-bit).
`STATUS-DAT-FILE-NAME`	A256	5	Status data file name.
`STATUS-DAT-FILE-SIZE`	I8	5	Status data file size (64-bit).
`STATUS-IDX-FILE-SIZE`	A256	5	Status index file name.
`STATUS-IDX-FILE-SIZE`	I8	5	Status index file size (64-bit).
`TRACE-LEVEL`	I2	5	PSTORE trace level.
`NOTUSED0`	I2	5	Alignment.

PSFFILE-OBJECT (Struct (INFO_PSFFILE)

Field Name	Format	CIS Interface Version	Description / Action
`FORMAT-VERSION`	I4	4	Store format version.
`COLD-START-TOD`	A16	4	Store cold-start time.
`HOT-STARTS`	I4	4	Number of hot starts since format.
`SMSGINDEXDAT`	A256	4	Message index data file name.
`LMSGINDEXDAT`	I4	4	Message index data file size.
`SMSGINDEXNDX`	A256	4	Message index index file name.
`LMSGINDEXNDX`	I4	4	Message index index file size.
`SSTATUSDAT`	A256	4	Status data file name.
`LSTATUSDAT`	I4	4	Status data file size.
`SSTATUSNDX`	A256	4	Status index file name.
`LSTATUSNDX`	I4	4	Status index file size.
`SMSGDAT`	A256	4	Message data file name.
`LMSGDAT`	I4	4	Message data file size.

PUBLICATION-OBJECT (Struct INFO_PUBLICATION)

Field Name Format CIS
Interface
Version Description / Action

PUBLICATION-ID A16 4 Publication ID.

PUBLISHER-USER-ID A32 4 Publisher's user ID.

PUBLISHER-P-USER-ID A28 4 Publisher's physical user ID.

PUBLISHER-P-USER-ID-CHAR A28 4 No longer used.

TOKEN A32 4 Publisher's token.

TOPIC A96 4 Topic name.

LAST-ACTIVE I4 4 Time (in seconds) since last activity.

EXPIRATION-TIME I4 4 Expiration time. Number of seconds since 1 JAN 1970.

LMSQCNT I4 4 Number of messages.

STATUS

Publication status:

`1`	`RECEIVED`
`2`	`ACCEPTED`
`3`	`DELIVERED`
`4`	`BACKEDOUT`
`5`	`PROCESSED`
`6`	`CANCELLED`
`7`	`TIMEOUT`
`8`	`DISCARDED`

UNUSED1 A3 4 Unused.

PUBLISHER-OBJECT (Struct INFO_PUBLISHER)

Field Name Format CIS
Interface
Version Description / Action

USER-ID A32 4 User ID.

P-USER-ID A28 4 Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle, i.e. no translation is performed. With CIS commands SHUTDOWN PARTICIPANT and SHUTDOWN SERVER, field SEQNO is provided as unique criterion.

P-USER-ID-CHAR A28 4 No longer used.

TOKEN A32 4 Token.

CHAR-SET I2 4 Publisher's character set.

ENDIAN I2 4 Publisher's endianness.

STATUS I2 4 Publisher's status.

UNUSED1 I2 4 Unused.

WAIT-PUBL-TYPE A16 4 Publication that publisher is waiting for.

WAIT-TOPIC A96 4 Topic that publisher is waiting for.

PUBL-ACT I4 4 Number of active publications.

TOPIC-ACT I4 4 Number of topics offered.

LAST-ACTIVITY I4 4 Time (in seconds) since last activity.

NONACT I4 4 Non activity timeout.

WAIT-NEW I4 4 Accumulated time (in seconds) of waits for new publications.

NUM-WAIT-NEW I4 4 Number of waits for new publications.

WAIT-OLD I4 4 Accumulated time (in seconds) of waits for old publications.

NUM-WAIT-OLD I4 4 Number of waits for old publications.

SUM-PUBL I4 4 Total number of publications.

IP-ADDRESS A16 4 IPv4 address of publisher.

HOST-NAME A256 4 Host name of publisher.

APPLICATION-NAME

A64

`CICS`	The four-byte transaction ID is set.
`Com-plete`	The eight-byte program name is set.
`IMS`	The four-byte IMS ID is set.

Padding blanks in bytes 10-17 are replaced by underscore characters.

RESERVED_ETBINFO_V73_5 A32 5 Reserved for future use.

COUNT-AUTHORIZATION-SUCCEEDED I4 5 Counter AUTHORIZ succeeded.

COUNT-AUTHORIZATION-FAILED I4 5 Counter AUTHORIZ failed.

CREATE-TIME I4 5 Creation time.

SEQNO I4 7 Unique sequence number of publisher. Can be used with CIS command SHUTDOWN.

IPV6-ADDRESS A46 8 IPv6 address corresponding to attribute HOST in DEFAULTS=SSL|TCP section of Broker attribute file.

RESOURCE-USAGE-OBJECT (Struct INFO_RESOURCE_USAGE)

Field Name	Format	CIS Interface Version	Description / Action
`TOTAL-STORAGE-ALLOCATED`	I4	7	Size of allocated storage in bytes.
`TOTAL-STORAGE-ALLOCATED-HIGH`	I4	7	Highest size of allocated storage in bytes since Broker started.
`TOTAL-STORAGE-LIMIT`	I4	7	Maximum of storage that can be allocated (broker attribute `MAX-MEMORY`).
`ACCOUNTING-BUFFERS-ALLOCATED`	I4	7	`ACCOUNTING`: Number of buffers allocated.
`ACCOUNTING-BUFFERS-FREE`	I4	7	`ACCOUNTING`: Number of buffers free.
`ACCOUNTING-BUFFERS-USED`	I4	7	`ACCOUNTING`: Number of buffers used.
`BLACKLIST-ENTRIES-ALLOCATED`	I4	7	`BLACKLIST`: Number of entries allocated.
`BLACKLIST-ENTRIES-FREE`	I4	7	`BLACKLIST`: Number of entries free.
`BLACKLIST-ENTRIES-USED`	I4	7	`BLACKLIST`: Number of entries used.
`BROKER-TO-BROKER-ENTRIES-ALLOCATED`	I4	7	`BROKER-TO-BROKER`: Number of entries allocated.
`BROKER-TO-BROKER-ENTRIES-FREE`	I4	7	`BROKER-TO-BROKER`: Number of entries free.
`BROKER-TO-BROKER-ENTRIES-USED`	I4	7	`BROKER-TO-BROKER`: Number of entries used.
`COM-BUFFERS-ALLOCATED`	I4	7	`COM-BUFFER`: Number of buffers allocated.
`COM-BUFFERS-FREE`	I4	7	`COM-BUFFER`: Number of buffers free.
`COM-BUFFERS-USED`	I4	7	`COM-BUFFER`: Number of buffers used.
`CMDLOG-FILTER-ENTRIES-ALLOCATED`	I4	7	`CMDLOG-FILTER`: Number of entries allocated.
`CMDLOG-FILTER-ENTRIES-FREE`	I4	7	`CMDLOG-FILTER`: Number of entries free.
`CMDLOG-FILTER-ENTRIES-USED`	I4	7	`CMDLOG-FILTER`: Number of entries used.
`CONNECTION-ENTRIES-ALLOCATED`	I4	7	`CONNECTION`: Number of entries allocated.
`CONNECTION-ENTRIES-FREE`	I4	7	`CONNECTION`: Number of entries free.
`CONNECTION-ENTRIES-USED`	I4	7	`CONNECTION`: Number of entries used.
`CONVERSATION-ENTRIES-ALLOCATED`	I4	7	`CONVERSATION`: Number of entries allocated.
`CONVERSATION-ENTRIES-FREE`	I4	7	`CONVERSATION`: Number of entries free.
`CONVERSATION-ENTRIES-USED`	I4	7	`CONVERSATION`: Number of entries used.
`EXT-SUBSCRIBER-ENTRIES-ALLOCATED`	I4	7	`PSTORE-SUBSCRIBER`: Number of entries allocated.
`EXT-SUBSCRIBER-ENTRIES-FREE`	I4	7	`PSTORE-SUBSCRIBER`: Number of entries free.
`EXT-SUBSCRIBER-ENTRIES-USED`	I4	7	`PSTORE-SUBSCRIBER`: Number of entries used.
`EXT-TOPIC-ENTRIES-ALLOCATED`	I4	7	`PSTORE-TOPIC`: Number of entries allocated.
`EXT-TOPIC-ENTRIES-FREE`	I4	7	`PSTORE-TOPIC`: Number of entries free.
`EXT-TOPIC-ENTRIES-USED`	I4	7	`PSTORE-TOPIC`: Number of entries used.
`HEAP-BYTES-ALLOCATED`	I4	7	`HEAP`: Number of bytes allocated.
`HEAP-BYTES-FREE`	I4	7	`HEAP`: Number of bytes free.
`HEAP-BYTES-USED`	I4	7	`HEAP`: Number of bytes used.
`MSG-BUFFER-LONG-ALLOCATED`	I4	7	`MSG-BUFFER-LONG`: Number of buffers allocated.
`MSG-BUFFER-LONG-FREE`	I4	7	`MSG-BUFFER-LONG`: Number of buffers free.
`MSG-BUFFER-LONG-USED`	I4	7	`MSG-BUFFER-LONG`: Number of buffers used.
`MSG-BUFFER-SHORT-ALLOCATED`	I4	7	`MSG-BUFFER-SHORT`: Number of buffers allocated.
`MSG-BUFFER-SHORT-FREE`	I4	7	`MSG-BUFFER-SHORT`: Number of buffers free.
`MSG-BUFFER-SHORT-USED`	I4	7	`MSG-BUFFER-SHORT`: Number of buffers used.
`PARTICIPANT-ENTRIES-ALLOCATED`	I4	7	`PARTICIPANT`: Number of entries allocated.
`PARTICIPANT-ENTRIES-FREE`	I4	7	`PARTICIPANT`: Number of entries free.
`PARTICIPANT-ENTRIES-USED`	I4	7	`PARTICIPANT`: Number of entries used.
`PARTICIPANT-EXT-ENTRIES-ALLOCATED`	I4	7	`PARTICIPANT-EXT`: Number of entries allocated.
`PARTICIPANT-EXT-ENTRIES-FREE`	I4	7	`PARTICIPANT-EXT`: Number of entries free.
`PARTICIPANT-EXT-ENTRIES-USED`	I4	7	`PARTICIPANT-EXT`: Number of entries used.
`PROXY-QUEUE-ENTRIES-ALLOCATED`	I4	7	`PROXY-QUEUE`: Number of entries allocated.
`PROXY-QUEUE-ENTRIES-FREE`	I4	7	`PROXY-QUEUE`: Number of entries free.
`PROXY-QUEUE-ENTRIES-USED`	I4	7	`PROXY-QUEUE`: Number of entries used.
`SERVICE-ATTRIBUTE-ENTRIES-ALLOCATED`	I4	7	`SERVICE-ATTRIBUTE`: Number of entries allocated.
`SERVICE-ATTRIBUTE-ENTRIES-FREE`	I4	7	`SERVICE-ATTRIBUTE`: Number of entries free.
`SERVICE-ATTRIBUTE-ENTRIES-USED`	I4	7	`SERVICE-ATTRIBUTE`: Number of entries used.
`SERVICE-ENTRIES-ALLOCATED`	I4	7	`SERVICE`: Number of entries allocated.
`SERVICE-ENTRIES-FREE`	I4	7	`SERVICE`: Number of entries free.
`SERVICE-ENTRIES-USED`	I4	7	`SERVICE`: Number of entries used.
`SERVICE-EXT-ENTRIES-ALLOCATED`	I4	7	`SERVICE-EXT`: Number of entries allocated.
`SERVICE-EXT-ENTRIES-FREE`	I4	7	`SERVICE-EXT`: Number of entries free.
`SERVICE-EXT-ENTRIES-USED`	I4	7	`SERVICE-EXT`: Number of entries used.
`SUBSCRIPTION-ENTRIES-ALLOCATED`	I4	7	`SUBSCRIPTION`: Number of entries allocated.
`SUBSCRIPTION-ENTRIES-FREE`	I4	7	`SUBSCRIPTION`: Number of entries free.
`SUBSCRIPTION-ENTRIES-USED`	I4	7	`SUBSCRIPTION`: Number of entries used.
`TIMEOUT-QUEUE-ENTRIES-ALLOCATED`	I4	7	`TIMEOUT-QUEUE`: Number of entries allocated.
`TIMEOUT-QUEUE-ENTRIES-FREE`	I4	7	`TIMEOUT-QUEUE`: Number of entries free.
`TIMEOUT-QUEUE-ENTRIES-USED`	I4	7	`TIMEOUT-QUEUE`: Number of entries used.
`TOPIC-ATTRIBUTE-ENTRIES-ALLOCATED`	I4	7	`TOPIC-ATTRIBUTE`: Number of entries allocated.
`TOPIC-ATTRIBUTE-ENTRIES-FREE`	I4	7	`TOPIC-ATTRIBUTE`: Number of entries free.
`TOPIC-ATTRIBUTE-ENTRIES-USED`	I4	7	`TOPIC-ATTRIBUTE`: Number of entries used.
`TOPIC-ENTRIES-ALLOCATED`	I4	7	`TOPIC`: Number of entries allocated.
`TOPIC-ENTRIES-FREE`	I4	7	`TOPIC`: Number of entries free.
`TOPIC-ENTRIES-USED`	I4	7	`TOPIC`: Number of entries used.
`TOPIC-EXT-ENTRIES-ALLOCATED`	I4	7	`TOPIC-EXT`: Number of entries allocated.
`TOPIC-EXT-ENTRIES-FREE`	I4	7	`TOPIC-EXT`: Number of entries free.
`TOPIC-EXT-ENTRIES-USED`	I4	7	`TOPIC-EXT`: Number of entries used.
`TRANSLATION-ENTRIES-ALLOCATED`	I4	7	`TRANSLATION`: Number of entries allocated.
`TRANSLATION-ENTRIES-FREE`	I4	7	`TRANSLATION`: Number of entries free.
`TRANSLATION-ENTRIES-USED`	I4	7	`TRANSLATION`: Number of entries used.
`UOW-ENTRIES-ALLOCATED`	I4	7	`UOW`: Number of entries allocated.
`UOW-ENTRIES-FREE`	I4	7	`UOW`: Number of entries free.
`UOW-ENTRIES-USED`	I4	7	`UOW`: Number of entries used.
`WORK-QUEUE-ENTRIES-ALLOCATED`	I4	7	`WORK-QUEUE`: Number of entries allocated.
`WORK-QUEUE-ENTRIES-FREE`	I4	7	`WORK-QUEUE`: Number of entries free.
`WORK-QUEUE-ENTRIES-USED`	I4	7	`WORK-QUEUE`: Number of entries used.

SECURITY-OBJECT (Struct INFO_SECURITY)

Field Name	Format	CIS Interface Version	Description / Action
`COUNT-AUTHENTICATION-SUCCEEDED`	I4	5	Successful authentications.
`COUNT-AUTHENTICATION-FAILED`	I4	5	Failed authentications.
`COUNT-AUTHORIZATION-SUCCEEDED`	I4	5	Successful authorizations.
`COUNT-AUTHORIZATION-FAILED`	I4	5	Failed authorizations.
`SAF-PROFILE-LENGTH`	I4	5	Max profile length (`CDT`) m/f.
`TRACE-LEVEL`	I2	5	Security trace level.
`SECURITY-LEVEL`	I2	5	Security Level m/f.
`AUTHENTICATION-TYPE`	A8	5	Authentication type.
`SAF-CLASS`	A8	5	SAF profile `CLASS` (8) m/f.
`SECURITY-NODE`	A8	5	Security node m/f.
`INCLUDE-CLASS`	I1	5	Include `CLASS` in prof m/f.
`INCLUDE-NAME`	I1	5	Include `NAME` in prof m/f.
`INCLUDE-SERVICE`	I1	5	Include `SERVICE` in prof m/f.
`UNIVERSAL`	I1	5	Allow undefined profile m/f.
`CHECK-IP-ADDRESS`	I1	5	Check IP address m/f.
`WARN-MODE`	I1	5	Run in warn mode m/f.
`IGNORE-STOKEN`	I1	5	Ignore ACI `STOKEN` m/f.
`TRUSTED-USER`	I1	5	Trusted User ID m/f.
`PROPAGATE-TRUSTED-USER`	I1	5	VerifiedId m/f.
`PASSWORD-TO-UPPER-CASE`	I1	5	Convert password to uppercase m/f.
`NOTUSED0`	A2	5	Alignment.

SERVICE-OBJECT (Struct INFO_SV)

Field Name Format CIS
Interface
Version Description / Action

SERVER-CLASS A32 1 Name of server class.

SERVER-NAME A32 1 Name of server.

SERVICE A32 1 Name of service. The header contains the maximum length for the SERVER-CLASS, SERVER-NAME and SERVICE fields for all retrieved objects. See Common Header Structure for Response Data.

TRANS A8 1 Name of translation routine used.

CONV-NONACT I4 1 Conversation timeout (corresponds to CONV-NONACT for the service in the attribute file).

SERVER-ACT I4 1 Number of servers active for service.

CONV-ACT I4 1 Number of conversations active for service.

CONV-HIGH I4 1 Highest number of conversations active for service.

LONG-ACT I4 1 Number of long buffers active (in use) for the service.

LONG-HIGH I4 1 Highest number of long buffers active (in use) for the service.

SHORT-ACT I4 1 Number of short buffers active (in use) for the service.

SHORT-HIGH I4 1 Highest number of short buffers active (in use) for the service.

NUM-WAIT-SERVER I4 1 Number of times a client had to wait for this service or messages from the server.

NUM-SERV-OCC I4 1 Number of times a client request (SEND with CONVID=NEW or NONE) could not be immediately assigned to a waiting server, i.e. all servers offering this service are occupied.

NUM-PEND I4 1 Number of new conversations which are currently in the queue, but not yet assigned to a server (pending).

PEND-HIGH I4 1 Highest number of pending conversations.

REQ-SUM I4 1 Accumulated number of requests (number of SEND commands with CONVID=NEW or NONE).

LMAXUOWS I4 2 Maximum number of active UOWs

LMAXUOWMSG I4 2 Maximum number of messages in a UOW

LUWTIME I4 2 Maximum UOW lifetime

LMAXDELCNT I4 2 Is currently not in use (count is always zero.)

LMAXMSGSIZE I4 2 Maximum size of a message

LTOTALUOWS I4 2 Number of UOWs

CSTORE I1 2 Store attribute for all UOWs:
0=OFF
1=BROKER

CUWSTATP I1 2 UOWstatus lifetime multiplier (0-255)

CDEFERRED

Default status attribute for all UOWs:

`0`	`NO`
`1`	`YES`

CENCLEVEL I1 3 Encryption level

ATTACH-MGRS-ACT I4 4 Number of attach servers active

LUWSTAT-ADD-TIME I4 4 Unit of work status additional lifetime

NUM-CONV I4 5 Number of conversations.

NUM-SERVER I4 5 Number of servers.

NUM-LONG-MSG-BUFFER I4 5 Number of long message buffers.

NUM-SHORT-MSG-BUFFER I4 5 Number of short message buffers.

CONVERSION A8 5 Name of conversion routine.

CONVERSION-PARMS A255 5 Conversion parameters.

NOTUSED1 A1 5 Alignment.

RESERVED I4 5 Reserved for future use.

SSL-OBJECT (Struct INFO_SSL)

Field Name	Format	CIS Interface Version	Description / Action
`CLONE-INDEX`	I4	5	Clone index.
`STATUS`	I4	5	Status of communicator. Possible values defined as `ETB_INFO_COM_STATUS_`.
`OPEN-CONNECTIONS`	I4	5	Number of open connections.
`MAX-CONNECTIONS`	I4	5	Maximum number of connections.
`PORT-NUMBER`	I4	5	Port number.
`IP-ADDRESS`	A16	6	IPv4 address corresponding to attribute `HOST` in `DEFAULTS=SSL` section of Broker attribute file.
`HOST-NAME`	A256	6	Host name specified using attribute `HOST` in `DEFAULTS=SSL` section of Broker attribute file.
`TASK-RUNNING`	I1	8	Transport task running. 0=NO, 1=YES.
`IPV6-ADDRESS`	A46	8	IPV6 address corresponding to attribute `HOST` in the `DEFAULTS=SSL` section of the Broker attribute file.

STATISTICS-OBJECT (Struct INFO_STATISTICS) (Excerpt of BROKER-OBJECT)

Field Name	Format	CIS Interface Version	Description / Action
`NUM-SERVICE`	I4	7	Number of services defined (see `NUM-SERVER`).
`SERVICE-ACT`	I4	7	Number of services active.
`NUM-CLIENT`	I4	7	Number of clients defined (see `NUM-CLIENT`).
`CLIENT-ACT`	I4	7	Number of clients active.
`CLIENT-HIGH`	I4	7	Highest number of clients active since Broker started.
`NUM-SERVER`	I4	7	Number of servers (see `NUM-SERVER`).
`SERVER-ACT`	I4	7	Number of servers active.
`SERVER-HIGH`	I4	7	Highest number of servers active since Broker started.
`NUM-CONV`	I4	7	Number of conversations defined (see `NUM-CONVERSATION`).
`CONV-ACT`	I4	7	Number of conversations active.
`CONV-HIGH`	I4	7	Highest number of conversations active since Broker started.
`NUM-LONG`	I4	7	Number of long buffers defined (see `NUM-LONG-BUFFER`).
`LONG-ACT`	I4	7	Number of long buffers active.
`LONG-HIGH`	I4	7	Highest number of long buffers active since Broker started.
`NUM-SHORT`	I4	7	Number of short buffers defined (see `NUM-SHORT-BUFFER`).
`SHORT-ACT`	I4	7	Number of short buffers active.
`SHORT-HIGH`	I4	7	Highest number of short buffers active since Broker started.
`NUM-TOPIC`	I4	7	Number of topics defined (see `NUM-TOPIC`).
`TOPIC-ACT`	I4	7	Number of topics active.
`NUM-PUBLISHER`	I4	7	Number of publishers defined (see `NUM-PUBLISHER`).
`PUBLISHER-ACT`	I4	7	Number of publishers active.
`PUBLISHER-HIGH`	I4	7	Highest number of publishers active since Broker started.
`NUM-SUBSCRIBER`	I4	7	Number of subscribers defined (see `NUM-SUBSCRIBER`).
`SUBSCRIBER-ACT`	I4	7	Number of subscribers active.
`SUBSCRIBER-HIGH`	I4	7	Highest number of subscribers active since Broker started.
`NUM-PUBLICATION`	I4	7	Number of publications defined (see `NUM-PUBLICATION`).
`PUBLICATION-ACT`	I4	7	Number of publications active.
`PUBLICATION-HIGH`	I4	7	Highest number of publications active since Broker started.

SUBSCRIBER-OBJECT (Struct INFO_SUBSCRIBER)

Field Name Format CIS
Interface
Version Description / Action

TOPIC A96 4 Topic name.

USER-ID A32 4 User ID.

P-USER-ID-CHAR A28 4 No longer used.

TOKEN A32 4 Token.

SUBSCRIPTION-TIME I4 4 Subscription time.

LAST-ACTIVITY-TIME I4 4 Last activity time.

EXPIRATION-TIME I4 4 Expiration time.

LAST-COMMITTED A16 4 Last committed publication.

LAST-RECEIVED A16 4 Last received publication.

DURABLE

Durable flag:

`0`	`NO`
`1`	`YES`

SWAPPED-OUT

Durable subscriber swapped out?

`0`	`NO`
`1`	`YES`

UNUSED1 I2 4 Unused.

CHAR-SET

User's character set:

`34`	EBCDIC_IBM
`66`	EBCDIC_SNI
`1`	ASCII_PC_386
`16`	ASCII_PC_OS2
`128`	ASCII_8859_1

BIG-ENDIAN

High order first:

`0`	`NO`
`1`	`YES`

STATUS

User's status:

`0`	Not waiting
`5`	Waiting

WAIT-PUBLID A16 5 PUBLID user is waiting for: "NEW" "OLD" "ANY" publication ID.

NOTUSED1 I2 5 Alignment.

NUM-PUBLICATIONS-ACTIVE I4 5 Number of active publications.

NONACT-TIME I4 5 Nonactivity timeout.

WAIT-NEW I4 5 Accumulated time of waits for new publications.

NUM-WAIT-NEW I4 5 Number of waits for new publ.

WAIT-OLD I4 5 Accumulated time of waits for messages from publisher.

NUM-WAIT-OLD I4 5 Number of waits for publisher messages.

IP-ADDRESS A16 5 IPv4 address of subscriber.

HOST-NAME A256 5 Host name of subscriber.

APPLICATION-NAME

A64

`CICS`	The four-byte transaction ID is set.
`Com-plete`	The eight-byte program name is set.
`IMS`	The four-byte IMS ID is set.

Padding blanks in bytes 10-17 are replaced by underscore characters.

RESERVED_ETBINFO_V73_4 A32 5 Reserved for future use.

COUNT-AUTHORIZATION-SUCCEEDED I4 5 Counter AUTHORIZ succeeded.

COUNT-AUTHORIZATION-FAILED I4 5 Counter AUTHORIZ failed.

CREATE-TIME I4 5 Creation time.

SEQNO I4 7 Unique sequence number of subscriber. Can be used with CIS command SHUTDOWN.

IPV6-ADDRESS A46 8 IPv6 address corresponding to attribute HOST in DEFAULTS=SSL|TCP section of Broker attribute file.

TCP-OBJECT (Struct INFO_TCP)

Field Name	Format	CIS Interface Version	Description / Action
`CLONE-INDEX`	I4	5	Clone index.
`STATUS`	I4	5	Status of communicator `ETB_INFO_COM_STATUS_`.
`OPEN-CONNECTIONS`	I4	5	Number of open connections.
`MAX-CONNECTIONS`	I4	5	Maximum number of connections. Platform-dependent. See Maximum TCP/IP Connections per Communicator under Broker Resource Allocation.
`PORT-NUMBER`	I4	5	Port number.
`IP-ADDRESS`	A16	6	IPv4 address corresponding to attribute `HOST` in `DEFAULTS=TCP` section of Broker attribute file.
`HOST-NAME`	A256	6	Host name specified using attribute `HOST` in `DEFAULTS=TCP` section of Broker attribute file.
`TASK-RUNNING`	I1	8	Transport task running. 0=NO, 1=YES.
`IPV6-ADDRESS`	A46	8	IPV6 address corresponding to attribute `HOST` in the `DEFAULTS=TCP` section of the Broker attribute file.

TOPIC-OBJECT (Struct INFO_TOPIC)

Field Name Format CIS
Interface
Version Description / Action

TOPIC A96 4 Topic name.

TRANS A8 4 Name of translation routine.

CONV A8 4 Name of conversion routine.

PUBLISHER-NONACT I4 4 Publisher non-activity timeout.

SUBSCRIBER-NONACT I4 4 Subscriber non-activity timeout.

SUBSCRIPTION-EXP I4 4 Subscription expiration time.

PUBLICATION-ACT I4 4 Number of active publications.

PUBLICATION-HIGH I4 4 Highest number of publications active since Broker started.

DURABLE-ACT I4 4 Number of durable subscribers active.

NON-DURABLE-ACT I4 4 Number of non-durable subscribers active.

LONG-ACT I4 4 Number of long buffers active.

LONG-HIGH I4 4 Highest number of long buffers active since Broker started.

SHORT-ACT I4 4 Number of short buffers active.

SHORT-HIGH I4 4 Highest number of short buffers active since Broker started.

ALLOW-DURABLE

Durable subscriber flag:

`0`	`NO`
`1`	`YES`

ALLOW-SUBSCRIBE

Allow SUBSCRIBE request?

`0`	`NO`
`1`	`YES`

AUTO-COMMIT

Auto commit:

`0`	`NO`
`1`	`YES`

UNUSED1 I1 4 Unused.

NUM-PUBLICATION I4 5 Number of publications.

NUM-SUBSCRIBER I4 5 Number of subscribers.

NUM-LONG-MSG-BUFFER I4 5 Number of long message buffers.

NUM-SHORT-MSG-BUFFER I4 5 Number of short message buffers.

CONVERSION-PARMS A255 5 Conversion parameters.

NOTUSED1 I2 5 Alignment.

MAX-PUBLICATION-MSG-SIZE I4 5 Max publication message size.

RESERVED I4 5 Reserved for future use.

USER-OBJECT (Struct INFO_USER)

Field Name Format CIS
Interface
Version Description / Action

USER-ID A32 7 Corresponds to USER-ID in the ACI. The maximum length of this field is determined by field MAX-UID-LEN in the header. See Common Header Structure.

IS-CLIENT

Is user a client?

`0`	`NO`
`1`	`YES`

IS-SERVER

Is user a server?

`0`	`NO`
`1`	`YES`

IS-PUBLISHER

Is user a publisher?

`0`	`NO`
`1`	`YES`

IS-SUBSCRIBER

Is user a subscriber?

`0`	`NO`
`1`	`YES`

SEQNO I4 7 Unique sequence number of user. Can be used with CIS command SHUTDOWN.

ENDIAN

Endian type of user's platform:

`1`	BIG ENDIAN (high order first)
`0`	LITTLE ENDIAN

CHAR-SET

Character set of user's platform:

`34`	EBCDIC IBM
`66`	EBCDIC SNI
`1`	ASCII PC 386
`16`	ASCII PC OS/2
`128`	ASCII 8859-1

P-USER-ID B28 7 Specifies the physical internal unique ID which is used to distinguish between several users with the same user ID. This field is used as a handle, i.e. no translation is performed. With CIS commands SHUTDOWN PARTICIPANT and SHUTDOWN SERVER, field SEQNO is provided as unique criterion.

TOKEN A32 7 Corresponds to TOKEN in the ACI. The maximum length of this field is determined by MAX-TK-LEN in the header. See Common Header Structure for Response Data.

LAST-ACTIVE I4 7 Elapsed time since the last activity of the user.

WORKER-OBJECT (Struct INFO_WKR)

Field Name Format CIS
Interface
Version Description / Action

WORKER-ID I2 1 The worker ID is the table number of this worker's worker queue entry.

WORKER-STAT

Status of worker:

`2`	`ACTIVE`
`4`	`STARTED`
`5`	`WAITING`

CALL-SUM I4 1 Sum of calls per worker since Broker started.

IDLE-SUM I4 1 Sum of idle time per worker since Broker started.

WORKER-USAGE-OBJECT (Struct INFO_WORKER-USAGE)

Field Name	Format	CIS Interface Version	Description / Action
`WORKER-MAX-ATTRIBUTE`	I4	7	Maximum number of worker tasks the Broker can use. See broker attribute `WORKER-MAX`.
`WORKER-MIN-ATTRIBUTE`	I4	7	Minimum number of worker tasks the Broker can use. See broker attribute `WORKER-MIN`.
`WORKER-NONACT-ATTRIBUTE`	I4	7	Non-activity time in seconds to elapse before a worker tasks is stopped. See broker attribute `WORKER-NONACT`.
`WORKER-QUEUE-DEPTH`	I4	7	Number of unassigned user requests in the input queue before another worker task gets started. See broker attribute `WORKER-QUEUE-DEPTH`.
`WORKER-START-DELAY-ATTRIBUTE`	I4	7	Delay after a successful worker task invocation before another worker task can be started. See broker attribute `WORKER-START-DELAY`.
`LAST-START-TIME`	I4	7	Time of last worker startup.
`LAST-STOP-TIME`	I4	7	Time of last worker stop.
`EFFECTIVE-START-DELAY-SECONDS`	I4	7	Time value representing the seconds of the timeval structure that contains the effective time consumption starting a worker task.
`EFFECTIVE-START-DELAY-MICRO-SECONDS`	I4	7	Time value representing the microseconds of the timeval structure that contains the effective time consumption starting a worker task.
`WORKER-HIGH`	I4	7	Highest number of worker tasks active since Broker started.
`WORKER-LOW`	I4	7	Lowest number of worker tasks active since Broker started.

SEARCH CONTENTS | PDF PAGE PDF BOOKS | HOME UP PREV NEXT