Verbs and Built-in Functions › &PPI

&PPI

Provides a facility for programs to exchange data. Each of the &PPI options shown in the syntax below is described individually following this generic description.

&PPI ALERT [ OPT={ NONE | ASIS | HEXPACK } ]
           [ DATA=data |
             VARS=prefix* [ RANGE=(start,end) ] |
             ARGS [ RANGE=(start,end) ] |
             VARS={ var | ( var1, var2, ..., varn ) } |
             MDO=mdoname ]

&PPI DEACTIVATE [ MAXQUEUE=n ]

&PPI DEFINE ID={ * | name } [ MAXQUEUE=n ]

&PPI RECEIVE [ WAIT={ YES | NO | n | NOTIFY } ]
             [ OPT={ NONE | ASIS | HEXEXP } ]
             [ VARS={ var | ( var1, var2, ..., varn ) } |
               VARS=prefix* [  RANGE=( start,end ) ] |
               ARGS [ RANGE=( start,end ) ] |
               STRING=( name, name, ..., name ) |
               MDO=mdoname [ MAP=map ] }

&PPI SEND TOID=name 
        [ OPT={ NONE | ASIS | HEXPACK } ]
        [ DATA=data |
          VARS=prefix* [ RANGE=( start,end ) ] |
          ARGS [ RANGE=(start,end) ] |
          VARS={ var | ( var1, var2, ..., varn ) } |
          MDO=mdoname ]

&PPI STATUS [ ID=name ]

The Program-to-Program Interface (PPI) provides a general purpose facility to exchange data between programs written in any language. It also provides a facility for any program to forward a generic alert to your product region. No special authorization is required to use PPI and it does not depend on having your product region running.

This implementation of PPI is supported on z/OS, MSP, MSP/AE, MSP/EX, and VOS3. The PPI implementation can use Cross-Memory Services or Service request Block (SRB) scheduling, so that MSP is supported.

The NCL &PPI verb provides access to your product. This interface allows any programming language to freely exchange information.

Note: The API provided by the Program-to-Program Interface is described in IBM's NetView Application Programming Guide: Program to Program Interface (SC31-6093-0).

PPI services is provided by the SOLVE Subsystem Interface (SSI) or by the NetView Subsystem Interface.