RenameTag

Associated with: Wonderware Historian database items

Security permission required to access this method: Configure (on both the point or accumulator for which the tag is being renamed, and the Wonderware Historian database item)

Use the RenameTag method to rename an existing tag in Wonderware Historian. Use this method to align an existing tag name in Wonderware Historian with the name of the point or accumulator with which that tag is associated, after that point or accumulator has been renamed and/or moved in the Geo SCADA Expert database.

The RenameTag method will only rename a tag that already exists in the Wonderware Historian database with which the Wonderware Historian database item is associated. For a tag to exist in the Wonderware Historian database, HCAL must have previously exported some historic data for the point or accumulator. When Geo SCADA Expert creates a tag in Wonderware Historian, the name of the tag is stored in the Geo SCADA Expert database (and can be viewed using the point's or accumulator's Wonderware Historian Export status attribute). The RenameTag method compares the tag name that is stored in Geo SCADA Expert with the current name of the point or accumulator plus the Wonderware Historian database item's Tag Names settings; if they differ, the method renames the tag in the Wonderware Historian and updates the tag name that is stored in the Geo SCADA Expert database.

To ascertain the tag name that currently applies to a point or accumulator in Geo SCADA Expert, view that point's or accumulator's Wonderware Historian Export Status display attribute.

To rename a tag in Wonderware Historian using the RenameTag method (so that the tag name aligns with the point's or accumulator's name in Geo SCADA Expert):

1. Ensure that the Wonderware Historian On-Premise server is configured to allow tags to be renamed programmatically. This is controlled by the 'AllowRenameTags' system parameter. You can use the Historian Configuration Editor in the ArchestrA System Management Console to set this system parameter to its required setting of 1.
2. In Geo SCADA Expert, ensure that the Wonderware Historian database item is configured with the required Tag Names settings (see Specify the Properties that are Associated with Tag Names).
3. Ensure that the point or accumulator for which the tag is to be renamed:
   • Is stored in the required location in the Geo SCADA Expert database (see Moving a Database Item)
   • Is assigned the relevant name (see Renaming a Database Item).
4. Use the RenameTag method in Geo SCADA Expert to trigger Wonderware Historian to update the existing tag name. You execute the RenameTag method programmatically; for example, using the Automation Interface.

   The method has 1 argument:

   • Object (String)—Use to specify either:
     • The Full Name of the point or accumulator for which the tag is to be renamed, including that point's or accumulator's full path in the database (see Full Name)

     Or:

     • The Id of the point or accumulator for which the tag is to be renamed (see Id).