CICS

Link to PGM001. No PSB is active and no arguments pass.

LINK PGM001

Link to the program stored in WS-PROGNAME. No PSB is active and no arguments pass.

LINK /WS-PROGNAME

Move the value PGM003 to WS-PROGNAME and link to that program.

LINK PGM003/WS-PROGNAME

Link to PGM004; execute an error routine for an abnormal condition. There is no active PSB and no arguments pass.

LINK PGM004 ERROR-PARA

Link to PGM005. Schedule a PSB and use a PCB named ABC-PCB for the linked-to program. Omit the positional parameter errorpara .

LINK PGM005 * DLIUIB ABC-PCB

Link to PGM006 and pass a Linkage data area SCR6-RECORD so that PGM006 can move data directly to screen fields.

LINK PGM006 * SCR6-RECORD

Link to PROG001, a non-APS program, passing TP-USERAREA only.

LINK PROG001(NONAPS)

Link to PROG002, a non-APS program, passing the data area WS-COMMAREA.

LINK PROG002(NONAPS) * COMMAREA(WS-COMMAREA) LENGTH(100)

Link to PROG003, a non-APS program, without passing a COMMAREA.

LINK PROG003(NONAPS) * NOCA

IMS DC

The following examples show the CALL statements generated in the program after linking to subprograms.

Coding     LINK SUBPGM * ARG1 ARG2 ARG3
Yields CALL 'SUBPGM' USING TP-COMMAREA ARG1 ARG2 ARG3

Coding LINK SUBPGM * *NOSPA ARG1 ARG2 ARG3
Yields CALL 'SUBPGM' USING ARG1 ARG2 ARG3

Coding LINK SUBPGM * ARG1 TP-USERAREA ARG2 ARG3
Yields CALL 'SUBPGM' USING ARG1 TP-USERAREA ARG2 ARG3

ISPF Dialog

Invoke PGM001 as a new program function. The SELECT service option NEWPOOL creates a new shared variable pool. The SELECT option is in effect.

LINK PGM001 * NEWPOOL

Invoke PGM001 as a new program function. The SELECT service option PARM passes data to PGM001 via LINKAGE SECTION. To pass variable data, VDEFINE a dialog variable. The SELECT option is in effect.

DLG-VDEFINE 01  WS-EMPL-NBR  PIC X(05) AS EMPNBR
MOVE EMPL-NBR TO WS-EMPL-NBR
LINK PGM001 * PARM('&EMPNBR')
DLG-VDELETE EMPNBR

Link to the program in WS-PROGNAME. The CALL option is in effect.

MOVE 'PGM001' TO WS-PROGRAM
LINK /WS-PROGNAME

Link to PGM006 and pass Linkage data area SCR6-RECORD so that PGM006 can move data directly to screen fields. The CALL option is in effect.

LINK PGM006 * SCR6-RECORD

Code Working-Storage and Linkage data structures using section keywords.

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 IO     INPUT-FILE ASSIGN TO UT-S-INPUT
 FD     INPUT-FILE
        LABEL RECORDS ARE STANDARD 
        BLOCK CONTAINS 0 RECORDS
 01     INPUT-REC         PIC X(80).
 WS 
 REC    WS-INPUT-REC.
            WS-IN-PART-NO       N8
            WS-IN-DESC          X50
            WS-IN-BASE-PRICE    N6V2
 ++     PANWSREC
 LK
 REC    LK-INPUT-REC
            LK-IN-PART-NO       N8
            LK-IN-DESC          X50
            LK-IN-BASE-PRICE    N6V2
 01     LK-OUT-REC.
 DS05   LK-OUT-REC

REPORT CODE: MC01   APS APPLICATION PAINTER    PAGE  1
               MACRO/PROGRAM CROSS  REFERENCE    01/17/92   08:26
        MKTAPS.MKT2

 SELECTION CRITERIA: TDDEMO
 APPLICATION: TDDEMO

 
*********************************************************************************
                            MACROLIB.          PROGRAM / STUB TYPE   NO.OF TIMES
NAME OF MACRO / MACROLIB:   IND.               USING MACRO IND       MACRO CALLED
---------------------------------------------------------------------------------
CLEAR                                          TDCM                         1
                                               TDOM                         1
                                               TDPM                         1

DB-ERASE                                       TDCM                         1
                                               TDOM                         1
   TDPM  1
.
.
.
PX-CA-COMPUTE-LEN                              TDOM                         1

.
.
.
TP-ATTR                                        TDOM                         13
                                               TDOT                         1
TP-PERFORM                                     TDCM                         36
                                               TDCS                         27
                                               TDME                         3
                                               TDOJ                         27
                                               TDOM                         80
                                               TDOT                         16
                                               TDOU                         9
                                               TDPF                         7
                                               TDPL                         27
                                               TDPM                         36
.
.
.
XCTL                                           TDCM                         1
                                               TDCS                         1
                                               TDME                         7
                                               TDOJ                         1
                                               TDOM                         1
                                               TDOT                         1
                                               TDOU                         1    
                                               TDPF                         1
                                               TDPL                         1
                                               TDPM                         1
TOTAL MACROS & LIBRARIES REPORTED 14
NO. OF PGMS. WITH MACRO CALL IN CODE 10
NO. OF COMMON MACROLIBS IN APPLN. 0
TOTAL NO. OF PROGRAMS IN APPLN. 10

Define a trancode definition, consisting of a function key (values specified in the MFS Function Keys example on Example:), and the fields OPTION-PREFIX and NEXT-OPTION. If the end user enters no values in these two fields, the literal UPDTMENU transmits in the MID.

