CA

Category

Program Painter and Specification Editor keyword (see Keywords)

Description:

Redefine the TP-USERAREA field of the Commarea. To pass data between programs, see TP-COMMAREA.

Syntax:

• Format 1:

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
   CA     datastructure

• Format 2:

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
   CA05   COBOLdatastructure

• Format 3:

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
   CADS   datastructurename

Comments:

• All formats generate an 05-level REDEFINES TP-USERAREA for the TP-USERAREA data structure and all other data elements at the same indentation level.

• When using Formats 1 and 3, code the data structure in the Data Structure Painter format; when using Format 2, code in COBOL format.

• A CA keyword in a batch program is not applicable and is ignored.

• For IMS, ISPF Dialog, and CICS programs, Commarea data structures are generated in Working-Storage; for prototyping under ISPF, they are generated in Linkage.

• &TP-USER-LEN controls the size of TP-USERAREA--for CICS, the default is 80 bytes; for IMS and ISPF Dialog, the default is zero. Change the size of this area by coding % &TP-USER-LEN=nnn, with a length greater than zero. Code this variable with the SYM1 or SYM2 keyword.

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 IO     INPUT-FILE ASSIGN TO UT-S-INPUT
 IO     OUTPUT-FILE ASSIGN TO UT-S-OUTPUT
 FD     INPUT-FILE
        LABEL RECORDS ARE STANDARD
        BLOCK CONTAINS 0 RECORDS
 01     INPUT-REC        PIC X(80).
 DS01   INPUTREC
 FD     OUTPUT-FILE 
        LABEL RECORDS ARE STANDARD
        BLOCK CONTAINS 0 RECORDS
 REC    OUTPUT-REC       X80
 01     OUTPUT-REC-R REDEFINES OUTPUT-REC. 
        ...COPY OUTREC.
 CA     CA-INPUT-REC 
          CA-IN-PART-NO       N8
          CA-IN-DESC          X50
          CA-IN-BASE-PRICE    N6V2
 CADS   CAOUTREC 

CCODE

Compatibility

IMS DB target

Description:

Use CCODE to include additional IMS command codes in DB-OBTAIN, DB-MODIFY, DB-PROCESS, and DB-STORE.

Syntax:

Valid IMS CCODEs are:

APS generates the following IMS CCODEs; do not code them yourself.

For more information, refer to the applicable IMS manuals.

Comments:

• Most IMS command codes are generated by the call keywords; any command code you specify with the CCODE keyword is added to these.

• Use CCODE carefully, because the command codes you specify with it are not validated by the APS/IMS DB Generator.

Example:

DB-OBTAIN REC RECORD-A
... WHERE KEY-A = WS-KEY-A CCODE 'Q'
... REC RECORD-B
... WHERE KEY-B = WS-KEY-B
... VIEW PCBNAME RESET

Checkin

Category

ENDEVOR Interface feature

Description:

Add to or update the ENDEVOR library with an APS component from an APS Project Group. Alternatively, sign in a component at check in, without adding to or updating the ENDEVOR library. To retrieve a member from the library, see Checkout.

From the APS/ENDEVOR Version Control Menu, select option 1, Checkin. Alternatively, enter CI in the Command field on any APS screen.

Specify requirements on the Checkin screen, as follows.

Checkout

Category

ENDEVOR Interface feature

Description:

Retrieve and, by default, sign out a revision from a controlled member of the ENDEVOR library to an APS Project Group so that you can modify it. To add or update the library, see Checkin.

From the APS/ENDEVOR Version Control Menu, select option 2, Checkout. Alternatively, enter CO in the Command field on any APS screen.

Specify requirements on the Checkout screen, as follows.

CIC-ADDRESS

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Use with the TP-LINKAGE call (TP-LINKAGE) to access CICS storage areas.

Syntax:

CIC-ADDRESS option(linkdataname) [option(linkdataname) ...]

