Click or drag to resize
OSIsoft, LLC

AFAnalysisAnalysisRulePlugIn Property

The analysis rule plugin property is used to specify which analysis rule will be used by the AFAnalysis to run the analysis.

Namespace:  OSIsoft.AF.Analysis
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version:
public AFPlugIn AnalysisRulePlugIn { get; set; }

Property Value

Type: AFPlugIn
The analysis rule plugin used to create the analysis rule which runs the analysis.

The analysis uses the configured analysis rule to provide the logic to run the analysis. The list of available analysis rules available on the system is provided by the PISystem.AnalysisRulePlugIns collection. An instance of a analysis rule is created by an object which is derived the AFAnalysisRule base class that has been registered on the PI AF Server using the RegPlugIn utility.

If this analysis was created from an AFAnalysisTemplate then the value of this property is defined by the template and cannot be modified. In this case, changing the AFAnalysisTemplate.AnalysisRulePlugIn property also changes the value of this property.

Version Information


Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6, 2.5, 2.4
See Also
Enabling Operational Intelligence