STP Procedure

LIST Statement

Lists details about the stored process that are specified by the PROGRAM= option

Optional Argument

Syntax

LIST< GROUP=level | (level1...leveln)>;

Optional Argument

GROUP=level | (level1...leveln)

specifies the level of detail that is listed about the stored process that is specified by the PROGRAM= option. The stored process is not executed. Specify one or more of the following levels:

GENERAL	specify this level in order to view a list that contains the following details: stored process name, description, creation date, modification date, keywords, responsible parties.
EXECUTION	specify this level in order to view a list that contains the following details: logical server, source in metadata, source code repository, result type.
INPUTPARAM	specify this level in order to view a list that contains a list of input parameters for this stored process that are defined in metadata or are defined via an INPUTPARAM statement in PROC STP. Some input parameters, such as _METAPERSON, _METAUSER, and _CLIENT, are automatically defined in metadata without user input.
OUTPUTPARAM	specify this level in order to view a list that contains details about output parameters that are defined in metadata.
INPUTDATA	specify this level in order to view a list that contains details about input data streams that are defined in metadata.
OUTPUTDATA	specify this level in order to view a list that contains details about output data streams that are defined in metadata.

Details

The LIST statement displays the metadata attributes of the stored process that are specified in the PROGRAM= option of the PROC STP statement. These attributes are displayed in the SAS log. The stored process does not run when the LIST statement is used.

Examples

Example 1

The following example uses the GROUP=GENERAL option with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=general;
run;

The following output displays in the SAS log:

NOTE: PROC_STP: ====== Metadata Listing for /Users/johndoe/procstp/myStoredProcess ======
NOTE:            Stored Process Name:  myStoredProcess
NOTE:            Description:  Stored Process description to demonstrate the List statement.
NOTE:            Creation Date:  21Dec2010:14:58:53
NOTE:            Modification Date:  21Dec2010:14:58:53
NOTE:            Keywords:  demo
NOTE:                       list
NOTE:            Responsible Parties:  sasadm
NOTE:                                  sasdemo

Example 2

The following example uses the GROUP=EXECUTION option with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=execution;
run;

The following output displays in the SAS log:

NOTE: PROC_STP: ====== Metadata Listing for /Users/johndoe/procstp/myStoredProcess ======
NOTE:            Server Context:  johndoe
NOTE:            Stored Process code may run on any available server
NOTE:            Execution required to be on johndoe application server only
NOTE:            Source Code Repository:  c:\johndoe\progs
NOTE:            Source File:  myStoredProcess.sas
NOTE:            Result Type:  Packages No
NOTE:                          Streaming Yes

Example 3

The following example uses the GROUP=INPUTPARAM option with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=inputparam;
   inputparam y=2;
run;

The following output displays in the SAS log:

NOTE: PROC_STP: ====== Metadata Listing for /Users/johndoe/procstp/myStoredProcess ======
NOTE:            Input Parameters:   x = 5
NOTE:                                Y = 2
NOTE:                                _result = STREAM
NOTE:                                _metaperson = sasadm
NOTE:                                _metauser = sasadm@saspw
NOTE:                                _client = PROCSTP; TKESTP; JVM 1.6.0_21; Windows XP (x86)
      5.1

Example 4

The following example uses the GROUP=OUTPUTPARAM option with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=outputparam;
run;

The following output displays in the SAS log:

NOTE: PROC_STP: ====== Metadata Listing for /Users/johndoe/procstp/myStoredProcess ======
NOTE:            Output Parameters:  results Integer
NOTE:                                mean Double

Example 5

The following example uses the GROUP=INPUTDATA option with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=inputdata;
run;

The following output displays in the SAS log:

NOTE: PROC_STP: ====== Metadata Listing for /Users/johndoe/procstp/myStoredProcess ======
NOTE:            InputData Sources available:
NOTE:                 Source: Generic  Fileref:  istream
NOTE:                     Label: instream
NOTE:                     Expected content type: application/unknown
NOTE:                     Description: Input data stream for stored process
NOTE:                     Allow rewinding stream: Yes

Example 6

The following example uses the GROUP=OUTPUTDATA option with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=outputdata;
run;

The following output displays in the SAS log:

NOTE: PROC_STP: ====== Metadata Listing for /Users/johndoe/procstp/myStoredProcess ======
NOTE:             OutputData Sources available:
NOTE:                 Target: Data Table  Table Parameter:    class
NOTE:                     Label: class
NOTE:                     Description: Output data table from stored process execution

Example 7

The following example shows how to use multiple options with the LIST statement:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=( general execution inputparam outputdata );
run;

Example 8

When the LIST statement has no arguments, it is functionally equivalent to having all the group options set. So the following two LIST invocations produce the same output:

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list;
run;

PROC STP PROGRAM='/Users/johndoe/procstp/myStoredProcess';
   list group=( general execution inputparam outputparam inputdata outputdata );
run;

Copyright © SAS Institute Inc. All rights reserved.