Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

FileDeployJob - setJobDestinationBackupOptions

FileDeployJob - setJobDestinationBackupOptions

Description :

Specifies backup options for files that are overwritten during a FileDeployJob. If a file suffix is specified, the files are renamed with a given suffix, or if backup directory options are specified the files are copied to a backup directory. Suffix and backup directory options cannot both be specified. The return value is the DBKey of the modified job.

Return type : DBKey

Command Input :

Variable Name

Variable Type

Description

jobName

String

Name of the File Deploy Job.

jobGroup

String

The path to the job group containing the File Deploy Job.

suffix

String

Specifies that the suffix that should be appended to all overwritten files. If a value is provided for this, the backup directory options should be blank.

backupDirectory

String

Specifies the directory to which overwritten files should be copied. If a value is provided for this and backupName, the suffix option should be blank.

backupName

String

Specifies the name under the given directory to which overwritten files are copied.

Examples :

Example

The following example sets the backup options of an existing job using file suffix.

Script





FileDeployJob setJobDestinationBackupOptions JobName /JobGroup .bak "" "" 



Example

The following example sets the backup options of an existing job using a backup directory.

Script





FileDeployJob setJobDestinationBackupOptions JobName /JobGroup "" /C/tmp/ backupDir 



Was this page helpful? Yes No Submitting... Thank you

Comments