PISystem Properties
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PISystem type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| AliasNames |
The list of alias names for the PISystem.
| |
| AnalysisRulePlugIns |
Gets the collection of AFAnalysisRule
plugin objects maintained by the PISystem.
| |
| AnalysisService |
This property returns the AFAnalysisService object associated with this PISystem.
| |
| AuthenticationMode |
Read-only property that returns the Authentication Mode of the .
| |
| AutoCreateNotificationsEnabled |
Gets or sets a value indicating if the AutoCreate
option is enabled for the PISystem.
| |
| Collective |
This property returns information and status about the PI AF Server collective.
| |
| ConfigStringValidationEnabled |
Gets or sets a value indicating if plugins are enabled to validate configuration strings when set.PISystem.
| |
| ConfiguredOidcIdentities |
Read-only property that returns the a collection of the configured AFOidcIdentity of the .
| |
| ConfiguredRoles |
Read-only property that returns the a collection of the configured Roles of the .
| |
| ConnectionInfo |
This property returns information about the connection to the PI AF Server from
the local computer.
| |
| CurrentUserIdentities |
Gets the list of AFSecurityIdentity identities of the person who is currently
logged on to the PISystem server.
| |
| CurrentUserIdentityString |
Gets the security identity string of the person who is currently logged on to the PISystem server.
| |
| CurrentUserName |
Gets the user name of the person who is currently logged on to the PISystem server.
| |
| Databases |
This property provides access to the AFDatabases collection that
corresponds to the list of databases that have been created on this PISystem.
| |
| DatabaseVersion |
Read-only property that contains a string that uniquely identifies the current
database version.
| |
| DataReferencePlugIns |
Gets the collection of AFDataReference
plugin objects maintained by the PISystem.
| |
| DefaultAuthenticationMode |
Returns AFAuthenticationMode shared by parent collection.
| |
| DefaultPIServerName | ||
| DeliveryChannelPlugIns |
Gets the collection of AFDeliveryChannel
plugin objects maintained by the PISystem.
| |
| DeliveryFormats |
The collection of global AFDeliveryFormat objects.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| EventsEnabled |
Gets or sets a value indicating if events are enabled for the PISystem.
| |
| ExtendedProperties |
A dictionary of extended properties that can be used to store application specific information.
| |
| FileAllowedExtensions |
The list of valid file extensions for an AFFile.
| |
| FileMaxLength |
The maximum allowed file size for an AFFile.
| |
| HasItemsCheckedOut |
Determines if any items are currently checked out in the PISystem.
| |
| HasItemsCheckedOutToMe |
Determines if any items are currently checked out to the current user in the
PISystem.
| |
| 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.) | |
| IdentityServerAuthorizationEndpoint |
Read-only property that returns the Authorization Endpoint for the Identity Server for the .
Will match unless connecting to a different RSSO Server.
| |
| IdentityServerEndpointAddress |
Read-only property that returns the endpoint address for the Primary Identity Server for the .
| |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDirty |
Indicates whether there are system level objects in the PISystem that
have been modified since the last save in to persistent storage.
| |
| IsReadOnly |
True if operations that make modifications are blocked on this instance.
| |
| IsShared |
True if this instance is shared with other users with the same set of identities.
| |
| Libraries |
This property provides access to the AFLibraries collection that
corresponds to the list of known libraries on the server.
| |
| Name |
This property identifies the name of the PISystem.
| |
| NotificationContactTemplates |
Gets the collection of top-level pre-configured notification contacts maintained
on this PISystem.
| |
| 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.
| |
| SecurityIdentities |
This property provides access to the AFSecurityIdentities collection that
corresponds to the list of security identities on the server.
| |
| SecurityMappings |
This property provides access to the AFSecurityMappings collection that
corresponds to the list of security mappings on the server.
| |
| SelectedAuthenticationMode |
Returns the AFAuthenticationMode for the current connection.
If not connected, None is returned.
| |
| ServerTime |
Gets the current time of the PI AF Server.
| |
| ServerTimeZone |
Gets the current time zone of the PI AF Server.
| |
| ServerVersion |
Read-only property that contains a string that uniquely identifies the current
server version.
| |
| TimeRulePlugIns |
Gets the collection of AFTimeRule
plugin objects maintained by the PISystem.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) | |
| UOMDatabase |
This property provides access to the UnitsOfMeasure database
UOMDatabase that
contains the UnitsOfMeasure that have been created on the PISystem.
| |
| UsingDefaultAuthenticationMode |
Returns true if PISystem is using the default shared AFAuthenticationMode |
See Also
In This Topic
Related Links
- AliasNames Property
- AnalysisRulePlugIns Property
- AnalysisService Property
- AuthenticationMode Property
- AutoCreateNotificationsEnabled Property
- Collective Property
- ConfigStringValidationEnabled Property
- ConfiguredOidcIdentities Property
- ConfiguredRoles Property
- ConnectionInfo Property
- CurrentUserIdentities Property
- CurrentUserIdentityString Property
- CurrentUserName Property
- Databases Property
- DatabaseVersion Property
- DataReferencePlugIns Property
- DefaultAuthenticationMode Property
- DefaultPIServerName Property
- DeliveryChannelPlugIns Property
- DeliveryFormats Property
- Description Property
- EventsEnabled Property
- ExtendedProperties Property
- FileAllowedExtensions Property
- FileMaxLength Property
- HasItemsCheckedOut Property
- HasItemsCheckedOutToMe Property
- IdentityServerAuthorizationEndpoint Property
- IdentityServerEndpointAddress Property
- IsDirty Property
- IsReadOnly Property
- IsShared Property
- Libraries Property
- Name Property
- NotificationContactTemplates Property
- Security Property
- SecurityIdentities Property
- SecurityMappings Property
- SelectedAuthenticationMode Property
- ServerTime Property
- ServerTimeZone Property
- ServerVersion Property
- TimeRulePlugIns Property
- UOMDatabase Property
- UsingDefaultAuthenticationMode Property