AFNotificationRuleTemplate Properties
- Last UpdatedNov 18, 2025
- 4 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFNotificationRuleTemplate type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| 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.
| |
| ContentExample | ||
| CreateEnabled |
This property indicates whether any AFNotificationRule created
from this template will have the initial Status
property set to Enabled or Disabled.
| |
| Criteria |
This indicates the default search criteria for any AFNotificationRule created from this template.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| DefaultDeliveryFormats |
The collection of default AFDeliveryFormat objects for this template.
| |
| DeliveryFormats |
The collection of AFDeliveryFormat objects for this template.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| HasTarget |
This read-only property indicates if there is a target
associated with this AFNotificationRuleTemplate.
| |
| 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.
| |
| MultiTriggerEventOption |
This property specifies when an AFNotificationRule created from this template is sent
based on severity.
| |
| Name |
Read/write property that identifies the name of the object.
| |
| None |
A AFNotificationRuleTemplate that represents no notification rule template.
| |
| NonrepetitionInterval |
Non-repetition interval for the AFNotificationRule created from this template.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| ResendInterval |
The interval for resending the AFNotificationRule created from this template.
| |
| Security |
This read-only property returns the AFSecurity information for the object.
| |
| Subscribers |
The collection of AFNotificationRuleSubscriber objects used to create the
Subscribers collection for any AFNotificationRule
created from this template.
| |
| Target |
The target of the notification rule template.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- Categories Property
- CategoriesString Property
- CheckOutInfo Property
- ContentExample Property
- CreateEnabled Property
- Criteria Property
- Database Property
- DefaultDeliveryFormats Property
- DeliveryFormats Property
- Description Property
- HasTarget Property
- IsDirty Property
- IsNew Property
- MultiTriggerEventOption Property
- Name Property
- None Property
- NonrepetitionInterval Property
- ResendInterval Property
- Security Property
- Subscribers Property
- Target Property