Save Document Library Object (SAVDLO)

Where allowed to run: All environments (*ALL)
Threadsafe: No

The Save Document Library Object (SAVDLO) command saves a copy of the specified documents, folders, or distribution objects (mail).

Notes:

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. Specific folders can be saved individually using DLO(*FLRLVL).
Distribution objects (mail) cannot be saved or restored for individual users. Mail can be saved only for all users.
SAVDLO does not require a dedicated system; however, individual objects in use when the save is issued cannot be saved. To ensure all document library objects are saved, run this command when no document or folder activity is occurring on the system.

Restrictions:

You must have all object (*ALLOBJ) or save system (*SAVSYS) special authority to use the following parameter combinations on this command:
- DLO(*ALL) FLR(*ANY)
- DLO(*CHG)
- DLO(*MAIL)
- DLO(*SEARCH) OWNER(*ALL)
- DLO(*SEARCH) OWNER(user-profile-name)
where the user profile name specified is not the user profile name of the user issuing the SAVDLO command.
If you do not have *ALLOBJ or *SAVSYS special authority, you must:
- Have all (*ALL) authority for each document or folder to be saved
- Be enrolled as a Document Interchange Architecture (DIA) user
Determining document or folder ownership does not include checking group profiles if one is associated with the specified user profile.
When using the OUTFILE parameter to save to an existing database file, you must have execute authority to the output file library.

Top

Parameters

Keyword	Description	Choices	Notes
DLO	Document library object	Single values: ALL, SEARCH, CHG, SYSOBJNAM, DOCL, MAIL, FLRLVL Other values (up to 300 repetitions): Character value*	Required, Positional 1
FLR	Folder	Single values: ANY, NONE Other values (up to 300 repetitions): Character value	Optional
DEV	Device	Single values: SAVF Other values (up to 4 repetitions): Name*	Required, Positional 2
SRCHTYPE	Search type	DOC, ALL	Optional
CHKFORMRK	Check for mark	NO, YES	Optional
CHKEXP	Expiration date	Date, NO, CURRENT	Optional
CRTDATE	Creation date	Element list	Optional
	Element 1: Starting time and date	Element list
	Element 1: Starting time	Time, *AVAIL
	Element 2: Starting date	Date, BEGIN, CURRENT
	Element 2: Ending time and date	Element list
	Element 1: Ending time	Time, *AVAIL
	Element 2: Ending date	Date, *END
DOCCLS	Document class	Character value, *ANY	Optional
OWNER	Owner profile	Name, CURRENT, ALL	Optional
REFCHGDATE	Last changed date	Date, ANY, SAVDLOALL	Optional
REFCHGTIME	Last changed time	Time, *ANY	Optional
SYSOBJNAM	System object name	Values (up to 300 repetitions): Name	Optional
DOCL	Document list	Character value, *NONE	Optional
VOL	Volume identifier	Single values: MOUNTED Other values (up to 75 repetitions): Character value*	Optional
SEQNBR	Sequence number	1-16777215, *END	Optional
EXPDATE	File expiration date	Date, *PERM	Optional
ENDOPT	End of media option	REWIND, LEAVE, *UNLOAD	Optional
LABEL	Label	Character value, *GEN	Optional
USEOPTBLK	Use optimum block	YES, NO	Optional
OPTFILE	Optical file	Path name, *	Optional
SAVF	Save file	Qualified object name	Optional
	Qualifier 1: Save file	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
OMITFLR	Folders to omit	Single values: NONE Other values (up to 300 repetitions): Character value*	Optional
OUTPUT	Output	NONE, PRINT, *OUTFILE	Optional
OUTFILE	File to receive output	Qualified object name	Optional
	Qualifier 1: File to receive output	Name
	Qualifier 2: Library	Name, LIBL, CURLIB
OUTMBR	Output member options	Element list	Optional
	Element 1: Member to receive output	Name, *FIRST
	Element 2: Replace or add records	REPLACE, ADD
