Documentation Additions



Verity Component Framework Developer Guide

The search and recipes source tutorial files provided with K2 present the completed tutorial at the end of each major step; for example, the files associated with mySearch1 already implement the tutorial as of the end of the step, the files associated with mySearch2 already implement the tutorial as of the end of next step, and so on.

If you want to work through the steps presented in the Verity Component Framework Developer Guide, follow the steps in the following sections to set up the tutorial to set up the files you need.

Setting up the Advanced Search Tutorial

To execute the steps specified in the “Advanced Search Tutorial” chapter of the Verity Component Framework Developer Guide, follow these steps:

1. Copy and paste the search/mySearch8 directory into the search directory and rename it to mySearch .

2. For each JSP file in the directory, change the call to the getInstance method from mySearch8 to mySearch .

3. In each JSP file, comment out all calls to the draw method; you will uncomment these methods as you perform the tutorial steps.

4. Using the Business Console, create a new application with the following parameters:

For Alias , enter mySearch .

For Location , enter installDir\appserver\webapps\search\mySearch , where installDir is the directory in which K2 is installed.

For Preview URL , enter http://localhost:9990/search/mySearch .

For Configuration name , enter mySearch .

You can then create and open the mySearch application and follow the tutorial steps.

Setting up the Taxonomy Browsing Tutorial

To execute the steps specified in the “Taxonomy Browsing Tutorial” chapter of the Verity Component Framework Developer Guide, follow these steps:

1. Copy and paste the recipes/myRecipes8 directory into the recipes directory and rename it to myRecipes .

2. For each JSP file in the directory, change the call to the getInstance method from myRecipes8 to myRecipes .

3. In each JSP file, comment out all calls to the draw method; you will uncomment these methods as you perform the tutorial steps.

4. Using the Business Console, create a new application with the following parameters:

For Alias , enter myRecipes .

For Location , enter installDir\appserver\webapps\recipes\myRecipes , where installDir is the directory in which K2 is installed.

For Preview URL , enter http://localhost:9990/recipes/myRecipes .

For Configuration name , enter myRecipes .

You can then create and open the myRecipes application and follow the tutorial steps.

Restarting a Tutorial After Skipping Steps

After setting up a tutorial, as described in the previous sections, you can skip major steps in these tutorials; however, you can only skip these steps in a forward direction. For example, you can complete the first major step, such as mySearch1 , skip mySearch2 and mySearch3 , and restart the tutorial at mySearch4 .

 

 
IMPORTANT   You must first set up the tutorial steps as described in the sections Setting up the Advanced Search Tutorial and Setting up the Taxonomy Browsing Tutorial.
 

 

1. Copy the configuration file from the step prior to the one you want to work on and overwrite either the mySearch.xml or myRecipes.xml files

For example, to start with the instructions for mySearch4 , copy config\mySeach3.xml to config\mySearch.xml .

2. Start, restart, or refresh the mySearch or myRecipes tutorial in the Business Console.

3. Search all JSP files in the mySearch or myRecipes directory and uncomment the draw methods for each component shown in the Business Console for the application.

You are now ready to resume the tutorial at the appropriate step; for example, if you copied config\mySeach3.xml to config\mySearch.xml , you are ready to start with the instructions for myStep4 .