LIST function

The LIST function corresponds to any of the views that lists items, such as TOBJO. The LIST function returns a list of REXX stem variables for the following items:

Objects
Sets
Object Definition Bases
Calendar Definition Bases
Day calendar entries
Time calendar entries
Period calendar entries
Calendar set entries
Layer sysplex
System layers
Sysplex layers
System pools
TOM System

Related topic

Using-the-TOM-programming-interface

Use the optional STEM keyword to specify the REXX stem name. If you do not specify the REXX stem name, the default stem name is LINE.

The variables are returned as follows:

LINE.0 contains the number of objects, sets, object Definition Bases, calendar Definition Bases, day calendar entries, time calendar entries, period calendar entries, calendar set entries, layer sysplex, system layers, or sysplex layers.
LINE.n contains the name of each object, set, object Definition Base, calendar Definition Base, day calendar entry, time calendar entry, period calendar entry, calendar set entry, layer sysplex, system layer, or sysplex layer.

Before the TOMEXEC FUNC(LIST) TYPE(OBJECT|SET) request, set:

stem.LIST.KEEP = “Y”

to indicate that TOMEXEC FUNC(LIST) TYPE(OBJECT|SET) should return a token that can be used on subsequent TOMEXEC FUNC(GET) OBJECT|SET requests. The use of this token will allow subsequent FUNC(GET) requests to use the Registry information which was created by FUNC(LIST) instead of reading the information from the Registry. This will eliminate the overhead of reading the Registry for each subsequent FUNC(GET) request, improving performance. Note that any changes to objects or sets in the Registry after the FUNC(LIST) will not be reflected in subsequent FUNC(GET) requests which pass the token. Depending on what information is needed, this may be acceptable. If the most current information is always required, do not use this feature.

If stem.LIST.KEEP=“Y” prior to the FUNC(LIST) request, save the value returned in the stem.LIST.TOKEN variable into a local variable after the FUNC(LIST) request completes. The following statements show an example of saving the token in the token.list local variable.

token.list = ‘’

token.list = line.list.token

This value of this local variable can then be passed to subsequent FUNC(GET) requests to eliminate Registry accesses. Refer to the information on the GET function to use this token on FUNC(GET) requests.

When processing of the data returned by FUNC(LIST) is completed, delete the list storage and the token in the TOM Product Address Space (PAS) by setting the following variables and making another FUNC(LIST) request:

drop line.

line.list.keep = “N”

line.list.token = token.list

If this request is not made, TOM will retain the storage and the token for 30 minutes and then it will be deleted.

There is a limit of four outstanding concurrent instances of the lists created by stem.LIST.KEEP=”Y” FUNC(LIST). If more are requested, FUNC(LIST) will complete with TOMRC=101 and an exception message will be set in REXX variable stem.EXCEPT.1.

The following table shows the command and parameters:

Command	Parameters
TOMEXEC FUNCTION(LIST)	TYPE(OBJECT \| SET \| DAY \| PERIOD \| TIME \| CALSET \| SYSLAYER \| PLEXLAYER \| LAYERPLEX \| OBJBASE \| CALBASE \| TOMSYSTEM \| SYSPOOL [STEM(LINE)] [CALBASE(calbase) \| DEFBASE(objbase) \|DB(objbase)] [SYSPLEXsysplex)] [TOMID(tom ID) \| TOMPLEX( tomplex name)] \| REALTIME

The following table describes the parameters:

Parameter	Function
TYPE	Specify one of the following possible values: OBJECT: lists all objects in the specified Definition Base SET: lists all the SETs in the specified Definition Base DAY: lists all the DAY entries in the specified calendar base PERIOD: lists all the PERIOD entries in the specified calendar base TIME: lists all the TIME entries in the specified calendar base CALSET: lists all the CALSET entries in the specified calendar base CALBASE: lists all the calendar bases in the Registry OBJBASE: lists all the object Definition Bases in the Registry LAYERPLEX: lists all the layer sysplexes in the specified Definition Base PLEXLAYER: lists all the sysplex layers in the specified Definition Base SYSLAYER: lists all the system layers in the specified Definition Base TOMSYSTEM: lists all of the TOM instances of each TOMPLEX for each sysplex with which the issuing TOM can communicate SYSPOOL: lists all the system pools
STEM	Specify the prefix of the REXX stem variables that contain the properties of the object (or set). The default REXX stem value is LINE. Stem variables are returned to the EXEC after the EXEC successfully completes running. Each variable contains the name of an item (such as an object, set, and so on) that is retrieved from the Definition Base.
CALBASE	Specify the name of the calendar base you want to list from. The default is the active calendar base.
DEFBASE	Specify the object Definition Base you want to list from. The default is the active Definition Base.
SYSPLEX	Specify the name of the SYSPLEX under which the items are stored in the Registry. The default is the local sysplex.
TOMID	Specify the ID of the TOM PAS on which you want the command issued.
TOMPLEX	Specify the name of the TOMPLEX where you want to issue the function. See Specifying-the-TOMID-and-TOMPLEX-parameters for usage information.
REALTIME	Specify the REALTIME keyword so that object attributes are inherited from models and all attributes that specify a variable have the resolved value of the variable at the time it is obtained. If a variable cannot be resolved, the attribute contains the variable name.

This section contains the following topics:

LIST function

On this page