++

Category:

Program Painter and Specification Editor keyword (see Keywords)

Description:

Generate a PANVALET ++INCLUDE statement.

Syntax:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 ++     PANVALETmembername

Comment:

The preceding section keyword determines the placement of a data structure in the generated program. Associated section keywords are:

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 WS
 REC    WS-INPUT-REC
          WS-IN-PART-NO       N8
          WS-IN-DESC          X50
          WS-IN-BASE-PRICE    N6V2
 01     WS-OUT-REC.
 DS05   WSOUTREC 
 ++     PANWSREC

01

Category:

Program Painter and Specification Editor keyword (see Keywords)

Description:

Use the 01 keyword to:

• Define the input and output files in a batch program File Section.

• Define a data structure in Working-Storage or Linkage Section.

• Copy a data structure into the Working-Storage or Linkage Section.

• Define APS Report Writer statements for headings, footers, or detail lines.

Syntax:

Format 1, define input or output files:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 IO     filename ASSIGN [TO] ...
        ORGANIZATION IS ...
 01     input|outputrecordname         PIC clause

Format 2, define a data structure:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 01     COBOLdatastructure
        [05  COBOLdatastructure]

Format 3, copy a data structure:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 01     COBOLcopystatement

Format 4, define Report Writer line types:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 01    [dataname] TYPE [IS] reportgroup
       [NEXT GROUP [IS] number|PLUS number|NEXT PAGE][.]
       [LINE [NUMBER IS] number|PLUS number|NEXT PAGE]
       MOCKUP|M LINE|LINES linenumber1 [THRU linenumberN]
       [OVERPRINT] WHEN "characterstring" AT COLUMN column]
       [SOURCE] [IS] dataname [options]]
       [VALUE] [IS] literal]
       [REFERENCE [IS] dataname PIC[TURE] [IS] picclause
           [options]]
        [SUM|+ [IS] dataname [dataname] ...
            [UPON detailgroup [detailgroup] ...]
            [RESET [ON] [FINAL] dataname]
            [options]]

Comments:

• You must provide all necessary COBOL punctuation.

• The following COPY statement formats are available for OS/VS COBOL. They are not supported by COBOL II, where the LANGLVL compiler option is set to 1.

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
   01     COPY copybookname
   
   01     dataname COPY copybookname
   
   01     dataname
              COPY copybookname
   
   01     dataname COPY copybookname
              REPLACING fieldname1 BY fieldname2

• To write subordinate elementary data telements, include the level numbers in columns 12 - 72.

• If you use the COBOL/2 compiler, or your copybook contains an indexed table, enter the SWYS or SYLK keyword in the KYWD column and the APS statement % INCLUDE, rather than a COBOL COPY statement. % INCLUDE inserts the copybook into the program before precompilation, so the APS Precompiler can interpret the index. See the Customization Facility User's Guide for more information.

• The preceding section keyword determines the placement of a data structure in the generated program. Associated section keywords are

  FD	File Section (see FD)
  SD	Sort File Description (see SD)
  WS	Working-Storage Section (see WS)
  LK	Linkage Section (see LK)

RENAMES

Category:

Data Structure Painter construct (see Data Structures)

Description:

Code 66-level RENAMES clauses in your data structures.

Syntax:

66 anytext

Parameters:

anytext

Comment:

A 66-level variable needs the same or deeper indentation than the data name it refers to.

Example:

-LINE- ------- DATA STRUCTURE PAINTER --------
000001   WORK-RECORD
000002      WORK-RECORD-GRP1
000003          WORK-FIELD-1   XX
000004          WORK-FIELD-2   XXX
000005          WORK-FIELD-3   PIC X(04)
000006      WORK-RECORD-GRP2
000007          WORK-FIELD-4   PIC X(02)
000008          WORK-FIELD-5   PIC X(06)
000009      WORK-RECORD-GRP3
000010          WORK-FIELD-6   PIC X(08)
000011          WORK-FIELD-7   PIC X(02)
000012   66  RECORD-1-REN RENAMES WORK-FIELD-1
000013   ... THRU WORK-FIELD-6