Parameters:

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 SYLK   TP-LINKAGE LK-CWA
 LK01   LK-CWA              PIC X(200).
 NTRY   CIC-ADDRESS CWA(LK-CWA)

CIC-ASSIGN

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Obtain values outside the program and assign them to a Working-Storage data area in the current program.

Syntax:

CIC-ASSIGN CICSoption(dataarea) [CICSoption(dataarea)....]
... [ERROR(errorpara)]
 

Parameters:

Example:

CIC-ASSIGN APPLID(WS-APPLID)
... ERROR(ERROR-PARA)

CIC-CANCEL

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Cancel a previously issued CIC-DELAY (See CIC-DELAY) or CIC-START (See CIC-START).

Syntax:

CIC-CANCEL [REQID(name)]
... [TRANSID(name)]
... [SYSID(name)]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-CANCEL TRANSID('TRAN') ERROR(ERROR-PARA)

CIC-DELAY

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Suspend task processing for a prescribed time interval.

Syntax:

CIC-DELAY [ REQID(name)]
... [INTERVAL(hhmmss)|TIME(hhmmss)]
... [ERROR(errorpara)]

Parameters:

Examples:

CIC-DELAY INTERVAL(500) ERROR(ERROR-PARA) REQID('UNIQCOM')

CIC-DELAY TIME(013000) ERROR(ERROR-PARA) REQID('UNIQCOM')

CIC-DELETEQ-TD

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Delete all transient data associated with a predefined transient data queue.

Syntax:

CIC-DELETEQ-TD QUEUE(name)
... [SYSID(name)]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-DELETEQ-TD QUEUE('TDAQ') ERROR(ERROR-PARA)

CIC-DELETEQ-TS

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Delete all temporary data and free all storage associated with a temporary storage queue.

Syntax:

CIC-DELETEQ-TS QUEUE(name)
... [SYSID(name)]
... [ERROR(erropara)]

Parameters:

Example:

CIC-DELETEQ-TS QUEUE('TSAQ') ERROR(ERROR-PARA)

CIC-FREEMAIN

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Release storage previously acquired by a CIC-GETMAIN (See CIC-GETMAIN).

Syntax:

CIC-FREEMAIN DATA(linkdataname)

Parameters:

Example:

CIC-FREEMAIN DATA(LK-STORAGE-AREA)

CIC-GETMAIN

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Obtain and initialize main storage. To release storage, see CIC-FREEMAIN.

Syntax:

CIC-GETMAIN SET(linkdataname)
... LENGTH(value)|FLENGTH(value)
... [INITIMG(value)]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-GETMAIN SET(STORAGE-AREA)
... LENGTH(WS-LENGTH)
... INITIMG(WS-BLANK)
... ERROR(ERROR-PARA)

CIC-LOAD

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Load specified programs, tables, or maps from a library to main storage; to delete these, see CIC-RELEASE.

Syntax:

CIC-LOAD PROGRAM(name) [SET(linkdataname)]
... [LENGTH(dataarea)]|[FLENGTH(dataarea)]
... [ENTRY(pointref)]
... [HOLD] [ERROR(errorpara)]

Parameters:

Example:

CIC-LOAD PROGRAM('TAXTAB')
... SET(TAX-TABLE-AREA) LENGTH(TAX-LEN)
... ERROR(ERROR-PARA)

CIC-READQ-TD

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Read transient data from a predefined data queue.

Syntax:

CIC-READQ-TD QUEUE(name)
... INTO(dataarea)|SET(linkdataname)
... [LENGTH(dataarea)] [SYSID(name)]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-READQ-TD QUEUE('TDAQ') INTO(WS-TD-REC)
... LENGTH(WS-TD-LEN)
... ERROR(ERROR-PARA)

CIC-READQ-TS

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Retrieve data from a temporary storage queue in main or auxiliary storage.

Syntax:

CIC-READQ-TS QUEUE(name)
... INTO(dataarea)|SET(linkdataname)
... LENGTH(dataarea) NUMITEMS(dataarea)
... [ITEM(value)|next]
... [SYSID(name)]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-READQ-TS QUEUE('TSAQ')
... INTO(WS-TD-RECORD) LENGTH(WS-TD-RECLEN)
... ERROR(ERROR-PARA)

