PISystemFeatures Enumeration
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
This enumeration represents the features that may be enabled or disabled for
the PISystem.
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public enum PISystemFeatures
Public Enumeration PISystemFeatures Dim instance As PISystemFeatures
public enum class PISystemFeatures
type PISystemFeatures
Members
| Member name | Value | Description | |
|---|---|---|---|
| None | 0 | No feature is specified. | |
| AdminFunctionality | 11 | Indicates whether the PISystem supports administrative functionality when using the methods in the AFAdmin class. | |
| Analysis | 1 | The PISystem supports AFAnalysis objects. | |
| AttributeTrait | 536870912 | Indicates whether the PISystem supports the Trait property. | |
| BaseTemplateOnly | 10 | Indicates whether the PISystem supports the BaseTemplateOnly property. | |
| CollectiveMembersUseCertificates | 512 | The PISystem HA members use certificates to establish connections between members. | |
| EFAttributeValueCapture | 131072 | Indicates whether the PISystem has event frame attribute value capture enabled. If enabled, the AFAttribute values for the AFEventFrame will be captured when its EndTime is set. Once captured, the attribute values will be cached and the AFDataReference will not be used to read their values. See AreValuesCaptured for more information. | |
| EnablePropagationOfTargetDeletion | 8192 | Indicates whether the PISystem has the propagation of target deletion enabled. If enabled, the deletion of an AFElementTemplate will delete any AFAnalysisTemplate or AFNotificationTemplate that targets the element template. Also when enabled, the deletion of an AFElement will delete any AFAnalysis or AFNotification that targets the element. | |
| EndTimeSearch | 1024 | The PISystem supports searching for an AFEventFrame by end time when specifying the AFSortField parameter or the AFEventFrameSearchMode parameter. | |
| ExternallyLinkedTable | 64 | The PISystem supports linking to external tables. See LinkExternal(IDbDataAdapter, Boolean, SecureString) for more details. | |
| ExternallyLinkedTableWithNonImpersonatedUser | 256 | The PISystem supports linking to external tables with a non-impersonated user. If supported, an externally linked AFTable is not required to use client impersonation. See LinkExternal(IDbDataAdapter, Boolean, SecureString) for more details. | |
| ExternallyLinkedTableWithSecurity | 128 | The PISystem supports linking to external tables with enhanced security. If supported, an externally linked AFTable can use client impersonation or specify an encrypted password. See LinkExternal(IDbDataAdapter, Boolean, SecureString) for more details. | |
| EventFrame | 8 | The PISystem supports AFEventFrame objects. | |
| EventFrameAcknowledgement | 134217728 | Indicates whether the PISystem supports Severity and CanBeAcknowledged properties in the AFEventFrame class. It also indicates that the GetAnnotations method is supported on elements. | |
| FindElementsByAttribute | 32 | The PISystem supports the FindElementsByAttribute(AFElement, String, AFAttributeValueQuery, Boolean, AFSortField, AFSortOrder, Int32, Int32, Int32) method. | |
| HiddenAndExcludedAttributes | 524288 | Indicates whether the PISystem supports marking attribute's IsHidden and/or IsExcluded properties. | |
| HighAvailability | 16 | The PISystem supports high availability using an AFCollective. | |
| InProgressSearch | 65536 | The PISystem supports searching for an AFEventFrame that is in progress when specifying the AFSearchMode parameter or the AFEventFrameSearchMode parameter. | |
| Model | 4194304 | The PISystem supports AFModel objects. | |
| ModelAnalysis | 8388608 | The PISystem supports AFModelAnalysis and AFCase objects. | |
| ModifyAttributeDescription | 3 | Indicates whether the PISystem supports overriding an attribute's Description that is defined by a template. If this feature is not supported, then the attribute's description cannot be modified if the attribute was created from an AFAttributeTemplate. It also indicates that the PISystem supports adding element categories regardless of its template's AllowElementToExtend setting. | |
| NoSandbox | 4096 | The PISystem does not support sandbox for saving objects to the server. If not supported, then ApplyChanges will save changes to the server but the AF SDK will manage the objects that are not checked into the server. | |
| Notification | 2 | The PISystem supports AFNotification objects. | |
| NotificationRule | 268435456 | Indicates whether the PISystem supports the AFNotificationRule objects. | |
| NotificationTemplate | 4 | The PISystem supports AFNotificationTemplate objects. | |
| OwnerSecurity | 7 | Indicates whether the PISystem supports the Owner security. | |
| QuerySearch | 67108864 | Indicates whether the PISystem supports the AFElementSearch, AFEventFrameSearch, AFNotificationRuleTemplateSearch, and AFNotificationRuleSearch query searches. | |
| QuerySearchAnalysis | 1073741824 | Indicates whether the PISystem supports the AFAnalysisTemplateSearch, AFAnalysisSearch, AFCaseSearch, and AFTransferSearch query searches. It also indicates that the PISystem supports the FindObjectIds(Int32, Int32) method. | |
| QuerySearchAttribute | 6 | Indicates whether the PISystem supports the AFAttributeSearch and AFNotificationContactTemplateSearch query searches. | |
| QuerySearchValueByPath | 9 | Indicates whether the PISystem supports the attribute value search by path. /> query searches. | |
| ResyncUsers | 12 | Indicates whether the PISystem supports the ResyncUsers(PISystem) method. | |
| SecurityIdentity | 262144 | Indicates whether the PISystem supports the new Access Control List (ACL) security format. If supported, the AFSecurityMapping and AFSecurityIdentity classes can be used. | |
| TableConnection | 16384 | The PISystem supports table connections that can be used to populate an AFTable object. If supported, a table connection AFTableConnection can be defined and used with different AFTable objects. | |
| TableParameters | 32768 | The PISystem supports parameters in the command string passed to create or update an AFTable. | |
| TableTimeColumn | 2048 | The PISystem supports time column. If supported, a table data reference AFTable can define a column to expose the table data as a time series. | |
| Transfer | 2097152 | The PISystem supports AFTransfer objects. | |
| UomCaseSensitive | 33554432 | Indicates whether the PISystem supports UOM case-sensitive abbreviations. When this is enabled, the correct case for the abbreviation must be used when looking up the UOM because there may be abbreviations that only differ by case. | |
| UomGroup | 5 | Indicates whether the PISystem supports UomGroup mappings. | |
| Versioning | 16777216 | Indicates whether the PISystem supports creating multiple versions of IAFVersionable objects. If versioning is not supported, then only a single version of an object can be created. |
Remarks
The supported features can be checked for a PISystem by calling
its Supports(PISystemFeatures) method. Supported features are determined
by the version of the PI AF Server and what the server reports that it supports.