Previous Topic

Next Topic

Book Contents

Book Index

CTDUFEXP Parameters

The parameters specified in the EXEC statement are listed in the Table 246. These parameters are used in the procedure to create the unloaded dataset name.

Table 246 CTDUFEXP EXEC parameters

Parameter

Description

PACKAGE

The package name. Maximum length is 8 characters. Mandatory.

This name is added as next to last qualifier to the unloaded dataset name and is printed in the output reports. The user can specify any name to identify a group of unloaded files.

DBFILE

File type to be acted upon:

  • ACT - Active User file
  • HST - History User file
  • MIG - Migration User file
  • PRM - Permanent User file

Mandatory.

Other statements are specified in the SYSIN DD input stream. They must be specified in the following order:

  1. General parameters
  2. INCLUDE
  3. Selection parameters
  4. Repeat INCLUDE with other Selection parameters if needed.
  5. EXCLUDE
  6. Selection parameters
  7. Repeat EXCLUDE with other Selection parameters if needed.

General parameters are specified in the beginning of the input stream. They define the utility's action, working mode and list of printed reports. The general parameters are described in the Table 247:

Table 247 CTDUFEXP general parameters

Parameter

Description

EXPORT/
CLEANUP

One of these words should be specified as first statement in the input stream. It defines the utility's action:

  • EXPORT - unload records related to the reports and rulers specified by the statements INCLUDE and EXCLUDE statements from the Control-D User file to the sequential dataset.
  • CLEANUP - delete the reports specified by the INCLUDE and EXCUDE statements from the Control-D User file. Only User and Notepad records related to the report are deleted by this utility. Other User file records and datasets related to the deleted reports will be deleted later as orphan records by the CTDDELRP, CTDCLHST, and CTVCLMIG utilities.

Note. The utility deletes only reports which have been unloaded in the previously utility's run with the function EXPORT.

REPORTS

Specifies that the utility will include the selected Control-D reports metadata in the processing. Optional.

RULERS

Specifies that the utility will include one of the following:

  • the selected Control-D rulers and Logical Views in the processing (when specified for the EXPORT action from the ACTIVE User file)
  • the selected Control-D mask rulers (when specified for the EXPORT action from the PERMANENT User file)

Optional.

Note. At least one, or both, of the parameters REPORTS or RULERS must be specified in the statement.

MODE

This mandatory parameter determines if the CTDUFEXP utility is run in Production mode or Simulation mode. If the parameter is not specified, the default is Production mode. You should run this utility in Simulation mode before running it in Production mode. Valid values are:

  • PROD – The utility runs in Production mode, changing and deleting report entries and CDAM files that satisfy the requirements specified by other parameters. Default.
  • TEST – The utility runs in Simulation mode, performing analysis and reporting but not changing or deleting any files.

LIST

Determines which output reports are printed by the utility.

The valid values are

  • ALL - all output reports available for the performed action and processed User file type are printed.

One or several of the following output report names can be specified. If several names are specified, they must be separated by commas and the list enclosed in parenthesis.

  • RECORDS - list of all exported or deleted Control-D reports including all the records related to them. This report is available for the EXPORT REPORTS and CLEANUP REPORTS actions. (Note: Since specifying RECORDS includes the reports also, do not specify both REPORTS and RECORDS.)
  • REPORTS - list of all exported or deleted Control-D reports, without their associated records. This report available for the EXPORT REPORTS and CLEANUP REPORTS actions.
  • FILES - list of CDAM and Index files related to the selected reports. This report is available for the action EXPORT REPORTS from the ACT, MIG, and HST User files.
  • VOLS - list of the volumes (volume serial numbers) where the CDAM and Index files related to the selected reports reside. This report is available for the EXPORT REPORTS action from the MIG and HST User files.
  • RULERS - list of all exported Rulers and Logical Views. This report is available for the action EXPORT RULERS.

Table 248 describes selection parameters that can be specified in the INCLUDE and EXCLUDE statements.

