Save DLO using BRM (SAVDLOBRM)

The Save Document Library Object using BRM (SAVDLOBRM) command saves a copy of the specified document, folders or distribution objects (mail).

Note:

When a folder is saved, the folder object is saved along with the documents contained in that folder and the subfolders and documents in the subfolders and all successively nested folders and documents.
Distribution objects (mail) cannot be saved or restored for individual users. Mail can be saved only for all users.

Virtual tape media and devices can be used with this command. The following restrictions apply to the use of virtual media and virtual devices.

The Device (DEV) parameter is limited on only one device or *MEDCLS special value for serial operations.
Execute authority is required to the Load or Unload Image Catalog (LODIMGCLG) command.
*CHANGE authority is required to the image catalogs.
Execute (*X) authority is required to each directory in the image catalog path name.
Read, write, execute (*RWX) authority is required to each image file in the parent directory that will be loaded or mounted.
*USE authority is required to the virtual devices using the image catalogs.

To use this command, you must have the Backup Recovery and Media Services for iSeries, 5722-BR1, licensed program installed.

Restrictions:

If *SEARCH is specified for the Document library object (DLO) parameter, then *CUML or *INCR must be specified for the Type of save (SAVTYPE) parameter.
If *SEARCH is specified for the Document library object (DLO) parameter, then *NONE must be specified for the Omit folders (OMITFLR) parameter.
If *ANY is specified for the Folder (FLR) parameter, then *ALL or *SEARCH must be specified for the Document library object (DLO) parameter.
You must have authority to the SAVDLO command.
You must have *ALLOBJ or *SAVSYS special authority to use this command. Users that do not have *ALLOBJ or *SAVSYS special authority must:
- Have *ALL authority for each document or folder to be saved.
- Be enrolled as Document Interchange Architecture (DIA) users.
This command does not support the *MAIL choice found on the SAVDLO command, Document library object (DLO) parameter.
This command cannot be used while another job is running commands such as RCLDLO, SAVDLO, SAVDLOBRM, RSTDLO and RSTDLOBRM because exclusive use of internal objects may have been obtained by these commands.
Determining document or folder ownership does not include checking group profiles if one is associated with the specified user profile.
This command should not be used by control group *EXIT item processing as results will be unpredictable.

You can save data to a Tivoli Storage Manager (TSM) server using this command. To save data to a TSM server, the following conditions must be met:

Only user data can be saved to TSM servers. BRMS does not allow *IBM type libraries to be saved TSM servers. Also, BRMS does not allows IBM supplied libraries that are considered user data such as QGPL, QUSRBRM, or QUSRSYS libraries to be saved TSM media.
You can only specify only one device for the Device (DEV) parameter and this device must be of category *NET or *APPC.
You can specify DEV(*MEDCLS) with the Location (LOC) parameter to identify the *NET or *APPC category device to be used.
You can specify a media policy name for the Media policy (MEDPCY) parameter if the media policy uses specifies *ADSM (TSM server) for the Media class attribute. Alternately you can specify MEDPCY(*NONE) in which can you must also specify *ADSM for the Media class (MEDCLS), Move policy (MOVPCY) and Secure volume (VOLSEC) parameters.
The Sequence number (SEQNBR) parameter must be *END.
The Save to save file (SAVF), Mark volumes for duplication (MARKDUP) and Mark history for duplication (MARKHST) parameters must be *NO. If *MEDPCY is specified for these parameters, then the respective value for the Save to save file attribute, Mark volumes for duplication attribute and Mark history for duplication attribute of the media policy specified by the Media policy (MEDPCY) parameter must be *NO.
The Required volumes (MINVOL) parameter must be *NONE. If SAVF(*MEDPCY) is specified then the value for the Required volumes attribute of the media policy specified by the Media policy (MEDPCY) parameter must be *NONE.
If *SYNCLIB is specified for the Save active (SAVACT) parameter each library is saved individually rather than as a group. Synchronization messages are therefore sent individually for each library rather than for the libraries as a group and synchronization is only within one library, not across libraries.

Parameters

Keyword	Description	Choices	Notes
DLO	Document library object	Character value, ALL, SEARCH	Required, Positional 1
FLR	Folder	Single values: ANY, NONE Other values (up to 100 repetitions): Character value	Optional, Positional 4
DEV	Device	Single values: NONE Other values (up to 4 repetitions): Name, MEDCLS	Required, Positional 2
MEDPCY	Media policy	Name, NONE, SYSPCY	Required, Positional 3
SAVACT	Save active	NO, YES	Optional
OBJDTL	Retain object detail	NO, YES	Optional
CTLGRP	Control group	Name, NONE, ARCGRP, BKUGRP, SYSGRP, *SYSTEM	Optional
SAVTYPE	Type of save	FULL, CUML, *INCR	Optional
ENDOPT	End of tape option	REWIND, LEAVE, *UNLOAD	Optional
USEOPTBLK	Use optimum block size	BKUPCY, DEV, NO, YES	Optional
SEQNBR	Sequence number	1-16777215, *END	Optional
TGTRLS	Target release	Character value, *CURRENT	Optional
CLEAR	Clear	NONE, AFTER, *ALL	Optional
DTACPR	Data compression	DEV, NO, *YES	Optional
COMPACT	Data compaction	DEV, NO	Optional
OMITFLR	Omit folders	Single values: NONE, BKUPCY Other values (up to 100 repetitions): Character value	Optional
ASP	Auxiliary storage pool	Character value, ANY, SYSTEM	Optional
REFDATE	Reference date	Character value, *REF	Optional
REFTIME	Reference time	Character value, *REF	Optional
EXPDATE	Expiration date	Date, MEDPCY, PERM	Optional
MOVPCY	Move policy	Name, MEDPCY, ADSM, *NONE	Optional
MEDCLS	Media class	Character value, MEDPCY, ADSM, *SYSPCY	Optional
LOC	Location	Name, MEDPCY, ANY, *HOME	Optional
SAVF	Save to save file	MEDPCY, NO, *YES	Optional
SAVFASP	Save file ASP	Character value, MEDPCY, SYSTEM	Optional
SAVFEXP	Retain save files	Date, MEDPCY, NONE, *PERM	Optional
MAXSTG	ASP storage limit	1-99, *MEDPCY	Optional
VOLSEC	Secure volume	MEDPCY, ADSM, NO, YES	Optional
MINVOL	Required volumes	1-9999, MEDPCY, NONE	Optional
MARKDUP	Mark volumes for duplication	MEDPCY, NO, *YES	Optional
MARKHST	Mark history for duplication	MEDPCY, NO, *YES	Optional

Top

Folder (FLR)

Specifies the folder or generic folder name in which the objects specified on the Document library object (DLO) parameter are located.

Single values

*ANY

Document library objects can be saved from any folder. Consider the following when using the FLR parameter:

FLR(*ANY) is not valid when DLO(document-name) is specified.
When SAVDLOBRM DLO(*ALL) FLR(*ANY) is specified, the following are saved:
- All documents
- All folders
- All distribution objects (mail)

*NONE

The documents saved are not in any folder. FLR(*NONE) is valid only when DLO(*ALL) is specified.

Other values (up to 100 repetitions)

generic*-folder-name

Specify the generic name. A generic name is a character string of one or more characters followed by an asterisk (*): for example, ABC*. The asterisk (*) substitutes for any valid characters. A generic name specifies all folders with names that begin with the generic prefix, for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete folder name.

folder-name

Specify the name of the folder that you want to save.

Note: Folder names that have upper and lower case characters as part of the name must be enclosed in single quotation marks.

  A few examples are:
Folder Name                   Entry in SAVDLOBRM
Folder                           'Folder'
FOLDER                            FOLDER
FOLDER/SUBFOLDER                  FOLDER/SUBFOLDER

Device (DEV)

Specifies the device or devices to be used by this command.

Single values

*MEDCLS: Devices for this command are selected based on device types that support the density for the media class specified in the media policy. The *MEDCLS special value is used for devices that are part of a device pool, such as several systems that share a single or set of devices. Devices are specified in the Work with Devices display.

Note: If you want to use more than one device for a serial save operation, the *MEDCLS can be repeated up to four times, once for each device used, except for virtual tape devices which is limited to a single value.

Other values (up to 4 repetitions)

Specifies the name of the device to be used for the save operation. The device name must already be in the BRMS device table.

You can save data to a TSM (ADSM) server using this command. You can only specify one TSM type server in the list of devices or *MEDCLS, which must select a TSM server. The device type can either be *APPC, which supports SNA network protocol, or *NET, which supports TCPIP protocol.

This is a required parameter.

You can enter multiple values for this parameter. If you are on an entry display and you need additional entry fields to enter these multiple values, type a plus sign (+) in the entry field opposite the phrase "+ for more" and press the Enter key.

Single values

