fwInstallation  8.4.1
Supported XML Tags in Component Description Files

XML Tags

List of all supported XML tags:


Mandatory tags

<component>

Root element of component description XML file. Other tags are child elements of this root element.

<name>

Name of the component.

<version>

Version of the component.


Recommended tags

<date>

Date when component was packaged. Recommended format: DD/MM/YYYY


Optional tags

Additional information about component

<description>

Description of a component

<comment>

Comment

Installation options

<dontRestartProject>

Indicates if project restart can be avoided after installation of the component. If so, it must have value "yes" (case insensitive). By default project will be restarted (when tag is not present or has value different than "yes"). Note: This tag is recognized by Installation tool, however it is not implemented.

<update_types>

Indicates if existing datapoint types should be updated during installation of component. To prevent update it must have value "no" (note: case sensitive). By default datapoint types will be updated (when tag is not present or has value different than "no").

<hiddenComponent>

Indicates if component should be by default hidden on the list of available components in the Installation Panel. To hide the component this tag must have value "yes" (case insensitive). By default component is displayed on the list of available components (when tag is not present or has value different than "yes"). Hidden components can be displayed by selecting "Show also: Hidden components" checkbox.

Component relationship

<subcomponent>

Indicates if component is a subcomponent. It must have value "yes" (case insensitive) for subcomponents. By default component is not recognized as subcomponent (when tag is not present or has value different than "yes").

<includeComponent>

Relative path to a subcomponent description XML file. Subcomponent will be installed during installation of parent component. It is possible to specify many subcomponents, each one in separated <includeComponent> tag.

Requirements

<required>

Defines a dependency on another component and its version (lowest required). Its value must have the following format: component=version
Example:

<required>fwCore=8.2.1</required>

<required_pvss_version>

Defines the lowest WinCC OA version required by the component to be installed. It is possible to restrict that it is the only allowed version by adding attribute 'strict' with value 'yes'.

<required_pvss_patch>

Defines the lowest required patch level for the required WinCC OA version.

<required_installer_version>

Defines the lowest Installation tool version required by the component to be installed. It is possible to restrict that it is the only allowed version by adding attribute 'strict' with value 'yes'.

Component files

<preinit>

Pre-init script. These scripts are executed prior to any other step of component installation.

<init>

Init script. These scripts are executed after all component files are copied, dpl files imported and config entries appended to the project config file. Note that it is not possible to use in init script libraries functions of components that are installed.

<postInstall>

Post-install script. These scripts are executed after installation of all selected components is finished and optionally after project restart. Post-install scripts of different components are executed in the same order as components were installed.

<delete>

Delete script. These scripts are executed during component removal.

<postDelete>

Post-delete script. These scripts are executed after removal of all selected components is finished.

<dplist>

Component dpl file. When component has more than one dpl file it is possible to specify the order in which the files are imported by adding the attribute 'order'.

<config>

File containing the entries to be added to the config file of the target project.

<config_linux>

File containing the entries to be added to the config file of the target project. Linux specific.

<config_windows>

File containing the entries to be added to the config file of the target project. Windows specific.

<help>

Relative path of the component help file. If provided, it can be opened from Installation panel on Installed components list.

<qtHelp>

Qt Compressed Help file with the component documentation. This file is added to the custom project Qt Help collection. To consult the documentation launch Qt Assistant from gedi's Help -> WinCC OA Overview menu item.

<bin>

Relative path of the component binary file. Binary files are treated in special way and their path must follow the pattern:

./bin/[componentName/][relativePathToPreserve/][versionDirectory/]binaryFileName

Binary file are copied directly to the bin/ directory or under the relativePathToPreserve/ path if present. Their target path is remembered by fwInstallation. If binary file is placed in versionDirectory (a directory named as WinCC OA version eg. 3.15/) then it is copied to the installation directory only if project is running in the corresponding WinCC OA version. componentName directory is always skipped.
Binary file examples:

Source path Target path Note
./bin/fwComponent/3.15/myBinary ./bin/myBinary Copied to target only in 3.15
./bin/fwComponent/widgets/linux-rhel-x86_64/3.16/myEwo.ewo ./bin/widgets/linux-rhel-x86_64/myEwo.ewo Copied to target only in 3.16
./bin/anotherBinary ./bin/anotherBinary Copied to target in any WinCC OA version

<file>

Other component files (including panels, scripts and libraries)