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

AF SDK Reference

PISystems.SetApplicationIdentity Method

  • Last UpdatedNov 18, 2025
  • 3 minute read
PISystems.SetApplicationIdentity Method
Set the client application identity to identify an application to the servers to which it connects.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public void SetApplicationIdentity(
	string appIdentity
)
Public Sub SetApplicationIdentity ( 
	appIdentity As String
)

Dim instance As PISystems
Dim appIdentity As String

instance.SetApplicationIdentity(appIdentity)
public:
void SetApplicationIdentity(
	String^ appIdentity
)
member SetApplicationIdentity : 
        appIdentity : string -> unit 

Parameters

appIdentity
Type: SystemString
The identity which identifies the application to the servers. Typically this string will contain a Guid in registry format. For example: 3509D21C-C73C-4246-BEE2-7F39D741DF2B.

Remarks

An application should always use the same identity when setting this property. When required, a unique Guid for an application can be obtained from OSIsoft. A Guid from OSIsoft is required when you are developing an application for use by others outside of your organization, e.g. if you are an OSIsoft Partner developing a custom application for your customers, or if your application connects to a PI Data Archive that requires applications to have an OSIsoft assigned Guid.

It is possible for an application to have more than one identifier. For example, an application can contain a control that talks to the SDK. The control can set an identifier while the application can also specify a different identifier. The server will see both of these identifiers associated with a particular session. Duplicate identifier are discarded so, although logically you only need to set the identifier once, resetting it to the same value during an execution is not a problem.

Note Notes to Callers
Currently, the PI AF Server ignores the application identifiers. Future versions of the PI AF Server will record this information. The application identifier is set when connecting to PIServer.

Version Information

AFSDK


See Also

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