CLEAR	Clear	NONE, AFTER, ALL, REPLACE	Optional
STG	Storage	KEEP, DELETE, *FREE	Optional
DTACPR	Data compression	DEV, NO, YES, LOW, MEDIUM, HIGH	Optional
COMPACT	Data compaction	DEV, NO	Optional
CMDCHRID	Command character identifier	Single values: SYSVAL, DEVD Other values: Element list	Optional
	Element 1: Graphic character set	Integer
	Element 2: Code page	Integer
TGTRLS	Target release	CURRENT, PRV, V5R2M0, V5R3M0, V5R4M0	Optional
SAVACT	Save active	NO, YES	Optional
SAVACTWAIT	Save active wait time	0-99999, 120, *NOMAX	Optional
ASP	ASP number	1-32, *ANY	Optional

Top

Document library object (DLO)

Specifies the document library objects to save. To save a folder, DLO(*ALL) must be specified.

This is a required parameter.

Single values

*ALL

All document library objects further qualified by the FLR parameter are to be saved. Specifying DLO(*ALL) FLR(*ANY) saves all document library objects.

*SEARCH

All document library objects that meet the specified search values are saved. Search values are specified by using the following parameters:

Folder (FLR) parameter.
Check for mark (CHKFORMRK) parameter.
Expiration date (CHKEXP) parameter.
Creation date (CRTDATE) parameter.
Document class (DOCCLS) parameter.
Owner profile (OWNER) parameter.
Last changed date (REFCHGDATE) parameter.
Last changed time (REFCHGTIME) parameter.

Note: Folders are saved only if SRCHTYPE(*ALL) is specified.

*CHG

All documents created or changed and all folders created since the last complete save operation and all mail is saved.

*SYSOBJNAM

The documents with the system object names specified for the System object name (SYSOBJNAM) parameter are saved.

*DOCL

The list of documents referred to in a document list specified for the Document list (DOCL) parameter is saved.

*MAIL

The distribution objects and documents referred to by a mail log are saved.

*FLRLVL

The folders specified for the Folder (FLR) parameter and documents in the folders are saved. Subfolders are not saved.

Other values (up to 300 repetitions)

document-name: Specify the user-assigned names of the documents that are saved. All documents specified must be in the same folder and that folder must be specified for the Folder (FLR) parameter.

Top

Folder (FLR)

Specifies the name of the folder to save.

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 one of the following is specified:
- DLO(*DOCL)
- DLO(*FLRLVL)
- DLO(document-name)
FLR(*ANY) is required when one of the following is specified:
- DLO(*CHG)
- DLO(*SYSOBJNAM)
- DLO(*MAIL)
- DLO(*SEARCH) SRCHTYPE(*ALL)
When SAVDLO 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 one of the following is specified:

DLO(*ALL)
DLO(*SEARCH) SRCHTYPE(*DOC)

Other values (up to 300 repetitions)

generic-folder-name

Specify a 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 objects 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 object name.

folder-name

Specify the user-assigned name of the folder in which the documents to be saved are located. The folder name can be a maximum of 63 characters in length.

Folder objects specified here are saved only when DLO(*ALL) or DLO(*FLRLVL) is specified.
FLR(folder-name) is not valid when one of the following is specified:
- DLO(*SYSOBJNAM)
- DLO(*MAIL)
- DLO(*SEARCH) SRCHTYPE(*ALL)
Only one folder name can be specified when one of the following is specified:
- DLO(*DOCL)
- DLO(*SEARCH) SRCHTYPE(*DOC)
- DLO(document-name)

Top

Device (DEV)

Specifies the name of the device used for the save operation. The device name must already be known on the system by a device description.

This is a required parameter.

Single values

*SAVF: The save operation is done using the save file specified for the Save file (SAVF) parameter.

Other values

optical-device-name: Specify the name of the optical device used for the save operation.

tape-media-library-device-name: Specify the name of the tape media library device used for the save operation.

tape-device-name: Specify the names of one or more tape devices used for the save operation. If a virtual tape device is used, it must be the only device specified. If multiple tape devices are used, they must have compatible media formats and their names must be specified in the order in which they are used. Using more than one tape device permits one tape volume to be rewound and unloaded while another tape device processes the next tape volume.

Top

Search type (SRCHTYPE)

