Each CICSPlex® SM managed object is represented externally by a resource table. A resource table defines all the attributes of an object. The attributes represent the collection of data that is available for that object.
The formal object name is used as the name of the resource table that describes the object's attributes. You identify an object in your API program by specifying its resource table name. For example, to find out about the programs in one or more CICS® systems, you could access the PROGRAM object. PROGRAM is the name of the CICSPlex SM resource table that describes CICS programs.
Each instance of an object is formatted as a resource table record that describes an actual resource in the CICSPlex SM environment. The object attributes are presented in the individual fields of a resource table record. It is important to note that a resource table is not itself an object. A resource table record is merely the format in which information about a managed object is returned by CICSPlex SM. This information includes the current attribute values, the actions that the object supports, and the releases of CICS for which the object is valid.
There is a resource table type for each type of CICSPlex SM managed object:
For a summary of the CICSPlex SM resource tables by type and complete descriptions of specific resource tables see the Resource table summary in the CICSPlex System Manager Resource Tables Reference.
Certain attributes in the CICSPlex SM resource tables are for internal use only; they cannot be modified or manipulated by an API program.
In CICS Resource and CICS Monitored tables, CICSPlex SM uses the following attributes to identify uniquely which CICS system contains the resource:
These attributes are included in every CICS Resource and CICS Monitored resource table record. You can specify these attributes in a GROUP command to summarize the records in a result set. However, you should not specify these attributes in an ORDER, SPECIFY FILTER, or SPECIFY VIEW command.
CPSM Definition and CICS Definition tables include a CHANGETIME attribute, which reflects the date and time at which the definition was last modified. CICS Definition tables also include a CREATETIME attribute, which is the date and time at which the definition was created. CICSPlex SM is solely responsible for maintaining the CHANGETIME and CREATETIME attributes; you should not attempt to modify these attribute values.
Normally, when you create a result set, each resource table record contains the complete set of attributes in the format defined by CICSPlex SM. There may be times, however, when you want to work with a subset of those attributes or work with them in a different order. The SPECIFY VIEW command lets you decide which attributes of a resource table to include in a record and what order to present them in. In effect, you are building a temporary, custom-made resource table.
You can build views only for resource tables with a type of CICS Resource; you cannot build views for any other type of resource table. Also, a view can be built from the attributes of only one resource table at a time. You cannot combine attributes from different resource tables into a single view.
When you build a resource table view, you have to give it a name. The name you assign to a view takes precedence over any existing resource table names. This means you can redefine an existing resource table name to represent a subset of the attributes in a different order than they appear in the original table.
For ease of maintenance of your programs, you are recommended to give unique names to your customized resource table views. If you do not use unique names, you should be aware that you cannot access another view with the same name in the same processing thread, without the programming overhead of discarding the original view. You should also check, when you upgrade your version of CICSPlex SM, that any new resource tables do not duplicate your customized view names.
To tell CICSPlex SM which resource table attributes you want to include and in what order, you specify an order expression on the FIELDS option of the SPECIFY VIEW command. This expression is similar to the one you use when sorting records in a result set with the ORDER command. The order expression consists of a list of the attributes to be included in the view.
The syntax of an order expression for building a view is:
Order Expression - Building a View .-,--------. V | >>---+------+-+-.---------------------------------------------->< '-attr-'
where:
You can specify as many attribute names as you like, but the total length of an order expression, including commas and blank spaces, must not exceed 255 characters. If you do not specify an attribute name, the order expression will, by default, contain the name of the first attribute in the resource table, for example, the JOBNAME attribute in the CICSRGN resource table.
For example, to build a limited view of the LOCTRAN resource table, you could specify:
TRANID,STATUS,USECOUNT,PROGRAM,PRIORITY,TRANCLASS.
Once a view is built, you can specify it on the OBJECT option of a GET command, just as you would the resource table itself. The resource table records returned by GET include only those attributes you named in the order expression on the SPECIFY VIEW command.
Any views that you build are associated with the specific processing thread on which you build them; they cannot be shared by other processing threads. When you terminate your processing thread, any views you built on it are discarded. You can also choose to discard a view at any time by using the DISCARD command.
You can build a structure for your customized view by using the SPECIFY VIEW, GET and FETCH commands to move the data into your structure. For example:
*****************************************************
* SPECIFY VIEW *
*****************************************************
STRING 'POOLNAME,MINITEMLEN,QUELENGTH,NUMITEMS,'
'RECOVSTATUS,MAXITEMLEN,LASTUSEDINT,'
'NAME,TRANSID,LOCATION.'
DELIMITED BY SIZE INTO BUFFERA.
MOVE 96 TO BUFFERL.
EXEC CPSM SPECIFY
VIEW('VTSQSHR')
FIELDS(BUFFERA)
LENGTH(BUFFERL)
OBJECT('TSQSHR')
THREAD(TTKN(1))
RESPONSE(SMRESP)
REASON(SMRESP2)
END-EXEC.
The associated structure will consist of each attribute specified in the SPECIFY VIEW FIELDS keyword and is shown in Figure 3.
01 VTSQSHR.
* Shared Temporary Storage Queue
02 POOLNAME PIC X(0008).
* TS Pool Name
02 MINITEMLEN PIC S9(0004) USAGE BINARY.
* Smallest item Length in bytes
02 QUELENGTH PIC S9(0008) USAGE BINARY.
* Total length in bytes . FLENGT
02 NUMITEMS PIC S9(0004) USAGE BINARY.
* Number items in queue
02 RECOVSTATUS PIC S9(0008) USAGE BINARY.
* Recovery Status
02 MAXITEMLEN PIC S9(0004) USAGE BINARY.
* Largest item length in bytes
02 LASTUSEDINT PIC S9(0008) USAGE BINARY.
* Interval since last use
02 NAME-R PIC X(0016).
* Queue Name -- RESERVED WORD --
02 TRANSID PIC X(0004).
* Trans that created tsqueue
02 LOCATION PIC S9(0008) USAGE BINARY.
* Queue Location
Note that the EYU-CICSNAME, EYU-CICSREL, and EYU-RESERVED attributes or any field alignment or padding attributes are not used in this structure.
[[ Contents Previous Page | Next Page Index ]]