CDAM Control Parameters

The following parameters are used to control the functions performed by the CDAM:

ACIF	DSN	PGMSTEP
ALLOCOPT	ENCODING	PROCSTEP
APA	ENCRYPT	PS
ASSOC	EXIT	STEPNUM
BLOB	JOBID	TIME
BLOCKS	JOBNAME	TRANSTO
CMPEXT	LAST	UNIT
CMPRTN	LINECT	VOLUMES (for a maximum of six volumes)
DATE	OUTLIM	XMLSEP
DDNAME	PCARCH
DEBUG	PGMSTEP

ACIF={YES | NO | ONLY | ALL}

The ACIF parameter settings determine the conversion format and destination of the printing mission, as outlined in Table 277.

Table 277 ACIF Parameter Settings

ACIF Parameter	Description
NO	Reports are not converted. Default.
YES	Reports with destination CTDPC or reports processed by printing mission with STORE parameter set to Y are converted to AFPDS Category 5 format.
ONLY	Reports with destination CTDPC or CTDS or reports processed by printing mission with STORE parameter set to Y are converted to AFPDS Category 5 format.
ALL	All reports are converted to AFPDS Category 5 format.

If the report has ACIF indexes, the original ACIF indexes remain available. However, identical Control-V indexes are created when the printing mission is processed. The new Control-V indexes enable the user to access a specific index value through Control-D/Page On Demand.

For more information about ACIF and Control-D/Page On Demand, see the Control-D and Control-V chapter of the INCONTROL for z/OS Administrator Guide.

For more information about the STORE parameter, see STORE: Mission-specific Parameter.

ALLOCOPT={ONEDSN | JOBSDSN1 | JOBSDSN2}

The ALLOCOPT parameter can be specified in the PRINT/CDAM PARMS field of any ON statement except ON DSN. If specified elsewhere (during a write operation), an error message is not produced and the parameter is ignored.

Note: For more detailed information about this parameter, see CDAM Logic.

When Control-D decollates a report from spool, it creates the following entities:

A CDAM file containing the compressed report. A CDAM file is created for every JES dataset (usually corresponding to every job DD statement).
A report descriptor entry in the Active User Report list ($SYSDATA record). This record contains general information about the compressed CDAM file and pointers to the beginning and end of the report.
One or more user or report entries in the Active User Report list. This record contains the report name and pointers to the beginning and end of the report pages belonging to the user.

Under "classical" circumstances, such as a large sysout distributed to many users, the decollation results are:

One CDAM dataset.
One SYSDATA entry describing the CDAM dataset.
Many user and report entries describing each recipient of (any part of) the report.

However, Control-V is not only used for distributing reports to users. Another common usage of Control-V is to archive MSGCLASS output from production jobs. Following is a schematic example of a report decollating mission definition used for this purpose:

ON CLASS A

WHEN - no data in the WHEN statement

DO USER PRODCNTL

DO NAME PRODUCTION MSGCLASS

DO BACKUP BCK0031D

If special CDAM allocation options are not used, the decollation results are:

Many CDAM files (three JES job datasets; one file for each DD statement).
Many SYSDATA entries (one for each CDAM dataset).
One user or report entry describing all the CDAM datasets.

This technique increases the number of records in the Control-V user files, resulting in inefficient resource usage. It wastes space and slows down Control-V operation. Space utilization on the disk is not efficient because each small CDAM dataset occupies one whole track.

The following ALLOCOPT (allocation) options can be used to remedy these problems:

ALLOCOPT=ONEDSN

When the above decollation is activated with this option, the results are:

One CDAM dataset containing all sysouts of the job (from the decollated class).
One SYSDATA entry for the entire CDAM dataset.
One user or report entry.

Under this option, Control-V assumes that the printing parameters of the first decollated JES dataset apply to all SYSOUTs in the CDAM dataset. Translation from machine printing control characters to ASA control characters is accomplished automatically at printing time.

ALLOCOPT=JOBSDSN1

When the above decollation is activated with this option, the results are:

The sysouts are written to a multi-job CDAM dataset (see below).
One SYSDATA entry for each job, describing all the sysout datasets of this job.
One user or report entry.

Under this option, Control-V assumes that the printing parameters of the first decollated JES dataset of the job apply to all SYSOUTs of the job. Translation from machine printing control characters to ASA control characters and vice versa is accomplished automatically at printing time.

ALLOCOPT=JOBSDSN2

When the above decollation is activated with this option, the results are:

The sysouts are written to a multi-job CDAM dataset (see below).
One SYSDATA entry for each JES sysout dataset (as in "classical" decollation).
One user or report entry.

Under this option, the printing parameters of each dataset are kept automatically.

APA=YES or NO

The APA parameter can be set to YES for AFPDS reports or to NO for regular reports. The default value is YES if the report contains only AFP lines (which begin with hexadecimal 5A). Otherwise, the default value is NO. The parameter is optional.

For an explanation of how setting the APA parameter to YES affects report indexes, see .

ASSOC=associationtype

This parameter specifies the report file type (for example, DOC, PDF, AFP).

Reports viewed using Control-D/Page On Demand or CTDWA are viewed according to the specified ASSOC value. For example, a report with association type PDF is viewed with Adobe Acrobat.

BLOB=imagetype

The presence of this parameter indicates that the report was created with Control-D/Image. The value indicated by BLOB is the image type specified when implementing Control-D/Image (for example, DOC, GIF, JPG).

For more information about Control-D/Image, see the Control-D and Control-V chapter of the INCONTROL for z/OS Administrator Guide.

BLOCKS=number

This parameter specifies the number of blocks allocated for the first "logical" extent of the compressed dataset. The parameter is optional. The default is defined by the Control-D installation parameter AMBLK#D.

The parameter should be used when the user wants to control the allocation algorithm of CDAM in order to improve system performance. For a full explanation, see CDAM Logic.

For example:

A report contains 100,000 lines. The record length is 121. The total space required (before compression) is 12,100,000 bytes. Assuming a compression rate of 50%, the total compressed space required is 6,050,000 bytes. The recommended block size of a CDAM dataset on a 3380 is 23476. Therefore, 6,050,000 : 23476 = 258 blocks are needed.

Using the default primary allocation size (assume 200) does cause CDAM to create at least two datasets (logically connected – transparent to the application program). If the user wants to create only one dataset (for performance reasons), a larger block number should be specified. For example:

//PRINT DD SUBSYS=(CDAM,'BLOCKS=280')

Whatever block number is used, CDAM does not abend due to space shortage when the initial allocation space is exhausted. In any case, any unused block in the allocated dataset is released at the end of the job step. For more details, see CDAM Logic.

If the STORE parameter in the Printing Mission Definition screen is set to Y (Yes), a new report file is created. This file incorporates print resources and can be viewed through Control-D/Page On Demand. Control-V indexes that were defined in the decollation mission are converted to fit the new report file. The new Control-V indexes enable the user to access a specific index value through Control-D/Page On Demand. For more information about Control-D/Page On Demand, see the Control-D and Control-V chapter of the INCONTROL for z/OS Administrator Guide.

CMPEXT=YES

This parameter can be used as a CDAM parameter in PRINT/CDAM PARMS in decollation mission definitions, and as a SUBSYS parameter in JCL.cards.

When this parameter is used, Control-D saves in the Control-D repository most of the printing parameters that are used in the OUTPUT card when the SYSOUT is created in the spool. These parameters can later be used automatically during Control-D printing. In this case, optional wish WD3133 (Dynamic allocation of OUTPUT card) must be activated with DATAC=ALL or DATAC=CMPEXT:

ID=WD3133,APPLY=YES,DATA=0,DATAC=ALL

CMPRTN=name

The name of the compression and decompression routine. This parameter overrides the default compression routine supplied with Control-V. The current default routine has a compression rate of 30% – 70% for reports and dumps.

DATE=jjj

The day in the year in Julian format. This parameter represents the day on which the compressed SYSOUT was created. This parameter can be used for retrieval purposes. If a different date is desired when creating a CDAM file, use the DSN field of the DD statement, which is described in Parameter DSN of the DD Statement.

DDNAME=name

This parameter can be used for retrieval. The format is a 1 - 8 character, valid DD name. This parameter represents the DD name from which the compressed sysout has been created.

DEBUG={YES|NO|debug levels}

This parameter helps Control-V support personnel solve problems. The parameter is optional. The default setting of DEBUG is NO (that is, no special debug printout). When DEBUG is set to YES, or debug levels are specified, CDAM writes special messages, snaps and other relevant data to DD statement CDAMSNAP. Debug levels are specified by a sequence of 1-8 digits, where each digit specifies a debug level. CDAM expects this DD statement to be defined in the job step. This DD statement must not use CDAM. The debugging messages must be directed to the spool or to a regular sequential dataset. In the following example, debug levels 1, 4, and 5 are set for the CDAM file:

//PRINT DD SUBSYS=(CDAM,'PREFIX=J01',

// 'DEBUG=145')

//CDAMSNAP DD SYSOUT=X

DSN=CDAM_dsname

