MPS Import::EnableCustomerForPlans

  • Article

This procedure adds an organization or user to the Plans database. This procedure attempts to configure an existing organization or user in the Plans database by trying to add a new record to the Plans database. The method does not fail if a valid record already exists.

Arguments

Input argument Required Description

<path>

Yes

The path of the user or organization.

<preferredDomainController>

Yes

<customerTypeName>

No

(optional) The plans database customer type. Valid values are:

  • BusinessUser.

  • ConsumerUser.

  • BusinessOrganization.

  • ResellerOrganization.

If <customerTypeName> is not supplied, the type is inferred from the customer object. If the object is an organization:

Managed Active Directory Organization Type Plan Customer Type

Reseller

ResellerOrganization

Customer

BusinessOrganization

If the object is a user:

Managed Active Directory Organization Type (user parent) Plan Customer Type

Reseller

BusinessUser

Customer

BusinessUser

Since there is no value on a user object in Active Directory that will indicate if the user is a consumer E-mail user, consumer users must be specified using the customerTypeName parameter:

<customerTypeName>ConsumerUser<customerTypeName>

Remarks

Prerequisites

  1. Organization must be located in the hosting AD tree at the proper level in the hierarchy depending on whether it is a reseller or customer.

  2. The Organization must be 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

  3. Users

    • User must be located in the hosting Active Directory tree at the proper level in the hierarchy depending on whether it is a reseller or customer.

    • The organization must be 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

    • The user must be compliant with the hosting prescription. If the user was created or processed with any of the following, then it is valid:

      • Managed Active Directory::CreateUser.

      • HostedExchange::CreateBusinessUser.

      • HostedExchange::CreateConsumerUser.

      • Hosted Messaging and Collaboration::CreateUser.

      • MPS Import::ImportUser.

      • MPS Import::EnableUserForHosting.

Procedure Steps type="ORDERED"

  1. Managed Hosting::GetOrgType (conditional) - retrieves the OWK for the organization type (e.g. hosting, reseller, customer, or default). This is used to infer the customerTypeName if the customerTypeName is not supplied.

  2. Managed Helpers::CreateCustomerRecord_.

Security

Impersonate caller.

Sample Code

Example XML Request

<request> 
  <procedure> 
    <execute namespace="MPS Import" procedure="EnableCustomerForPlans" impersonate="1"> 
      <executeData> 
        <path>LDAP://OU=alpineskihouse,OU=consolidatedmessenger,OU=Hosting,DC=fabrikam,DC=Com</path> 
        <preferredDomainController>AD01.fabrikam.Com</preferredDomainController> 
        <customerTypeName>BusinessOrganization</customerTypeName> 
      </executeData> 
    </execute> 
  </procedure> 
</request>

Applies To

MPS Import Namespace API for:

  • Hosted Messaging and Collaboration version 3.5