ConnectionString Property (ExactTargetConnection)

Visual Basic
C#

'Declaration
 
Public Shadows Property ConnectionString As String

public new string ConnectionString {get; set;}

Property Value

The connection string that includes the parameters needed to establish the initial connection. The default value is an empty string ("").

When ConnectionString property is assigned a value, connection closes. Many of the connection string values have corresponding properties. When the connection string is set, all of these properties are updated, except when an error is detected. In this case, none of the properties are updated. ExactTargetConnection properties return only those settings contained in the ConnectionString.

Resetting the ConnectionString on a closed connection resets all connection string values (and related properties).

The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception, such as System.ArgumentException, is generated. Other errors can be found only when an attempt is made to Open the connection.

The ConnectionString is similar to an OLE DB connection string. Values may be delimited by single or double quotes, (for example, name='value' or name="value"). Either single or double quotes may be used within a connection string by using the other delimiter, for example, name="value's" or name= 'value"s', but not name= 'value's' or name= ""value"". All blank characters, except those placed within a value or within quotes, are ignored. Keyword value pairs must be separated by a semicolon (;). If a semicolon is part of a value, it also must be delimited by quotes. No escape sequences are supported. The value type is irrelevant. Names are not case sensitive. Arguments names may occur only once in the connection string.

The following table lists the valid names for values within the ConnectionString.

Name	Description
App Client Id	Specifies the client ID from the Salesforce Marketing Cloud App Center.
App Client Secret	Specifies the client Secret from the Salesforce Marketing Cloud App Center.
App Sandbox	Determines whether to use a sandbox account for App Center Client authentication.
Authentication Type	Specifies the authentication method to connect to the service.
ClientIDs	Specifies the comma separated list of partner account ids and business units (used for the SELECT queries only).
Connection Lifetime	Determines the maximum time span (in seconds) a connection can remain in the pool: when a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).
Connect Timeout -or- Connection Timeout	Specifies the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 60.
Default Command Timeout	Specifies the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. A value of 0 indicates no limit.
Failover Retries	Specifies the maximum number of retry attempts to reconnect after a failover event.
Initialization Command	Specifies a data source-specific command to execute immediately after the connection is established.
Local SQL Engine	Uses a local SQL engine to process queries instead of a remote server.
Max Pool Size	Specifies the maximum number of connections allowed in the pool. Setting the Max Pool Size value of the ConnectionString can affect performance. The default value is 100.
Min Pool Size	Specifies the minimum number of connections allowed in the pool. The default value is 0.
NormalizeDbNames	Determines whether database object names are normalized when retrieved from the database.
Password	Specifies the password for UserNamePassword authentication.
Persist Security Info	Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.
Pooling	Determines whether, by default, the ExactTargetConnection object is drawn from the appropriate pool or is created and added to the appropriate pool, when set to true.
Proxy Host	Specifies the host name or IP address of proxy server.
Proxy Password	Specifies the password for the proxy server account.
Proxy Port	Specifies the port number of the proxy server. The default value is 3128.
Proxy User	Specifies the proxy server account name.
Run Once Command	Specifies a command to execute the first time the connection is opened. The command is not executed when the connection is retrieved from the connection pool.
Readonly	Determines whether the connection is read-only (allows only SELECT statements).
Refresh Token	Specifies the Salesforce Marketing Cloud OAuth 2.0 refresh token.
Subdomain	Specifies a tenant-specific subdomain of Marketing Cloud API endpoints. It is a 28-character string starting with the letters "mc", for example, mc563885gzs27c5t9-63k636ttgm. You can find your subdomain in the url in your browser after logging in to Salesforce Marketing Cloud.
Support Extension Objects	Determines whether to allow access to Salesforce Marketing Cloud data extensions via the connection. By default, true, which means that access is allowed. If you don't need access to Salesforce Marketing Cloud data extensions, you may set it to false to improve connection performance.
Token Server	Specifies the location where OAuth 2.0 refresh tokens are stored between sessions. The location can be a file on disk or a registry key.
Url	Specifies the URL of an ExactTarget instance for API UserNamePassword authentication.
User	Specifies the API User name to login using UserNamePassword authentication.
UTC Dates	Indicates whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time, and whether date values, specified on the application side (for example, in SQL statements) are considered UTC or local. Default value is false.

The following example creates a ExactTargetConnection and sets some of its properties in the connection string.

csharp

public void CreateExactTargetConnection()
{
  string myConnString1 = 
     "user=MyCompanyAdmin;password=mypassword;url=https://webservice.s7.exacttarget.com/Service.asmx;";
  ExactTargetConnection exactTargetConnection1 = new ExactTargetConnection(myConnString1);
  exactTargetConnection1.Open();
}

Visual Basic

Public Sub CreateExactTargetConnection()
  Dim myConnString1 As String = _
      "user=MyCompanyAdmin;password=mypassword;url=https://webservice.s7.exacttarget.com/Service.asmx;"
  Dim exactTargetConnection1 As New ExactTargetConnection(myConnString1)
  exactTargetConnection1.Open()
End Sub

Reference

ExactTargetConnection Class
ExactTargetConnection Members
Open Method
ExactTargetConnectionStringBuilder Class