Hosted Office Communications Server::CreateSipUser

This procedure creates a SIP account for an existing Active Directory user. The Office Communications Server settings are determined by the supplied service plan.

Use this procedure to assign Office Communications Server Hosted Service Plan to a user and enable the user for Office Communications Server services.

Arguments

Input argument	Required	Type	Description
<user>	Yes	xs:string	The Lightweight Directory Access Protocol (LDAP) path of the user.
<preferredDomainController>	Yes	xs:string	The domain controller to use for Active Directory actions.
<primaryURI>	Yes	xs:string	The primary SIP URI of the user. This URI must be unique and must be represented in the form "sip:user@domain" where the domain substring is a fully qualified domain name.
<planName>	Yes	xs:string	The unique name of the Office Communications Server user plan.
<planOverrides>	No		Container element for plan overrides.
<planOverrides/enabled>	No	xs:boolean	If true, the user is enabled for Office Communications Server.
<planOverrides/ enabledForEnhancedPresence>	No	xs:boolean	If true, the user is enabled for Enhanced Presence.
<planOverrides/ enabledForFederation>	No	xs:boolean	If true, the user is enabled to participate in a federated conversation.
<planOverrides/ enabledForInternetAccess>	No	xs:boolean	If true, the user is enabled for Internet access.
<planOverrides/ publicNetworkEnabled>	No	xs:boolean	If true, the user is allowed to participate in conversations with public IM providers such as AOL, MSN and Yahoo.
<planOverrides/ allowOrganizeMeetingWithAnonymousParticipants>	No	xs:boolean	If true, the user is allowed to invite anonymous user to meeting.
<planOverrides/meetingPolicy>	No	xs:string	The name of the Meeting Policy to be applied to a user.
<planOverrides/ucEnabled>	No	xs:boolean	If true, the user is enabled for Unified Communications.
<planOverrides/ucPolicy>	No	xs:string	The name of the Unified Communications Policy to be applied to a user.
<archiveFederatedCommunications>	No	xs:boolean	This setting controls whether to archive the user's communications across federated domains.
<archiveInternalCommunications>	No	xs:boolean	This setting controls whether to archive the user's communications within their internal domain.
<ipPBXSoftPhoneRoutingEnabled>	No	xs:boolean	If true, the user is enabled for both remote call control and Enterprise voice. This requires that <UCEnabled> is set to true.
<lineServerURI>	No	xs:string	The SIP URI of the telephony gateway server assigned to this user for remote-call control (RCC). A valid SIP URI uses the following form: Sip:abc@pbx1.phones.microsoft.com. This property is not indexed, but is marked for global container replication. If <RemoteCallControlTelephoneyEnabled> is true, this value cannot be NULL. The value of this property is not case-sensitive. The maximum length of the string is 454 characters.
<lineURI>	No	xs:string	Either the SIP URI or the Tel. URI of the user's phone line. This value is used by the Microsoft Office Communicator client and by Enterprise Voice for call routing. A valid SIP URI uses the following form: sip:+14257777777@phones.fabrikam.com;user=phone.This SIP URI value must be unique. A valid Tel. URI uses the following form: tel:+14257071111;ext=71111;attribute=telephone number This property is indexed and marked for global container replication. If <RemoteCallControlTelephoneyEnabled> is true, this value cannot be NULL. The value of this property is not case-sensitive. The maximum length of the string is 454 characters.
<remoteCallControlTelephonyEnabled>	No	xs:boolean	If true, the user is able to use the Microsoft Office Communicator client in combination with the user's computer to initiate, receive, and forward phone calls. If true, the user is authorized for remote call control. If false, the user is not authorized for remote call control. If the value is true, <LineURI> and <LineServerURI> cannot be null. The default value is false.
<poolFQDN>	No	xs:string	The fully qualified domain name (FQDN) of the home application pool for this user.
<poolTag>	No	xs:string	The tag to filter the list of available pools when automatically selecting a pool.

Output argument	Type	Description
<features>		A list of features applied to the user, combining the list of features from the plan and any overrides specified.
<features/enabled>	xs:boolean	If true, the user is enabled for Office Communications Server.
<features/ enabledForEnhancedPresence>	xs:boolean	If true, the user is enabled for Enhanced Presence.
<features/ enabledForFederation>	xs:boolean	If true, the user is enabled to participate in a federated conversation.
<features/ enabledForInternetAccess>	xs:boolean	If true, the user is enabled for Internet access.
<features/ publicNetworkEnabled>	xs:boolean	If true, the user is allowed to participate in conversations with public IM providers such as AOL, MSN and Yahoo.
<features/ allowOrganizeMeetingWithAnonymousParticipants>	xs:boolean	If true, the user is allowed to invite anonymous user to meeting.
<features/meetingPolicy>	xs:string	The name of the Meeting Policy to be applied to a user.
<features/ucEnabled>	xs:boolean	If true, the user is enabled for Unified Communications.
<features/ucPolicy>	xs:string	The name of the Unified Communications Policy to be applied to a user.
<poolFQDN>	xs:string	The fully qualified domain name (FQDN) of the home application pool for this user.
<poolDN>	xs:string	The distinguished name of the home application pool for this user. This name must be valid within the domain's Active Directory.

Remarks

Security

The caller must be at least a member of role: Customer Administrator

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::AddCustomerPlan and Managed Office Communications Server::CreateSipUser, which perform a check for Customer Administrator (UserCreators).

Preconditions

The user's organization is subscribed to the Hosted Office Communications Server service.
The specified plan was created with Hosted Office Communications Server::CreateUserPlan.
The specified plan was previously added to the organization's list of available plans.
At least one SIP Domain has been provisioned for the organization.
At least one available shared pool exists.

Business Rules

The specified plan must be of type OCSUserHosting.

Post-conditions

The user will be enabled for Office Communications Server.
The Office Communications Server feature values specified in the service plan will be applied to the user.
The specified plan will be assigned to the user.

Sequence Narrative

Actor submits CreateSipUser request to the Hosted Office Communications Server namespace.
CreateSipUser calls GetOrganizationPlanAssignment. This will validate that the user's organization has subscribed to the service.
CreateSipUser calls GetPlanWithTypeValidation_ with validTypeName='OCSUserHosting'. This will validate that the specified plan is of the type OCSUserHosting. It will also return the plan details which will be needed when calling the Managed Office Communications Server::CreateSipUser.
CreateSipUser calls Managed Plans::IsPlanAvailable. This will return 1 if the plan is available to the organization and 0 if it is not.
Alt: if available=0: If the plan is not available, throw an InvalidOperationException.
CreateSipUser calls Managed Plans::AddCustomerPlan.
CreateSipUser calls Managed Office Communications Server::CreateSipUser to retrieve the plan settings.
CreateSipUser calls Managed Office Communications Server::CreateSipUser to actually create the SIP user. Replace plan settings with planOverrides if any.

Sample Code

Example XML Request

