Previous Topic: OverviewNext Topic: z/VSE File Characteristics Program


Control Statements

Control statements are available that enable you to specify default parameters for CA ADS Batch application execution. At runtime, you can override any of these parameters by using control statements, as described in Runtime Considerations.

The control statements must follow the SYSTEM statement in the ADSOBSYS job stream.

Note: The ADSOBSYS parameters shown in this appendix affect only the CA ADS Batch runtime environment. They do not affect the CA ADS online runtime environment. For example, the STATISTICS parameters specifies how statistics are to be collected only for an CA ADS Batch application. You specify the CA ADS online environment at system generation in the ADSO statement.

Syntax for the CA ADS Batch control statements is shown below:

►►────┬──────────────────────────────────────────────────────┬────────────────►
      └─ PRImary pool ─┬──────┬─ primary-pool-size ──── . ───┘
                       ├─ IS ─┤
                       └─ = ──┘

 ►────┬──────────────────────────────────────────────────────────┬────────────►
      └─ SECondary pool ─┬──────┬─ secondary-pool-size ───── . ──┘
                         ├─ IS ─┤
                         └─ = ──┘

 ►────┬───────────────────────────────────────────────────────────────────────►
      └┬─ DIAlog ─┬─ STAtistics ──┬─ OFF ─────────────────────────────────────
       └─ DLG ────┘               └─ ON ─┬─────────────┬──────────────────────
                                         ├─ ALL ───────┤
                                         └─ SELected ──┘
 ►──────────────────────────────────────────────────────────────────────────┬─►
  ─────────────────────────────────────────────────────────────────┬─── . ──┘
  ──┬─────────────────────────────────────────────────────────────┬┘
    └─┬─ CHEckpoint ─┬─ interval ─┬──────┬─ checkpoint-interval ──┘
      └─ CKPT ───────┘            ├─ IS ─┤
                                  └─ = ──┘

 ►────┬────────────────────────────────────────────────────────────┬──────────►
      │                               ┌──────────────┐             │
      └─ ROUting codes ─┬───────┬─ ( ─▼─ route-code ─┴─ ) ──── . ──┘
                        ├─ ARE ─┤
                        ├─ IS ──┤
                        └─ = ───┘

 ►────┬────────────────────────────────────────────────────────────────────┬──►
      │                                  ┌───────────────────┐             │
      └─ DEScriptor codes ─┬───────┬─ ( ─▼─ descriptor-code ─┴─ ) ──── . ──┘
                           ├─ ARE ─┤
                           ├─ IS ──┤
                           └─ = ───┘
 ►───┬──────────────────────────────────────────────────────────────────────┬─►
     └┬─ DIAlog ─┬─ has ─┬─ MAXERR ────────┬─count of maximum-errors ─── . ─┘
      └─ DLG ────┘       └─ MAXimum ERRor ─┘

 ►────┬────────────────────────────────────────────────────────┬──────────────►
      └─ OPErator SHUtdown ─┬───────┬─┬─┬─ ENAbled ─┬─┬─── . ──┘
                            ├─ IS ──┤ │ └─ YES ─────┘ │
                            └─ = ───┘ └─┬─ DISabled ─┬┘
                                        └─ NO ───────┘

 ►───┬─────────────────────────────────────────────────────┬──────────────────►
     └─ MAXimum LINks ──┬──────┬── maximum-links ──── . ───┘
                        ├─ IS ─┤
                        └─ = ──┘
 ►───┬────────────────────────────────────────────────────────────────┬───────►
     └─ COMmit when files open causes ──┬──────┬───┬─ NOACTion ─┬─ . ─┘
                                        ├─ IS ─┤   ├─ WARNing ──┤
                                        └─ =  ─┘   └─ ABEND ────┘
 ►─┬────────────────────────────────────────────────────────────────────┬─────►
   │       ┌──────────────────────────────────────────────────┐         │
   └─ LOG ─▼─┬─── FILE1 ──┬──────┬──┬─ ADSLOGA ◄ ──────┬────┬─┴──── . ──┘
             │            ├─ IS ─┤  └─ run-time-label ─┘    │
             │            └─ = ──┘                          │
             ├─── COUNT1 ─┬──────┬─ file1-maximum-records ──┤
             │            ├─ IS ─┤                          │
             │            └─ = ──┘                          │
             ├─── FILE2 ──┬──────┬─ run-time-label ─────────┤
             │            ├─ IS ─┤                          │
             │            └─ = ──┘                          │
             ├─── COUNT2 ─┬──────┬─ file2-maximum-records ──┤
             │            ├─ IS ─┤                          │
             │            └─ = ──┘                          │
             ├─┬─ ARChive ────┬─────────────────────────────┤
             │ └─ NOARChive ◄ ┘                             │
             ├─┬─ COMpress ───┬─────────────────────────────┤
             │ └─ NOCOMpress ─┘                             │
             └─┬─ PREfix ─────┬─────────────────────────────┘
               └─ NOPREfix ───┘
 ►─┬─────────────────────────────────────────────────────────────────────┬────►
   └─┬─ SUBSCHEMA-LR-CTRL ─┬─┬────────┬─┬──────┬─ lrc-block-size ─── . ──┘
     └─ LRF ───────────────┘ └─ SIZe ─┘ ├─ IS ─┤
                                        └─ = ──┘

 ►─┬───────────────────────────────────────────────────────────────┬──────────►◄
   └─ DC ─┬──────────────────────┬─┬──────┬─ maximum-data ──── . ──┘
          └─ PACket ──┬────────┬─┘ ├─ IS ─┤
                      └─ SIZe ─┘   └─ = ──┘
