EventFrame schema
- Last UpdatedNov 10, 2023
- 4 minute read
Table and table-valued function templates from the event frame schema are covered in this topic. Each section describes their template parameters and the structure of the template specializations.
Master.EventFrame.Value
Its specialization are tables that contain current values of selected event frame attributes.
Template parameters
|
Name |
Data type |
|---|---|
|
Template |
String |
|
AttributeMetaData |
Array of tuple parameters |
AttributeMetaData sub-parameters
|
Name |
Data type |
Is nullable? |
Null behavior |
Is optional? |
|---|---|---|---|---|
|
AttributeTemplatePath |
String |
No |
N/A |
No |
|
TimeStampColumnName |
String |
Yes |
Column is excluded |
No |
|
ValueColumnName |
String |
No |
N/A |
No |
|
UnitOfMeasureColumnName |
String |
Yes |
Column is excluded |
Yes |
|
ErrorColumnName |
String |
Yes |
Column is excluded |
Yes |
|
UnitOfMeasure |
String |
Yes |
Default UOM |
Yes |
Columns
|
Name |
Data type |
Is nullable? |
Primary key |
|---|---|---|---|
|
EventFrameID |
Guid |
No |
Yes |
|
<TimeStampColumnName> |
DateTime |
No |
No |
|
<ValueColumnName> |
Yes |
No |
|
|
<UnitOfMeasureColumnName> |
String |
Yes |
No |
|
<ErrorColumnName> |
String |
Yes |
No |
Master.EventFrame.GetSampledValue
Its specializations are table-valued functions that return sampled values at the specified time.
Template parameters
|
Name |
Data type |
|---|---|
|
Template |
String |
|
AttributeMetaData |
Array of tuple parameters |
AttributeMetaData sub-parameters
|
Name |
Data type |
Is nullable? |
Null behavior |
Is optional? |
|---|---|---|---|---|
|
AttributeTemplatePath |
String |
No |
N/A |
No |
|
ValueColumnName |
String |
No |
N/A |
No |
|
UnitOfMeasureColumnName |
String |
Yes |
Column is excluded |
Yes |
|
ErrorColumnName |
String |
Yes |
Column is excluded |
Yes |
|
UnitOfMeasure |
String |
Yes |
Default UOM |
Yes |
Parameters
|
Name |
Data type |
|---|---|
|
EventFrameID |
Guid |
|
Time |
DateTime |
Columns
|
Name |
Data type |
Is nullable? |
Primary key |
|---|---|---|---|
|
<ValueColumnName> |
Yes |
No |
|
|
<UnitOfMeasureColumnName> |
String |
Yes |
No |
|
<ErrorColumnName> |
String |
Yes |
No |
Master.EventFrame.GetSampledValues
Its specializations are table-valued functions that return several sampled values within the specified time range.
Template parameters
|
Name |
Data type |
|---|---|
|
Template |
String |
|
AttributeMetaData |
Array of tuple parameters |
AttributeMetaData sub-parameters
|
Name |
Data type |
Is nullable? |
Null behavior |
Is optional? |
|---|---|---|---|---|
|
AttributeTemplatePath |
String |
No |
N/A |
No |
|
ValueColumnName |
String |
No |
N/A |
No |
|
UnitOfMeasureColumnName |
String |
Yes |
Column is excluded |
Yes |
|
ErrorColumnName |
String |
Yes |
Column is excluded |
Yes |
|
UnitOfMeasure |
String |
Yes |
Default UOM |
Yes |
Parameters
|
Name |
Data type |
|---|---|
|
EventFrameID |
Guid |
|
StartTime |
DateTime |
|
EndTime |
DateTime |
|
TimeStep |
TimePeriod |
Columns
|
Name |
Data type |
Is nullable? |
Primary key |
|---|---|---|---|
|
TimeStamp |
DateTime |
No |
Yes |
|
<ValueColumnName> |
Yes |
No |
|
|
<UnitOfMeasureColumnName> |
String |
Yes |
No |
|
<ErrorColumnName> |
String |
Yes |
No |
Master.EventFrame.GetSummaries
Its specializations are table-valued functions that return several summaries over a time range for each interval within the range. For more information, see the AF SDK Reference page AFData.Summaries Method.
Template parameters
|
Name |
Data type |
|---|---|
|
Template |
String |
|
AttributeMetaData |
Array of tuple parameters |
AttributeMetaData sub-parameters
|
Name |
Data type |
Is nullable? |
Null behavior |
Is optional? |
|---|---|---|---|---|
|
AttributeTemplatePath |
String |
No |
N/A |
No |
|
SummaryType |
String |
No |
N/A |
No |
|
CalculationBasis |
String |
No |
N/A |
No |
|
ValueColumnName |
String |
No |
N/A |
No |
|
UnitOfMeasureColumnName |
String |
Yes |
Column is excluded |
Yes |
|
ErrorColumnName |
String |
Yes |
Column is excluded |
Yes |
|
UnitOfMeasure |
String |
Yes |
Default UOM |
Yes |
|
ValueTimeStampColumnName |
String |
Yes |
Column is excluded |
Yes |
For allowed values of the template arguments, see the following the AF SDK Reference pages:
-
SummaryType: AFSummaryTypes Enumeration
-
CalculationBasis: AFCalculationBasis Enumeration
Parameters
Name
Data type
EventFrameID
Guid
StartTime
DateTime
EndTime
DateTime
TimeStep
TimePeriod
TimeType
String
Note: The following values are allowed for the TimeType argument:
1 - EarliestTime - The timestamp returned will be for the start of the summary period.
2 - MostRecentTime - The timestamp returned will be for the end of the summary period.
For more information about the TimeType argument in general, see the AF SDK Reference page TimeType: AFTimestampCalculation Enumeration.
Columns
Name
Data type
Is nullable?
Primary key
TimeStamp
DateTime
No
Yes
<ValueColumnName>
Double
Yes
No
<UnitOfMeasureColumnName>
String
Yes
No
<ErrorColumnName>
String
Yes
No
Master.EventFrame.GetSummary
Its specializations are table-valued functions that return summaries over a single time range. For more information, see the AF SDK Reference page AFData.Summary Method.
Template parameters
|
Name |
Data type |
|---|---|
|
Template |
String |
|
AttributeMetaData |
Array of tuple parameters |
AttributeMetaData sub-parameters
|
Name |
Data type |
Is nullable? |
Null behavior |
Is optional? |
|---|---|---|---|---|
|
AttributeTemplatePath |
String |
No |
N/A |
No |
|
SummaryType |
String |
No |
N/A |
No |
|
CalculationBasis |
String |
No |
N/A |
No |
|
ValueColumnName |
String |
No |
N/A |
No |
|
UnitOfMeasureColumnName |
String |
Yes |
Column is excluded |
Yes |
|
ErrorColumnName |
String |
Yes |
Column is excluded |
Yes |
|
UnitOfMeasure |
String |
Yes |
Default UOM |
Yes |
|
ValueTimeStampColumnName |
String |
Yes |
Column is excluded |
Yes |
For allowed values of the template arguments, see the following AF SDK Reference pages:
-
SummaryType: AFSummaryTypes Enumeration
-
CalculationBasis: AFCalculationBasis Enumeration
Parameters
Name
Data type
EventFrameID
Guid
StartTime
DateTime
EndTime
DateTime
Columns
Name
Data type
Is nullable?
Primary key
<ValueColumnName>
Double
Yes
No
<UnitOfMeasureColumnName>
String
Yes
No
<ErrorColumnName>
String
Yes
No
Master.EventFrame.GetSummary based on event frame start and end time
Its specializations are table-valued functions that calculate event frame summary based on the event frame start time and event frame end time. For more information, see the AF SDK Reference page AFData.Summary Method.
Template parameters
|
Name |
Data type |
|---|---|
|
Template |
String |
|
AttributeMetaData |
Array of tuple parameters |
AttributeMetaData sub-parameters
|
Name |
Data type |
Is nullable? |
Null behavior |
Is optional? |
|---|---|---|---|---|
|
AttributeTemplatePath |
String |
No |
N/A |
No |
|
SummaryType |
String |
No |
N/A |
No |
|
CalculationBasis |
String |
No |
N/A |
No |
|
ValueColumnName |
String |
No |
N/A |
No |
|
UnitOfMeasureColumnName |
String |
Yes |
Column is excluded |
Yes |
|
ErrorColumnName |
String |
Yes |
Column is excluded |
Yes |
|
UnitOfMeasure |
String |
Yes |
Default UOM |
Yes |
|
ValueTimeStampColumnName |
String |
Yes |
Column is excluded |
Yes |
For allowed values of the template arguments, see the following AF SDK Reference pages:
-
SummaryType: AFSummaryTypes Enumeration
-
CalculationBasis: AFCalculationBasis Enumeration
Parameters
Name
Data type
EventFrameID
Guid
Columns
Name
Data type
Is nullable?
Primary key
<ValueColumnName>
Double
Yes
No
<UnitOfMeasureColumnName>
String
Yes
No
<ErrorColumnName>
String
Yes
No