Excel Add-in Support

APTAGATTR | Read Tag Attribute

Summary

Retrieve a tag attribute value from a given tag. This function is available via the taskpane as well as directly via the cell “=APTAGATTR(…)”.

We recommend configuring this formula using the ‘Read Tag Attribute‘ task pane.

Return Value

The function returns the tag attribute value of a given tag. The tag must be configured in the Automation Portal Historian before the connection can be read in Microsoft Excel.

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’

Attribute – Specifies the attribute value 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.

Options – Specifies custom options given by the task pane. Default value is 0.

Example