Database Calls

Compatibility:

All targets

Description:

APS Logical View Database (DB) calls are predefined, easy-to-use statements with common syntax that allows transparent access to a variety of databases. The APS Logical View DB calls let you focus on what needs to be accomplished, rather than the mechanics of the target environment. To address environment-specific requirements, you can extend these calls with keywords; no native coding is required. These calls facilitate both generic processing and specialized requests.

APS supports the following database targets:

• IDMS
• IMS DB
• SQL
• VSAM batch
• VSAM online

Code database calls in the APS Program Painter for batch, report, or complex online programs, or in the Online Express Specification Editor for an Express program.

IDMS DB

The APS/IDMS calls include the following:

IMS DB

The APS/IMS DB calls include the following:

SQL

The APS/SQL DB calls include the following:

VSAM Online

The APS/VSAM online DB calls include the following:

VSAM Batch

The APS/VSAM batch DB calls include the following:

Coding Conventions

APS Logical View DB calls can consist of a call name, keywords, and arguments. Observe the following conventions when you code a DB call:

• Code the call using COBOL indentation. Improperly indented calls may cause errors.

• Argument values can be:
  • Variables

  • 1- to 7-digit numbers

  • Literal strings delimited by single or double quotation marks

• Separate each call component with a space, unless indicated otherwise in the syntax.

• Never code comments within database calls. To code comments, see Comments.

• Continue a call on as many as 101 subsequent lines by coding an ellipsis followed by a space (...). Break a call for continuation at any blank space, but do not break a parameter.

• Do not extend the call past column 72.

Related Topics:

Data Communication Calls

Compatibility:

All targets

Description:

APS Logical View Data Communication (DC) calls are predefined, easy-to-use statements that let you focus on what needs to be accomplished, rather than the mechanics of the target environment. To address environment-specific requirements, you can extend these calls with keywords; no native coding is required. These calls facilitate both generic processing and specialized requests.

APS supports the following data communication targets:

• CICS
• IMS DC
• ISPF Dialog (DLG)
• ISPF prototyping

Code data communication calls in the APS Program Painter for batch, report, or complex online programs, or in the Online Express Specification Editor for an Express program.

List of DC Calls

CICS

The APS/CICS DC calls include the following:

IMS DC

The APS/IMS DC calls include the following:

ISPF Dialog

The APS/ISPF Dialog DC calls include the following:

ISPF Prototyping

The APS/ISPF prototyping DC calls include the following:

Coding Conventions

APS Logical View DC calls can consist of a call name, keywords, and arguments. Observe the following conventions when you code a DC call:

• Code the call using COBOL indentation. Improperly indented calls may cause errors.

• Argument values can be:
  • Variables
  • 1- to 7-digit numbers
  • Literal strings delimited by single or double quotation marks

• Separate each call component with a space, unless indicated otherwise in the syntax.

• Code positional arguments in the order shown in the syntax for each call.

• To omit a positional argument, code an asterisk (*) in its place, except for the last argument.

• Never code comments within data communication calls. To code comments, see Comments.

• Continue a call on as many as 101 subsequent lines by coding an ellipsis followed by a space (... ). Break a call for continuation at any blank space, but do not break a parameter.

• Do not extend the call past column 72.

Related Topics

Data Structure Definition (DS01)

Category:

APS-generated report (see Application Reports)

Description:

The Data Structure Definition Reports displays data structure components exactly as painted, together with the following supplementary information.

• The Data Structure name and creation date
• The Data Structure title and date of last update

The report documents this aspect of your application to support future maintenance and enhancement efforts.

Comment:

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

Example:

REPORT CODE: REPT      APS ENTITY REPORT FACILIY                          PAGE     1
                              CLSAPS.CLS2                             07/18/92 14:49
REPORT CRITERIA: 2
 ALL MEMBERS OF LIBRARY TYPE : DS
*****************************************************************************************

 LIBRARY      ENTITY
 TYPE         NAME              STATUS           REMARKS
 -------      --------          -------------    ----------------------------
      DS      APFIELDS          REPORTED
      DS      BATCH1            REPORTED
      DS      COM               REPORTED
      DS      CONDATA           REPORTED
      DS      COST              REPORTED
      DS      DSFRD1            REPORTED
      DS      FORD2DS           REPORTED
      DS      HBSPA             REPORTED
      DS      PARTDATA          REPORTED
      DS      PARTMSTR          REPORTED
      DS      P2COMM            REPORTED
      DS      RECORD1           REPORTED
      DS      SBAPPL            REPORTED
      DS      STR1A             REPORTED
      DS      TOTCOST           REPORTED
      DS      TOTCST            REPORTED
      DS      TRAAPL            REPORTED
      DS      TRADATA           REPORTED
      DS      TRFIELDS          REPORTED
      DS      TR3RECD           REPORTED
      DS      TR6APPL           REPORTED
      DS      TR7APPL           REPORTED
      DS      TR8PART           REPORTED

REPORT CODE: DS01      APS APPLICATION PAINTER                            PAGE     1
                  DATA STRUCTURE DEFINITION REPORT                    07/18/92 14:49
                             CLSAPS.CLS2
SELECTION CRITERIA:
   APFIELDS


**********************************************************************************************
DATA STRUCTURE: APFIELDS                                           CREATED: 06/06/90
TITLE                                                              UPDATED: 06/06/90
**********************************************************************************************

START DATA     STATEMENT                                           LINE NO
COL------------------------------------------------------------------------------------------
 8             PART-MASTER-REC                                     00010000
10                     PM-PART-NO                             9(8) 00020000
10                     PM-NEW-PART-NO                         9(8) 00030000
10                     PM-OLD-PART-NO                         9(8) 00040000
10                     PM-PART-SHORT-DESC                     X13  0050000
10                     PM-UNITS                               9(8) 00060000
10                     PM-UNIT-BASE-PRICE                     S6V2 00070000
10                     PM-DIMENSIONS                          X(8) 00080001

Data Structures

Description:

APS lets you code reusable data structures for programs and copy libraries, using a shorthand format in the Data Structure Painter. Or, you can code these data structures specifically for your program in the Program Painter. The shorthand format substitutes indentation for level numbers and allows shorthand picture formats. The APS Generators insert level numbers for indentation levels, expand the shorthand formats to full COBOL formats, and insert the necessary punctuation. Alternately, you can code data structures in the standard COBOL format.

Constructs:

VALUE (Data Structure)

RED

OCCURS

88

66 . . . RENAMES

Edit Mask Characters

Code the following COBOL edit mask characters in your data structures.

A  P  Z  +  -  *  B  $  0 

For example:

A(12)000B

PIC A(12)000B.

PPP999

PIC PPP999.

ZZZ9.99

PIC ZZZ9.99

+999.99

PIC +999.99.

****.**

PIC ****.**.

S999PPP

PIC S999PPP.

Picture Formats

Code data structures in the Data Structure Painter format, which is a shorthand syntax.

9

PIC 9.

99

PIC 99

999

PIC 999

9999

PIC 9999

9(n)

PIC 9(n)

9n

PIC 9(n)

9&variable

PIC 9(&variable)

A

PIC A.

AA

PIC AA.

AAA

PIC AAA.

A(n)

PIC A(n).

An

PIC A(n).

A&variable

PIC A(&variable).

C

PIC S9 COMP.

C(n)

PIC S9(n) COMP.

Cn

PIC S9(n) COMP.

C-3

PIC S9 COMP-3.

Cn-3

PIC S9(n) COMP-3.

C&variable

PIC S9(&variable) COMP.

C&variable+-3

PIC S9(&variable) COMP-3.

F|FULL

PIC S9(9) COMP.

H|HALF

PIC S9(4) COMP.

I|INDEX

INDEX.  (For [USAGE IS] INDEX)

N

PIC 9.

N(n)

PIC 9(n).

Nn

PIC 9(n).

N&variable

PIC 9(&variable).

P|POINTER

POINTER.

(For COBOL/2 only:  [USAGE IS] POINTER.])

R|REDEF| REDEFINES

REDEFINES dataname.

S

PIC S9.

S(n)

PIC S9(n).

Sn

PIC S9(n).

S&variable

PIC S9(&variable).

SYNC

SYNCHRONIZED

V(n)

PIC V9(n).

Vn

PIC V9(n).

V&variable

PIC V9(&variable).

Vvalueclause

VALUE valueclause.

X

PIC X.

XX

PIC XX.

XXX

PIC XXX.

XXXX

PIC XXXX.

Xn

PIC X(n).

X(n)

PIC X(n).

X&variable

PIC X(&variable).

... 

Comments:

• Application generation treats most format specifications beginning with COBOL edit mask characters as a valid COBOL formats, and passes them directly to the generated program. However, APS translates an A, followed by a numeral, as follows.

  A8  generates  PIC A(8).

• Enter only the level 66, 77, or 88 numbers; do not enter other level numbers, such as 01, 05.

• Enter one data element name per line only. A data element name can be a valid COBOL name of 1 - 30 characters, or expression introduced by one of the Customizer default symbols.

• You can continue the data structure on multiple lines wherever a space occurs, for example:

  -------- Data Structure Painter -------
  WORK1-FIELD1      X(13)
  ... V'13 CHARS LONG'
  WORK1-FIELD2      X(120)
  ... VALUE 'A LONG LITERAL MAY
  ...  BE CONTINUED ON ONE OR
  ...  MORE LINES'

• You do not need to code the word PICTURE in a picture clause. A PICTURE clause format can be a valid COBOL format or a APS Data Structure Painter shorthand picture format.

• If you do code the PICTURE or PIC, use only valid COBOL syntax within the PIC clause--do not use the APS shorthand picture format.

• If you code the word PIC, you must follow it with valid COBOL syntax.

• APS treats the Data Structure Painter formats 99, A9, N9, S9, and V9 as valid COBOL formats and passes them directly to the generated program (as PIC 99, PIC A9, and so on). If, however, you want the generated COBOL to be PIC 9(9), PIC V(9), and PIC A(9), use the Data Structure Painter formats 9(9), V(9), and A(9).

• If a format includes a Customizer variable followed by additional format syntax, use a plus sign (+) to separate the Customizer variable from the additional syntax. During processing, APS eliminates the plus sign and concatenates the suffix onto the syntax. For example,

  9&variable+V5 generates PIC 9(&variable)V9(5).

• Distinguish Vvalueclause from V as an implied decimal point.
  • For Vvalueclause, precede the V with a space and immediately follow it with the valueclause.

  • For V as an implied decimal point, use no space before or after the V.

    For example:

    N8V4 generates PIC 9(8) V9(4). 
    N8 V4 generates PIC 9(8) VALUE 4.

• Never code comments within Data Structure Painter constructs. To code comments, see Comments.

Example:

-LINE- ------------------ Data Structure Painter -----------
000001        PROG-SPECIFIC-WORKING-DATA
000002          PGWS-FIELD1
000003              PGWS-FIELD2
000004                  PGWS-FIELD3
000005                      PGWS-FIELD4
000006                          PGWS-FIELD5
000007                              PGWS-FIELD6
000008                                  PGWS-FIELD7 X13 
 
000009                                  ... V'ABCDEFGHIJKL'
000010                  PGWS-FIELD8
000011                      PGWS-FIELD9
000012                          PGWS-FIELD10  N13

01  PROG-SPECIFIC-WORKING-DATA.
    05  PGWS-FIELD1.
        10  PGWS-FIELD2.
            15  PGWS-FIELD3.
                20  PGWS-FIELD4.
                    25  PGWS-FIELD5.
                        30  PGWS-FIELD6.
                            35  PGWS-FIELD7
                                PIC X(13)
                                VALUE 'ABCDEFGHIJKL'.
            15  PGWS-FIELD8.
                20  PGWS-FIELD9.
                    25  PGWS-FIELD10
                     PIC 9(13).

Date and Time Field Edits

Category:

Screen Painter feature (see Field Edits)

Description:

Specify the storage format, the format and data requirements that the end user must adhere to when entering data into a date or time screen, and specify the format requirements for displaying the date or time.

Procedure:

To assign internal, input, or output edits to a date screen, follow these steps.

1. Access the Screen Painter, then access the Field Edit Facility. From the Edit Selection window, select the Special Edits option.

2. From the Special Edits Screen Painter, select one of the following.

   Option	Description
   Date--Predefined Edits	Gregorian, Julian, or system date storage format and a predefined list of input/output formats
   Date--User-Defined Edits	Storage, input, and output date format that you define
   Time--User-Defined Edits	Storage, input, and output formats that you define

3. Assign date edits to fields as listed in the following Predefined Dates, User-Defined Dates, and Time Field tables or procedures.