*MEDCLS: Any device that supports the media class specified in the media policy can be used for this save operation.

Other values

*NONE: There is no device for this save operation. Save files are used to store the saved data.
device-name: Specify the names of one or more devices used for the save operation. If you are using more than one device (up to a maximum of four), specify the names of the devices in the order in which they are used.
Note: Only one media library device or one virtual tape device can be specified.

Media policy (MEDPCY)

Specifies the media policy that you want to use with this save command.

Media policies are used to determine:

The type of retention to use, such as days, date or version, for media used in control group processing.
The move policy to use with this media policy.
The media class to use.
Whether or not to use save files.
The type of retention to use, such as days or date for save files created in control group processing.

The media policy you specify must be a media policy that is in the BRMS media policy table.

This a required parameter.

*SYSPCY: The media policy specified in the system policy is assigned to output volumes from this save operation.
*NONE: No media policy is specified for this save operation. Media policy values must be supplied with the save command for each parameter that has a default of *MEDPCY.
Note: If you specify *NONE, and you are saving data to a TSM (ADSM) server, you must specify the *ADSM special value in the MOVPCY, MEDCLS and VOLSEC parameters which are part of the media policy values for this save operation. You must still supply the additional media policy values for the remaining parameters with *MEDPCY as the default. The TSM management class STANDARD, and the TSM node *LCL, are used as default values for the save operation.
media-policy: Specify the name of the media policy that you want to use with this save operation.

Control group (CTLGRP)

Specifies the name of the control group that you want to associate with the objects saved by this command. The control group name is stored with the media information and can be used with the Control group (CTLGRP) parameter on other BRMS commands to filter the media information or recover saved objects by control group.

Note: None of the attributes of the control group are used for the save.

If you are using version control for the items you are saving, this save operation will be recorded as part of the specified version control. Version control is specified in the media policy associated with this control group and can be reviewed by using the Work with Media Policies display.

*NONE: Do not specify a control group name for this command.
*ARCGRP: The name of the default archive control group.
Note: The BRMS Advanced feature (Option 2) is required to use this value.
*BKUGRP: The name of the default backup control group used to save all user data.
*SYSGRP: The name of the default system control group used to save all system data.
*SYSTEM: The name of the default system control group used to save the entire system.
control-group-name: Specify the name of the control group to be assigned to the items you are saving.

End of tape option (ENDOPT)

Specifies, when tape is used, what positioning operation is automatically done on the volume after the save operation ends. If more than one volume is included, this parameter applies only to the last volume used; all other volumes are rewound and unloaded when the end of the volume is reached.

Note: If no objects are saved the volume is not opened and the ENDOPT parameter is ignored.

If you specify *LEAVE and the device is a shared device, the device will not be varied off after the save operation. If you specify *LEAVE and the device is not a shared device, the device will be varied off after the save operation.

*REWIND: The volume is rewound, but not unloaded.
*LEAVE: The volume does not rewind or unload after the operation ends. It remains at the current position on the device.
*UNLOAD: The volume is automatically rewound and unloaded after the save operation ends.

Use optimum block size (USEOPTBLK)

Specifies whether or not the optimum block size is used for the save operation.

*BKUPCY: Use the value from the backup policy for the Use optimum block size parameter.

*DEV: Use the value specified on the Work with Devices display for the Use optimum block size parameter.

*NO: The optimum block size supported by the device is not used. Save commands use the default block size supported by all device types. The tape volume can be duplicated to any media format using the Duplicate Tape (DUPTAP) command or the Duplicate Media using BRM (DUPMEDBRM) command.

*YES

The optimum block size supported by the device is used for Save commands. If the block size used is larger than a block size that is supported by all device types then:

Performance may improve.
The tape file that is created is only compatible with a device that supports the block size used. Commands such as Duplicate Tape (DUPTAP) and Duplicate Media using BRM (DUPMEDBRM) do not duplicate files unless the files are being duplicated to a device which supports the same block size that was used.
The value for the Data Compression (DTACPR) parameter is ignored.

Target release (TGTRLS)

Specifies the release of the operating system on which you intend to restore the objects being saved.

*CURRENT: The objects are to be restored on a system that is running the same release of the operating system currently running on your system. For example, if V5R2M0 is running on the system, *CURRENT means that you intend to restore the objects on a system with V5R2M0 installed. The objects can also be restored on a system with any subsequent release of the operating system installed.