PRIMARY POOL IS primary-pool-size

Specifies the size, in bytes, of the primary buffer pool. Primary-pool-size is an integer in the range 0 through 2,147,483,647. The default is determined at system generation; the system generation default is 4,000.

Note: For more information about specifying primary pools, see the discussion of the ADSO statement in CA IDMS System Generation Guide.

SECONDARY POOL IS secondary-pool-size

Specifies the size, in bytes, of the secondary buffer pool. The secondary pool is allocated from the system storage pool when the primary buffer pool becomes full. Secondary-pool-size is an integer in the range 0 through 2,147,483,647. The default is determined at system generation; the system generation default is 2,000.

DIALOG STATISTICS OFF/ON

Specifies whether dialog statistics are to be collected during application execution.

OFF specifies that statistics are not to be collected.

ON specifies that statistics are to be collected.

The default is determined at system generation; the system generation default is OFF.

Parameters included in the ON clause are as follows.

ALL/SELECTED

Specifies whether dialog statistics are maintained for all dialogs or for only selected dialogs in an application. The default is determined at system generation.

Dialogs are selected at runtime through the DIALOG STATISTICS control statement.

CHECKPOINT INTERVAL IS checkpoint-interval

Specifies the frequency with which dialog statistics are to be written to the log file. Statistics are written to the log file once every time statistics are accumulated for the checkpoint-interval time. CA ADS Batch accumulates statistics every time a dialog issues a control command. The default checkpoint interval is determined at system generation; the system generation default is 200.

ROUTING CODES ARE (route-code)

(z/OS) specifies the OS operator-message routing codes, as described in the applicable operating system supervisor services and macro instructions. This parameter supplies the value of the ROUTCDE parameter for WTO (write-to-operator) macros issued by the system. Route-code is an integer in the range 1 through 16; the default is 11. Multiple routing codes must be separated by commas.

DESCRIPTOR CODES ARE (descriptor-code)

(z/OS ) specifies the z/OS operator-message description code, as described in the applicable operating system supervisor services and macro instructions. This parameter supplies the descriptor code to the DESC parameter for WTO (write-to-operator) macros issued by the system. Descriptor-code is an integer in the range 1 through 16; the default is 7.

DIALOG HAS MAXERR COUNT OF maximum-errors

Specifies the maximum number of error records that can be sent to the suspense file of any dialog. If this number is exceeded at runtime, the runtime system terminates the application. For example, if the maximum error count is 1, the runtime system terminates the application when the second error record is to be written. If the maximum error count is 0, the runtime system allows an unlimited number of error records to be sent to a suspense file. Maximum-errors is an integer in the range 0 through 32,767; the default is 0.

OPERATOR SHUTDOWN IS ENABLED/DISABLED

Specifies whether the operator can send a request to the runtime system to terminate an application. If operator shutdown is enabled, the runtime system begins application execution by issuing a WTOR (write-to-operator with reply) macro. At any time during application execution, the operator can issue a SHUTDOWN command, as described in Runtime Considerations.