Predefined Dates

User-Defined Dates

Time Fields

Note: In a report mock-up, use PIC clauses instead of COBOL masks when formatting dates and times containing / $ or :. See Report Mock-Ups.

DB/DC Target Combinations

Description:

The following table shows all valid DB/DC combinations for generating executable programs.

DB-BIND

Category:

Database call (see Database Calls)

Compatibility:

IDMS target

Description:

Bind all records copied into a program subschema via a COPY IDMS statement; bind the run unit.

Syntax:

Format 1:

DB-BIND REC [recordname]

Format 2:

DB-BIND RUN-UNIT
... SUBSCHEMA name|NODENAME name|DBNAME name

Parameters:

Comments:

• All programs accessing IDMS databases must be bound to the run unit.

• DB-BIND generates the IDMS command COPY IDMS SUBSCHEMA-BINDS.

• All programs with a subschema generate a DB-BIND, but if protocol is manual, you must code a DB-BIND REC recordname. Coding DB-BIND overrides the automatic generation of the call.

• If IDM-PROTOCOL MANUAL is not coded, do not code any options with DB-BIND. APS generates a COPY IDMS RECORD recordname for every DB-BIND REC recordname.

• No status flags are generated; paragraph IDMS-STATUS checks for errors.

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 SYEN   IDM-PROTOCOL BATCH-AUTOSTATUS MANUAL
   .
   .
   .
 PROC
        DB-BIND RUN-UNIT DBNAME TESTDB
        DB-BIND REC EMPLOYEE
        DB-OPEN MODE RETRIEVAL
        PERFORM 100-PROCESS-RTN

DB-CLOSE

Category:

Database call (see Database Calls)

Compatibility:

IDMS DB, SQL, and VSAM batch targets

Description:

Close IDMS files and subschema areas; close SQL cursor sets; close VSAM batch files.

Syntax:

IDMS DB

DB-CLOSE ALL

VSAM Batch

Format 1:

DB-CLOSE FILE filename1 [ ... filenameN]

Format 2:

DB-CLOSE FILE ALL

SQL

DB-CLOSE CUR[SOR] cursorname

Parameters:

Comments:

IDMS DB

• DB-CLOSE nullifies all currencies; execute appropriate DB-BIND and DB-OPEN calls in order to use the database again within the same program.

• APS generates DB-CLOSE for all online programs unless the program is a linked program or DB-CLOSE is coded.

SQL

A cursor set can be opened, processed, and closed multiple times in the same program; you must code DB-CLOSE before you invoke another DB-OPEN.

VSAM Batch

DB-CLOSE is required.

DB-COMMIT

Category:

Database call (see Database Calls)

Compatibility:

SQL target

Description:

Perform database commit functions.

Syntax:

DB-COMMIT [HOLD]

Parameters:

Comments:

Any SQL program running under ISPF prototype or ISPF Dialog generates DB2 COMMITs upon normal termination of the program (for example, through TP-SEND, TP-XCTL, TP-TERM). In addition, APS provides two variables you can code that generate COMMITs for DB calls under either ISPF prototyping or ISPF Dialog.

• &DB2-AUTO-COMMIT = 0. Code this variable before the NTRY call in your program to generate a COMMIT for the following DB calls.

  DB-STORE
  DB-ERASE (except with WHERE or WHERE CURRENT)
  DB-MODIFY (except with WHERE or WHERE CURRENT)

• &TP-ISPF-DB2-COMMIT-NEEDED = 1. If you modify the NTRY call in such a way that you need a COMMIT generated at the end of your modification routine (for example, if you perform an update or open a cursor), code this variable and set it to 1 before the NTRY call in your program. You can modify NTRY by updating $TP-ENTRY functions in the APS CNTL file APDLGIN and coding edit routines.

DB-DECLARE

Category:

Database call (see Database Calls)

Compatibility:

SQL target

Description:

Designate a set of rows as a logical group, that is, a cursor set. The call declares:

• All rows and columns in a table
• All columns, from specific rows, in a table
• Specific columns in a table
• Specific columns, from specific rows, in a table

Syntax:

Format 1, unqualified, select all columns:

DB-DECLARE cursorname copylibname-REC
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... [UPDATE|ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]

Format 2, qualified, select all columns:

DB-DECLARE cursorname copylibname-REC
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... WHERE column operator [[:]altvalue]|column
... [AND|OR column operator [[:]altvalue]|column]
... [UPDATE|ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]

Format 3, select specific columns:

DB-DECLARE cursorname copylibname-REC
... [DISTINCT]
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... column1 [(altvalue)] [... columnN [(altvalue)]]
... [WHERE column operator [[:]altvalue]|column
... [AND|OR correlname.]column operator [[:]altvalue]|column]
   .
   .
   .
... [AND|OR correlname.]column operator [[:]altvalue]|column]]
... [UPDATE|ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]

Format 4, join columns from two or more tables:

DB-DECLARE cursorname correlname.copylibname-REC
... [DISTINCT]
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... [correlname.copylibname-REC
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
   .
   .
   .
... [WHERE correlname.column operator [:]altvalue|correlname.column
... [AND|OR correlname.column oper [:]altvalue|correlname.column]
   .
   .
   .
... [AND|OR correlname.column operator [:]altvalue|correlname.col]]
... [ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]

Format 5, specify a UNION:

DB-DECLARE cursorname copylibname-REC
... [DISTINCT]
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... [WHERE column operator [[:]altvalue]|column
... [AND|OR column operator [[:]altvalue]|column]
   .
   .
   .
... [AND|OR column operator [[:]altvalue|]column]]
... UNION [ALL]
DB-OBTAIN REC copylibname-REC
   .
   .
   .
... [ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]

Parameters:

Comments:

• Declare a cursor before coding a DB-OPEN or DB-FETCH call.

• Because a declared cursor name is referenced by all subsequent calls for that cursor, code UPDATE to specify which columns can be modified; otherwise columns cannot be modified in subsequent cursor processing.

• When specifying columns for sorting, identify them either by name or position in the selection list; do not mix references.

• When you code WITH HOLD, a commit operation commits all the changes in the current unit of work, but releases only locks that are not required to maintain the cursor. Afterwards, you must code an initial DB-FETCH before you can execute a positioned update or delete. After the initial DB-FETCH, the cursor is positioned on the row following the one it was positioned on before the commit operation.

• The WITH HOLD clause is ignored in CICS and IMS DC.

Examples:

DB-DECLARE D2MAST-CURSOR D2TAB-REC
... UPDATE PM_COLOR PM_NEW_PART_NO

DB-DECLARE D2MAST-CURSOR D2TAB-REC
... DISTINCT
... WHERE PM_PART_SHORT_DESC = 
... :WS-PART-SHORT-DESC
... AND PM_UNIT_BASE_PRICE BETWEEN 10 AND 50

DB-DECLARE D2MAST-CURSOR D2TAB-REC
... PM_PART_NO
... PM_COLOR (WS-COLOR)
... WHERE PM_PART_SHORT_DESC = 
... :WS-PART-SHORT-DESC
... AND PM_UNIT_BASE_PRICE BETWEEN 10 AND 50

DB-DECLARE D2MAST-CURSOR D2TAB-REC
... DISTINCT
... PM_PART_NO PM_COLOR
... WHERE PM_PART_SHORT_DESC = 
... :WS-PART-SHORT-DESC
... ORDER 2, 1

DB-DECLARE JOIN-CUR A.D2TAB-REC
... DISTINCT
... PM_PART_NO PM_COLOR
... B.D2INVEN_REC IN_QTY_ONHAND
... WHERE A.PM_PART_NO = B.IN_PART_NO
... AND A.PM_COLOR = :WS-COLOR
... AND B.IN_COLOR = 'BLUE'
... UNION
DB-OBTAIN REC D2TAB-REC
... PM_PART_NO PM_COLOR PM_UNITS
... WHERE PM_COLOR ^= 'BLUE'
... AND PM_UNITS < 50
... ORDER 1 ASC, 2 ASC

DB-ERASE

Category:

Database call (see Database Calls)

Description:

Delete a record or records.

Under IDMS, the call deletes:

• Record from all sets in which it participates as a member
• Record from database
• Mandatory and optional member records

Under IMS, the call deletes:

• Record and all dependent segments
• Record obtained by a path call DB-OBTAIN

Under SQL, the call deletes:

• All rows in a table
• Specific row in a table
• Cursor set rows

Under VSAM, the call deletes:

• Record(s) specified by key qualification via DB-OBTAIN (key qualified)
• Record retrieved by DB-OBTAIN or DB-PROCESS (unqualified)

Syntax:

IDMS DB

DB-ERASE REC recordname [PERM|SELECT|ALL]

IMS DB

Format 1:

DB-ERASE REC segment [FROM dataarea]
... [VIEW pcbname|PCB pcbname]

Format 2:, records obtained by path calls:

DB-ERASE REC|REF segment1 [FROM dataarea]
... [VIEW pcbname|PCB pcbname]
... REC|REF segment2 [FROM dataarea]
... [VIEW pcbname|PCB pcbname]
   .
   .
   .
... REC segmentN [FROM dataarea]
... [VIEW pcbname|PCB pcbname]

SQL

Format 1:

DB-ERASE REC copylibname-REC
... [WHERE column operator [:]altvalue
... [AND|OR column operator [:]altvalue
  .
  .
  .
... AND|OR column operator [:]altvalue]]

Format 2:

DB-ERASE REC copylibname-REC
... [WHERE CURRENT [OF] cursorname]

VSAM Batch

Format 1, key-qualified:

DB-ERASE REC recordname
 ... WHERE primarykeyname = value
 ... [SUB value] [OF dataarea]

Format 2, unqualified:

DB-ERASE REC recordname

VSAM Online

Format 1, key-qualified:

DB-ERASE REC recordname
... WHERE primarykeyname = value
... [SUB value] [OF dataarea] [KLEN value]
... [SYSID systemname] [DDN ddname]

Format 2, unqualified:

DB-ERASE REC recordname

Parameters:

Comments:

IDMS DB

Record to be deleted must be current of run unit.

IMS DB

• DB-ERASE assumes record retrieval from the default I/O area. If this is not true, you must code FROM dataarea.

• When a record is obtained from a PCB other than the default PCB, such as by DB-OBTAIN with VIEW or PCB, you must code VIEW pcbname.

• Specify every segment down to the first segment being deleted for records obtained by path calls. That is, every record named in an DB-OBTAIN preceding an ERASE must be named in the DB-ERASE, also.

Examples:

DB-ERASE REC ORDER ALL

 DB-OBTAIN REC RECORD-A WHERE KEY-A = VALUE-A
 ... REC RECORD-B WHERE KEY-B = VALUE-B
 ... REC RECORD-C WHERE KEY-C = VALUE-C HOLD

DB-ERASE REF RECORD-A
... REC RECORD-B
... REC RECORD-C

DB-ERASE REC D2TAB-REC
... WHERE PM_PART_NO = '123'
... OR PM_PART_NO = '567'

DB-ERASE REC ORDR-RECORD
... WHERE ORDR-NUMBER = CUST-ORDR-NUMBER

DB-OBTAIN REC CUST-RECORD
... WHERE CUST-KEY = SCREEN-CUST-KEY
IF OK-ON-REC
    DB-ERASE REC CUST-RECORD

DB-ERASE REC ORDR-RECORD
... WHERE ORDR-NUMBER = SCREEN-PARTIAL-ORDR-NUMBER
... KLEN 6
IF  OK-ON-REC
    SCREEN-MSG = 
... 'ORDER RECORDS DELETED, NUMBER ORDERS = '
    SCREEN-NBR-RECS = APS-VSAM-NUMREC

DB-OBTAIN REC CUST-RECORD
... WHERE CUST-KEY = SCREEN-CUST-KEY
... HOLD
IF OK-ON-REC
    DB-ERASE REC CUST-RECORD

DB-FETCH

Category:

Database call (see Database Calls)

Compatibility:

SQL target

Description:

Sequentially retrieve rows from the cursor set defined by DB-DECLARE.

Syntax:

DB-FETCH CUR[SOR] cursorname
... [INTO dataname]

Parameters:

IF OK-ON-REC
    MOVE hostname TO dataname

Comments:

• When you define a cursor set with DB-DECLARE, SQL places the selected rows in a results table, or cursor set. DB-FETCH retrieves these rows.

• Each DB-FETCH returns the next row of the cursor set until the end of the results table is reached. The row returned by the current iteration of DB-FETCH is the current row.

• You can code DB-FETCH within an S-COBOL loop to retrieve multiple rows from a cursor set.

• To FETCH into individual columns, specify those alternate host variables in DB-DECLARE.

Example:

DB-FETCH CURSOR D2MAST-CURSOR
... INTO WS-D2MAST-RECORD

DB-FREE

Category:

Database call (see Database Calls)

Compatibility:

VSAM online target

Description:

Release file resources and:

• End a sequential DB-OBTAIN browse.

• Unlock a held record (a record held by a DB-OBTAIN HOLD) when DB-OBTAIN is not followed by DB-MODIFY or DB-ERASE.

Syntax:

DB-FREE REC recordname|ALL
... [VIEW keyname]
... [ENDBR] [UNLOCK] [REQID number]
... [SYSID systemname] [DDN ddname]

Parameters:

Comments:

• UNLOCK and ENDBR are default keywords. De-activate as follows.
  • Coding only ENDBR makes UNLOCK inactive.
  • Coding only UNLOCK makes ENDBR inactive.

• When ALL is coded and UNLOCK and ENDBR are active, a single DB-FREE call (located in a central paragraph) works for the entire program. Note Code ALL only when &VS-ENDBR-CONTROL = "APS" (found in the APS CNTL file APVSAMIN).

Examples:

DB-OBTAIN REC ORDR-RECORD
... WHERE ORDR-NUMBER = SCREEN-ORDR-NUMBER
... HOLD
DB-FREE REC ORDR-RECORD UNLOCK

DB-OBTAIN REC CUST-RECORD
... VIEW CUST-NUMBER
DB-FREE REC CUST-RECORD
... VIEW CUST-NUMBER ENDBR

DB-GET

Category:

Database call (see Database Calls)

Compatibility:

IDMS DB target

Description:

Move data from a previously located record (via a DB-OBTAIN REF) into Working-Storage.

Syntax:

DB-GET REC [recordname]

Parameter:

Example:

DB-GET REC ORDER

DB-MODIFY

Category:

Database call (see Database Calls)

Description:

Modify a record.

Under IDMS DB, the call rewrites the object record in the database from Working-Storage.

Under SQL, the call updates row contents in a table or cursor set, as follows.

• All rows in a table
• Specific rows in a table
• Specific columns in a table
• Specific columns of a specific row
• Cursor set rows

Syntax:

IDMS DB

DB-MODIFY REC recordname

IMS DB

DB-MODIFY
... REC|REF recordname1 [FROM dataarea]
... [VIEW pcbname|PCB pcbname]
   .
   .
   .
... REC|REF recordnameN [FROM dataarea]
... [VIEW pcbname|PCB pcbname]

SQL

DB-MODIFY REC copylibname-REC
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... [FROM dataname]
... [WHERE column1 operator [:]altvalue
   .
   .
   .
... AND|OR columnN operator [:]altvalue]
... [END[WHERE]]]
... [WHERE CURRENT [OF] cursorname]

VSAM Batch

DB-MODIFY REC recordname [FROM dataarea]

VSAM Online

DB-MODIFY REC recordname [FROM dataarea]
... [SYSID systemname] [DDN ddname]

Parameters:

Comments:

IDMS DB

The object record must be current of run unit. If a CALC key is modified, the object record can be accessed by the new CALC key value.

IMS DB

• The record must be retrieved and held by a DB-OBTAIN or DB-PROCESS call before it can be modified.

• DB-MODIFY assumes record retrieval is from the default I/O area. If it is not, code FROM dataarea.

• When a record is not obtained from the default PCB, such as by DB-OBTAIN with VIEW or PCB, code VIEW pcbname.

• To modify records obtained by a path call DB-OBTAIN, specify every segment obtained in the path. To specify that a segment is not modified, code REF.

VSAM Batch and Online

Before modifying a record, retrieve it with a DB-OBTAIN or DB-PROCESS call.

Examples:

DB-MODIFY REC ORDER

DB-OBTAIN REC RECORD-A WHERE KEY-A = VALUE-A
... REC RECORD-B WHERE KEY-B = VALUE-B
... REC RECORD-C WHERE KEY-C = VALUE-C HOLD
DB-MODIFY REF RECORD-A
... REF RECORD-B
... REC RECORD-C

DB-MODIFY REC D2TAB-REC
... PM_UNIT_BASE_PRICE (25.99)
... PM_UNITS (:WS-UNITS)
... WHERE PM_PART_SHORT_DESC = 'WIDGET'
... AND PM_COLOR = 'RED'
... AND PM_UNIT_BASE_PRICE < 50

DB-OBTAIN REC CUST-RECORD
... WHERE CUST-NUMBER = SCREEN-CUST-NUMBER
IF  OK-ON-REC
    DB-MODIFY REC CUST-RECORD
    ... FROM CUST-RECORD-UPDATE-AREA

DB-OBTAIN REC CUST-RECORD
... WHERE CUST-NUMBER = SCREEN-CUST-NUMBER
... HOLD
IF  OK-ON-REC
    DB-MODIFY REC CUST-RECORD
    ... FROM CUST-RECORD-UPDATE-AREA

DB-OBTAIN

Category:

Database call (see Database Calls)

Description:

Read and retrieve a database record.

Under IDMS DB, DB-OBTAIN:

• Retrieves or finds a record stored within an IDMS database
• Moves a record into Working-Storage
• Establishes currency for a given record type

Under IMS, DB-OBTAIN retrieves segments at any level and performs:

• Qualified and unqualified record retrievals
• Retrieval of records qualified on multiple fields (Boolean qualification)
• Retrieval of records qualified on secondary indices composed of more than one field
• Compound calls
• Path calls
• Hold segments for modification or deletion
• Current positioning
• Reset positioning
• First/last qualification
• Naming of an alternate I/O area that a record is read into or stored from
• Retrieval of segments using concatenated key qualification

Under SQL, DB-OBTAIN:

• Selects an entire row qualified on one column
• Selects an entire row qualified on multiple columns
• Selects specific columns from a row
• Names an alternate data name into which the host-variable structure is moved
• Joins columns from more than one table
• Specifies a union

Under VSAM, DB-OBTAIN:

• Reads records from a file
• Provides a starting point in a file that meets specified key criteria in the call
• Reads calls sequentially, in ascending key order (sequential DB-OBTAIN)
• Reads a record based upon specified key criteria (direct DB-OBTAIN)
• Positions a file for a sequential DB-OBTAIN, based upon key criteria (positional DB-OBTAIN)

Syntax:

IDMS DB

Format 1, based on a CALC key or an indexed or sorted set:

DB-OBTAIN REC|REF recordname
... WHERE keyname = value [NEXT]
... [HOLD] [EXCLUSIVE]

Format 2, where the most recently retrieved occurrence of a record type is current of run unit:

DB-OBTAIN REC|REF recordname CURRENT
... [HOLD] [EXCLUSIVE]

Format 3, where the most recently retrieved occurrence of any record in the set or area is current of run unit:

DB-OBTAIN REC|REF IDMSREC
... SET setname|AREA areaname CURRENT
... [HOLD] [EXCLUSIVE]

Format 4, based on database address:

DB-OBTAIN REC|REF IDMSREC|recordname
... WHERE DBKEY = value
... [HOLD] [EXCLUSIVE]

Format 5, where the set owner is obtained when record is unknown:

DB-OBTAIN REC|REF IDMSREC
... SET setname OWNER
... [HOLD] [EXCLUSIVE]

Format 6, based on a CALC key or an indexed or sorted set, using a valid operator:

DB-OBTAIN [REF recordname1] REC|REF recordname2
... WHERE sortkey operator value
... [SET setname [RESET]]|[RESET]
... [HOLD] [EXCLUSIVE]

Format 7, based on position within set:

DB-OBTAIN [REF recordname1] REC|REF recordname2
... [SET setname]
... [WHERE SEQUENCE = number|FIRST|LAST|PREV|NEXT]
... [HOLD] [EXCLUSIVE]

Format 8, based on position within the set when the record is unknown:

DB-OBTAIN REC|REF IDMSREC SET setname|AREA areaname
... [WHERE SEQUENCE = number|FIRST|LAST|PREV|NEXT]
... [HOLD] [EXCLUSIVE]

Format 9, based on position within area:

DB-OBTAIN REC|REF recordname [AREA areaname]
... [WHERE SEQUENCE = number|FIRST|LAST|PREV|NEXT]
... [HOLD] [EXCLUSIVE]

IMS DB

Format 1, unqualified:

DB-OBTAIN REC recordname [HOLD] [RESET]

Format 2, qualified:

DB-OBTAIN REC recordname
... WHERE fieldname1 operator value
... [AND|OR fieldname2 operator value [FIRST|LAST]
... [INTO dataarea]
        .
        .
... [AND|OR fieldnameN operator value] [FIRST|LAST]
... [INTO dataarea] [HOLD]]] [RESET]

Format 3, qualified on secondary index values:

DB-OBTAIN REC recordname
... WHERE fieldname operator (value1 [ ... valueN])
... [INTO dataarea]
... [FIRST|LAST] [HOLD] [RESET]

Format 4, qualified compound retrieval:

DB-OBTAIN REF segmentname1 WHERE fieldname1 operator value
... REC|REF segmentname2 WHERE fieldname2 operator value
        .
        .
        .
... [REC segmentnameN WHERE fieldnameN operator value
... [FIRST|LAST] [HOLD]]
... [RESET]

Format 5, retrieve next segment:

DB-OBTAIN NEXT[REC] INTO dataarea 
...VIEW pcbname|PCB pcbname [HOLD] [RESET]

Format 6, retrieve segment specified in program at run time:

MOVE 'segmentname' TO segmentname
DB-OBTAIN IMSREC segmentname FROM dataarea
... VIEW pcbname|PCB pcbname

Format 7, retrieve dependent of current record:

DB-OBTAIN REF recordname1 CURRENT
... REC recordname2 [WHERE fieldname operator value]

Format 8, retrieve segment from PSB with multiple PCBs:

DB-OBTAIN REC recordname
... [WHERE fieldname operator value]
... VIEW pcbname|PCB pcbname

Format 9, retrieve qualified or subscripted field:

DB-OBTAIN REC recordname
... WHERE keyname operator fieldname
... OF dataarea|SUB (number)

Format 1, retrieve dependent record via concatenated key:

DB-OBTAIN REC recordname CKEYED dataname

Format 1, qualified, select all columns:

DB-OBTAIN REC copylibname-REC
... WHERE column operator [:]altvalue|column
... [AND|OR column operator [:]altvalue|column]
        .
        .
        .
... [AND|OR column operator [:]altvalue|column]
... [INTO dataname]

Format 2, unqualified, select all columns:

DB-OBTAIN REC copylibname-REC
... [INTO dataname]

Format 3, join all columns from two tables:

DB-OBTAIN REC correlname1.copylibname-REC
... REC correlnameN.copylibname-REC
... [WHERE correlname.column oper [:]altvalue|correlname.column
... [AND|OR correlname.column op [:]altvalue|correlname.column]
        .
        .
... [AND|OR correlname.column oper [:]altvalue|correlname.col]]

Format 4, select specific columns:

DB-OBTAIN REC copylibname-REC [DISTINCT]
... column1 [(altvalue)] [... columnN [(altvalue)]]
... [WHERE [correlname.]column operator [:]altvalue|column]

VSAM Batch

Format 1, sequential:

DB-OBTAIN REC recordname 
... [VIEW keyname] [INTO dataarea] [RESET]

Format 2, direct:

DB-OBTAIN REC recordname
... WHERE keyname operator value [SUB value]
... [OF dataarea] [INTO dataarea]

Format 3, positional:

DB-OBTAIN REF recordname
... WHERE keyname operator value [SUB value] [OF dataarea]

VSAM Online

Format 1, sequential:

DB-OBTAIN REC recordname 
... [VIEW keyname] [INTO dataarea]
... [HOLD] [PREV] [REQID number] [RESET]
... [SYSID systemname] [DDN ddname]

Format 2, direct:

DB-OBTAIN REC recordname
... WHERE keyname operator value [SUB value]
... [OF dataarea] [INTO dataarea] [KLEN value]
... [HOLD] [REQID number]
... [SYSID systemname] [DDN ddname]

Format 3, positional:

DB-OBTAIN REF recordname
... WHERE keyname operator value [SUB value] [OF dataarea]
... [KLEN value] [RESETBR] [REQID number]
... [SYSID systemname] [DDN ddname]

Parameters:

IF OK-ON-REC
    MOVE hostname TO dataname

Comments:

IDMS DB

• If REF is coded without REC, the action performed is a FIND.

