Array Formula Parameters

The following table describes the parameters for the array formulas for the Historian Excel Add-In.


Parameter	Description
`pArchiveNameMask`	A search mask you can use to browse the archivers. Use standard Windows wildcard characters.
`pArraySize`	The number of cells that the array spans.
`pCalculationMode`	The type of calculation mode. See the Calculation Modes section in the Getting Started with Historian guide for a complete list.
`pCollector`	The collector or collector mask that you want to query.
`pCollectorNameMask`	A search mask for browsing collectors. Use standard Windows wildcard characters.
`pDescriptionMask`	A search mask for browsing tag descriptions. Use standard Windows wildcard characters.
`pDirection`	The direction (forward or backward from the start time) of data sampling from the archive.
`pEndTime`	The end time used to refine your query.
`pFilterComparisonMode`	The type of comparison to be made on the filter comparison value: `Equal` Filter condition is True when the `FilterTag` is equal to the comparison value. `EqualFirst` Filter condition is True when the `FilterTag` is equal to the first comparison value. `EqualLast` Filter condition is True when the `FilterTag` is equal to the last comparison value. `NotEqual` Filter condition is True when the `FilterTag` is NOT equal to the comparison value. `LessThan` Filter condition is True when the `FilterTag` is less than the comparison value. `GreaterThan` Filter condition is True when the `FilterTag` is greater than the comparison value. `LessThanEqual` Filter condition is True when the `FilterTag` is less than or equal to the comparison value. `GreaterThanEqual` Filter condition is True when the `FilterTag` is greater than or equal to the comparison value. `AllBitsSet` Filter condition is True when the binary value of the `FilterTag` is equal to all the bits in the condition. It is represented as `^` to be used in Filter Expression. `AnyBitSet` Filter condition is True when the binary value of the `FilterTag` is equal to any of the bits in the condition. It is represented as `~` to be used in Filter Expression. `AnyBitNotSet` Filter condition is True when the binary value of the `FilterTag` is not equal to any one of the bits in the condition. It is represented as `!~` to be used in Filter Expression. `AllBitsNotSet` Filter condition is True when the binary value of theFilterTag is not equal to all the bits in the condition. It is represented as `!^` to be used in Filter Expression.
`pFilterComparisonValue`	The value to compare the filter tag with when applying the appropriate filter to the DataRecordset query (to determine the appropriate filter times).
`pFilterExpression`	An expression that includes multiple filter conditions. The type of conditions used are: `AND` Condition `OR` Condition Combination of both `AND` and `OR` Filter Expression can be used instead of `FilterTag`, `FilterComparisonMode` and `FilterValue` parameters. While using `FilterExpression`, the expression is passed within single quotes and for complex expressions we write the conditions within a parenthesis. There is no maximum length for a filter expression.
`pFilterMode`	The type of time filter: `ExactTime` Retrieves data for the exact times that the filter condition is True (only True). `BeforeTime` Retrieves data from the time of the last False filter condition up until the time of the True condition (False until True). `AfterTime` Retrieves data from the time of the True filter condition up until the time of next False condition (True until False). `BeforeAndAfterTime` Retrieves data from the time of the last False filter condition up until the time of next False condition (While True). The `FilterMode` defines how time periods before and after transitions in the filter condition should be handled. For example, `AfterTime` indicates that the filter condition should be True starting at the timestamp of the archive value that triggered the True condition and leading up to the timestamp of the archive value that triggered the False condition.
`pFilterTag`	The single tagname used when applying the filter criteria.
`pNumberOfSamples`	Number of samples from the archive to retrieve. Samples will be evenly spaced within the time range defined by start time and end time for most sampling modes. For the `RawByNumber` sampling mode, the `NumberOfSamples` column determines the maximum number of values to retrieve. For the `RawByTime` sampling mode, the `NumberOfSamples` is ignored.
`pRowCol`	The sorting criteria used: 0 for Columns and 1 for Rows.
`pSamplingInterval`	For non-raw sampled data, this column represents a positive integer for the time interval (in milliseconds) between returned samples.
`pSamplingMode`	The type of sampling mode used by the query. See the Sampling Modes section in the Getting Started with Historian guide for a complete list.
`pSearchText`	The text or mask that you want to search for in the message.
`pServer`	Name of the server from which you are retrieving data. If you are running Excel on the same server that you are retrieving data from, you do not have to enter a string, as the default server is used.
`pSort`	The sorting criteria used for the rows or columns: 0 for Descending and 1 for Ascending.
`pStartTime`	The start time used to refine your query.
`pTagMask`	A search mask for browsing tagnames. Use standard Windows wildcard characters.
`pTagName`	The tagname or tagname mask that you want to query.
`pTopic`	The message topic: Connections Configuration General Services Performance Security
`Parameters()`	Output display of the array formula. This field can include be one or more parameters.