Hosted Office Communications Server::Initialize

  • Article

This procedure initializes the Hosted Office Communications Server namespace.

The procedure is responsible for registering the service and its types with the Plan Manager database. It will also establish a dependency between this service and Hosted Active Directory.

Arguments

Input argument Required Type Description

<preferredDomainController>

Yes

xs:string

The domain controller to use for Active Directory actions.

Remarks

Security

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

Permission Check

This procedure does not need to perform an explicit permission check. The procedure calls Managed Plans::RegisterService, which performs a check for Domain Administrator.

Preconditions

  • The Plan Manager database has been installed.

  • The Managed Plans namespace has been initialized.

  • The Hosted Active Directory namespace has been initialized.

Business Rules

The procedure must be able to be run multiple times without throwing an exception.

Post-conditions

The service and all its plans types will be initialized.

Sequence Narrative

  1. The Actor submits an Initialize request to the Hosted Office Communications Server namespace.

  2. The Initialize procedure calls GetServiceInformation to retrieve the data for registering the service.

  3. The Initialize procedure calls Managed Plans::RegisterService with the service information, plan types, feature types, and service dependency for the service.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The name of the preferred domain controller in the Service Provider domain.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="Initialize" impersonate="1"> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
   <data /> 
</response>

Applies To

Hosted Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5