GrooveForms2.ReplaceDesign Operation
The ReplaceDesign operation replaces the design of a target Forms tool with the design from a source Forms tool. This operation is intended to facilitate the updating of Forms tools by making it easy to distribute the changes made in a design source tool to other Forms tools.
HTTP Post URL
The HTTP Post URL specifies the design source Forms tool that provides the updated design. 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
<TargetFormsToolURI />
| Element | Data type | Description |
|---|---|---|
TargetFormsToolURI |
|
Identifies the target Forms tool whose design is to be replaced. This URI can be obtained using the GrooveTools.Read operation in the ToolData element. |
Output Message Header
GrooveResponseHeader specifies the Response key.
Return Value
None.
Remarks
This operation is intended to make updating Forms tools easier. In some cases, a forms designer will make updates to a source template tool, and then use ReplaceDesign to propagate that design to other tools and spaces. This allows the designer to test the changes in a development instance of the tool before using the changed design in a production instance of the tool that contains important data.
Warning
Some modifications to a design can cause data loss. Consequently, it is important to test a new design in a nonproduction instance of the tool before updating the design on production tools that contain important data.
ReplaceDesign is used after a forms tool designer has updated the design source instance of the tool to distribute the changes to all other tools to be changed. The ReplaceDesign operation replaces the entire design of the tool, including views, scripts, form definitions and schema.
See the Groove Forms Tool online help for more information about replacing the design of a Forms tool.
Note
A ReplaceDesign operation can cause a significant amount of data to be communicated between the members of the workspaces. This operation is significantly less efficient than having a workspace member make minor design changes in each workspace using the Forms designer. When a Forms tool design is changed using the Forms designer, only the design changes need to be sent over the network. When the design is replaced by the ReplaceDesign operation or by a user selecting the Groove Replace Design menu item, the entire Forms tool design is sent over the network even if the new design has only minor changes.
The Design Source tool specified in the HTTP Post URL and the target tool specified in the FormsToolURI parameter must be the same kind of tool. Either both must be Groove Forms Tools Version 5 or both must be InfoPath Forms Tools Version 1. If different kinds of forms tools are specified, the ReplaceDesign operation returns an exception.
When calling this operation with InfoPath Forms Tools, the InfoPath template designs must be compatible. Specifically, the following condition must be met:
- For each InfoPath form in the current design, the new design must contain an InfoPath form with an identical URN, which is the InfoPath Form ID, and an InfoPath template version that is equal to or greater than the version in the current design.
See the ReadInfoPathTemplate operation for more information.
See Also
Reference
Concepts
Accessing Forms Tool Design Information
Replacing a Forms Tool Design