PISystem Methods
- Last UpdatedNov 18, 2025
- 13 minute read
- PI System
- AF SDK 2024 R2
- Developer
The PISystem type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | ApplyChanges |
This method applies (saves) all the changes to objects modified at the system level by the current user and
makes those changes available to other applications executing under the same user account.
|
| ApplyChanges(AFCheckedOutMode) |
This method applies (saves) all the changes to objects modified at the system level according
to the specified AFCheckedOutMode and makes those changes available to other
applications executing under the same user account.
|
| ApplyChanges(IListIAFTransactable) |
This method applies (saves) the changes to the specified modified objects and makes
those changes available to other objects.
|
| CanCreateCollective |
Check if a collective can be created for this PISystem.
|
| CheckIn |
This method checks in (commits) all the changes to all modified objects at the system level
by saving the object's information to persistent storage.
|
| CheckIn(AFCheckedOutMode) |
This method checks in (commits) all the changes to all modified objects at the system level
by saving the object's information to persistent storage according to the specified
AFCheckedOutMode.
|
| CheckIn(IListIAFTransactable) |
This method checks in (commits) the changes to the specified modified objects
by saving the object's information to persistent storage.
|
| CompareTo(Object) |
Compares this instance with a specified Object.
(Inherited from AFObject.) |
| CompareTo(AFObject) |
Compares this instance with a specified AFObject.
(Inherited from AFObject.) |
| Connect |
Connects to the server using default credentials to allow sending and retrieving data.
|
| Connect(NetworkCredential) |
Connects to the server using the specified credentials to allow sending and retrieving data.
|
| Connect(String) |
Connects to the server using the specified Access Token to allow sending and retrieving data.
|
| Connect(AFConnectionPreference) |
Connects to the server using the specified connection preference to allow sending and retrieving data.
|
| Connect(Boolean, IWin32Window) |
Connects to the server with a credential prompt if necessary to allow sending and retrieving data.
|
| Connect(NetworkCredential, AFConnectionPreference) |
Connects to the server using the specified credentials and connection preference
to allow sending and retrieving data.
|
| Connect(String, AFConnectionPreference) |
Connects to the server using the specified Access Token to allow sending and retrieving data.
|
| Connect(String, String) |
Connects to the server using the specified credentials to allow sending and retrieving data.
|
| Connect(Boolean, IWin32Window, AFConnectionPreference) |
Connects to the server using the specified connection preference with a credential prompt
if necessary to allow sending and retrieving data.
|
| Connect(String, String, AFConnectionPreference) |
Connects to the server using the specified credentials to allow sending and retrieving data.
|
| Connect(Boolean, IWin32Window, AFConnectionPreference, Boolean) |
Connects to the server using the specified connection preference with a credential prompt
if necessary to allow sending and retrieving data and return an indication that dialog was canceled.
|
| ConnectWithPrompt |
Connects to the server prompting for credentials.
|
| ConnectWithPrompt(IWin32Window) |
Connects to the server prompting for credentials.
|
| ConnectWithPrompt(AFConnectionPreference) |
Connects to the server prompting for credentials and specifying a connection preference.
|
| ConnectWithPrompt(IWin32Window, AFConnectionPreference) |
Connects to the server prompting for credentials and specifying a connection preference.
|
| CreateCollective |
Convert the PISystem into a member of a new AFCollective.
|
 | CreatePISystem |