Reorder the fields in the first screen. The second screen sequences ERR-MSG after PAGING in the Working-Storage Section. The third screen shows the result.

-KYWD- 12-*----20---*----30---*----40---*----50---*----60
 RED   STOCK-REPORT
       CONTROLS ARE FINAL WS-LOCATION-CODE
       PAGE LIMIT IS 50
       FIRST DETAIL 10
       LAST DETAIL 40
       FOOTING 47.
 MOCK  STCKPRT
 01    TYPE IS REPORT HEADING NEXT GROUP 
           NEXT PAGE LINE 20.
       MOCKUP LINES 1 THRU 6
       SOURCE WS-DATE

Specify that lines 1 through 8 in the report mock-up contain the heading text.

-KYWD- 12-*----20---*----30---*----40---*----50---*----60
 01    TYPE IS REPORT HEADING LINE 20 NEXT GROUP
           NEXT PAGE.
       MOCKUP LINES 1 THRU 8

REPORT CODE: REPT                     APS ENTITY REPORT FACILITY                    PAGE    1
                                              CLSAPS.CLS2                      01/18/92 15:01
REPORT CRITERIA: 2
           ALL MEMBERS OF LIBRARY TYPE : RP
*********************************************************************************************
           LIBRARY      ENTITY
           TYPE         NAME                      STATUS                     REMARKS
---------------------------------------------------------------------------------------------

           RP           COSTRPT                   REPORTED
           RP           MERPT                     REPORTED

REPORT CODE: RP01                        APS APPLICATION PAINTER                  PAGE     1
                                       APPLICATION DEFINITION REPORT          01/18/92 15:01
                                                CLSAPS.CLS2

SELECTION CRITERIA: COSTRPT
*******************************************************************************************
REPORT: COSTRPT                                                            CREATED: 07/27/90
AUTHOR: CLSONE                                                             UPDATED: 07/27/90
*************************************************************************************************
 
             USER MANUFACTURING COMPANY
         EXPENDITURES REPORT AS OF XXXXXXXX

                                  NO                                   CUMULATIVE
MONTH      DAY      DEPT          PURCHASES    ITEM         COST       COST 
XXXXXXXXX  EXPENDITURES
XXXXXXXXX    XX     XXX           2Z9           X           ZZ9.99
TOTAL COSTS FOR W/E                 XXXXXXXXX   XX        Z,ZZ9.88     ZZ,ZZ9.99
 TOTAL COSTS FOR XXXXXXXXX  ZZ,ZZ9.99
TOTAL EXPENDITURES FOR YEAR-TO-DATE  ZZZ,ZZ9.99

PAGE ZZZ9
END OF REPORT

REPORT CODE:RP01                  APS APPLICATION PAINTER                       PAGE     1
                              APPLICATION DEFINITION REPORT               01/18/92   15:01
                                      CLSAPS.CLS2

        SELECTION CRITERIA: MERPT
*******************************************************************************************
        REPORT: MERPT                                                    CREATED: 08/24/90
        AUTHOR: CLSTRA                                                   UPDATED: 08/24/90
*************************************************************************************************
                               USER MANUFACTURING COMPANY
                          EXPENDITURES REPORT AS OF XXXXXXXX

                                     NO                                 CUMULATIVE
MONTH        DAY          DEPT       PURCHASES     ITEM      COST       COST        
XXXXXXXX     EXPENDITURES
XXXXXXXX     XX           XXX        2Z9           X       ZZ9.99
TOTAL COSTS FOR W/E XXXXXXXX XX                          Z,ZZ9.99       ZZ,ZZ9.99
TOTAL COSTS FOR XXXXXXXX  ZZ,ZZ9.99
TOTAL EXPENDITURES FOR YEAR-TO-DATE ZZZ,ZZ9.99

PAGE ZZZ9
END OF REPORT

Send messages to another program; perform error routine when error occurs.

MSG-SW trancode PROCESS-ERRORS

Send messages and pass a screen record. Note that the asterisk (*) replaces the positional parameter errorpara.

MSG-SW trancode * SCRA

Send messages and pass a COBOL record.

MSG-SW trancode * WS-CUSTOMER RECORD

Generate code to receive screen SCRA when the program is screen-invoked. Specify that the program can receive a screen that contains invalid data. Omit the error paragraph.

-KYWD-  12--*--20---*----30----*---40---*----50---*----60
 NTRY   SCRA * NORETRY

Receive multiple screens and include an error routine. Note that when you use SCRNLIST, you do not specify any screens in the NTRY statement.

-KYWD-  12--*--20---*----30----*---40---*----50---*----60
 SYM1   SCRNLIST C1ORDR C2ORDR C3ORDR
 NTRY   * PROCESS-ERRORS

CICS

Generate code to receive screen CUSTORDR in mapset CUSTOR$ for a screen-invoked program. Perform MAP-ERROR-PARA when an exceptional condition occurs on the RECEIVE MAP.

-KYWD-  12--*--20---*----30----*---40---*----50---*----60
 NTRY   CUSTODR(CUSTOR$) MAP-ERROR-PARA

IMS DC

Receive a message into a COBOL record I/O area.

-KYWD-  12--*--20---*----30----*---40---*----50---*----60
 NTRY   WS-CUSTOMER * *RECORD

DLG

Generate code to display screen SCRA. Perform PROCESS-ISPF-ERRORS when return codes from services are greater than 12. Generate CONTROL ERRORS RETURN code so the program can control all error processing.

-KYWD-  12--*--20---*----30----*---40---*----50---*----60
 NTRY   SCRA  PROCESS-ISPF-ERRORS  RETURN

ISPF Dialog

Generate code to display screen SCRA. Perform PROCESS-ISPF-ERRORS when return codes from services are greater than 12. Generate CONTROL ERRORS RETURN code so the program can control all error processing.

-KYWD-  12--*--20---*----30----*---40---*----50---*----60
 NTRY   SCRA  PROCESS-ISPF-ERRORS  RETURN

NULL Indicator Field

Compatibility:

SQL target

Description:

Use a null indicator variable to indicate whether the associated host variable has been assigned a null value.

Syntax:

APS/SQL generates a null indicator variable in Working-Storage, defined as follows.

01  IND-cursorname|IND-recordname
    05  IND-column

Comments:

• When using indicator variables, prefix them with the 01 level name, because APS can generate duplicate names with different 01 levels.

• When column contains an underscore, it changes to a hyphen at program generation.

• Normally, the IND-cursorname structure references a cursor set. To override this structure when generating indicator variables, set the &D2-USE-CURSOR-IND flag to NO in the APS CNTL member APDB2IN. This generates the indicator variables with the IND-recordname structure.

OCCURS

Category:

Data Structure Painter construct (see Data Structures)

Description:

Code OCCURS clauses in your data structures.

Syntax:

dataname(OCCURSclause) [TIMES]
[... DO|ODO dataname]
[... IX|IB|IXB|IXBY dataname]
[... ASCENDING KEY IS dataname] 
[... DESCENDING KEY IS dataname]
 ... PICformat

Shorthand syntax for the dimensions of a table in an OCCURS clause.

Parameters:

Comment:

Always code an INDEXED BY clause on a continuation line.

Examples:

-LINE- ------- Data Structure Painter --------
000001    EXDS-TABLE
000002        EXDS-TABLE-3  (1-99)
000003        ... ODO EXDS-TABLE-3-SIZE
000004        ... IXB EXDS-INDEX
000005        ... X20

01  EXDS-TABLE.
    05  EXDS-TABLE-3 OCCURS 1 TO 99
                     DEPENDING ON
                     EXDS-TABLE-3-SIZE
                     INDEXED BY EXDS-INDEX
                     PIC X(20).

-LINE- ------- Data Structure Painter --------
000001      TYPE-DESC-RATE-CONSTANTS X90
000002      TYPE-DESC-RATE-TABLE-REDEF R
000003          TYPE-DESC-RATE-TABLE (30)
000004          ... ASCENDING KEY IS TYPE-CODE
000005          ... IXB DATA-INDEX
000006              TYPE-CODE X
000007              DESC-CODE X
000008              RATE-CODE X

01  TYPE-DESC-RATE-CONSTANTS    PIC X(90).
01  TYPE-DESC-RATE-TABLE-REDEF  REDEFINES
                TYPE-DESC-RATE-CONSTANTS.
    05  TYPE-DESC-RATE-TABLE    OCCURS 30
                ASCENDING KEY IS TYPE-CODE
                INDEXED BY DATA-INDEX.
        10  TYPE-CODE           PIC X.
        10  DESC-CODE           PIC X.
        10  RATE-CODE           PIC X.

-LINE- ------- Data Structure Painter --------
000001    LOAN-RATE-TABLE
000002        LOAN-RATE-ROW OCCURS 10 TIMES
000003        ... ASCENDING KEY IS TYPE-CODE
000004        ... IXB DATA-INDEX
000005            TYPE-CODE  PIC X(05)

01  LOAN-RATE-TABLE.
    05  LOAN-RATE-ROW       OCCURS 10 TIMES
                    ASCENDING KEY IS TYPE-CODE
                    INDEXED BY DATA-INDEX.
        10 TYPE-CODE            PIC X(05).

OPT

Category:

Program Painter and Specification Editor keyword (see Keywords)

Compatibility:

Programs created in Program Painter

Description:

Suppress the mainline program section generated by the NTRY or PROC keyword, in order to supply your own screen and program invocation logic. Use OPT only in programs with screens.

Syntax:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 NTRY|
 PROC
 OPT    PROG

Comment

• You can use PROGRAM, PROGRAMMER, PCONV, or PCONVERT in place of PROG.

• Code an NTRY, PROC, or OPT statement for each program.
  • To generate a batch program template with a PROCEDURE DIVISION USING statement, code PROC.

  • To generate a program template that fully defines all parts of your program except for the procedural code that you supply, code NTRY.

OVERPRINT

Category:

Report Writer statement (see Report Writer Structures and the APS User's Guide chapter Create Reports with Report Writer)

Compatibility:

Batch environments

Description:

Print one line on top of the other without advancing the line printer. Use this feature to create bold text or to underscore text.

Syntax:

OVERPRINT|O WHEN 'characterstring' AT COLUMN integer

Parameters:

Comment:

In the mock-up, the two lines of text that print on one line of the page must be consecutive. On the first line enter a text string. On the second line enter the text that prints over the first line, and to the right of this text enter a unique characterstring to identify the line. When the report prints, blanks replace characterstring in the mock-up.

Examples:

XXXXXXX
_______                                                                  NO ADVANCING

-KYWD- 12-*----20---*----30---*----40---*----50---*----60
 01    TYPE IS PAGE HEADING.
       MOCKUP LINES 7 THRU 9
       OVERPRINT WHEN 'NO ADVANCING' AT COLUMN 70

XXXXXXX

WIDGETS
WIDGETS
DITTO

-KYWD- 12-*----20---*----30---*----40---*----50---*----60
 01    TYPE IS REPORT HEADING LINE 20 NEXT GROUP NEXT PAGE.
       MOCKUP LINES 1 THRU 6
       OVERPRINT WHEN 'DITTO' AT COLUMN 70

WIDGETS

PAGE LIMIT

Category:

Report Writer clause (see Report Writer Structures and the APS User's Guide chapter Create Reports with Report Writer)

Compatibility:

Batch environments

Description:

Define the page length and the vertical subdivisions of a printed page.

Syntax:

PAGE LIMIT IS|ARE number [LINE|LINES]
    [FIRST DETAIL linenumber]
    [LAST DETAIL linenumber]
    [FOOTING linenumber] [.]

Parameters:

Comments:

• Code PAGE LIMIT before FIRST DETAIL, LAST DETAIL, or FOOTING.

• Code FIRST DETAIL, LAST DETAIL, and FOOTING in any order.

• Each report group should fit on one page; Report Writer never splits a report group across page boundaries.

• Coding PAGE LIMIT assumes default values.

• Omitting FIRST DETAIL assigns the heading line value to linenumber.

• Omitting either LAST DETAIL or FOOTING assigns the PAGE number value to them.

• Coding FOOTING without LAST DETAIL assigns the FOOTING linenumber to LAST DETAIL linenumber.

• Coding LAST DETAIL without FOOTING assigns the LAST DETAIL linenumber to FOOTING linenumber.

• Omitting PAGE LIMIT generates a single-page report of indefinite length without page and line counter registers.

Example:

-KYWD- 12-*----20---*----30---*----40---*----50---*----60
 RED   STOCK-REPORT
       CONTROLS ARE FINAL WS-LOCATION-CODE
       PAGE LIMIT IS 50
       FIRST DETAIL 10
       LAST DETAIL 40
       FOOTING 47.

Panel Options, ISPF Dialog

Compatibility:

ISPF Dialog target

Category:

Screen Painter feature

Description:

Generate native panel definition statements.

Procedure:

To generate native panel definition statements, follow these steps.

1. From any screen in the Screen Painter, select Actions ISPF Panel Options from the action bar or enter is in the Command field. The ISPF Panel Options screen displays.

2. Complete the screen fields as follows:

   Field	Description and Values
   Command Field	Enter screen field name for the panel command field that allows end users to enter ISPF commands and prevents truncation errors when they use PF keys. Default is the first unprotected I/O field on the screen. This option generates the native )BODY CMD(variable) statement.
   Long Message Short Message	Enter sysmsg, if specified on Screen Generation Parameters screen, or a screen field name for the panel long and short message fields. These fields allow the program to move literal messages to the screen. These options generate the native )BODY LMSG(variable) statement for the long message and the )BODY SMSG(variable) statement for the short message.
   Help Panel	Enter the name of the panel to display, if the end user requests help. This option generates the HELP = panelname statement.
   Pfkey Option	P Program controls PF key processing. APS saves the end user's original PF key values and replaces them with literals not recognized by ISPF, so that you can control the PF key usage. When the program terminates, the original PF key values are restored. See PF Key Values. I Default. ISPF controls PF key processing.

3. To save your selections and exit this screen, press F3 or enter end in the Command field. To exit without saving your selections, enter cancel in the Command field.

PARA and Paragraphs

Category:

Program Painter and Specification Editor keyword (see Keywords)

Description:

Indicate a paragraph in your program code. A paragraph is a Procedure Division routine that you write and perform specifically for one program. Use paragraphs to perform the following, depending on which APS tool you use.

Syntax:

Format 1:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 PARA   paragraphname [SECTION.]
        paragraphcode

Format 2:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60--
             .
             .
             .
        PERFORM paragraphname [(arguments)]
             .
             .
             .
 PARA   paragraphname [(+|-arguments)]
        statement
             .
             .
             .
        PERFORM subparagraphname [(arguments)]
 PARA   subparagraphname [(+|-arguments)]
        statement
             .
             .
             .
 WS
 01     group-level-data-item
        05  elementary-data-item
             .
             .
             .

Comments:

• Use Format 1 with SECTION to code a SORT procedure.

• The keyword PARA, followed by a paragraph name with an optional list of arguments, denotes a paragraph. Within a paragraph, indentation determines the exact positioning of its logic statements, or statement blocks.