Specifies the type of objects for which to search. This parameter is valid only if *SEARCH is specified for the Document library object (DLO) parameter.

*DOC: Only documents are to be searched and saved.
*ALL: Documents and folders are to be searched and saved.

Top

Check for mark (CHKFORMRK)

Specifies whether documents marked for storage are saved. This parameter is valid only when *SEARCH is specified for the Document library object (DLO) parameter and *DOC is specified for the Search type (SRCHTYPE) parameter.

*NO

Documents that meet the other search values for this save operation are saved regardless of whether they are marked for storage.

*YES

Only those documents that meet the other search values and are also marked for storage are saved. Documents may be marked:

Keep
Free
Delete

Top

Expiration date (CHKEXP)

Specifies that all documents with an expiration date before the specified date are to be saved. The expiration date is assigned by the user when a document is created to specify when the document is no longer needed. This parameter is valid only when *SEARCH is specified for the Document library object (DLO) parameter and *DOC is specified for the Search type (SRCHTYPE) parameter.

*NO: The expiration date is ignored.
*CURRENT: All documents with an expiration date before today's date are saved.
date: Specify a document expiration date. All documents with an expiration date before this date are saved.

Top

Creation date (CRTDATE)

Specifies that documents and folders that have a creation date during the time period specified are to be saved. The time period is specified by a starting time and date and an ending time and date. This parameter is valid only when *SEARCH is specified for the Document library object (DLO) parameter. The time period is specified as follows:

((start-time  start-date) (end-time  end-date))

Element 1: Starting time and date

Element 1: Starting time

Use one of the following to specify the starting time. Documents must have been created after this time to be selected. Documents created before this time are not selected.

*AVAIL

Documents and folders filed at any time are eligible for saving.

time

Specify the starting time. When the starting time is used as a search value, the starting date must not be *BEGIN. The starting-time must be the same as the value specified for the Last changed time (REFCHGTIME) parameter when the REFCHGTIME parameter is specified. The time can be specified with or without a time separator:

Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds.
With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.

Element 2: Starting date

Use one of the following to specify the starting date. Documents must have been created on or after this date to be saved. Documents created before this date are not saved.

*BEGIN: Documents and folders are saved regardless of the creation date associated with the object.
*CURRENT: Only documents and folders filed on today's date, after the starting time (if specified), are selected.
date: Specify a starting date for the document creation date time period. The date must be entered in the job date format. The start date must be the same as the value specified for the Last changed date (REFCHGDATE) parameter when the REFCHGDATE parameter is specified.

Element 2: Ending time and date

Element 1: Ending time

Use one of the following to specify the ending time. Documents must have been created before this time to be saved. Any documents created after the specified time are not saved.

*AVAIL: Documents and folders filed at any time are selected for saving.
time: Specify the ending time. When the ending time is to be used as a search value, the ending date must not be *END. See the description of starting-time for details about how time can be specified.

Element 2: Ending date

Use one of the following to specify the ending date. Documents must have been created on or before this date to be saved. Documents created after this date are not saved.

*END: Documents and folders filed on any date are selected. The ending time is not allowed when *END is specified.
date: Specify the ending date for the document creation date time period. Documents created on or before this date are saved. The date must be specified in job date format.

Top

Document class (DOCCLS)

Specifies the class of documents to be saved. The class is assigned by the user when the document is created. This parameter is valid only when *SEARCH is specified for the Document library object (DLO) parameter and *DOC is specified for the Search type (SRCHTYPE) parameter.

Note: Although document classes are user-assigned, double-byte character set (DBCS) data cannot be specified on this parameter.

*ANY: The document class is not used to select documents for saving.
character-value: Specify the document class, ranging from 1 through 16 characters, used to select documents for saving.

Top

Owner profile (OWNER)

Specifies the owner of the documents and folders to be saved. This parameter is valid only when *SEARCH is specified for the Document library object (DLO) parameter.

*CURRENT: Documents and folders owned by the current requester are saved.
*ALL: This parameter is not used to select documents and folders for saving. You must have all object (*ALLOBJ) or save system (*SAVSYS) special authority if *ALL is specified.
name: Specify the name of the user profile that owns the documents and folders to be saved. All documents and folders owned by this user and that meet the other search values specified are saved. *ALLOBJ or *SAVSYS special authority is required if a user profile is selected other than the user profile of the user issuing this command.

Top

Last changed date (REFCHGDATE)

Specifies the date after which the folders that are created and the documents that are changed or created are to be saved. The change date is updated when the document content or description is changed. This parameter is valid only when *SEARCH is specified for the Document library object(DLO) parameter.

*ANY: No reference change date is specified. Documents are saved regardless of the date they were created or changed. Folders are saved regardless of the date they were created.
*SAVDLOALL: Folders that have been created and documents created or changed since that last complete save operation are saved.
date: Specify the date after which the created folders or the created or changed documents are saved.

Top

Last changed time (REFCHGTIME)

Specifies the time, relative to the date specified for the REFCHGDATE parameter, after which the folders that are created and the documents that are changed or created are to be saved. The change time is updated when the document content or description is changed. This parameter is valid only when *SEARCH is specified for the Document library object (DLO) parameter.

*ANY

No time is specified. The documents are saved regardless of the time they were created or changed. Folders are saved regardless of the time they were created.

time

Specify the time after which the created folders or the created or changed documents are saved.

The time can be specified with or without a time separator:

Without a time separator, specify a string of 4 or 6 digits (hhmm or hhmmss) where hh = hours, mm = minutes, and ss = seconds.
With a time separator, specify a string of 5 or 8 digits where the time separator specified for your job is used to separate the hours, minutes, and seconds. If you enter this command from the command line, the string must be enclosed in apostrophes. If a time separator other than the separator specified for your job is used, this command will fail.

Top

System object name (SYSOBJNAM)

Specifies the system object names of the documents that are saved, when *SYSOBJNAM is specified for the Document library object (DLO) parameter.

Single values

*NONE: A system object name is not specified.

Other values (up to 300 repetitions)

name: Specify the system object name of the document to be saved. A full ten characters must be specified.

Top

Document list (DOCL)

Specifies a list of documents to be saved. The document list must be in a folder. The name of the folder must be specified using the Folder (FLR) parameter. You must have use (*USE) authority to the folders containing the documents in the document list.

Note: A document list must be the result of a local search, not a remote search.

*NONE: No document list is saved.
character-value: Specify the document list to be saved.

Top

Volume identifier (VOL)

Specifies the volume identifiers of the volumes, or the cartridge identifiers of tapes in a tape media library device, on which the data is saved. The volumes must be placed in the device in the same order as specified for this parameter.

Single values

*MOUNTED: The data is saved on the volumes placed in the device. For a media library device, the volume to be used is the next cartridge in the category mounted by the Set Tape Category (SETTAPCGY) command.
Note: This value cannot be specified when using an optical media library device.

Other values (up to 75 repetitions)

character-value: Specify the identifiers of one or more volumes in the order in which they are placed in a device and used to save the data.

Top

Sequence number (SEQNBR)

Specifies, when tape is used, the sequence number to use as the starting point for the save operation.

*END: The save operation begins after the last sequence number on the first tape. If the first tape is full, an error message is issued and the operation ends.
1-16777215: Specify the sequence number of the file to be used for the save operation.

Top

File expiration date (EXPDATE)

Specifies the expiration date of the file created by the save operation. If a date is specified, the file is protected and cannot be overwritten until the specified expiration date.

Notes:

This parameter is valid for tape and optical files.
Specifying this parameter does not protect against a later save operation specifying CLEAR(*ALL).

*PERM: The file is protected permanently.
date: Specify the date when protection for the file ends.

Top

End of media option (ENDOPT)

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

Note: This parameter is valid only if a tape or optical device name is specified for the DEV parameter. For optical devices, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be ignored.

*REWIND: The tape is automatically rewound, but not unloaded, after the operation has ended.

*LEAVE: The tape does not rewind or unload after the operation ends. It remains at the current position on the tape drive.

*UNLOAD: The tape is automatically rewound and unloaded after the operation ends. Some optical devices will eject the volume after the operation ends.

