The IBM Retail Vendor template for WebSphere Portal provides portlets that let anonymous users submit requests to recover lost or forgotten passwords. However, to submit these requests, anonymous users require session IDs. If you do not enable session IDs for anonymous users, they might encounter problems when submitting password recovery requests.

1. Navigate to the following directory:
   • Microsoft Windows: wp_profile_root\PortalServer\config
   • Linux: wp_profile_root/PortalServer/config
2. Locate and open NavigatorService.properties with any text editor.
3. Specify true as the value for the public.session parameter. For example, public.session=true
4. Save and close NavigatorService.properties.

The installation script for the IBM Retail Vendor template for WebSphere Portal uses the IBM WebSphere Portal ConfigEngine. Before you run the installation script, ensure that the correct values are specified for the required ConfigEngine properties.

1. Navigate to the following directory: wp_profile_root\ConfigEngine\properties.
2. Locate and open wkplc.properties with any text editor.
3. Ensure the following properties conform to your environment settings:

   WasUserid

   Specify the user ID for IBM WebSphere Application Server.

   WasPassword

   Specify the password for WebSphere Application Server.

   PortalAdminId

   Specify an administrator user ID for the WebSphere Portal.

   PortalAdminPwd

   Specify the password for the WebSphere Portal administrator user ID.

   WasUserHome

   Specify the directory where WebSphere Application Server user data is created. For example, C:/IBM/WebSphere/wp_profile.

   WpsHostName

   Leave the default value for this property.

   CellName

   Specify the name of the WebSphere Application Server cell.

   NodeName

   Specify the name of the WebSphere Application Server node.

   ServerName

   Specify the name of the application server for WebSphere Portal.

4. Save and close wkplc.properties.

You must enable communication between IBM WebSphere Portal and IBM Lotus Sametime Proxy Server before you install the IBM Retail Vendor template for WebSphere Portal. Enabling communication between WebSphere Portal and Lotus Sametime Proxy Server involves editing the WebSphere Portal AJAX proxy configuration.

1. Navigate to the following directory: wp_profile_root\installedApps\node_name\AJAX Proxy Configuration.ear\wp.proxy.config.war\WEB-INF
   Clustered environments: Perform this task on the primary node only.
2. Locate and open proxy-config.xml with any text editor.
3. Locate the following element: <proxy:mapping contextpath="/common_proxy" url="*"/>.
4. Copy and paste the following XML beneath that element:

   <proxy:policy url="http://lotus_sametime_proxy_server_name:port_number/*" acf="none">
   <proxy:actions>
   <proxy:method>GET</proxy:method>
   <proxy:method>POST</proxy:method>
   <proxy:method>HEAD</proxy:method>
   </proxy:actions>
   </proxy:policy>

5. Edit the XML you pasted into the file to specify the server name and port number for Lotus Sametime Proxy Server.
6. Save and close proxy-config.xml.

The IBM Retail Vendor template for WebSphere Portal requires several attributes that do not exist in the default IBM WebSphere Portal user registry. To make these custom attributes available, you can either add the attributes to your LDAP directory or configure a property extension database (previously referred to as a lookaside database). Property extension databases store attributes that the LDAP directory does not or cannot store, but which you want to include in your portal user registry. When you configure a property extension database, you effectively extend the user registry to make new attributes available as part of your portal user profile. However, it is generally preferable to store all user attributes in the main user registry. You should configure a property extension database only if you cannot add new attributes to your LDAP directory. You can configure a property extension database for a stand-alone or clustered environment.

1. Add the following attributes to your user registry:
   • city
   • companyName
   • countryNames
   • companyPhone
   • products
   • userAddress
   • vendorNo
   Multiple value attributes: countryNames and products can contain multiple values. When you add these attributes to your property extension database, specify true as the value for the following parameter: la.multiValued.
2. Refer to the WebSphere Portal Information Center for instructions on configuring a property extension database.
   • Microsoft Windows: http://publib.boulder.ibm.com/infocenter/wpdoc/v6r1/topic/com.ibm.wp.ent.doc_v615/install/win_lookaside_db.html
   • Linux: http://publib.boulder.ibm.com/infocenter/wpdoc/v6r1/topic/com.ibm.wp.ent.doc_v615/install/linux_lookaside_db.html

For high availability, using remote databases is preferred. For improved performance, databases can be distributed across multiple database servers. If you plan to install the IBM Retail Vendor template for WebSphere Portal in a clustered environment, you must create remote databases then transfer your IBM WebSphere Portal databases from your file system to the remote databases, including the Java Content Repository (JCR) for IBM Lotus Web Content Management. Creating remote databases and transferring the databases ensures that the data for WebSphere Portal is available across your clustered environment. If you plan to install the Retail Vendor template in a stand-alone production environment, you might also want to create a remote database and transfer your WebSphere Portal databases to ensure high availability. If you plan to install the Retail Vendor template in a stand-alone environment for testing and evaluation purposes, you do not need to perform this task.

IBM Lotus Web Content Management uses a Java Content Repository (JCR) to store data. During the installation of the IBM Retail Vendor template for WebSphere Portal, the JCR might become corrupted if the installation is aborted. For this reason you should backup your JCR database before you install the Retail Vendor template. In the event that the JCR does become corrupted you can use the backup copy to restore your data.

1. Disable all syndicators.
2. Stop the WebSphere Portal server.
3. Navigate to the following directory: wp_profile_root\ConfigEngine\properties
4. Locate and open wkplc_comp.properties. with any text editor.
5. Locate the following property that contains the name of your JCR database: jcr.DbName
6. Follow the instructions provided in the documentation for your database to backup the JCR database.
7. Restart the WebSphere Portal server.
8. Re-enable all syndicators.