• A paragraph ends with the next appearance of any Procedure Division keyword, except the comment keyword (/*); there is no need to code an END-paragraphname.

• Code at least one PERFORM statement before any PARA keywords in your program. Generally, you code a PERFORM statement that performs your main logic paragraph.

Paragraph Rules:

Rules for coding paragraphs in Online Express:

• A paragraph can consist of a main paragraph, other paragraphs that the main paragraph performs, and Data Division source code for the paragraphs.

• For each paragraph, enter the PARA keyword in the KYWD column and the paragraph name in column 12 on the same line. On the following lines, enter COBOL, COBOL/2, or S-COBOL paragraph statements. Do not use any other APS keywords in paragraphs.

• After all paragraphs, use APS Data Division keywords to define data items that the paragraphs reference.

Rules for coding paragraphs in the Specification Editor and Program Painter:

• A paragraph can perform other paragraphs.

• For each paragraph, enter the PARA keyword in the KYWD column and the paragraph name in column 12 on the same line. On the following lines, enter COBOL, COBOL/2, or S-COBOL paragraph statements. Do not use any other APS keywords in paragraphs.

Anywhere in the program, use APS Data Division keywords to define any data items that the paragraphs reference.

PERFORM

Category:

S-COBOL structure (see S-COBOL Structures)

Description:

Depart from the normal program execution sequence to execute a particular paragraph or section and then return control to the statement immediately following the PERFORM statement.

Syntax:

Format 1, perform a paragraph:

PERFORM paragraphname

Format 2, perform a paragraph and pass arguments:

PERFORM paragraphname (actualargument1[[,]
... actualargument2[,] ... actualargumentN])
                      .
                      .
PARA  paragraphname ([+|-]formalargument1[[,]
... [+|-]formalargument2[,] ... [+|-]formalargumentN])

Parameters:

Comments:

• When continuing a list of arguments onto one or more other lines, do not break an argument.

• The number of actual arguments must equal the number of formal argument names and be in the same order.

Examples:

PERFORM PARA-1( 'ABC', ABC-FLD, RESULT)
          .
          .
          .
    PARA-1( +ARG1, +ARG2, -'Y')

    MOVE 'ABC' TO ARG-1
    MOVE ABC-FLD TO ARG2
    PERFORM PARA-1 THRU .......
    MOVE 'Y' TO RESULT

-LINE- -KYWD- 12-*----20---*----30---*----40---*----50---*--
000100  NTRY
   .
   .
   .
003010            IF CLASS = 'HALF-TIME'
003020                PERFORM GET-SALARY( 20,
003021                ... HOURLY-RATE, WEEKLY-PAY)
003030            ELSE
003040                PERFORM GET-SALARY( 40,
003041                ... HOURLY-RATE, WEEKLY-PAY)
003050            WEEKLY-PAY = WEEKLY-PAY * TAX
003060            COMPUTE MEDICAL-DEDUC =
003061            ... HOURLY-RATE * 1.50
   .
   .
   .
005010  PARA   GET-SALARY( +HOURS-WORKED,
005011        ... PAY-RATE,-TOT-PAY)
005020            TOT-PAY = HOURS-WORKED * PAY-RATE
   .
   .
   .

PF Key Values

Category:

Data communications feature (see also Data Communication Calls)

Compatibility:

CICS, IMS DC, and ISPF Dialog targets

Description:

Use the PF key 88-levels generated by APS.

Syntax:

CICS

PFKEY-FIELD PIC X(01).
    88  ENTER-KEY VALUE '''. (single quotation mark)
    88  CLEAR-KEY VALUE '_'.
    88  PEN VALUE '='.
    88  OPID VALUE 'W'.
    88  MSRE VALUE 'X'.
    88  STRF VALUE 'H'.
    88  TRIG VALUE '"'. (double quotation mark)
    88  PA1 VALUE '%'.
    88  PA2 VALUE '>'.
    88  PA3 VALUE ','.
    88  PF0 VALUE '''. (single quotation mark)
    88  PF00 VALUE '''. (single quotation mark)
    88  PF1 VALUE '1'.
    88  PF2 VALUE '2'.
    88  PF3 VALUE '3'.
    88  PF4 VALUE '4'.
    88  PF5 VALUE '5'.
    88  PF6 VALUE '6'.
    88  PF7 VALUE '7'.
    88  PF8 VALUE '8'.
    88  PF9 VALUE '9'.
    88  PF1 VALUE ':'.
    88  PF11 VALUE '#'.
    88  PF12 VALUE '@'.
    88  PF13 VALUE 'A'.
    88  PF14 VALUE 'B'.
    88  PF15 VALUE 'C'.
    88  PF16 VALUE 'D'.
    88  PF17 VALUE 'E'.
    88  PF18 VALUE 'F'.
    88  PF19 VALUE 'G'.
    88  PF20 VALUE 'H'.
    88  PF21 VALUE 'I'.
    88  PF22 VALUE '['.
    88  PF23 VALUE '.'.
    88  PF24 VALUE '<'.

IMS DC

APS assigns character values for the 24 PF keys and the ENTER key to APS-painted screens. NTRY generates logic to place this portion of the input message in a field with 88-level condition names to facilitate program testing for PF and ENTER keys.

TP-PF-KEY            PIC X(132).
    88  PF0            VALUE ' '.
    88  PF00           VALUE ' '.
    88  PF1            VALUE '1'.
    88  PF01           VALUE '1'.
    88  PF2            VALUE '2'.
    88  PF02           VALUE '2'.
    88  PF3            VALUE '3'.
    88  PF03           VALUE '3'.
    88  PF4            VALUE '4'.
    88  PF04           VALUE '4'.
    88  PF5            VALUE '5'.
    88  PF05           VALUE '5'.
    88  PF6            VALUE '6'.
    88  PF06           VALUE '6'.
    88  PF7            VALUE '7'.
    88  PF07           VALUE '7'.
    88  PF8            VALUE '8'.
    88  PF08           VALUE '8'.
    88  PF9            VALUE '9'.
    88  PF09           VALUE '9'.
    88  PF10           VALUE 'A'.
    88  PF11           VALUE 'B'.
    88  PF12           VALUE 'C'.
    88  PF13           VALUE 'D'.
    88  PF14           VALUE 'E'.
    88  PF15           VALUE 'F'.
    88  PF16           VALUE 'G'.
    88  PF17           VALUE 'H'.
    88  PF18           VALUE 'I'.
    88  PF19           VALUE 'J'.
    88  PF20           VALUE 'K'.
    88  PF21           VALUE 'L'.
    88  PF22           VALUE 'M'.
    88  PF23           VALUE 'N'.
    88  PF24           VALUE 'O'.
    88  ENTER-KEY      VALUE ' '.
    88  NO-KEY-USED    VALUE LOW-VALUES.

During screen painting, if you paint PF key values or use a PF key to supply all or part of the trancode value, you cannot use the above facility for PF key testing.

ISPF Dialog

TP-PF-KEY            PIC X(04).
    88  ENTER-KEY      VALUE '    '.
    88  PF1            VALUE 'PF01'.
    88  PF01           VALUE 'PF01'.
    88  PF2            VALUE 'PF02'.
    88  PF02           VALUE 'PF02'.
    88  PF3            VALUE 'PF03'.
    88  PF03           VALUE 'PF03'.
    88  PF4            VALUE 'PF04'.
    88  PF04           VALUE 'PF04'.
    88  PF5            VALUE 'PF05'.
    88  PF05           VALUE 'PF05'.
    88  PF6            VALUE 'PF06'.
    88  PF06           VALUE 'PF06'.
    88  PF7            VALUE 'PF07'.
    88  PF07           VALUE 'PF07'.
    88  PF8            VALUE 'PF08'.
    88  PF08           VALUE 'PF08'.
    88  PF9            VALUE 'PF09'.
    88  PF09           VALUE 'PF09'.
    88  PF10           VALUE 'PF10'.
    88  PF11           VALUE 'PF11'.
    88  PF12           VALUE 'PF12'.
    88  PF13           VALUE 'PF13'.
    88  PF14           VALUE 'PF14'.
    88  PF15           VALUE 'PF15'.
    88  PF16           VALUE 'PF16'.
    88  PF17           VALUE 'PF17'.
    88  PF18           VALUE 'PF18'.
    88  PF19           VALUE 'PF19'.
    88  PF20           VALUE 'PF20'.
    88  PF21           VALUE 'PF21'.
    88  PF22           VALUE 'PF22'.
    88  PF23           VALUE 'PF23'.
    88  PF24           VALUE 'PF24'.

To let your program control PF key values, specify P(rogram controlled) in the PFKEY Option field on the ISPF Panel Options screen. See Panel Options, ISPF Dialog.

Precompiler Options

Category:

Application generation

Description:

Define variations and special features for program precompilation.

Procedure:

1. From the APS Options Menu enter option 3 in the Option field. Alternatively, from any APS screen enter opt 3 in the Command field. The Precompiler Options screen displays.

2. Set options appropriate for your environment as described below.

   Option	Description and Values
   Apost	Override Quote. Yes Default. Use the apostrophe character to delimit non-numeric literals in your input source.
   Quote	Override Apost. Yes Use the single quote character to delimit non-numeric literals in your input source. No Default
   SCBtrace	Yes Activates the SAGE-TRACE-FLAG debugging facility.
   RWT	Yes Default. Generate COBOL code from APS Report Writer statements. Specify with COBOL II compiler. No Pass Report Writer statements directly to theCOBOL compiler. Note: For very large Report Writer programs, enter rwt=bigrwt in the APS Parm field on the Generator Options screen.
   Lang	Indicate which type of source to process and which columns to process. SCB=yes Default. Processes APS specifications (S-COBOL) in columns 8-72; the symbol &07 in your code forces a character into column 7. COBOL=yes Process COBOL source in columns 1-72. JCL=yes Process JCL in columns 1-72. Useful for text-processing JCL and for controlling columns 1-6 of S-COBOL. Text=yes Process any source in columns 1-80. APS considers all columns as text, and generates no sequence numbers. Automatically set XLATE=FMP. To override XLATE=FMP, enterXLATE=value in the APS Parm field. XLATE=value in the APS Parm field.
   XLATE	Specify which processing step(s) that APS performs. You can stop processing at any of the steps listed below to help isolate the step at which errors occur. The steps are listed in the order in which APS executes them. All options except ALL are mutually exclusive. ALL=yes Default. Process all source code through all applicable processing steps and generates an error report; use when COBOL compile immediately follows in jobstream. FMP=yes Stop processing after APS macros and user-defined Customization Facility macros are processed. RED=yes Stop processing after report mock-ups are translated into IBM Report Writer source. RWT=yes Stop processing after Report Section is translated into COBOL Working-Storage and S-COBOL.
   MockupFMP	Yes Scan lines in report mock-ups and processes the characters % $ & and + as Customization Facility symbols. No Default.
   SUBR	Yes Specify that the generated source is a subroutine program. No Default. Specify that the generated source is a primary program.
   Narrow	Yes Default. Define 80 columns as the message report width. No Define 132 columns as the width.
   Evalmess	Yes Generate messages that list evaluation bracket resolutions. Usually results in long listings. No Default.
   Seq	Specifiy the type of sequence numbers that APS generates. See also, Genident, Spaceident, Ident. COBOL=yes Generate COBOL-style numbers in cols 1-6. Record=yes Generate new numbers in columns 73-80, incrementing by 100 for each input record and by two for each generated record. Identifier=yes Generate line numbers in columns 73-80; columns 73-74 contain 0.
   Syntax	Specify which compiler to use. COBOLII=yes Generate COBOL-II syntax. S-COBOL=yes Generate S-COBOL syntax.
   Emark	Generate a three-character string marking error and warning messages in the message report. Questions=yes Default. Generate ???. Dollars=yes Generate $$$. 3-Char String =string Generate the string you specify.
   Genseq	Override Spaceseq. Yes Default. Generate sequence numbers in columns 1-6 for blank or out-of-sequence lines of source code and when new lines are generated.
   Spaceseq	Override Genseq. Yes Generate spaces in columns 1-6; incompatible with Lang=Text.
   Genident	See also, Spaceident, Ident, Seq. Yes Generate sequence numbers in columns 73-80 for blank or out of sequence source code lines and when new lines are generated. No Default. Generate the last known contents of columns 73-80 when new lines are generated and passes identifiers as they exist in GENSRC.
   Spaceident	See also, Genident, Ident, Seq. Yes Generate spaces in columns 73-80. Incompatible with Lang=Text.
   Main	Specify location of the main input source. MAININ=yes Default. Read from file named by external name MAININ. Use this default unless using your own JCL. Instream=yes Read source instream with the JCL that you provide. Member Name=membername Read from the PDS or file name or source statement library designated by the external name SCELIB.
   Ident	See also, Genident, Spaceident, Seq. Yes Generate the internal program name in columns 73-80. No Default.
   FMP	Yes Default. Process APS macros and user-defined Customization Facility macros. No Use only with your own JCL skeleton.
   Source	Yes Print the main input source program, specified in the MAIN option, after the message report. No Default.
   Gendirect	Yes Allow generatation of nested IF statements in the COBOL source.
   Gencomment	Yes Generate replaced source statements as comments in the COBOL source. NO Default.
   Usernames	Yes Generate the following prefix for APS-generated paragraphs: paraname- No Default. Generate the following prefix for APS generated paragraphs: G-- Note: To generate any other prefix, enter the following in the APS Parm field on this screen. usernames=prefix
   APS Parm	Display all Precompiler options whose default values you override. These values also display in the APS Parm field on the Generator Options screen. APS saves the values you change on the APS Parm field on the Precompiler Option screen. APS does not save values that you change in the APS Parm field on the Generator Options screen.

Example:

PROC

Category:

Program Painter and Specification Editor keyword (see Keywords)

Compatibility:

Non-IMS batch programs

Description:

Generate the batch program template, including a PROCEDURE DIVISION USING clause that enables a called program to receive data from the calling program.

Syntax:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 PROC   [variablename1 variablename2 ... variablenameN]

Comments:

• Code an NTRY, PROC, or OPT statement for each program.
  • The generated $TP-ENTRY generates a program template to send the appropriate window depending on the program invocation mode. To suppress the window and program invocation logic from your program template, code OPT PROG (OPT).

  • To generate a program template to define all parts of your program except for the procedural code, code See NTRY.

• Use PROC instead of NTRY in non-IMS batch programs called by other programs. For IMS programs, use NTRY.

• Code Linkage Section data structures for the variables that the called program receives.

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 PROC   REC-2 REC-2 REC-3

PROCEDURE DIVISION USING REC-2 REC-2 REC-3

Program Control Blocks, IO

Category:

Data communication feature (see also Data Communication Calls)

Compatibility:

IMS DC target

Description:

APS generates an IO PCB with the following format in the Linkage Section.

LINKAGE SECTION.
01  IO-PCB.
    05  IO-PCB-LTERM        PIC X(8).
    05  FILLER              PIC X(2).
    05  IO-PCB-STATUS       PIC X(2).
    05  IO-PCB-INPUT-PREF.
        10  IO-PCB-DATE     PIC S9(7) COMP-3.
        10  IO-PCB-TIME     PIC S9(7) COMP-3.
        10  IO-PCB-MSG-SEQ  PIC S9(7) COMP.
    05  IO-PCB-MOD-NAME     PIC X(8).
    05  IO-PCB-USER-ID      PIC X(8).

In an APS IMS/SQL program, code a PSB with the same name as your DB2 subschema. The PSB must specify an IO PCB (by setting CMPAT=YES in the PSBGEN). If your program uses MSG-SW, the PSB must also specify an alternate IO PCB.

Comments:

• A program requires IO PCBs to obtain an input message and return a reply to the originating terminal.

• To send a message to a logical terminal instead of to the originating terminal, code the MSG-SW call and specify an alternate IO PCB that you define with MODIFY=YES in the program specification block (PSB). MSG-SW cannot include the EXPRESS keyword when it references this alternate IO PCB.

Program DB/DC Report (PG02)

Category:

APS-generated report (see Application Reports)

Description:

The Program DB/DC Report includes documentation summaries on the subschemas, PSBs, and screens used by a program. The Program DB/DC Report has a separate section for database views, record I/O areas, and screen I/O areas.

The Database Views section provides the following information.

• Record names of the root and each dependent segment

• Segments in hierarchical sequence, indented to show each segment's level in the database

• Functions (PROCOPTS) that can be performed for each segment

• Key and sequence fields for accessing each record

• VSAM file descriptions

The Record I/O Areas section provides information on the COBOL I/O areas for the database and file records. Records are listed alphabetically by record name.

The Screen I/O Areas section provides information on COBOL I/O areas for up to 20 screens arranged alphabetically.

Comment:

Produce the Program DB/DC Report from the Documentation Facility.

Example:

REPORT CODE: PG02        APS PROGRAMMER SUBSYSTEM       01/17/92      14:29
                           PROGRAM DB/DC REPORT

***************************************************************************
PROGRAM: TDOM  PSB/SUBSCHEMA: TDDB2
SCREENS: TDOM
***************************************************************************

TABLES/VIEWS: (DB2 RECORDS)
---------------------------
TABLE: TDCUST-REC
TABLE: TDODET-REC
TABLE: TDORDR-REC
TABLE: TDPART-REC


RECORD IO AREAS
---------------

RECORD: TDCUST-REC
 ****************************************************************
 *                 DCLGEN TABLE  : MKTAEA.TDCUST USER: CLSTR1   *
 *                    LIBRARY: CLSAPS.CLS2.COPYLIB              *
 *                    MEMBER : TDCUST  DATE: 90/11/27           *
 *                    ACTION(REPLACE)  TIME 13:11:44            *
 *                                     DB2 SYSTEM: DB2B         *
 ********************************************************************
 
  EXEC SQL DECLARE MKTAEA.TDCUST TABLE
   (CM_CUSTOMER_NO CHAR(6) NOT NULL,
   CM_CUSTOMER_NAME CHAR(20) ,
   CM_CUSTOMER_ADDR CHAR(20) ,
   CM_CUSTOMER_CITY CHAR(20) ,
   CM_CUSTOMER_ZIP CHAR(9) )
  END-EXEC.

 ******************************************************************
 * COBOL DECLARATION FOR TABLE MKTAEA.TDCUST                      *
 ******************************************************************
 01  TDCUST-REC.
  10  CM-CUSTOMER-NO PIC X(6).
  10  CM-CUSTOMER-NAME PIC X(20).
  10  CM-CUSTOMER-ADDR PIC X(20).
  10  CM-CUSTOMER-CITY PIC X(20).
  10  CM-CUSTOMER-ZIP PIC X(9).
 


******************************************************************
* THE NUMBER OF COLUMNS DESCRIBED BY THE DECLARATION IS 5        *
**********************************************************************
SCREEN IO AREAS
---------------

SCREEN: TDOM                                           FORMAT (:/D/M )
                                                            RULEDLINE:
                                                INITIAL CURSOR (X):: :
                                                           COLOR: :: :
                                             UNDERSCORE (U/:):: : :: :
                                             BLINKING (B/:): :: : :: :
                                      REVERSE VIDEO (R/:): : :: : :: :
                                      INTENSITY (B/:/D): : : :: : :: :
                                        PROTECT (P/U): : : : :: : :: :
     01  TDOM-RECORD.                              : : : : : :: : :: :
     05  TDOM-FUNCTION          PIC X(1).          U B : : : :: X :: :
     05  TDOM-ORDER-NO          PIC X(6).          U B : : : :: : :: :
     05  TDOM-SAVEKEY-1         PIC X(8).          P D : : : :: : :: :
     05  TDOM-CUSTOMER-NO       PIC X(6).          U B : : : :: : :: :
     05  TDOM-CUSTOMER-NAME     PIC X(20).         U B : : : :: : :: :
     05  TDOM-CUST-ENTRY-DATE   PIC X(8).          U B : : : :: : :: :
     05  TDOM-ORDER-DEL-DUE-D   PIC X(8).          U B : : : :: : :: :
     05  TDOM-ORDER-DEL-INSTR   PIC X(20).         U B : : : :: : :: :
     05  TDOM-TABLE-1.                             : : : : : :: : :: :
               10  FILLER       OCCURS 5.          : : : : : :: : :: :
               15  TDOM-ROW-FUNCTION
                                 PIC X(1).
               15  TDOM-PART-NO PIC X(8).
               15  TDOM-LINE-NO PIC X(4).
               15  TDOM-PART-SHORT-DESC
                                PIC X(14).
               15  TDOM-QTY-ORDERED
                                PIC X(8).
               15  TDOM-QTY-BASE-PRICE
                                PIC X(10).
               15  TDOM-TAX-CATEGORY
                                PIC X(1).
               15  TDOM-SAVEKEY-2 PIC X(15).
               05  TDOM-MESSAGE PIC X(79).         P B : : : :: : :: :

Program Definition Report (PG01)

Category:

APS-generated report (see Application Reports)

Description:

The Program Definition Report produces a listing of the program code you create in the Program Painter. Use this report when you need to review program listings to troubleshoot problems, or when you need to document completed programs in your applications.

Comment:

Produce the Program Definition Report from the Report Generator, Painter Menu, or Application Painter.

Example:

REPORT CODE: PG01                APS APPLICATION PAINTER                   PAGE     1
                                PROGRAM DEFINITION REPORT              01/18/92 15:10
                                       CLSAPS.CLS2
SELECTION CRITERIA:
 TDCM
*************************************************************************************
PROGRAM: TDCM                                                       CREATED: 03/19/90
TITLE :
UPDATED : 12/19/90
*************************************************************************************************
START    KYWD    STATEMENT                                                    LINE NO
COL      ----    --------------------------------------------------------------------

 8       SYM1    % INCLUDE APSMACS (APXMACS)                                  00010007
 8       NTRY    TDCM * NORETRY                                               00020007
12       /************************************************************        00030007
12       /************************************************************        00040007
12       /***                                                                 00050007
12       /*** MAINLINE LOGIC                                                  00060007
12       /***                                                                 00070007
12       /************************************************************        00080007
12       /************************************************************        00090007
12       TP-PERFORM PX-INIT-HOUSEKEEPING                                      00100007
12       /************************************************************        00110007
12       /* CONTROL POINT: - POST-SCREEN-READ                                 00120007
12       /************************************************************        00130007
12       IF SC-ED-ALL-OK                                                      00140007
16       MOVE SPACE TO TDCM-MESSAGE                                           00150007

Program Specification Blocks

Compatibility:

CICS and IMS DB targets

Description:

When you assign a PSB to a program by naming the PSB in the Application Painter, CICS schedules only one PSB at a time. NTRY schedules the PSB. This PSB is active until the program

• Encounters a SEND or TERM.
• Initiates a CIC-TERM-PSB and continues processing.

To ensure that your PSB remains active when you link or transfer to another program, pass the associated PCBs in the LINK or XCTL call, as shown below.

LINK programname [errorpara]
... [DLIUIB pcbname [pcbname ...]]
... [userparm [userparm]...]
 
XCTL programname [errorpara]
... [DLIUIB pcbname [pcbname ...]]

The invoking program must pass the PCBs in the order that they are coded in the Linkage Section of the invoked program.

When a program invokes a LINK to a subprogram, and passes a scheduled PSB, it expects the PSB to remain scheduled when control returns from the subprogram. To return without terminating the PSB, use TERM because it does not terminate a PSB passed from a higher-level program. To terminate a PSB, use the CIC-TERM-PSB call.

Example:

LINK PROGRMB * DLIUIB
... ORDERDB-PCB
... ITEMDB-PCB
... USER-LINK-1
... USER-LINK-2

The PSB remains scheduled at the start of the next program.