*PRV: The objects are to be restored on a system that is running on the previous release with modification level 0 of the operating system. For example if V5R2M0 is running on your system, *PRV means you intend to restore the objects on a system with V5R1M0 installed. The object can also be restored on a system with any subsequent release of the operating system installed.
Note: Not all objects can be targeted to another release. Objects that are new to a release typically cannot be saved to a previous release.

target-release

Specify the release in the format VxRxMx, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V5R2M0 is version 5, release 2, modification level 0.

The objects can be restored on a system with the specified release or with any subsequent release of the operating system installed.

Note: Not all objects can be targeted to another release. Objects that are new to a release typically cannot be saved to a previous release.

Valid values depend on the current version, release, and modification level, and they change with each new release. If you specify a release-level that is earlier than the earliest release level supported by this command, an error message is sent indicating the earliest supported release.

Clear (CLEAR)

Specifies whether uncleared volumes or save files encountered during the save operation are automatically cleared.

*NONE: None of the uncleared volumes or save files encountered during the save operation are automatically cleared. If the save operation cannot proceed because an uncleared volume is encountered, an inquiry message is sent to the operator, allowing the ending of the save operation, or specifying that the currently selected volume be cleared so the operation can continue.
If a save file is not cleared, the inquiry message is sent to the work station message queue for an interactive job, or to the operator for a batch job. All volumes used to perform the save operation should be cleared, or the save file must be empty, before the save command is issued.
*AFTER: All the uncleared volumes after the initial volume are automatically cleared. This option is not valid for save or restore operations to a save file. If the operation cannot proceed because the first volume is uncleared, an inquiry message is sent to the system operator, allowing him to end the operation or to specify that the currently selected volume be cleared so the operation can continue.
*ALL: All the uncleared volumes or save files encountered during the save operation are automatically cleared. If tapes are used and a sequence number is specified, the volume is cleared and, starting with that sequence number, all volumes following the first volume are cleared.

Data compression (DTACPR)

Specifies whether data compression is used.

*DEV

If the device has the hardware compression feature installed, processing proceeds as if DTACPR(*YES) is specified. If the compression feature is not installed or save data is written to a save file, processing proceeds as if DTACPR(*NO) is specified.

Note: If *DEV is specified on both the Data compression (DTACPR) parameter and the Data compaction (COMPACT) parameter, only device data compaction is performed if device data compaction is supported on the device. Otherwise, data compression is performed if supported on the device.

If *YES is specified on the Data compression (DTACPR) parameter and *DEV is specified on the Data compaction (COMPACT) parameter, both device data compaction and device data compression are performed if supported on the device.

*NO

No data compression is performed.

*YES

If the save is to tape and the target device supports compression, hardware compression is performed. If device compression is not supported, or if the save data is written to a save file, software compression is performed. If the save is running while other jobs on the system are active and software compression is used, the overall system performance can be affected.

Omit folder (OMITFLR)

Specifies the names of one or more folders, or the generic names of each group of folders, to be excluded from the save operation.

Single values

*NONE: No folders are excluded from the save operation.

Other values (up to 100 repetitions)

*BKUPCY: The folders that are to be excluded are specified in the backup policy.
generic*-folder-name: Specify the generic name. A generic name is a character string of one or more characters followed by an asterisk (*): for example, ABC*. The asterisk (*) substitutes for any valid characters. A generic name specifies all folders with names that begin with the generic prefix, for which the user has authority. If an asterisk is not included with the generic (prefix) name, the system assumes it to be the complete folder name.
folder-name: Specify the name of a folder that you want to omit from this save operation.

Auxiliary storage pool (ASP)

Specifies the system (1) or basic user auxiliary storage pool (2-32) of the document library object to be saved.

*ANY: The objects to be saved reside in the system (1) or basic user auxiliary storage pool (2-32). When *ALL is specified on the DLO parameter, all document library objects on the system are saved.
*SYSTEM: The objects to be saved reside in the system (1) auxiliary storage pool. All document library objects in basic user auxiliary storage pools (2-32) are ignored.
auxiliary-storage-pool-name: Specify the name of the system (1) or basic user auxiliary storage pool (2-32) whose objects you want to save. All document library objects in other auxiliary storage pools are ignored.
auxiliary-storage-pool-number: Specify the number of the system (1) or basic user auxiliary storage pool (2-32) whose objects you want to save. All document library objects in other auxiliary storage pools are ignored. The number specified must designate an existing auxiliary storage pool that contains document library objects.

Note: Document library objects are not supported for UDFS, primary and secondary auxiliary storage pools.