The following rules apply to the INCLUDE and EXCLUDE statements:

Table 248 CTDUFEXP selection parameters

Parameter

Description

BKPMIS

It specifies the name (or the template name) of the backup mission used to back-up of the reports. The maximum length is 8 characters.

It is available for all actions with the HST file type only.

BKPUTIL

It specifies the type of the backup utility as it is specified in the CTDPARM parameters member. The maximum length is 8 characters.

It is available for all actions with HST file type only.

CATEGORY

It specifies the name (or the template name) of the report category. The maximum length is 20 characters.

Is available for EXPORT REPORTS and CLEANUP REPORTS for all file types.

CDAMDSN

It specifies the name (or the template name) of the CDAM dsname (data set name) containing the report. The maximum length is 44 characters.

It is available for all actions and file types. For the MIG file type, the original CDAM or the migrated CDAM dataset name can be specified.

If FILE=ACT or FILE=HST, the original CDAM dsname is searched. If FILE=MIG, the original and the primary and secondary migrated CDAM dsnames are searched.

EXPDATE

It specifies the expiration date or range of dates for the migrated or backed-up reports. One date or range of dates (in the form of date1-date2) can be specified. The dates can be specified in one of the following formats, DD/MM/YY, MM/DD/YY, or YY/MM/DD, depending on the site standard, defined in the IOAPARM installation member.

It is available for all actions and file types.

INDEXDSN

It specifies the name (or the template name) of the Control-V Index dsname (data set name) related to the report. The maximum length is 44 characters.

Is available for EXPORT REPORTS and CLEANUP REPORTS for the ACT, MIG, and HST file types.

If FILE=ACT or FILE=HST, the original Index dsname is searched. If FILE=MIG, the original and the migrated Index dsname is searched.

INDEXNAME

It specifies the name (or the template name) of the Main Control-V Index name related to the report. The maximum length is 20 characters.

Is available for EXPORT REPORTS and CLEANUP REPORTS for the ACT, MIG, HST file types.

JOBID

It specifies the system job identification number. Numeric value. The maximum length is 7 digits.

It is available for all actions and file types.

JOBNAME

It specifies the name (or the template name) of the job created the report. The maximum length is 8 characters.

It is available for all actions and file types.

MIGMEDIA

It specifies the name (or the template name) of the media to where the report content is migrated. The maximum length is 8 characters.

It is available for all actions with the MIG file type only.

MIGMIS

It specifies the name (or the template name) of the migration mission with which the reports have been migrated. The maximum length is 8 characters.

It is available for all actions with the MIG file type only.

ODATE

It specifies the ordering date or range of dates (in the format of date1-date2) of the report. The dates can be specified in one of the following formats, DD/MM/YY, MM/DD/YY, or YY/MM/DD, depending on the site standard defined in the IOAPARM installation member.

It is available for all actions and file types.

REPNAME

It specifies the name (or the template name) of the Report. If blanks or apostrophes are included in the Report name, the Report name must be specified between apostrophes and any apostrophes included in the Report name must be doubled. The maximum length is 50 characters.

It is not available for CHANGE action.

RETPD

It specifies the retention period of the backed-up or migrated report. Numeric value. The maximum length is 5 digits.

It is available for all actions and file types.

RULNAME

It specifies the name (or the template name) of the ruler or of the Logical View. The maximum length is 8 characters.

RULTYPE

It specifies the type of the ruler or of the Logical View. The available values are:

  • VIEW - view ruler
  • PRINT - print ruler
  • LOGVIEW - logical view

USER

It specifies the name (or the template name) of the report recipient. The maximum length is 8 characters.

Is available for all actions and file types.

VOLSER

It specifies the tape volume serial number (or the template) where the backup or migrated content of the report resides. The maximum length 6 characters.

Is available for EXPORT REPORTS and CLEANUP REPORTS for the MIG, HST file types.

Parent Topic

CTDUFEXP – Transfer data between Control-D Repositories