You can create the database for the sample checklist data on IBM DB2 Universal Database. You should create the database on DB2 if you plan to install the IBM Retail Vendor template for WebSphere Portal in a clustered environment or a stand-alone production environment.

1. Open the DB2 command window.
2. Enter and run the following command to create the database: db2 create DB TOOLBOX
   Important:

   • You must specify TOOLBOX as the name for the database.
   • If a database with the name TOOLBOX already exists, enter and run the following command to remove the database: db2 drop DB TOOLBOX

You can create the database for the sample checklist data on Derby. You should create the database on Derby if you plan to install the IBM Retail Vendor template for WebSphere Portal in a stand-alone environment for evaluation or demonstration purposes.

1. Open a command prompt and navigate to AppServer_root\derby\bin\embedded.
2. Run the following command to start a Derby SQL session: ij.bat
3. Run the following command to create the database: CONNECT 'jdbc:derby:TOOLBOX;create=true'; exit;
   Important:

   • You must specify TOOLBOX as the name for the database.
   • If a database with the name TOOLBOX already exists, enter and run the following command to remove the database: drop DB TOOLBOX

When you set your environment parameters in retail-template.properties, you specify the hostname and port number for the IBM Lotus Sametime servlet as the value for retail.chat.bot.hostname. In a clustered environment, the installation script does not automatically install the Lotus Sametime bot on this server. Instead, the installer adds the configured Enterprise Archive (EAR) file for the bot to the file system of the primary node. You must then manually install that EAR file to the server you specified for retail.chat.bot.hostname. You should install the bot on a separate system than the IBM Retail Vendor template for WebSphere Portal. For example, you can install the bot on the system where you installed the IBM Business Process Accelerator Framework.

1. Navigate to the following directory on the file system for your primary node: PortalServer_root/installableApps
2. Locate the following file: template.retail.botserviceEAR.ear.
3. Copy template.retail.botserviceEAR.ear to the file system of the server where you plan to install the Lotus Sametime bot.
4. Log in to the IBM WebSphere Application Server administration console on the server where you plan to install the Lotus Sametime bot.
5. Select Applications > Enterprise Applications.
6. Click Install.
7. Select Local file system and browse to template.retail.botserviceEAR.ear then click Next.
8. Leave the installation options in step 1 as default and click Next.
9. In the Map modules to servers section, select the module and server1 and click Apply then Next.
10. Review the summary of installation options and click Finish. A message informs you if the application was installed successfully.
11. Save the changes to the master configuration.

You must perform several tasks in IBM WebSphere Application Server Network Deployment. These tasks include restarting the server for the IBM Business Process Accelerator Framework, mapping applications to servers, and propagating the plugin configuration file for the Web server.

1. Log in to WebSphere Application Server Network Deployment.
2. Map the following applications to the required servers:
   • Retail_Enhanced_Theme
   • PA_WPF
   1. Select Applications > Enterprise Applications.
   2. Locate and click Retail_Enhanced_Theme.
   3. Select Modules > Manage Modules.
   4. Select the module and map to PortalCluster and webserver.
   5. Click Apply then OK.
   6. Save the changes to the master configuration.
   7. Select Applications > Enterprise Applications.
   8. Locate and click PA_WPF.
   9. Select Modules > Manage Modules.
   10. Select the module and map to PortalCluster and webserver.
   11. Click Apply then OK.
   12. Save the changes to the master configuration.
   13. Select Applications > Enterprise Applications.
   14. Locate and click lotusform.bpa.checklist.support.war to open the configuration window.
   15. Select Modules > Manage Modules.
   16. Select the module and map to PortalCluster and webserver.
   17. Click Apply then OK.
   18. Save the changes to the master configuration.
3. Map the BPAServer application to the required servers.
   Note: This step is required only if you have federated the Business Process Accelerator Framework server to the deployment manager. Otherwise, proceed to the next step.
   1. Select Applications > Enterprise Applications.
   2. Locate and click BPAServer.
   3. Select Modules > Manage Modules.
   4. Select the module and map to server1 and webserver. Where server1 corresponds to the server where the Business Process Accelerator Framework is installed.
   5. Click Apply then OK.
   6. Save the changes to the master configuration.
4. Generate and propagate the plugin configuration file for the Web server.
   1. Select Servers > Web servers.
   2. Click the webserver that corresponds to your HTTP server.
   3. Select the webserver and click Generate Plug-in.
   4. Select the webserver and click Propagate Plug-in. A message displays to inform you the propagation is complete for the Web server.

Ensure the Web modules for the IBM Retail Vendor template for WebSphere Portal are started.

1. Open the following URL and log in to IBM WebSphere Portal as an administrator:
   • Stand-alone environments: http://portal_hostname:port_number/wps/myportal
   • Clustered environments: http://webserver_hostname:port_number/wps/myportal
   Where /wps/myportal is the URL for registered users.
2. Select Administration > Portlet Management > Web Modules. The Manage Web Modules portlet displays.
3. Locate each of the following Web modules and ensure they are started:
   • ibm.integrations.portlets.form-3.5.1.3.war or ibm.integrations.portlets.form-3.5.1.35.war
     Note about file names: The name of the WAR can vary depending on your configuration.
   • Retail_Login.war
   • toolbox.retail.war
   • FeedServiceAdminPortlet.war
4. Select Activate on the row of any Web modules that are not started.