<request>
  <data>
	<!--LDAP path of the user.-->
	<user>LDAP://CN=JohnC@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</user>
	<!--The domain controller to use for Active Directory actions.-->
	<preferredDomainController>AD01.Fabrikam.Com</preferredDomainController>
	<!--The primary SIP URI of the user. This URI must be unique and must be represented in the form "sip:user@domain" where the domain substring is a fully qualified domain name.-->
	<primaryURI>sip:JohnC@AlpineSkihouse.com</primaryURI>
	<!--The unique name of the OCS user plan.-->
	<planName>BasicOCSIM</planName>
	<!--Feature values to override plan settings.-->
	<planOverrides>
	<!--This allows the user to invite anonymous user to meeting.-->
	<allowOrganizeMeetingWithAnonymousParticipants>true</allowOrganizeMeetingWithAnonymousParticipants>
	<!--This enables the user for Office Communications Server.-->
	<enabled>true</enabled>
	<!--This enables the user for new advanced features of Office Communications Server.-->
	<enabledForEnhancedPresence>true</enabledForEnhancedPresence>
	<!--This enables the user to participate in a federated conversation.-->
	<enabledForFederation>true</enabledForFederation>
	<!--This enables the user for internet access.-->
	<enabledForInternetAccess>true</enabledForInternetAccess>
	<!--This setting controls the user ability to participate in conversations with public IM providers such as AOL, MSN and Yahoo.-->
	<publicNetworkEnabled>true</publicNetworkEnabled>
	<!--Specifies the name of the Meeting Policy to be applied to a user.-->
	<meetingPolicy>Default Policy</meetingPolicy>
	<!--This enables the user for Unified Communications.-->
	<ucEnabled>true</ucEnabled>
	<!--Specifies the name of the Unified Communications Policy to be applied to a user. This parameter must be present if ucEnabled is true.-->
	<ucPolicy>Default Policy</ucPolicy>
	</planOverrides>
	<!--Controls whether a user's communications across federated domains are archived.-->
	<archiveFederatedCommunications>true</archiveFederatedCommunications>
	<!--Controls whether a user's communications within their internal domain are archived.-->
	<archiveInternalCommunications>true</archiveInternalCommunications>
	<!--Controls whether the user is enabled for both remote call control and Enterprise voice.  Requires that the UCEnabled be set to true.-->
	<ipPBXSoftPhoneRoutingEnabled>true</ipPBXSoftPhoneRoutingEnabled>
	<!--The SIP URI of the telephony gateway server assigned to this user for remote-call control (RCC).-->
	<lineServerURI>sip:server01@pbx1.phones.fabrikam.com</lineServerURI>
	<!--Either the SIP URI or the Tel. URI of the user's phone line. This value is used by the Microsoft Office Communicator client and by Enterprise Voice for call routing.-->
	<lineURI>tel:+15555550101</lineURI>
	<!--Controls whether the user is able to use the Microsoft Office Communicator client in combination with the user's computer to initiate, receive, and forward phone calls.-->
	<remoteCallControlTelephonyEnabled>true</remoteCallControlTelephonyEnabled>
	<!--The fully qualified domain name (FQDN) of the home application pool for this user.-->
	<poolFQDN>pool01.fabrikam.com</poolFQDN>
	<!--The tag to filter the list of available pools when automatically selecting a pool.-->
	<poolTag>LabA</poolTag>
  </data>
  <procedure>
	<execute namespace="Hosted Office Communications Server" procedure="CreateSipUser" impersonate="1">
	<before source="data" sourcePath="user" destination="executeData" mode="move" />
	<before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" />
	<before source="data" sourcePath="primaryURI" destination="executeData" mode="move" />
	<before source="data" sourcePath="planName" destination="executeData" mode="move" />
	<before source="data" sourcePath="planOverrides" destination="executeData" mode="move" />
	<before source="data" sourcePath="archiveFederatedCommunications" destination="executeData" mode="move" />
	<before source="data" sourcePath="archiveInternalCommunications" destination="executeData" mode="move" />
	<before source="data" sourcePath="ipPBXSoftPhoneRoutingEnabled" destination="executeData" mode="move" />
	<before source="data" sourcePath="lineServerURI" destination="executeData" mode="move" />
	<before source="data" sourcePath="lineURI" destination="executeData" mode="move" />
	<before source="data" sourcePath="remoteCallControlTelephonyEnabled" destination="executeData" mode="move" />
	<before source="data" sourcePath="poolFQDN" destination="executeData" mode="move" />
	<before source="data" sourcePath="poolTag" destination="executeData" mode="move" />
	<after source="executeData" destination="data" mode="merge" />
	</execute>
  </procedure>
</request>

Example XML Response

<response>
  <data>
	<!--A list of features applied to the user, combining the list of features from the plan and any overrides specified.-->
	<features>
	<!--This allows the user to invite anonymous user to meeting.-->
	<allowOrganizeMeetingWithAnonymousParticipants>true</allowOrganizeMeetingWithAnonymousParticipants>
	<!--This enables the user for Office Communications Server.-->
	<enabled>true</enabled>
	<!--This enables the user for new advanced features of Office Communications Server.-->
	<enabledForEnhancedPresence>true</enabledForEnhancedPresence>
	<!--This enables the user to participate in a federated conversation.-->
	<enabledForFederation>true</enabledForFederation>
	<!--This enables the user for internet access.-->
	<enabledForInternetAccess>true</enabledForInternetAccess>
	<!--This setting controls the user ability to participate in conversations with public IM providers such as AOL, MSN and Yahoo.-->
	<publicNetworkEnabled>true</publicNetworkEnabled>
	<!--Specifies the name of the Meeting Policy to be applied to a user.-->
	<meetingPolicy>Default Policy</meetingPolicy>
	<!--This enables the user for Unified Communications.-->
	<ucEnabled>true</ucEnabled>
	<!--Specifies the name of the Unified Communications Policy to be applied to a user. This parameter must be present if ucEnabled is true.-->
	<ucPolicy>Default Policy</ucPolicy>
	</features>
	<!--The fully qualified domain name (FQDN) of the home application pool for this user.-->
	<poolFQDN>pool01.fabrikam.com</poolFQDN>
	<!--The distinguished name of the home application pool for this user. This name must be valid within the domain's Active Directory.-->
	<poolDN>CN=LC Services,CN=Microsoft,CN=Pool,CN=Pools,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</poolDN>
  </data>
</response>

Applies To