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

AF SDK Reference

PISystem Properties

  • Last UpdatedNov 18, 2025
  • 7 minute read
PISystem Properties

The PISystem type exposes the following members.

Properties

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

See Also

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