Top

Label (LABEL)

Specifies the name that identifies the data file on the tape used for the save. If the LABEL parameter is used the label must be specified on the restore command.

*GEN: The file label is created by the system.
character-value: Specify the data file identifier that is used as the label for the data file used for the save operation. A maximum of 17 characters can be specified.

Top

Use optimum block (USEOPTBLK)

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

Note: Specifying USEOPTBLK(*YES) may result in a tape that can be duplicated only to a device that supports the same block size.

*YES

The optimum block size supported by the device is used for Save commands. If the block size that is 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) 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 DTACPR parameter is ignored.

*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.

Top

Optical file (OPTFILE)

Specifies the path name of the optical file that is used for the save operation, beginning with the root directory of the volume.

For more information on specifying path names, refer to "Object naming rules" in the CL concepts and reference topic in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter.

*: The system generates an optical file name in the root directory of the optical volume.
'optical-directory-path-name/*': The system generates an optical file name in the specified directory of the optical volume.

'optical-file-path-name': Specify the path name of the optical file.

Top

Save file (SAVF)

Specifies the save file that is used to contain the saved data. The save file must be empty, unless *ALL is specified for the Clear (CLEAR) parameter.

Note: A value must be specified for this parameter if *SAVF is specified for the Device (DEV) parameter.

Qualifier 1: Save file

name: Specify the name of save file to be used.

Qualifier 2: Library

*LIBL: All libraries in the library list for the current thread are searched until the first match is found.

*CURLIB: The current library for the thread is used to locate the save file. If no current library entry exists in the library list, the QGPL library is used.
name: Specify the name of the library where the save file is located.

Top

Folders to omit (OMITFLR)

Specifies the names of one of 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 300 repetitions)

generic-folder-name: Specify a 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 to be excluded from the save operation.

Top

Output (OUTPUT)

Specifies whether a list with information about the saved objects is created. The information can be printed with the job's spooled output or directed to a database file.

*NONE: No output listing is created.

*PRINT: The output is printed with the job's spooled output.

*OUTFILE: The output is directed to the database file specified for the File to receive output (OUTFILE) parameter.

: Note: You must specify a database file name for the File to receive output (OUTFILE) parameter when OUTPUT(*OUTFILE) is specified.

Top

File to receive output (OUTFILE)

Specifies the name and library of the database file to which the information about the document library objects is directed when *OUTFILE is specified for the Output (OUTPUT) parameter. If the file does not exist, this command creates a database file in the specified library. If a new file is created, the system uses QAOJSAVO in QSYS with a format name of QJSDLO as a model.

Qualifier 1: File to receive output

name: Specify the name of the database file to which output from the command is directed. If this file does not exist, it is created in the specified library.

Qualifier 2: Library

*LIBL: All libraries in the library list for the current thread are searched until the first match is found.

*CURLIB: The current library for the thread is used to locate the file. If no library is specified as the current library for the job, the QGPL library is used.

name: Specify the name of the library to be searched.

Top

Output member options (OUTMBR)

Specifies the name of the database file member to which the output is directed when *OUTFILE is specified for the Output (OUTPUT) parameter.

Element 1: Member to receive output

*FIRST: The first member in the file receives the output. If OUTMBR(*FIRST) is specified and the member does not exist, the system creates a member with the name of the file specified for the File to receive output (OUTFILE) parameter.
name: Specify the name of the file member that receives the output. If OUTMBR(member-name) is specified and the member does not exist, the system creates it.
If the member exists, you can add records to the end of the existing member or clear the existing member and add the records.

Element 2: Replace or add records

*REPLACE: The existing records in the specified database file member are replaced by the new records.
*ADD: The new records are added to the existing information in the specified database file member.

Top

Clear (CLEAR)

Specifies whether active data on the media is automatically cleared or replaced. Active data is any file on the media that has not expired. For saves to tape, clearing active data will make any files on the tape volume beyond the last file written by the save operation no longer accessible. For saves to optical, the files written by the save operation can be automatically replaced while other files on the volume remain active, or all active files can be automatically cleared. Clearing does not erase the data, it just makes the files no longer accessible.