Removing the IBM Banking template for WebSphere Portal on Microsoft Windows involves specifying two properties then running a batch file from a command line window. The removal script automates the removal of the Retail Vendor template.

1. Navigate to the runtime folder in the temporary directory where you copied the installation files. For example, C:\temp\retail\runtime.
2. Locate and open uninstall-retail.bat with any text editor.
3. Specify values for the following properties:
   • set assemblyRoot: Specify the directory where you extracted retail.paa. For example, C:\temp\retail\runtime\retail.
   • set profilePath: Specify the WebSphere Portal profile directory. For example, C:\IBM\WebSphere\wp_profile.
4. Open a command line window.
   Removing in a clustered environment: If you are removing the Retail Vendor template in a clustered environment, run the batch file from the primary node.
5. Navigate to the runtime folder. For example, C:\temp\retail\runtime.
6. Enter and run the following command: uninstall-retail.bat > uninstall.log The batch file uninstalls the Retail Vendor template components. The results of the removal are recorded in uninstall.log, which is created in the same directory as uninstall-retail.bat. For example, C:\temp\retail\runtime.
7. Open Manual_Uninstall_Steps.txt to determine if you need to perform any manual removal steps. The removal script automates the various steps required to uninstall the Retail Vendor template. The removal script does not stop the removal process if any steps are not successful. For this reason, there might be one or more removal steps that you must perform manually. During the removal process, any steps that do not complete successfully are recorded in Manual_Uninstall_Steps.txt, along with instructions on performing the steps.
   1. Navigate to the PortalServer_root directory.
   2. Locate and open Manual_Uninstall_Steps.txt with any text editor. If the file is empty and does not contain any manual steps, the removal script successfully removed the Retail Vendor template. You do not need to take any action if the file is empty.
   3. Follow the instructions for any manual steps that display in the file. For more information on manually removing the Retail Vendor template, see Manually removing the Retail template.
   4. Close Manual_Uninstall_Steps.txt.
8. Delete the following folder from your file system: RetailTemplate.
   1. Navigate to the PortalServer_root directory.
   2. Locate and delete the following folder: RetailTemplate.

Removing the IBM Banking template for WebSphere Portal on Linux involves specifying two properties then running a shell script from a terminal window. The removal script automates the removal of the Retail Vendor template.

1. Ensure uninstall-retail.sh contains the correct UNIX end-of-line characters.
   1. Open a terminal and navigate to the directory where you copied the installation files. For example, /root/temp/retail/runtime
   2. Run the following command: dos2unix -b install-retail.sh
2. Ensure you have run permission on uninstall-retail.sh.
   1. Open a terminal and navigate to the directory where you copied the installation files. For example, /root/temp/retail/runtime
   2. Enter the following command to determine if you have run permission: ls -l
   3. If you do not have run permission, enter the following command: chmod 755 uninstall-retail.sh
3. Navigate to the runtime folder in the temporary directory where you copied the installation files. For example, /root/temp/retail/runtime.
4. Locate and open uninstall-retail.sh with any text editor.
5. Specify values for the following properties:
   • set assemblyRoot: Specify the directory where you extracted retail.paa. For example, /root/temp/retail/runtime/retail.
   • set profilePath: Specify the WebSphere Portal profile directory. For example, /IBM/WebSphere/wp_profile.
6. Open a terminal window.
   Removing in a clustered environment: If you are removing the Retail Vendor template in a clustered environment, run the script from the primary node.
7. Navigate to the runtime folder in the temporary directory where you copied the installation files. For example, /root/temp/retail/runtime
8. Enter and run the following command: ./uninstall-retail.sh > uninstall.log The script removes the Retail Vendor template components. The results of the removal are recorded in uninstall.log, which is created in the same directory as uninstall-retail.sh. For example, /root/temp/retail/runtime.
9. Open Manual_Uninstall_Steps.txt to determine if you need to perform any manual removal steps. The removal script automates the various steps required to uninstall the Retail Vendor template. The removal script does not stop the removal process if any steps are not successful. For this reason, there might be one or more removal steps that you must perform manually. During the removal process, any steps that do not complete successfully are recorded in Manual_Uninstall_Steps.txt, along with instructions on performing the steps.
   1. Navigate to the PortalServer_root directory.
   2. Locate and open Manual_Uninstall_Steps.txt with any text editor. If the file is empty and does not contain any manual steps, the removal script successfully removed the Retail Vendor template. You do not need to take any action if the file is empty.
   3. Follow the instructions for any manual steps that display in the file. For more information on manually removing the Retail Vendor template, see Manually removing the Retail template.
   4. Close Manual_Uninstall_Steps.txt.
10. Delete the following folder from your file system: RetailTemplate.
    1. Navigate to the PortalServer_root directory.
    2. Locate and delete the following folder: RetailTemplate.

If you encounter errors using the removal script, you can manually uninstall the IBM Retail Vendor template for WebSphere Portal. You might also choose to manually uninstall the Retail Vendor template to restore your environment in the event that the installation is not successful.

1. Delete the Retail Vendor template portal pages.
   1. Log in to IBM WebSphere Portal as an administrator.
   2. Select Administration > Portal User Interface > Manage Pages.
   3. In the Search field, enter retail and click Search.
   4. Locate and delete the following pages:

      Retail Administration

      Unique identifier: com.ibm.toolbox.template.retail.retailer.administration

      Retail

      Unique identifier: com.ibm.toolbox.template.retail.retail.stub