This parameter is used, as a retrieval criterion to obtain a desired CDAM according to CDAM name. To retrieve a particular CDAM, the ON DSN / ON TRNDSN statement must contain the DSN parameter defined with CDAM name withan asterisk instead of the two last ‘00’ characters. If the CDAM name is longer than 40 characters, define the DSN= parameter on the second line of the ON DSN / ON TRNDSN statement in the Decollation mission definition. For example:

ON DSN = PREFIX=CTD.USR,

DSN=CTD.USR.CTDCDAM.J69859.D0571613.S01.N0004*

PRT COPIES LVL USER

PRINT/CDAM PARMS =

If a Decollation mission definition is ordered by FTO, define the DSN parameter DSN as DSN=%%CDAM. In this case, the variable %%CDAM will be resolved by the CDAM name created by FTO in the current session, as follows:

ON DSN = PREFIX=CTD.USR,

DSN=%%CDAM

PRT COPIES LVL USER

PRINT/CDAM PARMS =

EAVUSE=OPT|NO

The EAVUSE parameter can be used as a CDAM parameter in PRINT/CDAM PARMS in a decollation mission definitions, and as a SUBSYS parameter in JCL cards.

When this parameter is specified in a JCL card, Control-D uses the dynamic allocation parameter EATTR=OPT|NO for allocation of the created CDAM files. If it is omitted, the EAVUSE#C parameter in the CTDPARM member is used by default.

When this parameter is specified in a decollation mission, Control-D uses the dynamic allocation parameter EATTR=OPT|NO for allocation of the created CDAM and Index files. If it is omitted, the EAVUSE#C parameter in the CTDPARM member is used by default for the CDAM files and the EAVUSE#V parameter in the CTVPARM member is used by default for the index files.

ENCODING={rprt_enc|NO}

This parameter specifies the character set used in the report. Although the report is written to CDAM in the original encoding, the decollation mission works with text translated into EBCDIC code.

If the encoding is not defined for an XML report, the encoding is taken from the XML header record. If the encoding is not specified in the XML header, the UTF-8 code is assumed according to the XML standard. If this parameter is not specified for a non-XML report, no translation is performed.

The list of supported encoding is located in the ENCODTBL member of the IOA IOAENV library.

Examples

A text report with ENCODING set to ISO-8859 is translated from ASCII to EBCDIC for the decollation process.
An XML report that has the following tag in the first line, and without the ENCODING parameter specified, is translated from UTF-8 Unicode to EBCDIC:
<?xml version=’1.0’ encoding=’UTF-8’?>
An XML report that has no header tag, and ENCODING is set to NONE, is not translated.

ENCRYPT={YES | NO}

This parameter specifies whether the CDAM Encryption routine encrypts regular (non-JOBSDSN) data before it is written to the CDAM file. This parameter can be used as a CDAM parameter in PRINT/CDAM PARMS in decollation mission definitions, and as a SUBSYS parameter in JCL cards.

Note: The ENCRYPT parameter setting overrides the default set by the AMENCRPT parameter setting in the CDAM section of CTDPARM.

EXIT={YES | NO}

This parameter designates whether output processing Exit CTDX018 should be activated. This parameter can only be used when writing directly to a CDAM file. The default setting of EXIT is NO (that is, the exit is not activated). This default can be changed by the INCONTROL administrator. When EXIT is set to YES, the exit receives control for every line which is written to a CDAM file. For additional details, see CDAM User Exit CTDX018.

JOBID=Jnnnnn[nn]

This parameter can be used for retrieval purposes. The format is Jnnnnn or Jnnnnnnn where nnnnn[nn] is the JES job ID of the job which created the compressed sysout. JOBID can be 5 or 7 digits depending on the z/OS setting.

JOBNAME=name

This parameter can be used for retrieval purposes. The format is a 1 through 8 character valid jobname. It represents the job which created the compressed sysout.

LAST={YES|NO}

This parameter is used, along with other parameters, as a retrieval criteria to obtain the sysouts of the last job. The default value of this parameter is N (No).

If LAST is set to Y (Yes), Control-V retrieves (decollates) the SYSOUTs of the last execution of the job. For example:

ON DSN PREFIX=CDU08,DDNAME=REPOUT,LAST=YES

For the specific report decollating mission jobname, the last execution of the job which produced output on DD statement REPOUT is processed and its outputs from DD statement REPOUT (CDAM datasets) are decollated.

LINECT=number