Notes:

Clearing a tape does not initialize it. You should initialize tapes to a standard label format before the save command is issued by using the Initialize Tape (INZTAP) command and specifying a value for the NEWVOL parameter.
Clearing an optical volume does initialize it.
If a volume that is not initialized is encountered during the save operation, an inquiry message is sent and an operator can initialize the volume.

*NONE: None of the media is automatically cleared. If the save operation encounters active data on a tape volume or in a save file, an inquiry message is sent, allowing the operator to either end the save operation or clear the media. If the save operation encounters the specified optical file, an inquiry message is sent, allowing the operator to either end the save operation or replace the file.

*ALL: All of the media is automatically cleared.

If tapes are used and a sequence number is specified for the SEQNBR parameter, the first tape is cleared beginning at that sequence number. All tapes following that first tape are completely cleared. To clear the entire first tape, SEQNBR(1) must be specified.

*AFTER: All media after the first volume is automatically cleared. If the save operation encounters active data on the first tape volume, an inquiry message is sent, allowing the operator to either end the save operation or clear the media. If the save operation encounters the specified optical file on the first volume, an inquiry message is sent, allowing the operator to either end the save operation or replace the file.

: Note: The *AFTER value is not valid for save files.

*REPLACE: Active data on the media is automatically replaced. Optical volumes are not initialized. Other media is automatically cleared in the same way as the *ALL value.

Top

Storage (STG)

Specifies whether system storage occupied by the document being saved is kept, deleted, or freed after the save operation ends.

Note: STG(*DELETE) and STG(*FREE) are not valid when any of the following are specified:

DLO(*ALL) FLR(*ANY)
DLO(*SEARCH) CHKFORMRK(*YES)
DLO(*CHG)
DLO(*MAIL)
SAVACT(*YES)

*KEEP: The storage occupied by the document remains unchanged after the save operation.
*DELETE: The document object and all search terms are deleted from the system after the save operation.
*FREE: The document description and search terms remain on the system but the storage occupied by the document is deleted after the save operation. The document cannot be used until the document is restored to the system.

Top

Data compression (DTACPR)

Specifies whether data compression is used. If the save is running while other jobs on the system are active and software compression is used, the overall system performance may be affected.

Note: If *DEV is specified for both this 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 *YES is specified for this parameter and *DEV is specified for the COMPACT parameter, both device data compaction and device data compression are performed if supported on the device.

*DEV: If the save is to tape and the target device supports compression, hardware compression is performed. Otherwise, no data compression is performed.

*NO: No data compression is performed.
*YES: If the save is to tape and the target device supports compression, hardware compression is performed. If compression is not supported, or if the save data is written to optical media or to a save file, software compression is performed. Low software compression is used for all devices except optical DVD, which uses medium software compression.
*LOW: If the save operation is to a save file or optical, software data compression is performed with the SNA algorithm. Low compression is usually faster and the compressed data is usually larger than if medium or high compression is used.
Note: This value is not valid for tape.
*MEDIUM: If the save operation is to a save file or optical, software data compression is performed with the TERSE algorithm. Medium compression is usually slower than low compression but faster than high compression. The compressed data is usually smaller than if low compression is used and larger than if high compression is used.
Note: This value is not valid for tape.
*HIGH: If the save operation is to a save file or optical, software data compression is performed with the LZ1 algorithm. High compression is usually slower and the compressed data is usually smaller than if low or medium compression is used.
Note: This value is not valid for tape.

Top

Data compaction (COMPACT)

Specifies whether device data compaction is performed.

*DEV

Device data compaction is performed if the data is saved to tape and all tape devices specified for the Device (DEV) parameter support the compaction feature.

Note: If *DEV is specified for both the Data compression (DTACPR) parameter and this 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 for the DTACPR parameter and *DEV is specified for this parameter, both device data compaction and device data compression are performed if supported on the device.

*NO

Device data compaction is not performed.

Top

Command character identifier (CMDCHRID)

Specifies the character identifier (graphic character set and code page) for the data specified for the Document class (DOCCLS) parameter. The character identifier is related to the display device used to enter the document class.

