Excel Add-in Support

Taskpane: Read Tag Attribute

Summary

The ‘Read Tag Attribute’ taskpane helps the user configuring the ‘=APTAGATTR(…) function’ in a very user-friendly way. This function reads the requested attribute of a given tag and displays it in any desired Excel cell. Before a tag can be used in Excel, the tag must first be configured in Automation Portal Historian.

The user can open the ‘Read Tag Attribute’ taskpane by clicking the ‘Read Tag Attribute’ button in the Automation Portal Excel Add-in ribbon.

Arguments

Tag – Specifies the tag name of the desired tag. The tag name must be exactly the same as configured in the Automation Portal ‘Historian’. The user can also search the tag via the ‘Search Tag’ panel. To make use of the ‘Search Tag’ panel click the magnifying glass next to the tag field.

Attribute – Specifies the attribute of the tag. Following options are possible:

  • Name – Returns the name of the given tag.
  • Description – Returns the description field of the given tag.
  • Active – Returns whether the given tag is active or not.
  • Connection – Returns the connection of the given tag.
  • Datatype – Returns the datatype of the given tag.
  • Client Access – Returns the client access of the given tag.
  • Quality – Returns the latest quality status of the given tag.
  • Value – Returns the latest value of the given tag.
  • Timestamp – Returns the timestamp of the latest value of the given tag.
  • Address – Returns the address parameters of the given tag.
  • Archive – Returns whether the archiving is enabled or not for given tag.
  • Scanrate – Returns the scan rate of the given tag.
  • Scaled Low – Returns the scaled low value of the given tag.
  • Scaled High – Returns the scaled high value of the given tag.
  • Deadband Type – Returns the deadband type of the given tag.
  • Deadband – Returns the deadband value of the given tag.
  • Engineering Units – Returns the engineering units field of the given tag.
  • Instrument Tag – Returns the instrument tag field of the given tag.
  • Instrument Location – Returns the instrument location field of the given tag.

Header – When this checkbox is checked, a header with column titles is added to the top of the tag attribute cell.

Timestamp – When this checkbox is checked, the timestamp of the shown value is added to the left of the tag attribute value.

Procedure

1. First open the taskpane by clicking the ‘Read Tag Attribute‘ in the ribbon.

2. Secondly, click the magnifying glass, the ‘Search Tag‘ panel appears.

3. Next, select the desired tag from the list and click ‘OK‘, the tag name will appear in the tag textbox.

4. Select the desired attribute.

5. Thereafter, check the desired ‘Header’ and ‘Timestamp’ options.

6. Then, select the desired cell where the attribute value should be displayed in the spreadsheet.

7. Finally, click ‘OK’, the attribute value will appear in the cell.

Example