Connecting from Code

The CData ADO.NET Provider for Sage X3 Cloud implements a standard DbConnection object in SageX3CloudConnection. You can also use the SageX3CloudConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.

Creating Connection Objects

See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create SageX3CloudConnection objects.

using (SageX3CloudConnection connection =   
  new SageX3CloudConnection("URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;"))  
{  
  connection.Open();  
}

VB.NET

Using connection As New SageX3CloudConnection("URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;")
  connection.Open
End Using

Using SageX3CloudConnectionStringBuilder

The following code example shows how to use an ADO.NET connection string builder to parse a connection string.

SageX3CloudConnectionStringBuilder builder =
  new SageX3CloudConnectionStringBuilder("URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;");
  //Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
  builder.ConnectionString = "URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;";
  //Now that the connection string has been parsed,
  // you can work with individual items:
  builder.MyString = "new property";
  builder.MyBoolean = true;

  // You can refer to connection keys using strings, 
  // as well. 
  builder["Logfile"] = "test.log";
  builder["Verbosity"] = 5;

VB.NET

Dim builder As SageX3CloudConnectionStringBuilder = New SageX3CloudConnectionStringBuilder("URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
  
' You can refer to connection keys using strings, 
' as well. 
builder("Logfile") = "test.log"
builder("Verbosity") = 5