Selection criteria keyword reference for Archive function
The Archive process supports numerous selection criteria keywords that can be used to
determine whether a given data set is selected for Archive processing. The keywords can also
explicitly identify which data sets are to be excluded from Archive processing.
Wildcard support for specifying masks
For Archive processing, you may use wildcard characters in masks for data set names, volume
serial numbers, management class names, and storage group names. For more information about using
wildcards, see appendix Wildcard support for specifying selection criteria keywords.
Selection criteria keyword restrictions
There are some restrictions on the values that you may specify for
selection criteria keywords. For detailed information about these
restrictions, see appendix Selection criteria keyword restrictions.
Selection criteria keyword definitions
ARCHIVE_SOURCE=ML2|L0
The ARCHIVE_SOURCE= keyword specifies whether the candidate data sets for archiving reside on ML2 tape or on L0 disk.
You may specify the ARCHIVE_SOURCE= keyword multiple times in one job, but Archive processing accepts the first occurrence only.
Do not include blank spaces in your value specification. For example, ARCHIVE_SOURCE=L0 is a valid specification, but ARCHIVE_SOURCE= L0 and ARCHIVE_SOURCE = L0 are not valid specifications.
Note: If you do not include the ARCHIVE_SOURCE= keyword in your CRITERIA statements, Archive processing assumes that the candidate data sets reside on ML2 tape.
Supported wildcard characters: none
Example values:ML2, L0
GROUP_NAME=name
The GROUP_NAME= keyword begins a group of CRITERIA selection statements, where name is the group name. This is an optional keyword, but if you do not specify a value for name, Advanced Archive for DFSMShsm assigns GROUP_NAME=DFLT.
If you are archiving inactive data to a cloud storage environment (parameter ARCHIVE-TARGET=CLOUD|GROUP), GROUP_NAME=name identifies the cloud definition name that is used for the Archive operation. Be aware that you can configure parameter library member AXQEDRGN to exclude certain cloud definitions from automatic Restore processing (see AXQEDRGN for more information).
The value that you specify for name must be a string that is 1 - 8 characters in length.
Supported wildcard characters: none
Example values:STANDARD, PRD22
DSN=dsnameormask
The DSN= keyword specifies a data set name or data set name mask against which
the names in the raw candidate file are compared to select the candidate records to include in
processing.
The value that you specify must be 1 – 44 characters in length.
Supported wildcard characters:*, **, %
Example value:TEST.B%B.**
DSN>membername
The DSN> keyword specifies the name of the parameter library member that
contains a list of data set names or data set name masks (or both) to include in processing. The
data set names and masks that you specify in the contents of membername may
start in any column and are terminated by three or more consecutive blank spaces.
Supported wildcard characters:
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername, you may use %,
*, and ** in the values that you specify for data set name
masks.
Example value for membername:ARCHIV27
Example value for masks specified in the contents of member membername:TEST.B%B.**
XDSN=dsnameormask
The XDSN= keyword specifies a data set name or data set name mask against which
the names in the raw candidate file are compared to identify the candidate records to be excluded
from processing.
The value that you specify must be 1 – 44 characters in length.
Supported wildcard characters:*, **, %
Example value: TEST.B%B.**
XDSN>membername
The XDSN> keyword specifies the name of the parameter library member that
contains a list of data set names or data set name masks (or both) to exclude from processing. The
data set names and masks that you specify in the contents of member membername
may start in any column and are terminated by three or more consecutive blank spaces.
Supported wildcard characters:
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername, you may use %,
*, and ** in the values that you specify for data set name
masks.
Example value for membername:DONTSAVE
Example value for masks specified in the contents of member membername:TEST.B%B.**
MGMTCLAS=mgmtclasname
The MGMTCLAS= keyword specifies the name of an SMS management class or a mask
for SMS management class names that you want included in processing.
Supported wildcard characters:*, %
Example value:STAND*
MGMTCLAS>membername
The MGMTCLAS> keyword specifies the name of the parameter library member that
contains a list of management class names or management class name masks (or both) to include in
processing. The management class names and masks that you specify in the contents of member
membername may start in any column and are terminated by three or more
consecutive blank spaces.
Supported wildcard characters:
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername, you may use % and
* in the values that you specify for management class name masks.
Example value for membername:INCMCLAS
Example value for masks specified in the contents of member membername:STAND*
XMGMTCLAS=mgmtclasname
The XMGMTCLAS= keyword specifies the name of an SMS management class or a mask
for SMS management class names that you want excluded from processing.
Supported wildcard characters:*, %
Example value: STAND*
XMGMTCLAS>membername
The XMGMTCLAS> keyword specifies the name of the parameter library member that
contains a list of management class names or management class name masks (or both) to exclude from
processing. The management class names and masks that you specify in the contents of member
membername may start in any column and are terminated by three or more
consecutive blank spaces.
Supported wildcard characters:
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername, you may use % and
* in the values that you specify for management class name masks.
Example value for membername:IGNORE62
Example value for masks specified in the contents of member membername:STAND*
#DAYS_SINCE_CREATE=n|n-nn
The value that is assigned to the #DAYS_SINCE_CREATE= keyword specifies a
number of days, or a range of days, that have elapsed since the data set was created. Candidate data
sets whose create dates are the specified number of days old are selected for processing.
n represents an integer in the range 0 – 99999. The create date of the
candidate data set is subtracted from the current Julian date and if the difference is equal to
n, the data set meets the selection criteria.
n-nn represents a range of values in the range (0 – 99999) - (0 – 99999). The
create date of the candidate data set is subtracted from the current Julian date and if the
difference is equal to or greater than n, and is equal to or less than
nn, the data set meets the selection criteria.
Note: Separate n
from nn with a hyphen (-) and no blank spaces.
Supported wildcard characters: none
Example values:12, 0–12 (note that 0 - 12 is not a valid
value)
#DAYS_SINCE_LASTUSED=n|n-nn
The value that is assigned to the #DAYS_SINCE_LASTUSED= keyword specifies a
number of days, or a range of days, that have elapsed since the data set was last used. Candidate
data sets whose last-used dates match the value or fall within the range of values that are
specified for this keyword are selected for processing.
n represents an integer in the range 0 – 99999. The last-used date of the
candidate data set is subtracted from the current Julian date and if the difference is equal to
n, the data set meets the selection criteria.
n-nn represents a range of values in the range (0 – 99999) - (0 – 99999). The
last-used date of the candidate data set is subtracted from the current Julian date and if the
difference is equal to or greater than n, and is equal to or less than
nn, the data set meets the selection criteria.
Note: Separate n
from nn with a hyphen (-) and no blank spaces.
Supported wildcard characters: none
Example values: 12, 0–12 (note that 0 -
12 is not a valid value)
#DAYS_SINCE_MIGRATED=n|n-nn
The value that is assigned to the #DAYS_SINCE_MIGRATED= keyword specifies a
number of days, or a range of days, that have elapsed since the data set was migrated to ML2.
Candidate data sets whose migration dates match the value or values that are specified for this
keyword are selected for processing.
n represents an integer in the range 0 – 99999. The migration date of the
candidate data set is subtracted from the current Julian date and if the difference is equal to
n, the data set meets the selection criteria.
n-nn represents a range of values in the range (0 – 99999) - (0 – 99999). The
migration date of the candidate data set is subtracted from the current Julian date and if the
difference is equal to or greater than n, and is equal to or less than
nn, the data set meets the selection criteria.
Note: Separate n
from nn with a hyphen (-) and no blank spaces.
Supported wildcard characters: none
Example values:12, 0–12 (note that 0 - 12 is not a valid
value)
#DAYS_UNTIL_EXPIRATION=n|n-nn
The value that is assigned to the #DAYS_UNTIL_EXPIRATION= keyword specifies a number of days, or a range of days, that remain until the data set expires. Candidate data sets with expiration dates that are this number of days in the future are selected for processing.
n represents an integer in the range 0 – 99999. The current Julian date is subtracted from the expiration date of the candidate data set and if the difference is equal to n, the data set meets the selection criteria.
n-nn represents a range of values in the range (0 – 99999) - (0 – 99999). The current Julian date is subtracted from the expiration date of the candidate data set and if the difference is equal to or greater than n, and is equal to or less than nn, the data set meets the selection criteria.
Note: Separate n from nn with a hyphen (-) and no blank spaces.
Note: Specifying 99999 as a value for this keyword causes the selection of data sets that have permanent expiration dates.
Supported wildcard characters: none
Example values:12, 0–12 (note that 0 - 12 is not a valid
value)
MIGRATION_DATE=date|startdate-enddate
The value that is assigned to the MIGRATION_DATE= keyword specifies a date, or
a range of dates, on or during which the data set was migrated to ML2. Candidate data sets whose
migration dates match the value or values that are specified for this keyword are selected for
processing.
You can specify single dates and date ranges in the following formats:
Julian dates:
YYYY.DDD or YYYY.DDD - YYYY.DDD
Julian dates must fall within the range 1900.001 – 2999.365.
Gregorian dates:
MM/DD/YYYY or MM/DD/YYYY - MM/DD/YYYY
DD/MM/YYYY or DD/MM/YYYY - DD/MM/YYYY
YYYY/MM/DD or YYYY/MM/DD - YYYY/MM/DD
Gregorian date values must fall within the range 01/01/1900 – 12/31/2999 (MM/DD/YYYY format),
01/01/1900 – 31/12/2999 (DD/MM/YYYY format), or 1900/01/01 – 2999/12/31 (YYYY/MM/DD format).
You must use the same date format for both startdate and
enddate. startdate and enddate are
separated by a hyphen (-) with no blank spaces on either side.
Supported wildcard characters: none
Example values: 12/01/2014, 2014.033-2014.365 (note that
2014.033 - 2014.365 is not a valid value)
EXPIRATION_DATE=date|startdate-enddate
The value that is assigned to the EXPIRATON_DATE= keyword specifies a date, or
a range of dates, on or during which the data set is scheduled to expire. Candidate data sets whose
expiration dates match the value or values that are specified for this keyword are selected for
processing.
You can specify single dates and date ranges in the following
formats:
Julian dates:
YYYY.DDD or YYYY.DDD - YYYY.DDD
Julian dates must fall within the range 1900.001 – 2999.365.
Note: There are two exceptions to the
supported date value range for EXPIRATION_DATE.
You may specify 0000.000 to select data sets
that have a null expiration date.
You may specify 9999.365 to select data sets
that have a permanent expiration date.
Gregorian dates:
MM/DD/YYYY or MM/DD/YYYY - MM/DD/YYYY
DD/MM/YYYY or DD/MM/YYYY - DD/MM/YYYY
YYYY/MM/DD or YYYY/MM/DD - YYYY/MM/DD
Gregorian date values must fall within the range 01/01/1900 – 12/31/2999 (MM/DD/YYYY format),
01/01/1900 – 31/12/2999 (DD/MM/YYYY format), or 1900/01/01 – 2999/12/31 (YYYY/MM/DD format).
You must use the same date format for both startdate and
enddate. startdate and enddate are
separated by a hyphen (-) with no blank spaces on either side.
Supported wildcard characters: none
Example values:12/01/2014, 2014.033-2014.365 (note that 2014.033 -
2014.365 is not a valid value)
STORGRP=storagegroupname
Note: The STORGRP= keyword is applied during Archive processing only when the
candidate data sets reside on L0 disk (data set selection criteria
ARCHIVE_SOURCE=L0).
The STORGRP= keyword specifies the storage group name that is to be captured
from the IDCAMS DCOLLECT process or captured from the DCOLLECT
output flat file. The value that you specify for storagegroupname must be a valid
storage group name that is 1 - 8 alphanumeric characters.
Supported wildcard characters:*, %. Note that the IDCAMS DCOLLECT process
ignores wildcard specifications, but the wildcards are interpreted by Advanced Archive for DFSMShsm during Archive processing.
Example value:PRD%SET
STORGRP>membername
Note: The STORGRP> keyword is applied during Archive processing only when the
candidate data sets reside on L0 disk (data set selection criteria
ARCHIVE_SOURCE=L0).
The STORGRP> keyword specifies the name of a parameter library member that
contains the storage group names that are to be captured from the IDCAMS DCOLLECT
process or captured from the DCOLLECT output flat file. The member name that you
specify must be 1 - 8 alphanumeric characters.
Within the contents of member membername, storage group names may begin in any
column and are delimited by blank spaces.
Supported wildcard characters:
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername, you may use % and
* in storage group name masks. Note that the IDCAMS DCOLLECT
process ignores wildcard specifications, but the wildcards are interpreted by Advanced Archive for DFSMShsm during Archive processing.
Example value for membername:PRDSET
Example value for masks specified in the contents of member membername:PRD%SET
XSTORGRP=storagegroupname
Note: The XSTORGRP= keyword is applied during Archive processing only when the
candidate data sets reside on L0 disk (data set selection criteria
ARCHIVE_SOURCE=L0).
The XSTORGRP= keyword specifies the storage group name that is not
to be captured from the IDCAMS DCOLLECT process or captured from the
DCOLLECT output flat file. The value that you specify for
storagegroupname must be a valid storage group name that is 1 - 8 alphanumeric
characters.
Supported wildcard characters:*, %. Note that the IDCAMS DCOLLECT process
ignores wildcard specifications, but the wildcards are interpreted by Advanced Archive for DFSMShsm during Archive processing.
Example value:PRD%SET
XSTORGRP>membername
Note: The XSTORGRP> keyword is applied during Archive processing only when the
candidate data sets reside on L0 disk (data set selection criteria
ARCHIVE_SOURCE=L0).
The XSTORGRP> keyword specifies the name of a parameter library member that
contains the storage group names that are not to be captured from the IDCAMS
DCOLLECT process or captured from the DCOLLECT output flat file.
The member name that you specify must be 1 - 8 alphanumeric characters.
Within the contents of the specified parameter library member, storage group names may begin in
any column and are delimited by blank spaces.
Supported wildcard characters:
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername, you may use % and
* in storage group name masks. Note that the IDCAMS DCOLLECT
process ignores wildcard specifications, but the wildcards are interpreted by Advanced Archive for DFSMShsm during Archive processing.
Example value for membername:PRDSET
Example value for masks specified in the contents of member membername:PRD%SET
VOL=volser|startvolser-endvolser
Note: The VOL= keyword is applied during Archive processing only when the candidate
data sets reside on L0 disk (data set selection criteria ARCHIVE_SOURCE=L0).
The value that is assigned to the VOL= keyword specifies a volume serial number,
or a range of volume serial numbers, of candidate data set names to be captured from the IDCAMS
DCOLLECT process or captured from the DCOLLECT output flat file.
Candidate data sets whose volsers match the value or values that are specified for this keyword are
selected for processing.
volser represents a 1– to 6–byte volume serial number or a volume serial
number mask to match against candidate records for inclusion in processing.
startvolser-endvolser represents a range (with no blank spaces on either side
of the hyphen) of volume serial numbers to match against the candidate records for inclusion in
processing. IDCAMS DCOLLECT ignores ranges of values that are specified for the
VOL= keyword, but the Archive job processes the ranges appropriately.
Supported wildcard characters:*, %. Note that the IDCAMS DCOLLECT process
permits the selection of volumes.
You may use % and * in individual volser masks. The Archive
process translates the % character in the keyword value to * and
then interprets the value string up to the first *.
You may not use wildcard characters in the values that you specify for
startvolser or for endvolser.
Example values:PRD*, 1%%A2, 200000–600000 (note that
200000 - 600000 is not a valid value)
VOL>membername
Note: The VOL> keyword is applied during Archive processing only when the candidate
data sets reside on L0 disk (data set selection criteria ARCHIVE_SOURCE=L0).
The VOL> keyword specifies the name of the parameter library member that
contains a list of any combination of the following: volume serial numbers, ranges of volume serial
numbers, or masks of volume serial numbers of data sets to be captured from the IDCAMS
DCOLLECT process or captured from the DCOLLECT output flat file
for inclusion in processing.
Within the contents of member membername, the volume serial numbers that you
specify may start in any column and are terminated by three or more consecutive blank spaces. You
may specify volume serial numbers individually or as a range of values (startvolser -
endvolser) where startvolser and endvolser are
separated by a hyphen and no blank spaces.
Supported wildcard characters: Note that the IDCAMS DCOLLECT process
permits the selection of volumes.
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername:
You may use % and * in individual volser masks. The Archive
process translates % to * and then interprets the value string up
to the first *.
You may not use wildcard characters in the values that are specified for
startvolser or for endvolser.
Example values for membername:PRODVOLS, VOL15TST
Example values for masks specified in the contents of member
membername:PRD*, 1%%A2, 200000–600000 (note that
20000 - 600000 is not a valid value)
XVOL=volser|startvolser-endvolser
Note: The XVOL= keyword is applied during Archive processing only when the
candidate data sets reside on L0 disk (data set selection criteria
ARCHIVE_SOURCE=L0).
The value that is assigned to the XVOL= keyword specifies a volume serial
number, or a range of volume serial numbers, of candidate data sets that are not be
captured from the IDCAMS DCOLLECT process or from the DCOLLECT
output flat file. Candidate data sets whose volsers match the value or values that are specified for
this keyword are excluded from processing.
volser represents a 1– to 6–byte volume serial number or a volume serial
number mask to match against candidate records for exclusion from processing.
startvolser-endvolser represents a range (with no blank spaces on either side
of the hyphen) of volume serial numbers to match against the candidate records for exclusion from
processing. IDCAMS DCOLLECT ignores ranges of values that are specified for the
XVOL= keyword, but the Archive job processes the ranges appropriately.
Supported wildcard characters:*, %. Note that the IDCAMS DCOLLECT process does
not permit the exclusion of volumes, but the Archive process does.
You may use % and * in individual volser masks. The Archive
process translates the % character in the keyword value to * and
then interprets the value string up to the first *.
You may not use wildcard characters in the values that you specify for
startvolser or for endvolser.
Example values:PRD*, 1%%A2, 200000–600000 (note that
200000 - 600000 is not a valid value)
XVOL>membername
Note: The XVOL> keyword is applied during Archive processing only when the
candidate data sets reside on L0 disk (data set selection criteria
ARCHIVE_SOURCE=L0).
The XVOL> keyword specifies the name of the parameter library member that
contains a list of any combination of the following: volume serial numbers, ranges of volume serial
numbers, or masks of volume serial numbers of data sets that are not be captured from
the IDCAMS DCOLLECT process or from the DCOLLECT output flat
file.
Within the contents of member membername, the volume serial numbers that you
specify may start in any column and are terminated by three or more consecutive blank spaces. You
may specify volume serial numbers individually or as a range of values
(startvolser-endvolser) where startvolser and
endvolser are separated by a hyphen and no blank spaces.
Supported wildcard characters: Note that the IDCAMS DCOLLECT process does
not permit the exclusion of volumes, but the Archive process does.
You may not use wildcard characters in the value that you specify for
membername.
Within the contents of member membername:
You may use % and * in individual volser masks. The Archive
process translates % to * and then interprets the value string up
to the first *.
You may not use wildcard characters in the values that are specified for
startvolser or for endvolser.
Example values for membername:PRODVOLS, VOL15TST
Example values for masks specified in the contents of member
membername:PRD*, 1%%A2, 200000–600000 (note that
200000 - 600000 is not a valid value)
Rules for specifying criteria statements
The following rules apply to the specification of criteria statements:
You may code the statements in any sequence, with the exception
of the GROUP_NAME= statement. If you are specifying
a GROUP_NAME= statement, it must be coded as the
first statement of a criteria group.
You may code only one keyword and its corresponding value per statement. For example:
#DAYS_SINCE_CREATE=100–200
Valid
#DAYS_SINCE_CREATE=100–200#DAYS_SINCE_LASTUSED=50
Not valid
You may not include blank spaces on either side of the hyphen
when specifying a range of values. For example:
#DAYS_SINCE_CREATE=100–200
Valid
#DAYS_SINCE_CREATE=100 – 200
Not valid
#DAYS_SINCE_CREATE=100– 200
Not valid
EXPIRATION_DATE=2014.150–2014.300
Valid
EXPIRATION_DATE=2014.150 – 2014.300
Not valid
EXPIRATION_DATE=2014.150 –2014.300
Not valid
The hierarchy of the criteria statements is as follows:
TIER-1
GROUP_NAME=, ARCHIVE_SOURCE=
TIER-2
STORGRP=, STORGRP>
XSTORGRP=, XSTORGRP>
#DAYS_SINCE_LASTUSED=
#DAYS_SINCE_MIGRATED=
#DAYS_UNTIL_EXPIRATION=
#DAYS_SINCE_CREATE=
DSN=, DSN>
XDSN=, XDSN>
MGMTCLAS=, MGMTCLAS>
XMGMTCLAS=, XMGMTCLAS>
EXPIRATION_DATE=
MIGRATION_DATE=
VOL=, VOL>
XVOL=, XVOL>
Under a Tier-1 statement, one or more Tier-2 statements may
be coded. Each Tier-2 statement is compared as an AND within the sphere
of the Tier-1 statement.
In this example, L0 disk data sets with names that match ABC%.DE*.** and data
sets with names that match X*.D123*.HUK are selected as candidates for
GROUP1.
Note: If ARCHIVE_SOURCE=ML2 or the ARCHIVE_SOURCE=
statement were omitted from the CRITERIA DD statement, ML2 data sets with names
that match ABC%.DE*.** and data sets with names that match
X*.D123*.HUK are selected as candidates for GROUP1.
In this example, candidate records that have data set names
that match SYS*.CAT*.ONE.** or match the names or
patterns (or both) in parameter library member INCLDSN2 but do not match data set names that match SYS*.CAT1*.ONE.** and have a #DAYS_SINCE_CREATE= value of 200 and
a MIGRATION_DATE= value in the range 04/19/2009–06/30/2010
are selected as candidates for GROUP3.
In this example, L0 disk candidate records whose volume serial numbers match 999* or fall in the range AB0000-AB9999 are rejected as candidates for GROUP8.
At a minimum, one Tier-1 statement and one Tier-2 statement
must be coded for a candidate to be selected for processing.
For keywords that support value ranges, the values specified
are always internally organized so that the lower of the two value
specifications is compared first. For example, if #DAYS_SINCE_CREATE=300–20 is coded, before the statement is used for comparison, it is reorganized
as #DAYS_SINCE_CREATE=20–300.
To code comment statements, code an asterisk (*) in the first position within the statement.