The SHUTDOWN command causes the runtime system to terminate the application with an optional dump. If shutdown is disabled, the operator can terminate the application only by abnormally terminating the runtime system. The default specification is DISABLED.

MAXIMUM LINKS IS maximum-links

Specifies the maximum number of dialog levels that can be established by each CA ADS Batch application thread. Maximum-links is an integer in the range 0 through 32,767. The default is determined at system generation; the system generation default is 10.

COMMIT WHEN FILES OPEN CAUSES NOACTION/WARNING/ABEND

Specifies the action to be taken when a database commit is to be performed before all files used in the application have been closed, as follows:

LOG

Specify defaults for the log file. All LOG statement parameters are optional. The parameters are as follows.

FILE1 IS ADSLOGA/run-time-label

Specifies the runtime label (z/OS ddname, z/VSE filename) of the primary log file.

COUNT1 IS file1-maximum-records

Specifies the number of log records that are written to the primary log file before the file is considered full.

If file1-maximum-records is reached at runtime, the runtime system switches to the secondary log file or, if no secondary log file is allocated, wraps around to the beginning of the primary log file. If archiving is requested, the runtime system archives the primary log file to tape.

If 0 is specified, no predefined limit is placed on the number of records written to the primary log file. If space for a disk log file is exceeded at runtime, the runtime system abnormally terminates the application.

File1-maximum-records is an integer in the range 1 through 99999; the default is 0.

FILE2 IS run-time label

Specifies the runtime label of the secondary log file.

COUNT2 IS file2-maximum-records

Specifies the number of log records that are written to the secondary log file before the file is considered full.

If file2-maximum-records is reached at runtime, the runtime system switches back to the primary log file. If archiving is requested, the runtime system archives the secondary log file to tape.

If 0 is specified, no predefined limit is placed on the number of records written to the secondary log file. If space for a disk log file is exceeded at runtime, the runtime system abnormally terminates the application.

File2-maximum-records is an integer in the range 1 through 99999; the default is 0.

ARCHIVE/NOARCHIVE

(z/OS only) specifies whether log file archiving is to be performed at runtime when a log file is full. For more information about log file archiving, see Log Files. The default is NOARCHIVE.

COMPRESS/NOCOMPRESS

Specifies whether log records are compressed in the log file to save space at runtime. If neither COMPRESS nor NOCOMPRESS is specified, the runtime system uses the z/OS and z/VSE device-type assignment to determine whether to compress the records:

  • In z/OS, records are not compressed if the assignment is SYSOUT; otherwise, records are compressed.
  • In z/VSE, records are not compressed if the device type is PRINTER (as specified using ADSOBSYS or at runtime); otherwise, records are compressed.
PREFIX/NOPREFIX

Specifies whether a prefix is to precede each log record. Prefixes are required by the print log utility. If neither PREFIX nor NOPREFIX is specified, the runtime system uses the z/OS and z/VSE device-type assignment to determine whether to include a prefix:

  • In z/OS , a prefix is not included if the assignment is SYSOUT; otherwise, a prefix is included.
  • In z/VSE, a prefix is not included if the device type is PRINTER (as specified using ADSOBSYS or at runtime); otherwise, a prefix is included.
SUBSCHEMA-LR-CTRL SIZE IS lrc-block-size

Specifies the space, in bytes, reserved for the logical record request WHERE clause (PXE), which is passed internally in the LRC block. The default is 512.

The larger the WHERE clause, the more space is required for the PXE. The default of 512 is large enough to include approximately 32 operators, operands, and literals.

The SUBSCHEMA-LR-CTRL SIZE parameter enables you to override the default allocation, usually to enlarge it. If the allocation is insufficient for a logical record command, the dialog abends with a minor code of 69.

Lrc-block-size can be any value from 1 through 32767.

DC PACKET SIZE IS maximum-data

Specifies the maximum size, in bytes, for the data stream in a QUEUE or WRITE PRINTER command. The default is 952.

Maximum-data does not include the 72 bytes that the run-time system allocates in addition to hold system and packet-header information in the data stream. Therefore, if you accept the default of 952, 1024 bytes will be allocated at run time for the entire data stream.

The DC PACKET SIZE parameter enables you to override the default allocation, usually to enlarge it. If the allocation is insufficient for a QUEUE or WRITE PRINTER command, the dialog abends with a minor code of 19.

Maximum-data can be any value from 1 through 32767.