Create a view for a JSP page

In this lesson, you create a view and its corresponding JSP page. A view represents the data that is displayed in the storefront. In this tutorial, you register the view to a JSP page, when you type the view URL in a Web browser, the corresponding JSP page loads. In this lesson, the view you create is called MyNewView and the corresponding JSP page is called MyNewJSPTemplate.jsp.

Note: The file paths in this tutorial are specific to the Madison store and might be different for your storefront.

About this task

In this lesson, you learn how to perform the following tasks:

Place JSP pages and image files to apply to a specific store.
Use Rational Application Developer to create JSP pages.
Create property files to contain JSP page text.
Update the struts-config-ext.xml file to map views to corresponding JSP pages
Set up access controls for the new view.
Use the WebSphere Commerce development environment to test the new view.

Procedure

Map the new view to the new JSP page by inserting an entry into the struts-config-ext.xml file. Determine the unique identifier for your store before you insert the new entry into the struts-config-ext.xml file.
1. Start the test environment.
2. Navigate to the following URL in a web browser: http://localhost/webapp/wcs/admin/servlet/db.jsp.
3. In the input box, enter the following SQL statement:
```
select STOREENT_ID from STOREENT where IDENTIFIER = 'Madisons';
```
  Where Madisons is the name of your store. Make note of the STOREENT_ID value.
Add an entry for your view and JSP page to the struts-config-ext.xml file:
1. In the Enterprise Explorer view expand Stores > WebContent > WEB-INF.
2. Right-click the struts-config-ext.xml file; click Open With > Struts Configuration File Editor.
3. Set the mapping settings in the Action Mappings tab:
  1. In the Actions Mappings section, click Add. Rename the path value from the default /action1 to path value /MyNewView
  2. In the Action Mapping attributes section, enter com.ibm.commerce.struts.BaseAction in the Type field.
  The mapping settings in the Struts Configuration File Editor resemble the following:
4. Click the Global Forwards tab; click Add.
5. Change the default name from success to MyNewView/storeId for the view name.
  For example, change the default name to MyNewView/10001 where 10001 is your storeent_id.
6. In the Forward Attributes section, enter /MyNewJSPTemplate.jsp in the Path field.
7. In the Forward Mapping Extensions section, enter com.ibm.commerce.struts.ECActionForward in the Class Name field.
8. The Global Forwards tab of the Struts Configuration File Editor resembles the following:
9. Save your changes and leave the Struts Configuration File Editor open.
Update the struts configuration registry component. The registry component is used by the server to detect your changes to the struts configuration files:
1. Open the Administration Console and select Site on the Administration Console Site/Store Selection page.
2. Click Configuration > Registry. A list of registry components for the site opens.
3. Select the check box for the Struts Configuration registry component; click Update.
4. Click Refresh to reload the Registry window. After the update is complete, the status column reads Updated.
Create a properties file to store the translatable text for the JSP pages. If you use translatable text from the JSP page itself, the task of translation is much simpler and is also key to a globalized website.

You create a properties file for the locale en_US. You can create properties files for each locale you support. If you view the store that uses the locale fr_FR, you can also create a properties file for the fr_FR you use, containing text in French. You also create a default properties file, with no locale in the file name. If a customer uses a locale that does not have a corresponding properties file, the text from the default properties file displays.

When the WebSphere Commerce Developer builds the Stores project, it copies the new properties files to the Stores project in the Stores\WebContent\WEB-INF\classes\Madisons directory. The files are used as a resource bundle by your new JSP page. A resource bundle contains the text that displays in the JSP page through a Web browser and is retrieved from this file.