CIC-RELEASE

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target in the z/OS environment

Description:

Delete program, table, or map, previously loaded with a CIC-LOAD call (See CIC-LOAD), from main storage.

Syntax:

CIC-RELEASE PROGRAM(name)
... [ERROR(errorpara)]

Parameters:

Example:

CIC-RELEASE PROGRAM('PROG5')
... ERROR(ERROR-PARA)

CICS

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS targets

Description:

Code and pass through native CICS calls.

Syntax:

CICS command

Example:

CICS ASKTIME

CIC-SCHEDULE-PSB

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS and IMS DB targets

Description:

Schedule the PSB in the program, if not currently scheduled; to terminate it, see CIC-TERM-PSB. APS automatically generates these calls when you specify a PSB in the Application Painter.

Syntax:

CIC-SCHEDULE-PSB

Comment:

To define a PSB in your application definition, see the APS User's Guide chapter Paint the Application Definition.

CIC-SEND-TEXT

Category

Data communication call (see Data Communication Calls)

Compatibility

CICS target

Description:

Format output data without mapping and transmit to a terminal or line printer.

Syntax:

CIC-SEND-TEXT FROM(dataarea)
... LENGTH(value) [CICSoptions]
... [ERROR(errorpara)]

Parameters:

Comment:

Use CIC-SEND-TEXT prior to a TERM (See TERM) from a main program in order to clear the screen and unlock the keyboard.

Example:

CIC-SEND-TEXT FROM(TEXT-STRING)
... LENGTH(100) ERASE FREEKB
... ERROR(ERROR-PARA)

CIC-SERVICE-RELOAD

Category

Data communication call (see Data Communication Calls)

Compatibility

CICS target

Description:

Establish addressability to a data area in the Linkage Section following an address change in the BLL cell.

Syntax:

CIC-SERVICE-RELOAD linkdataname

Parameters:

Comment:

SERVICE-RELOAD is an OS/VS COBOL statement; do not use with COBOL II, because the compiler treats this call as a CONTINUE statement.

Example:

MOVE PASSED-ADDRESS TO LINK-AREA-1-PNTR
CIC-SERVICE-RELOAD LINK-AREA-1

CIC-START

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Start a task on a local or remote system at a specified time.

Syntax:

CIC-START TRANSID(name)
... [INTERVAL(hhmmss)|TIME(hhmmss)] [CICSoptions]
... [ERROR(errorpara)]

Parameters:

Examples:

CIC-START TRANSID('TRNL') INTERVAL(10000)
... ERROR(ERROR-PARA)

CIC-START TRANSID('TRN2') TIME(173000)
... TERMID('STA3') ERROR(ERROR-PARA)

CIC-TERM-PSB

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Terminate the currently scheduled PSB (See CIC-SCHEDULE-PSB). You normally use this call before transferring to another program.

Syntax:

CIC-TERM-PSB

CIC-WRITEQ-TD

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Write transient data to a predefined data queue.

Syntax:

CIC-WRITEQ-TD QUEUE(name) FROM(dataarea)
... [LENGTH(value)] [SYSID(name)]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-WRITEQ-TD QUEUE('TRDQ') FROM(WS-MESSAGE)
... LENGTH(WS-TD-LEN)
... ERROR(ERROR-PARA)

CIC-WRITEQ-TS

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS target

Description:

Write or rewrite temporary data records to a temporary storage queue.

Syntax:

CIC-WRITEQ-TS QUEUE(name) FROM(dataarea)
... LENGTH(value) [SYSID(name)]
... [ITEM(dataarea) [REWRITE] [CICSoptions]
... [NOSUSPEND]
... [ERROR(errorpara)]

Parameters:

Example:

CIC-WRITE-TS QUEUE(QUEUE-NAME)
... FROM(WS-TS-RECORD)
... LENGTH(WS-TS-LENGTH)
... ITEM(WS-TS-ITEM-NO)
... ERROR(ERROR-PARA)

CLEAR

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS, IMS DC, and ISPF Dialog targets

Description:

Move spaces or low-values to all fields in a specified screen.

Syntax:

[TP-|SC-]CLEAR screenname

Comment:

This call does not alter the field attributes.

Example:

CLEAR SCRA

CLEAR-ATTRS

Category:

Data communication call (see Data Communication Calls)

Compatibility:

CICS, IMS DC, and ISPF Dialog targets

Description:

Reset all screen field attributes to their original painted values.

Syntax:

[TP-]CLEAR-ATTRS screenname

Comment:

The screen field contents do not change.

Example:

CLEAR-ATTRS SCRA

COBOL/2 Support

Description:

Code program logic in both the Program Painter and Specification Editor using COBOL/2 structures.

Under APS COBOL/2 support, you can:

• Code both S-COBOL and COBOL/2 structures in the same program.

• Code structures in columns 7 - 80 (rather than column 12 - 72).

• Import existing COBOL/2 program Procedure Division code directly into APS, without any changes.

• Generate COBOL/2 output, regardless of whether you use S-COBOL, COBOL/2, or a combination.

• Generate PERFORM THRU paragraphname-EXIT code for each paragraph. To do so, change the default NO setting for the GENEXIT flag to YES in the ISPSLIB member SSMCOMP.

You can turn COBOL/2 support on and off by setting the Generate COBOL/2 field on the Generation Options screen.

When programming in the Program Painter or Specification Editor, you can code in COBOL/2 as follows.

• To turn on COBOL/2, enter cobol2 on the Command line.

• To turn off COBOL/2, enter scobol on the Command line.

Comments:

• APS saves the current status of COBOL/2 support; therefore it remains turned on or off the next time you access APS.

• There are slight differences in the Program Painter and Specification Editor screens when COBOL/2 is turned on.

• All keywords are supported and required as before. Exception: The PARA keyword is optional; you can code the paragraph name beginning in column 8. Keywords are coded in columns 8 - 11 (area B).

• Paragraph names can have a maximum of 24 characters.

• Code only one verb per line.

• Nested COBOL/2 programs are not supported.

• You must use consistent indentation (we recommend four spaces) throughout your program, even when importing COBOL/2 structures, or you will receive warning messages and your generated logic will probably be inaccurate. For example:

  000001  IF OK-TO-PROCEED
  000002      MOVE A TO B
  000003      IF D = E
  000004          MOVE F TO G
  000005    ELSE
  000006        MOVE H TO I

  When compiling and generating the above code, APS will not know which IF statement lines 005 and 006 belong to.

• If a COBOL/2 EVALUATE statement is also valid S-COBOL EVALUATE syntax, APS processes it as an S-COBOL statement.

• When importing existing COBOL/2 code into APS, remember to assign the appropriate APS keywords to non-Procedure Division statements.

• APS stores COBOL/2 program files in a slightly different format to support access up to column 80. When an existing S-COBOL program is subsequently saved under COBOL/2, the source text of keyword lines shifts one byte to the right. This truncates any character coded in column 72 and displays a Truncation has occurred warning.

  This truncation only occurs on a keyword line, and in fairly unusual circumstances, such as a PARA keyword followed by a long string of arguments with the last argument ending in column 72. If it happens, edit the member, fix the line, and save the file with COBOL/2 support turned on.

CODE

Category:

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

Compatibility:

Batch environments

Description:

Specify a two-character literal placed at the beginning of each report line. It is useful when writing multiple reports to one file.

Syntax:

CODE literal

Parameters:

Comments:

• The two bytes identifying a literal are included in the logical record size, not in the print line description.

• If your report has a File Description (FD) in the REPORT IS clause, include a RECORD CONTAINS clause that allows for the two extra bytes the CODE clause needs; the default value of 133 for RECORD CONTAINS does not.

  If your report does not have a File Description, the APS default record length of 250 includes the extra two bytes the CODE clause needs.

• If you specify CODE for one report, specify it for all reports in the file.

Example:

Comments

Description:

Enter comments in your program. To write comments in the Identification Division, see REM.

Syntax:

• Format 1, code anywhere in your program:

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
   /*     commentline

• Format 2, code in the Procedure Division only:

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
          /*commentline

• Format 3, code in the Procedure Division only:

  -KYWD-  12-*----20---*----30---*----40---*----50---*----60
          Program code    /*comment

• Format 4, code in Customization Facility macros:

  %* comment

• Format 5, code in the Data Structure Painter only:

  * comment
  /* comment
  %* comment

Comments:

• Comment lines do not affect the function of a program or data structure. In the Program Painter, the last keyword entered before your comment line(s) is still in effect.

  ---

  Note: You cannot code comments within database calls, data communication calls, or Data Structure Painter constructs.

  ---

• Do not use evaulation brackets in Formats 2, 3, and 4.

• Begin each comment line with /* or %*.

• In the Procedure Division, you can code /* anywhere in the column 12 - 72 area.

• A Customization Facility comment (Format 4) can start in any column, as long as it is on a line by itself and is indented (we recommend four spaces) underneath the Customization Facility statement.

• To code macro statements, use Format 4.

• Do not code comments within database calls.

Examples:

-LINE- -KYWD-  12--*--20---*----30----*---40---*----50---*----60
002000         /* S-COBOL COMMENT LINE
002010  /*     COBOL COMMENT LINE
002020  PARA   MAIN-PARA   /* S-COBOL COMMENT

-LINE- -------- DATA STRUCTURE PAINTER -------
000001         /* WORK FIELD 1 RECORD
000002         WRK1-FIELD-1    X(5)
000003             88 OPEN-VAL   V'OPEN'
000004             88 CLOSED-VAL V'CLOSE'

000001  */* WORK FIELD 1 RECORD
000002   01  WRK1-FIELD-1    PIC X(5).
000003       88  OPEN-VAL    VALUE 'OPEN'.
000004       88  CLOSED-VAL  VALUE 'CLOSE'.

Component List (MS01)

Category:

APS-generated report (see Application Reports)

Description:

The Component List Report catalogs all of the components created for an application within a specific Project andGroup.

The report lists components by painter in six columns - one each for applications, programs, screens, report mock-ups, data structures, and scenarios. Within each column, the report lists components in alphabetical order. The bottom of the report totals the number of components listed for each painter. You can produce a report listing application components of one or more types.

Comments:

• Produce the Component List Report from the Documentation Facility.

• This report does not provide information about subschemas or about the contents of each listed component.

Example:

REPORT CODE: MS01                APS APPLICATION DICTIONARY                   PAGE     1
                                 COMPONENT LIST                           05/17/92 09:13
                                 MKTAPS.MKT2
SELECTION CRITERIA: ALL
*********************************************************************************************

APPLICATIONS  PROGRAMS SCREENS   REPORTS   DATA STRUCTURES SCENARIOS
------------  -------- -------   -------   --------------- ---------

CICSJSS       ADEMO    ADEMO     $APSCMR   APCOMM          APDEMO
CICSVSAM      AW02PGM  ADEMOKB   MANUFAC   AWO3            APSDEMO
CUSTORDR      AW03PGM  ADEMO1    MWPART    BANK2           APSDEMO2
DEMOKEB       XXXPGM   ADEMO1J   REPORT1   COMAREA2        APSDEMO3
DEMO1803      ANNER1   ADEMO1X   VNDROPD   DLGAPPL         DEMO4
DLXVAPPL      DLGINQ   ADEMO3D             CPFDATAB        CBIS
DLX2APPL      LGMNU    ADEMO3J             DB2DEMO         DL2APPL
DMVAPPL       DLXVINQ  A2CASE              MARIA           DEMO###
LEVEL30       DLX2UPD  CMKTEMP             QSSGLOBL        ISR00007
MVS20SCR      DMOMNU   CMK1                QSS9            MVS21
PTSUNLD       PMINFOT1 DLGU                                SSS2
PXAPPL        PMINFOT2 DMOM                                TEST
QSSAPPL       PMINFO3  KEB
SSKTEST       PMINFO4  KEBDEMO1
TDDEMO        PMUDS1   KEB1
TESTQSS       PMXXXXT2 MEAD1
USRDEMO       PMXXXXT3 P22604
              PM1SVKEY REWDEMO
              PTSUNLD  TDCS
                       PXCUSTM   TDDDH
                       PXMENU    TDDST
                       PXORDRM   TDFIRN
                       PXORDRS   TDJH
                       PXPARTL   TDME
                       PXVCUSTM  TDOJ
                       PXVMENU   TDOM
                       PXVORDRM  TDOT
                       PXVORDRS  TDOU
                       PXVPARTL  TDPF
.
.
                       TDCM
                       TDCS
                       TDME
                       TDOJ
                       TDOM
                       TDOT
                       TDOU
                       TDPF
                       TDPL
                       TDPM

      APPLICATIONS  -     28
          PROGRAMS  -     60
           SCREENS  -     50
           REPORTS  -      6
   DATA STRUCTURES  -     13
         SCENARIOS  -     18

CONTROL

Category:

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

Compatibility:

Batch environments

Description:

Identify control data items (controls), which are tested for a change each time a detail line is printed. Create a control hierarchy for the report control headings and footings (control breaks).

Syntax:

• Format 1:

  CONTROL [IS] [FINAL] dataname

• Format 2:

  CONTROLS [ARE] [FINAL] dataname1 ... datanameN

Parameters:

Comments:

• Datanames can be qualified, but cannot be subscripted or indexed, or have a subordinate data item with a variable size defined in an OCCURS clause. Each dataname must be a different data item.

• List the datanames from the highest to lowest level. An implicit FINAL is the highest control. The first dataname is the major control; the last dataname is the minor (lowest) control.

• You can omit the CONTROL clause when the only control is FINAL.

• The first time a GENERATE builds a report, all control values are saved. The next GENERATE tests controls for changes every time a detail line is printed, by comparing the contents with the contents saved from the last GENERATE of the same report, as follows.
  • If the control is numeric, the relation test compares two numeric operands.

  • If the control is an index, the test compares two index data items.

  • If it is neither numeric nor an index, it compares two non-numeric operands.

• A change in dataname (a control) causes a control break that:
  • Prints control footings for lower level datanames, followed by the control footing for the dataname causing the control break

  • Clears counters associated with the datanames

  • Prints control headings for the dataname and lower level datanames

  • Prints the detail line causing the break

Example:

Control Files

Description:

Use APS control file variables to control certain functions. Each control file contains documentation on its variables. Look in the APS CNTL PDS or library for these files.

CICS

File APCICSIN controls:

• DLIUIB name

• Prologue generation

• Inline error checking (for example, CICS IGNORE globally or NOHANDLE on a call-by-call basis)

• Data name suffixes generated for field length and attribute data names

• DFHAID and APS-EIBRCODE copybook inclusion

• EJECTs

• CICS comments

• APS/CICS call overrides

• RESP/RESP2 options

DB and DC Calls

Note: Changing APSDBDC file parameter values affects the entire installation. To override values only for a specific Project, set the variables in the CNTL file APSPROJ.

Field Edits

File APFEIN controls:

• Setting the maximum number of input and output edited fields per paragraph. The default is ten input fields and ten output fields. To change the defaults, set the &FE-INP-PARA-BREAK and &FE-OUT-PARA-BREAK variables as desired.

• Preventing execution of a user-defined input application edit when the field does not pass assigned field edits. The default is NO, which continues execution. To prevent execution, set the variable &FE-BYPASS-INPUT-APPL-EDIT to YES.

• Preventing execution of subsequent input and output field edits if a field fails a user-defined input application edit. The default is NO, which continues execution. To prevent execution, set the variables &FE-BYPASS-EDITS-IF-APPL-FAIL and &FE-BYPASS-OUTPUT-EDITS to YES. Overriding this parameter is not recommended because it affects Customizer rules.

• Using the USA format or European format that reverses the comma and decimal point. The default is the USA format. To use the European format, set the &FE-DECIMAL-IS-COMMA variable to YES.

• Supporting DBCS (Double Byte Character Set) characters. The default for the &FE-DBCS-ENABLE variable is YES.

• Resetting attribute bytes to the painted values if the field passes all assigned input edits under CICS. The default for the &FE-RESET-CICS-ATTRS variable is YES.

• Resetting field attribute bytes before or after input edits under CICS. The default for the &FE-RESET-CICS-ATTRS-AT-TOP variable is NO, which means after input edits.

• Allowing spaces within numbers. The default for the $FE-EMB-SPACE-IN-NUMERIC is NO.

• Performing numeric calculations where the numeric de-edit option was not selected. The default is NO. Setting the &FE-EDIT-WHEN-NUMERIC to YES readies all numeric fields on the screen for calculations.

• Interpreting the century for output date formats. The default for the &FE-FIRST-YEAR-OF-CENTURY is 10. This means that APS interprets any date with a YY (year) value of 11 through 99 as being in the 20th century, that is, year 1911 through 1999, and any YY value of 00 through 10 as being in the 21st century, that is, year 2000 through 2010.

IMS DB and DC

Use the IMS control file, APIMSIN, to control these functions:

• Prologue generation

• EJECTs

• Color, Blink, Reverse Video, Underscore switches

• System Service Calls (IM-STAT, IM-LOG, IM-ROLL, IM-ROLB)

• GSAM RSA calls

• DB-PROCESS call loop limit flag, &VS-IMS-LOOP-MAX (default 100); you can change the limit number or disable the check for the limit.

ISPF Dialog

Use the ISPF Dialog contol file, APDLGIN, to control these functions:

• DYNAM or NODYNAM calls

• VDELETE variables upon TP-TERM

• TP-LINK and TP-XCTL generation of COBOL CALLs or ISPEXEC SELECTs

• Automatic open/close for VSAM files (enable/disable)

• DB2 COMMIT generation for ISPF Dialog TP-LINK, TP-XCTL, and TP-TERM calls

• Prologue generation

• EJECTs

• ISPF comments

SQL

Use the DB2 control file, APDB2IN, to control these functions:

• Comment generation (default: comments are generated)

• EJECTs

• Size of SQL calls accepted (default: 200 tokens, for example, items separated by spaces)

• Generation of the IBM DCLGEN convention, DCLtablename, for host 01-level qualifiers

• Automatic error processing, controlled by the variable &D2-AUTO-ERROR-HANDLING (default: ON)

• Customization of automatic error processing, including:
  • Modifying the APS error processing paragraph &D2-ERROR-PARA, which resides in the macro $DB2-ERROR-SETUP

  • Modifying which status codes should be considered error conditions, in the macro $DB2-CHECK-RETURNS-AUX, and changing the status of a referential integrity constraint from an abnormal condition to an invalid key

• The DB-PROCESS call loop limit flag, &DB2-LOOP-LIMIT (default: 100); you can change the limit number or disable the check for the limit.

• COMMIT generation for the DB-MODIFY, DB-STORE, DB-ERASE, and DB-CLOSE calls

• DB2 customization exits, which are program locations where you can write your own macros to customize APS/SQL calls

• Generated data names. You can:
  • Override the use of the IND-cursorname structure when generating indicator variables

  • Use an 01-level name instead of copylib-REC for DB2 record host-variable qualification

  • Modify generated data names used by $DB2-EPILOGUE, which is invoked after all DB2 calls have been processed

  • Use a table alias name instead of the table name

• Comment generation for the APS $DB2- calls, which are used by the APS/SQL calls

VSAM Batch and Online

Use the VSAM control file, APVSAMIN, to control these functions:

• Functions for both CICS/VSAM and batch:
  • Abnormal error processing (enable/disable automatic APS routine)

  • Non-referenced record descriptions (include/exclude)

  • Record inclusion

  • A flag you must use if your copylib records don't begin with the 01-level number

• CICS/VSAM-specific functions:
  • Abnormal error processing (exclude certain CICS Exceptional Conditions and ISI-Errors from being abnormal conditions)

  • DB-PROCESS call loop limit flag, &VS-CICS-LOOP-MAX (default 100); you can change the limit number or disable the check for the limit.

  • ENDBR/UNLOCK

  • Customization exits, which are program locations where you can write your own macros to customize APS/VSAM and native VSAM calls

  • Data name generation

  • Comment generation

• Batch-specific functions:
  • Abnormal error processing (exclude certain batch conditions from being abnormal conditions)

  • DB-PROCESS call loop limit flag, &VS-MVS-LOOP-MAX (default: 999,999); you can change the limit number or disable the check for the limit

  • Termination method (STOP RUN or call your own abend program)

  • Customization exits, which are program locations where you can write your own macros to customize APS/VSAM calls

  • Data name generation

  • Comment generation

User Help

Use the APS User Help Facility control file, APHLPIN, to control these functions for generating the User Help database:

• Program and screen names (if naming conflicts exists)
• Internal and external storage database targets
• Subschema access used by the help database
• Database name and attributes
• Database field names--COBOL or native
• Screen data storage options
• Data field length
• Global screen message field name
• Field help indicator string
• Date format
• PF key designations
• COBOL help invocation conditions
• APS-generated User Help comment suppression

Control Points

Category:

Online Express feature

Description:

Write and execute custom processing logic to supplement or override the default logic that Online Express generates. Execute this logic at any of the APS-provided locations in your program, known as program control points.

To view the control points in your program, display the Control Points screen or the Database Call Tailoring screen. Or, you can look in your generated program source to see where the control points occur. The complete set of control points is as follows.

Flowcharts

The following flowcharts illustrate the locations of all control points in APS-generated programs.

The flowchart below illustrates the location of the database call control points in generated programs.

Comments:

• Because the design and functionality of many programs differ, you often see a different subset of control points from program to program.

• APS generates comments in your program to identify the control points. To activate or deactivate the generation of these comments in Online Express, access the Express Parms screen and enter yes in the Control Points Comments field.

• The Normal Status (Before Record is Processed) control point lets you add custom logic before looped records map to the screen. Use this control point to map only some of the records that a loop obtains. In your stub or macro, write conditional logic to determine which records to map. APS provides a flag, OK-TO-PROCEED, that you set to True to map and process the record, or False to bypass mapping and processing. You can ignore the flag if you do not use this control point; the flag is set to True by default. To add custom logic after APS maps any record to your screen, use the Normal Status control point.

Example:

DB-PROCESS REC SALES-RECORD
... WHERE ANNUAL-SALES-TOTAL > 99999
    PERFORM CHECK-BEFORE-MAPPING-STUB-PARA
    IF OK-TO-PROCEED
        ADD 1 TO CTR
        PERFORM RECORD-STOREKEY-PARA
        MOVE REC-TO-SCREEN-BLK1
        PERFORM CHECK-AFTER-MAPPING-STUB-PARA
   .
   .
   .
CHECK-BEFORE-MAPPING-PARA
    TRUE OK-TO-PROCEED
    IF SALES-REGION NOT = NORTHWEST
        FALSE OK-TO-PROCEED
CHECK-AFTER-MAPPING-PARA
    calculation and mapping routine for grand total

Note:

• The CHECK-BEFORE-MAPPING-PARA paragraph executes at the Normal Status (Before Record is Processed) control point.

• The CHECK-AFTER-MAPPING-PARA paragraph executes at the Normal Status control point.

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

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