Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

This function is used in Python Scripting.

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.editTags(tagPaths, attributes, parameters, accessRights, overrides, alarmList, alarmConfig[, provider][, json])

  • Parameters

String[] tagPaths - The full path to the Tag you want to edit. For members of UDT instances, the tagPath will be the path to the UDT instance, with the overrides parameter listing out the member Tags to edit. Note: you can specify the Tag provider name in square brackets at the beginning of the parentPath string. Example: "[myTagProvider]MyTagsFolder". If the Tag provider name is left off then the project default provider will be used.

PyDictionary attributes - The Tag's configuration attributes.

PyDictionary parameters - The parameters for a UDT instance Tag.

String accessRights - The access rights for a Tag. Possible values are Read_Only, Read_Write, and Custom.

PyDictionary overrides - All of the overrides for a UDT instance Tag.

String alarmList - List of legacy alarms for the Tag. The legacy alarm system was retired in 7.6.0, so the alarmConfig parameter should be utilized on newer versions.

PyDictionary alarmConfig - The alarm configuration for the Tag.

String provider The name of the Tag provider, used in conjunction with the JSON argument. The default value is the default Tag provider. Optional

String json - The properties to edit on Tags, represented as a JSON object. When using this, it acts as a replacement for other parameters. Optional.

  • Returns

Nothing

  • Scope

All

Code Examples

There are no examples associated with this scripting function.

  • No labels