Skip to main content

File

Function: This element is used to copy a file to the file system of the installation computer. The target path is either predefined or can be selected by the user.

Parameter

Description

TargetFolder

Contains the path of the destination folder where the file should be copied

If this is a string, then the path is used directly. If this is an integer value prepended by a dollar sign ($), then it is a reference to the TargetDirectoryDefinition and the user will have the option to interactively select the desired target path. You can also use environment variables which are between percent signs (%).

In addition to the variables which are provided by the operating system, there are also local environment variables:

  • AP_COMMON: Directory of the common folder of the Automation Platform

    Installation

  • AP_PLUGINS: Directory of the plug-in folder of the Automation Platform

    Installation

  • AP_PROFILES: Directory of the profiles folder of the Automation Platform

    Installation

  • AP_ROOT: Directory of the root folder of the Automation Platform

    Installation

  • DESKTOP: Logical desktop, not the location of the physical file system

  • GATEWAYPLC: Location of the GatewayPLC folder

    Requirement: At least version Package Manager 3.5.7.0

  • GATEWAYPLC_CFG_CRTWIN: Location of the ControlWin configuration file

    Requirement: At least version Package Manager 3.5.13.0

  • GATEWAYPLC_CFG_GTW: Location of the gateway configuration file

    Requirement: At least version Package Manager 3.5.13.0

  • GATEWAYPLC_CFG_HMI: Location of the HMI configuration file

    Requirement: At least version Package Manager 3.5.13.0

  • GATEWAYPLC_CFG_SM: Location of the SoftMotion configuration file

    Requirement: At least version Package Manager 3.5.13.0

  • GATEWAYPLC_CFG_RTV: Location of the RemoteTargetVisualization configuration file

    Requirement: At least version Package Manager 3.5.13.0

  • PACKAGE_VERSION: Version of the package

    Requirement: At least version Package Manager 3.5.17.0

  • PACKAGE_NAME: Localized name of the package

    Requirement: At least version Package Manager 3.5.17.0

  • ACTIVE_PROFILE: Profile with which the Package Manager runs.

    Requirement: At least version Package Manager 3.5.17.0

Path

_cds_icon_three_dots.png: Opens the file directory for selecting the file path of the file

IgnoreArchiveFolder

_cds_icon_checked.png: The archive path is ignored and the installation routine behaves as if the file were located at the top level within the package archive.

Default value: "not enabled" (_cds_icon_option_deactivated.png)

Overwrite

Defines whether and under what conditions the file should be overwritten if the file already exists in the destination folder

The conditions are defined by the combination of Option and Version.

Option

  • Yes: Overwrite

  • No: Do not overwrite

  • TargetVersionSmaller: Overwrite depends on the version of the version element or if this exists on the version of the package file.

  • TargetVersionEqual: Overwrite depends on the version of the version element or if this exists on the version of the package file.

  • TargetVersionGreater: Overwrite depends on the version of the version element or if this exists on the version of the package file.

  • TargetVersionSmallerOrEqual: Overwrite depends on the version of the version element or if this exists on the version of the package file.

  • TargetVersionSmallerOrGreater: Overwrite depends on the version of the version element or if this exists on the version of the package file.

Version

Version compared to when the option is TargetVersionGreaterOrEqual or TargetVersionSmallerOrEqual, TargetVersionGreater, TargetVersionEqual, or TargetVersionSmaller

The string has to correspond to one of the following formats:

  • <major version>.<minor version>

  • <major version>.<minor version>.<build>

  • <major version>.<minor version>.<build>.<revision>

The string has to correspond to one of the following formats:

Where <major version>, <minor version>, <build> and <revision> are each numbers between 0 and 255

Annotation

Additional comment or information about the file

This information is visible only within the Package Designer.

Id

Integer which identifies the file element

Has to be unique within the component

Requirement: Minimum version of the Package Manager is 3.5.4.0