Using the CICS Monitor Exit Interface › GSVCMEI Macro—Interface to the Monitor Exit

GSVCMEI Macro—Interface to the Monitor Exit

The macro GSVCMEI is provided with CA SYSVIEW and provides an interface to its CICS monitor exit. Add the GSVCMEI macro to your existing packages to perform its functions.

Review the GSVCMEI macro format for the resources available for use when writing programs to communicate with the Monitor Exit Interface.

The GSVCMEI macro has the following format:

....+....1....+....2....+....3....+....4....+....5....+....6
MEIC		    GSVCMEI GEN_COMMAREA,DSECT=NO
	   EXEC CICS LINK PROGRAM('GSVCMEI')
		COMMAREA(MEIC)
		LENGTH(=AL2(MEIC_L))

MEIPL		    GSVCMEI GEN_PARMLIST,DSECT=NO
	   GSVCMEI function,			Call MEI
		NAME=,
		TYPE=,
		FIELD=,
		DATA=,
		PL=,
		OKRET=,
		WNRET=,
		ERRET=,

MEIC

The MEIC portion of the GSVCMEI macro demonstrates the command-level interface:

• Generate MEI COMMAREA to use with the CICS command-level interface:

  ....+....1....+....2....+....3....+....4....+....5....+....6
  MEIC		    GSVCMEI GEN_COMMAREA,DSECT=NO
  

• CICS command-level interface to MEI:

  ....+....1....+....2....+....3....+....4....+....5....+....6
              EXEC CICS LINK PROGRAM('GSVCMEI')
  		  COMMAREA(MEIC)
  		  LENGTH(=AL2(MEIC_L))
  

MEIPL

The MEIPL portion of the GSVCMEI macro demonstrates the assembler macro interface:

• Generate MEI parameter list to use with the assembler macro interface:

  ....+....1....+....2....+....3....+....4....+....5....+....6
  MEIPL		    GSVCMEI GEN_PARMLIST,DSECT=NO
  

• Generate MEI assembler macro interface calls:

  ....+....1....+....2....+....3....+....4....+....5....+....6
  	  GSVCMEI function,		    Call MEI
  		NAME=,
  		TYPE=,
  		FIELD=,
  		DATA=,
  		DATALEN=,
  		PL=,
  		OKRET=,
  		WNRET=,
  		ERRET=,
  

  function

  Note: For usage details on these functions, see the programming examples in topics Use the Assembler Macro Interface Coding Method or Use the EXEC CICS Command Level Program Coding Method.

  The following functions are available:

  SET_UMBRELLA_NAME - Provides an umbrella transaction name and optionally an umbrella type to associate with the transaction.

  PROGRAM_USAGE - Provides the name of a program that is being used. This function tracks program usage within other products, such as fourth-generation products.

  START_CLOCK - Starts the timing of an event or function. After the timed event or function completes, issue a STOP_CLOCK function call. The START_CLOCK function can be nested.

  STOP_CLOCK - Stops the timing of an event or function. Precede each STOP_CLOCK function with a START_CLOCK function call.

  START_EVENT - Starts the timing of an event or function. After the timed event or function completes, issue a STOP_EVENT function call. The START_EVENT function can be nested. Each event can be assigned a 16-character event name and a 16-character event type.

  STOP_EVENT - Stops the timing of an event or function. Precede each STOP_EVENT function with a START_EVENT function call.

  SET_FIELD - Provides data to store in the requested collection field.

  GET_FIELD - Retrieves data from the requested collection field.

  SET_USERDATA - Provides a user-defined data value to be associated with the executing transaction.

  GET_USERDATA - Retrieves a previously stored user-defined data value for the executing transaction.

  NAME=

  Specifies the resource name for the function being called.

  TYPE=

  Specifies a type value, relative to the function being called and the NAME= value provided.

  FIELD=

  Specifies the field code

  DATA=

  Specifies the data value for function calls SET_FIELD, GET_FIELD, SET_USERDATA, GET_USERDATA.

  DATALEN=

  Specifies the length of the DATA= value for the SET_USERDATA and GET_USERDATA function calls.

  PL=

  Specifies the parameter list name. The default is MEIPL.

  OKRET=

  Specifies a branch label to use when the return code equals zero (0).

  WNRET=

  Specifies a branch label to use when the return code equals four.

  ERRET=

  Specifies a branch label to use when the return code is not equal to zero or four.

Note: The MEISAMP member in the sample library contains sample MEI calls.

More information:

Decide What Coding Method to Use