Process Macros › SVAPI Macro

SVAPI Macro

The SVAPI macro executes the $RMCALL API. The macro inherits the $RMCALL return code.

Parameters: SVAPI Macro

• Opt

  Refers to the requested option and is automatically set to SERVICE.

• Service

  Refers to the requested SERVICE and is automatically set to ACTION.

• Action

  Mandatory field that identifies the type of processing required. The value of this field must be one of the following:

  • COMMAND issues an Automation Services command.
  • DBGET retrieves the definition of a resource or service specified by the SysName, Version, Class, and Name fields. The information is stored in the &ZRMDB prefixed variables.
  • STGET retrieves the current status of the resource or service specified by the SysName, Version, Class and Name fields. The information is stored in the &ZRMST prefixed variables.
• Command

  Identifies the required command if the value of the Action field is COMMAND.

• SysName

  Identifies the system image in which to perform the action. If this field is not completed, the current system image is assumed by default.

• Version

  Identifies the version of the system image in which to perform the action. If this field is not completed, the current system image is assumed by default.

• Class

  Identifies the resource or service class.

• Name

  Identifies the resource or service.

• Parms

  Specifies the parameters required by the command specified in the Command field.

Example: SVAPI Macro

In the following example, the macro sets the actual state of the local CICSA resource to ACTIVE.

 PROD------ Automation Services : SVAPI Macro Parameter Definition -------------
 Command ===>                                                    Function=UPDATE

 .- API Parameters ------------------------------------------------------------.
 |                                                                             |
 |  Opt ........ SERVICE              Service .... ACTION                      |
 |                                                                             |
 |  Action ..... COMMAND              Command .... ASA                         |
 |                                                                             |
 |  SysName ....                      Version ....                             |
 |                                                                             |
 |  Class ...... 02                   Name ....... CICSA                       |
 |                                                                             |
 |  Parms ......                                                               |
 |                                                                             |
 '-----------------------------------------------------------------------------'





  F1=Help      F2=Split     F3=OK
                            F9=Swap                               F12=Cancel