Note: The Tutorial_All_en_US.properties file is provided as the code source for the tutorial and copying is encouraged to reduce the effort of typing and minimize typing errors.
1. In the Enterprise Explorer view, navigate to Stores > Java Resources: src > Madisons.
2. Right-click the Tutorial_All_en_US.properties file; select Copy.
3. Right-click the Tutorial_All_en_US.properties file again; select Paste. In the Name Conflict window, type TutorialNLS_en_US.properties.
4. Right-click the TutorialNLS_en_US.properties file; select Copy.
5. Right-click the TutorialNLS_en_US.properties file again; select Paste. In the Name Conflictwindow, type TutorialNLS.properties.
6. Click OK.
Create the MyNewJSPTemplate JSP page for your new view, MyNewView:
Note: MyNewJSPTemplate_All.jsp is provided as a source code sample for the tutorial and copying is encouraged to reduce the effort of typing and minimize typing errors. When you create your JSP page, create a new blank JSP page and copy and paste appropriate sections from the MyNewJSPTemplate_All.jsp source code file.
1. In the Enterprise Explorer view, expand Stores > WebContent > Madisons.
2. Right-click Madisons; select New > File.
3. In the File name field, enter MyNewJSPTemplate.jsp.
4. Click Finish.
5. The MyNewJSPTemplate.jsp file opens. Click the Source tab.
6. Open the MyNewJSPTemplate_ALL.jsp file for editing.
7. In the MyNewJSPTemplate_ALL.jsp file, copy the text between <?xml version="1.0" and content="IBM Software Development Platform"/>.
8. In the MyNewJSPTemplate.jsp file, delete the default code and paste the copied text into the file.
9. Copy the preparation section from the MyNewJSPTemplate_ALL.jsp file into the MyNewJSPTemplate.jsp file. This preparation section sets the place holders for updates you make to the file.
  1. In the MyNewJSPTemplate_ALL.jsp file copy the text between the <%--PREPARATION SECTION and END OF PREPARATION SECTION --%> markers, but not the markers themselves.
  2. Paste the copied text to the end of your MyNewJSPTemplate.jsp file.
10. In the MyNewJSPTemplate_ALL.jsp file, copy sections 1A and 2.
11. Paste the copied text into your MyNewJSPTemplate.jsp file between the , , , and  markers.
  Section 1A includes the JSTLEnvironmentSetup.jspf file that sets up environment variables. Section 2 creates the resource bundle object that retrieves information from the properties file and sets the locale. TutorialNLS refers to the name of the properties file that you customized in the previous step. The .properties file extension for TutorialNLS.properties is not included because the Java Standard Tag Library (JSTL) syntax requires that the file extension is not included in the setBundle tag
12. In the MyNewJSPTemplate_ALL.jsp file, copy section 3.
13. Paste the copied text into your MyNewJSPTemplate.jsp file between the  and  markers. The code retrieves text that is created in your properties files.
Create and load access control policies for the view. You specify the command-level access control in this step. The command-level access control policy specifies that all users are allowed to execute the view. This type of access control policy might not be suitable in every circumstance. The access control policy is defined by the MyNewViewACPolicy.xml file.
1. Stop the WebSphere Commerce test server.
2. In a command prompt, navigate to the WCDE_installdir\bin directory.
3. Run the acpload command:
  - acpload MyNewViewACPolicy.xml
  - acpload db_name db_user db_password inputXMLFile schema_name where
    - db_name is the name of your development database.
    - db_user is the name of the database user.
    - db_password is the password for your database user.
    - inputXMLFile is the XML file that contains the access control policy specification. In this case, specify MyNewViewACPolicy.xml.
    - schema_name is:
      
      The database user who created the database and owns the schema
      
      The user who owns the tables
    The following text is an example of the command, with variables specified:
```
acpload dbname db2user db2userpassword MyNewViewACPolicy.xml DB2USER
```
4. Ensure that the policy files are successfully created:
  1. Navigate to the WCDE_installdir\logs directory. Inspect the acpload.log and messages.txtfiles to ensure that the access control policy loaded successfully. The messages.txt file might not exist if the load completed successfully.
  2. Navigate to the WCDE_installdir\xml\policies\xml directory. Ensure that the MyNewViewACPolicy_idres.xml and MyNewViewACPolicy_xmltrans.xml files were created. These files are created as part of a successful idresgen utility process.
Test your new view in the WebSphere Commerce development environment.
1. Start the WebSphere Commerce Test Server.
2. Expand Stores > WebContent > Madisons.
3. Right-click the index.jsp file; click Run As > Run on Server. The storefront page is displayed in the Web browser.
  
  Note: If prompted to select a server, select Choose an existing server and click Finish.
4. In the Web browser, enter the following URL: http://localhost/webapp/wcs/stores/servlet/MyNewView
  The new JSP page is displayed in the Web browser: