Parameters

Description

TYPE

Type of task to be carried out:
PROJECT: Back up the entire project
MASTERDATA: Back up the master data

PROJECTNAME 

Project name with complete file path (optional).
If nothing is entered, the selected project will be used if the action is to be run over the user interface (e.g. via script or the toolbar). When executing from the Windows command line, PROJECTNAME must be specified or ProjectAction has to be used before that. Otherwise a system message will appear.

ARCHIVENAME 

Archive name.
Name of the file in which the backup data should be saved (without path).

DESTINATIONPATH

Target directory

COMMENT

Comment on backup (optional).
The comment is written as a string into the corresponding property of the saved project.
Default value : Corresponding property is not specified.

BACKUPMEDIA 

Type of saving:
EMAIL: Project is sent via e-mail.
DISK: Project is saved on a hard drive, disk, etc.

SPLITSIZE

If the project to be backed up needs to be zipped, the target file can automatically be split into separate parts so it can be sent via e-mail. SPLITSIZE indicates the maximum file size in megabytes. If the SPLITSIZE = 0, the file is not split up. If the parameter BACKUPMEDIA = DISK, the SPLITSIZE is ignored. The parameter is optional (default value: 0.0).

BACKUPAMOUNT 

An enum constant that can accept the following values:
BACKUPAMOUNT_ALL: The entire contents of the project directory are saved.
BACKUPAMOUNT_MIN: Only the database files required for restoring the project are saved while redundant database files are ignored.
Default value: BACKUPAMOUNT_ALL.

COMPRESSPRJ 

Indicates whether the database should be compressed before saving (optional, 0 = No, 1 = Yes).
Default value: 0

INCLEXTDOCS 

Indicates whether external documents should be included in the backup (optional, 0 = No, 1 = Yes).
Default value: 0

INCLIMAGES 

Indicates whether image files should be included in the backup (optional, 0 = No, 1 = Yes).
Default value: 0

COPYREFDATA

Indicates whether the referenced data (external documents, image files) should be copied, prior to the data backup, to the respective project directory (...\"Projectname"\DOC\*.* and ...\"Projectname"\Images\*.*) (optional, 0 = No, 1 = Yes).
Default value: 0
Only applies if the TYPE parameter has of the following value: PROJECT.

BACKUPMETHOD 

Type of backup:
BACKUP: Project is backed up
PACK: Project is zipped
SOURCEOUT: Project is filed off
ARCHIVE: Project is archived. Cannot be specified if the parameter BACKUPMEDIA = EMAIL.

MDTYPE 

Type of master data to be backed up:
SYMBOLS: Symbol libraries
MACROS: Macros
FORMS: Forms
ARTICLES: Parts data
LANGUAGES: Dictionaries
STANDARDSHEET: Plot frames
STATIONDATA: User, workstation data

SOURCEPATH 

Source directory only applies when backing up master data.

FILENAME 

Name of the file to be backed up.
The file name can be specified with or without the complete file path.
The file extension must be specified.
A file extension with a placeholder is possible (for example /FILENAME:*.fn1, /FILENAME:*.*, /FILENAME:*sh).
This only applies for saving master data.