01  WORK-RECORD.
    05  WORK-RECORD-GRP1.
        10  WORK-FIELD-1        PIC XX.
        10  WORK-FIELD-2        PIC XXX.
        10  WORK-FIELD-3        PIC X(04).
    05  WORK-RECORD-GRP2.
        10  WORK-FIELD-4        PIC X(02).
        10  WORK-FIELD-5        PIC X(06).
    05  WORK-RECORD-GRP3.
        10  WORK-FIELD-6        PIC X(08).
        10  WORK-FIELD-7        PIC X(02).
    66  RECORD-1-REN RENAMES WORK-FIELD-1
                            THRU WORK-FIELD-6.

88

Category:

Data Structure Painter construct (see Data Structures)

Description:

Code 88-level clauses in your data structures.

Syntax:

88   dataname VALUE 'value1' [THRU 'value2']
...                'value3' [THRU 'value4']
...                'value5' [THRU 'value6']
   .
   .
   .
...                'valueN' [THRU 'valueN']

Parameters:

Comments:

• An 88-level variable needs the same or deeper indentation as the data name it refers to.

• You can code the VALUE clause either
  • On the same line as dataname if it fits entirely on that line.

  • On its own line and continue it on subsequent lines with the continuation symbol.

Examples:

Application Definition Report (AP01)

Category:

APS-generated report (see Application Reports)

Description

The Application Definition Report displays each component of an application in a separate report section.

This report consists of the following collection of reports.

• Data Structure Definition Report (DS01) (Data Structure Definition (DS01))

• Program Definition Report (PG01) (Program Definition Report (PG01))

• Report Definition Report (RP01)

• Screen Hardcopy/Field Attribute Report (SC01) (Screen Hardcopy/Field Attribute Report (SC01))

• Screen Field Edits Report (ED01) (Field/Screen Cross Reference (SC02))

• Program DB/DC Report (PG02) (Program DB/DC Report (PG02))

Comments:

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

• This report does not provide information about the scenarios that you create in the Scenario Painter.

Example:

REPORT CODE: REPT              APS ENTITY REPORT FACILITY                             PAGE  1
                                       CLSAPS.CLS2                             01/21/92 09:28
REPORT CRITERIA:
       ALL ASSOCIATED ENTITIES OF THE APPLICATION :  TDDEMO
*********************************************************************************************
LIBRARY    ENTITY
TYPE          NAME           STATUS          Comments:
---------------------------------------------------------------------------------------------
 
       AP       TDDEMO        REPORTED
       PG       TDCM          REPORTED
       PG       TDCS          REPORTED
       PG       TDME          REPORTED
       PG       TDOJ          REPORTED
       PG       TDOM          REPORTED
       PG       TDOT          REPORTED
       PG       TDOU          REPORTED
       SC       TDCM          REPORTED
       SC       TDCS          REPORTED
 .
 .
 .
 
REPORT CODE: AP01        APS APPLICATION PAINTER                                       PAGE 1
                         APPLICATION DEFINITION REPORT                         01/21/92 09:28
                       CLSAPS.CLS2
SELECTION CRITERIA:
   TDDEMO
*********************************************************************************************
APPLICATION: TDDEMO                                           CREATED: 02/15/90
TITLE      :                                                  UPDATED: 08/30/90
AUTHOR     : CLSTR1                                           DC TARGET:   CICS 
                                                                 DB TARGET:   VSAM
*********************************************************************************************
 
-LINE-   PROGRAMS   SCREENS  IO   REPORTS    DATA STR TY  SBSC/PSB USERMACS LOC
---------------------------------------------------------------------------------------------
000001   TDME       TDME     IO
000002   TDCM       TDCM     IO                           TDDB2
000003   TDPL       TDPL     IO                           TDDB2
000004   TDOM       TDOM     IO                           TDDB2
000005   TDOT       TDOT     IO                           TDDB2
000006   TDOJ       TDOJ     IO                           TDDB2
000007   TDOU       TDOU     IO                           TDDB2
 .
 .
 .

