MPS Import::ImportUser

This procedure imports a consumer or business user into MPS system. This procedure attempts to import a user into the Hosted Exchange and MPS systems by doing the following:

Renaming user to comply with UPN = commonName convention
Preserving existing sAMAccountName.
Setting group memberships.
Setting security ACLs on object.
Creating a record for the user in the plans database.
Optionally creating a mailbox if one does not exist - other wise import mailbox allocation into RM.
Applying plan settings to mailbox.

Arguments

Remarks

Prerequisites

The user must be located in an OU container that is compliant with the hosting prescription. If the OU was created or processed with any of the following, then it is valid:

Managed Active Directory::CreateOrganization.
HostedExchange::CreateBusinessOrganization.
Hosted Messaging and Collaboration::CreateOrganization.
MPS Import::ImportOrganization.
MPS Import::EnableOrganizationForHosting.

Procedure Steps

MPS Import::EnableUserForHosting
MPS Import::EnableCustomerForPlans (conditional) - If plans node is supplied.
Managed Active Directory::ModifyUser (conditional) - If properties node is supplied.
Preferred DC Active Directory Provider::Get Properties - checks for an existing mailbox to determine if a mailbox should be created or simply imported.
MPS Import::CreateMailbox (conditional) - If user does not have an existing mailbox.
MPS Import::ApplyMailboxPlan (conditional) - If user has an existing mailbox.
MPS Import::AllocateExistingMailbox (conditional) - If user has an existing mailbox.

sAMAccountName behavior

When creating a user, it is necessary to also ensure that the new user's sAMAccountName is unique within the domain. If it is not, creation will fail. The procedure will attempt to create the object with the provided sAMAccountName. If this value is not unique in the domain, then the following auto account name generation applies:

Also, interactions with Exchange make it undesirable for the '@' character to appear in a sAMAccountName. Therefore, when creating or renaming a user or group, the sAMAccountName will be similar to the input name (or Universal principal name), except that illegal sAMAccountName characters are removed, and '@' characters are replaced with '_'. If the sAMAccountName collides with an existing sAMAccountName, then a random string of digits will be appended to the sAMAccountName to ensure uniqueness.

The algorithm for generating a sAMAccountName from the seed name (Universal Principal Name for a user, or cn if the object is a group), is as follows: type="ORDERED"

Remove all of the following illegal characters from the seed name: "/\[]:|<>+=;?,*
Trim the seed name to a maximum of 20 characters
If the last character is a '.', replace it with '_'
Attempt to create the object with the trial sAMAccountName
If there is a sAMAccountName collision in step 4, generate 3 trial names by limiting the seed name to 17 characters, then appending a random 3-digit number to each. Generate 2 additional trial names by limiting the seed name to 15 characters, then appending a 5-digit random number to each. Attempt to create the object using each of these 5 trial names in turn.

<proxyAddresses>: Additional proxy addresses for the user. Ignored if planName not provided.

Note

The procedure will accept additional proxyAddress. However, the called Hosted Exchange::CreateMailbox procedure, which is executed when a plan is specified, adds a primary SMTP address based on the user's UPN prefix and the org's SMTP Domain (e.g. user@alpineskihouse.com).
<alias>: The procedure will accept this as an optional parameter. Other wise an alias will be generated from the UPN prefix (e.g. user from user@alpineskihouse.com)
<properties>/<property>: One or more Active Directory attributes that are valid for an object of the user class.

Security

Impersonate caller.

Sample Code

Example XML Request

<request>
  <procedure>
	<execute namespace="MPS Import" procedure="ImportUser" impersonate="1">
	<executeData>
		<path>LDAP://CN=jimc@alpineskihouse.com,OU=alpineskihouse,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path>
		<userPrincipalName>user@alpineskihouse.com</userPrincipalName>
		<plans>
		<plan type="ExchMailbox" name="BaseMail>
		</plans>
		<customerTypeName>BusinessUser</customerTypeName>
	</executeData>
	<after source="executeData" sourcePath="user" destination="data"/>
	</execute>
  </procedure>
</request>

Minimal XML Usage

<request>
  <procedure>
	<execute namespace="MPS Import" procedure="ImportUser" impersonate="1">
	<executeData>
		<path>LDAP://CN=jimc@alpineskihouse.com,OU=alpineskihouse,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path>
		<userPrincipalName>user@alpineskihouse.com</userPrincipalName>
	</executeData>
	<after source="executeData" sourcePath="user" destination="data"/>
	</execute>
  </procedure>
</request>

The minimal usage shown above will only have the following effects on the specified users:

Renames user to comply with UPN = commonName convention.
Preserves existing sAMAccountName.
Sets group memberships.
Sets security ACLs on object.
Creates a record for the user in the plans database.

Example XML Response

Shown for format only; content may vary.

<response>
  <data>
	<executeData>
	<path>LDAP://CN=user1@MPSImportOrg02.com,OU=MPSImportOrg02,OU=MPSImportRes01,OU=Hosting,DC=fabrikam,DC=Com</path>
	<userPrincipalName>user1@MPSImportOrg02.com</userPrincipalName>
	<plans>
		<plan type="ExchMailbox" name="BaseMail" />
	</plans>
	<customerTypeName>BusinessUser</customerTypeName>
	<preferredDomainController>AD01-Wh.fabrikam.Com</preferredDomainController>
	<mailStore>
		<serverName>EXBE01-WH</serverName>
		<mailStoreName>BusinessMailstore2</mailStoreName>
	</mailStore>
	<properties>
		<property name="msExchQueryBaseDN">OU=MPSImportOrg02,OU=MPSImportRes01,OU=Hosting,DC=fabrikam,DC=com</property>
		<property name="mail">user1@MPSImportOrg02.com</property>
		<property name="msExchMailboxFolderSet">
		<value>98821</value>
		</property>
		<property name="showInAddressBook" mode="append">
		<value>CN=Default Global Address List,CN=All Global Address Lists,CN=Address Lists Container,CN=fabrikam,CN=Microsoft Exchange,CN=Services,CN=Configuration,DC=fabrikam,DC=com</value>
		</property>
		<property name="msExchUserAccountControl">0</property>
	</properties>
	<mail>
		<disablePOP>0</disablePOP>
		<disableIMAP>0</disableIMAP>
		<disableHTTP>0</disableHTTP>
		<size>10000</size>
	</mail>
	<proxyAddresses>
		<value>user1@MPSImportOrg02.com</value>
		<value>user1_MPSImportOrg02@fabrikam.com</value>
	</proxyAddresses>
	<user path="LDAP://cn=user1@MPSImportOrg02.com,OU=MPSImportOrg02,OU=MPSImportRes01,OU=Hosting,DC=fabrikam,DC=com" name="user1@MPSImportOrg02.com">
		<memberOfGroup name="LDAP://cn=AllUsers@MPSImportOrg02,cn=_Private,OU=MPSImportOrg02,OU=MPSImportRes01,OU=Hosting,DC=fabrikam,DC=com">
		</memberOfGroup>
	</user>
	</executeData>
  </data>
</response>

Applies To