README

IBM® Gift Center for WebSphere® Commerce
Kiosk Channel Sample Application
For the Consumer direct sample store
AIX®, Linux™, Solaris Operating Environment, and Windows®

Professional and Enterprise
Version 7.0

Last updated: June 21, 2010
 

Important

Contents

What's in this README

This README contains information on how to install the kiosk channel of the IBM Gift Center for WebSphere Commerce for the Consumer direct starter store. This README is applicable to the following:

You can use the sample application on top of your existing version of the IBM Gift Center to take advantage of a richer multichannel gift registry solution. The sample is packaged as a series of three SAR files (the kiosk SAR being one of them) that work on top of the Consumer direct sample store. The instructions in this README teach you how to publish the kiosk channel SAR.

Note: To use the kiosk channel, you must first publish the SAR file for the Web or online gift registry channel. Refer to the README for IBM Gift Center Online or Web Channel Sample Application for details on how to publish the Web or online channel SAR.

For the kiosk gift registry channel, gift registrants can create and manage gift registries, while gift givers can search for and view a shopping list -- all from an in-store, touch-screen kiosk. In addition, kiosk peripherals, such as a scanner or printer also make this a self-serve solution for both gift registrants and gift givers.

To fully manage your kiosk system, you can separately purchase, install, and configure Netkey Creator for your kiosk. Netkey manages system interactions and responses to the kiosk environment and its peripherals. As a self-serve channel for gift registries, setting up registries or purchasing from them should be a user-friendly and efficient experience. Netkey contributes to this by reducing the complexity or confusion sometimes associated with system problems. For example, using Netkey the kiosk component of the IBM Gift Center sample application suppresses any browser pop-up windows, detects if a kiosk has not be used after a set time, and detects malfunctioning peripherals (such as a printer jam).

The sample application includes various features and functions in addition to the base IBM Gift Center solution. With this channel, registrants can create and manage their gift registries, and gift givers can search for gift lists, using an in-store kiosk. For details on this channel, refer to the IBM WebSphere Commerce 7.0 Information Center (expand Samples > Sample stores > Consumer direct sample store> IBM Gift Center for the Consumer direct sample store).

Path variables

This README file uses the following variables to represent directory paths:
ConsumerDirect_store_ID
The unique store ID (such as 10001) for the Consumer direct sample store. This ID is system generated, when you publish the store using the WebSphere Commerce Administration Console. To determine the Consumer direct store ID, run the following SQL statement:
 
select * from store
 
This SQL statement queries the STORE database table. Look for ConsumerDirect under the DIRECTORY column, and note the value for STORE_ID.
 
hostname
The host name of the machine where you installed WebSphere Commerce or WebSphere Commerce Developer.
 
instance_name
The name of the WebSphere Commerce instance. The default instance name is demo.
 
WAS_installdir
The installation directory for WebSphere Application Server. The default installation directory is as follows:
WCDE_installdir
The installation directory for the WebSphere Commerce Developer. The default installation directory is as follows:
WC_installdir
The installation directory for the WebSphere Commerce. The default installation directory is as follows:

Installation prerequisites