Application Field Edit Routines

Category:

Screen Painter feature (see Field Edits)

Description:

Specify additional edits or tests for input or output data.

Procedure:

To assign an edit routine, follow these steps.

1. From the Screen Painter, access the Field Edit Facility.

2. To access the Application Edits screen, select the Application Editing prompt on any Field Edit screen.

3. Complete the following options.

   Option	Description
   Type	Indicate whether this application edit is a paragraph, subprogram, or APS macro. Default is P(aragraph).
   Name	Enter a descriptive name for the application edit; maximum 32 characters.
   Arguments	To pass a screen field or error flag, prefix the name with the screen name and a hyphen. If the field is located in a list box or combination box, APS suffixes the name with (APS-ROW-SUB).
   	Enter the following arguments separated by commas and enclose literals in single quotation marks.
   Paragraph	Data names or literals that pass to the paragraph through a PERFORM with arguments statement in the generated program.
   Subprogram	Data names that appear on the CALL USING statement in the generated program.
   APS macros	Customization Facility macro terms, literals, and numeric literals. Do not enclose arguments with double quotation marks.
   Execute Before/After APS Edits	Specify when the program executes this application edit--before or after the normal APS field edit routine. Default is b(efore). See also "Comments:" below.
   Paragraph COPYLIB or APS Macro USERMACS Member	Specify an associated COPYLIB member or a paragraph or the associated USERMACS member name for an APS macro.
   Working-Storage COPYLIB Member	Specify a Working-Storage COPYLIB member to be included in the program Working-Storage section.

Alternately, for screen fields, you can select a predefined edit from the Application Edit List, which is a centralized collection of routines maintained by your APS Administrator. To do so:

1. On the Application Editing screen, enter appllist listname in the Command field, where listname is the name of the list of available edits. See your APS Administrator for the name of the list at your site. The Application Selection screen displays.

   

2. Type s before the input or output edit routine you want.

3. Press Enter to select the edit and return to the Application Editing screen. APS copies the field values from the selected edit routine, overlaying existing entries. You can modify the selected edit routine on this screen.

Comments:

• You can interrogate the following APS-generated flags and data fields to determine input data errors.

  APS-EDITS-PASSED	Flag that APS sets to T(rue) if there are no input errors and F(alse) if there are input errors
  APS-EDIT-ERRORS-CTR	Data field containing the number of screen fields in error
  screenname-fieldname-FLAG	Flag that APS sets to T(rue) if an error occurs and F(alse) if not

• You can use the following APS-generated fields to code your application edit routines. The option Execute Before/After APS Edits determines which field to reference, as shown in the table below.

  Representation	Execute Option	Name and Format
  Input	After APS edits	Screenname-fieldname. Internal picture was updated by any previous field edits.
  Input	Before APS edits	Screenname-fieldname-INPT. Data field containing any invalid data entered by the end user. Edits have not been performed; data is in screen input format. Field length is field length painted on the screen; definition is PIC X.
  Output	After APS Edits	Screenname-fieldname-EDIT. Data was moved to -EDIT by previous output edits. Data may contain special symbols. Default length is field length painted on the screen; definition is PIC X.
  Output	Before APS Edits	Screenname-fieldname. Data was not processed by previous output edits and is still in the internal format. Data in this field moves to the -EDIT field when an output format is specified. Default length is field length painted on the screen; definition is PIC X.
  Input or Output	Before or After APS Edits	(APS-ROW-SUB). This data field contains the row number being processed for fields in a repeated block, or in a list box or combination box.
  Input or Output	Before or After APS Edits	APS-EDIT-MESSAGE. Data field that lets you display an error message in addition to any you defined in the field edits for the field. Move a literal or data name containing the text into this field.
  Input or Output	Before or After APS Edits	Screenname-fieldname-LEN. For CICS only. Contains the length of the field; definition is PIC X.
  Input or Output	Before or After APS Edits	Screenname-fieldname-ATTR. For CICS only. Contains the attribute values assigned to the field; definition is PIC X.