• In Format 1:, if an indexed or sorted set has a complex key (that is, more than one field makes up the key), a Working-Storage area named setname-KEY is generated to store the key values. Before coding DB-OBTAIN, move the desired values to the appropriate fields in the record obtained.

• In Format 6, to use multiple sets, code SET setname. Code RESET unless currency on the set has been established.

IMS DB

• In Format 2, fieldname1 can be a primary key, secondary key, segment sequence field, or segment search field. If it is a secondary key made up of more than one field, the data name supplied as value must be a concatenation of all fields composing the index.

• In Format 3, the number of values listed within parentheses must equal the number of source fields making up the index, and be listed in the same order. Values can be qualified or subscripted.

• In Format 4:
  • Ensure that all segments lie along a single imaginary path that runs from the root down to the dependent segment, and are in the same logical database.

  • Specify segments in hierarchical order.

  • With a compound DB-OBTAIN, code REC for the lowest level segment.

• In Format 5:
  • Do not use with IMS call codes.
  • NEXTREC generates IMS retrieval call without segment search arguments (SSAs).
  • Do not use field qualifications with NEXTREC and IMSREC.

• In Format 6:
  • Code only one segment per call. Move the correct IMS segment name into Working-Storage before issuing the call.

  • Do not use field qualifications with NEXTREC and IMSREC.

• In Format 7:
  • Code CURRENT only with REF.
  • Code CURRENT for the first level specified.
  • Do not qualify a CURRENT segment in any other way; you can qualify segments below as usual.

VSAM Online

Always follow a DB-OBTAIN HOLD with a DB-MODIFY or DB-ERASE.

Examples:

MOVE SCR1-LAST-NAME TO CUSTOMER-LAST-NAME
MOVE SCR1-FIRST-NAME TO CUSTOMER-FIRST-NAME
DB-OBTAIN REC CUSTOMER WHERE CUSTOMER-NAME-KEY = *

DB-OBTAIN REC IDMSREC AREA CUST-REGION
... CURRENT

DB-OBTAIN REC CUSTOMER WHERE DBKEY = WS-DBKEY

DB-OBTAIN REF CUSTOMER REF ORDER WHERE SEQUENCE = 5

DB-OBTAIN REF SEGMENT-A WHERE KEY-A = VALUE-A
... REF SEGMENT-B WHERE KEY-B = VALUE-B
... REC SEGMENT-C WHERE KEY-C = VALUE-C HOLD

DB-OBTAIN REC SEGMENT-A WHERE KEY-A = VALUE-A
... REC SEGMENT-B WHERE KEY-B = VALUE-B
... REC SEGMENT-C HOLD

DB-OBTAIN REC SEGMENT-A WHERE KEY-A = VALUE-A
... REF SEGMENT-B WHERE KEY-B = VALUE-B
... REC SEGMENT-C HOLD

DB-OBTAIN REC RECORD-A WHERE FIELD-1 = VALUE-1
DB-OBTAIN REF RECORD-A CURRENT
... REC RECORD-B WHERE FIELD-2 = VALUE-2

DB-OBTAIN REF RECORD-A WHERE FIELD-1 = VALUE-1
... REC RECORD-B LAST

DB-OBTAIN REF RECORD-A
... REC RECORD-B INTO DATAAREA-B
... REC RECORD-C INTO DATAAREA-C

DB-OBTAIN REC RECORD-A
... WHERE KEY-A = FIELD-X OF DATAAREA-Z

01  FIELD-X OCCURS 10 TIMES PIC X(10).
        .
        .
        .
DB-OBTAIN REC RECORD-A
... WHERE KEY-A = FIELD-X SUB(7)
        .
        .
        .
DB-OBTAIN REC RECORD-C
... CKEYED WS-FIELD

DB-OBTAIN REC D2TAB-REC
... WHERE PM_PART_NO = '123'
... INTO WS-D2MAST-RECORD

DB-OBTAIN REC D2TAB-REC DISTINCT
... WHERE PM_PART_SHORT_DESC = 'WIDGET'
... AND PM_COLOR = 'RED'

DB-OBTAIN REC D2TAB-REC DISTINCT
... PM_PART_NO PM_COLOR (WS-COLOR)
... WHERE PM_PART_SHORT_DESC = 'WIDGET'
... AND PM_COLOR = 'RED'

DB-OBTAIN REC CUST-RECORD VIEW CUST-NUMBER

DB-OBTAIN REC CUST-RECORD
... INTO CUST-RECORD-SAVE-AREA

DB-OBTAIN REC CUST-RECORD
... WHERE CUST-NUMBER = SCREEN-CUST-NUMBER
... SUB (ROW-CTR)

DB-OBTAIN REF CUST-RECORD
... WHERE CUST-NUMBER = SCREEN-CUST-NUMBER
IF  OK-ON-REC
    DB-OBTAIN REC CUST-RECORD
    ... VIEW CUST-NUMBER

DB-OBTAIN REC CUST-RECORD
... INTO CUST-RECORD-SAVE-AREA
... HOLD
      .
      .
DB-MODIFY REC CUST-REC

DB-OBTAIN REC CUST-RECORD VIEW CUST-NUMBER

DB-OBTAIN REC CUST-RECORD
... WHERE CUST-NUMBER = SCREEN-CUST-NUMBER SUB (ROW-CTR)

DB-OBTAIN REC ORDR-RECORD
... WHERE ORDR-NUMBER = CUST-ORDR-NUMBER HOLD

DB-OBTAIN REF CUST-RECORD
... WHERE CUST-NAME = SCREEN-CUST-NAME
IF  OK-ON-REC
    DB-OBTAIN REC CUST-RECORD... VIEW CUST-NAME

DB-OPEN

Category:

Database call (see Database Calls)

Compatibility:

IDMS DB, SQL, and VSAM batch targets

Description:

Open a record, cursor set, or file.

Syntax:

IDMS DB

DB-OPEN [ALL] [MODE usagemode]
... [AREA areaname]

SQL

DB-OPEN CUR[SOR] cursorname

OS4 and VSAM Batch

Format 1:

DB-OPEN FILE filename [... filename]
... MODE option

Format 2:

DB-OPEN FILE ALL
... MODE option

Parameters:

Comments:

IDMS DB

• DB-OPEN generates an IDMS READY command; if not coded, the call is automatically generated.
• Usagemode, if specified in the subschema, replaces RETRIEVAL as the default.

SQL

A cursor set can be opened, processed, and closed multiple times in the same program. A DB-OPEN issued for an open cursor set causes an error; first code a DB-CLOSE.

SAM Batch

DB-OPEN is required.

Examples:

DB-OPEN FILE DORDER MODE EXTEND

DB-OPEN ALL

DB-OPEN MODE PROTECTED UPDATE AREA CUSTOMER-REGION

DB-OPEN CURSOR D2MAST-CURSOR

DB-OPEN FILE AORDER ASUPLIR MODE I-O

DB-PROCESS

Category:

Database call (see Database Calls)

Description:

Combine record retrieval and looping functions into one call.

Under IDMS DB, DB-PROCESS processes all records within a set, an area, or an indexed set based on a specified value.

Under IMS, DB-PROCESS processes:

• Records that satisfy the key qualification (key qualified)
• Records sequentially (unqualified)

Under SQL, DB-PROCESS simplifies cursor row processing by:

• Declaring a cursor
• Opening a cursor for processing
• Defining a loop flag and a loop counter
• Providing logic for retrieving rows from the results table
• Executing user-written row processing code
• Processing closing the cursor set file at the end of processing
• Processing entire rows throughout a cursor set
• Processing specific columns throughout a cursor set
• Processing specific columns and rows throughout a cursor set
• Processing columns from more than one table, such as a join)

Under VSAM, DB-PROCESS processes records:

• Sequentially, beginning at the position established by the key qualification (key qualified)

• Sequentially, beginning at the beginning, end, or a previously defined position in the file (unqualified)

Syntax:

IDMS DB

DB-PROCESS [REF recordname] REC recordname
... [DB-PROCESS-ID name] [WHERE keyname operator value]
... [SET setname|AREA areaname] [RESET] [HOLD] [EXCLUSIVE]
 Controlled logic block

IMS DB

Format 1, key-qualified:

DB-PROCESS REC recordname
... [WHERE keyname operator value [SUB value] [OF dataarea]]
... [DB-PROCESS-ID name] [INTO dataarea]
... [HOLD] [RESET]
... [VIEW pcbname|PCB pcbname]
 Controlled logic block

Format 2, unqualified:

DB-PROCESS REC recordname
... [DB-PROCESS-ID name] [INTO dataarea]
... [HOLD] [RESET]
... [VIEW pcbname|PCB pcbname]
 Controlled logic block

SQL

Format 1, unqualified--select all columns:

DB-PROCESS REC copylibname-REC
... [DB-PROCESS-ID name]
... [DB-LOOP-MAX=number]
... [FETCH ONLY] [WITH HOLD]
... [OPTIMIZE number]
... [UPDATE|ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]
... [INTO dataname]
 Controlled logic block

Format 2, qualified--select all columns:

DB-PROCESS REC copylibname-REC
... [DB-PROCESS-ID name]
... [FETCH ONLY] [WITH HOLD] [OPTIMIZE number]
... WHERE column operator [[:]]altvalue]|column
... [AND|OR column operator [[:]altvalue]|column]
          .
          .
... [AND|OR column operator [[:]altvalue]|column]
... [DB-LOOP-MAX=number]
... [UPDATE|ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]
... [INTO dataname]
 Controlled logic block

Format 3, select specific columns:

DB-PROCESS REC copylibname-REC
... [DB-PROCESS-ID name]
... [DISTINCT]
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... column1 [(altvalue)] [... columnN [(altvalue)]]
... WHERE column operator [[:]altvalue]|column
... [AND|OR column operator [[:]altvalue]|column]
          .
          .
          .
... [AND|OR column operator [[:]altvalue]|column]
... [DB-LOOP-MAX=number]
... [UPDATE|ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]
 Controlled logic block

Format 4, join columns from two or more tables:

DB-PROCESS REC correlname.copylibname-REC
... [DB-PROCESS-ID name] [DISTINCT]
... [FETCH ONLY] [WITH HOLD]
... [OPTIMIZE number]
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... REC correlname.copylibname-REC
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
          .
          .
