FactoryTalk View SE Add Component Tool

FactoryTalk View SE Add Component Tool programmatically adds components to an existing HMI project without having to use FactoryTalk View Studio.
The tool has the following command line usage:
SEAddComponent applicationName applicationType areaName componentListFile [/U username] [/P password] [overwrite]
User authentication
Add
/U
 and
/P
 parameters to a specific user for user authentication. The user must have the application level Read, List Children, Create Children, Write, and Delete security permissions to run the command and add components successfully. Azure AD or OpenID Connect user accounts are not supported.
/U username
This parameter is an optional parameter that specifies the user name to sign in.
/P password
Parameters are case-insensitive. If a specified value includes a space, enclose the value in quotation marks.
TIP: If
/U
 and
/P
 are omitted and only single sign-on is enabled, it can do the user authentication. First, it uses the current user who signed in to FactoryTalk Directory to do the authentication. If no user is signed in, it will use the current Windows system signed-in user to sign in FactoryTalk Directory and do the authentication with that user. When single sign-on is disabled, use
/U
 and
/P
 to specify a valid user to run the command.
Command parameters
  • applicationName
     is the name of the FactoryTalk View SE application that contains the HMI project where components will be added. Quotations will be needed if the name contains any spaces.
  • applicationType
     is either the string
    Distributed
     or
    Stand-alone
    .
  • areaName
     is the name of area where the HMI project is located. In the case of stand-alone applications or the root area in a distributed application, the area name must be set to
    /
    . The syntax for areas is
    /<area name>/<sub-area name>
    . Quotations will be needed if the name contains any spaces.
  • componentListFile
     is the full path to an XML file containing a list of components to add. Quotations will be needed if the path contains any spaces.
  • overwrite
     is an optional parameter that, if present, will allow existing component files to be overwritten. If this parameter is not present, the existing component files will not be overwritten.
Examples
SEAddComponent MyApplication Distributed /MyArea/MySubArea "C:\SEFiles\Files.xml"
SEAddComponent MyApplication Stand-alone / "C:\SEFiles\Files.xml" overwrite
Remarks
  • The component file must not have the
    Hidden
     file attribute set.
  • The component file name must not contain any of the following characters:
    % . " : ? * < > # { } - [ ] ’ \ / ; = & +
  • A log file is generated describing the results of the tool execution. This log file is saved in the same folder as the component list file and it is named
    $AddComponent.txt
    .
  • When importing a tag CSV file, a log file is saved in the same folder as the component list file. The log file is named
    HMIProject
    .log
     where
    HMIProject
     is the HMI project name. For example, for the HMI project TagImportServer, the corresponding log file is TagImportServer.log.
  • When the tool has completed execution, it returns one of the following codes:
    • 0 = successful completion
    • 1 = any error occurred during execution
  • When adding a language file, the HMI server must be loaded and in the
    Active
     state.
  • When adding the RecipePro files (.csv or .rcpf), the file
    StyleSheet.xsl
     must be in the same folder as the
    SEAddComponent.exe
    .
  • When adding a RecipePro CSV file, the file must comply to the following format and rules:
    • The first part must be
      Description
      .
    • The second part must be
      Ingredient Name
      ,
      Type
      ,
      Unit
      ,
      Min
      ,
      Max
      ,
      Tag Set
      , and
      Recipe Value
      .
    • The third part are the ingredient values. These values must meet the following requirements:
      • The third part cannot exceed 20,000 lines.
      • Type
         must be
        Number
         or
        String
        . If
        Type
         is
        Number
        ,
        Recipe Value
         cannot be empty.
      • Ingredient Name
         is case-insensitive and must be unique.
        Tag Set
         cannot be empty.
        Ingredient Name
        ,
        Tag Set
        , and
        Unit
         must be fewer than 256 characters.
      • If the
        Min
         and
        Max
         values are specified,
        Recipe Value
         must be within the range of the
        Min
         and
        Max
         values.
    Example
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal