Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAnalysisService.RuntimeInformationFields Property

AFAnalysisService.RuntimeInformationFields Property

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFAnalysisService.RuntimeInformationFields Property
This property is a collection of all the fields supported by PI Analysis Service for runtime query for this PISystem.

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public ICollection<string> RuntimeInformationFields { get; }
Public ReadOnly Property RuntimeInformationFields As ICollection(Of String)
	Get

Dim instance As AFAnalysisService
Dim value As ICollection(Of String)

value = instance.RuntimeInformationFields
public:
property ICollection<String^>^ RuntimeInformationFields {
	ICollection<String^>^ get ();
}
member RuntimeInformationFields : ICollection<string> with get

Property Value

Type: ICollectionString
A collection of all fields supported by the analysis service for runtime query for this PISystem.

Remarks

The following fields are supported in both QueryRuntimeInformation(String, String) and QueryRuntimeInformationTObject(String, String, FuncIListAFAnalysisServiceRuntimeFieldValue, TObject) queryString and fields arguments.

Field nameValue typeDescription
IDGuidAnalysis GUID
nameStringAnalysis name
categoryStringAnalysis category
descriptionStringAnalysis description
elementNameStringAnalysis element
templateStringAnalysis template, empty if none
pathStringFull path of the analysis
statusStringAnalysis status in the analysis service from the set of "Running", "Stopped", "Starting", "Stopping", "Error", "Warning", and "Suspended"
statusDetailStringError, warning and suspended status details when available
lastEvaluationStatusStringLast evaluation status from the set of "Success", "Error", and "Skipped"
lastEvaluationStatusDetailStringLast evaluation error details when available
lastLagDoubleThe last evaluation lag with respect to the trigger time in milliseconds
averageLagDoubleAverage evaluation lag with respect to the trigger time in milliseconds since service start
lastElapsedDoubleThe amount of time in milliseconds spent evaluating the last execution of the analysis
averageElapsedDoubleAverage amount of time in milliseconds spent evaluating the analysis since service start
lastTriggerTimeDateTimeThe last trigger time of the analysis
averageTriggerDoubleAverage time in milliseconds between two triggering events
successCountInt32Successful evaluation count since service start
errorCountInt32Failed evaluation count since service start
skipCountInt32Skipped evaluation count since service start

Additionally, the following directives can be used in both QueryRuntimeInformation(String, String) and QueryRuntimeInformationTObject(String, String, FuncIListAFAnalysisServiceRuntimeFieldValue, TObject) queryString to sort and limit the response.

Field nameValue typeDescription
sortByStringField name to sort by
sortOrderString"Asc" or "Desc" for ascending and descending sorting, respectively
maxCountInt32Maximum number or results to return

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in