Managed Plans::RegisterService

This procedure provides a single call mechanism for setting up a service and its types in Plan Manager Database. The call supports adding the service, the service dependencies and all supported types: customerTypes, statusTypes, eventTypes, assetTypes, planTypes, and featureTypes. If the flagIgnoreAlreadyExistsError parameter is supplied and set to one, then the procedure will not error when it encounters existing records. This procedure can be used by hosted services initialize procedures as a convenient way to set up a service.

Arguments

Input Arguments	Required	Description
<preferredDomainController>	Yes	The domain controller to use for Active Directory actions.
<serviceId>	Yes	The globally unique identifier (GUID) to be assigned to the service. Each service has a unique serviceId.
<serviceName>	Yes	The unique name of the service.
<serviceDescription>	No	The description of the service.
<dependencies>	No	A collection of service dependencies
<dependencies/ value>	No	Zero or more service dependencies
<types>	No	Container for various type collections
<types/ statusTypes>	No	Collection of status types
<types/ statusTypes/ statusType>	No	Onee or more status type definitions
<types/ statusTypes/ statusType/ statusDescription>	No	Description for the type
<types/ statusTypes/ statusType/ statusTypeCode>	No	Unique two character code for the type
<types/ statusTypes/ statusType/ statusTypeName>	No	The status type, e.g. Enabled.
<types/ eventTypes>	No	Collection of event types
<types/ eventTypes/ eventType>	No	One or more event type definitions
types/ eventTypes/ eventType/ eventDescription>	No	Description for the new type
<types/ eventTypes/ eventType/ eventTypeCode>	No	Unique two character code for the new type
<types/ eventTypes/ eventType/ eventTypeName>	No	The application defined event type, such as Enabled.
<types/ assetTypes>	No	Collection of asset types
<types/ assetTypes/ assetType>	No	One or more asset type definitions
<types/ assetTypes/ assetType/ assetTypeCode>	No	Unique 2 character code for the new asset type
<types/ assetTypes/ assetType/ assetTypeDescription>	No	Description of the new asset type
<types/ assetTypes/ assetType/ assetTypeName>	No	Unique name of the asset type.
<types/ planTypes>	No	Collection of plan types
<types/ planTypes/ planType>	No	One or more plan type definitions
<types/ planTypes/ planType/ allowMultiple>	No	Boolean indicating whether a customer can have more than one plan of this type assigned
<types/ planTypes/ planType/ planTypeCode>	No	Unique two character code for the type
<types/ planTypes/ planType/ planTypeDescription>	No	Description of the type
<types/ planTypes/ planType/ planTypeName>	No	Unique friendly name for the type
<types/ customerTypes>	No	Collection of customer types
<types/ customerTypes/ customerType>	No	One or more customer type definitions
<types/ customerTypes/ customerType/ customerTypeCod>	No	Unique two character code for the type
<types/ customerTypes/ customerType/ customerTypeDescription>	No	Description of the new type.
<types/ customerTypes/ customerType/ customerTypeName>	No	The name of the customer type. For example: BusinessUser
<types/ featureTypes>	No	Collection of feature types
<types/ featureTypes/ featureType>	No	One or more feature type definitions
<types/ featureTypes/ featureType/ featureDescription>	No	The description of the new feature.
<types/ featureTypes/ featureType/ featureName>	No	The unique name of the Feature.
<types/ featureTypes/ featureType/ nativeAttribute>	No	The native attribute this type maps to. For example this could be a Active Directory attribute such as mDBOverHardQuotaLimit.
<types/ featureTypes/ featureType/ featureName>	No	The unique name of the Feature.
<types/ featureTypes/ featureType/ parentNode>	No	If the provisioning API requires that the feature's native attribute be contained in an element then that should be entered in the parameter. For example properties or mail.
<types/ featureTypes/ featureType/ statusTypeName>	No	The status type, e.g. Enabled.
<types/ featureTypes/ featureType/ xSLDatatype>	No	The optional datatype if required for a specific nativeAttribute. For example bin.hex.
<flagIgnoreAlreadyExistsError>	No	Instruct the procedure not to fail if any of the types already exist.

Remarks

Sample Code

Example XML Request

<request>
  <data>
	<preferredDomainController>ad01.fabrikam.com</preferredDomainController>
	<serviceId>1F444526CB6F4D5C9A59C9A84E26B618</serviceId>
	<serviceName>TestService</serviceName>
	<serviceDescription>Test Service</serviceDescription>
	<dependencies>
	<value>ActiveDirectory</value>
	</dependencies>
	<types>
	<statusTypes>
		<statusType>
		<statusDescription>Entity is enabled</statusDescription>
		<statusTypeCode>EN</statusTypeCode>
		<statusTypeName>Enabled</statusTypeName>
		</statusType>
	</statusTypes>
	<eventTypes>
		<eventType>
		<eventDescription>Entity placed in a pending state</eventDescription>
		<eventTypeCode>PN</eventTypeCode>
		<eventTypeName>Pending</eventTypeName>
		</eventType>
	</eventTypes>
	<assetTypes>
		<assetType>
		<assetTypeCode>HH</assetTypeCode>
		<assetTypeDescription>A host header for an IIS site</assetTypeDescription>
		<assetTypeName>HostHeader</assetTypeName>
		</assetType>
	</assetTypes>
	<planTypes>
		<planType>
		<allowMultiple>0</allowMultiple>
		<planTypeCode>TS</planTypeCode>
		<planTypeDescription>Test Service Plan</planTypeDescription>
		<planTypeName>TestServiceOrg</planTypeName>
		</planType>
	</planTypes>
	<customerTypes>
		<customerType>
		<customerTypeCode>BZ</customerTypeCode>
		<customerTypeDescription>Business Organization</customerTypeDescription>
		<customerTypeName>BusinessUser</customerTypeName>
		</customerType>
	</customerTypes>
	<featureTypes>
		<featureType>
		<featureDescription>Test warning quota</featureDescription>
		<featureName>TestServiceQuota</featureName>
		<nativeAttribute>quota</nativeAttribute>
		<parentNode>service</parentNode>
		<statusTypeName>Enabled</statusTypeName>
		<xSLDatatype>xs:string</xSLDatatype>
		</featureType>
	</featureTypes>
	</types>
	<flagIgnoreAlreadyExistsError>1</flagIgnoreAlreadyExistsError>
  </data>
  <procedure>
	<execute namespace="Managed Plans" procedure="RegisterService" impersonate="1">
	<before source="data" destination="executeData" mode="merge" />
	<after source="executeData" destination="data" mode="merge" />
	</execute>
  </procedure>
</request>

Applies To