[MS-OCPROTO]: Office Client Protocols Overview
Intellectual Property Rights Notice for Protocol Documentation Copyrights. This protocol documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you may make copies of it in order to develop implementations of the protocols, and may distribute portions of it in your implementations of the protocols or your documentation as necessary to properly document the implementation. This permission also applies to any documents that are referenced in the protocol documentation. No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation. Patents. Microsoft has patents that may cover your implementations of the protocols. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, the protocols may be covered by Microsoft's Open Specification Promise (available here: http://www.microsoft.com/interop/osp). If you would prefer a written license, or if the protocols are not covered by the OSP, patent licenses are available by contacting protocol@microsoft.com. Trademarks. The names of companies and products contained in this documentation may be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than specifically described above, whether by implication, estoppel, or otherwise. Tools. This protocol documentation is intended for use in conjunction with publicly available standard specifications and network programming art, and assumes that the reader either is familiar with the aforementioned material or has immediate access to it. A protocol specification does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments you are free to take advantage of them.
Abstract
1 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
The Office Client Protocols Overview describes the client and server protocols used by the applications of Microsoft® Office Ultimate 2007 Service Pack 1 (SP1). It covers protocols that are commonly shared by all applications in Office Ultimate 2007 SP1, and those protocols that are used by only specific applications in Office Ultimate 2007 SP1. Where appropriate, this document describes the relationships between protocols and provides example scenarios to show how they are used.
Revision Summary
Author Microsoft Corporation Microsoft Corporation Microsoft Corporation Date April 4, 2008 June 27, 2008 October 6, 2008 Version 0.1 1.0 1.01 Comments Initial availability Revised and edited the technical content Revised and edited the technical content
2 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Table of Contents
1 Introduction ............................................................................................................................ 5 1.1 About this Document ....................................................................................................... 5 1.2 Covered Applications ....................................................................................................... 6 1.3 Definitions ........................................................................................................................ 6 2 Common Protocol Usage (Shared by Several Applications) ................................................. 9 2.1 Authentication .................................................................................................................. 9 2.1.1 Overview ................................................................................................................... 9 2.1.2 Protocol List .............................................................................................................. 9 2.2 File Access ..................................................................................................................... 11 2.2.1 Overview ................................................................................................................. 11 2.2.2 Protocol List ............................................................................................................ 11 2.2.3 Protocol Discovery and Feature Enablement.......................................................... 14 2.2.3.1 File Access from SMB Shares ......................................................................... 14 2.2.3.2 File Access from Web Servers ........................................................................ 15 2.2.3.3 Web Views Detection ...................................................................................... 16 2.2.3.4 Other Considerations for File Access from Web Servers................................ 17 2.2.3.5 Understanding HTTP Conversion for UNC Redirector Files.......................... 17 2.3 Document Management ................................................................................................. 18 2.3.1 Overview ................................................................................................................. 18 2.3.2 Protocol List ............................................................................................................ 18 2.3.3 Protocol Discovery and Feature Enablement.......................................................... 20 2.3.3.1 Document Recovery and Workflow Enablement ............................................ 20 2.3.3.2 Version History Enablement............................................................................ 20 2.3.3.3 Check In and Check Out Enablement.............................................................. 21 2.3.3.4 Property Panel Enablement.............................................................................. 22 2.3.3.5 Document Management Information Task Pane Enablement ......................... 24 2.4 Data Access .................................................................................................................... 25 2.4.1 Overview ................................................................................................................. 25 2.4.2 Protocol List ............................................................................................................ 25 2.5 Rights Management........................................................................................................ 26 2.5.1 Overview ................................................................................................................. 26 2.5.2 Protocol List ............................................................................................................ 26 2.6 Active Directory Communications................................................................................. 27 2.6.1 Overview ................................................................................................................. 27
3 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
2.6.2 Protocol List ............................................................................................................ 28 2.7 Microsoft Error Reporting.............................................................................................. 28 2.7.1 Overview ................................................................................................................. 28 2.7.2 Protocol List ............................................................................................................ 28 2.7.3 Protocol Discovery and Enablement....................................................................... 30 2.8 Customer Experience Improvement Program ................................................................ 30 2.8.1 Overview ................................................................................................................. 30 2.8.2 Protocol List ............................................................................................................ 30 2.8.3 Protocol Discovery and Enablement....................................................................... 31 2.9 ActiveX Controls Installed by the Office Client for Server Integration ........................ 31 2.9.1 Overview ................................................................................................................. 31 2.9.2 ActiveX Controls Installed...................................................................................... 31 3 Application-Specific Protocol Usage.................................................................................... 33 3.1 Office Word.................................................................................................................... 33 3.1.1 Overview ................................................................................................................. 33 3.1.2 Protocol List ............................................................................................................ 34 3.2 Office Excel.................................................................................................................... 34 3.2.1 Overview ................................................................................................................. 34 3.2.2 Protocol List ............................................................................................................ 35 3.3 Office PowerPoint .......................................................................................................... 35 3.3.1 Overview ................................................................................................................. 35 3.3.2 Protocol List ............................................................................................................ 36 3.4 Office Access ................................................................................................................. 36 3.4.1 Overview ................................................................................................................. 36 3.4.2 Protocol List ............................................................................................................ 37 3.5 Office OneNote .............................................................................................................. 38 3.5.1 Overview ................................................................................................................. 38 3.5.2 Protocol List ............................................................................................................ 38 3.6 Office Publisher.............................................................................................................. 38 3.6.1 Overview ................................................................................................................. 38 3.7 Office InfoPath ............................................................................................................... 39 3.7.1 Overview ................................................................................................................. 39 3.7.2 Protocol List ............................................................................................................ 39 3.7.3 Publishing an InfoPath Form to a Server ................................................................ 42 3.7.3.1 Publishing a form template which is not browser-enabled to the server ......... 42
4 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
3.7.3.2 Publishing a browser-enabled form template to the server ............................. 43 3.7.3.3 Publishing an administrator-approved form template ..................................... 43 3.7.3.4 Verifying that a form template can be browser-enabled ................................. 43 3.7.4 Data Connections .................................................................................................... 44 3.7.4.1 Database query data connection ...................................................................... 45 3.7.4.2 Web service query or Web service submit data connectio n ............................ 46
3.7.4.2.1 3.7.4.2.2 3.7.4.2.3 3.7.4.2.4 Discovering Web services by using UDDI ..........................................................46 Retrieving and interpreting WSDL .....................................................................46 SOAP (Simple Object Access Protocol) protocol use when auser fills out a form...46 Use of Web service proxy ..................................................................................47
3.7.4.3 HTTP POST submit data connection .............................................................. 47 3.7.4.4 SharePoint lists query data connection ............................................................ 47 3.7.4.5 XML file query data connection ...................................................................... 47 3.7.4.6 File submit connection..................................................................................... 48 3.7.4.7 Universal Data Connection (.udc, .udcx) files................................................. 48 3.7.4.8 Human Workflow Services data connection ................................................... 48 3.8 Office Outlook................................................................................................................ 49 3.8.1 Overview ................................................................................................................. 49 3.8.2 Protocol List ............................................................................................................ 49 3.9 Groove ............................................................................................................................ 50 4 References ............................................................................................................................. 50 5 Appendix A: Product Behavior ............................................................................................ 56 6 Index ...................................................................................................................................... 57
1
Introduction
This document is an overview of the client and server protocols used by the applications of Microsoft® Office Ultimate 2007 Service Pack 1 (SP1). It covers protocols that are commonly shared by all applications in Office Ultimate 2007 SP1, and those protocols that are used by only specific applications in Office Ultimate 2007 SP1. Where appropriate, this document describes the relationships between protocols and provides example scenarios to show how they are used.
1.1 About this Document
This document is a companion to the protocol specifications that are included in the Office documentation set.
5 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
This document is organized as follows: Section 1.2 lists the applications covered by this document. Section 1.3 provides definitions of terms that are used in this document. Section 2 covers the common protocols that are used by most or all of the Office Ultimate 2007 SP1 client applications. Section 3 covers protocols that are specific to each application.
1.2 Covered Applications
The client applications covered by this document are those in Microsoft Office Ultimate 2007 SP1. These include: Microsoft® Office Word 2007 Service Pack 1 (SP1) Microsoft® Office Excel® 2007 Service Pack 1 (SP1) Microsoft® Office PowerPoint® 2007 Service Pack 1 (SP1) Microsoft® Office Access® 2007 Service Pack 1 (SP1) Microsoft® Office Publisher 2007 Service Pack 1 (SP1) Microsoft® Office InfoPath® 2007 Service Pack 1 (SP1) Microsoft® Office OneNote® 2007 Service Pack 1 (SP1) Microsoft® Office Outlook® 2007 Service Pack 1 (SP1) Microsoft® Office Groove® 2007 Service Pack 1 (SP1)
Microsoft Office Groove 2007 is covered separately in the Groove Protocols Overview document [MS-GRVPROT].
1.3 Definitions
The following terms are defined in [MS-GLOS]: Active Directory Active Directory Domain Services (AD DS) authentication constrained delegation credential digital certificate domain Generic Security Services (GSS) Hype rtext Transfer Protocol over Secure Sockets Layer (HTTPS) interactive logon Kerberos
6 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Lightweight Directory Access Protocol (LDAP) path principal property public key read-only schema Secure Sockets Layer (SSL) Server Message Block (SMB) share Transport Layer Security (TLS) URL (Uniform Resource Locator) user agent
The following terms are defined in [MS-OFCGLOS]: Active Directory Service Interfaces (ADSI) administrator-approved form template alert alert subscription browser-enabled form template business logic check in check out column content type cookie data connection data connection library data source default vie w document library File Transfer Protocol (FTP) folder form form definition (.xsf) file form file
7 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
form te mplate form te mplate (.xsn) file form te mplate form vie w group header HTML (HyperText Markup Language) HTTP GET HTTP POST Human Workflow Services (HWS) Hype rtext Transfer Protocol (HTTP) Inte rnet messages list list ite m main data connection main data source me mbership minor version online analytical processing (OLAP) permission picture library proxy publish secondary data source site collection Slide Library SOAP (Simple Object Access Protocol) SOAP header SOAP message submit Universal Data Connection (.udc, . udcx) file Universal Description, Discovery, and Integration (UDDI) URI (Uniform Resource Identifier) user name Web server Web service WSDL (Web Se rvices Description Language) WebDAV (Web Distributed Authoring and Versioning Protocol)
8 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
workflow workflow association workflow instance workflow task X-header XML docume nt XSD (XML schema docume nt)
2
Common Protocol Usage (Shared by Several Applications)
This section describes the usage of common protocols for features which are shared by several Office Ultimate 2007 SP1 applications. The application-specific sections list which of these common protocol sets are used by a given application.
2.1 Authentication
2.1.1 Overvie w
Office client applications use authentication services provided by the operating system. In general, Office client applications support the Authentication protocols described in the following section 2.1.2. 2.1.2 Protocol List
Table 1 lists the Authentication protocols that are generally supported by Office client applications. Table 1. Authentication protocols Protocol Name Protocol Description and Usage Document Short Name
9 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name
Protocol Description and Usage
Document Short Name [MS-SPNG]
Simple and Protected Generic Security Service Application Program Interface Negotiation Mechanism (SPNEGO) Protocol Extensions
Simple and Protected Gene ric Security Services (GSS) Application Program Interface Negotiation Mechanism. SPNEGO is an Authentication protocol that performs no authentication. Instead, it allows secure negotiation among other security protocols in scenarios where the client and server might support more than one protocol. Extensions to the Kerberos Network Authentication Service (V5) protocol [RFC4120]. These extensions provide additional capability for authorization information including group me mberships, interactive logon information and integrity levels, and constrained delegation and encryption supported by Kerberos principals. Used in Windows for authentication between clients and servers. For Microsoft Windows® 2000 Server, Windows® XP, Windows Server® 2003, Windows Vista®, and Windows Server® 2008, Kerberos replaces NTLM as the preferred authentication protocol. However, NTLM is still used in cases where Kerberos does not work (for example, if one of the machines is not Kerberos-capable, if the server is not joined to a domain, or if the Kerberos configuration is not set up correctly). SPNEGO-based Kerberos and NTLM HTTP Authentication.
Kerberos Protocol Extensions
[MS-KILE]
NT LAN Manager (NTLM) Authentication Protocol Specification
[MSNLMP]
SPNEGO-based Kerberos and NTLM HTTP Authentication in Microsoft Windows
[RFC4559]
10 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name
Protocol Description and Usage
Document Short Name [MS-DPSP]
Digest Protocol Extensions HTTP Authentication: Basic and Digest Access Authentication
Windows extensions to the Digest Authentication standard specified in [RFC2617] and [RFC2831]. HTTP/1.0 includes the specification for a Basic Access Authentication scheme. This scheme is not considered a secure method of user authentication (unless used in conjunction with some external secure system such as Secure Sockets Layer (SSL)), as the user name and password are passed over the network as cleartext. Specifies the Passport Server Side Include (SSI) Version 1.4 Protocol (or the Passport SSI Version 1.4 Protocol), also known as the "Passport Tweener" protocol. The Passport SSI Version 1.4 Protocol is a Microsoftproprietary protocol based on HTTP (as specified in [RFC2616]) for authenticating a client to a server with the assistance of an authentication server.
[RFC2617]
Passport Server Side Include (SSI) Version 1.4 Protocol Specification
[MS-PASS]
2.2 File Access
2.2.1 Overvie w
Office client applications use several protocols to communicate with servers when accessing files. The exact protocol that is used depends on the type of server that is being communicated with (for example, Server Message Block (SMB) share or Web server) and other factors such as the version of the Office client, supported capabilities that are advertised by the Web server in response to an OPTIONS request, and what operating system the Office client is running on. 2.2.2 Protocol List
Table 2 lists protocols used by Office client applications to access files on servers. Table 2. File access protocols
11 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name Server Message Block (SMB) Version 1.0 Server Message Block (SMB) Version 2.0
Protocol Description and Usage Extensions to the Common Internet File System (CIFS) protocol, as specified in [CIFS] used for file and print sharing. Extension of the original Server Message Block (SMB) Protocol (as specified in [MS-SMB] and [CIFS]). It improves scaling and robustness. It is available in Windows Vista and Windows Server 2008. Web Distributed Authoring and Versioning (WebDAV) protocol. Microsoft client implementation of the WebDAV protocol provides file access and content management over the Internet. The implementation is a minor extension to IETF [RFC2518] (WebDAV), which is layered on top of the Hypertext Transfer Protocol (HTTP) defined in [RFC2068]. The extensions provide enhanced features such as new error codes and additional TCP ports that the protocol can operate on.
Document Short Name [MS-SMB]
[MS-SMB2]
HTTP Extensions for Distributed Authoring∙WebDAV Web Distributed Authoring and Versioning (WebDAV) Protocol: Client Extensions
[RFC2518]
[MS-WDV]
12 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name Web Distributed Authoring and Versioning (WebDAV) Protocol: Microsoft Extensions
Protocol Description and Usage All versions of Windows SharePoint Services implement a Microsoft–specific version of the WebDAV protocol which has both extensions to and limitations for the protocol. Most of the extensions are designed to work around specific behaviors in the Windows client component that implements WebDAV. For example, the server performs more granular capability negotiation based on the user agent string. The limitations exist mainly because the server was not originally implemented to be RFC-compliant. As a result, several required sections of the protocol are not implemented.
Document Short Name [MS-WDVME]
Office Document Update Utility Extensions Protocol Specification
Extensions to the WebDAV protocol. Extensions include header updates, a property which enables optimized protocol interaction for synchronization, and a property which allows the server to send clients the virus infection status of a document. This is used by the Office clients' Document Workspaces feature to synchronize documents with Windows SharePoint Services.
[MSWDVMODUU]
Web Distributed Authoring and Versioning Error Extensions Protocol Specification
Describes the extended error codes that Windows SharePoint Services can send back to an Office client application. Extended errors include errors such as document checked out, minor version limit extended, and missing required document properties.
[MSWEBDAVE]
13 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name FrontPage Server Extensions Remote Protocol Specification FrontPage Server Extensions Website Management Protocol Specification
Protocol Description and Usage Provides file access functionality similar to WebDAV, allowing a Web site to be presented as a file share. Provides a set of methods to implement file uploading and downloading, basic file locking, file movement, and directory creation and listing on a Web server.
Document Short Name [MS-FPSE]
[MC-FPSEWM]
Windows SharePoint Services Collaborative Application Protocol Specification Hypertext Transfer Protocol -- HTTP/1.1
Specifies a protocol that enables a client to retrieve and manipulate various types of content on a server. An application-level protocol for distributed, collaborative, and hypermedia information systems. It is a generic, stateless, protocol which can be used for many tasks including file access. If other protocols are not supported, Office client applications use HTTP GET for read-only access to files. File Transfer Protocol used for opening and saving. Locking is not supported by Office client when accessing files over FTP.
[MS-WSSCAP]
[RFC2616]
File Transfer Protocol (FTP)
[RFC959]
2.2.3
Protocol Discovery and Feature Enable ment
2.2.3.1 File Access from SMB Shares All Office client applications can access files on SMB shares by using the [MS-SMB] protocol or [MS-SMB2] protocol. These services are provided to the Office client applications by the
14 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
operating system. The operating system determines the discovery and choice of protocol version (1.0 or 2.0) to use when accessing files on an SMB share. 2.2.3.2 File Access from Web Servers When an Office client application attempts to open a document on a Web server, the Office client application does one of the following: Opens the document in browse (read-only) mode. Opens the document in edit mode, as read/write with a lock on the document on the server to ensure exclusive access for the client.
Which action to take is determined by investigating the folder path where the document is located and by investigating the capabilities of the server that manages that path. The following steps describe this process. 1. The Office client application issues an HTTP 1.1 standard OPTIONS request as specified in [RFC2616]. 2. The Web server responds to the OPTIONS request with the list of methods that are supported for the Uniform Resource Identifier (URI). If the server rejects the OPTIONS request, the Office client application tries to open the document in browse mode with an HTTP GET request. 3. The Office client application evaluates the response and examines the MS-Author-Via header value (specified in [MS-WDVRV]) to determine the Web authoring protocol. a. If the MS-Author-Via header has a value of MS-FP/4.0,DAV to indicate that the server supports the FrontPage Server Extensions Remote Protocol (FPSE) specified in [MS-FPSE] and the WebDAV protocol specified in [RFC2518], then the protocol used is determined by the operating system and version of the Office client in use, as follows: i. Microsoft Office 2003 Edition applications use the [MS-FPSE] protocol for remote file access to that document. ii. If the operating system on which the client is installed is Windows XP, then the 2007 Microsoft Office suite applications use the [MS-FPSE] protocol for remote file access to that document. iii. If the operating system on which the client is installed is Windows Vista, and the Windows Web Client service is enabled, then the 2007 Microsoft Office suite applications use the WebDAV protocol for remote file access to that document. iv. If the operating system on which the client is installed is Windows Vista, and the Windows Web Client service is disabled, then the 2007 Microsoft
15 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Office suite application attempts to use the [MS-FPSE] Protocol if it is available on the client for remote file access to the document. b. If the MS-Author-Via header has a single value of DAV to indicate that the server supports WebDAV but not [MS-FPSE], then the Office client uses WebDAV for remote file access to the document. c. If the MS-Author-Via header is not present, but a DAV header is present with a value of 1 (no lock support and not recommended) or 1,2 (locks supported), then the Office client uses WebDAV. The Office client does not notify the user if the WebDAV server does not support locks, and in this case if there are two conflicting write operations to the file from separate clients, then the changes in the last write operation are used. d. If the server does not provide an authoring protocol, the Office client uses browse mode and the file is opened as read-only with an HTTP GET. The client can save a local copy; however, the Office client cannot save back to the file's original folder location. 2.2.3.3 Web Views Detection Web views allow a user to browse the folders and files on a Web server in the file Open dialog box or Save dialog box. How Web views are enabled depends on the version of Office client and the version of the operating system in use. For 2007 Microsoft Office suite applications installed on Windows Vista, Web views are enabled as follows: 1. If the browse path is an HTTP path, and a HEAD request to the Web View URL (Uniform Resource Locator) succeeds, Web views are enabled. 2. The client makes a GET request to get the Web view of the folder and displays the HTML (HyperText Markup Language) response in the dialog box. (Details are specified in the [MS-WSSCAP], Section 3.1.4.6. For the Microsoft Office 2003 Editions applications installed on Windows Vista, or for the Microsoft Office 2003 Editions applications or the 2007 Microsoft Office system applications installed on Windows® XP: 1. If the server responds to an OPTIONS request with the MicrosoftOfficeWebServer: 5.0_Collab header, Web views are enabled. 2. The client makes a GET request to get the Web view of the folder and displays the HTML response in the dialog box. (Details are specified in the [MS-WSSCAP], Section 3.1.4.6.
16 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
2.2.3.4 Other Considerations for File Access from Web Servers When implementing Web servers to support file access from Office client applications, consider the following: The Office client uses a standard HTTP 1.1 OPTIONS request. Web servers that do not handle this command cannot support full read/write access in Office client applications. When opening Office documents, users can be prompted for authentication. This behavior occurs if the Web server requires authentication to process an OPTIONS request to the URL of the folder. Changes to the server configuration can typically be made to avoid this problem by giving anonymous users browse permissions (also known as list permissions) to the folder. The prompt for authentication is expected if the server requires authentication for either the folder or file location. Upon opening a file, the user can be prompted to select a client digital certificate or to select a server digital certificate. This behavior can occur even if this digital certificate information is previously provided via a Web browser for the same navigation. Because the Office client application makes a new request for its own process space to the server, a new session is created each time. This new session can produce additional security warnings or additional prompts to complete the OPTIONS request successfully or for subsequent file access. Cookie information that is used for gathering the document is not used in the OPTIONS request. If the server requires this cookie information to permit direct calls to the folder URL, the OPTIONS request and file access can fail. If this problem occurs, the user can be prompted repeatedly for authentication; however, the user can fail to provide authentication. This problem occurs because of missing session cookies for the Web server, not because of missing authentication. This problem is specific to certain Webserver designs that depend on cookie information instead of authentication information, or that depend on both cookie information and authentication information.
2.2.3.5 Understanding HTTP Conversion for UNC Redirector Files The Windows Web Client service (also known as the WebDAV mini-redirector) in the Windows operating systems lets WebDAV-enabled folders appear as UNC shares. Because of the Windows Web Client service, an application can open the file, edit the file, and save to the file even if it cannot directly interact with an HTTP server. However, document collaboration requires more functions than are provided by the Windows Web Client service. Therefore, Office client applications determine if a file path is associated with the Windows Web Client service. If it is, the Office client application remaps the path back to a full URL and then opens the file by using the protocol that is appropriate for the type of server handling requests for
17 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
the fully specified URL. This enables an Office client application to perform full-document collaboration features, as if the file is opened directly from the URL in the Office client application.
2.3 Document Management
2.3.1 Overvie w
The Office client enables a variety of document management functions when communicating with servers that support that functionality. These include the following: Version history Check- in or check-out operations Content types and document properties Document Management Information task pane Workflow
The following table describes the document management protocols that are used by the 2007 Microsoft Office system applications. 2.3.2 Protocol List
Table 3 lists the document management protocols used by the 2007 Microsoft Office system applications. Table 3. Document management protocols Protocol Name Protocol Description and Usage Document Short Name [MSDWSS]
Document Workspace Web Service Protocol Specification
Used by the Document Management Information task pane to create, edit, or delete workspaces and folders for a site.
18 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name
Protocol Description and Usage
Document Short Name [MSWWSP]
Workflow Web Service Protocol Specification
Allows client applications to query, boot, and manipulate Workflows on a document. Client applications, given a document, can do the following: query information about existing workflow instances and workflow tasks emitted by these workflow instances, query for available workflow associations for a given list, create workflow instances from a given workflow association for a particular document, and modify workflow tasks related to their document. WebUrlFromPageUrl method of this protocol is used commonly as a precursor to other method calls for other protocols. It gets the parent site for a given file. Enumerates items, gets changes, and gets and sets properties on lists and documents. Gives programmatic access to the view and manages the versions of files on the server. It allows retrieval of all versions of a file, deletion of previous versions of a file, and restoration of a file to a previous version. Used for document management, provides check- in or check-out operations in addition to file access.
Webs Web Service Protocol Specification Lists Web Service Protocol Specification Versions Web Service Protocol Specification
[MSWEBSS]
[MSLISTSWS] [MSVERSS]
FrontPage Server Extensions Remote Protocol Specification FrontPage Server Extensions Website Management Protocol Specification
[MS-FPSE]
By using a set of methods, provides file uploading and downloading, directory creation and listing, basic file locking, and file movement on a Web server.
[MCFPSEWM]
19 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
2.3.3
Protocol Discovery and Feature Enable ment
The Office client application begins discovery by determining the type of Web server it is communicating with and the capabilities that Web server supports. This is performed through an HTTP OPTIONS request. The Office client application then looks for the existence and values of the MicrosoftSharePointTeamServices header and Docume ntManagementServer header in the response. These HTTP single- value header values and multiple-value header values use the same format as any header value as specified in HTTP 1.1 [RFC2616]. An example of how this looks when sent with the DocumentManage mentServer header is as follows: DocumentManagementServer: Version History;Source Control;\r\n The following sections describe the features that are enabled, depending on the header values. 2.3.3.1 Document Recovery and Workflow Enablement Starting in the 2007 Microsoft Office system, the Office client applications check for the existence of the DocumentManagementSe rver header in the response. If the header exists, the Office client application enables the following features with no assumptions that the server does anything to support them: Document Recovery Workflow Word Reading Layout
Note: To support workflow, the server must return data in the Workflow Web service [MSWWSP] request made by the Office client application. This either fails or succeeds as any standard Web service would, and therefore the server is not required to handle this if it is not supporting workflow. The Microsoft Office 2003 Editions applications do not check this header and enable these features. 2.3.3.2 Version History Enablement Table 4 describes the conditions in which Office client applications enable the version history features.
20 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Table 4: Conditions required to enable version history features Client Version Microsoft Office 2003 Editions 2007 Microsoft Office suites 2007 Microsoft Office suites MicrosoftSharePointTeamServices OPTIONS Header Exists DocumentManage mentServer OPTIONS Header Any (exists or not); not checked Enabled Yes
Exists with no value or a value less than 12
Any (exists or not)
Yes
Any (exists or not)
Exists with value Version History
Yes
By default, the version history features are hidden unless the correct header and value are specified in the response. For the version history features to function correctly, Office client applications require the server to support [MC-FPSEWM]. 2.3.3.3 Check In and Check Out Enablement Table 5 describes the conditions in which Office client applications enable the check in and check out features. Table 5: Conditions required to enable check in and check out features Client Version Microsoft Office 2003 Editions MicrosoftSharePointTeamServices OPTIONS header Exists DocumentManage mentServer OPTIONS header Any (exists or not) – not checked Enabled Yes
21 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Client Version 2007 Microsoft Office suites 2007 Microsoft Office suites
MicrosoftSharePointTeamServices OPTIONS header Exists
DocumentManage mentServer OPTIONS header Any (exists or not)
Enabled Yes
Any (exists or not)
Exists with value Source Control
Yes
In addition to these conditions, Office client applications enable this feature only if the user is allowed to check out the document. It examines this permission on the server by using [MCFPSEWM]. By default, the Check In and Check Out features in Office client applications are disabled unless the correct header and value is specified in the response. Office client applications require the server to support [MC-FPSEWM] for the check in and check out features to function correctly. 2.3.3.4 Property Panel Enablement The integrated Property Panel in the Office client is used to collect document properties to store on the server with the document. After the user enters properties, the properties are stored in the file. After the file is saved to the server, the server may extract the properties in the file for document management purposes. Table 6 describes the conditions in which Office client applications enable the Property Panel features. Table 6: Conditions required to enable Prope rty Panel features Client Version MicrosoftShareP ointTeamService s OPTIONS Header DocumentMana gementServer OPTIONS Header For File Type Enabled
22 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Client Version
MicrosoftShareP ointTeamService s OPTIONS Header Does not apply
DocumentMana gementServer OPTIONS Header Does not apply
For File Type
Enabled
Microsoft Office 2003 Editions 2007 Microsoft Office suites
Does not apply
Not supported
Exists with value greater than "12"
Does not apply
.doc, .docm, .docx, .dot, .dotm, .dotx, .pot, .potm .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .vsd, .vst, .xls, .xlsb, .xlsm, .xlsx, .xlt, .xltm, .xltx
.doc, .docm, .docx, .dot, .dotm, .dotx, .pot, .potm .potx, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, . vsd, .vst, .xls, .xlsb, . xlsm, . xlsx, .xlt, .xltm, . xltx
Yes
2007 Microsoft Office suites
Does not apply
Exists with value Properties Schema
Yes
By default, the Property Panel features in Office client applications are disabled unless the correct header and value is specified in the response. Office client applications require the server to support [MS-LISTSWS] for getting and manipulating document properties. If the integrated Property Panel is not enabled by the conditions described in Table 6, then the Web Form Property Panel is used to collect document properties to store on the server with the document. The Web Form Property Panel is a Web form that is launched from the Office client application. By default, the Web Form Property Panel features are disabled unless the correct header and value is specified in the response. Table 7 describes the scenarios in which Office client applications enable the Web Form Property Panel features and launch the Web Form Property Panel.
23 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Table 7: Conditions required to enable Web Form Property Panel features Client Version Microsoft Office 2003 Editions 2007 Microsoft Office suites MicrosoftOfficeWebSe rver OPTIONs Header Exists with value 5.0_Collab Integrated Property Panel Does not apply Web Form Property Panel Enabled Yes
Exists with value 5.0_Collab
Not enabled by conditions above
Yes
The Web Form Property Panel requires the server to support [MC-FPSEWM] for getting and manipulating document properties. 2.3.3.5 Document Management Information Task Pane Enablement The Document Management Information task pane provides document status, lists of other members of the workspace and their presence, tasks in the workspace, other documents in the workspace, and links in the workspace. By default, the Document Management Information task pane features in Office client applications are disabled unless the correct header and value is specified in the response. Table 8 describes the conditions in which Office client applications enable the Document Management Information task pane features. Table 8: Conditions required to enable the Document Manage ment Information task pane Client Version Microsoft Office 2003 Editions MicrosoftSharePointTeamServices OPTIONS Header Exists DocumentManage mentServer OPTIONS Header Does not apply Enabled Yes
24 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Client Version 2007 Microsoft Office suites
MicrosoftSharePointTeamServices OPTIONS Header Exists
DocumentManage mentServer OPTIONS Header Does not apply
Enabled Yes
Office client applications require the server to support [MS-DWSS] for the Document Management Information task pane functionality.
2.4 Data Access
2.4.1 Overvie w
The Office client supports a variety of features that provide or use remote data access. These include the ability to import remote data into a table or PivotTable report in Microsoft Office Excel, or to link a table of remote data into Microsoft Office Access, and the ability to use remote data for a mail- merge list in Microsoft Office Word. These features use OLEDB and Open Database Connectivity (ODBC), which are client-side APIs for accessing local and remote data by using ODBC drivers. A common way to extend these features to new data sources is to install an appropriate ODBC driver for the data source. These features can then use the data source. ODBC is a client side API (not a wire protocol) that is broadly used in the industry, and many ODBC drivers exist for different data sources. For more information about OLEDB and ODBC, see [MSDN-OLEDB] and [MSDN-ODBC]. When communicating with Microsoft® SQL Server® data sources, the OLEDB drivers included with the Office client application communicate over the wire to the server running SQL Server by using the Tabular Data Stream (TDS) protocol (specified in [MS-TDS]). 2.4.2 Protocol List
Table 9 lists the protocol used for data access. Table 9: Protocol used for data access Protocol Name Protocol Description and Usage Document Short Name
25 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name MS-Tabular Data Stream Protocol Specification
Protocol Description and Usage Protocol used for remote data access to SQL Server
Document Short Name [MS-TDS]
2.5 Rights Management
2.5.1 Overvie w
The Office client provides functionality that the document owne r can use to restrict how others may access and manipulate the contents of a document. The document owner can control whether a document can be accessed, printed, forwarded, or copied by assigning all or any of these rights to a specific individual or group. Information to manage these rights is stored as XrML (eXtensible Rights Markup Language specified in [MS-RMPR]), and travels with the document and its encrypted content. When the Office client application opens an RMS protected document, the Office client application communicates with the Rights Management Client in the Windows operating system. The Windows operating system may then communicate with the RMS server to determine the user's current document rights. If the user has access rights, the document is decrypted and only the functionality the user has been granted by the document owner is enabled ( for example, print or copy, may be disabled in that document). The Office client application requires access to an [MS-RMPR]-compliant server to enable users to restrict permissions on documents or open documents with restricted permissions. 2.5.2 Protocol List
Table 10 lists the protocols used for rights management. Table 10: Protocols used for rights manage ment Protocol Name Protocol Description and Usage Document Short Name
26 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name
Protocol Description and Usage
Document Short Name [MSRMPR]
Rights Management Services (RMS): Client-to-Server Protocol Specification Rights Management Services (RMS): ISV Extension Protocol Specification
Used to obtain and issue digital certificates and licenses for creating and working with protected content.
The RMS: ISV Extension Protocol facilitates the creation of applications that extend the capabilities of RMS-enabled applications or bridge capabilities of different software systems by allowing for direct communication between applications and RMS servers without the use of the RMS client. This protocol enables applications to decommission protected content and retrieve a recipient's public key digital certificate
[MS-RMSI]
2.6 Active Directory Communications
2.6.1 Overvie w
Office client applications communicate with Active Directory® to perform various tasks such as looking up user information and finding printers. Office client applications communicate with Active Directory by using two sets of APIs: the Lightweight Directory Access Protocol (LDAP) APIs and the Active Directory Service Interfaces (ADSI) APIs. When calling the ADSI APIs, the ADSI LDAP Provider communicates with Active Directory. The ADSI LDAP Provider is a set of COM objects that implement ADSI and run locally on the client machine where the Office client application is installed, and which make calls to LDAP. The LDAP protocols that communicate with Active Directory are specified in [MS-ADTS]. The Office client applications use ADSI (and consequently the [MS-ADTS] protocol) to find and install printers. The Find Printer functionality uses ADSI to find printers based on search criteria in the Find Printer dialog box, and then install the printer drivers. Office Outlook, Office InfoPath, and Office Groove use ADSI and the LDAP APIs (and consequently the [MS-ADTS] protocol) to find information about the user (such as the user's email address and group membership), to create and delete user accounts or passwords in Active
27 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Directory, to manage personal sites in Microsoft® Office SharePoint® Server, and to integrate with Instant Messaging. 2.6.2 Protocol List
Table 11 lists the protocol used for communicating with Active Directory. Table 11: Protocol used for communication with Active Directory Protocol Name Active Directory Technical Specification Protocol Description and Usage The primary specification for Active Directory, including both Active Directory Domain Services (AD DS) and Active Directory Lightweight Directory Services (AD LDS). Document Short Name [MS-ADTS]
2.7 Microsoft Error Reporting
2.7.1 Overvie w
All Office client applications can collect information from events in an error report through the Microsoft Error Reporting service. [MS-CER] provides an organization with the ability to copy error reports from a set of client machines to a file share on a server. The protocols contain configuration options that can instruct the application to collect additional information in the error report as specified in [MS-CER] and [MS-MERX]. 2.7.2 Protocol List
Table 12 lists the protocols used for error reporting. Table 12: Protocols used for error re porting. Protocol Name Protocol Description and Usage Document Short Name
28 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name
Protocol Description and Usage
Document Short Name [MS-CER]
Corporate Error Reporting Version 1.0 Protocol Specification
Multi-staged protocol used by Windows® XP and Windows Server® 2003 clients that allows components to send user mode and kernel mode error reports to a corporation's servers instead of to Microsoft servers. The reports are stored on a configurable file share location. This protocol uses SMB as a transport. All versions of the Windows operating system implement basic server-side configurations, but the CER tool is required to implement the full range of server-side configuration options. The CER tool is available only under the software assurance application.
Corporate Error Reporting Version 2.0 Protocol Specification
Multi-staged client service protocol that allows components to send user mode and kernel mode error reports to a corporation's servers. The Corporate Error Reporting V.2 Protocol allows components to send failure information to the corporate servers instead of to Microsoft servers. Developers can configure failure report buckets to collect additional failure specific information and also send responses back to the client machines. The server side of the protocol is implemented by System Center Operations Manager 2007. This protocol is used by Windows Vista® clients.
[MS-CER2]
Microsoft Error Reporting Extension to Corporate Error Reporting Version 1.0 Protocol Specification
Extends the original Corporate Error Reporting V.1 Protocol to support additional kinds of error reporting, additional options for existing protocol details, and more specific requirements about error report contents. This protocol is used by Windows XP and Windows Server 2003 clients.
[MSMERX]
29 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
2.7.3
Protocol Discovery and Enable ment
An error event, such as an application exception, kernel fault, or a generic event defined by the application, causes the Office client application to collect information in an error report. The Error Reporting Protocol does not create the original contents of the error report. The error report is a single .cab file (as specified in [MS-MERX]) that contains the error reporting information. If the client is configured with the file path of the file share on the server through policy settings (as specified in [MS-CER]), the error files are copied by using the SMB Protocol on Windows XP and Windows Server 2003 using [MS-CER], and by using HTTP 1.1 POST on Windows Vista using [MS-CER2] (Corporate Error Reporting V.2 Protocol). Parameters from the Office client application determine the file share folder structure where the .cab file is stored. If the folder structure for a set of parameters does not exist, it is created. Each folder structure contains a set of configuration files. A configuration file can be modified through a response from the service. The configuration files contain parameters that instruct the Error Reporting Protocol about what information to include in an error report and what response to send to the Office client application.
2.8 Customer Experience Improvement Program
2.8.1 Overvie w
All Office client applications can collect instrumentation data through the Customer Experience Improvement Program (CEIP) service. The Corporate CEIP protocol provides an organization with the ability to redirect the instrumentation files from a set of client machines to a server. 2.8.2 Protocol List
Table 13 lists the protocol used for the CEIP program. Table 13: Protocol used for CEIP program Protocol Name Protocol Description and Usage Document Short Name
30 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name Corporate Customer Experience Improvement Program Clientto-Server Protocol Specification
Protocol Description and Usage Allows components to send instrumentation files to a corporation's servers instead of to Microsoft servers. This protocol uses HTTP/1.1 as a transport. This protocol is used by Windows XP and Windows Vista clients.
Document Short Name [MS-CCEIP]
2.8.3
Protocol Discovery and Enable ment
The Office client application collects instrumentation data for users who have opted- in to the CEIP. The instrumentation data is written to files on the client machine. If the Office client is configured with an upload URL through policy settings, as specified in [MS-CCEIP], the files are uploaded using HTTP/1.1 POST. The upload URL contains the service URL as a query string parameter and the protocol redirects the files to the service.
2.9 ActiveX Controls Installed by the Office Client for Server Integration
2.9.1 Overvie w
The Office client installs several ActiveX controls to enable Web servers such those running Windows SharePoint Services to invoke client functionality when viewed in a browser that supports ActiveX controls. These can be invoked in the same way any ActiveX controlled is invoked from a Web page. These ActiveX controls do not define any additional wire protocols, but are described here to provide information about interoperability. 2.9.2 ActiveX Controls Installed
The ActiveX controls that are installed by the Office client are documented on the Microsoft Developer Network (MSDN) (see [MSDN-WSS3CLIENTSIDEAPI]). The ActiveX® controls described in Table 14 are used within the context of SharePoint sites, but do not invoke Office client applications such as Office Word, Office Excel, Office PowerPoint, or Office Outlook. The following table lists the protocols used by each ActiveX control.
31 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Table 14: Stand-alone ActiveX controls ActiveX Control Name ListNet Feature Description Protocols Used
Provides a richer SharePoint list datasheet editing experience than is provided by default. Enables multiple documents to be uploaded to a document library on a SharePoint site. Enables a user to copy a document on a SharePoint site to one or more locations on a server.
[MS-LISTSWS]
UploadCtl
[MS-WSSCAP] [MS-FPSE] [MS-COPYS]
CopyCtl
The ActiveX controls described in Table 15 launch Office client applications, interact with them through client-side APIs, or specify settings that are subsequently used by Office client applications. Table15: ActiveX controls that integrate with Office client applications but do not directly use protocols ActiveX Control Name OpenDocuments Feature Description Launches Office client applications so that user can create a document or edit an existing document. Enables users to create documents that are based on a specified template, to choose to open the documents as read only or read/write, and to check out the documents. Launches the Microsoft® Office Picture Manager and passes command line parameters for editing and downloading pictures from picture libraries. Launches Office PowerPoint to open presentations from a Slide Library or publish individual slides to a Slide Library.
32 of 57
OISClientLauncher
PPActiveX
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
ActiveX Control Name OpenXMLDocuments
Feature Description Launches Office InfoPath to create XML docume nts or forms based on a specified template, or to edit XML documents or forms with InfoPath. Enables a Web page to display presence information for people, and allows the user to take various actions with respect to those people through an on-object user interface (UI) in Windows® SharePoint® Services. Integrates through client side APIs with Microsoft Office Communicator. Configures a user's My Site location, which is used by client applications to discover locations of SharePoint sites and libraries. Also used to retrieve colleague suggestions generated from client applications. Enables a user to import lists from Office Excel spreadsheets or to verify whether Office Excel is enabled to export lists from Windows SharePoint Services. Returns the name of the application used to synchronize events lists and contacts lists in Windows SharePoint Services with a messaging application such as Office Outlook 2007. Enables a user to create or open a database that contains data from a SharePoint list in an application such as Office Access.
NameCtrl
PersonalSite
SpreadSheetLauncher
StssyncHandler
ExportDatabase
3
Application-Specific Protocol Usage
3.1 Office Word
3.1.1 Overvie w
Microsoft Office Word uses all the common protocols covered in section 2 for each of the relevant features. It uses the data access protocols covered in section 2.4 for features such as Mail Merge.
33 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
In addition to these common protocols, Microsoft Office Word 2007 uses two specific protocols for publishing to blogs: ATOM Publishing Protocol 1.0 and the MetaWeblog Extensions Protocol Specification protocol [MS-METAWEB]. Word determines the protocol to use based on the service provider chosen by the user in the Word user interface. When communicating with blogs on servers running Windows SharePoint Services, Word uses the MetaWeblog Extensions Protocol Specification protocol. Word also supports the Open Document Management 1.0 API [ODMA 1.0]. This is a client-side API, not a protocol; however, it can be used to integrate Word with document management systems by installing an ODMA provider on the client. 3.1.2 Protocol List
Table 16 lists the protocols used by Office Word to publish to blogs. Table 16: Protocols used by Office Word to publish to blogs. Protocol Name The Atom Publishing Protocol The Atom Syndication Format MetaWeblog Extensions Protocol Specification Protocol Description and Usage Simple HTTP-based protocol. Creates and updates Web resources. Describes the format of the data packet used by the Atom Publishing Protocol. API for publishing blogs. Document Short Name [RFC5023] [RFC4287] [MSMETAWEB]
3.2 Office Excel
3.2.1 Overvie w
Microsoft Office Excel uses all the common protocols covered in section 2 for each of the relevant features. It uses the data access protocols covered in section 2.4 for external data features. Office Excel uses the [MS-SSAS9] protocol when connecting to SQL Server® Analysis Services to access online analytical processing (OLAP) data. When publishing a workbook to Excel Services on a server running Microsoft Office SharePoint Server 2007, Excel determines the appropriate URL to which to direct the browser by using [MS-ESURL].
34 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Excel uses the Lists Web Services Protocol [MS-LISTSWS] to sync list data. For example, when a user selects Export to Spreadsheet from the Actions list on a SharePoint list, Excel uses [MSLISTSWS] to sync the list data. Excel also uses [MS-LISTSWS] for creating lists from existing Excel tables. Excel does not use any other Excel–specific protocols. 3.2.2 Protocol List
Table 17 lists the protocols used by Office Excel in addition to the common protocols covered in section 2. Table 17: Protocols used by Office Excel, in addition to the common protocols covered in section 2 Protocol Name Excel Services Publishing Protocol Specification Lists Web Service Protocol Specification QL Server Analysis Services Protocol Specification Protocol Description and Usage Enables a protocol client to form the protocol server URL and associated query string parameters to display the workbook in the browser after the workbook is published to the protocol server. Enumerates items, gets changes, gets and sets properties, and checks in or checks out list items. Document Short Name [MS-ESURL]
[MS-LISTSWS]
Enables remote access to OLAP data from SQL Server Analysis Services.
[MS-SSAS9]
3.3 Office PowerPoint
3.3.1 Overvie w
Microsoft Office PowerPoint uses all the common protocols covered in section 2, except for the data access protocols covered in section 2.4. In addition to these common protocols, Office
35 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
PowerPoint 2007 uses a specific protocol for communicating with Slide Libraries on servers running Microsoft Office SharePoint Server 2007. PowerPoint 2007 can share and reuse slide content by storing individual slide files in a centrally located Slide Library on a server running Office SharePoint Server 2007. Slide Library updates associate a slide inserted in a presentation with the original slide that resides in the Slide Library on the server. Each time the presentation is opened, PowerPoint notifies the user if the slide has been updated and gives the user the option to ignore the update, append a new slide, or update the slide. PowerPoint 2007 uses the [MS-SLIDELI] protocol to communicate with the server to query and obtain information about the contents of the Slide Library. 3.3.2 Protocol List
Table 18 lists the protocol used by Office PowerPoint for communicating with Slide Libraries on servers running Microsoft Office SharePoint Server 2007 Table 18: Protocol used by Office Powe rPoint for communicating with Slide Libraries Protocol Name Slide Library Web Service Protocol Specification Protocol Description and Usage Obtains information about slides in a PowerPoint Slide Library on a SharePoint site. Document Short Name [MS-SLIDELI]
3.4 Office Access
3.4.1 Overvie w
Microsoft Office Access uses all the common protocols covered in section 2 for each of the relevant features. It uses the data access protocols covered in section 2.4 via OLEDB or ODBC for external data features. These data access APIs ultimately use the Tabular Data Stream Protocol [MS-TDS] when communicating with Microsoft® SQL Server®. In addition, Office Access uses the Lists Web Services Protocol [MS-LISTSWS] for syncing, adding, and modifying list data. For example, when a user selects Open with Access from the Actions list on a SharePoint list, Access uses [MS-LISTSWS] to access and modify the list data. Access also uses [MS-LISTSWS] for creating lists from existing Access tables. After creating a list from an existing Access table, Access uses the [MS-VIEWSS] protocol to modify the default view of the newly published list to hide certain columns and show others.
36 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Access also uses the [MS-WPPS] protocol to provide a feature that allows Access to modify the default view of a list. This feature opens the SharePoint list as an Access database showing a particular form view, instead of opening the list using the default SharePoint list control in the Web browser. 3.4.2 Protocol List
Table 19 lists the protocols used by Office Access for syncing, adding, and modifying list data and for modifying the default view of a list. Table 19: Protocols used by Office Access for syncing, adding, and modifying list data and for modifying the default view of a list Protocol Name Protocol Description and Usage Document Short Name [MS-TDS]
MS-Tabular Data Stream Protocol Specification Lists Web Service Protocol Specification Views Web Service Protocol Specification Web Part Pages Web Service Protocol Specification Webs Web Service Protocol Specification
Used for remote data access to a server running SQL Server. Enumerates items, gets changes, gets and sets properties, and checks in or checks out list items. Provides methods to add a list view or to retrieve a specific view or the collection of list views. Enables a client to gather the information needed to author Web pages that use server resources and author execution logic that reacts to changes in the server state. Maps file path URLs to document libraries for actions such as subsequent calls to [MS-LISTSWS].
[MSLISTSWS] [MSVIEWSS] [MSWPPS]
[MSWEBSS]
37 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
3.5 Office OneNote
3.5.1 Overvie w
Microsoft Office OneNote uses all the common protocols covered in section 2, except for the data access protocols covered in section 2.4. When Office OneNote is synchronizing files with servers running SharePoint Products and Technologies, in addition to using either the [MS-WDV] protocol or [MS-FPSE] protocol as described in section 2.2 for the actual file transfer, OneNote also uses the following protocols. 3.5.2 Protocol List
Table 20 lists additional protocols Office OneNote uses when synchronizing files with servers running Windows SharePoint Services. Table 20: Additional protocols used by Office OneNote when synchronizing files with servers running Windows SharePoint Services Protocol Name Lists Web Service Protocol Specification Webs Web Service Protocol Specification Hypertext Transfer Protocol -- HTTP/1.1 Protocol Description and Usage Enumerates OneNote files in the document library folder, and efficiently enumerates changed files. Maps file path URLs to document libraries for subsequent calls to [MS- LISTSWS]. Sends OPTIONS requests to the server to identify the server version and supported protocols. Sends HEAD requests to files and folders to validate their existence, invoke authentication, and check file modified times. Document Short Name [MSLISTSWS] [MSWEBSS] [RFC2616]
3.6 Office Publisher
3.6.1 Overvie w
Microsoft Office Publisher uses all the common protocols covered in section 2 for each of the relevant features. It uses the data access protocols covered in section 2.4 via OLEDB or ODBC for features such as Mail Merge.
38 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Publisher does not use any additional Office Publisher–specific protocols.
3.7 Office InfoPath
3.7.1 Overvie w
Microsoft Office InfoPath uses the common protocols covered in section 2 for file authentication, file access for opening and saving forms, rights management, Error Reporting, CEIP, and Active Directory integration. Office InfoPath form files are used to store the data of an electronic form that has been completed by a user. These form files are rendered based on a form template (.xsn) file which defines the visualization and behavior of the form. Form files are defined in [MS-IPFFX]; form template (.xsn) files are defined in [MS-IPFF]. In addition InfoPath uses several other protocols when communicating with a forms server for publishing forms and data connections. These are covered in this section. 3.7.2 Protocol List
Table 21 lists additional protocols used by Office InfoPath when communicating with a forms server for publishing forms and data connections. Table 21: Additional protocols used by Office InfoPath when communicating with a forms server for publishing forms and data connections Protocol Name Active Directory Technical Specification Windows SharePoint Services Collaborative Application Protocol Specification Protocol Description and Usage The primary specification for Active Directory, including both AD DS and Active Directory Lightweight Directory Services (AD LDS). Enables a client to retrieve and manipulate various types of content on a server. Document Short Name [MS-ADTS]
[MS-WSSCAP]
39 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name Forms Services Design and Activation Web Service Protocol Specification Forms Services Feature Detection Protocol Specification Forms Services Proxy Web Service Protocol Specification InfoPath Data Connection File Download Protocol Specification InfoPath HWS Feature Protocol Specification Lists Web Service Protocol Specification
Protocol Description and Usage Allows InfoPath to request a list of problems that prevent InfoPath Forms Services from transforming a form template into a format that can be displayed in a Web browser. It also allows InfoPath to request that InfoPath Forms Services perform an actual transformation, if possible. Detects if InfoPath Forms Services is present and enabled on the server. InfoPath Forms Services is required to publish a browserenabled form te mplate.
Document Short Name [MS-FSDAP]
[MS-FSFDP]
Forwards SOAP messages.
[MS-FSPP]
Retrieves a Unive rsal Data Connection (.udc, .udcx) file.
[MS-INFODCF]
Enables interaction with the Human Workflow Services Web Service (HWS) on a server running Microsoft BizTalk Server. Manipulates the schema and contents of SharePoint lists.
[MS-IPHWS]
[MS-LISTSWS]
40 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name Site Data Web Service Protocol Specification
Protocol Description and Usage Specifies a set of server extensions used to augment a basic HTTP server so that it supports full and incremental indexing. Indexing, in this context, is defined as the process of exploring Web site content and building an index to use for search, systematic cataloging, content auditing, or similar purposes. Enables remote access to data on a server running SQL Server.
Document Short Name [MS-SITEDATS]
MS-Tabular Data Stream Protocol Specification Webs Web Service Protocol Specification Hypertext Transfer Protocol -HTTP/1.1 HTTP Over TLS Simple Object Access Protocol (SOAP) 1.1
[MS-TDS]
Provides methods for modifying sites in the site collection.
[MS-WEBSS]
Enables navigation to documents on the Internet.
[RFC2616]
Enables secure transmission of HTTP traffic. Makes remote procedure calls to a protocol server.
[RFC2818] [SOAP1.1]
41 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name UDDI Programmer's API 1.0 UDDI Version 2.04 API Specification
Protocol Description and Usage Enables discovery of Web services exposed by a remote server.
Document Short Name [UDDI 1.0] [UDDI 2.0]
3.7.3
Publis hing an InfoPath Form to a Server
For a user to be able to complete an InfoPath form, the form template must be published to a network server where the user can access it. Servers running Windows SharePoint Services often act as these servers. An InfoPath form template can be completed by users in one of two ways: in the Web browser or in InfoPath. If the form template is published as a Browser-enabled form template, users can fill it out in a Web browser by using InfoPath Forms Services or by using the InfoPath client application. If the form template is not published as a Browser-enabled form template, users can complete it only if they have the InfoPath client application installed. Some InfoPath features are not available for browser-enabled form templates. The following sections provide an overview of the primary ways an InfoPath form template can be published. 3.7.3.1 Publishing a form template which is not browser-enabled to the server Browser-enabled form templates do not support all available InfoPath features. Form designers who need to use features not supported in the Web browser will publish a form template without enabling it for Web browsers. As a result, users are required to use the InfoPath client application to complete it. List content types are used to publish a form template to a docume nt library on servers running Windows SharePoint Services. More information is available in [MS-WSSCCSP]. The following protocols are used in this scenario:
42 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[MS-FPSE] for getting Web site metadata, setting file properties, and performing file operations such as renaming [MS-WSSCAP] for document library operations [MS-WEBSS] for getting site URLs and column fields [MS-LISTSWS] to manage content types [MS-WDV] to upload the file
Updating a previously published form template uses the same set of protocols and a very similar process. 3.7.3.2 Publishing a browser-enabled form template to the server The process to publish a browser-enabled form template to the server is much the same as the process for publishing a form template that is not browser-enabled. In this scenario the same protocols are used as in section 3.7.3.1. In addition, the [MS-FSFDP] protocol is used to detect the presence of InfoPath Forms Services on the server and [MS-FSDAP] to check the design of and browser-enable the form template. Publishing a content type as a form template uses the same set of protocols and a very similar process. 3.7.3.3 Publishing an administrator-approved form template Designers can pass on the form template to a server administrator for deployment. This option is available only when a form template will be browser-enabled and is browser-compatible. The scenarios for publishing an administrator-approved form te mplate include allowing code to run in the form and to permit cross-domain data connections. Form te mplates with code or cross-domain data connections cannot be browser-enabled without administrator approval. In addition to protocols mentioned in previous scenarios, this scenario uses [MS-SITEDATS] to determine the location to publish the administrator-approved form template. For administrator-approved form templates, the purpose of the publish process is to save the form template to a location where the administrator can access it. The form template must then be activated by the server administrator. More information about publishing an administratorapproved form template can be found in [TECHNET-DEPADM]. 3.7.3.4 Verifying that a form template can be browser-enabled InfoPath provides a Design Checker feature that informs the form designer of any features currently in the form that will not work in InfoPath Forms Services and will prevent the form from opening in the Web browser.
43 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
To use the Design Checker feature, the form template compatibility setting must be InfoPath and InfoPath Forms Services. In this case, [MS-FSDAP] is used to communicate with the server to determine if there are any problems. 3.7.4 Data Connections
Microsoft Office InfoPath provides the capability to connect to data both locally and on remote computers. Data connections in Office InfoPath can be separated into two categories: query data connections and submit data connections. Query data connections perform a query against a data source such as a database or Web service, and return data to the form. Returned data can be displayed in one or more form vie ws, used to populate drop-down list box controls or to manipulate by using business logic. Submit data connections submit data from the form to a submit location. Submitted data can include individual values, a subset of the XML data in one of the form's data sources, or an entire data source from the form. Behavior of a data connection will vary depending on whether the data connection is the main data connection for the form template or a secondary data connection. The following sections describe details for each data connection type. A main data connection provides the XML for the main data source of the form, and may be updateable. A secondary data connection provides data for one or more secondary data sources in the form, and is read-only. Table 22 and table 23 list data connections by type, and indicates the versions of InfoPath that support each type. The Main Data Connection column indicates whether the specified type of data connection can be used as the main data connection of a form. These values are the same for all versions of InfoPath. Table 22: Query data connections Data Connection Type Web service Database InfoPath 2007 InfoPath 2007 Forms Services Yes Yes (read-only, SQL Server only) Yes Main Data Connection Yes Yes
Yes Yes
XML file
Yes
No
44 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Data Connection Type SharePoint list Human Workflow Services (HWS)
InfoPath 2007
InfoPath 2007 Forms Services Yes No
Main Data Connection No No
Yes Yes
Table 23: Submit data connections Data Connection Type Web service HTTP POST E- mail File submit Human Workflow Services (HWS) InfoPath 2007 InfoPath 2007 Forms Services Yes Yes Yes Yes No Main Data Connection Yes No No No No
Yes Yes Yes Yes Yes
The following sections describe each data connection type. The e- mail submit data connection uses Office Outlook to send e- mail, but uses no InfoPath–specific protocols. 3.7.4.1 Database query data connection When connecting to databases, Office InfoPath uses similar technology and protocols to those described in section 2.4. Specifically, when connecting to Microsoft SQL Server the [MS-TDS] protocol is used. InfoPath can only access Office Access file databases and remote databases that support the [MS-TDS] protocol, such as Microsoft SQL Server. To interoperate with database systems other than those running Office Access or Microsoft SQL Server: Use a SOAP Web service to connect to the database (recommended).
45 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Use Office Access as an intermediate data access layer. Use a database that implements [MS-TDS].
3.7.4.2 Web service query or Web service submit data connection Office InfoPath connects to Web services by using SOAP ([SOAP1.1]). 3.7.4.2.1 Discovering Web services by using UDDI The InfoPath designer can connect to a Universal Description, Discovery, and Integration (UDDI) server to discover available Web services by using [UDDI 1.0] or [UDDI 2.0]. 3.7.4.2.2 Retrieving and interpreting WSDL InfoPath requires a Web Services Description Language (WSDL) file (as described in [WSDL]) at design time to determine what WSDL operations are available on a Web service, and the SOAP message format that each WSDL operation expects. InfoPath can connect to only Web services that specify the "document" binding style and the "literal" use in the WSDL file. Web services using the "RPC" binding style or the "encoded" use are rejected. InfoPath depends on having a complete XSD schema in the WSDL for each SOAP message used by a given WSDL operation. This schema is expected to accurately reflect the format of the data that will be received when a user completes the form. 3.7.4.2.3 SOAP (Simple Object Access Protocol) protocol use when auser fills out a form When a user completes a form by using InfoPath in edit mode, or by using a Web browser connected to InfoPath Forms Services, and when the form contains one or more Web service data connections, InfoPath or InfoPath Forms Services communicates with the Web service by using SOAP messages, as specified in [SOAP1.1]. At form load-time, InfoPath constructs a SOAP message by using the XSD Schema information stored in the form template (.xsn) file for the Web service query data connection, and sends the SOAP message to the Web service specified as the load-time query. InfoPath receives a SOAP message in reply, and populates all or part of the form with the data returned in the SOAP message. When the user submits the form, InfoPath constructs a SOAP message by using the XSD Schema information stored in the form template (.xsn) file for the Web service submit data connection, and sends the SOAP message to the Web service specified as the submit action of the button.
46 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
3.7.4.2.4 Use of Web service proxy For form templates published to InfoPath Forms Services, the protocol client can use a Proxy to call the Web service using Authentication credentials other than those of the currently logged- in user. See [MS-FSPP] for details. Use of the Proxy requires that settings for the data connection are stored in a Universal Data Connection (.udc, .udcx) file, as specified in [MS-UDCX]. When a user completes a form, InfoPath retrieves the data connection settings from the Universal Data Connection (.udc, .udcx) file and forwards the SOAP message via the proxy by using [MSFSPP]. When a user fills out the form template by using a Web browser connected to InfoPath Forms Services, InfoPath Forms Services retrieves the Universal Data Connection (.udc, .udcx) file. The Forms Service Proxy Web service Protocol uses a Windows identity specified by the server administrator to call the Web service, and adds a SOAP header to the SOAP message that contains the logon identifier of the user, as specified in [MS-FSPP]. 3.7.4.3 HTTP POST submit data connection InfoPath can submit the main data source of a form as the body of a request by using the HTTP POST verb, as specified in [RFC2616], section 9.5. 3.7.4.4 SharePoint lists query data connection InfoPath can query a list for data by using the lists web service. A list can be used to supply supplemental data to a form, such as data to populate entries in a drop-down list box control, or data for use by business logic; however, it cannot be used as the main data source of a form. InfoPath uses [MS-WEBSS] to determine the lists available for the designer to choose from, and [MS-LISTSWS] to retrieve the list columns for the designer to use and to populate the form when a user is completing it. 3.7.4.5 XML file query data connection InfoPath can query an arbitrary URL for XML content. The supported protocol types are file, HTTP, Hype rtext Transfer Protocol over Secure Sockets Layer (HTTPS), and File Transfer Protocol (FTP). HTTP and HTTPS queries are performed by using the HTTP GET verb [RFC2616], section 9.3. InfoPath expects the response to be a well- formed XML document as specified in [XML], with a content type of text/xml ([RFC2616], section 14.17). XML data returned from the query can be used to supply supplemental data to a form, such as data to populate entries in a drop-down list box control, or data for use by business logic; however, it cannot be used as the main data source of a form.
47 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
3.7.4.6 File submit connection InfoPath can be configured to submit the entire form as a file to a directory on a server that supports either WebDAV (Web Distributed Authoring and Versioning Protocol) or [MSFPSE]. InfoPath attempts to first use [MS-FPSE] to save the file, and if that protocol is not supported by the server, WebDAV is used. 3.7.4.7 Universal Data Connection (.udc, .udcx) files When data connection settings are stored in an external Universal Data Connection (.udc, .udcx) file as specified in [MS-UDCX], InfoPath uses one of two approaches to retrieve the settings when a user completes the form. The approach chosen depends on whether the data connection is configured to use the Universal Data Connection (.udc, .udcx) file from a data connection library, or from a central store of Universal Data Connection (.udc, .udcx) files. This setting is stored in the element associated with the data connection in the form definition (.xsf) file. The approaches InfoPath can take are as follows: If a Universal Data Connection (.udc, .udcx) file is stored in a data connection library, InfoPath uses HTTP to retrieve the Universal Data Connection (.udc, .udcx) file from a location relative to the published location of the form template when a user fills out the form. If a Universal Data Connection (.udc, .udcx) file is stored in a central store, InfoPath uses the InfoPath Data Connection File Download ([MS-INFODCF]) protocol to retrieve the file when a user fills out the form.
When a user completes the form by using InfoPath Forms Services, InfoPath Forms Services retrieves any necessary Universal Data Connection (.udc, .udcx) files by using local APIs. 3.7.4.8 Human Workflow Services data connection Office InfoPath can connect to a Microsoft® BizTalk® Server server that is running the Human Workflow Services (HWS) service to query or update the status of a workflow associated with the document. InfoPath uses the Web service exposed on the HWS server ([MS-IPHWS]) to accomplish these tasks. InfoPath Forms Services does not support form templates that connect to Human Workflow Services. Human Workflow Services cannot be used as the main data source of a form.
48 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
3.8 Office Outlook
3.8.1 Overvie w
Microsoft Office Outlook uses all the common protocols covered in section 2, except for the data access protocols covered in section 2.4. In addition to these common protocols, Office Outlook 2007 uses specific protocols for setting up connections to lists on servers running Windows SharePoint Services and synchronizing data with those lists. Additionally, it uses a specific protocol to process alerts that it receives. Outlook also uses a set of protocols to communicate with servers running Microsoft Exchange Server. The interactions with servers running Microsoft Exchange Server are covered in a separate overview document, [MS-OXPROTO]. Outlook 2007 can establish local copies of SharePoint lists. If Outlook is installed on a client machine, an option to connect to Outlook is available on the Actions menu on the SharePoint list as viewed in the browser. When the user selects this command from the browser, an stssync URL is opened for which Outlook has registered itself as a handler with the operating system. The format of an stssync URL is defined by the [MS-STSSYN] protocol. The compact string format described in this protocol encodes the parameters relevant to a client that needs to connect to a list via the [MS-LISTSWS] protocol. When this string is received by Outlook 2007, the user is shown a confirmation dialog box before a local folder for the list is created and syncing is attempted. Client copies of the server data are obtained via the [MS-LISTSWS] protocol. After Outlook 2007 establishes this local copy of the list, any changes to the client or server copies of the items are transmitted by using the [MS-LISTSWS] protocol. The specifics of these interactions and how Outlook 2007 handles the list schema are described in the [MS-OUTSPS] protocol. A user of Office SharePoint Server 2007 can also configure the server to send alerts when a document, Web page, or other resource located on the server changes. These alerts are standard Inte rnet messages as defined in [RFC2822] which make use of X-header fields (private fields as defined in [RFC822]) to store additional information about the alert. Outlook 2007 uses the [MS-OSALER] protocol to parse this extra information, to display icons for messages of this type, and to catalog alert subscriptions. Outlook then uses the [MS-ALERTSS] protocol to allow users to manage these subscriptions. 3.8.2 Protocol List
Table 24 lists additional protocols used by Office Outlook. Table 24: Additional protocols used by Office Outlook
49 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
Protocol Name Lists Web Service Protocol Specification Lists Client Sync Protocol Specification
Protocol Description and Usage Transfers list items from the server to the client and from the client to the server. Determines the correct processing and logic to correctly host local copies of SharePoint list items in Outlook. Uses the [MSLISTSWS] protocol for the actual transfers. URL format that instantiates a connection between Outlook and a given SharePoint list. Extracts data from an alert sent from a server running Windows SharePoint Services to Outlook. Manages a user's alert subscriptions from within Outlook.
Communicates and stores information related to e-mail, calendars, contacts, voicemail, task tracking and other user collaboration functionality.
Document Short Name [MSLISTSWS] [MSOUTSPS]
StsSync Structure Specification Outlook and SharePoint Alerts Interop Protocol Specification Alerts Web Service Protocol Specification Office Exchange Protocols Overview
[MSSTSSYN] [MSOSALER]
[MSALERTSS] [MSOXPROTO]
3.9 Groove
An overview of Microsoft Office Groove is covered in a separate document, [MS-GRVPROT].
4
References
[CIFS] Leach, P. and Naik, D., "A Common Internet File System (CIFS/1.0) Protocol", March 1997, http://www.microsoft.com/about/legal/intellectualproperty/protocols/BSTD/CIFS/dr aftleach-cifs- v1-spec-02.txt. [MC-FPSEWM] Microsoft Corporation, "FrontPage Server Extensions: Web Site Management Protocol Specification", April 2008.
[MS-ADTS] Microsoft Corporation, "Active Directory Technical Specification", March 2008.
[MS-ALERTSS] Microsoft Corporation, "Alerts Service Protocol Specification", June 2008.
50 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[MS-CCEIP] Microsoft Corporation, "Corporate Customer Experience Improvement Program Client-to-Server Protocol Specification", June 2008. [MS-CER] Microsoft Corporation, "Corporate Error Reporting Version 1.0 Protocol Specification", March 2008. [MS-CER2] Microsoft Corporation, "Corporate Error Reporting Version 2.0 Protocol Specification", June 2008. [MS-COPYS] Microsoft Corporation, "Copy Web Service Protocol Specification", June 2008. [MSDN-CAB] Microsoft Corporation, "Microsoft Cabinet SDK", March 1997, http://msdn.microsoft.com/en- us/library/ms974336.aspx. [MSDN-ODBC] Microsoft Corporation, "Microsoft Open Database Connectivity (ODBC)", http://msdn.microsoft.com/en- us/library/ms710252.aspx. [MSDN-OLEDB] Microsoft Corporation, "Microsoft OLE DB", http://msdn.microsoft.com/enus/library/ms722784.aspx. [MSDN-WSS3CLIENTSIDEAPI] Microsoft Corporation, "Client-Side API Reference", http://msdn.microsoft.com/en- us/library/ms440037.aspx. [MS-DPSP] Microsoft Corporation, "Digest Protocol Extensions", March 2008. [MS-DWSS] Microsoft Corporation, "Document Workspace Web Service Protocol Specification", June 2008. [MS-ESURL] Microsoft Corporation, "Excel Services Publishing Protocol Specification", June 2008. [MS-FPSE] Microsoft Corporation, "FrontPage Server Extensions Remote Protocol Specification", June 2008. [MS-FSDAP] Microsoft Corporation, "Forms Services Design and Activation Web Service Protocol Specification", June 2008. [MS-FSFDP] Microsoft Corporation, "Forms Services Feature Detection Protocol Specification", June 2008.
51 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[MS-FSPP] Microsoft Corporation, "Forms Services Proxy Web Service Protocol Specification", June 2008. [MS-GLOS] Microsoft Corporation, "Windows Protocols Master Glossary", June 2008. [MS-GRVPROT] Microsoft Corporation, "Groove Protocols Overview", June 2008. [MS-INFODCF] Microsoft Corporation, "InfoPath Data Connection File Download Protocol Specification", June 2008. [MS-IPFF] Microsoft Corporation, "InfoPath Form Template Format Structure Specification", June 2008. [MS-IPFFX] Microsoft Corporation, "InfoPath Form File Format Specification", June 2008. [MS-IPHWS] Microsoft Corporation, "InfoPath HWS Feature Protocol Specification", June 2008. [MS-KILE] Microsoft Corporation, "Kerberos Protocol Extensions", March 2008. [MS-LISTSWS] Microsoft Corporation, "Lists Web Service Protocol Specification", June 2008. [MS-MERX] Microsoft Corporation, "Microsoft Error Reporting Extension to Corporate Error Reporting Version 1.0 Protocol Specification", June 2008. [MS-METAWEB] Microsoft Corporation, "MetaWeblog Extensions Protocol Specification", June 2008. [MS-NLMP] Microsoft Corporation, "NT LAN Manager (NTLM) Authentication Protocol Specification", March 2008. [MS-OFCGLOS] Microsoft Corporation, "Microsoft Office Client Master Glossary", June 2008. [MS-OFREF] Microsoft Corporation, "Microsoft Office Master Reference", June 2008. [MS-OSALER] Microsoft Corporation, "Alerts Interop Protocol Specification", June 2008. [MS-OUTSPS] Microsoft Corporation, "Lists Client Sync Protocol Specification", June 2008. [MS-OXPROTO] Microsoft Corporation, "Office Exchange Protocols Overview", June 2008.
52 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[MS-PASS] Microsoft Corporation, "Passport Server Side Include (SSI) Version 1.4 Protocol Specification", March 2008. [MS-RMPR] Microsoft Corporation, "Rights Management Services (RMS): Client-to-Server Protocol Specification", March 2008. [MS-SITEDATS] Microsoft Corporation, "Site Data Web Service Protocol Specification", June 2008. [MS-SLIDELI] Microsoft Corporation, "Slide Library Web Service Protocol Specification", June 2008. [MS-SMB] Microsoft Corporation, "Server Message Block (SMB) Protocol Specification", March 2008. [MS-SMB2] Microsoft Corporation, "Server Message Block (SMB) Version 2.0 Protocol Specification", March 2008. [MS-SPNG] Microsoft Corporation, "Simple and Protected Generic Security Service Application Program Interface Negotiation Mechanism (SPNEGO) Protocol Extensions ", March 2008. [MS-SSAS9] Microsoft Corporation, "SQL Server Analysis Services Protocol Specification", June 2008. [MS-STSSYN] Microsoft Corporation, "StsSync Structure Specification", June 2008. [MS-TDS] Microsoft Corporation, "MS-Tabular Data Stream Protocol Specification", March 2008. [MS-UDCX] Microsoft Corporation, "Universal Data Connection 2.0 XML File Structure Specification", June 2008. [MS-VERSS] Microsoft Corporation, "Versions Web Service Protocol Specification", June 2008. [MS-VIEWSS] Microsoft Corporation, "Views Web Service Protocol Specification", June 2008. [MS-WDV] Microsoft Corporation, "Web Distributed Authoring and Versioning (WebDAV) Protocol: Client Extensions", March 2008.
53 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[MS-WDVME] Microsoft Corporation, "Web Distributed Authoring and Versioning (WebDAV) Protocol: Microsoft Extensions", March 2008, Web Distributed Authoring and Versioning (WebDAV) Protocol: Microsoft Extensions. [MS-WDVMODUU] Microsoft Corporation, "Office Document Update Utility Extensions Protocol Specification", June 2008. [MS-WDVRV] Microsoft Corporation, "World Wide Distributed Authoring and Versioning (WebDAV) MS-Author-Via Protocol Specification", March 2008. [MS-WEBDAVE] Microsoft Corporation, "Web Distributed Authoring and Versioning Error Extensions Protocol Specification", June 2008. [MS-WEBSS] Microsoft Corporation, "Webs Web Service Protocol Specification", June 2008. [MS-WPPS] Microsoft Corporation, "Web Part Pages Web Service Protocol Specification", June 2008. [MS-WSSCAP] Microsoft Corporation, "Windows SharePoint Services Collaborative Application Protocol Specification", June 2008. [MS-WSSCCSP] Microsoft Corporation, "Windows SharePoint Services: Content Database Core List Schema and Site Provisioning Communications Protocol Specification", June 2008. [MS-WWSP] Microsoft Corporation, "Workflow Web Service Protocol Specification", June 2008. [ODMA 1.0] ODMA Interoperability Exchange, "Open Document Management 1.0 API", http://odma.info/. [RFC2068] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., and Berners-Lee, T., "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2068, January 1997, http://www.ietf.org/rfc/rfc2068.txt. [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and Jensen, D., "HTTP Extensions for Distributed Authoring∙WebDAV", RFC 2518, February 1999, http://www.ietf.org/rfc/rfc2518.txt. [RFC2616] Fielding, R., et al., "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999, http://www.ietf.org/rfc/rfc2616.txt.
54 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[RFC2617] Franks, J., Hallam- Baker, P., Hostetler, J., Lawrence, S., Leach, P., Luotonen, A., and Stewart, L., "HTTP Authentication: Basic and Digest Access Authentication", RFC 2617, June 1999, http://www.ietf.org/rfc/rfc2617.txt. [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000, http://www.ietf.org/rfc/rfc2818.txt. [RFC2822] Resnick, P., Ed., "Internet Message Format", RFC 2822, April 2001, http://www.ietf.org/rfc/rfc2822.txt. [RFC2831] Leach, P. and Newman, C., "Using Digest Authentication as a SASL Mechanism", RFC 2831, May 2000, http://www.ietf.org/rfc/rfc2831.txt. [RFC4287] Nottingham, M., Ed. and Sayre, R., Ed., "The Atom Syndication Format", RFC 4287, December 2005, http://www.ietf.org/rfc/rfc4287.txt. [RFC4559] Jaganathan, K., Zhu, L., and Brezak, J., "SPNEGO-based Kerberos and NTLM HTTP Authentication in Microsoft Windows", RFC 4559, June 2006, http://www.ietf.org/rfc/rfc4559.txt. [RFC5023] Gregorio, J., Ed. and de hOra, B., Ed., "The Atom Publishing Protocol", RFC 5023, October 2007, http://www.ietf.org/rfc/rfc5023.txt. [RFC822] Crocker, D.H., "Standard for ARPA Internet Text Messages", RFC 822, August 1982, http://www.ietf.org/rfc/rfc0822.txt. [RFC959] Postel, J. and Reynolds, J., "File Transfer Protocol (FTP)", RFC 959, October 1985, http://www.ietf.org/rfc/rfc959.txt. [SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., Layman, A., Mendelsohn, N., Nielsen, H. F., Thatte, S., and Winer, D., "Simple Object Access Protocol (SOAP) 1.1", May 2000, http://www.w3.org/TR/2000/NOTE-SOAP-20000508/. [TECHNET-DEPADM] Microsoft Corporation, "Deploy Administrator-Approved Form Templates (Office SharePoint Server)", http://technet.microsoft.com/enus/library/cc262921.aspx. [UDDI 1.0] UDDI.org, "UDDI Programmer's API 1.0", UDDI Published Specification, June 2002, http://www.uddi.org/pubs/ProgrammersAPI-V1.01-Published-20020628.pdf.
55 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
[UDDI 2.0] OASIS, "UDDI Version 2.04 API Specification", UDDI Committee Specification, July 2002, http://uddi.org/pubs/ProgrammersAPI-V2.04-Published-20020719.pdf. [MS-WDV] Microsoft Corporation, "Web Distributed Authoring and Versioning (WebDAV) Protocol: Client Extensions", March 2008. [WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description Language (WSDL) 1.1", W3C Note, March 2001, http://www.w3.org/TR/2001/NOTE-wsdl-20010315. [XML] World Wide Web Consortium, "Extensible Markup Language (XML) 1.0 (Fourth Edition)", W3C Recommendation, September 2006, http://www.w3.org/TR/REC-xml. [XRML] ContentGuard, Inc., "XrML... eXtensible rights Markup Language", 2005, http://www.xrml.org/XrML_12.asp.
5
Appendix A: Product Behavior
The information in this specification is applicable to the following Microsoft products and technologies: 2007 Microsoft® Office system Service Pack 1 (SP1)
Exceptions, if any, are noted below. Unless otherwise specified, any statement of optional behavior in this specification prescribed using the terms SHOULD or SHOULD NOT implies the aforementioned Microsoft products' behavior is in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term MAY implies these Microsoft products do not follow the prescription.
56 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008
6
Index
O Office Access, 36 Office Excel, 34 Office InfoPath, 39 Office OneNote, 38 Office Outlook, 49 Office PowerPoint, 35 Office Publisher, 38 Office Word, 33 P Product behavior, 56 Protocol list, 9 Protocol usage: application-specific, 33; common, 9 R References, 50 Rights management, 26
A Active Directory communications, 27 ActiveX controls, client-server integration, 31 Authentication, 9 C Customer Experience Improvement Program, 30 D Data access, 25 Document management, 18 F File access, 11 G Groove, 50 I Introduction, 5 M Microsoft error reporting, 28
57 of 57
[MS -OCPROTO] - v1.01 Office Client Protocols Overview Copyright © 2008 M icrosoft Corporation. Release: October 6, 2008