Component list file

The component list file supplied to the Add Component Tool is an XML file consisting of a list of component category headings and component file names.
The file has the following format. The
<category>
and
<component>
sections can be repeating sections.
<hmi> <category type="TYPE" folder="FOLDER"> <component file="NAME"/> </category> </hmi>
  • TYPE
    is one of the component category types.
  • FOLDER
    is the name of the folder where the component files in this category is located. This is an optional attribute. If this attribute is not present, the component files are assumed to be located in the same folder as this component list file. The folder attribute can be specified either as an absolute folder (for example,
    C:\SEFiles\gfx
    ) or as a relative folder (for example,
    .\gfx
    ). If it is a relative folder specification, it is assumed to be relative to the folder where this component list file is located.
  • NAME
    is the name of the component file without a folder specification (for example,
    pump.gfx
    ).
Examples
Adding graphic displays, global object displays, and images to an existing application:
When adding graphic displays or global object displays, you can specify a folder to hold them. If the folder doesn't exist, it will create one for you.
<hmi> <category type="Graphics;Displays" folder="C:\SEFiles\Displays"> <component file="overview.gfx" folder="overview"/> <component file="pump house.gfx" folder="pumps"/> </category> <category type="Graphics;Global Objects" folder="C:\SEFiles\GOs"> <component file="button.ggfx" folder="buttons"/> <component file="panel.ggfx" folder="panels"/> </category> <category type="Graphics;Images" folder="C:\SEFiles\Images"> <component file="logo.bmp"/> <component file="pump.bmp"/> </category> </hmi>
Adding folders under Displays and Global Objects of an existing application:
<hmi> <category type="Graphics;DisplayFolders"> <component folder="line1"/> <component folder="line2"/> </category> <category type="Graphics;GlobalObjectsFolders"> <component folder="common1"/> <component folder="common2"/> </category> </hmi>
Adding XML files to an existing application:
<hmi> <category type="Graphics;Displays" folder="C:\SEFiles\Displays"> <component file="overview.xml"/> </category> <category type="Graphics;Global Objects" folder="C:\SEFiles\GOs"> <component file="common.xml"/> </category> </hmi>
Adding script files to an existing application:
<hmi> <category type="Scripts;Files" folder="C:\SEFiles\ScriptFile"> <component file="A1.ps1"/> <component file="A2.psm1"/> <component file="A3.psd1"/> </category> </hmi>
Adding a language file to an existing application:
<hmi> <category type="Language;Files" folder="C:\SEFiles"> <component file="Excelname.xls"/> </category> </hmi>
Importing FactoryTalk Alarms and Events alarms to an alarm sever
  • AE area
    - Specifies the name of the area that contains the Tag Alarm and Event server. The syntax is
    <area name>/<sub-area name>
    , if the application type is network station or network distributed. In the case of stand-alone applications, the area name must be set to
    /
    .
  • AE server
    - Specifies the name of the Tag Alarm and Event server.
  • AE file
    - Specifies the full path to the XML or Excel file that contains the alarms to be imported.
  • AE type
    - It is optional. Specifies the type of the operation. The value must be an integer from 1 through 6. If omitted, the default value is 1.
    • 1. Update existing alarm definitions and create new alarm definitions from the import file.
    • 2. Import only new alarm definitions from the import file and skip existing alarm definitions.
    • 3. Delete all existing alarm definitions, and then create new alarm definitions from the import file.
    • 4. Update existing messages and create new messages from the import file.
    • 5. Import only new messages from the import file and skip existing messages.
    • 6. Delete all existing messages, and then create new messages from the import file.
For a local application:
<hmi> <category type="FTAE" folder="C:\SEFiles\FTAE"> <AE area="/"/> <AE server="FTAEServer1"/> <AE file="Alarm and Event Server_AlarmImport.xml"/> <AE type="2"/> </category> </hmi>
For a network application:
<hmi> <category type="FTAE" folder="C:\SEFiles\FTAE"> <AE area="Line1_Alarms/MySubArea"/> <AE server="FTAEServer1"/> <AE file="Alarm and Event Server_AlarmImport.xml"/> <AE type="2"/> </category> </hmi>
The component category types and their associated application tree folder names are defined in the following table.
Component Category Type
Application Tree Folder Name
Graphics;Displays
Displays
Graphics;DisplayFolders
Displays
Graphics;Images
Images
Graphics;Global Objects
Global Objects
Graphics;GlobalObjectsFolders
Global Objects
Parameter;Files
Parameters
Recipe;Files
Recipes
RecipePro;Files
RecipePro
MessageServer;Tables
Local Messages
Templates;Files
Trend Templates
TagDb;Files
Tags
Snapshots;Files
Trend Snapshots
TrendPro Template;Files
TrendPro Templates
XYPlot Template;Files
XY Plot Templates
Derived;Models
Derived Tags
Event;Models
Events
Macro;Files
Macros
Key;Files
Client Keys
Data Logging;Models
Data Log Models
FTAE
Alarms and Events
DataLogPro;Files
DataLogPro
Navigation;Files
Navigation menu
Navigation;Icons
Navigation menu
Scripts;Files
Scripts
Language;Files
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal