AFAnalysisTemplate Properties
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAnalysisTemplate type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AnalysisRule |
The instance of the analysis rule used by the AFAnalysisTemplate to
configure an analysis rule in an AFAnalysis created from this template.
| |
| AnalysisRulePlugIn |
The analysis rule plugin property is used to specify which
analysis rule will be used by the AFAnalysis to run the analysis.
| |
| CaseTemplate |
The AFElementTemplate that is used when creating a new AFCase
using one of the AFAnalysis.AddCase Overload
methods.
| |
| Categories |
This is a user-defined collection of categories for the object that can be used for
querying and/or reporting purposes.
| |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
| |
| CheckOutInfo |
This read-only property returns the checked out status information for the object.
| |
| CreateEnabled |
This property indicates whether any AFAnalysis created
from this template will have the initial Status
property set to Enabled or Disabled.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| ExtendedProperties |
A dictionary of extended properties that can be used to store application specific information.
| |
| GroupID |
Indicates the group identifier for the AFAnalysis created from this template.
| |
| HasNotificationTemplate |
This read-only property indicates if there is an AFNotificationTemplate
associated with this analysis template.
| |
| HasTarget |
This read-only property indicates if there is a target
associated with this analysis template.
| |
| ID |
Read-only property that provides a unique identifier for the object to be used for
quick access that is not dependent upon the index.
(Inherited from AFObject.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
This read-only property indicates whether the object has been modified since the
last save to the PI AF Server.
| |
| IsNew |
This read-only property indicates whether the object is new and has never been saved
to the PI AF Server.
| |
| Name |
Read/write property that identifies the name of the object.
| |
| None |
An AFAnalysisTemplate that represents no analysis template.
| |
| NotificationTemplate |
This property returns the AFNotificationTemplate that is associated with
this AFAnalysisTemplate.
| |
| OutputTime |
The analysis output time offset.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| Security |
This read-only property returns the AFSecurity information for the object.
| |
| Target |
The target of the analysis template.
| |
| TimeRule |
The instance of the time rule used by the AFAnalysisTemplate to
configure a time rule in an AFAnalysis created from this template.
| |
| TimeRulePlugIn |
The time rule plugin property is used to specify which
time rule will be used by the AFAnalysis to determine when the
analysis runs.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- AnalysisRule Property
- AnalysisRulePlugIn Property
- CaseTemplate Property
- Categories Property
- CategoriesString Property
- CheckOutInfo Property
- CreateEnabled Property
- Database Property
- Description Property
- ExtendedProperties Property
- GroupID Property
- HasNotificationTemplate Property
- HasTarget Property
- IsDirty Property
- IsNew Property
- Name Property
- None Property
- NotificationTemplate Property
- OutputTime Property
- Security Property
- Target Property
- TimeRule Property
- TimeRulePlugIn Property