• APS processes input data from the screenname-fieldname-INPT field. After the data passes the input edits, the data moves to screenname-fieldname and takes on the characteristics of the internal picture. For output, the data moves to the screenname-fieldname-EDIT field and takes on the characteristics of the output format specifications.

• Application edit routines execute for a field whether the data passes or fails field edits, unless you set various switches in the APFEIN control file (see Control Files). To indicate an error in an application edit routine, move T to screenname-fieldname-FLAG. This tells APS to execute error processing; you can display an additional error message from the APS-EDIT-MESSAGE field.

Examples:

01  EMPLOYEE-RECORD.
    05  EMPLOYEE-SALARY-GRP.
        10  EMPLOYEE-SALARY-INPT.
            15  FILLER                      PIC X(03).
            15  EMPLOYEE-SALARY             PIC S9(O5)V99.
        10  EMPLOYEE-SALARY-OUTP REDEFINES
                                      EMPLOYEE-SALARY-INPT.
            15  EMPLOYEE-SALARY-EDIT        PIC $$$,$$9.99.

PERFORM VALIDATE-CUSTOMER-NO( SCRN-CUSTOMER-NO,
... SCRN-CUST-NO-FLAG, APS-EDIT-MESSAGE)
   .
   .
   .
VALIDATE-CUSTOMER-NO(+WS-CUSTOMER-NO,-WS-ERROR-FLAG,
... WS-MESSAGE)
    DB-OBTAIN REF CUST-RECORD
    ... WHERE CUSTOMER-NO-KEY = WS-CUSTOMER-NO
    IF NTF-ON-REC
           MOVE 'T' TO WS-ERROR-FLAG
           MOVE 'CUSTOMER NUMBER NOT FOUND ON FILE'
           ... TO WS-MESSAGE
           MOVE ' ' TO WS-ERROR-FLAG
    ELSE
           MOVE 'T' TO WS-ERROR-FLAG
           MOVE 'ABNORMAL RETURN ON PART NBR VALIDATION'
           .... TO WS-MESSAGE

CALL 'CUSTVER' USING
... SCRN-CUSTOMER-NO,
... SCRN-CUST-NO-FLAG,
... APS-EDIT-MESSAGE

$VALIDATE-CUSTOMER-NO("SCRN-CUSTOMER-NO",
% ... "SCRN-CUST-NO-FLAG",
% ... "APS-EDIT-MESSAGE")
   .
   .
% DEFINE $VALIDATE-CUSTOMER-NO( &CUSTOMER-NO, &ERROR-FLAG,
% ... &MESSAGE )
    $DB-OBTAIN("REF CUST-RECORD",
    % ... <%&CQ WHERE CUSTOMER-NO-KEY = &CUSTOMER-NO&CQ>)
    IF NTF-ON-REC
        MOVE 'T' TO &ERROR-FLAG
        MOVE 'PART NUMBER NOT FOUND ON FILE' TO &MESSAGE
    ELSE-IF OK-ON-REC
        MOVE ' ' TO &ERROR-FLAG
    ELSE
        MOVE 'T' TO &ERROR-FLAG
        MOVE 'ABNORMAL RETURN ON CUSTOMER NUMBER VALIDATION'
        ...TO &MESSAGE

Application Painter

Description:

Create an application definition by listing all its components in a matrix that indicates their relationsip to each other. Specify requirements on the Application Painter screen, as follows:

Comments:

• You can include procedural subroutines that any program of the application can reference, known as global stubs. To do so, enter the stub name in the Program field, and enter *stub in the field. Regardless of the row where you enter a global stub name, any program of the application can reference it. See STUB.