... [WHERE correlname.column oper [[:]altvalue]|correlname.column
... [AND|OR correlname.column oper [[:]altvalue]|correlname.col]
          .
          .
... [AND|OR correlname.column oper [[:]altvalue]|correlname.col]
... [DB-LOOP-MAX=number]
... [ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]
 Controlled logic block

Format 5, specify a UNION:

DB-PROCESS REC copylibname-REC
... [DB-PROCESS-ID name]
... [DISTINCT]
... [FETCH ONLY]
... [WITH HOLD]
... [OPTIMIZE number]
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... [WHERE column operator [[:]altvalue]|column
... [AND|OR column operator [[:]altvalue]|column]
          .
          .
          .
... [AND|OR column operator [[:]altvalue]|column]]
... [DB-LOOP-MAX=number]
... UNION [ALL]
DB-OBTAIN REC copylibname-REC
          .
          .
          .
... [ORDER
... column1 [ASC|DESC] [...columnN [ASC|DESC]]]
 Controlled logic block

VSAM Batch

Format 1, qualified:

DB-PROCESS REC recordname WHERE keyname operator value
... [DB-PROCESS-ID name] [SUB value]
... [OF dataarea] [INTO dataarea]
 Controlled logic block

Format 2, unqualified:

DB-PROCESS REC recordname [VIEW keyname]
... [DB-PROCESS-ID name] [INTO dataarea] [RESET]
 Controlled logic block

VSAM Online

Format 1, key-qualified:

DB-PROCESS REC recordname WHERE keyname operator value
... [DB-PROCESS-ID name] [SUB value]
... [OF dataarea] [INTO dataarea]
... [KLEN value] [HOLD] [PREV]
... [REQID number] [SYSID systemname]
... [DDN ddname]
 Controlled logic block

Format 2, unqualified:

DB-PROCESS REC recordname
... [DB-PROCESS-ID name] [INTO dataarea]
... [HOLD] [PREV] [RESET]
... [REQID number] [SYSID systemname]
... [VIEW keyname] [DDN ddname]
 Controlled logic block

Parameters:

IF OK-ON-REC
MOVE hostname TO dataname

Loop Structure

DB-PROCESS provides a built-in loop structure to process records and rows. The loop structure can include blocks of user-supplied logic and APS-generated control fields. User logic executes once for each successful iteration of DB-PROCESS, and can include

• Any APS/DB call, except DB-OPEN, DB-DECLARE, or DB-CLOSE
• Record and row processing code, for example, MOVE DATA TO SCREEN

APS generates the following fields, enabling you to logically terminate the loop structure.

IMS DB, VSAM Batch, and VSAM Online

Sample loop syntax:

/* Begin process loop
DB-PROCESS REC recordname
... WHERE keyname operator value parameters
... [DB-PROCESS-ID name]
    IF  APS-PROCESS-CTR|name-PROCESS-CTR > value
    /* End process loop
        TRUE APS-END-PROCESS|name-END-PROCESS
    ELSE
        /* User-written record processing logic
IF ...
/*Logic executed after process loop termination
/*    Includes file status checking

IDMS DB

Sample loop syntax:

DB-OBTAIN REC recordname WHERE key = value
/* Begin process loop
DB-PROCESS REF recordname REC recordname
    IF APS-PROCESS-CTR > value
    /* End process loop
        TRUE APS-END-PROCESS
    ELSE
        /* User-written record processing logic
        /*     Can include file status checking
/* Logic executed after process loop termination
   /*     Can include file status checking

SQL

Sample loop syntax:

/* Begin process loop
DB-PROCESS REC recordname
    /* Custom row processing code
    IF APS-PROCESS-CTR|name-PROCESS-CTR > value
    /* End process loop
        TRUE APS-END-PROCESS|name-END-PROCESS
    ELSE
        /* Custom record processing logic
        /*     Can include file status checking
/* Logic executed after process loop termination
/*     Can include file status checking

Comments:

• Under IDMS DB and SQL, code file status checking inside a DB-PROCESS loop; under IMS DB, and VSAM Batch or Online, code file status checking outside the process loop.

• You can nest DB-PROCESS calls if you supply each call with a unique DB-PROCESS-ID clause, thus providing controlled exits for each.

• DB-PROCESS continues looping until the program reaches a TRUE APS-END-PROCESS or TRUE name-END-PROCESS, an invalid or end of file condition, the limit defined by an APS internal counter.

• You can change the value of LOOP-MAX in the APSMACS file; this affects all generated applications. Or, change the LOOP-MAX limit at the program level by redefining it at the top of your program with the SYM1 or SYM2 keyword. For example:

  SYM1    % &prefix-LOOP-MAX = 200

• APS defines a loop limit as follows:
  • If you do not code DB-PROCESS-ID, the loop limit is 500, set by the APS counter &APS-DB-PROCESS-GLOBAL-LIMIT. This counter resides in the APSMACS file APSBASE.

  • If you do code DB-PROCESS-ID, adhere to the following loop limit and counter for each target.

    Target	Limit	APS Counter
    IDMS	100	&IDMS-LOOP-MAX
    IMS DB	100	&VS-IMS-LOOP-MAX
    SQL	100	&DB2-LOOP-MAX
    VSAM Batch	999,999	&VS-MVS-LOOP-MAX
    VSAM Online	100	&VS-CICS-LOOP-MAX

IMS DB

Processing begins at a previously established position in the database or, if RESET coded, at the beginning of the database.

SQL

• DB-PROCESS generates and performs the DB-DECLARE, DB-OPEN, DB-FETCH, and DB-CLOSE calls within loop structure.

• APS automatically declares the cursor at the first DB-PROCESS. All subsequent calls within the loop reference the cursor. The cursor is named
  • By you, if you code DB-PROCESS-ID.

  • By APS, which generates a copylib name and a numeric suffix, beginning with one and increasing by one with each subsequent DB-PROCESS for the same DCLGEN or copybook member.

• When you code WITH HOLD, a commit operation commits all the changes in the current unit of work, but releases only locks that are not required to maintain the cursor. Afterwards, you must code an initial DB-FETCH before you can execute a positioned update or delete. After the initial DB-FETCH, the cursor is positioned on the row following the one it was positioned on before the commit operation.

• The WITH HOLD clause is ignored in CICS and IMS DC.

VSAM Batch

• The ENDFILE condition can be determined outside of the process loop, even after DB-PROCESS ends the sequential browse.

• You must precede a DB-PROCESS call with a DB-OPEN call, and code a subsequent DB-CLOSE call. APS does not support automatic file opening and closing.

VSAM Online

• Because DB-PROCESS terminates the active browse when the process loop is terminated, it is not necessary to end the browse with the DB-FREE call.

• DB-PROCESS unlocks a locked record when the process loop terminates. Unlocking a record via a DB-FREE UNLOCK is unnecessary.

• The ENDFILE condition can be determined outside of the process loop, even after DB-PROCESS ends the sequential browse.

Examples:

DB-PROCESS REC CUST-RECORD
... WHERE CUST-KEY >= SCREEN-KEY
... DB-PROCESS-ID CUST
        IF  CUST-PROCESS-CTR > SCREEN-MAX
            TRUE CUST-END-PROCESS
        ELSE
            SCREEN-CUST    (CUST-PROCESS-CTR) = CUST-NAME
            SCREEN-PHONE   (CUST-PROCESS-CTR) = CUST-PHONE
            SCREEN-ADDRESS (CUST-PROCESS-CTR) = CUST-ADDRESS
IF NTF-ON-REC
    SCREEN-MSG = 'CUSTOMER NOT FOUND'
ELSE-IF END-ON-REC
    SCREEN-MSG = 'END OF CUSTOMER RECORDS'

DB-PROCESS REC CUST-RECORD
... WHERE CUST-KEY >= SCREEN-KEY
... SET CUST-ORDR
... DB-PROCESS-ID CUST
        IF  CUST-PROCESS-CTR > SCREEN-MAX
            TRUE CUST-END-PROCESS
        ELSE
            SCREEN-CUST    (CUST-PROCESS-CTR) = CUST-NAME
            SCREEN-PHONE   (CUST-PROCESS-CTR) = CUST-PHONE
            SCREEN-ADDRESS (CUST-PROCESS-CTR) = CUST-ADDRESS
IF NTF-ON-REC
    SCREEN-MSG = 'CUSTOMER NOT FOUND'
ELSE-IF END-ON-REC
    SCREEN-MSG = 'END OF CUSTOMER RECORDS'

DB-PROCESS REC D2TAB-REC
... DB-PROCESS-ID D2MAST-ID
... DISTINCT
... INTO WS-D2MAST-RECORD

DB-PROCESS REC D2TAB-REC
... DB-PROCESS-ID D2MAST-ID
... PM_PART_NO (WS-PART-NO)
... PM_NEW_PART_NO (WS-NEW-PART-NO) PM_UNITS
... ORDER 1 ASC 3 DESC

DB-PROCESS REC A.D2TAB-REC
... DB-PROCESS-ID D2MAST-ID
... DISTINCT
... PM_PART_NO PM_UNITS PM_PART_SHORT_DESC
    IF D2MAST-ID-PROCESS-CTR >5
        TRUE D2MAST-ID-END-PROCESS
    ELSE
        /* Custom logic to process SAVEKEY
        IF NOT TRUE D2MAST-ID-END-PROCESS
            DB-PROCESS REC D2INV-REC
            ... DB-PROCESS-ID D2INV-ID
            ... WHERE INPM_PART_NO = :WS-SAVE-PART-NO
                /* Custom record processing logic

DB-ROLLBACK

Category:

Database call (see Database Calls)

Compatibility:

SQL target

Description:

Perform SQL ROLLBACK functions.

Syntax:

DB-ROLLBACK

DB-STORE

Category:

Database call (see Database Calls)

Description:

Write a record to a file or database.

Under IMS, DB-STORE lets you:

• Specify either a single record level or multiple records along a path, like DB-OBTAIN.

• Store a dependent segment--one that references one or more parent level segments to specify the exact record placement. This is a compound DB-STORE.

Under SQL, DB-STORE lets you add entire rows or selected columns.

Syntax:

IDMS DB

DB-STORE REC recordname

IMS DB

DB-STORE [REC|REF recordname1] [FROM dataarea]
... [VIEW pcbname|PCB pcbname]
... [WHERE fieldname operator value]
... [REC|REF recordname2] [FROM dataarea]
... [VIEW pcbname|PCB pcbname]
... [WHERE fieldname operator value]
... [SUB number] [OF dataarea]
        .
        .
        .
... REC recordnameN [FROM dataarea]
... [VIEW pcbname|PCB pcbname]
... [WHERE fieldname operator value]
... [SUB number] [OF dataarea]

OS4

DB-STORE REC recordname
... [FORMAT formatname]
... [FROM dataarea]

SQL

Format 1:

DB-STORE REC copylibname-REC
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... [FROM dataname]

Format 2:

DB-STORE REC copylibname-REC
... [column1 [(altvalue)] [... columnN [(altvalue)]]]
... [DB-OBTAIN REC copylibname-REC
... column1 [... columnN]
... WHERE column1 operator [:]altvalue
... [AND|OR column2 operator [:]altvalue]]
        .
        .
... [AND|OR columnN operator [:]altvalue] ]

VSAM Batch

DB-STORE REC recordname [FROM dataarea]

VSAM Online

DB-STORE REC recordname [FROM dataarea]
... [SYSID systemname] [DDN ddname]

Parameters:

Comments:

IDMS DB

Initialize all CALC keys; make all sets, in which the object record participates as a mandatory member, current of record type. If the location mode of the object record is VIA, establish currency for the set in which the record participates as a member.

IMS DB

• When a record is not obtained from the default I/O area, such as by DB-OBTAIN INTO, code FROM dataarea.

• When a record is not obtained from the default PCB, such as by DB-OBTAIN VIEW|PCB, code VIEW|PCB pcbname.

• When you store a new root, DB-STORE places the record according to its key field value. If a STORE for a dependent record provides qualification at each parent level, this qualification specifies the position of the new record. Otherwise, prior database positioning determines record placement. Thus, a DB-STORE for a dependent record should either
  • Specify qualification at each parent level, or

  • Ensure that the preceding database call executed for the database PCB accesses the desired parent.

Examples:

DB-STORE REC ORDER

DB-STORE REC RECORD-A

DB-STORE REC RECORD-A REC RECORD-B

DB-STORE REF RECORD-A WHERE FIELD-1 = VALUE-1 REC RECORD-B

DB-OBTAIN REF RECORD-A WHERE KEY-A = VALUE-A 
DB-STORE RECORD-B

DB-STORE REC D2TAB-REC
... PM_PART_NO PM_NEW_PART_NO ('23432')
... PM_COLOR (:WS-NEW-COLOR)

 DB-STORE REC D2INVEN-REC IN_PART_NO IN_UNIT_BASE_PRICE
 ... DB_OBTAIN REC D2MASTER-REC PM_PART_NO PM_UNIT_BASE_PRICE
 ... WHERE PM_PART_NO not= PM_NEW_PART_NO

DB-STORE REC ORDR-RECORD
IF OK-ON-REC
    SCREEN-MSG = 'ORDER ADDED TO FILE'
ELSE-IF IVD-ON-REC
    SCREEN-MSG = 'ORDER ALREADY EXISTS'

DB-SUBSCHEMA

Category:

Database call (see Database Calls)

Compatibility:

IDMS DB, IMS DB, SQL, VSAM batch, and VSAM online targets

Description:

Include the imported program subschema in your program. APS automatically does this for you when you specify your subschema in the Application Painter after importing the subschema.

Syntax:

DB-SUBSCHEMA subschemaname

Comment:

Specify a subschema for an APS program in either of the following ways.

• Recommended way Code the subschema name in the Application Painter.
• Code a DB-SUBSCHEMA call prior to the NTRY parameter.

DDIFILE Report (DB01)

Category:

APS-generated report (see Database Calls)

Description:

The DDIFILE Report describes the contents of the DDIFILE that contains your imported database definitions. Use this report to understand and evaluate the results of an import.

The report provides a section for each of the following items.

• DBDs
• PSBs
• Files
• Subschemas

Comment:

Produce the DDIFILE Report from the Documentation Facility.

Example:

REPORT CODE: DB01         APS DATA DESCRIPTION INTERFACE                           PAGE     1
                                   DBD REPORT                                 92/01/21  09:53

NAME                CREATED     UPDATED       REC NO       MESSAGE
---------------------------------------------------------------------------------------------

BE3ORDER            88/08/19    88/08/19      20           INCOMPLETE SET OF DDI NAMES FOUND
BE3ORDRX            88/08/19    88/08/19       3           NO DDI NAMES SPECIFIED
CORDPSB             89/10/12    00/00/00       3
CPTORDLD            89/11/02    00/00/00       3

 

REPORT CODE: DB01         APS DATA DESCRIPTION INTERFACE                           PAGE     4
                                FILE REPORT                                   92/01/21  09:53

NAME                CREATED     UPDATED       REC NO       MESSAGE
---------------------------------------------------------------------------------------------

CUSTMAST-REC        90/08/13    90/08/15      5
CUSTORDR-REC        90/08/13    90/08/15      5
 
 

REPORT CODE: DB01         APS DATA DESCRIPTION INTERFACE                           PAGE     5
                                SUBSCHEMA REPORT                              92/01/21  09:53

NAME                CREATED     UPDATED       REC NO       MESSAGE
---------------------------------------------------------------------------------------------

DMVINQ              90/05/10    90/12/07      1
DMVLST              90/05/10    90/12/07      3
 
 
***********   FINAL TOTALS   ***********
           TOTAL NUMBER OF DBDS              18
           TOTAL NUMBER OF DBD RECS         530
           TOTAL NUMBER OF PSBS              45
           TOTAL NUMBER OF PSB RECS          93
           TOTAL NUMBER OF FILES              8
           TOTAL NUMBER OF FILE RECS         30
           TOTAL NUMBER OF SUBSCHS           10
           TOTAL NUMBER OF SUBSCH RECS       21
           TOTAL NUMBER OF ENTITIES          63
           TOTAL NUMBER OF RECORDS          623

DDI Statements

Compatibility:

IMS and VSAM targets

Category:

Importer feature

Description:

Identify IMS database segments and VSAM files and their corresponding COBOL Syntax

DDI statements are comprised of the literal *DDI followed by a statement type and its applicable parameter parameters. The statement type identifies what database or file component to import. For example, database, record or field. Code DDI statements for any environment as follows:

IMS DB

The DBD statement corresponds to the DBD statement:

*DDI DBD NAME=dbname

The REC statement corresponds to the SEGM statement/copylib:

*DDI REC NAME=cpylibrec|[new-COBOL-recordname],
*DDI     SEG=segname, [COPY=membername|[new-copylibname]],
*DDI     [GEN01=Y|N]

The FLD statement corresponds to the FIELD and XDFLD statement/copylib field:

*DDI FLD NAME=cpylibfldname, IMSNAME=fldname,
*DDI     [PIC=cpylibpic]

The PSB statement corresponds to the PSB name:

*DDI PSB NAME=PSBname

The PCB statement is a positional, or placeholder statement. It corresponds to the PCB for which you are assigning an additional set of names:

*DDI PCB

VSAM DB

The VSM statement corresponds to the VSAM file external ddname:

*DDI VSM DDN=extddname, TYPE=K|E|R, VSPREFIX=fileprefix,
         [CYL|TRK|REC(size)], CISZ(cntlintrvalsize),
         VOL(volname), CAT=catname, [idcamsparms]

The REC statement corresponds to the copylib record name and copylib file name:

*DDI REC NAME=recname, SHORT=shrtrecname, COPY=membername,
         SOURCE=P|C|, MAXLEN=maxreclen, AVGLEN=avgreclen

The IDX statement is for a keyed file. It corresponds to copylib key field name and copylib file name:

*DDI IDX NAME=cpylibreckeyfldname, [ALIAS=redefinefld],
         TYPE=P|U|D, KEYLEN=keyfldlen, OFFSET=position,
         DDN=indxddname, PIC=number,[idcamsparms]

The SUB statement identifies the copylib record name(s) used by your APS program, record processing, batch options, and VSAM file external ddname:

*DDI SUB NAME=subschemaname, RECORD=recname,
         PROCOPT=A|G|I|D|R, [ACCESS=options], [BLOCK=0],
         [LABEL=STANDARD], [ASSIGN=extddname]

Parameters:

Comments:

IMS DB/DC

• When APS generates DDI symbols, it converts special characters that appear in IMS data names follows:
  • $ converts to an X
  • # converts to an Y
  • @ converts to a Z

• To access the index database itself, define the index DBD to the APS Generator, and include PCBs for it in PSBs defined to the APS Generator.

• If a PSB contains multiple PCBs for the database, use the VIEW or PCB parameter when you code the database macro to ensure that the correct PCB is used for the generated call.

• Select option 3, Generate DDISYMB symbols from DDIFILE, only if you want to regenerate DDI symbols that have been previously generated by following the procedures above.

Examples:

DBD    NAME=DBD1 etc.
SEGM   NAME=S1 etc.
FIELD  NAME=S1FLD etc.
SEGM   NAME=S2 etc.
FIELD  NAME=S2FLD etc.
 
Copylib file (S1)
01  SALES-REC.
    05  REGION-FLD          PIC 9(03).
   .
   .
Copylib file (S2)
01  CUST-REC.
    05  LOCATION-FLD        PIC X(30).
   .
   .

KYWD 12-+----20---+----30---+----40---+----50---+-
*DDI DBD NAME=DBD1
*DDI REC NAME=SALES-REC,SEG=S1,COPY=S1,
*DDI     GEN01=Y
*DDI FLD NAME=REGION-FLD,IMSNAME=S1FLD,PIC=9(03)
*DDI REC NAME=CUST-REC,SEG=S2,COPY=S2,
*DDI     GEN01=Y
*DDI FLD NAME=LOCATION-FLD,IMSNAME=S2FLD,PIC=X(30)

DBD     NAME=DEDBASE,ACCESS=DEDB,RMNAME=DEDBRAND
AREA    DEVICE=3380,SIZE=1024,UOW=(20,5),ROOT=(40,10),DD1=AREA1
AREA    DEVICE=3380,SIZE=1024,UOW=(20,5),ROOT=(40,10),DD1=AREA2
AREA    DEVICE=3380,SIZE=1024,UOW=(20,5),ROOT=(40,10),DD1=AREA3
SEGM    NAME=CUST,PARENT=0,BYTES=(80,80)
FIELD   START=03,BYTES=06,TYPE=C,NAME=(ACCTNO,SEQ,U)
FIELD   START=09,BYTES=09,TYPE=C,NAME=SSA
FIELD   START=18,BYTES=30,TYPE=C,NAME=NAME
FIELD   START=48,BYTES=30,TYPE=C,NAME=ADDRESS
SEGM    NAME=SUMM,PARENT=CUST,BYTES=(30,30),TYPE=SEQ
FIELD   START=03,BYTES=10,TYPE=C,NAME=ACTION
FIELD   START=13,BYTES=08,TYPE=C,NAME=AMOUNT
FIELD   START=21,BYTES=10,TYPE=C,NAME=TELLER
SEGM    NAME=TRAN,PARENT=CUST,BYTES=(50,50),TYPE=DIR,      X
        SSPTR=8
FIELD   START=03,BYTES=06,TYPE=C,NAME=(TRANDATE,SEQ)
FIELD   START=09,BYTES=06,TYPE=C,NAME=TRANAMT
FIELD   START=15,BYTES=15,TYPE=C,NAME=TYPE
FIELD   START=30,BYTES=08,TYPE=C,NAME=BALANCE
SEGM    NAME=CHARGE,PARENT=TRAN,BYTES=(30,30),TYPE=DIR,SSPTR=5
FIELD   START=03,BYTES=06,TYPE=C,NAME=DATE
FIELD   START=09,BYTES=06,TYPE=C,NAME=SERVCHAR
FIELD   START=15,BYTES=10,TYPE=C,NAME=TYPECHAR
DBDGEN
FINISH
END

*DDI DBD NAME=DEDBASE
*DDI REC NAME=CUSTOMER-RECORD,SEG=CUST,COPY=CUST
*DDI FLD NAME=CUSTOMER-ACCT-NO,IMSNAME=ACCTNO
*DDI FLD NAME=CUSTOMER-SSA,IMSNAME=SSA
*DDI FLD NAME=CUSTOMER-ADDRESS,IMSNAME=ADDRESS
*DDI REC NAME=SUMMARY-RECORD,SEG=SUMM,COPY=SUMM
*DDI FLD NAME=SUMMARY-ACTION,IMSNAME=ACTION
*DDI FLD NAME=SUMMARY-AMOUNT,IMSNAME=AMOUNT
*DDI FLD NAME=SUMMARY-TELLER,IMSNAME=TELLER
*DDI REC NAME=TRANSACTION-RECORD,SEG=TRAN,COPY=TRAN
*DDI FLD NAME=TRANSACTION-TRANDATE,IMSNAME=TRANDATE
*DDI FLD NAME=TRANSACTION-AMOUNT,IMSNAME=TRANAMT
*DDI FLD NAME=TRANSACTION-TYPE,IMSNAME=TYPE
*DDI FLD NAME=TRANSACTION-BALANCE,IMSNAME=BALANCE
*DDI REC NAME=CHARGE-RECORD,SEG=CHARGE,COPY=CHARGE
*DDI FLD NAME=CHARGE-DATE,IMSNAME=DATE
*DDI FLD NAME=CHARGE-SERVCHAR,IMSNAME=SERVCHAR
*DDI FLD NAME=CHARGE-TYPECHAR,IMSNAME=TYPECHAR
 
DBD     NAME=DEDB1,ACCESS=DEDB,
        RMNAME=(DBFHD040)
AREA    DD1=DEDB1DD,DEVICE=3380,SIZE=1024,
        ROOT=(10,5),UOW=(15,10)
SEGM    NAME=A,BYTES=(48,27),PARENT=0
FIELD   NAME=(A1,SEQ,U),BYTES=10,START=3,TYPE=C
SEGM    NAME=B,BYTES=(24,11),PARENT=((A,SNGL)),TYPE=DIR,SSPTR=5
FIELD   NAME=(B1,SEQ,U),BYTES=5,START=3,TYPE=C
FIELD   NAME=B2,BYTES=5,START=10,TYPE=C
SEGM    NAME=C,BYTES=(34,32),PARENT=((B,DBLE)),RULES=(,HERE),
        TYPE=DIR
FIELD   NAME=(C1,SEQ,U),BYTES=20,START=3,TYPE=C
SEGM    NAME=D,BYTES=(52,33),PARENT=((A,DBLE)),TYPE=DIR,SSPTR=3
FIELD   NAME=(D1,SEQ,U),BYTES=2,START=3,TYPE=C
SEGM    NAME=E,BYTES=(52,33),PARENT=((A,DBLE)),RULES=(,FIRST),
        TYPE=DIR
FIELD   NAME=(E1,SEQ,U),BYTES=2,START=3,TYPE=C
DBDGEN
FINISH
END
 
DDI *DDI DBD NAME=DEDB1
 
DBD     NAME=MSDB1,ACCESS=MSDB
DATASET REL=NO
SEGM    NAME=A,BYTES=4
FIELD   NAME=(A1,SEQ,U),BYTES=1,START=1,TYPE=X
DBDGEN
FINISH
END
 
*DDI DBD NAME=MSDB1
 
PSB
PCB   TYPE=DB,DBDNAME=DEDB1,PROCOPT=A,KEYLEN=35
SENSEG NAME=A,PARENT=0
SENSEG NAME=B,PARENT=A,SSPTR=((1,R),(2,U),(5))
SENSEG NAME=C,PARENT=B
PCB    TYPE=DB,DBDNAME=DEDBASE,PROCOPT=A,KEYLEN=12
SENSEG NAME=CUST,PARENT=0
SENSEG NAME=SUMM,PARENT=CUST
SENSEG NAME=TRAN,PARENT=CUST
PCB    TYPE=DB,DBDNAME=MSDB1,PROCOPT=A,KEYLEN=1
SENSEG NAME=A,PARENT=0
PSBGEN PSBNAME=FASTPATH,LANG=COBOL
END

KYWD 12-+----20---+----30---+----40---+----50---+---
*DDI VSM DDN=EMPLOYEE
*DDI       TYPE=K,VSPREFIX=VQAC6550.APS17X,
*DDI       TRK(100 10),CISZ(8192),VOL(SAGE03),
*DDI       REPLICATE,FSPC(15 15),SHR(1 3),NOIMBED
*DDI REC NAME=EMPLOYEE-RECORD,SHORT=EMPL,
*DDI       COPY=EMPLOYEE,SOURCE=P,
*DDI       MAXLEN=56
*DDI IDX NAME=EMPL-EMP-NUM,TYPE=P,KEYLEN=6,OFFSET=0,
*DDI       DDN=EMPLOYEE,TRK(5 5),VOL(SAGE03)
*DDI IDX NAME=EMPL-SOURCE-CODE,TYPE=D,
*DDI       KEYLEN=6,OFFSET=30,DDN=EMPLOYE1,
*DDI       TRK(3 3),VOL(SAGE03),NOIMBED
*DDI IDX NAME=EMPL-SALARY,TYPE=D,
*DDI       KEYLEN=4,OFFSET=36,DDN=EMPLOYEZ,
*DDI       PIC=9(7)COMP-3,TRK(3 3),VOL(SAGE03)
*DDI SUB NAME=SAMPPGM,RECORD=EMPLOYEE-RECORD,PROCOPT=A,
*DDI       LABEL=STANDARD,BLOCK=200,ASSIGN=EMPLOYEE

% * CICS RECORDS ARE REDEFINED FOR WORKING-STORAGE.
% * MVS  RECORDS ARE NOT REDEFINED;  ARE PLACED DIRECTLY UNDER FD.
% IF &APS-MDC = "CICS-TP"
    &VSSUF = "  REDEFINES ORDER-RECORD"
% ELSE
    &VSSUF = ""
01  ORDER-RECORD.
    05  ORDER-KEY                   PIC X(05).
    05  ORDER-RECORD-TYPE           PIC X(01).
    05  ORDER-CUST-NUMBER           PIC X(07).
    05  ORDER-PART-NUMBER           PIC X(07).
    05  ORDER-QUANTITY-ORDERED      PIC 9(05).
    05  ORDER-QUANTITY-TYPE         PIC X(10).
    05  ORDER-ORDER-AMOUNT          PIC 9(05)V99.
    05  ORDER-ORDER-STATUS          PIC X(04).
01  ORDER-PART-RECORD &VSSUF.
    05  FILLER                      PIC X(06).
    05  PART-NAME                   PIC X(05).
    05  PART-DESCRIPTION            PIC X(25).
    05  PART-SUPPLIER-NBR           PIC X(07).
    05  PART-SUPPLIER-NAME          PIC X(25).
01  ORDER-DELV-RECORD &VSSUF.
    05  FILLER                      PIC X(06).
    05  DELV-CONTACT-NAME           PIC X(30).
    05  DELV-CONTACT-PHONE          PIC X(12).
    05  DELV-ADDRESS                PIC X(35).
    05  DELV-SPECIAL-INSTRUCTIONS   PIC X(50).

KYWD 12-+----20---+----30---+----40---+----50---+---
*DDI VSM DDN=ORDER
*DDI REC NAME=ORDER-RECORD,SHORT=ORDER,COPY=ORDER,SOURCE=P,
*DDI     MAXLEN=133,AVGLEN=46
*DDI IDX NAME=ORDER-KEY,TYPE=P,KEYLEN=5,OFFSET=0,DDN=ORDER
*DDI REC NAME=ORDER-PART-RECORD,SHORT=PART,MAXLEN=68
*DDI REC NAME=ORDER-DELV-RECORD,SHORT=DELV,MAXLEN=133
*DDI SUB NAME=ORDERSS,
*DDI     RECORD=ORDER-RECORD,PROCOPT=A,
*DDI     LABEL=STANDARD,BLOCK=0,ASSIGN=ORDER

*DDI VSM DDN=PERSON
*DDI     TYPE=K,VSPREFIX=VAPS6550,
*DDI     CISZ(4096),VOL(PDVL02),TRK(5 5)
*DDI REC NAME=PERSONNEL-RECORD,SHORT=PERSONEL,
*DDI     COPY=PERSONEL,SOURCE=P,MAXLEN=80,PREFIX=PER
*DDI IDX NAME=SSA,ALIAS=SSA-X,TYPE=P,KEYLEN=9,
*DDI     OFFSET=0,DDN=PERSON,
*DDI     TRK(5,5),VOL(PDVL02)
*DDI IDX NAME=LAST-NAME,TYPE=D,KEYLEN=15,
*DDI     OFFSET=9,DDN=PERSON1,
*DDI     TRK(5,5),REUSE,VOL(PDVL02)
*DDI IDX NAME=TITLE,TYPE=D,KEYLEN=15,
*DDI     OFFSET=24,DDN=PERSON2,
*DDI     TRK(5,5),REUSE,VOL(PDVL02)
*DDI SUB NAME=SAMPLE,RECORD=PERSONNEL-RECORD,
*DDI     PROCOPT=A

                                                03590000
DELETE VAPS6550.PERSON.CLUSTER                  01550000
           CLUSTER                              01610000
           PURGE                                01620000
                                                01640000
IF LASTCC = 8                                   01650000
THEN                                            01660000
       SET LASTCC = 00                          01670000
                                                01680000
DEFINE CLUSTER                                  01690000
           (INDEXED                             01760000
           NAME (VAPS6550.PERSON.CLUSTER)       01820000
           UNIQUE)                              01980000
                                                01990000
           DATA                                 02000000
           (NAME (VAPS6550.PERSON.DATA)         02010000
           TRK(5,5)                             02030000
           VOL(PDVL02)                          02080000
           RECSZ (80 80)                        02130000
           CISZ (4096)                          02170000
           KEYS (9 0)                           02240000
           SHR (3 3))                           02320000
                                                02340000
           INDEX                                02350000
           (NAME (VAPS6550.PERSON.INDEX)        02360000
           TRK(5,5)                             02440000
           VOL(PDVL02)                          02460000
           CISZ (1024)                          02550000
           SHR (3 3)                            02660000
           )                                    02690000
                                                02710000
       IF LASTCC < 5                            02720000
       THEN                                     02730000
       REPRO                                    02740000
           INFILE (DD1)                         02750000
           ODS (VAPS6550.PERSON.CLUSTER)        02760000
                                                02770000
       DEF AIX                                  02890000
           (NAME (VAPS6550.PERSON1.AIX)         02990000
           RELATE (VAPS6550.PERSON.CLUSTER)     03000000
           REUSE                                03040000
           TRK(5,5)                             03110000
           VOL(PDVL02)                          03180000
           RECSZ (256 512)                      03220000
           CISZ (1024)                          03260000
           KEYS ( 15 9)                         03290000
           NONUNIQUEKEY                         03340000
           UPGRADE)                             03380000
           DATA                                 03390000
           (NAME(VAPS6550.PERSON1.DATA))        03400000
           INDEX                                03410000
           (NAME(VAPS6550.PERSON1.INDEX))       03420000
                                                03430000
IF LASTCC < 5                                   03440000
       THEN                                     03450000
       BLDINDEX                                 03460000
           IDS (VAPS6550.PERSON.CLUSTER)        03470000
           ODS (VAPS6550.PERSON1.AIX)           03480000
                                                03490000
       IF LASTCC < 5                            03500000
       THEN                                     03510000
       DEF PATH                                 03520000
           (NAME (VAPS6550.PERSON1.PATH)        03530000
           PENT (VAPS6550.PERSON1.AIX)          03540000
           UPDATE)                              03550000
       DEF AIX                                  02890000
           (NAME (VAPS6550.PERSON2.AIX)         02990000
           RELATE (VAPS6550.PERSON.CLUSTER)     03000000
           REUSE                                03040000
           TRK(5,5)                             03110000
           VOL(PDVL02)                          03180000
           RECSZ (256 512)                      03220000
           CISZ (1024)                          03260000
           KEYS ( 15 24)                        03290000
           NONUNIQUEKEY                         03340000
           UPGRADE)                             03380000
           DATA                                 03390000
           (NAME(VAPS6550.PERSON2.DATA))        03400000
           INDEX                                03410000
           (NAME(VAPS6550.PERSON2.INDEX))       03420000
                                                03430000
IF LASTCC < 5                                   03440000
       THEN                                     03450000
       BLDINDEX                                 03460000
           IDS (VAPS6550.PERSON.CLUSTER)        03470000
           ODS (VAPS6550.PERSON2.AIX)           03480000
                                                03490000
       IF LASTCC < 5                            03500000
       THEN                                     03510000
       DEF PATH                                 03520000
           (NAME (VAPS6550.PERSON2.PATH)        03530000
           PENT (VAPS6550.PERSON2.AIX)          03540000
           UPDATE)                              03550000

DDISYMB Flags

Compatibility:

SQL target

Description:

You can use special DDISYMB flags to suppress or modify DCLGEN copybook generation. After you generate your subschema and DDISYMB file, insert these override flags into the DDISYMB file.

Syntax:

Flag 1, suppress inclusion of the APS-generated DCLGEN copybook:

&D2-INCLUDED-COPYLIB-copybookname = "YES"|"NO"

Flag 2, specify user override of APS indicator structure generation:

&D2-INCLUDED-IV-copybookname = "YES"|"NO"

Flag 3, specify indicator variable prefix override, overriding the APS default prefix IND:

&D2-copybookname-IV-PREFIX = "prefixvalue"

Flag 4, specify indicator structure, group-level, override name:

&D2-copybookname-IV-01-NAME = "indicatorvariablename"

Flag 5, specify host structure, group-level override name:

&D2-copybookname-HOST-01-NAME = "01levelname"

Flag 6, generate a value for &D2-copybookname-HOST-01-NAME:

&D2-GLOBAL-DCLGEN-NAME = "YES"|"NO"

Flag 7, override use and generation of the default IND-cursorname structure:

&D2-USE-CURSOR-IND = "YES"|"NO"

Comments:

• Code Flag 1 to:
  • Include your own DB2 host variable copybook.

  • Suppress inclusion of the corresponding APS-generated DCLGEN copybook named by copybookname.

• Code Flag 2 to:
  • Include your own indicator variable structure in the copybook or DB2 DDI symbols for that table.

  • Suppress generation of the APS host indicator variable structure for the table named by copybookname.

• For Flag 2, the APS-generated host indicator variable structure follows the format:

  01  IND-copybookname-REC
      05 IND-colname1
      05 IND-colname2

  If you override the host indicator variable structure generated by APS, you still must conform to the format above. However, you can override the IND prefix with one of your own. You can specify one prefix for each host indicator variable structure. The prefix you create must be supplied to APS via the variable &D2-copybookname-IV-prefix.

  Similarly, you may also override the 01-level name of the host indicator variable structure. If the 01-level name you choose is not in the APS format shown above, supply it to APS via the variable &D2-copybookname-IV-01-name. These two user flags are described below.

• For Flag 3:
  • Code it to substitute a value for the default prefix, IND, on all indicator variables for a table.

  • Include this flag to supply your own indicator variable structure and if the variable names have a prefix other than IND.

  • The prefix you enter can include up to 11 characters.

  • Follow the naming convention of prefix-columname for indicator variable names, where prefix is either IND or a value you specify in the prefix override. For example, for a table represented by a copybook named TAB2, the entry:

    % &D2-TAB2-IV-PREFIX = "TAB2-IV"

    Yields the following indicator variable structure.

    01  TAB2-IV-TAB2-REC.
        05  TAB2-IV-colname1
        05  TAB2-IV-colname2
        05  TAB2-IV-colname3
          .
          .
        05  TAB2-IV-colnameN

  • If you do not supply this variable, the APS uses the structure generated for each cursor, cursorname-IND-variable, for cursor processing.

• For Flag 4:
  • Code it to create your own 01-level name for the indicator variable structure. Indicatorvariablename replaces the APS-generated 01-level name. The default for the 01-level name is prefixcolumnamerec.

  • Include this flag to supply an override indicator variable structure when the 01-level name does not conform to the APS naming convention.

  • The maximum length of indicatorvariablename is 30 characters.

  • Indicator variable names must follow the naming convention of prefix-columname, in which prefix is either IND or a value you specify in &D2-copybookname-IV-PREFIX. For example, a table represented by a copybook named TAB2, the entry:

    % &D2-TAB2-IV-01-NAME = "TAB2-IND-VAR"

    Yields the following indicator variable structure:

    01  TAB2-IND-VAR.
        05  IND-colname1
        05  IND-colname2
        05  IND-colname3
       .
       .
        05  IND-colnameN

  • If you do not supply this variable, the APS uses the structure generated for each cursor, cursorname-IND-variable, for cursor processing.

• Code Flag 5 to change the default host structure after the DCLGEN process creates it. 01levelname replaces the APS-generated 01-level name, copylibnamerec. APS uses your host 01-level name when it qualifies host variables during SQL generation.

• You can use Flag 6, rather than Flag 5, to generate a name for all your tables. In the APS CNTL file APDB2IN, set the flag &D2-GLOBAL-DCLGEN-NAME to yes. APS generates a value for &D2-copybookname-HOST-01-NAME, using the IBM DCLGEN convention of DCLtablename. Defining this flag in APDB2IN overrides manually-coded definitions in all applications.

• Use Flag 7 to override the default indicator variable structure, IND-cursorname with the structure IND-tablerec. APS generates the default indicator variable structure, as follows:

  01   TABLE-REC.
       05  COL1                PIC X(4).
       05  COL2                PIC X(8).
  01   IND-TABLE-REC.
       05  IND-COL1            PIC S9(4) COMP.
  01   IND-CURSOR1.
       05  IND-COL1            PIC S9(4) COMP.
       .
       .
       .
       DB-FETCH CURSOR CURSOR1
       IF OK-ON-REC
           IF IND-COL1 OF IND-CURSOR1 = +0
               MAP-COL1 = COL1 in TABLE-REC

  ---

  Note: Using the host indicator variable structure can simplify your code because the one indicator variable structure can be used repeatedly. In nested processes, however, the host indicator variables are overwritten by each successive nesting level.

  ---

Examples:

% &D2-copybookname-IV-PREFIX = "TAB2-IV"

% &D2-copybookname-IV-01-NAME = "USER-IND-VAR-NAME"

% &D2-D2MASTER-HOST-01-NAME = "XYZ-D2MASTER-STRUCT"
****************************************************
*  COBOL DECLARATION FOR TABLE D2MASTER
*  01-LEVEL NAME POST-PROCESSED
****************************************************
01  XYZ-D2MASTER-STRUCT.
  10  PM-PART-NO                      PIC X(8).
  10  PM-NEW-PART-NO                  PIC X(8).
  10  PM-OLD-PART-NO                  PIC X(8).
  10  PM-PART-SHORT-DESC              PIC X(13).
  10  PM-UNITS                        PIC 9(5).
  10  PM-UNIT-BASE-PRICE              PIC 9(5).
  10  PM-DIMENSIONS                   PIC X(8).
  10  PM-COLOR                        PIC X(8).

EXEC SQL SELECT ...
INTO XYZ-D2MASTER-STRUCT.PM-PART-NO,
XYZ-D2MASTER-STRUCT.PM-NEW-PART-NO,
        .
        .
        .
    XYZ-D2MASTER-STRUCT.PM-COLOR,
FROM ...
WHERE ...
END-EXEC

EXEC SQL SELECT ...
INTO D2TAB-REC.PM-PART-NO,
    D2TAB-REC.PM-NEW-PART-NO,
        .
        .
        .
    D2TAB-REC.PM-COLOR,
FROM ...
WHERE ...
END-EXEC

DECL

Category:

Program Painter and Specification Editor parameter

Compatibility:

ISPF Dialog and ISPF prototyping batch programs; CICS and IMS DC programs without screens

Description:

Create Declarative Section statements only--not sections or paragraphs.

See also DPAR and USE BEFORE REPORTING for creating Declarative Section statements, paragraphs, and sections.

Syntax:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 DECL   declarativestatements

Comments:

• We recommend that you code declaratives at the end of your program, because APS generates the END DECLARATIVES statement when either:
  • It encounters another keyword in the KYWD column.
  • The Declaratives Section is at the end of the program.

• Do not code the DECLARATIVE SECTION header or the END DECLARATIVES statement. APS generates these for you.

Example:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 DECL   declarative statement
        declarative statement

DECLARATIVES.
declarative statement
declarative statement
END DECLARATIVES

DLG-ISPEXEC

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Invoke ISPF services that use CALL ISPEXEC format.

Syntax:

DLG-ISPEXEC commandproceduresyntax

Parameters:

Comment:

Data field DLG-ISPEXEC-RC contains the return code after the call execution.

Examples:

DLG-ISPEXEC CONTROL SPLIT DISABLE
IF  DLG-ISPEXEC-RC = 8
    /* SPLIT SCREEN ALREADY DISABLED
    TRUE  SPLIT-SCREEN-DISABLED
ELSE-IF DLG-ISPEXEC-RC = 0
    /* SPLIT SCREEN DISABLED
    TRUE  SPLIT-SCREEN-DISABLED

DLG-ISPEXEC LIBDEF ISPMLIB DATASET ID('ABC.DEF.ISPMLIB')
IF  DLG-ISPEXEC-RC = 0
    /* OK
ELSE
    DISPLAY '??? LIBDEF ISPMLIB ERROR, RC = ' DLG-ISPEXEC-RC

DLG-ISPEXEC SELECT CMD(%ALOCFILE ALLOC)
IF  DLG-ISPEXEC-RC = 0
    /* OK
ELSE
    DISPLAY '??? ALOCFILE ERROR, RC = ' DLG-ISPEXEC-RC

DLG-ISREDIT

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Invoke ISREDIT services.

Syntax:

DLG-ISREDIT commandproceduresyntax

Parameter:

Comment:

Data field DLG-ISREDIT-RC contains the return code after call execution.

Example:

DLG-VDEFINE LASTLINE &APS-FULL
DLG-ISREDIT (LASTLINE) = LINENUM .ZLAST
IF  LASTLINE = 0
    /* NEW MEMBER
    TRUE  NEW-MEMBER

DLG-SETMSG

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Display a message on the next panel; predefine message text and attributes.

Syntax:

Format 1, SETMSG definition:

DLG-SETMSG
... [SHORT 'shortmessagetext']
... [LONG 'longmessagetext']
... [ALARM 'YES'|'NO']
... [HELP 'helppanelname']

Format 2, SETMSG definition for execution by Format 3:

DLG-SETMSG erroridentifier
... [SHORT 'shortmessagetext']
... [LONG 'longmessagetext']
... [ALARM 'YES'|'NO']
... [HELP 'helppanelname']

Format 3, SETMSG execution

DLG-SETMSG [erroridentifier|messageID]

Parameters:

Comments:

• If you use Format 2, include at least one of the keywords.
• Data field DLG-SETMSG-RC checks the return code after call execution.

Examples:

DLG-SETMSG INVALID-OPT
... SHORT 'INVALID OPTION'
... LONG  'ENTER ONE OF THE LISTED OPTIONS'
... ALARM 'YES'

IF  SCRA-OPTION = 'value'
    /* VALID CONDITION
ELSE
    DLG-SETMSG INVALID-OPT

DLG-VCOPY

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Copy data from a Dialog variable to a COBOL program variable and generate the Working-Storage entry for the COBOL variable, if the COBOL level is specified.

Syntax:

DLG-VCOPY [COBOLlevel] COBOLvariable
... [[FROM] dialogvariable]
... [PIC COBOLpicture]|LEN value
... [GENONLY]

Parameters:

Comments:

• Code FROM dialogvariable on the same line as COBOLvariable.

• Coding COBOLlevel generates COBOLvariable Working-Storage; otherwise, define the COBOL variable in Working-Storage.

• Data field DLG-VCOPY-RC contains the return code after call execution.

Examples:

DLG-VCOPY SCRA-ZUSER FROM ZUSER LEN 8

DLG-VCOPY 01 WS-LONG-ERROR-MESSAGE PIC X(78) FROM ZERRLM

DLG-VDEFINE

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Establish a link between a Dialog function pool variable and a COBOL program variable.

Syntax:

DLG-VDEFINE [COBOLlevel] COBOLvariable
... [[AS] dialogvariable]
... [PIC COBOLpicture]|LEN value
... [GENONLY]

Parameters:

Comments:

• Code AS dialogvariable on the same line as COBOLvariable.

• NTRY automatically links any panel variables to screen field names.

• Coding COBOLlevel generates COBOLvariable in Working-Storage; otherwise, define the COBOL variable in Working-Storage.

• Data field DLG-VDEFINE-RC checks the return code after call execution.

Example:

DLG-VDEFINE 01 WS-COMM-DATA PIC X(150) AS COMDATA

DLG-VDELETE

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Remove the Dialog variables, previously defined by VDEFINE, from the function pool.

Syntax:

DLG-VDELETE dialogvariable|*

Parameters:

Comments:

• Coding an asterisk deletes the variables according to the value of the control variable &DLG-AUTO-VARIABLE-VDELETE.

• Data field DLG-VDELETE-RC contains the return code after call execution.

Example:

DLG-VDEFINE 01 WS-COMM-DATA LEN(150)
... AS COMDATA
DLG-VDELETE COMDATA

DLG-VREPLACE

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Move data from a COBOL program variable to an ISPF function pool variable.

Syntax:

DLG-VREPLACE [COBOLlevel] COBOLvariable
... [[INTO] dialogvariable]
... [PIC COBOLpicture]|LEN value
... [GENONLY]

Parameters:

Comments:

• Code INTO dialogvariable on the same line as COBOLvariable.

• Coding COBOLlevel generates COBOLvariable in Working-Storage; otherwise, define the COBOL variable in Working-Storage.

Example:

DLG-VREPLACE 01 WS-PF01-HELP PIC X(04) VALUE 'HELP' INTO ZPF01

DLG-VRESET

Category:

Data communication call (see Data Communication Calls)

Compatibility:

ISPF Dialog target

Description:

Reset all program function pool variables and delete the links between COBOL variables and Dialog variables within the function pool.

Syntax:

DLG-VRESET

Comment:

Data field DLG-VRESET-RC contains the return code after call execution.

DPAR

Category:

Program Painter and Specification Editor parameter (see Keywords)

Compatibility:

ISPF Dialog and ISPF prototyping programs; CICS and IMS DC batch programs and reports

Description:

Create a Declarative Section or section paragraph--not declarative statements.

See also DECL and USE BEFORE REPORTING for creating Declarative Section statements, paragraphs, and sections.

Syntax:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 DPAR   sectionname SECTION
        USE declarativesentence
[DPAR   paragraphname
            paragraphstatements ]

Parameters:

Comments:

• We recommend that you code declaratives at the end of your program, because APS generates the END DECLARATIVES statement when either:
  • It encounters another parameter in the KYWD column.
  • The Declaratives Section is at the end of the program.

• Do not code the DECLARATIVE SECTION header and the END DECLARATIVES statements. APS generates these for you.

Example:

-KYWD-   12-*----20---*----30---*----40---*----50---*----60---*----70-
 DPAR    DUMMY-FOOTER SECTION
         USE BEFORE REPORTING FOOTER-DUMMY
 DPAR    DUMMY-FOOTER-PARA
         MOVE TOTAL-DIFF TO TIME-TOTAL
         SUPPRESS PRINTING
 DPAR    TOTAL-FOOT-SECTION SECTION
         USE BEFORE REPORTING TOTAL-FOOT
         TOTAL-FOOT-PARA
         TIME-AVERAGE = TIME-TOTAL / AVERAGE-CNT
         CALL-PERCENTAGE = (HALF-HOUR-CALLS / AVERAGE-CNT)
         ... * 100
         MOVE HALF-HOUR-CALLS TO HOLD-CALLS
         ADD HOLD-CALLS TO HALF-HOUR-CNT
         MOVE ZERO TO HALF-HOUR-CALLS
 DPAR    CONTROL-FOOTING-FINAL SECTION
         USE BEFORE REPORTING CNTL-FT-GP
 DPAR    CONTROL-FOOTING-FINAL-PARA
         IF SYSIN-TRACKER NOT = 'CTSALL'
             SUPPRESS PRINTING
         ELSE
             FINAL-PERCENTAGE = (HALF-HOUR-CNT / FINAL-PROB-CNT * 100)

 DECLARATIVES.
 
 DUMMY-FOOTER SECTION.
     USE BEFORE REPORTING FOOTER-DUMMY
 DUMMY-FOOTER-PARA.
     MOVE TOTAL-DIFF TO TIME-TOTAL
     SUPPRESS PRINTING
 TOTAL-FOOT-SECTION SECTION.
     USE BEFORE REPORTING TOTAL-FOOT
     $TOTAL-FOOT-PARA
     TIME-AVERAGE = TIME-TOTAL / AVERAGE-CNT
     CALL-PERCENTAGE = (HALF-HOUR-CALLS / AVERAGE-CNT)
     ... * 100
     MOVE HALF-HOUR-CALLS TO HOLD-CALLS
     ADD HOLD-CALLS TO HALF-HOUR-CNT
     MOVE ZERO TO HALF-HOUR-CALLS
 CONTROL-FOOTING-FINAL SECTION.
     USE BEFORE REPORTING CNTL-FT-GP
 CONTROL-FOOTING-FINAL-PARA.
     IF SYSIN-TRACKER NOT = 'CTSALL'
         SUPPRESS PRINTING
     ELSE
         FINAL-PERCENTAGE = (HALF-HOUR-CNT / FINAL-PROB-CNT * 100)
 
 END DECLARATIVES

DS

Category:

Program Painter and Specification Editor parameter (see Keywords)

Description:

In your program, include a data structure created in the Data Structure Painter and in that format.

Syntax:

-KYWD-  12-*----20---*----30---*----40---*----50---*----60
 DS[nn]  datastructurename

Comments:

• Nn is the beginning level number for the data structure entity. This is useful when concatenating multiple data structure entities in the same program. Nn overrides the default 01-level created with the REC parameter in the Data Structure Painter.

• The preceding section parameter 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)

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