Managed Data Hosting::CreateCustomerDatabase

The CreateCustomerDatabase method creates a database for a specified customer and optionally creates a customer directory structure on a specified share for data (.mdf) and log (.ldf) file.

Arguments

Input argument	Required	Description
<org>	Yes	The Lightweight Directory Access Protocol (LDAP) path of the owning organization.
<serverName>	Yes	A string representing the name of the server. This can be a network basic input/output system (NetBIOS) name, a fully qualified domain name (FQDN), or an IP address.
<databaseName>	Yes	The name of the database to be created.
<preferredDomainController>	Yes	The name of the preferred domain controller.
<sqlUserName>	No	User name for connecting to the SQL server via SQL Authentication. If this node is present, the connection will be made via SQL Authentication rather than Windows Authentication. The existence of this node also requires that the <sqlUserPass/> node exist.
<sqlUserPass>	No	The password for connecting to the SQL server via SQL Authentication, using the username indicated by <sqlUserName/>. If the <sqlUserName/> node is not present, this node is ignored.
<dataRootShare>/@serviceAcct: <dataRootShare>	No	The UNC path to the share where customer data (mdf) and logfiles are store (ldf). This path must be accessible via the MPF server and the account that is submitting this request must have permissions to create directories on that share (e.g. \\SQL01\customerData$). The serviceAcct attribute is the sAMAccountName of the service account that the SQL server runs as. This is required in order to provide file permission rights to the account for the customer's data and log files. Note: sAMAccountName cannot be longer than 20 characters. See SAM-Account-Name Attribute for more information.
<dataRootPath>	No	The local path to the root directory where customer data (mdf) and logfiles are store (ldf). dataRootShare has to be passed if dataRootPath is being passed. Note that dataFile and logFile parameters will be ignored if dataRootShare and dataRootPath parameters aren't provided.
<dataFile>/<logicalName>	No	The logical name for the file. If you intend to supply any of the optional dataFile parameters, you must set the logical name of the data file.
<dataFile>/<fileSize>	No	The file size in megabytes (MB) (you must specify the unit). If not specified, the model database size of the primary file is used. Requires that the dataFile/logicalName node exist and be non-null. Note When using any automated method to create a database of a specific size in which the size parameter is set by the automated process, you must specify a size greater than or equal to that of the model database. When size isn't specified, the model database is used as the template for a new database.
<dataFile>/<fileMaxSize>	No	The maximum size in kilobytes (KB), MB, or gigabytes (GB) (you must specify the unit) for the file . The default is megabyte (MB) and must be a whole number. The default is unlimited. Requires that the dataFile/logicalName node exist and be non-null.
<dataFile>/<fileGrowth>	No	Designates a growth increment in KB, MB, GB, or percentage (you must specify the unit). The default is 10 percent and the minimum value is 64 KB. Requires that the dataFile/logicalName node exist and be non-null.
<logFile>/<logicalName>	No	The logical name for the file. If no log file is specified, a single log file is created with a system-generated name and size that is 25 percent of total data file size. If you intend to supply any of the optional logFile parameters, you must set the logical name of the data file.
<logFile>/<fileSize>	No	The file size in MB (you must specify the unit). If not specified, the model database size of the primary file is used. Requires that the logFile/logicalName node exist and be non-null.
<logFile>/<fileMaxSize>	No	The maximum file size in KB, MB, or GB. The default is megabyte (MB) and must be a whole number . The default is unlimited. Requires that the logFile/logicalName node exist and be non-null.
<logFile>/<fileGrowth>	No	Designates a growth increment in KB, MB, GB, or percentage (you must specify the unit. ). The default is 10 percent and the minimum value is 64 KB. Requires that the logFile/logicalName node exist and be non-null.

Output argument	Description
<dataFile>/<filePath>	Operating system file name (full path).
<logFile>/<filePath>	Operating system file name (full path).

Remarks

Provisioning Steps

The following steps occur when creating a customer database with the CreateCustomerDatabase method of the Managed Data Hosting Namespace:

Create the customer's root directory and set its permissions.
Create the Sqldata folder and set its permissions.
Create the database and apply any optional settings.
Add a login to the database for the admins@<org> group.
Add the login to the dbo role for that database.

Data Persistence

A container and leaf structure is created in the Customer organizational unit (OU) private directory to maintain data about the Web site for easily lookup without requiring the IIS metabase path. For example:

CN=Services

			CN=Databases

							CN=NorthwindSales (displayName=SQL01)

										 CN=dataFile (displayName=\\Sql01\customerData$\Northwind\data\sales.mdf)

																CN=logFile (displayName=\\Sql01\customerData$\Northwind\logs\sales.ldf)

Directory Structure and Security

The CreateCustomerDatabase method creates the following directory structure:

<sqldataroot>

			 +--northwindtraders (customer root)

			 |			 |

			 |			 +-- data

				|			 |	 |

			 |			 |	 +--<data1>.ldf

			|			 |	 |

			 |			 |	 +--<data2>.ldf

			|			 |

			 |			 +-- logs

			 |			 |		 |

			 |			 |		 +--<log1>.ldf

		 |			 |		 |

			 |			 |		 +--<log2>.ldf

		 |			 |

			 |			 +-- backups

			 +--<customer02>

			 +--<customer03>

Security

The CreateCustomerDatabase method has the following security requirements:

The caller is impersonated.
The caller is tested for OrgCreator permissions by checking for membership in the domain admins group.

Note

The provisioning system only supports databases greater than 1 MB in size.

Customers Root Path Security

Customers Data Directory Security

Customers Log Directory Security

Customers Backup Directory Security

Sample Code

Example XML Request

The following is an example of an XML request for the CreateCustomerDatabase method:

<?xml version="1.0" encoding="iso-8859-1" ?>

<request>

 <procedure>

				<execute namespace="Managed Data Hosting"

			procedure="CreateCustomerDatabase" impersonate="1">

				 <executeData>

					 <org>LDAP://OU=northwindtraders,OU=consolidatedmessenger,

				 OU=Hosting,DC=fabrikam,DC=Com

				 <serverName>Mps01-wh</serverName>

				 <databaseName>NorthWindSales</databaseName>

				 <preferredDomainController>AD01-WH.fabrikam.Com

				 </preferredDomainController>

					<dataRootShare serviceAcct='fabrikam\MPSSQLService'>\\mps01-

					wh\temp</dataRootShare>

				 <dataRootPath>c:\temp</dataRootPath>

						</executeData>

			</execute>

		</procedure>

</request>

Example XML Response

No example XML response.

Applies To