• To create a new application definition quickly, you can copy an existing one and modify it. To do so, use the Create Like function on the Painter Menu.

• If you are creating a CICS or IMS DC application that accesses SQL or VSAM databases, and you want to create an application prototype to execute and test within the APS Prototype Execution facility, set the DC target to ISPF and the DB target to SQL or VSAM. After testing the ISPF prototype, change the DB/DC targets to the production targets, and regenerate the application.

• Deleting a component from the Application Painter matrix removes it from the application definition, but not from the APS Repository; the componenet is available to add to other applications. However, if you delete a component from the Painter Menu, APS removes it from the APS Repository; you must delete it from all applications that reference it.

• If you are creating an IMS application that does not access the IMS message queue, specify MVS as your DC target.

Application Painter Member Processing Exits

Description

On the Application Painter, the selection fields next to programs, screens, reports, and data structures accept the following APS-defined selection codes.

You can create selection codes to do additional things by writing a member processing exit subroutine. For example, you could create a member processing exit that contains logic to archive an entity to tape when the user-defined selection code T is entered. You can also create member processing exits to modify or disable the APS-defined selection codes.

Procedure:

To write an Application Painter member processing exit, follow these steps:

1. Copy the APS-provided member processing exit program template, A1UXAP01, which resides in the APSPROG PDS. Modify the copy with your own logic to suit your needs, and generate the program. Note that in the A1UXAP01 program, a like-named macro library is included; the $APS-UXAP01-LINK-PARMS macro member of this library defines the parameters you use in the exit program.

2. Access the APS Administration Configuration screen and define your member processing exit name.

3. Test your member processing exit. If you get a system abend code 806 from the Application Painter, the exit is not in the system search path - perhaps you entered the wrong name in step 2, or your exit did not compile.

4. To make your exit available from any Project and Group, copy the generated load module to an appropriate load library, such as the APS software library ISPLLIB2, or any library in the system search path.

Selection Code Processing

When you enter one or more selection codes on the Application Painter, the Painter first validates that the selection codes were entered correctly. Then, if no errors are found, the Painter processes the selection codes.

You can code logic in an exit program for any of three Application Painter processing points - during validation, before processing, and after processing. APS provides the following two structures in the exit macro and the exit program template respectively, to determine which function is requested.

P-FUNC-CD        X(1)
    88  P-FUNC-CD-VALIDATE     V 'V'
    88  P-FUNC-CD-PRE-PROCESS  V 'B'
    88  P-FUNC-CD-POST-PROCESS V 'A'
               .
               .
               .
EVALUATE P-FUNC-CD
WHEN 'V'
    PERFORM VALIDATE-FUNC
WHEN 'B'
    PERFORM CUSTOM-PREPROCESS
WHEN 'A'
    PERFORM CUSTOM-POSTPROCESS

APS also provides the following variables in the exit macro. To define your own selection code(s) to the exit program, reference these variables in your program.

% &APS-UE-SEL-BROWSE             = 'B'
% &APS-UE-SEL-BIND               = 'BD'
% &APS-UE-SEL-EDIT               = 'E'
% &APS-UE-SEL-GEN                = 'G'
% &APS-UE-SEL-ONLINE-EXPRESS     = 'OX'
% &APS-UE-SEL-REPORT             = 'R'
% &APS-UE-SEL-SELECT             = 'S'

Validation

The Painter validates each selection code entered. It also calls the exit program's validation paragraph once per selection code. In the paragraph, you can use the following return codes.

