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

AF SDK Reference

AFAnalysisTemplate Properties

  • Last UpdatedNov 18, 2025
  • 5 minute read
AFAnalysisTemplate Properties

The AFAnalysisTemplate type exposes the following members.

Properties

  NameDescription
Public property
AnalysisRule
The instance of the analysis rule used by the AFAnalysisTemplate to configure an analysis rule in an AFAnalysis created from this template.
Public property
AnalysisRulePlugIn
The analysis rule plugin property is used to specify which analysis rule will be used by the AFAnalysis to run the analysis.
Public property
CaseTemplate
The AFElementTemplate that is used when creating a new AFCase using one of the AFAnalysis.AddCase Overload methods.
Public property
Categories
This is a user-defined collection of categories for the object that can be used for querying and/or reporting purposes.
Public property
CategoriesString
This read-only property returns the list of categories in a string separated by semicolons.
Public property
CheckOutInfo
This read-only property returns the checked out status information for the object.
Public property
CreateEnabled
This property indicates whether any AFAnalysis created from this template will have the initial Status property set to Enabled or Disabled.
Public property
Database
This read-only property returns the AFDatabase where this object is defined.
Public property
Description
Read/write property that provides a more detailed description of the object.
Public property
ExtendedProperties
A dictionary of extended properties that can be used to store application specific information.
Public property
GroupID
Indicates the group identifier for the AFAnalysis created from this template.
Public property
HasNotificationTemplate
This read-only property indicates if there is an AFNotificationTemplate associated with this analysis template.
Public property
HasTarget
This read-only property indicates if there is a target associated with this analysis template.
Public property
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.)
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFObject.)
Public property
IsDeleted
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.)
Public property
IsDirty
This read-only property indicates whether the object has been modified since the last save to the PI AF Server.
Public property
IsNew
This read-only property indicates whether the object is new and has never been saved to the PI AF Server.
Public property
Name
Read/write property that identifies the name of the object.
Public propertyStatic member
None
An AFAnalysisTemplate that represents no analysis template.
Public property
NotificationTemplate
This property returns the AFNotificationTemplate that is associated with this AFAnalysisTemplate.
Public property
OutputTime
The analysis output time offset.
Public property
PISystem
This read-only property allows access to the PISystem associated with this object.
(Inherited from AFObject.)
Public property
Security
This read-only property returns the AFSecurity information for the object.
Public property
Target
The target of the analysis template.
Public property
TimeRule
The instance of the time rule used by the AFAnalysisTemplate to configure a time rule in an AFAnalysis created from this template.
Public property
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.
Public property
UniqueID
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.)

See Also

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