XML Tags

Supported XML Tags in Component Description Files

XML Tags

component
name
version
date
config
init
postInstall
file
dplist
required_pvss_version
required_pvss_patch
preinit
help
dontRestartProject
required
update_types
includeComponent
comment
delete
config_windows
postDelete
config_linux
subComponent

Detailed Description

JCOP FW Installation Tool: List of supported XML tags in the component description files

Author:
Fernando Varela (EN-ICE)
Date:
August 2010

Variable Documentation

Developer comment as string (optional)

e.g. <comment>This is a comment</comment>

component This tag defines that this is a component (Mandatory)

Name of the file containing the entries to be added to the config file of the target project (optional)

e.g. <config>./config/fwDIM.config</config>

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

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

Date when the component was packaged (Mandatory)

e.g. <date>10/11/2009</date>

Script to be executed during the deletion of the component (optional)

e.g. <delete>./myDelete.ctl</delete>

dontRestartProject flag indicating whether the restart of the project can be avoided after the installation of the component. The only possible value "yes" to avoid project restart (optional)

e.g. <dontRestartProject>yes</dontRestartProject>

Component dpl file. Note that in the case of having multiple dpl files, the developer may choose the order in which these files are imported using the attribute 'order' (optional)

e.g. <dplist order="1">./dplist/FwDimDemoDps.dpl</dplist>

e.g. <dplist order="2">./dplist/FwDimDps.dpl</dplist>

Component file (optional)

e.g. <file>./fwDIM.xml</file>

Name of the help file to be opened from the main panel of the Installation Tool (optional)

e.g. <help>./fwAccessControl/fwAccessControl.htm</help>

includeComponent link to a sub-component that must also be installed during the installation of this component (optional)

e.g. <includeComponent>./fwGeneral.xml</includeComponent>

Filename of an init script (optional)

e.g. <init>./config/fwDIM.init</init>

Name of the component (Mandatory)

e.g. <name>fwCore</name>

Script to be executed after the deletion of a component (optional)

e.g. <postDelete>./myPostDelete.ctl</postDelete>

Filename of a post-installation script (optional)

e.g. <postInstall>./config/fwDIM.postInstall</postInstall>

Filename of a pre-init script. These scripts are executed prior to any other step during the installaiton of a component (optional)

e.g. <preinit>./scripts/fwDim/preinit.ctl</preinit>

required defines a dependency with a required component. The value must have the format '<component>=<version>'. (optional)

e.g. <required>fwCore=3.2.0</required>

This tag defines patch level for a component to be installed (optional)

e.g. <required_pvss_patch>C001</required_pvss_patch>

This tag defines the required minimal PVSS version for the component to be installed. An exact match of the PVSS versions can be requested by defining the attributed 'strict' as shown in the example.(optional)

e.g. <required_pvss_version strict="yes">3.6-SP1</required_pvss_version>

Flag indicating if the component is a subcomponent. Only possible value is 'yes'. (Mandatory for subcomponents)

e.g. <subComponent>yes</subComponent>

update_types flag indicating if the dp-types of the component must be overwritten in case they already exist in the project. (optional)

e.g. <update_types></update_types>

Version of the component (Mandatory)

e.g. <name>2.4.5</name>

 All Files Functions Variables