AVEVA Historian Client Workbook function reference
- Last UpdatedFeb 03, 2025
- 6 minute read
This section describes the AVEVA Historian Client Workbook functions and their arguments. For a description of the arguments, see Function Arguments.
Required arguments are shown in a bold font.
|
Function Name |
Syntax |
Comments |
|---|---|---|
|
wwAggregate |
=wwAggregate( DataSource, TagRange, RowOrRes, Time1, Time2, AggCalc, ValueCriteria, OptionRange ) |
Returns an array. This function retrieves values from the AnalogHistory table for specified tags, and then performs aggregate calculations. Single value is returned for each of the selected tags. Quality and value criteria can be specified. Use a row count of 0 to ensure that all stored values are included in the calculations. |
|
wwAggregateWide |
=wwAggregateWide( DataSource, TagRange, RowOrRes, Time1, Time2, AggCalc, TagCriteria, OptionRange ) |
Returns an array. This function retrieves values from the AnalogWideHistory table for specified tags, and then returns an aggregate value for each tag. Use a row count of 0 to ensure that all stored values are included in the calculations. |
|
wwAlarmLimits |
=wwAlarmLimits( DataSource, TagRange, OptionRange ) |
Returns an array. |
|
wwAnalogHistory |
=wwAnalogHistory( DataSource, TagRange, RowOrRes, Time1, Time2, Interpolation, RetrievalMode, TimeDeadband, ValueDeadband, ValueCriteria, DetectDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. If the retrieval mode is set to delta, then a time deadband and value deadband may be specified. |
|
wwAnalogLive |
=wwAnalogLive( DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. |
|
wwAnalogLive1 |
=wwAnalogLive1(DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplaySourceTag, DisplaySourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwAnalogTagDetails |
=wwAnalogTagDetails( DataSource, TagRange, Description, EngUnit, EURange, RawRange, Storage, OptionRange ) |
Returns an array. |
|
wwAnalogTagDetails1 |
=wwAnalogTagDetails1( DataSource, TagRange, Description, EngUnit, EURange, RawRange, Storage, SourceTag , SourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwAnalogWideHistory |
=wwAnalogWideHistory( DataSource, TagRange, RowOrRes, Time1, Time2, Interpolation, TagCriteria, DisplayDatetime, DisplayMilliseconds, OptionRange ) |
Returns an array. The cyclic retrieval mode is used. |
|
wwBaseDate |
=wwBaseDate() |
Returns a string. Inserts the current base date into a cell. |
|
wwBaseTime |
=wwBaseTime() |
Returns a string. Inserts the current base time into a cell. The base time can be used in conjunction with the base date to specify "relative" time periods for queries. |
|
wwDiscreteHistory |
=wwDiscreteHistory( DataSource, TagRange, RowOrRes, Time1, Time2, RetrievalMode, TimeDeadband, ValueCriteria, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality OptionRange ) |
Returns an array. If the retrieval mode is set to delta, then a time deadband may be specified. |
|
wwDiscreteLive |
=wwDiscreteLive( DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. |
|
wwDiscreteLive1 |
=wwDiscreteLive1( DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplaySourceTag, DisplaySourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwDiscreteTagDetails |
=wwDiscreteTagDetails( DataSource, TagRange, Description, Messages, Storage, OptionRange ) |
Returns an array. |
|
wwDiscreteTagDetails1 |
=wwDiscreteTagDetails1(DataSource, TagRange, Description, Messages, Storage, SourceTag, SourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwDiscreteWideHistory |
=wwDiscreteWideHistory( DataSource, TagRange, RowOrRes, Time1, Time2, TagCriteria, DisplayDatetime, DisplayMilliseconds, OptionRange ) |
Returns an array. The delta retrieval mode is used. |
|
wwEventHistory |
=wwEventHistory( DataSource, TagRange, RowOrRes, Time1, Time2, ValueCriteria, DetectDatetime, DateTime, OptionRange ) |
Returns an array. The first 100 rows are returned. |
|
wwEventSnapshot |
=wwEventSnapshot( DataSource, EventTagRange, SnapshotTagRange, SnapshotTagType, Time1, Time2, DetectDatetime, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. |
|
wwEventTagDetails |
=wwEventTagDetails( DataSource, TagRange, Description, TimeDeadband, DetectorType, ActionType, Status, Logged, ScanRate, Reset, OptionRange ) |
Returns an array. |
|
wwHistory |
=wwHistory( DataSource, TagRange, RowOrRes, Time1, Time2, Interpolation, RetrievalMode, TimeDeadband, ValueDeadband, ValueCriteria, EdgeDetection, HistoryVersion, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplayOPCQuality, DisplayAsWide, OrderBy, OptionRange ) |
Returns an array. Use with IndustrialSQL Server (AVEVA Historian) 8.0. |
|
wwHistory2 |
wwHistory2( DataSource, TagRange, RowOrRes, Time1, Time2, Interpolation, RetrievalMode, TimeDeadband, ValueDeadband, RowLimit, TimestampRule, QualityRule, State, StateCalculation, ValueCriteria, EdgeDetection, HistoryVersion, ReplacePoorQuality, DisplayAsWide UseStringHistory, OrderBy, DisplayFlags ) |
Returns an array. Use with IndustrialSQL Server (AVEVA Historian) 9.0. |
|
wwHistory3 |
= wwHistory3(DataSource, TagRange, RowOrRes, Time1, Time2, Interpolation, RetrievalMode, TimeDeadband, ValueDeadband, RowLimit, TimestampRule, QualityRule, State, StateCalculation, ValueCriteria, EdgeDetection, HistoryVersion, ReplacePoorQuality, DisplayAsWide UseStringHistory, OrderBy, AnalogFilter, DisplayFlags ) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwLive |
=wwLive( DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplayOPCQuality, OptionRange ) |
Returns an array. Use with IndustrialSQL Server (AVEVA Historian) 8.0 or 9.0. |
|
wwLive1 |
=wwLive1(DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplayOPCQuality, DisplaySourceTag, DisplaySourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwQuery |
=wwQuery(DataSource, SQLQuery, OptionRange, StartDate, EndDate, TagRange) |
StartDate, EndDate, and TagRange are optional. Returns an array. Returns the results of a SQL statement. |
|
wwRefreshFunction |
=wwRefreshFunction() |
Refreshes the array-formula of the selected cell. Returns a Boolean value indicating the success or failure of the refresh operation. |
|
wwReplicatedLive |
=wwReplicatedLive(DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplaySourceTag, DisplaySourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwReplicatedTagDetails |
=wwReplicatedTagDetails(DataSource, TagRange, Description, Storage, SourceTag, SourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwStringHistory |
=wwStringHistory( DataSource, TagRange, Time1, Time2, ValueCriteria, DetectDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. The first 100 rows are returned. |
|
wwStringLive |
=wwStringLive( DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. |
|
wwStringLive1 |
=wwStringLive1( DataSource, TagRange, DisplayTagName, DisplayDatetime, DisplayMilliseconds, DisplayQuality, ReplacePoorQuality, DisplaySourceTag, DisplaySourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwStringTagDetails |
=wwStringTagDetails( DataSource, TagRange, Description, MaxLength, OptionRange ) |
Returns an array. |
|
wwStringTagDetails1 |
=wwStringTagDetails1( DataSource, TagRange, Description, MaxLength, SourceTag, SourceServer, OptionRange) |
Returns an array. Use with AVEVA Historian 10.0 or later. |
|
wwSummaryTags |
=wwSummaryTags( DataSource, TagFilter, DescriptionFilter, Description, SummaryPeriod, SummaryType, OptionRange ) |
Returns an array. Returns tags that have been configured to generate summary data. Filters can be used to show which tags are configured for different summary durations or type (min, max, avg, sum). |
|
wwSummaryTagValues |
=wwSummaryTagValues( DataSource, TagRange, SummaryType, SummaryPeriod, Time1, Time2, DisplayDatetime, DisplayQuality, ReplacePoorQuality, OptionRange ) |
Returns an array. |
|
wwTagSearch |
=wwTagSearch( DataSource, TagRange, TagFilter, DescriptionFilter, Description, OptionRange ) |
Returns an array. This function is not inserted into a worksheet cell when executed using the Tag Search menu command. |
|
wwWideHistory |
=wwWideHistory( DataSource, TagRange, RowOrRes, Time1, Time2, Interpolation, RetrievalMode, TagCriteria, EdgeDetection, HistoryVersion, DetectDatetime, DisplayMilliseconds, OrderBy, OptionRange ) |
Returns an array. Use with AVEVA Historian version 8.0. |
|
wwWideHistory2 |
=wwWideHistory2( DataSource, TagRange, RowOrRes, Time1, Time2, InterpolationType, RetrievalMode, TimeDeadband, ValueDeadband, RowLimit, TimestampRule, QualityRule, State, StateCalculation, TagCriteria, EdgeDetection, HistoryVersion, OrderBy, DisplayFlags ) |
Returns an array. Use with AVEVA Historian version 9.0 or later. |
|
wwWideHistory3 |
= wwWideHistory3( DataSource, TagRange, RowOrRes, Time1, Time2, InterpolationType, RetrievalMode, TimeDeadband, ValueDeadband, RowLimit, TimestampRule, QualityRule, State, StateCalculation, TagCriteria, EdgeDetection, HistoryVersion, OrderBy, AnalogFilter, DisplayFlags ) |
Returns an array. Use with AVEVA Historian 9.5 or later. |