DB2ConnectionStringBuilder.ClientCorrelationToken property

Gets or sets the client correlation token name on Db2 for z/OS servers.

Namespace:
IBM.Data.DB2
Assembly:
IBM.Data.DB2 (in IBM.Data.DB2.dll)

Syntax


[Visual Basic]
Public Property ClientCorrelationToken As String
[C#]
public string ClientCorrelationToken {get; set;}
[C++]
public: __property String* get_ClientCorrelationToken();
public: __property void set_ClientCorrelationToken(String*);
[JScript]
public function get ClientCorrelationToken() : String;
public function set ClientCorrelationToken(String);

Property value

  • You can specify the ClientCorrelationToken property when you are connecting to Db2 for z/OS Version 11 server in new function mode (NFM).
  • The IBM Data Server Provider for .NET has limit of 255 characters for the ClientCorrelationToken property.
  • The default value is the DRDA correlation token that is generated during a connection. A database client component typically generates the DRDA correlation token value. However, if the database client component cannot generate the value, the database server generates the value.
  • There is no monitoring support for the client correlation token value in the Db2® Connect gateway server.
  • The ClientCorrelationToken property value is sent to the server without any client side validation.
  • The character string that is provided for the ClientCorrelationToken property value must be null terminated.
  • The ClientCorrelationToken property value is replayed upon connection failover when the advanced client reroute (ACR) feature and the workload balance (WLB) feature are enabled.