Single values

*SYSVAL: The system determines the graphic character set and code page values for the command parameters from the QCHRID system value.

*DEVD: The system determines the graphic character set and code page values from the display device description where this command was entered. This option is valid only when entered from an interactive job. If this option is specified in a batch job, an error occurs.

Element 1: Graphic character set

1-32767: Specify the graphic character set to use.

Element 2: Code page

1-32767: Specify the code page to use.

Top

Target release (TGTRLS)

Specifies the release level of the operating system on which you intend to use the object being saved.

When specifying the target-release value, the format VxRxMx is used to specify the release, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V5R3M0 is version 5, release 3, modification 0.

Valid values depend on the current version, release, and modification level of the operating system, and they change with each new release. You can press F4 while prompting this command parameter to see a list of valid target release values.

*CURRENT: The object is to be restored to, and used on, the release of the operating system currently running on your system. The object can also be restored to a system with any subsequent release of the operating system installed.
*PRV: The object is to be restored to the previous release with modification level 0 of the operating system. The object can also be restored to a system with any subsequent release of the operating system installed.
character-value: Specify the release in the format VxRxMx. The object can be restored to a system with the specified release or with any subsequent release of the operating system installed.

Top

Save active (SAVACT)

Specifies whether an object can be updated while it is being saved.

*NO: Document library objects in use are not saved. Document library objects cannot be updated while being used.
*YES: Document library objects can be changed during the save request.
Note: Some applications update document library objects directly. The data is supplied to the application rather than saving the updates in a temporary file and then updating the DLOs. DLOs that are being updated directly (typically, those being updated by PC-based applications) will not be saved. See the Backup and Recovery information in the iSeries Information Center at http://www.ibm.com/eserver/iseries/infocenter for more information on using this parameter.

Top

Save active wait time (SAVACTWAIT)

Specifies the amount of time for an object that is in use, before continuing the save operation. If an object remains in use for the specified time, the object is not saved.

120: The system waits up to 120 seconds for each individual object to become available before continuing the save operation.
*NOMAX: No maximum wait time exists.
0-99999: Specify the number of seconds to wait for each individual object before continuing the save operation.

Top

ASP number (ASP)

Specifies the number of the auxiliary storage pool (ASP) of the document library object (DLO) to be saved.

*ANY: The objects to be saved reside in any ASP. When DLO(*ALL) FLR(*ANY) are specified, all document library objects on the system are saved.
Note:When DLOs from multiple ASPs are saved, multiple tape media files are created. The beginning and ending sequence numbers of these media files will be required on the RSTDLO command to restore all ASPs.
1-32: Specify the number of an existing ASP that contains the document library objects to be saved. ASP 1 is the system ASP.
Note: Mail that has not been filed and documents that are not in a folder reside in the system ASP.

Top

Examples

Example 1: Performing a Complete Save Operation

SAVDLO   DLO(*ALL)  FLR(*ANY)  DEV(TAP01)

This command saves all folders, documents, and mail to the tape device TAP01.

Example 2: Saving All Changes

SAVDLO   DLO(*CHG)  DEV(TAP01)

This command saves all documents created or changed since the last complete save operation, folders created since the last complete save operation, and all mail.

Example 3: Saving An Entire ASP

SAVDLO   DLO(*ALL)  DEV(TAP01)  FLR(*ANY)  ASP(2)

This command saves all folders and documents in user ASP 2.

Example 4: Saving Objects Changed After a Specific Date

SAVDLO   DLO(*SEARCH)  DEV(TAP01)  OWNER(*ALL)
         REFCHGDATE('01/01/2002')

This command saves all documents changed or created after January 1, 2002. This command is useful for saving changes between backups of the documents. This command is similar to the Save Changed Objects (SAVCHGOBJ) used for other object types.

Example 5: Saving Documents and Folders Changed After a Specific Date

SAVDLO   DLO(*SEARCH)  DEV(TAP01)  SRCHTYPE(*ALL)  OWNER(*ALL)
         REFCHGDATE('01/01/2002')

This command saves all folders created since 01/01/2002 and all documents created or changed since 01/01/2002.

