Share via


GrooveFilesBase64.SetWSSProperties Operation

The SetWSSProperties operation provides the initial configuration for the SharePoint Files tool. This operation specifies the URL of the SharePoint document library and the identity of the synchronizer. Calling this operation only defines the initial configuration, and does not start the synchronization. To start the synchronization requires an action by a workspace member. This operation has no meaning if the tool is not a SharePoint Files tool.

HTTP Post URL

The HTTP Post URL targets the SharePoint Files tool. This URI is provided by the GrooveTools.Read operation in the ToolData element.

Input Message Header

GrooveRequestHeader specifies information common to all Groove Web Services., including the Groove Identity URL and the Groove Request key.

Input Message Parameters

<SetWSSProperties/> 
Element Data type Description

SetWSSProperties

WSSPropertiesDescriptor

Specifies the URL of the SharePoint document library and the Groove identity that is responsible for synchronizing the workspace with SharePoint.

Output Message Header

GrooveResponseHeader specifies the Response key.

Return Value

None.

Remarks

This operation is intended to provide the initial configuration after the SharePoint Files tool has been programmatically added to a workspace. The SetWSSProperties operation does not check the validity of the SharePoint document library URL or the Identity URL. Once the tool has been configured, it is not possible to change the configuration using web services.

The Groove identity responsible for synchronizing the workspace does not need to be a member of the workspace when SetWSSProperties operation is called, but since the identity needs to be a member to start synchronization with the SharePoint document library, you need to ensure that the identity is or becomes a member of the space.

If the tool targeted by the HTTP Post URL is not a SharePoint Files tool or is a SharePoint Files tool that has already been configured, this operation returns a SOAP exception.

When you call this operation, you must specify both the SharePoint document library URL and the synchronizer Identity URL.

See Also

Reference

GrooveFilesBase64 Web Service

Concepts

Operations on SharePoint Files