Tool Complex Type

Applies to: SharePoint Workspace 2010 | Visual Studio 2008

The Tool type describes a specific instance of a tool.

Syntax

<Tool>
  <ID />
  <URI />
  <Name />
  <Unread />
  <Category />
  <Creator />
  <Owner />
  <Type />
  <ComponentResourceURL />
  <LocalURI />
  <MembersURI />
  <Data />
</Tool>

Complex Type Elements

Element	Data type	Description
ID	xs:string	The tool identification string. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
URI	xs:anyURI	URI that identifies the tool and can be used as the GrooveTools HTTP target URL in calls to Delete, UpdateUnreadMark, or to view the tool in calls to GrooveLocal.View. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Name	xs:string	The tool name. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value required by operation. Update operation: value required by operation. Events: value provided by events.
Unread	xs:long	The number of unread items in the tool. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Category	xs:string	The tool category. This element is reserved for future use. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Creator	xs:anyURI	The Groove identity of the Groove user who created the workspace or added this tool to it. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Owner	xs:anyURI	This element is reserved for future use. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Type	xs:string	A URN that identifies the type of the tool. Each URN is associated with a specific Groove Web Service that can be used to access tools of that type. See Remarks for more information about the Type URN. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
ComponentResourceURL	xs:anyURI	The Groove URL that identifies the tool template. This element is only used when adding a tool to a workspace with the Create operation. You can get the valid values for ComponentResourceURL from the Template type returned by the ReadAvailableTools operation. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value required by operation. Update operation: value ignored by operation. Events: value provided by events.
LocalURI	xs:anyURI	URI for the GrooveLocal.OpenToolProperties operation. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
MembersURI	xs:anyURI	URI for the GrooveMembers.EnterTool and GrooveMembers.ExitTool operations. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.
Data	xs:anyURI	The URI that provides the HTTP Post URL for the Web Service exposed by this tool. The usage of this element depends on the context: Read operation: value provided by operation. Create operation: value ignored by operation. Update operation: value ignored by operation. Events: value provided by events.

Remarks

In workspaces created with Groove 2007, tools have the following values for Type.

Type	Tools	Web service for tools
urn:groove.net:platform.tools.Forms2	Groove Forms	GrooveForms2
urn:groove.net:platform.tools.InfoPathForms	InfoPath Forms	GrooveForms2
urn:groove.net:platform.tools.Files	Files	GrooveFilesBase64
urn:groove.net:platform.tools.WSSFiles	SharePoint Files	GrooveFilesBase64
urn:groove.net:platform.tools.Calendar	Calendar	GrooveCalendar

See Also

Reference

GrooveTools Web Service

Concepts

Accessing Tools in a Workspace