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

AF SDK Reference

AFGlobalSettings Class

  • Last UpdatedNov 18, 2025
  • 7 minute read
AFGlobalSettings Class
All the global application settings.

Inheritance Hierarchy

SystemObject
  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

You do not need to declare an instance of a static class in order to access its members.
public ref class AFGlobalSettings abstract sealed
[<AbstractClassAttribute>]
[<SealedAttribute>]
type AFGlobalSettings =  class end

The AFGlobalSettings type exposes the following members.

Properties

  NameDescription
Public propertyStatic member
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.
Public propertyStatic member
CacheMaxObjects
The maximum number of objects that the AF SDK will keep in its cache at any one time.
Public propertyStatic member
CacheObjectCleanUpTimeout
The timeout to clean up cached objects.
Public propertyStatic member
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.
Public propertyStatic member
CertificateMode
Setting determines the level of strictness required for certificate validation
Public propertyStatic member
CheckConnectAsDifferentUser
Indicates if the current user should be checked when making a remote call to the server.
Public propertyStatic member
CheckPIVersion
Indicates if the version of the PIServer should be checked when making a connection to the server.
Public propertyStatic member
CollectionPageSize
The number of items on each page of a paged collection.
Public propertyStatic member
DataBufferOption
Indicates the AFBufferOption to use when updating values.
Public propertyStatic member
DisableAuthenticationFallback
Controls fallback authentication behavior if OIDC is set as the default mode and the current PISystem or PIServer being connected to does not support OIDC connections.
Public propertyStatic member
EnableBinaryFormatter
Indicates if BinaryFormatterDeserialize should be enabled on the system.
Public propertyStatic member
EnableEnvironmentVariableSubstitution
Indicates if Environment Variable Resolution in Data References should be enabled on the system.
Public propertyStatic member
IgnoreThreadCurrentPrincipal
Setting to determine if the AFSDK should attempt to use user settings set on CurrentPrincipal including user Id, Name, and access tokens.
Public propertyStatic member
MaxCheckIPTimeout
The maximum timeout used to check that a bad host address has been fixed.
Public propertyStatic member
MaxSaveChangedItems
The maximum number of items to save to the server at a time.
Public propertyStatic member
MinCheckIPTimeout
The minimum timeout used to check that a bad host address has been fixed.
Public propertyStatic member
NextIDBlockSize
The number of unique identifiers to allocate from the server at a time.
Public propertyStatic member
PIPointCacheUpdatePeriod
The period to wait between updating PIPoint cache. By default the period is zero which disables refresh.
Public propertyStatic member
PIServersDirectoryOptions
The directory options used when looking up a PIServer in the collection.
Public propertyStatic member
PISystemOpenIdProxyPoolSize
The number of OpenId proxies in the pool of connections to the PISystem.
Public propertyStatic member
PISystemProxyDisconnectTimeout
The amount of time to allow a connection to the PISystem to be disconnected before timing out.
Public propertyStatic member
PISystemProxyMaxParallelCalls
The maximum number of parallel calls that can be made over a connection to the PISystem.
Public propertyStatic member
PISystemProxyPoolSize
The number of proxies in the pool of connections to the PISystem.
Public propertyStatic member
PISystemsDirectoryOptions
The directory options used when looking up a PISystem in the collection.
Public propertyStatic member
PreferOpenIdAuth
Setting determines if Client initial connects should prompt for Authentication type selection or default to using Windows or OpenId Connect.
Public propertyStatic member
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.
Public propertyStatic member
SDKVersion
Read-only property contains a string that uniquely identifies the current client version of the SDK.
Public propertyStatic member
ShowExcludedAttributes
Setting determines if attributes with their IsExcluded property set to are shown.
Public propertyStatic member
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.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7

See Also

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