Tutorial: Extending the Recipes tool to support workspaces
Attention: This tutorial is currently under revision. The content might contain errors or inaccuracies. Subscribe to this page to be notified when an updated version is available.
This tutorial demonstrates how to add workspace support to the Recipes tool. This is the final tutorial in the series of Recipes tool tutorials.To complete the task, enable workspace support for the Project service module. This will prevent the same object from being edited by users in different task groups within the same workspace. Workspaces in the Management Center use BOD service modules. BOD service modules support workspaces by allowing you to customize what aspects of the physical and logical layers of a BOD service module are under change control. This change control data is passed back to the presentation layer where you can show it in the Management Center workspaces.
Learning objectives
After completing this tutorial, you should be able to:
- Enable workspace support for a service module
- Enable change control for a noun
- Include change control information in the response of a Get service
- Create a workspace with task groups and tasks by using workspace admin tool
Time required
This tutorial is expected to take 2 hours to complete.
Skill level
Advanced
Audience
This tutorial is intended for developers customizing the Management Center.
System requirements
Before you begin, ensure that you have:
- Installed WebSphere Commerce Developer version 7.
- Installed DB2 V9.5.1
- Enabled workspaces.
- Set the value of StagingEnable to true in the file, WC_EAR\xml\config\wc-server.xml. An example follows:
<Staging ContentMgmtEnable="false" DBName="" DBServerName="" DBServerPort="" DBUserID="" DBUserPwd="" DataSourceName="" DatabaseType="" NumWorkspaces="5" ReadPrefix="WCR" StagingEnable="true" WritePrefix="WCW" display="false"/>
- Verified that the WebSphere Commerce Developer installation is using a DB2 database.
- Downloaded and unzipped CreateWorkSpace.zip to a temporary location on the hard drive.
Prerequisites
This tutorial is the fifth tutorial in a series of five. Complete the following tutorials before proceeding with this one:
- Tutorial: Creating the Project BOD service module
- Tutorial: Adding a Recipes tool to the Management Center
- Optional: Tutorial: Supporting extended sites in the Recipes tool
You also need to create the following users:
User ID Organization Roles ConMgr Root Organization Workspace Manager ProMgrA Root Organization Recipe Manager, Product Manager, Workspace Content Contributor ProMgrB Root Organization Recipe Manager, Product Manager, Workspace Content Contributor ProMgrApp Root Organization Recipe Manager, Product Manager, Workspace Task Group Approver
To complete this tutorial, be familiar with the following terms and concepts:
- Web services
- XML
- WebSphere Commerce services
- Rational Application Developer
- Management Center framework
- Data service layer
- Business object mediator
- Content managed table
- Operational table
Lessons in this tutorial
- Enable workspace support for the service module
In this lesson, we will enable workspace support for the service module.
- Enable change control for the noun
You can enable change control for a noun by registering a change control mediator for the noun. No Java coding is required. The data service layer uses the registration information and the change control mediator to validate whether the object can be modified and to create locks when modifying the object. All change control uses a common change control mediator implementation, which is provided for you by default.
- Include change control information in the response of a Get service
The Get request access profile determines whether change control information is returned as part of the response. The InsertMoreData command registration point registers a generic implementation that uses the business object mediator to resolve and include change control information. The Recipes tool in the Management Center will use the change control information to show what objects are locked.
- Test the customization
In this lesson, we will test the customization by creating the new workspace, new task groups, and new tasks using the Workspace Administration Tool.