Data connector property IDs

1. Overview

This article is advanced, and intended for developers who want to set or override data connectors programmatically. IDs are used for the various settings for each data provider.

This article shows you how to find the IDs, lists some of them for convenience, and provides an example of using one of the IDs in a data connector override when creating a tenant.

2. Data Connector Property IDs

You can inspect the data connector dialog to find each setting's ID.

For convenience, some of the available IDs are also listed below.

2.1. Finding property IDs

When the data connector dialog is open for a new or existing data connector with Data Provider set to the appropriate value, you can use the browser's developer tools to find the ID associated with each field in the dialog. You can follow steps like the ones for identifying CSS classes to override.

If you are using the .NET API, you can also use the IDataProviderService to get the DataProviderInfo for your provider and access all of its PropertyDescriptors. For information on accessing services, see Working with services in the API reference.

2.2. BasicHttp

2.3. BigQuery

2.4. DB2

2.5. DynamicsCrm

2.6. EXA

2.7. Excel

2.8. FlatFile

2.9. GoogleAnalytics (Original Deprecated Version)

2.10. GoogleAnalytics

2.11. Jet

2.12. MySql

2.13. OData

2.14. Odbc

2.15. Oracle

2.16. Pardot

2.17. Postgres

2.18. Salesforce

2.19. SharePointExcel

2.20. SharePointList

2.21. Sheets

2.22. Snowflake

2.23. SqlServer

2.24. Teradata

2.25. Vertica

2.26. XmlFile

3. Example

The following example uses C# to make REST calls to log on and create a tenant with a data connector override, using the InitialCatalog property ID listed above for SQL Server to override it on the data connector. Some Dundas types are used for convenience by referencing Dundas .NET assemblies.

using System.Net;
using System.Net.Http;

using Dundas.BI.Data.Parameters;
using Dundas.BI.WebApi.Models;

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

void Main()
{
	string baseUrl = "http://localhost:8000";

	using (HttpClient httpClient = new HttpClient())
	{
		// Get Session Id
		string logonUri = baseUrl + "/Api/LogOn/";
		var logonOptions = new
		{
			accountName = "admin",
			password = "1234",
			deleteOtherSessions = true,
			isWindowsLogOn = false
		};

		var requestBodyAsString = JsonConvert.SerializeObject(logonOptions);
		
		StringContent content = new StringContent(
			requestBodyAsString,
			Encoding.UTF8,
			"application/json"
		);

		string jsonString;

		using (var response = httpClient.PostAsync(logonUri, content).Result)
		{
			jsonString = response.Content.ReadAsStringAsync().Result;
		}

		TenantData tenantData = new TenantData();
		tenantData.AccountNamePattern = "T";
		tenantData.Name = "MyTenant";

		// The data connector you created. 
		// You will need to get this ID when you create the data connector.
		Guid dataConnectorId = new Guid("a102fefc-62c9-4517-9bf4-77c9a08c4f76");

		// The initial catalog property ID.
		Guid initialCatalogId = new Guid("8FFE4086-6013-4586-902C-FDA2502548D4");
		string initialCatalog = "MyTenantData";

		// The value for the initial catalog that will be set in the override data.
		ParameterValueData initialCatalogParameterValueData = new ParameterValueData();
		initialCatalogParameterValueData.ParameterValueType = ParameterValueTypes.SingleString;
		initialCatalogParameterValueData.Value = initialCatalog;
		initialCatalogParameterValueData.ParameterId = initialCatalogId;

		// Create the override data.
		ProviderPropertyOverrideData providerPropertyOverrideData = 
			new ProviderPropertyOverrideData();
		providerPropertyOverrideData.Key = dataConnectorId;
		providerPropertyOverrideData.Value.Add(initialCatalogParameterValueData);


		// Add the override 
		tenantData.DataConnectorPropertyOverrides.Add(providerPropertyOverrideData);
		tenantData.LicenseSeatAllocation = new TenantSeatAllocationData();

		dynamic obj = JObject.Parse(jsonString);
		string sessionId = obj.sessionId.ToString();
		string url = baseUrl + "/API/Tenant/";

		// Add an Authorization header (v10 and higher)
		httpClient.DefaultRequestHeaders.Authorization =
			new AuthenticationHeaderValue("Bearer", sessionId);

		// Define the request body
		HttpContent requestBody = null;
		requestBody = new StringContent(
			JsonConvert.SerializeObject(tenantData),
			Encoding.UTF8,
			"application/json"
		);

		using (var response = httpClient.PostAsync(url, requestBody).Result)
		{
			if (response.StatusCode == HttpStatusCode.OK)
			{
				Console.WriteLine("Success");

				string jsonObject = response.Content.ReadAsStringAsync().Result;

				Console.WriteLine(jsonObject);
			}
		}
	}
}

4. See also

• Tenant overrides
• Multi-tenancy
• Creating a data provider
• .NET API Reference