This function is used in Python Scripting.

Description

Imports a JSON Tag file at the provided path. Also supports XML and CSV Tag file exports from legacy systems.

Client Permission Restrictions

Permission Type: Tag Editing

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax

system.tag.importTags(filePath, basePath, [collisionPolicy])

  • Parameters 

String filePath - The file path of the Tag export to import.

String basePath - The Tag path that will serve as the root node for the imported Tags.

String collisionPolicy - The action to take when a Tag or folder with the same path and name is encountered. Possible values include: "a" Abort and throw an exception, "o" Overwrite and replace existing Tag's configuration, "i" Ignore that item in the list. Defaults to Overwrite. [optional]

  • Returns

List - A List of QualityCode objects, one for each Tag in the list, that is representative of the result of the operation. See Scripting Object Reference.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples

There are no code examples for this function.

Keywords

system tag importTags, tag.importTags