2. Delete the Web Archive (WAR) file for the Retail Vendor template.
   1. Log in to IBM WebSphere Portal as an administrator.
   2. Select Administration > Portlet Management > Web Modules.
   3. In the Search field, enter toolbox.retail.war and click Search.
   4. Delete toolbox.retail.war.
3. Delete the following from the file system for the portal server where you installed the Retail Vendor template:
   • PortalServer_root/installableApps/tmpRetailWar
     Note: This artefact might not be present on your file system.
   • PortalServer_root/installableApps/toolbox.retail.war
4. Delete the IBM Business Process Accelerator Checklist WAR file.
   1. Log in to the IBM WebSphere Application Server administration console.
   2. Select Applications > Enterprise Applications.
   3. Locate and select lotusform.bpa.checklist.support.war and click Stop if the application is running.
   4. Select lotusform.bpa.checklist.support.war and click Uninstall.
   5. Save the changes to the master configuration.
   6. Navigate to the following directory: wp_profile_root/installedApps.
   7. Locate and delete lotusform.bpa.checklist.support.war.
5. Remove the mail session object.
   1. Log in to the WebSphere Application Server administration console.
   2. Select Resources > Mail > Mail sessions.
   3. Select accelerators.forms Email Session Object and click Delete.
   4. Save the changes to the master configuration.
6. Delete the following Business Process Accelerator files and folders:
   • lotus_forms_root/bpa/extensions/config/Retail.properties
   • lotus_forms_root/bpa/extensions/workflow_checklist
   • lotus_forms_root/bpa/repositories/bpa/templates/1
   • lotus_forms_root/bpa/repositories/forms/retail
7. Remove the checklist Enterprise Java Bean (EJB).
   1. Log in to the WebSphere Application Server administration console.
   2. Select Applications > Enterprise Applications.
   3. Locate and select com.ibm.accelerators.checklistsEAR and click Stop if the application is running.
   4. Select com.ibm.accelerators.checklistsEAR and click Uninstall.
   5. Save the changes to the master configuration.
   6. Delete the following files:
      • PortalServer_root/installableApps/com.ibm.accelerators.checklistsEAR.ear
      • PortalServer_root/shared/app/com.ibm.accelerators.checklistsClient.jar
8. Remove the checklist container managed persistence connection factory.
   1. Log in to the WebSphere Application Server administration console.
   2. Select Resources > JDBC > Data sources > checklist.
   3. Clear the following field: Use this data source in container managed persistence (CMP).
   4. Click Apply then OK.
   5. Save the changes to the master configuration.
9. Remove the checklist J2C authentication alias.
   1. Log in to the WebSphere Application Server administration console.
   2. Select Resources > JDBC > Data sources > checklist > JAAS > J2C authentication data.
   3. Select checklistDb2Auth and click Delete.
   4. Save the changes to the master configuration.
10. Remove the checklist data source.
    1. Log in to the WebSphere Application Server administration console.
    2. Select Resources > JDBC > Data sources.
    3. Select checklist and click Delete.
    4. Save the changes to the master configuration.
11. Remove the checklist JDBC provider.
    1. Log in to the WebSphere Application Server administration console.
    2. Select Resources > JDBC > JDBC Providers.
    3. Locate and select vmmdbJDBC and click Delete.
    4. Save the changes to the master configuration.
12. Clear the value of the checklist database variable.
    1. Log in to the WebSphere Application Server administration console.
    2. Select Environment WebSphere Variables.
    3. Set the value of Scope to Node=node_name, Server=WebSphere_Portal.
    4. Click DB2UNIVERSAL_JDBC_DRIVER_PATH to open the configuration window.
    5. Clear the Value field and click Apply then OK.
    6. Save the changes to the master configuration.
13. Delete the TOOLBOX database from IBM DB2 Universal Database.
    1. Open the DB2 command window.
    2. Enter and run the following command: db2 drop DB TOOLBOX
14. Remove the theme and skins for the Retail Vendor template.
    1. Log in to WebSphere Portal as an administrator.
    2. Select Administration > Portal User Interface > Themes and Skins.
    3. From the list of available themes, select Retail Enhanced Theme and click Delete theme.
    4. From the list of available skins, select Retail - Thin Main Column and click Delete skin. Repeat this step to delete Retail - Thin Peripheral and Retail - Standard Skin.
15. Remove the theme EAR file.
    1. Log in to the WebSphere Application Server administration console.
    2. Select Applications Enterprise Applications.
    3. Locate and select Retail_Enhanced_Theme and click Stop if the application is running.
    4. Select Retail_Enhanced_Theme and click Uninstall.
    5. Save the changes to the master configuration.
    6. Delete the following file: PortalServer_root/installableApps/Retail_Enhanced_Theme.war
16. Remove the servlet for IBM Lotus Sametime.
    1. Log in to the WebSphere Application Server administration console.
    2. Select Applications Enterprise Applications.
    3. Locate and select Accelerators_Sametime_Bot and click Stop if the application is running.
    4. Select Accelerators_Sametime_Bot and click Uninstall.
    5. Save the changes to the master configuration.
    6. Delete the following file: PortalServer_root/installableApps/template.retail.botserviceEAR.ear
17. Remove the nodes for IBM Lotus Web Content Management.
    1. Log in to WebSphere Portal as an administrator.
    2. Select Applications > Content > Personalization > Business Rules.
    3. Select WCM and click Delete.
18. Delete the following Java Archive (JAR) file: PortalServer_root/pzn/prereq.pzn/collections/com.toolbox.content.templates.pzn.jar
19. Delete the Web content libraries and data for the Retail Vendor template.
    1. Log in to WebSphere Portal as an administrator.
    2. Select Administration > Portal Content > Web Content Libraries.
    3. Delete the Web content libraries in the following sequence:
       Important: You must delete these libraries in this sequence to avoid errors. Deleting libraries may take several minutes. Ensure that you successfully deleted a library before you delete the next library in the sequence.
       1. Retail_Content
       2. Retail_Resources
       3. TB_Top
       4. TB_Core
       5. TB_Shared
20. Delete the following folder: wp_profile_root/installedApps/node_name/WCM_EXTENSION.ear/wp.wcmextension.war/jsp/ctc
21. Delete the login WAR file for the Retail Vendor template.
    1. Log in to WebSphere Portal as an administrator.
    2. Select Administration > Portlet Management > Web Modules.
    3. Locate Retail_Login.war and click the Delete icon.
    4. Delete the following folder: PortalServer_root/installableApps/Retail_Login.war.
22. Remove the Retail Vendor template component registration.
    • On Microsoft Windows, run the following task from the wp_profile_root\ConfigEngine directory: ConfigEngine.bat -uninstall -assemblyList retail
    • On Linux, run the following task from the wp_profile_root/ConfigEngine directory: ./ConfigEngine.sh -uninstall -assemblyList retail
23. Log out of WebSphere Portal and the WebSphere Application Server administration console then stop WebSphere Portal.
24. Delete the following folders:
    • PortalServer_root/installableApps/tmpSTEar
    • PortalServer_root/RetailTemplate
    • wp_profile_root/installedApps/node_name/PA_WPF.ear
25. Start WebSphere Portal.

You must manually remove the TOOLBOX database on IBM DB2 Universal Database.

1. Open the DB2 command window.
2. Run the following command: db2 drop DB TOOLBOX
3. Exit the DB2 command window.

You must manually the TOOLBOX database on Derby.

1. Open a command prompt and navigate to AppServer_root\derby\bin\embedded.
2. Run the following command to start a Derby SQL session: ij.bat
3. Run the following command to remove the schema: DROP DB TOOLBOX; EXIT;

The alternative text and icons that display in the checklist user interface are specified in a properties file. You can open this properties file in IBM WebSphere Portlet Factory and specify custom alternative text and icons. Alternatively, you can create a custom properties file that contains the keys from the default properties file.

1. Open your checklist project in WebSphere Portlet Factory.
2. Navigate to the following directory: WebContent\WEB-INF\work\source\com\ibm\accelerators\builders\checklist\ui.
3. Locate and open ChecklistUI.properties.
4. Specify values for the following properties:
   Creating a custom properties file: If you create a custom properties file, you must include all the following keys in your properties file. When you create a custom properties file, specify the path to this file in the Resource Bundle Name field in the Checklist builder. The path must be relative to the following directory: wpf_project\WebContent\.

   doneButtonAltText

   Specify alternative text for the Done button.

   finishButtonAltText

   Specify alternative text for the Finish button.

   deleteButtonAltText

   Specify alternative text for the Delete button.

   learnMoreButtonAltText

   Specify alternative text for the Learn More button.

   proceedButtonAltText

   Specify alternative text for the Proceed button.

   checkUncheckButtonAltText

   Specify alternative text for the Check/Uncheck button.

   mainImageAltText

   Specify alternative text for the main checklist image.

   completedActivityAltText

   Specify alternative text for completed activities.

   requiredActivityAltText

   Specify alternative text for required activities.

   categoryViewExpandedIconAltText

   Specify alternative text for the expanded category view.

   categoryViewCollapsedIconAltText

   Specify alternative text for the collapsed category view.

   learnMoreIconFilePath

   Enter the path to the icon you want to use as the Learn More button. The path must be relative to the following directory: wpf_project\WebContent\.

   proceedIconFilePath

   Enter the path to the icon you want to use as the Proceed button. The path must be relative to the following directory: wpf_project\WebContent\.

   checkIconFilePath

   Enter the path to the icon you want to use as the Check/Uncheck button. The path must be relative to the following directory: wpf_project\WebContent\.

   requiredImageIconFilePath

   Enter the path to the icon you want to use to indicate required activities. The path must be relative to the following directory: wpf_project\WebContent\.

   spacerFilePath

   Enter the path to the icon you want to use as the blank space that displays before portal users complete activities. This icon displays in the Check/Uncheck column. The path must be relative to the following directory: wpf_project\WebContent\.

   checkmarkGreenImageFilePath

   Enter the path to the icon you want to use as the check mark that displays when portal users complete activities. This icon displays in the Check/Uncheck column. The path must be relative to the following directory: wpf_project\WebContent\.

   categoryViewExpandedIconFilePath

   Enter the path to the icon you want to use for expanded categories. The path must be relative to the following directory: wpf_project\WebContent\.

   categoryViewCollapsedIconFilePath

   Enter the path to the icon you want to use for collapsed categories. The path must be relative to the following directory: wpf_project\WebContent\.

   failedToSaveMessage

   Enter a message to display to users when the save operation is not successful.

   errorMessage

   Specify a prefix for error messages. The default value is Error.

5. Save and close ChecklistUI.properties.

When you use the Retail User Management portlet to register new vendor administrators, several operations take place to create users, groups and subgroups. These operations are carried out as a single transaction. You should configure the transaction if there are changes to the business groups or supplier subgroups, or if you add new supplier subgroups.

<Step>
   <ForwardStep>
      <Action>
         <Name>registerActions.addSupplierSubGroupToSupplierGroup</Name>
         <Parameters>
            <Parameter>_merchandising</Parameter>
         </Parameters>
      </Action>
   </ForwardStep>
   <RollbackStep>
      <Action>
         <Name>registerActions.removeSupplierSubGroupFromSupplierGroup</Name>
         <Parameters>
            <Parameter>_merchandising</Parameter>
         </Parameters>
      </Action>
   </RollbackStep>
</Step>

1. Open the location of the configuration files as appropriate.
   • If you have installed the Retail Vendor template and want to perform the configuration tasks at runtime, navigate to the following directory: wp_profile_root/installedApps/node_name/PA_WPF.ear/toolbox.retail.war
   • If you want to perform the configuration tasks before you install the Retail Vendor template, do the following:
     • Navigate to the directory where you extracted retail.paa. For example,
       • Microsoft Windows: C:\temp\retail\runtime\retail
       • Linux: /root/temp/retail/runtime/retail
     • Locate and open the following folder: retail.common.
     • Locate and extract retail.common.zip to a folder named retail.common.
     • Locate and extract toolbox.retail.war to a folder named toolbox.retail.
     Repackaging the archives: You must repackage any archives you extract before you install the Retail Vendor template.
2. Navigate to the following folder where the directory is relative to toolbox.retail.war: accelerators/config/retailAdmin
   
3. Locate and open registrationTransaction.xml with any text editor.
4. Specify new business groups or subgroups for the appropriate <Parameter> element if you have added or changed the business groups or subgroups. For example, if you added a new supplier subgroup named advertising, specify this subgroup in the <Parameter> element as follows:

   <Step>
      <ForwardStep>
         <Action>
            <Name>registerActions.addSupplierSubGroupToSupplierGroup</Name>
            <Parameters>
               <Parameter>_advertising</Parameter>
            </Parameters>
         </Action>
      </ForwardStep>
      <RollbackStep>
         <Action>
            <Name>registerActions.removeSupplierSubGroupFromSupplierGroup</Name>
            <Parameters>
               <Parameter>_advertising</Parameter>
            </Parameters>
         </Action>
      </RollbackStep>
   </Step>

   The <Name> element corresponds to Java methods. You can locate these methods in com.ibm.accelerators.retail.pkg. This PKG is located in the design_time folder of the installation files for the Retail Vendor template. To locate the Java methods, open com.ibm.accelerators.retail.pkg and navigate to the following file: Files/WEB-INF/work/source/com/ibm/accelerators/retail/admin/retailer/portlets/pages/IRegisterActions.java.

   The <Parameter> element is required for each parameter in the Java method, except for the WebAppAccess parameter. For example,

   • You must specify a group suffix in the <Parameter> element for this method: public String createSupplierSubGroup(WebAppAccess webAppAccess, String groupSuffix);
   • You do not have to specify a <Parameter> element for this method: public String createSupplierGroup(WebAppAccess webAppAccess);
5. Save and close registrationTransaction.xml.

The registration page in the Retail User Management portlet lets you create new users. The registration page contains several fields where you specify details to create users. You can add fields to the registration portlet page.

1. Open the location of the configuration files as appropriate.
   • If you have installed the Retail Vendor template and want to perform the configuration tasks at runtime, navigate to the following directory: wp_profile_root/installedApps/node_name/PA_WPF.ear/toolbox.retail.war
   • If you want to perform the configuration tasks before you install the Retail Vendor template, do the following:
     • Navigate to the directory where you extracted retail.paa. For example,
       • Microsoft Windows: C:\temp\retail\runtime\retail
       • Linux: /root/temp/retail/runtime/retail
     • Locate and open the following folder: retail.common.
     • Locate and extract retail.common.zip to a folder named retail.common.
     • Locate and extract toolbox.retail.war to a folder named toolbox.retail.
     Repackaging the archives: You must repackage any archives you extract before you install the Retail Vendor template.
2. Add new fields for the registration page as elements in registerData.xsd.
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: /accelerators/xml/schemas/retailAdmin
      
   2. Locate and open registerData.xsd with any text editor.
   3. Add new elements to the sequence of fields as in the following example:

      <xsd:element name="Register">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element maxOccurs="1" minOccurs="0" name="field_name1" type="xsd:string"/>
            <xsd:element maxOccurs="1" minOccurs="0" name="field_name2" type="xsd:string"/>
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>

   4. Save and close registerData.xsd.
3. Specify the new fields in registerDataDataDefinition.xml.
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: /accelerators/xml/dataDefinition/retailAdmin
      
   2. Locate and open registerDataDataDefinition.xml with any text editor.
   3. Add new data definitions as in the following example:

      <DataDefinition name="Register">
        <Required>true</Required>
        <Children>
          <DataDefinition name="field_name1">
            <Label>field_name1</Label>
            <Required>true</Required>
            <DataType>string</DataType>
          </DataDefinition>
          <DataDefinition name="field_name2">
            <Label>field_name2</Label>
            <Required>true</Required>
            <DataType>string</DataType>
          </DataDefinition>
        </Children>
      </DataDefinition>

   4. If required, specify any other validation expressions, formatting classes, and so on.
   5. Save and close registerDataDataDefinition.xml.
4. Create attribute mappings for the new fields.
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: /accelerators/config/retailAdmin
      
   2. Locate and open attributeMapping.properties with any text editor.
   3. Create properties for the new fields and specify the corresponding attributes from your user registry as follows:

      field_name1=attribute_name
      field_name2=attribute_name

   4. Save and close attributeMapping.properties.
