HMI Configuration File Elements and Attributes

This topic and the subtopics list the XML elements and attributes for the HMI configuration file. The elements and attributes allowed are defined in the schema (XSD file) provided by Phoenix Contact.

This chapter includes the following sections:

Further Info
An example of an XML configuration file can be found in the topic "HMI Configuration Sample". For a description how to use the HMI Configurator, refer to the topic "Working with HMI Configuration Files".

Schema code

The schema (XSD file) describes which elements and attributes are allowed in the HMI configuration file. If you have an XML editor that supports XSD, associate the file with your XML file. To associate the XSD with the XML file, include the Xmlns:xsi namespace and the xsi:noNamespaceSchemaLocation attribute in the XML file as shown in the following example. (In this case, the Configuration.xsd is located in the same folder as the XML file; the file name can also be specified with an absolute or relative path.)

The XSD file is located in the installation directory of PLCnext Engineer. To use and associate the file with the HMI configuration file, copy it to a local folder.

Configuration file elements and attributes

The following table lists all the elements defined in the XSD schema that the content of the HMI configuration file must conform. The elements are listed in the order they are declared in the XSD schema. For a detailed description of the elements and their attributes click the corresponding link.

Note
All elements and attributes must be written in lowercase.

Element 1

<hmigenerator> Root element of the configuration file.

<generation> Container for one or more <page> and <folder> elements.

<page> The HMI page to be created.

<folder> The folder to be created under the 'Application' node in the PLANT.

<group> The group of HMI symbols to be created.

<symbol> The HMI symbol instance to be created.

<onfunctionblock> The FB instance that triggers the creation of symbol/symbol group.

<onprogram> The program instance that triggers the creation of symbol/symbol group.

<onvariable> The variable that triggers the creation of symbol/symbol group.

<onpage> The HMI page that triggers the creation of symbol/symbol group.

<settings> The global setting definitions for the generation of the HMI content.

<id> The reference to the configuration file.

<startpage> The start page of the HMI application.

<tagset> Tag settings for application local HMI tags.

<index> Used to define the order of execution if multiple configuration files are instantiated.

<pagestyles> Container for one or more <pagestyle> elements.

<pagestyle> Assignment of page style definitions.

<template> Page template used for the creation of the HMI page.

<templatelibrary> Library containing the page template used for the creation of the HMI page.

<backgroundtemplate> Page used as background page for the creation of the HMI page.

<backgroundtemplatelibrary> Library containing the page used as background page for the creation of the HMI page.

<width> Used to set width of the HMI page.

<height> Used to set height of the HMI page.

<groupstyles> Container for one or more <groupstyle> elements.

<groupstyle> Assignment of group style definitions.

<location> (contained by <groupstyle>) Used to position the HMI group on the HMI page.

<symbolstyles> Container for one or more <symbolstyle> elements.

<symbolstyle> Assignment of symbol style definitions.

<location> (contained by <symbolstyle>) Used to position the HMI symbol on the HMI page.

<datasets> Container for one or more <dataset> elements.

<dataset> Data set to be used for the HMI symbol.

<data> Used to set HMI page parameters or HMI symbol parameters.

<tagsets> Container for one or more <tagset> elements.

<tagset> Tag sets to be used for the HMI application or page.

<tag> Used to create application local HMI tags or page local HMI tags.

<parametersets> Container for one or more <parameterset> elements.

<parameterset> Parameter sets to be used for the HMI page.

<parameter> Used to create HMI page parameters.

<symbolsets> Container for one or more <symbolset> elements.

<symbolset> Symbol set definitions to be used for an HMI symbol instance.

Element	1
<hmigenerator>	Root element of the configuration file.
<generation>	Container for one or more <page> and <folder> elements.
<page>	The HMI page to be created.
<folder>	The folder to be created under the 'Application' node in the PLANT.
<group>	The group of HMI symbols to be created.
<symbol>	The HMI symbol instance to be created.
<onfunctionblock>	The FB instance that triggers the creation of symbol/symbol group.
<onprogram>	The program instance that triggers the creation of symbol/symbol group.
<onvariable>	The variable that triggers the creation of symbol/symbol group.
<onpage>	The HMI page that triggers the creation of symbol/symbol group.
<settings>	The global setting definitions for the generation of the HMI content.
<id>	The reference to the configuration file.
<startpage>	The start page of the HMI application.
<tagset>	Tag settings for application local HMI tags.
<index>	Used to define the order of execution if multiple configuration files are instantiated.
<pagestyles>	Container for one or more <pagestyle> elements.
<pagestyle>	Assignment of page style definitions.
<template>	Page template used for the creation of the HMI page.
<templatelibrary>	Library containing the page template used for the creation of the HMI page.
<backgroundtemplate>	Page used as background page for the creation of the HMI page.
<backgroundtemplatelibrary>	Library containing the page used as background page for the creation of the HMI page.
<width>	Used to set width of the HMI page.
<height>	Used to set height of the HMI page.
<groupstyles>	Container for one or more <groupstyle> elements.
<groupstyle>	Assignment of group style definitions.
<location> (contained by <groupstyle>)	Used to position the HMI group on the HMI page.
<symbolstyles>	Container for one or more <symbolstyle> elements.
<symbolstyle>	Assignment of symbol style definitions.
<location> (contained by <symbolstyle>)	Used to position the HMI symbol on the HMI page.
<datasets>	Container for one or more <dataset> elements.
<dataset>	Data set to be used for the HMI symbol.
<data>	Used to set HMI page parameters or HMI symbol parameters.
<tagsets>	Container for one or more <tagset> elements.
<tagset>	Tag sets to be used for the HMI application or page.
<tag>	Used to create application local HMI tags or page local HMI tags.
<parametersets>	Container for one or more <parameterset> elements.
<parameterset>	Parameter sets to be used for the HMI page.
<parameter>	Used to create HMI page parameters.
<symbolsets>	Container for one or more <symbolset> elements.
<symbolset>	Symbol set definitions to be used for an HMI symbol instance.