ICEfaces™ BEA Workshop Studio Integration Version 2.0.0

Contents

• Overview
• Requirements
• Installation
• Define ICEfaces home directory
• Create new project with ICEfaces capabilities
  
• Add ICEfaces capabilities to existing web project
• Create ICEfaces friendly JSP page with provided template
• Update existing ICEfaces project with new ICEfaces runtime libraries
  
• Uninstallation

Overview

ICEfaces BEA Workshop Studio Integration provides project level ICEfaces support for developers who use the BEA Workshop Studio for ICEfaces application development. This integration is built on top of BEA Workshop 3.3.

• add ICEfaces and its dependent libraries to the project
• configure web.xml and faces-config.xml for ICEfaces support
• provide ICEfaces friendly JSP page template
• upgrade existing ICEfaces project with new ICEfaces runtime libraries

Requirements

ICEfaces BEA Workshop Studio Integration v2.0.0 is built on BEA Workshop Studio v3.3. BEA Workshop Studio v3.2/3.3 is required. Check http://workshopstudio.bea.com/ for more detailed information.

Installation

1. Remove previous version of ICEfaces BEA Workshop Studio Integration before installing ICEfaces BEA Workshop Studio Integration v2.0.0. To remove previous version of ICEfaces  BEA Workshop Studio Integration, search for directory {Workshop_Home}/eclipse/plugins/,  {Workshop_Home}/WTP/eclipse/plugins/, and {Workshop_Home}/Workshop/eclipse/plugins/ or other linked directories to find directory name as com.icesoft.ide.beaworkshop_1.5.* and remove it.

2. Check if previous version of ICEfaces BEA Workshop Integration has been properly removed. Start up Workshop Studio and Click Help -> About BEA Workshop Studio -> Plug-in Details to check if the integration has been removed. If there is still a entry from ICEsoft Technologies Inc., you need to shut down Workshop Studio and remove installed previous version of ICEfaces Workshop Studio Integration as described in Step 1.
   
   
3. Download ICEfaces binary release bundle from ICEfaces.org.
4. Download ICEfaces BEA Workshop Integration v2.0.0 named as ICEfaces-BEA-WS-IDE-v2.0.0.zip from ICEfaces.org
5. Unzip ICEfaces-BEA-WS-IDE-v2.0.0.zip to a directory, for example ICEfaces-v2.0.0-BEAWorkshop
6. Click Help -> Software Updates -> Find and Install...  and select Search for new features to install to bring up Install dialog as shown.
   
   
7. Click New Local Site... button and select directory ICEfaces-BEA-WS-IDE-v2.0.0, which is created in Step 5. Click OK
8. Type in ICEface BEAWorkshop Update in Name text field of Edit Local Site dialog and click OK.
   
9. Check ICEfaces BEAWorkshop Update and click Finish.
   
   
10. In Updates dialog, Check ICEfaces BEAWorkshop Integration 2.0.0 and click Next>
    
    
11. Accept COMMUNITY LICENSE AGREEMENT in Feature License dialog and click Next>
12. Click Finish.  If there is no error message, the ICEfaces BEA Workshop Studio Integration has been properly installed.
13. Restart BEA Workshop Studio.

Define ICEfaces home directory

ICEfaces BEA Workshop Studio Integration does not bundle with ICEfaces runtime libraries. When you create a new project or update the existing ICEfaces project with new release of ICEfaces libraries, you will be asked to select where ICEfaces binary release bundle has been saved.  The place can aslo be defined using ICEfaces home directory preference dialog after ICEfaces BEA Workshop Studio Integration has been successfully installed.

Following instructions describe how to define home directory for ICEfaces binary release bundle using preference dialog.

1. Click Window -> Preferences...
2. Open Workshop Studio Facet Libraries, and click ICEFaces Libraries
3. Type in path to home directory for ICEfaces binary release bundle in ICEfaces Home Directory text field, or use Browser... button to select ICEfaces home directory.  Note that this directory should contain lib sub-directory and the lib directory should contains ICEfaces and dependent jar files as listed in the preference dialog.
4. If OK button is disabled, it means that the home directory does not contain all required ICEfaces and dependent jar files. Click OK button if OK button is enabled.

Create new project with ICEfaces capabilities

The following instructions describe how to use how to create a new project with ICEfaces capabilities.

1. From main menu bar, click  File -> New -> Project..., and from New Project wizard select Web -> Dynamic Web Project  and then click Next >
   
   
2. Enter a Project Name , click Next> .
   
3. Check the list of selected project facets in the project facets table as shown in following figure. Click Next> button and Next> button. Please note that version 2.0.0 for ICEfaces facet does not indicate the version number of ICEfaces runtime libraries.
   
4. In ICEfaces BEA Workshop wizard, type in path to home directory for ICEfaces binary release bundle in ICEfaces Home Directory text field, or use Browser... button to select ICEfaces home directory.  Note that this directory should contain lib sub-directory and the lib directory should contains ICEfaces and dependent jar files.
   
5. Click Finish to finish creating new ICEfaces project.
   

Add ICEfaces capabilities to existing web project

1. In AppXplorer or Project Explorer view,  right click on the project to which you want to add ICEfaces capabilities to.
2. click Properties.
   
3. Select Project Facets in Properties dialog  and click  Add/Remove Project Facets..
   
4. Following step 3 in previous section Create new project with ICEfaces capabilities

Create ICEfaces friendly JSP page with provided template

ICEfaces friendly JSP page templates are also provided in this integration to make ICEfaces page development easier.

The following instructions describe how to use the provided template.

1. Right click on WebContent folder in Package Explorer view and select following menu items New -> JSP
   
2. Type in jsp file name. If you want to create a page based on ICEfaces JSPX page template (.jspx) described in next step, file extension should .jspx.
3. Select New ICEfaces JSPX File or New ICEfaces JSP File.  Click Finish.

Update existing ICEfaces project with new ICEfaces runtime libraries

1. In Project Explorer or Package Explore view, select the ICEfaces project for which you want to update with new ICEfaces runtime libraries, and right-click to bring up its context menu.
   
2. Click Update ICEfaces Libraries... and change ICEfaces home directory, and click Finish
   

Uninstallation

1. Click Help -> Software Updates -> Manage Configuration, Product Configuration dialog shows up
2. Right-click ICEfaces BEA Workshop Integration 2.0.0 -> Uninstall (Do not click Disable)
3. Click OK in Uninstall dialog