5. Specify the new fields in optionalUserAttributes.properties.
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: /accelerators/config/retailAdmin
      
   2. Locate and open optionalUserAttributes.properties with any text editor.
   3. Enter the new fields beneath the #Optional user account attributes heading as follows:

      field_name1
      field_name2

   4. Save and close optionalUserAttributes.properties.

You can configure common user attributes so that when your site administrator creates a new vendor administrator, specific values are automatically added to the profiles for any new members that the vendor administrator creates. For example, you can configure the CompanyName parameter as a common user attribute so that the value that your site administrator specifies for this parameter is added to the vendor administrator and all subsequent members that the vendor administrator creates. You can configure common user attributes if you plan to use the personalization engine for IBM WebSphere Portal can to provide specific content for registered users.

1. Open the location of the configuration files as appropriate.
   • If you have installed the Retail Vendor template and want to perform the configuration tasks at runtime, navigate to the following directory: wp_profile_root/installedApps/node_name/PA_WPF.ear/toolbox.retail.war
   • If you want to perform the configuration tasks before you install the Retail Vendor template, do the following:
     • Navigate to the directory where you extracted retail.paa. For example,
       • Microsoft Windows: C:\temp\retail\runtime\retail
       • Linux: /root/temp/retail/runtime/retail
     • Locate and open the following folder: retail.common.
     • Locate and extract retail.common.zip to a folder named retail.common.
     • Locate and extract toolbox.retail.war to a folder named toolbox.retail.
     Repackaging the archives: You must repackage any archives you extract before you install the Retail Vendor template.
2. Navigate to the following folder where the directory is relative to toolbox.retail.war: accelerators/config/retailAdmin
   
3. Locate and open commonUserAttributes.properties with any text editor.
4. Add or remove the appropriate parameters. You can add only parameters that correspond to fields in the registration page of the Retail User Management portlet. To locate the available parameters, do the following:
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: /accelerators/xml/schemas/retailAdmin
   2. Locate and open registerData.xsd with any text editor.
   The available parameters are specified as follows:

   <xsd:element maxOccurs="1" minOccurs="0" name="parameter" type="xsd:string"/>

5. Save and close commonUserAttributes.properties.

By default, the Vendor User Management portlet displays a maximum of 10 users in the member list. You can modify the maximum number of users that display in the member list.

1. Open the location of the configuration files as appropriate.
   • If you have installed the Retail Vendor template and want to perform the configuration tasks at runtime, navigate to the following directory: wp_profile_root/installedApps/node_name/PA_WPF.ear/toolbox.retail.war
   • If you want to perform the configuration tasks before you install the Retail Vendor template, do the following:
     • Navigate to the directory where you extracted retail.paa. For example,
       • Microsoft Windows: C:\temp\retail\runtime\retail
       • Linux: /root/temp/retail/runtime/retail
     • Locate and open the following folder: retail.common.
     • Locate and extract retail.common.zip to a folder named retail.common.
     • Locate and extract toolbox.retail.war to a folder named toolbox.retail.
     Repackaging the archives: You must repackage any archives you extract before you install the Retail Vendor template.
2. Navigate to the following folder where the directory is relative to toolbox.retail.war: accelerators/config/supplierAdmin
   
3. Locate and open pagingConfig.properties with any text editor.
4. Specify the desired maximum number of users for the member list as the value for pagingSize. For example, pagingSize=20 displays a maximum of 20 users in the member list.
5. Save and close pagingConfig.properties.

When vendor administrators add new members, they select appropriate roles and countries for the new members. If new members belong to the merchandising role, vendor administrators also select specific products for these members. You can modify, add, and remove the roles, products, and countries that display in the Vendor User Management portlet.

1. Open the location of the configuration files as appropriate.
   • If you have installed the Retail Vendor template and want to perform the configuration tasks at runtime, navigate to the following directory: wp_profile_root/installedApps/node_name/PA_WPF.ear/toolbox.retail.war
   • If you want to perform the configuration tasks before you install the Retail Vendor template, do the following:
     • Navigate to the directory where you extracted retail.paa. For example,
       • Microsoft Windows: C:\temp\retail\runtime\retail
       • Linux: /root/temp/retail/runtime/retail
     • Locate and open the following folder: retail.common.
     • Locate and extract retail.common.zip to a folder named retail.common.
     • Locate and extract toolbox.retail.war to a folder named toolbox.retail.
     Repackaging the archives: You must repackage any archives you extract before you install the Retail Vendor template.
2. To configure the roles, do the following:
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: WEB-INF/work/classes/com/ibm/accelerators/retail/admin/supplier/portlets
      
   2. Locate and open RoleList.properties with any text editor.
   3. Modify, add, or remove the roles as desired.
      Remember: If you add new roles, you must also create a new role mapping.
   4. Save and close RoleList.properties.
3. To configure the products, do the following:
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: WEB-INF/work/classes/com/ibm/accelerators/retail/admin/supplier/portlets
      
   2. Locate and open ProductList.properties with any text editor.
   3. Modify, add, or remove the roles as desired.
   4. Save and close ProductList.properties.
4. To configure the countries, do the following:
   1. Navigate to the following folder where the directory is relative to toolbox.retail.war: WEB-INF/work/classes/com/ibm/accelerators/retail/admin/supplier/portlets
      
   2. Locate and open CountryList.properties with any text editor.
   3. Modify, add, or remove the roles as desired.
   4. Save and close CountryList.properties.

The roles that vendor administrators can select for new members are mapped to supplier subgroups. These subgroups are specified as parameters in RoleList.properties. You should configure role mappings, if you add new roles for the Vendor User Management portlet or if you have added or changed the supplier subgroups.