Create a new PISystem instance based upon the specified host address.
|
| Disconnect |
Disconnects an open connection to the PI AF Server.
|
| Equals(Object) |
Determines whether the specified Object is equal to the current object.
(Overrides AFObjectEquals(Object).) |
| Equals(AFObject) |
Indicates whether the current object is equal to another object of the same type.
(Inherited from AFObject.) |
| Equals(PISystem) |
Indicates whether the current object is equal to another object of the same type.
|
| ExportCsv(Object, IListType, IListString, CultureInfo) |
Exports the CSV representation of requested object(s) and returns it as a string.
|
| ExportCsv(Object, IListType, IListString, PIExportMode, CultureInfo) |
Exports the CSV representation of requested object(s) and returns it as a string.
|
| ExportCsv(Object, IListType, IListString, CultureInfo, String, Object, Object, EventHandlerAFProgressEventArgs) |
Exports the representation of requested object(s) in comma-separated (CSV) format to a file.
|
| ExportCsv(Object, IListType, IListString, PIExportMode, CultureInfo, String, Object, Object, EventHandlerAFProgressEventArgs) |
Exports the representation of requested object(s) in comma-separated (CSV) format to a file.
|
| ExportXml(Object, PIExportMode) |
Exports the XML representation of any object(s) and returns it as a string.
|
| ExportXml(Object, PIExportMode, String, Object, Object, EventHandlerAFProgressEventArgs) |
Exports the XML representation of any object(s) to a file.
|
| ExportXml(Object, PIExportMode, XmlWriter, Object, Object, EventHandlerAFProgressEventArgs) |
Exports the XML representation of any object(s) to an XmlWriter.
|
| FindChangedItems(Boolean, AFTime, AFTime) | Obsolete.
Find all the items that have changed in the PISystem.
|
| FindChangedItems(Boolean, Int32, Object, Object) |
Find all the items that have changed in the PISystem for all types of objects.
|
| FindChangedItems(AFIdentity, Boolean, AFTime, AFTime) | Obsolete.
Find all the items that have changed in the PISystem of the
specified type.
|
| FindChangedItems(Boolean, Boolean, Int32, Object, Object) |
Find all the items that have changed in the PISystem with the option to retrieve both the
system and database level changes.
|
| FindChangedItems(AFIdentity, Boolean, Int32, Object, Object) |
Find all the items that have changed in the PISystem of the specified type.
|
| FindChangedItems(AFIdentity, Boolean, Boolean, Int32, Object, Object) |
Find all the items that have changed in the PISystem of the specified type with the option
to retrieve both the system and database level changes.
|
| FindCheckedOutItems |
This method finds all the items that are currently checked out in the
PISystem.
|
| GetActiveDirectoryProperties |
Retrieves the Active Directory settings the server uses to retrieve contact information.
|
| GetAnonymousClientChannelTChannel |
Creates a ChannelFactory. The factory will be created using the provided binding and address. The channel will use a TLS connection with no client credentials.
|
| GetClientChannelTChannel |
Creates a ChannelFactory. The factory will be created using the appropriate binding and address based on the AFAuthenticationMode the PISystem is currently connected with.
|
| GetClientRpcMetrics |
Get the remote procedure call metrics to the server for this PISystem.
|
| GetCsvColumns(Type) |
Retrieve a collection containing the required and optional CSV columns for the specified
object type and its children.
|
| GetCsvColumns(Type, IListType) |
Retrieve a collection containing the required and optional CSV columns for the specified
object type and its children.
|
| GetFindChangedItemsCookie |
Retrieve the server cookie used in conjunction with FindChangedItems.
|
| GetHashCode |
Gets the hash code for this instance of the object which is suitable for use in hashing
algorithms and data structures like a hash table.
(Overrides AFObjectGetHashCode.) |
| GetIdentityProvidersandRoles |
Returns a collection of the configured Roles of the .
|
| GetIdentityServerBestRsso |
Method to retrieve the Best Redundant Single Sign-On Server Endpoint for the Identity Server for the .
|
| GetObjectCounts |
Gets the total number of objects by type in the database.
|
| GetPath |
Returns the full path to the object, using just the names.
(Inherited from AFObject.) |
| GetPath(AFObject) |
Returns the path to the object relative from another object.
(Inherited from AFObject.) |
| GetPath(AFEncodeType, AFObject) |
Returns the path to the object relative from another object,
using the name and/or id as specified
by encodeType.
(Inherited from AFObject.) |
| GetRpcMetrics |
Get the remote procedure call metrics for the server.
|
| GetSecurity |
Gets the AFSecurity information of the specified security item
associated with the object.
|
| GetSessions(NullableAFTime, NullableAFTime, AFSortOrder, Int32, Int32) |
Retrieves session data for the specified filter criteria.
|
| GetSessions(NullableAFTime, NullableAFTime, AFSessionSortField, AFSortOrder, Int32, Int32) |
Retrieves session data for the specified filter criteria.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| ImportCsv(AFDatabase, PIImportMode, CultureInfo, Stream, EventHandlerAFProgressEventArgs) |
Imports the comma-separated value (CSV) representation of any object from a stream.
|
| ImportCsv(AFDatabase, PIImportMode, CultureInfo, String, EventHandlerAFProgressEventArgs) |
Imports the comma-separated value (CSV) representation of any object from a file.
|
| ImportXml(Object, PIImportMode, String) |
Imports the XML representation of any object from either a file or string.
|
| ImportXml(Object, PIImportMode, Stream, EventHandlerAFProgressEventArgs) |
Imports the XML representation of any object from a stream.
|
| ImportXml(Object, PIImportMode, XmlReader, EventHandlerAFProgressEventArgs) |
Imports the XML representation of any object from an XmlTextReader.
|
| LogOut |
Logs out the current OIDC user and disconnects all associated open connections to the PI AF Server.
|
| Persist |
This method returns the persistence string for the object.
(Inherited from AFObject.) |
| Refresh |
Refreshes the client with any changes that have been made to any system-level object since loaded.
|
| Refresh(Boolean) |
Refreshes the client with any changes that have been made to any system-level and optionally
database-level objects since loaded.
|
| Refresh(IEnumerableAFObject) |
Refreshes the client with any changes that have been made to the specified objects since they were loaded.
|
| RemovePlugInAssembly |
Removes a AFPlugIn assembly from the database.
|
| RemovePlugInSupportAssembly |
Removes an AFPlugIn support assembly from the database.
|
| SetActiveDirectoryProperties |
Sets the Active Directory settings the server uses to retrieve contact information.
|
| Supports(PISystemFeatures) |
Checks if the specified PISystemFeatures feature is supported by
the PISystem.
|
| Supports(String, Boolean) |
Checks if the specified feature is supported by the PISystem.
|
| ToString |
Returns a String that represents the current object.
(Inherited from AFObject.) |
| UndoCheckOut |
Rolls back all the changes to the system since the last call to the
CheckOut method of each object. Any
changes since the check out will be lost.
|
| UploadPlugInAssembly |
Uploads a AFPlugIn assembly to the database.
|
| UploadPlugInSupportAssembly |
Uploads a AFPlugIn support assembly to the database.
|
See Also
In This Topic
Related Links
- ApplyChanges Method
- CanCreateCollective Method
- CheckIn Method
- Connect Method
- ConnectWithPrompt Method
- CreateCollective Method
- CreatePISystem Method
- Disconnect Method
- Equals Method
- ExportCsv Method
- ExportXml Method
- FindChangedItems Method
- FindCheckedOutItems Method
- GetActiveDirectoryProperties Method
- GetAnonymousClientChannel(TChannel) Method
- GetClientChannel(TChannel) Method
- GetClientRpcMetrics Method
- GetCsvColumns Method
- GetFindChangedItemsCookie Method
- GetHashCode Method
- GetIdentityProvidersandRoles Method
- GetIdentityServerBestRsso Method
- GetObjectCounts Method
- GetRpcMetrics Method
- GetSecurity Method
- GetSessions Method
- ImportCsv Method
- ImportXml Method
- LogOut Method
- Refresh Method
- RemovePlugInAssembly Method
- RemovePlugInSupportAssembly Method
- SetActiveDirectoryProperties Method
- Supports Method
- UndoCheckOut Method
- UploadPlugInAssembly Method
- UploadPlugInSupportAssembly Method