AFGlobalSettings Class
- Last UpdatedNov 18, 2025
- 7 minute read
- PI System
- AF SDK 2024 R2
- Developer
All the global application settings.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFGlobalSettings
OSIsoft.AFAFGlobalSettings
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static class AFGlobalSettings
Public NotInheritable Class AFGlobalSettings
public ref class AFGlobalSettings abstract sealed
[<AbstractClassAttribute>] [<SealedAttribute>] type AFGlobalSettings = class end
The AFGlobalSettings type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| BestRssoRetrievalCooldown |
Used to update the cooldown period between checking for the Best RSSO Server.
Default is 5 seconds. Every call within the cooldown period will return the same Best RSSO.
| |
| CacheMaxObjects |
The maximum number of objects that the AF SDK will keep in its cache at any
one time.
| |
| CacheObjectCleanUpTimeout |
The timeout to clean up cached objects.
| |
| CacheTime |
The length of time, in seconds, that AF SDK objects will be kept in the cache,
provided there is room based on the MaxObjects property.
| |
| CertificateMode |
Setting determines the level of strictness required for certificate validation
| |
| CheckConnectAsDifferentUser |
Indicates if the current user should be checked when making a
remote call to the server.
| |
| CheckPIVersion |
Indicates if the version of the PIServer should be checked when making
a connection to the server.
| |
| CollectionPageSize |
The number of items on each page of a paged collection.
| |
| DataBufferOption |
Indicates the AFBufferOption to use when updating values.
| |
| DisableAuthenticationFallback | ||
| EnableBinaryFormatter |
Indicates if BinaryFormatterDeserialize should be enabled on the system.
| |
| EnableEnvironmentVariableSubstitution |
Indicates if Environment Variable Resolution in Data References should be enabled on the system.
| |
| IgnoreThreadCurrentPrincipal |
Setting to determine if the AFSDK should attempt to use user settings set on
CurrentPrincipal including user Id, Name, and access tokens.
| |
| MaxCheckIPTimeout |
The maximum timeout used to check that a bad host address has been fixed.
| |
| MaxSaveChangedItems |
The maximum number of items to save to the server at a time.
| |
| MinCheckIPTimeout |
The minimum timeout used to check that a bad host address has been fixed.
| |
| NextIDBlockSize |
The number of unique identifiers to allocate from the server at a time.
| |
| PIPointCacheUpdatePeriod |
The period to wait between updating PIPoint cache.
By default the period is zero which disables refresh.
| |
| PIServersDirectoryOptions |
The directory options used when looking up a PIServer in the collection.
| |
| PISystemOpenIdProxyPoolSize |
The number of OpenId proxies in the pool of connections to the PISystem.
| |
| PISystemProxyDisconnectTimeout |
The amount of time to allow a connection to the PISystem to
be disconnected before timing out.
| |
| PISystemProxyMaxParallelCalls |
The maximum number of parallel calls that can be made over a connection to the PISystem.
| |
| PISystemProxyPoolSize |
The number of proxies in the pool of connections to the PISystem.
| |
| PISystemsDirectoryOptions |
The directory options used when looking up a PISystem in the collection.
| |
| PreferOpenIdAuth |
Setting determines if Client initial connects should prompt for Authentication type selection
or default to using Windows or OpenId Connect.
| |
| RssoListTimeout |
The timeout period between retrieving a new list of valid RSSO Servers
from the current AF Server of PI Data Archive.
Default is 24 hours.
| |
| SDKVersion |
Read-only property contains a string that uniquely identifies the
current client version of the SDK.
| |
| ShowExcludedAttributes |
Setting determines if attributes with their IsExcluded
property set to are shown.
| |
| TaskSchedulerForAsyncEmulation |
Task scheduler to use when querying data from data references that do not natively support asynchronous calls.
If null, asynchronous calls are not supported if the data reference does not natively support them.
Write data methods are not emulated.
|
Remarks
This class includes all the global settings that can be set
for an application.