<role>
   <name>AccountsReceivable</name>
	 <group>finance</group>
</role>

1. Open the location of the configuration files as appropriate.
   • If you have installed the Retail Vendor template and want to perform the configuration tasks at runtime, navigate to the following directory: wp_profile_root/installedApps/node_name/PA_WPF.ear/toolbox.retail.war
   • If you want to perform the configuration tasks before you install the Retail Vendor template, do the following:
     • Navigate to the directory where you extracted retail.paa. For example,
       • Microsoft Windows: C:\temp\retail\runtime\retail
       • Linux: /root/temp/retail/runtime/retail
     • Locate and open the following folder: retail.common.
     • Locate and extract retail.common.zip to a folder named retail.common.
     • Locate and extract toolbox.retail.war to a folder named toolbox.retail.
     Repackaging the archives: You must repackage any archives you extract before you install the Retail Vendor template.
2. Navigate to the following folder where the directory is relative to toolbox.retail.war: accelerators/config/supplierAdmin
   
3. Locate and open roleMapping.xml with any text editor.
4. To add new roles, add the new <role> element with the appropriate values for the name and group.
   Remember: The value you specify for the role name must be defined as a parameter in RoleList.properties.
5. To update the subgroups that the roles map to, specify the suffix for the subgroup in the <group> element as appropriate.
6. Save and close roleMapping.xml.

The minimum software requirements for customizing the IBM Lotus Sametime bot are Eclipse IDE for Java Developers and WebSphere Application Server Community Edition. Alternatively, you can use IBM Rational® Application Developer and WebSphere Application Server. You must also download the IBM Lotus Sametime 8.5 SDK to obtain the required Java libraries.

1. Download and install Eclipse IDE for Java Developers at: http://www.eclipse.org/
2. Download and install WebSphere Application Server Community Edition at: http://www-01.ibm.com/software/webservers/appserv/community/
3. Download the IBM Lotus Sametime 8.5 SDK at: http://www.ibm.com/developerworks/lotus/downloads/toolkits.html

The IBM Lotus Sametime bot for the IBM Retail Vendor template for WebSphere Portal is deployed to IBM WebSphere Application Server as an Enterprise Archive (EAR) application.

1. Open Eclipse IDE for Java Developers. Ensure the Java EE perspective is selected.
2. Select File > New > Project > J2EE > Enterprise Application Project and click Next.
3. Specify a project name.
4. Select a target runtime as appropriate and click Next. If you are using WebSphere Application Server Community Edition, select IBM WASCE v2.1.
5. Leave the project facets as default and click Next.
6. Select Generate Deployment Descriptor and click Finish.

After you create the EAR application project, you create a dynamic Web project and add it to the EAR. You then import the source code for the IBM Lotus Sametime bot into the dynamic Web project to implement the interface for your custom selection strategy.

1. In the project for the EAR application, select File > New > Project > Web > Dynamic Web Project and click Next.
2. Specify a project name.
3. In the EAR Membership section, select Add project to an EAR and select the EAR application project you created for the Lotus Sametime bot.
4. Click Finish to create the dynamic Web project.
5. Import sametimeBotServlet.zip into the dynamic Web project.
   1. Right click the project and select Import > Import > General > Archive File and click Next.
   2. Browse to the location of sametimeBotServlet.zip and click Open. This archive is located in the design_time folder in the directory where you copied the contents of the product disc. For example, C:\temp\retail\design_time.
   3. Select Overwrite existing resources without warning and click Finish.
6. Modify the project build path to include the appropriate Java Runtime Environments (JRE).
   1. Right click the project and select Properties > Java Build Path > Libraries.
   2. Select JRE System Library [WebSphere v6.1 JRE] (unbound) and click Edit.
   3. Specify your local JRE and click Finish.
   4. Select Server Library [was.base.v61] (unbound) and click Edit.
   5. Select IBM WASCE v2.1 or other appropriate runtime and click Finish.
   6. Click OK to save and exit.
7. Copy the required libraries from the Lotus Sametime 8.5 SDK.
   1. Extract the archive that contains the Lotus Sametime 8.5 SDK.
   2. Locate and open the following directory: client/stjava/bin.
   3. Locate the following Java Archive (JAR) files:
      • CommRes.jar
      • STComm.jar
      • stjavatk.jar
   4. Copy the JAR files to the following folder in your dynamic Web project: project_name/WebContent/WEB-INF/lib.

A custom selection strategy is an implementation of the com.ibm.accelerators.chat.strategy.ISelectPolicy interface. This interface is available when you import the source code for the IBM Lotus Sametime bot into your dynamic Web project.

1. Create a new Java class that implements the com.ibm.accelerators.chat.strategy.ISelectPolicy interface.
2. Locate the following method in PolicyFactory.java: createDefaulPolicy().
3. Modify createDefaulPolicy() to return the object of the class you implemented.

Before you deploy your custom Lotus Sametime bot, you must specify several parameters to reflect your environment setup.

1. Navigate to the following directory in your dynamic Web project: project_name/WebContent/WEB-INF.
2. Locate and open web.xml with any text editor.
3. Specify values for the following parameters:

   SametimeCommunityHostname

   Specify the hostname where you installed the Lotus Sametime Community server. For example, server_name.ibm.com

   BotUsername

   Specify the user name for the bot.

   BotPassword

   Specify the password that corresponds to the user name.

   Timeout

   Specify a maximum number of seconds for the bot to resolve groups and users before timing out. For example, specify 60 for one minute, 120 for two minutes, and so on.

4. Save and close web.xml.