This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.
Managing a SIP Application on Office Communications Server
The Microsoft Office Communications Server Management API provides two WMI classes for registering and managing applications.
MSFT_SIPApplicationSetting (Updated) defines the settings used to register a SIP application with Office Communications Server.
MSFT_SIPApplicationPriorityList defines the execution order of the applications installed on a computer running Office Communications Server.
To register an application, first instantiate an instance of the MSFT_SIPApplicationSetting class for the application and then register the object with WMI. See Registering a SIP Application with Office Communications Server for sample code that illustrates how to create an instance of this class, and how to register and unregister the object with WMI.
As applications are registered and their corresponding MSFT_SIPApplicationSetting instances are created, each application's GUID is automatically added to the end of a priority list that defines the execution order of applications on Office Communications Server. This list is stored in the InstanceIDList property of the MSFT_SIPApplicationPriorityList object on the server.
Applications are also automatically removed when their corresponding MSFT_SIPApplicationSetting instance is removed from the WMI repository. You cannot directly add applications to, or remove applications from the priority list. |
The priority list defines the order in which applications are executed when a SIP message is received. The first application instance in the list has the first opportunity to process an incoming request. If the first application does not process the incoming request, the request is sent to the next application on the list, and so on. Conversely, responses are processed in reverse order. For responses, the last application instance in the list has the first opportunity to process the response. If the application does not process the response, the response is sent to the next-to-last application on the list, and so on. By handling responses in reverse order, the last application to process the incoming request is the first application to process the response.
To manage the execution order of applications on Office Communications Server, reorder the GUIDs contained in the InstanceIDList property of the MSFT_SIPApplicationPriorityList object on the server. Define the execution order based on the nature of the applications. For example, an application that logs calls probably should execute before an application that looks up user endpoints because, even if no endpoints exist for a user, you might still want to log the call as part of monitoring SIP traffic.