For example:

        /* *************************************************
        /* USER LOGIC TO VALIDATE SELECTION CODES
        /* *************************************************
PARA    VALIDATE-FUNC
        /* VALIDATE THE SELECTION CODE...
        IF P-SEL-CD = 'yourcode'
            RETURN-CODE = &UE-RC-OK
        ELSE
            RETURN-CODE = &UE-RC-UNKNOWN-SEL-CD

Preprocessing:

If validation was successful, the Application Painter processes the selection codes in this order:

For each selection code, the Application Painter checks the return code set by the exit program during validation. If the return code is &APS-UE-RC-OK or &APS-UE-RC-CONTINUE, the Application Painter calls the exit program preprocessing paragraph; otherwise standard Application Painter processing occurs.

In the exit program preprocessing paragraph, write your custom preprocessing logic, and then set one of these return codes.

For each selection code, when the exit program preprocess paragraph returns &APS-UE-RC-CONTINUE or &APS-UE-RC-POSTPROCESS, the Application Painter attempts to perform its standard processing. Then, for &APS-UE-RC-POSTPROCESS, the Application Painter calls the exit program postprocess paragraph. The call parameter P-APS-STATUS indicates the success or failure of the standard Application Painter processing.

Postprocessing:

Use the exit program postprocessing paragraph to execute any action after the standard Application Painter processing. A common action is to free resources allocated by the preprocess paragraph. The postprocessing paragraph should set one of these return codes.

Comments:

• A member processing exit can display one or more ISPF screens.

• A member processing exit can invoke one or more subroutines.

• Each member processing exit must return to the Application Painter.

• A member processing exit cannot directly or indirectly invoke the Application Painter.

• A member processing exit can set a message using the SETMSG paragraph provided in A1UXAP01. Depending on the circumstances, a subsequent APS message can override this message.

Application Reports

Description:

APS provides a set of reports that help you understand your application and its various components. Use these reports as you develop an application to determine the status of your work and the tasks left to complete. Some reports help you to troubleshoot problems in an application that you are developing, or to determine the impact of a proposed change. Others help you to verify the results of your work. Once you have fully implemented an application, use the APS reports to document it so that developers who later maintain or enhance the application can easily understand it in detail.

You can produce reports on an entire application, on selected components, or on selected members of components. You can produce reports from the Report Generator, Painter Menu, Application Painter, or Documentation Facility, as follows.

Procedures:

Use the following procedures to produce APS reports from the Report Generator, Painter Menu, Application Painter, and Documentation Facility.

Report Generator

Produce reports from the Report Generator following these steps.

1. On the Painter Menu, enter in the Type field the component type that you want to report on - ap(plication), cn (scenario), ds (data structure), pg (program), rp (report mock-up), or sc(reen).

2. Leave the Member field blank.

3. Enter report in the Command field and press Enter to display the Report Generator screen.

4. Enter one of the following selection criteria.
   • To report on all members of all component types, type 1 in the Option field. Make sure that all entry fields are blank on the screen.

   • To report on all members of the one component type, type 2 in the Option field. Leave the value that displays in the Library field.

   • To report on a specific member of a component, type 3 in the Option field. Leave the value that displays in the Library field, and enter the component's member name in the Member Name field.

   • To report on a range of members in a component, type 3 in the Option field. Enter the component type in the Library field and the value range of the members you want to report on in the Range Greater and Range Less fields.

5. Press Enter to submit a job to produce the report.

Painter Menu

Produce reports from the Painter Menu following these steps.

1. In the Type field, enter the component type that you want to report on - ap(plication), cn (scenario), ds (data structure), pg (program), rp (report mock-up), or sc(reen).

2. In the Member field, enter the member name that you want to report on.

3. Enter report in the Command field and press Enter. The Print Report screen displays.

4. Press Enter to submit a job to generate the report.

Application Painter

Produce reports from the Application Painter following these steps.

1. To report on all members of all components, or all members of a specific component, do one of the following.
   • Type report in the Command field to report on all members of all components of an application.

   • Enter report componenttype all in the Command field to report on all members of a specific component. Componenttype can be ap(plication), cn (scenario), ds (data structure), pg (program), rp (report mock-up), or sc(reen).

2. To report on a specific member of a component, do one of the following.
   • Enter report componenttype componentname in the Command field.

   • Type r next to the component name in the Application Painter matrix.

3. Press Enter to submit a job to generate the report.

Documentation Facility

Produce reports from the Documentation Facility following these steps.

1. From the APS Main Menu screen, enter option 2 in the Option field. The Dictionary Services screen displays.

2. From the Dictionary Services screen, enter option 3 in the Option field. The Documentation Facility screen displays.

3. Select the desired report from the Actions listing on the action bar or enter the applicable option number in the Option field. A selection criteria screen displays for the selected report.

4. Enter any selection criteria. See the individual report descriptions for details.

5. Press Enter to submit a job to generate the report.

Comments:

• Although the procedures for producing reports from the Painter Menu and the Report Generator are very similar, the Report Generator offers more flexibility. On the Painter Menu you can report on specific component members, while the Report Generator lets you report on any range of component members that you specify.

• Make sure that the current Project and Group contain the application entities you want to report on. If you want to change your Project\Group, do the following. Alternatively, from the APS Main Menu, select option 0, Options. The APS Options Menu displays. Select option 2, Project Group Environment. Enter the desired Project and Group values and press PF3 to return to the APS Main Menu.

• Set up job card information so that you can submit jobs to generate reports. To do so, from the APS Main Menu, select option 0 and then option 6, Job Card Options. Alternatively, enter opt in the Command field.

• To set the job class, from the APS Main Menu, select option 0 to invoke the Generator Options panel. Then select option 1 and reference the job card you created.

APSMACS Rule Library

Description:

Contains macros used by APS during generation. Place user macros in project.group.USERMACS.

Note: This feature is closely associated with the Control Files feature. See Control Files.

Category:

APS library.

AT END/INVALID KEY

Category:

S-COBOL structure (see S-COBOL Structures)

Description:

Test the END-OF-FILE or AT END condition for files accessed sequentially, and test the INVALID KEY condition for files accessed randomly.

Syntax:

conditionalverb [AT] END ON      filename
              INVALID [KEY] ON
  statementblock

Comments:

• S-COBOL defines 05 filename - END PIC x and 05 filename - INV PIC x as flags for the AT END and INVALID KEY conditions for each file.

• END ON filename and INVALID ON filename are 88-level file status condition names that S-COBOL provides with the AT END and INVALID KEY flags. You can use these as a condition in any conditional statement.

• Flag setting occurs when the file is accessed by a READ, WRITE, START, etc., statement and before the AT END ON/INVALID KEY ON conditional is valid.

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----
 PARA   MAIN-LOGIC
            OPEN INPUT MASTER-FILE
            REPEAT
                READ MASTER-FILE INTO MASTER-REC
                ... INVALID KEY
                    MASTER-REC = HIGH-VALUES
                ELSE-IF MASTER-TYPE = 'A'
                    PERFORM PROCESS-TYPE-A
                ELSE-IF MASTER-TYPE = 'C'
                    PERFORM PROCESS-TYPE-C
                ELSE
                    PERFORM PROCESS-OTHER-TYPES
            UNTIL INVALID KEY ON MASTER-FILE
            CLOSE MASTER-FILE
            STOP RUN

ATTR

Category:

Data communications call (see Data Communication Calls)

Description:

Modify the screen I/O field attributes attributes at run time. To reset all screen field attributes to their original painted values, see CLEAR-ATTRS.

Syntax:

ISPF Prototyping

[TP-]ATTR screenname POS fieldname[(subscript)]

CICS, IMS DC, and ISPF Dialog

[TP-]ATTR screenname
... attribute1[+attribute2...]
... fieldname[(subscript)][+fieldname[(subscript)] ...]

Keywords

fieldname
[(subscript)]

Comments:

• When redefining a screen, use the original name.

• Code only as many fieldnames as can fit on a single line. To code more field names, code another ATTR.

• For character-based applications, to modify color or highlighting, set the Extattr Modifiable field to Y in the Screen Painter Screen Generation Parameters: screen.

• You can code attributes that are not supported, such as when prototyping, without causing an error. They are ignored at generation/execution time.

Examples:

Attributes, Screen Fields

Category:

Screen Painter feature

Description:

Assign field attributes by modifying the default attribute values for your text and I/O fields. To modify screen field attributes at run time, see ATTR and CLEAR-ATTRS.

Valid attribute values for screen fields on the Field Attribute screens are the following.

Comments:

• Under ISPF Prototyping, you cannot assign both the Protected and Dark attributes to I/O fields.

• Turning the numeric keyboard locking attribute on does not ensure only numeric data is entered, because it is terminal dependent.

• The Modify Extended Attributes attribute works in conjunction with the EXATTR MODIFBLE parameter on the Screen Generation Parameters: screen. If you set that parameter to F(alse), APS ignores the Modify attribute. If you set the parameter to T(rue), APS searches your screen to find which fields have the Modify attribute on.

• To define a field to accept an MFS system literal, you give it the name of the literal, preceded by an asterisk (*). For example, for a field to contain the system literal DATE2, the field name should be *DATE2. When a field is used as a system literal, it is unavailable to the program and does not have modifiable attributes. See your MFS documentation for valid system literals.

• Using the values 00 through 0F for the KANJI ruled line attribute, surround the field as follows.

  Value	Under	Right	Over	Left
  00					Equivalent to spaces
  01	X				Equivalent to U
  02		X			Equivalent to R
  03	X	X
  04			X		Equivalent to O
  05	X		X
  06		X	X
  07	X	X	X
  08				X	Equivalent to L
  09	X			X
  0A		X		X
  0B	X	X		X
  0C			X	X
  0D	X		X	X
  0E		X	X	X
  0F	X	X	X	X	Equivalent to B

Bind and Translate Options, SQL

Compatibility

SQL DB targets

Description:

Define bind options for DB2 application and program generation.

Procedure

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

2. Select Bind and translate options as described below.

   Field	Description and Values
   DB2 System Name	Specify the appropriate name for your site. Default: DB2.
   Plan Name	Specify the plan name you use when you Bind an application. If you leave this field blank, the default depends upon your use of the BIND command in the Application Painter.
   Owner of Plan (Authid)	Leave this field blank or specify a primary or secondary authorization ID of the BIND.
   Qualifier	Leave this field blank or specify the implicit qualifier for the unqualified table names, views, indexes, and aliases contained in the plan.
   Action	Specify the bind action to be executed. Valid values: add or replace.
   Retain Execution Authority	Specify Yes if you specified REPLACE in the BIND ACTION field. Otherwise specify No.
   Isolation Level	Valid values: rr or cs.
   Plan Validation Time	Valid values: run or bind.
   Explain Path Selection	Yes Activates the DB2 EXPLAIN function. No Does not activate the function.
   Resource Acquisition Time	Valid values: use or allocate. If you enter ALLOCATE, you must enter DEALLOCATE in the Resource Release Time field.
   Resource Release Time	Valid values: commit or deallocate. The value you enter in this field depends on the value you entered in the Resource Acquisition Time field.
   Defer Prepare	Yes Generates the keyword DEFER(PREPARE), which defers the prepare statement referring to a remote object. No Default.
   Cache Size	Specify the size (in bytes) of the authorization cache to be acquired in the EDMPOOL for the plan. Valid values: 0 to 4096.
   Data Currency	Yes Data currency is required for ambiguous cursors. No Data currency is not required for ambiguous cursors.
   Current Server	Leave this field blank or specify a connection to a location before the plan runs.
   Message Flag	Specify which messages display. Valid values: I, W, E, C, or blank.

Example:

Comments:

• To reinstate the defaults defined for your site, enter reset in the Option field.

• For detailed explanations of these fields, see the IBM DB2 Application Programing Guide.

Copyright © 2002 Micro Focus International Limited. All rights reserved.
This document and the proprietary marks and names used herein are protected by international law.