Skip to main content

Folder

Function: This element is used to copy a folder 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 folder 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 folder

The folder is copied to the package archive.

IgnoreArchiveFolder

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

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

Annotation

Additional comment or information about the file

This information is visible only within the Package Designer.

Requirement: At least version Package Manager 3.5.4.0