Move policy (MOVPCY)

Specifies the move policy that you want to use for output volumes created as a result of this save operation.

If this save operation that you are performing is saving data to a device of category *NET or *APPC, you must specify the special value *ADSM (TSM server) for the MOVPCY parameter, since a TSM server controls the use of media in this case, not BRMS.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*ADSM: Media movement is controlled by TSM server specifications.
*NONE: There is not a move policy associated with the output volumes that are created as a result of this save operation.
move-policy: Specify a move policy that will be assigned to output volumes from this save operation.

Media class (MEDCLS)

Specifies the media class that you want to use for selection of output volumes used in this save operation.

If this save operation that you are performing is saving data to a device of category *NET or *APPC, you must specify the special value *ADSM (TSM server) for the MEDCLS parameter, since a TSM server controls the use of media in this case, not BRMS.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*ADSM: The save operation uses media that is selected and controlled by TSM server specifications.
*NONE: There is not a media class associated with the output volumes that are selected for this save operation.
*SYSPCY: The value for the media class in the system policy will used to select output volumes for this save operation.
media-class: Specify a media class that will be used to select output volumes for this save operation.

Save file ASP (SAVFASP)

Specifies the system (1) or basic user auxiliary storage pool (2-32) to which a save file is created as a result of this save operation.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*SYSTEM: The save file is saved to the system (1) auxiliary storage pool.
save-file-ASP-name: Specify the name of the auxiliary storage pool to which you are saving the save file.
save-file-ASP-number: Specify the system (1) or basic user auxiliary storage pool number (2-32) for the save file that is created as a result of the save operation.

Note: UDFS, primary and secondary auxiliary storage pools are not supported for this parameter.

Secure volume (VOLSEC)

Specifies whether you want to apply volume security to volumes in this media class. Volumes that are secured can only be read by users with the special authorities *ALLOBJ or *SAVSYS.

If the save operation that you are performing is saving data to a device of category *NET or *APPC, you must specify the special value *ADSM (TSM server) for the VOLSEC parameter, since a TSM server controls volume security in this case, not BRMS

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*ADSM: Volume security is controlled by TSM server specifications.
*NO: Volume security has not been applied to this media class. Volumes that do not have volume security can be read by anyone.
*YES: Only users with special authorities *ALLOBJ or *SAVSYS can read media volumes in this media class.

Require volumes (MINVOL)

Specifies the minimum number of expired volumes that must be present before any save can be done using this media policy. The value can also be checked by user jobs using the Check Expired Media for BRM (CHKEXPBRM) command.

Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NONE in this parameter. If you specify MINVOL(*MEDPCY), then the value of the Required volumes field in the referenced media policy must be *NONE.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NONE: There is no check done to determine the minimum number of required volumes before a save operation begins.
number-of-volumes: Specify the number of expired media volumes that must be available before any BRMS save operation will begin. The number can range from 1 to 9999.

Mark volumes for duplication (MARKDUP)

Specifies whether media volumes will be marked for duplication. When *YES is selected, all volumes used during a save operation are marked for duplication. You can use VOL(*SEARCH) on the Duplicate Media using BRM command to duplicate the saved items after the save has completed.

Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NO in this parameter. If you specify MARKDUP(*MEDPCY), then the value of the Mark for duplication attribute in the referenced media policy must be *NO.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NO: Volumes written to during a save operation will not be marked for duplication.
*YES: Volumes written to during the save operation will be marked for duplication.

Mark history for duplication (MARKHST)

Specifies whether history items will be marked for duplication. When *YES is selected, all history items created during a save operation are marked for duplication. You must use VOL(*SCHHST) on the Duplicate Media using BRM command to duplicate the saved items.

Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NO in this parameter. If you specify MARKHST(*MEDPCY), then the value of the Mark history for duplication attribute in the referenced media policy must be *NO.

*MEDPCY: The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
*NO: History items created during the save operation will not be marked for duplication.
*YES: History items created during the save operation will be marked for duplication.

Examples

Example 1: Performing a Save of All DLO's

SAVDLOBRM DLO(*ALL) FLR(*ANY) DEV(TAP01) MEDPCY(FULL)

This command saves all folders, documents and mail to device TAP01 using the media policy FULL.

Example 2: Saving Objects Changed After a Specific Date

SAVDLOBRM DLO(*SEARCH) DEV(TAP01) MEDPCY(FULL) REFDATE('1/1/03')

This command saves all documents changed after 1/1/03 to device TAP01.