This parameter can be used for reports without page control characters (machine or ASA reports). When printing without Control-V, the printer normally skips to a new page based on the value of the LINECT parameter of the OUTPUT statement. The same is true for Control-V. It breaks such reports into pages based on the value of the LINECT parameter. If the parameter is not specified for such reports, Control-V assumes that the value of LINECT is 100.

This parameter affects all reports. Even if a report has page control characters, a page break occurs after LINECT lines if control character ‘1’ is not detected.

This parameter should be specified in the CDAM parameters when writing directly to CDAM or in the PRINT/CDAM PARMS field when decollating from spool. For more information, read about parameter LINECT in PRINT/CDAM PARMS: Decollating Parameter (decollating mission).

OUTLIM=number

The OUTLIM parameter sets a limit on the number of records that can be written to a CDAM during decollation from a SYSOUT. If the limit is reached, the decollation mission will end immediately. No error message for this limit is issued. The remaining part of the SYSOUT will not be stored in CDAM.

The optional wish WD0699 does not limit the size of CDAM files written by decollation.

The OUTLIM parameter can be specified in the PRINT/CDAM PARMS field of any ON statement except ON DSN. If specified elsewhere (during a write operation), an error message is not produced and the parameter is ignored.

PCARCH={Y|N}

Specifies whether the report is (Y) or is not (N) archived (backed up) by Control-D/WebAccess Server after the report is transferred to a PC. For more information, see the description of modifying report attributes in the Control-D/WebAccess Server Administrator Guide.

PGMSTEP=name

This parameter may be used for retrieval. The format is a 1 through 8 character valid job step name. It represents the step in the job from which the compressed sysout has been created.

PREFIX=name

CDAM writes the sysout to sequential datasets. The PREFIX parameter specifies the high level datasets name qualifier. The name must be a valid dataset name qualifier of from 1 through 7 alphanumeric characters. It may consist of two parts separated by a period, but total length cannot exceed seven characters.

This parameter is optional. If omitted, the following occurs:

If the file is created when writing directly to CDAM, the value specified in the Control-D installation parameter AMPREF in the CTDPARM member is used.
If the file is created by Control-D decollation with ALLOCOPT=JOBSDSN1, the value specified in the Control-D installation parameter JB1PREF in the CTDPARM member is used.
In all other cases (the file is created by Control-D decollation without ALLOCOPT, or with ALLOCOPT=ONEDSN or JOBSDSN2), the value specified in the Control-D installation parameter AMPREFD in the CTDPARM member is used.

The dataset names created by the CDAM are subject to regular security constraints imposed by the data center (using any standard security package or site-developed system). The dataset is allocated and opened using the standard system services, thus enforcing regular security considerations.

PROCSTEP=name

This parameter may be used for retrieval. The format is a 1 through 8 character valid procedure step name. It represents the JCL procedure step name from which the compressed sysout has been created.

PS={DOC1|CSET}

The PS parameter can be used to decollate PostScript output using the DOC1 or CompuSet product.

STEPNUM=nn

This parameter can be used for retrieval. The format is nn where nn is the relative number of the step from the beginning of the job (in hexadecimal format). It represents the step number in the job from which the compressed sysout has been created.

TIME=hhmm

This parameter can be used for retrieval. The format is hhmm representing the hour and minute when the compressed sysout was created.

TRANSTO=transformationtype

This parameter specifies the type of file to which the report is transformed when viewed using Control-D/Page On Demand (for example, PDF, TXT).

For example, if the CDAM parameter APA is set to YES (specifying an AFP report) and TRANSTO is set to PDF, when the AFP report is viewed using Control-D/Page On Demand, it is converted to a PDF file.

The file conversion occurs only if the appropriate conversion utility is installed.

For more information about the TRANSTO parameter, see the Control-D and Control-V chapter of the INCONTROL for z/OS Administrator Guide.

UNIT=name

The name of the unit on which the compressed SYSOUT is written. The name must be a valid (1 through 8 character) unit name within the system. The unit must be a disk and it can span any number of disk drives. The parameter is optional. The default name is defined by Control-D installation parameter AMUNIT.

VOLUMES=(nnnnn1,...nnnnn6)

The names of the volumes on which the compressed SYSOUT is written. The names must be a valid volume name within the system. The parameter is optional. The default name is defined by the Control-D installation parameter AMVOL.

XMLSEP=tagname

Defines an XML tag to be used for splitting an XML document into pages. The value tagname is case-sensitive. When XMLSEP is set to a value, the ASSOC parameter is set to XML. For CDAM decollation, the XMLSEP parameter must be specified only in the SUBSYS parameter of the DD statement creating the document. XMLSEP may be used only for EBCDIC reports.

Parent Topic

CDAM Parameters