Ensure you have completed the following prerequisites on the same system where you will install the IBM Gift Center sample application:

  1. You have installed the following software:
  • If you are using WebSphere Commerce Developer:
    1. WebSphere Commerce Developer Enterprise or WebSphere Commerce Developer Professional Version 7.0 on the platform, Web server, database, and level of Rational Application Developer that is supported with WebSphere Commerce Developer Version 7.0.
    2. IBM Gift Center according to the instructions in Installing Gift Center.
  • You have published the WebSphere Commerce sample store (called Consumer direct), specifying non-ATP inventory, and you can successfully launch the Consumer direct sample store in a browser using
    http://hostname/webapp/wcs/stores/servlet/ConsumerDirect/index.jsp.

    Note: If you have already published the Consumer direct sample store with ATP inventory, you can update the database to change the store to non-ATP by setting the STORE.INVENTORYSYSTEM value to -2 for your store. To remove ATP from the store, run the following SQL statement:

    update store set inventorysystem =-2 where store_id=ConsumerDirect_store_ID
     
  • You have published the SAR file for the Web or online gift registry channel. To use the kiosk channel, you must first publish the Web or online gift registry SAR, according to the instructions in the README for IBM Gift Center Online or Web Channel Sample Application.

    • Installing the kiosk channel for IBM Gift Center for the Consumer direct starter store

    To install the kiosk channel:

    1. On the same machine where you have installed WebSphere Commerce or WebSphere Commerce Developer, create a sar directory as follows:
    2. From the same Web site where you obtained this README file, download and save the IBMGiftCenter_kiosk.zip file.
    3. Publish the GiftCenterKiosk.sar as follows:
       
      1. Open the WebSphere Commerce Administration Console at:

        https://hostname:8002/adminconsole

        Hint: If you cannot access the Administration Console, ensure that both your Web server and WebSphere Commerce application server (that is, your WC_instance_name), or WebSphere Commerce test environment server have started.
      2. Log on using your WebSphere Commerce administrator ID and password.
      3. From the Administration Console Site/Store Selection page, select the Site radio button and click OK. The Site Administration Console home page displays.
      4. From the menus at the top, select Store Archives > Publish. The Store Archives page displays listing the SAR files available for publishing.
      5. From the list, select the check box next to GiftCenterKiosk.sar and click Next.
      6. The Parameters page displays. From the Value list, select ConsumerDirect and click Next.
      7. The Summary page displays, listing the store archive and store selected, as well as the location to which the store archive will be published. After reviewing the summary information, click Finish.
      8. A confirmation dialog displays, telling you the number of the publishing job. Click OK. The Publish Job Status page displays. The publishing state is reflected in the Publish Status column.
      9. Click Refresh to update the status. Once publishing is complete, the Publish Status column displays Successful.
      10. (Optional) To see more details about this job, select GiftCenterKiosk.sar from the list. Click Details. The Publish Details page displays. Review the publishing details.
      11. Log out of WebSphere Commerce Administration Console by selecting the Logout link at the top left of the page.
         
    4. Set the event types for gift registries created using kiosk:
      1. Locate the eventType.xml file under the following directory:
        • WebSphere Commerce on AIX, Linux, Solaris Operating Environment, and Windows:
          WAS_installdir/profiles/instance_name/installedApps/WC_instance_name_cell/
          WC_instance_name.ear/Stores.war/ConsumerDirect/KioskArea/pageConfig
        • WebSphere Commerce Developer:
          WCDE_installdir\workspace\Stores\WebContent\ConsumerDirect\KioskArea\pageConfig
      2. Determine the event type IDs for each event type for your system by running the following SQL statement:

        select eventtype_id,eventtypename from grevnttype;

        This SQL statement queries the GREVNTTYPE database table. For each event type defined in the EVENTTYPENAME column, note the value for the corresponding EVENTTYPE_ID column.
      3. Edit the eventType.xml using a text editor. Replace the event type ID with those found using the SQL statement. For example, if your event type ID for weddings is 10003, then in the eventType.xml, replace:

        <param name="eventTypeId" value="3" />

        with

        <param name="eventTypeId" value="10003" />

      4. After you have specified all values for all event types, save the eventType.xml file.
         
    5. Restart your WebSphere Commerce application server (for example, server1), or your WebSphere Commerce test environment server.
       
    6. Associate the IBM Gift Center with your physical kiosk. The IBM Gift Center kiosk display pages are a set of JSPs that you can launch from a Web browser on your physical kiosk. You will also have a kiosk management application, such as Netkey Creator. Depending on what kiosk management application you are using, the steps to associate the IBM Gift Center kiosk pages with your physical kiosk will differ. The key step is to associate the host name of the machine where you enabled the IBM Gift Center and the kiosk sample application. After you associate the two, you can point your kiosk to the IBM Gift Center kiosk home page at:

      http://hostname/webapp/wcs/stores/servlet/ConsumerDirect/kiosk.jsp

    Verifying your installation

    To verify that you have successfully published the kiosk channel of the IBM Gift Center sample application and that it works successfully with IBM Gift Center, use the Consumer direct starter store to ensure that you can access gift registry features by accessing the store's Web site. If you can successfully view the pages, then your installation is successful. To verify your installation:

    1. Do one of the following:
    2. Create a birthday gift registry:
      1. From the kiosk home page, select Create a Registry.
      2. On the next page, select New Customer.
      3. The Specify Your Logon Information page displays. Since you have not registered with the Consumer direct sample store before, provide a registration logon ID and password here and select Submit. This is a one-time set up; the next time you access the Consumer direct sample store, you can log on as a returning registered customer.
      4. On the Select an Event page, select Birthday.
      5. Provide information for all remaining pages, selecting Submit to progress through each page.
      6. On the Set Up Your Gift Registry Access page, specify values in the Registry password and Verify password fields. This password will be used to access the gift registry.
      7. On the Review Your Registry Information pages, click Confirm on the first page, and then Create Registry, on the second page. If you have successfully installed the sample application, the system does the following:
        • Creates a birthday gift registry for the Consumer direct sample store.
        • E-mails a confirmation to the e-mail address used when creating the gift registry (if e-mail is set up on your WebSphere Commerce system. Refer to the IBM WebSphere Commerce 7.0 Information Center for details.)
        • Displays a congratulatory message with the gift registry ID.
      8. You can start adding items to this gift registry by selecting Quit from the congratulatory page, and the Update Registry List from the kiosk home page.

    Notices

    This information was developed for products and services offered in the U.S.A.

    IBM may not offer the products, services, or features discussed in this document in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

    Any reference to an IBM licensed program in this publication is not intended to state or imply that only IBM's licensed program may be used. Any functionally equivalent product, program, or service that does not infringe any of IBM's intellectual property rights may be used instead of the IBM product, program, or service. Evaluation and verification of operation in conjunction with other products, except those expressly designated by IBM, is the user's responsibility.

    IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to:

    IBM Director of Licensing
    IBM Corporation
    North Castle Drive
    Armonk, NY 10504-1785
    U.S.A.

    For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

    IBM World Trade Asia Corporation
    Licensing
    2-31 Roppongi 3-chome, Minato-ku
    Tokyo 106, Japan

    The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:

    INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

    This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

    Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

    IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

    Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

    IBM Canada Ltd.
    Office of the Lab Director
    8200 Warden Avenue
    Markham, Ontario
    L6G 1C7
    Canada

    Such information may be available, subject to appropriate terms and conditions, including in some cases payment of a fee.

    The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any equivalent agreement between us.

    Any performance data contained herein was determined in a controlled environment. Therefore, the results obtained in other operating environments may vary significantly. Some measurements may have been made on development-level systems and there is no guarantee that these measurements will be the same on generally available systems. Furthermore, some measurement may have been estimated through extrapolation. Actual results may vary. Users of this document should verify the applicable data for their specific environment.

    Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

    All statements regarding IBM's future direction or intent are subject to change or withdrawal without notice, and represent goals and objectives only.

    This information is for planning purposes only. The information herein is subject to change before the products described become available.

    This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

    Credit card images, trademarks and trade names provided in this product should be used only by merchants authorized by the credit card mark's owner to accept payment via that credit card.

    Trademarks and service marks

    The following terms are trademarks or registered trademarks of IBM Corporation in the United States and other countries or both:

    Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

    Linux is a trademark of Linus Torvalds in the United States, other countries, or both.

    Other company, product, or service names may be trademarks or service marks of others.

    **************************************************************************

** COPYRIGHT INTERNATIONAL BUSINESS MACHINES CORPORATION 2006

** ALL RIGHTS RESERVED.

**************************************************************************

    Note to US Government Users -- Documentation related to restricted rights -- Use, duplication, or disclosure is subject to restriction set forth in GSA ADP Schedule Contract with IBM Corp.

    End of README file