USS Process Keyword Parameter Reference

USS Process Parameter

Range

Default

Description

ACTION

1-18

1

The function to be performed:

0 = Restore / USS receive file transfer

1 = Backup / USS send file transfer

2 = As of...Restore

3 = Wait for remote initiate

4 = Restart only

5 = Run a job

6 = Kill last restartable backup

7 = Run host report

8 = Restart restores only

9 = Kill restartable restore

10 = Submit a host job

11 = Migration

12 = Inquire Versions

13 = Performance test

14 = Reserved

15 = Reserved

16 = Delete backup

17 = Register target name

18 = Inquire files

BACKUPPROFILE

1-8 characters

none

The Backup Profile name to be used when requesting the specified function.

BLANKTRUNC

(File Transfer only)

Y / N

Y

(Only used if LINEBLOCK=Y)

Y = Trailing blanks at the end of each record are removed.

N = Trailing blanks are retained.

CALCDASDSIZE

Y / N

N

N = If you are performing a sequential disk backup the amount of space allocate on MVS for the backup depends on the amount of file data found.

Y = If you are performing a sequential disk backup the amount of space allocated on MVS depends on the amount of file and non-file data found.

COMPRESSLEVEL

(Backups only)

0 - 4

1

Specifies the compression level for data transmitted from USS

0 = No compression

1 = Fast compression

2 = High compression 1

3 = High compression 2

4 = High compression 3

DASDOVERRIDE

(Backups only)

0-9999

100 %

Allows you to override the amount of space (bytes) requested on a sequential disk backup. Must be specified in 1 of 4 forms:

+<number>: Add the given number of bytes to the total calculated.

-<number>: Subtract the given number of bytes from the total calculated.

<number>%: Use the given percentage to calculate the total.

<number>: Use the given number to override any calculated value.

DATELIMIT

(Backups only)

N or 0,

Y or 1,

 2

N

Allows inclusion or migration of files based on modification date. If you enable this parameter you must also specify a LATESTDATE.

0 (or N): This feature is disabled.

1 (or Y): Files after the LATESTDATE (and LATESTTIME for UNIX) are included/migrated.

2: Files before the LATESTDATE and LATESTTIME are included/migrated.

DAYSOLD

(Backups only)

0 - 365

180

The number of days (less 1) that a file has not been accessed before inclusion in the backup or migration.

DESTINATION

(Restores only)

Valid USS filename or pathname

none

This parameter allows you to specify that files be restored to a different file or path name from which they were originally backed up. The wildcard specifications must match the wildcard specifications in the FILES parameter. You can specify up to 128 characters.

DIRDELETE

(Backups only)

Y or N

Y

Y = If automatically deleting files, remove directories which ad all the files deleted.

N = Leave the directories which were just emptied.

DIRSONLY

(Restores only)

Y or N

N

Whether ONLY directories and no files should be restored:

Y = Restore only directories (no files)

N = Restore files and directories.

DUPDAYS

(Backups only)

1-999

30

If duplicate checking is enabled, specifies the number of days since the file was modified before it can be considered eligible for duplicate handling.

DUPLICATE

(Backups only)

Whether you wish to use duplicate file checking.

N = No special duplicate file handling.

Y = UPSTREAM on the Client will send up placeholder records for all files meeting DUPDAYS specification.

EXCLUDELISTNAME

Valid USS Filename

none

A specially formatted USS resident exclude list file name. All files included in this list will be excluded from the selected operation.

FILEDELETE

(Backups only)

Y or N

N

Y = Delete the files which were successfully backed up.

N = Do not delete the files which were successfully backed up.

FILES

Valid USS File Path Information

none

The file specification to be backed up or restored or the name of the job to run. This can include wildcards. This is a required parameter.

FILETRANSFER

Y / N

N

Y = This is a file transfer

N = This is a backup or restore function.

HIDDENFILES

(Backups only)

Y or N

Y

Whether hidden and system files should be backed up as well as normal files.

HOSTFILENAME

(File Transfer only)

Valid MVS Dataset Name

(See Description)

If specified, the name of the MVS dataset used in a file transfer operation.

If not specified, then FDR/UPSTREAM MVS will generate a name for USS sends, or will use the latest recorded file transfer for USS receives.

HOSTRECORD

(File Transfer USS sends only)

Y = Transferred files are recorded in the FDR/UPSTREAM MVS database for easy retrieval.

N = Transferred files are not recorded in the database.

HOSTSORT

(Restores only)

Y / N

N

Y = You wish the host sort utility used for restores.

N = You do not wish the host sort utility used for restores.

INQOPTIONS

(Merge Inquiries and Restores)

bitmap

value

2

(New value) A bit map of options used during an inquiry

and restore:

0 = Inquiries and restores only show normal files and

the highlighted backup.

1 = Inquires show migrated files as well as normal

files.

2 = Inquires and restores use  Highlighted back to full.

4 = Inquires operate from the currently highlighted backup to the first version Highlighted back to oldest

8 = (not used)

16 = Only display migrated files in an inquiry.

32 = Reserved

64 = Expiration date is displayed for migrated files.

JOBOPTIONS

(Request job)

bitmap

value

0

A bit map of options used when a job is requested and started:

0 = Start job and immediately terminate UPSTREAM.

1 = Start job and do not terminate UPSTREAM.

2 = Wait for job to be terminated.

4 = Not used

8 = No job just terminate UPSTREAM USS

JOBRETURNCODEMAP

(Run JOB Function)

0:0, ?:8

For CONV=WAIT jobs, a mapping between the Client return code and the host job return code. You can specify multiple mappings (including Client return code ranges), the ‚? is used for all unassigned Client return codes.

LASTACCESS

(Backups only)

Y or N

N

Y = Only include files which have not been accessed for the number of days (or more) specified in the DAYSOLD parameter.

N = Don’t restrict by last access date.

LATESTDATE

(Backups only)

date in the format

MM-DD-YY

none

This parameter is only used if you specify DATELIMIT=Y.

This field must be 8 characters

LATESTTIME

Time in the format

HH:MM:SS

none

The time, within the LATESTDATE to back up the files.

LATESTVERSION

(Restores only)

Y or N

N

Y No Y = You wish to restore the latest version available for the backup profile.

N = You wish to use a specific version date.

LINEBLOCK

(File Transfer only)

Y or N

N

Y = Records are separated by line feed characters (LF) for USS sends; LF’s are added at the end of each record for USS receives.

N = All records are separated by the record size for USS sends.

LINETRUNC

(File Transfer only)

Y or N

N

(Only used if LINEBLOCK=Y for Client sends)

Y = Data exceeding the record size is truncated.

N = Data exceeding the record size is sent as a separate record.

LOGNONFATAL

Y, N, or 2

N

0 = (or N) Nonfatal errors during a backup or restore are not logged or displayed.

1=  (or Y) = Nonfatal errors encountered during function requests are logged and displayed.

2 = Only messages during a backup which result in a skipped file are transmitted to the host.

MAXKFILESIZE

file size in Kb

zero (0)

Allows you to exclude files which are larger than the specified size (in 1024 byte multiples). 0 indicates no file size exclusion.

MERGE

(Backups only)

0, 1,2, 3

0

The merge backup type to use:

0 = No merge used

1 = Full merge

2 = Incremental merge

3 = First-time merge backup

MIGRBITS

(Restores only)

1, 2

0

How migrated files should be treated in a restore:

1 = Include migrated files in the restore.

2 = Include only migrated files (no regular files).

MODIFYFILE

Y or N

N

Y = Files to be selected for an incremental backup are determined by the last date/time that FDR/UPSTREAM was run (This is stored in the modification file).

N = Files to be selected for an incremental backup are determined by the setting of the archive bit.

PACKFLUSHAFTERFILE

Y or N

N

Y = Forces a packed record in a backup to be transmitted after each file.

N = Records are fully packed.

PACKRECSIZE

0 - 32700

32700

The maximum number of bytes transmitted or received per packed text record from the host.

Specify 0 to disable record packing.

PARAMETER

Valid USS Filename

upstream.dat

The name (and optionally the path) of the parameter file to read FDR/UPSTREAM USS parameters from.

PASSWORD

none

Your password. This is usually required if the user ID is

required. You can specify up to 32 characters. If FDR/UPSTREAM generates this field in a parameter file, then it is encrypted. In attended mode the password is not read from a parameter file (but can be accepted from the command line or environment).

PERFORMBITMAP

bitmap

value

96

A bit map of performance tests you wish to run:

1 = CPU test

2 = Screen I/O test.

4 = File I/O (read) test.

8 = Backup, No I/O test

16 = VSAM performance test

32 = Raw communications test, PC send

64 = Raw communications test, MVS send.

PERFORMNUMRECORDS

1 - 9999

500

The number of records sent or received via the raw communications performance tests.

PERFORMRECORDSIZE

1 - 32700

8192

The size of records sent or received via the raw communications performance tests.

PLUGIN

Valid USS Filename

none

PLUGIN None No Allows you to specify the name of a shared library which can be used to extend UPSTREAM’s functionality. PLUGINs must be in the /plugin directory directly beneath the UPSTREAM directory.

PLUGINPARAMETERS

user specifiable string

none

PLUGINPARAMETERS None No Parameters specific to the plugin. See the documentation for the plugin for more details.

POSTJOB

Valid USS Filename

None

If defined, this is the file name of a program, batch file or script file which will be run after the unattended UPSTREAM function.

PREJOB

Valid USS Filename

None

If defined, this is the name of a program, batch file or script file which will be run before the unattended FDR/UPSTREAM function.

RECORDSIZE

1 - 32700

8192

The data blocking size. This is a memory/performance tool.

REPORTNAME

Valid USS Filename

us.rpt

The name of the file to write reporting information to.

REPORTOPTIONS

bitmap

value

0

A bit map describing any of the report features you wish to enable:

1 = Files backed up/restored

2 = Files skipped during the backup

4 = Files automatically deleted

8 = Inquire versions

16 = Inquire files

32 = Specified parameters

RESTARTTYPE

0, 1, 2

0

Specifies the action to be performed, at a restart point (usually the next time FDR/UPSTREAM is run), if there is a restartable error:

0 = Never restart.

1 = (Backups only) Restart failed files and incomplete

backups

2 = Restart only incomplete backups.

RESTORECHECKPOINT

0 - 256

120

The number of seconds between automatic checkpoints when performing a restartable restore.

RETAIN

(Migration specs only)

0 -9999

90

In a migration spec, the number of days that the file should be merged forward onto new full backups.

SENDHOSTDETAILS

Y or N

N

N = Only the first line of an error is sent to the host.

Y = All message lines of a message are sent except additional description lines from the message file.

SKIP

(Restores only)

0, 1, 2, 3, 4, 5

0

For restores using “List and Restore”, a set of options of how to process existing files:

0 = Restore all files regardless of whether there are existing files.

1 = Restore only files where there is no existing file of the same name.

2 = Restore only files where the existing file’s modification date/time and size are not the same.

3 = Restore only files which have been marked for FDR/UPSTREAM NetWare auto-recall.

4 = Restore only files which have 0 length.

5 = Restore only files which are older than those stored on disk.

SKIPOLD

(Restores only)

Y or N

N

Y = Only those files which are newer on the mainframe will be restored.

N = All files will be restored.

SPECNUMBER

(Repeating)

ascending number starting at 1.

1

The header to this file set. Each file set begins with a SPECNUMBER definition. This is a required parameter.

SPECTYPE

(Repeating)

0, 1, 2

0

0 = File specification is files to be included in the backup or restore.

1 = File specification is files to be excluded from the backup or restore.

2 = File specification is files to be migrated during the backup.

STORAGETYPE

0, 1, 2, 3

3

How the data is stored on the mainframe.

0 = Archive backup. Will be merged to tape when the next archive is performed on the mainframe.

1 = Keyed/duplicate backup. Stored on mainframe disk until rolled off.

2 = Sequential disk. Stored on mainframe DASD.

3 = Sequential tape. Stored directly on mainframe TAPE

SUBDIRECTORIES

(Repeating)

Y or N

Y

Y = All subdirectories under the specified one will be checked for files which match the file specification.

N = Only those files in the specified or default directory which match the file specification will be transferred.

USERID

none

Your security identifier. This may be required by some MVS systems (see your system administrator). You can specify up to 32 characters.

VERSIONDATE

(Restores Only)

format:

yymmddhhmmss

none

For a restore, if you specified LATESTVERSION=N, then you are required to specify a complete version date. This is usually used with an inquire versions command. The version date is exactly 12 numeric characters.

XFERECORDSIZE

(File Transfers Only)

1 - 32700

8192

The record blocking size for file transfers. Users will often use 80 for text files as well.