Example 6: Saving Documents Created After a Specific Date

SAVDLO   DLO(*SEARCH)  DEV(TAP01)
         CRTDATE((*AVAIL '01/01/2002'))  OWNER(*ALL)

This command saves all documents created or changed since 01/01/2002.

Example 7: Saving Documents and Folders Created After a Specific Date

SAVDLO   DLO(*SEARCH)  DEV(TAP01)  SRCHTYPE(*ALL)
         CRTDATE((*AVAIL '01/01/2002'))  OWNER(*ALL)

This command saves all documents and folders created since 01/01/2002.

Example 8: Freeing System Storage During the Save Operation

SAVDLO   DLO(DOCX)  FLR(FOLDERA)  DEV(TAP01)  STG(*FREE)

This command saves the document named DOCX in folder FOLDERA to the tape device TAP01. As part of the save operation, the system storage that was occupied by the data portion of the document is freed.

Example 9: Saving Folders

SAVDLO   DLO(*ALL)  DEV(*SAVF)  FLR(BILL TOM MARY)  SAVF(SAVF1)

This command saves the folders BILL, TOM, and MARY, and all the documents in these folders.

Example 10: Saving Just the Folder Level of a Folder

SAVDLO   DLO(*FLRLVL)  FLR(DEC01)  DEV(*SAVF)  SAVF(MYLIB/SAVF1)

This command saves folder DEC01 in folder STATUS and all the documents in this folder to save file SAVF1 in library MYLIB. Subfolders in this folder are not saved.

Example 11: Saving Just Mail

SAVDLO   DLO(*MAIL)  DEV(*SAVF)

This command saves all distribution objects and all documents referred to by a mail log.

Top

Error messages

*ESCAPE Messages

CPF3728: Device &1 specified with other devices.
CPF3733: &2 &1 in &3 previously damaged.
CPF3767: Device &1 not found.
CPF3768: Device &1 not valid for command.
CPF3793: Machine or ASP storage limit reached.
CPF3812: Save file &1 in &2 in use.
CPF384D: Save or restore operation not allowed on ASP &1.
CPF384E: USEOPTBLK(*YES) not valid for CD-ROM premastering.
CPF8AC3: ASP &5 is not valid.
CPF8A47: Internal system objects in use.
CPF90B2: List of folder names not valid with DLO parameter.
CPF90C1: Document list &1 empty.
CPF90C2: Document list &1 not used.
CPF90D7: Documents not saved.
CPF90E1: Folder &1 cannot be used with TGTRLS(*PRV).
CPF90E5: Not authorized to document list &1.
CPF9006: User not enrolled in system distribution directory.
CPF902E: &1 document library objects saved. &10 not saved.
CPF903B: Too many objects for save file.
CPF903C: No document library objects saved.
CPF9030: Owner profile (&1) not found.
CPF9046: No documents found satisfying search specification in folder &1.
CPF9053: Not authorized to requested function.
CPF9056: Not authorized to requested function.
CPF906B: No document library objects saved.
CPF908A: Requester &1 not enrolled.
CPF9096: Cannot use CMDCHRID(*DEVD), DOCCHRID(*DEVD) in batch job.
CPF941B: Save data area &1 in use.
CPF9410: &1 document library objects saved. &10 not saved.
CPF9411: Changes for ASP &1 not saved.
CPF9417: CRTDATE value not valid with REFCHGDATE or REFCHGTIME.
CPF9418: SAVF parameter not valid.
CPF9419: LABEL(*GEN) required.
CPF9810: Library &1 not found.
CPF9812: File &1 in library &2 not found.
CPF9820: Not authorized to use library &1.
CPF9822: Not authorized to file &1 in library &2.
CPF9825: Not authorized to device &1.
CPF9830: Cannot assign library &1.
CPF9831: Cannot assign device &1.
CPF9845: Error occurred while opening file &1.
CPF9846: Error while processing file &1 in library &2.
CPF9850: Override of printer file &1 not allowed.
CPF9851: Overflow value for file &1 in &2 too small.
CPF9860: Error occurred during output file processing.
CPF9899: Error occurred during processing of command.

Top