MC docview

download MC docview

of 52

Transcript of MC docview

  • 8/8/2019 MC docview

    1/52

    IBM Software Group

    WebSphereSupport Technical Exchange

    WebSphere Commerce Management CenterArchitecture and Customization Scenarios

    Susan Flynn Solution Architect, ISSWNicolai Nielsen Solution Architect, ISSWPolina Gohshtein Solution Architect

  • 8/8/2019 MC docview

    2/52

    IBM Software Group

    WebSphereSupport Technical Exchange 2

    Session Agenda Introduction to IBMManagement Center for WebSphereCommerce

    Description of feature pack 3.0.1

    Overview of Management Center Architecture Management Center UI Technology

    Management Center Client

    Management Center Web Application

    Positioning of Management Center within Engagements

    Skill sets for customizations

    Customization complexity

    Customization of Management Center

    Customization scenarios

    Overview of how customizations are performed

    Discuss Best Practices related to customization

    Summary, References and Questions

  • 8/8/2019 MC docview

    3/52

    IBM Software Group

    WebSphereSupport Technical Exchange 3

    Description of Feature Pack 3.0.1 Feature Pack 3.0.1 is the latest WebSphere Commerce feature pack, available as of

    July, 2008

    The purpose of this feature pack is to build upon the previous functionality in FeaturePack 3.0.0 for the IBM Management Center for WebSphere Commerce, mainly forsupporting customizations of the Management Center.

    Feature Pack 3.0.1 can be downloaded by accessing the url:http://www-1.ibm.com/support/docview.wss?uid=swg24013534And selecting the Management Center download link and filling out a form. An e-

    mail notification will be sent to the requestor with instructions on downloading.

    Feature Pack 3.0.1 supersedes Feature Pack 3.0.0 and the former does not requirethe latter for installation.

    Refer to the InfoCenter for instructions on the required prerequisites, and installationand configuration:

    http://publib.boulder.ibm.com/infocenter/wchelp/v6r0m0/index.jsp?topic=/com.ibm.commerce.admin.doc/tasks/tigfepguiinstall.htm

  • 8/8/2019 MC docview

    4/52

    IBM Software Group

    WebSphereSupport Technical Exchange 4

    Architecture Management Center Client

    Flash application that runs in the browser

    Developed using the OpenLaszlo technology

    Management Center Web Application

    Simple Struts based Web application

    Part of the WebSphere Commerceapplication (EAR)

    A mediator between the Management Centerclient and component services (business logic)

    SOA/SOI Component Services

    Used by the Management Center to invokethe business logic

    WC EAR

    Management Center

    Web Application

    XML

    Response

    BODMessages

    BODMessages

    ComponentServices

    HTTP

    Request

    Browser

    Flash Player

    Management CenterClient (.swf)

  • 8/8/2019 MC docview

    5/52

    IBM Software Group

    WebSphereSupport Technical Exchange 5

    Management Center Client Technology OpenLaszlo v4.0 (www.openlaszlo.org) is an open source platform for

    creating the presentation layer of rich Internet applications

    OpenLaszlo applications are written in LZX, an object oriented,declarative language that uses XML tags to create/manipulate JavaScript objects

    The Management Center framework utilizes the library of rich UIcomponents (classes) provided by OpenLaszlo, and defines its own

    reusable components and libraries

    The Management Center OpenLaszlo application files (LZX) arecompiled into Flash (SWF)

    When the Management Center client is accessed via a URL, the SWF

    file is downloaded to the client side and is displayed by the Flash playerwithin the browser

  • 8/8/2019 MC docview

    6/52

    IBM Software Group

    WebSphereSupport Technical Exchange 6

    Management Center Client Management Center shell

    Includes all the aspects of the UI that are not tool-specific

    Includes the Management Center banner area,tools menu and status bar

    Handles user logon/logout

    Management Center tools

    Catalogs, Marketing, PromotionsEach tool is responsible for managing a set ofobjects

    Management Center foundation

    Contains all the common UI widgets and

    infrastructureManagement Center tools use or extend the baseclasses provided in the foundation

  • 8/8/2019 MC docview

    7/52

    IBM Software Group

    WebSphereSupport Technical Exchange 7

    Management Center Main Concepts Object

    Business artifacts that are managed by the Management Center tools

    There are Primary Objects (e.g. product), Child Objects (e.g. attribute) andReference Objects (e.g. merchandising association)

    Object Definition (wcfObjectDefinition)

    Base class that describes the characteristics of an object

    Defines child and reference objects

    Defines actions that can be performed on this object

    Business Object Editor (wcfBusinessObjectEditor)

    Base class that every Management Center tool must extend Wires the main pieces of a tool layout

    Manages all interactions done within the Management Center tool

  • 8/8/2019 MC docview

    8/52

    IBM Software Group

    WebSphereSupport Technical Exchange 8

    Management Center Building Blocks Menu

    File, Edit, View, and Help

    Toolbar

    A subset of the most commontasks you can perform

    Store List

    Select the store on which youwill work

    ToolbarMenu Store List

  • 8/8/2019 MC docview

    9/52

    IBM Software Group

    WebSphereSupport Technical Exchange 9

    Management Center Building Blocks Explorer View

    Allows you to navigate throughthe objects

    Utilities View

    A clipboard

    Allows you to locate and useobjects that you want to use

    without navigating away from thecurrent view

    Find Area

    Allows you to search for objectsof a given type

    The search is performed basedon a search definition for theobject Utilities ViewExplorer View

    Find Area

  • 8/8/2019 MC docview

    10/52

    IBM Software Group

    WebSphereSupport Technical Exchange 10

    Management Center Building Blocks Main Work Area

    A placeholder for detailedviews of objects

    List View

    Used to define how a list ofcertain objects should bedisplayed

    For example, a list view maydefine that a list of catalog

    entries will be displayed in a gridwith columns for the code,description, thumbnail, etc

    Properties View

    Used to define the wayproperties/children of a given

    object are displayed

    Properties View

    List View

    Main Work Area

  • 8/8/2019 MC docview

    11/52

    IBM Software Group

    WebSphereSupport Technical Exchange 11

    Management Center UI Services How does the Management Center client communicate with the WebSphere Commerce

    component services?

    The Management Center client has a Service class (wcfService) that:

    Builds a URL with all of the specified parameters

    Sends the URL request

    Parses the response (XML)

    The Management Center foundation provides a number of Service classes for you suchas: create, update, delete, search

    When developing the UI, one would define the type of service they want to be called whena given action is performed by a business user

    The URL that the Management Center UI Service calls is handled by the ManagementCenter Web Application

  • 8/8/2019 MC docview

    12/52

    IBM Software Group

    WebSphereSupport Technical Exchange 12

    Management Center Web Application A simple Struts Web application that acts as a

    mediator between the Management Center

    client and the WebSphere Commercecomponent services

    Converts URL requests into BOD messages

    (Management Center client WebSphere

    Commerce component services)

    Converts BOD messages into XML responses

    (WebSphere Commerce component services Management Center client)

    WC EAR

    Management Center

    Web Application

    Browser

    Flash Player

    Management Center Client (.swf)

    XML Response

    BOD Messages

    Component Services

    HTTP Request

    Servlet Filter

    Client Library

    BOD Messages

    Struts Actions JSPs

  • 8/8/2019 MC docview

    13/52

    IBM Software Group

    WebSphereSupport Technical Exchange 13

    Management Center Web Application Servlet Filter

    Resolves the authentication information

    Sets the user session (activity token) Client Library

    Handles communication with the componentservices

    Allows the client to easily switch between Webservices and local Java calls depending on thedeployment

    Management Center supports local only

    Different types of Struts Actions and JSPsdepending on the type of the request:

    Get request

    Create/Update/Delete request

    WC EAR

    Management Center

    Web Application

    Browser

    Flash Player

    Management Center Client (.swf)

    XML Response

    BOD Messages

    Component Services

    HTTP Request

    Servlet Filter

    Client Library

    BOD Messages

    Struts Actions JSPs

  • 8/8/2019 MC docview

    14/52

    IBM Software Group

    WebSphereSupport Technical Exchange 14

    Browser

    Flash Player

    Flow of a Get request1. Request enters the Servlet Filter to resolve the

    authentication information2. Struts action forward is executed3. Request is forwarded to the Get Controller JSP

    (per Struts configuration)4. The Controller JSP uses the get-data tag to

    invoke the appropriate Get service5. The get-data tag uses the Client Library to make

    the service request6. The service returns a BOD with the list of Nouns

    (objects)7. The Get Controller JSP invokes the Serialization

    JSP8. The Serialization JSP formats the BOD into an

    XML format that is returned to the ManagementCenter Client

    WC EAR

    Management Center Client (.swf)

    Management Center

    Web Application

    XML Response

    BOD Messages

    Component Services

    HTTP Request

    Servlet Filter

    Client Library

    Serialization JSP

    BOD Messages

    1

    2

    3

    4

    5 6

    7

    8

    Struts Action Response JSP

  • 8/8/2019 MC docview

    15/52

    IBM Software Group

    WebSphereSupport Technical Exchange 15

    WC EAR

    Management Center

    Web Application

    Flow of a Create/Update/Delete request1. Request enters the Servlet Filter to resolve the

    authentication information2. A BusinessObjectDocument Struts Action is

    executed3. The Struts Action builds the change/process

    BOD request based on the given URLparameters

    4. The Client Library is used to issue the BOD

    request5. The service returns a BOD response

    6. The Struts Action parses the BOD response andforwards it to a Struts forward (success, failure,error)

    7. The response JSP formats the data into an XML

    response and returns it to the ManagementCenter client

    Browser

    Flash Player

    Management Center Client (.swf)

    XML Response

    BOD Messages

    Component Services

    HTTP Request

    Servlet Filter

    Client Library

    Struts Action Response JSP

    BOD Messages

    1

    2

    3

    4 5

    6

    7

  • 8/8/2019 MC docview

    16/52

    IBM Software Group

    WebSphereSupport Technical Exchange 16

    Session Agenda Introduction to IBM Management Center for WebSphere Commerce

    Description of feature pack 3.0.1

    Overview of Management Center Architecture Management Center UI Technology

    Management Center Client

    Management Center Web Application

    Positioning of Management Center within Engagements

    Skill sets for customizations

    Customization complexity

    Customization of Management Center

    Customization scenarios

    Overview of how customizations are performed

    Discuss Best Practices related to customization

    Summary, References and Questions

  • 8/8/2019 MC docview

    17/52

    IBM Software Group

    WebSphereSupport Technical Exchange 17

    Required Skill Set for Customizations Client-side:

    OpenLaszlo

    XML

    Javascript

    Understanding object oriented concepts

    Note: No Flash development skills necessary

    Server-side:

    Struts action configuration

    JSP, JSTLCommerce Services (SOA & SOI)

    Commerce Command Framework

  • 8/8/2019 MC docview

    18/52

    IBM Software Group

    WebSphereSupport Technical Exchange 18

    Suggested Learning Resources openlaszlo.org

    OpenLaszlo online reference

    OpenLaszlo developer guide

    OpenLaszlo tutorials

    Klein, Carlson and MacEwen: Laszlo In Action

    Redbook SG24-7619-00: WebSphere Commerce LOB ToolingCustomization (Scheduled for August 2008)

    InfoCenter topics on Management Center

  • 8/8/2019 MC docview

    19/52

    IBM Software Group

    WebSphereSupport Technical Exchange 19

    Customization Complexity

    Various levels of complexity:

    Simple CustomizationsMedium Complexity Customizations

    High Complexity Customizations

    Out of category

    Features overlapping with future feature packs

  • 8/8/2019 MC docview

    20/52

    IBM Software Group

    WebSphereSupport Technical Exchange 20

    Simple customization scenarios Simple customizations:

    Changing labels

    Rearranging content in properties view

    Hiding fields from properties view or a list view

    Adding fields in properties view

    Adding columns in list view

    Modifying client-side input validation

    Involvement from ISSW is not required, but encouraged forthe first engagement

  • 8/8/2019 MC docview

    21/52

    IBM Software Group

    WebSphereSupport Technical Exchange 21

    Complex customization scenarios Medium complexity customizations:

    Integration with third party applications, e.g. content

    management

    High complexity customizations:

    Creating new components

    Create new tools

    Customizations overlapping with future features

    Involvement with ISSW is strongly encouraged for all of thesescenarios, especially for the first project

  • 8/8/2019 MC docview

    22/52

    IBM Software Group

    WebSphereSupport Technical Exchange 22

    Session Agenda Introduction to IBM Management Center for WebSphere Commerce

    Description of feature pack 3.0.1

    Overview of Management Center Architecture Management Center UI Technology

    Management Center Client

    Management Center Web Application

    Positioning of Management Center within Engagements

    Skill sets for customizations

    Customization complexity

    Customization of Management Center

    Customization scenarios

    Overview of how customizations are performed

    Discuss Best Practices related to customization

    Summary, References and Questions

  • 8/8/2019 MC docview

    23/52

    IBM Software Group

    WebSphereSupport Technical Exchange 23

    How Customizations are PerformedThis section will cover the concepts on how to perform customizations to the Management

    Center.

    Customizations can be performed for both the Management Center client and the Management

    Center Web Application.

    Organization of LOBTools Project in WC Developer Toolkit

    Restricted Files

    Development Assets and Folder Locations

    Business Object Editor and User Interface Components

    Extending the Resource Bundle for Multi-Language Support

    Creating the extended resource bundle

    Including reference to the resource bundle

    Description and location of mediator, tools and configuration files

    This section will use the Warranty scenario as an example for how to perform some of the customizations. This scenario is alsodocumented as a tutorial in the WebSphere Commerce InfoCenter.

  • 8/8/2019 MC docview

    24/52

    IBM Software Group

    WebSphereSupport Technical Exchange 24

    Organization of LOBTools Project in WCDeveloper Toolkit Management Center files include:

    OpenLaszlo source files, images,

    HTML pages, properties files, Strutsaction classes, JSP files, config filesand the ManagementCenter.swf file.

    The OpenLaszlo files are compiled

    by the OpenLaszlo compiler into theManagementCenter.swf Flash file.

    This runs within the clients browser.

    Other files are part of the

    Management Center web applicationthat runs on the server.

  • 8/8/2019 MC docview

    25/52

    IBM Software Group

    WebSphereSupport Technical Exchange 25

    Open Laszlo Restricted FilesOpenLaszlo files that are locatedin the restricted folders shouldnot be modified.

    Files under the restricteddirectories contain classdefinitions for the basicfunctionality that is common to alltools within the ManagementCenter.

    Files within the restricted

    directories will be replaced whenyou install WebSphere Commercefixes, or migrate to the nextrelease.

  • 8/8/2019 MC docview

    26/52

    IBM Software Group

    WebSphereSupport Technical Exchange 26

    User Interface Widgets

    Calendar view

    List view

    Rich Text Editor

    Date Editor

    Time Editor

    Group / Disclosure controlValue Selector

    Check box Combo box Date and Time Editor

    List view Calendar view Text Editor Rich Text Editor Tab Group (Disclosure Control) Value Selector

  • 8/8/2019 MC docview

    27/52

    IBM Software Group

    WebSphereSupport Technical Exchange 27

    Business Object Editor Each tool within the Management Center contains a Business Object

    Editor, which allows a business user to create and maintain Management

    Center objects.

    The wcfBusinessObjectEditor class is a base class that all ManagementCenter tools must extend. It is the main widget within the Management

    Center framework, and includes the various low level widgets that make up

    the framework. The Management Center object editor includes support forseveral parts of the Management Center user interface.

  • 8/8/2019 MC docview

    28/52

    IBM Software Group

    WebSphereSupport Technical Exchange 28

    Description of the Main UI Pieces thatmay be Customized

    Explorer view: the explorer view contains an explorer tree withnodes that you can select, expand, and collapse. The explorer

    view controls what is displayed in the main work area.

    If you must add a new tool to the Management Center, you willneed to define an OpenLaszlo library class for the top objectdefinition in the explorer view.

    You will need to create your own directory structure under the..\LOBTools\WebContent\WEB-INF\src\lzx directory. For

    example, the top object definition for the Catalog tool is..\LOBTools\WebContent\WEB-INF\src\lzx\commerce\catalog\objectDefinitions\CatalogTopObjectDefinition.lzx.

    Refer to the InfoCenter under the topic of Defining a topobject definition in the explorer view for information on how toperform this type of customization.

  • 8/8/2019 MC docview

    29/52

    IBM Software Group

    WebSphereSupport Technical Exchange 29

    Description of the Main UI Pieces thatmay be CustomizedList view: One of the views displayed in the

    main work area. A list view lists objects in

    the form of a table.

    List view definitions are typically modified toinclude new columns of information.

    Files are located in the..\LOBTools\WebContent\WEB-INF\src\lzx\commerce\\listViewDefinitions directory. Edit the file to change, suchas CatalogEntryGrid.lzx and add a newwidget, such as wcfGridComboBox.

    Refer to the tutorial Adding new fields inthe Catalogs Tool for information on howto modify a list view.

  • 8/8/2019 MC docview

    30/52

    IBM Software Group

    WebSphereSupport Technical Exchange 30

    Description of the Main UI Pieces thatmay be Customized

    Properties view: One of the views displayed in the mainwork area. A properties view shows details about an

    object and is where you can edit the object.

    Properties view definitions are typically modified toinclude new properties for an object, such as detailedwarranty information for a product.

    Files are located in the..\LOBTools\WebContent\WEB-INF\src\lzx\commerce\\propertiesView. Often,you will change a pane to reference the new property.Edit the file, such as CatalogPropertyPane.lzx toinclude a new tab.

    In addition, you may need to define initial values forthe new property through a GUI widget such as acombo box. To modify object definition files, navigateto ..\LOBTools\WebContent\WEB-

    INF\src\lax\commerce\\objectDefinitions. Editthe file to be modified, such asProductPrimaryObjectDefinition.lzx to add newproperty values.

  • 8/8/2019 MC docview

    31/52

    IBM Software Group

    WebSphereSupport Technical Exchange 31

    Description of the Main UI Pieces thatmay be Customized

    Find area and Utilities View: Search for objects by typing

    a keyword and selecting a search object type from a list.(You can also select the advanced search option torefine your search.) Results are displayed within themain work area and Utilities View.

    Extend the out-of-box Advanced Search dialog toinclude new properties in the search criteria - extend the

    catAllCatalogEntriesAdvancedSearchContent class inthe file ..\LOBTools\WebContent\WEB-INF\src\lzx\commerce\catalog\restricted\searchDefinitions\CatalogAdvancedSearchContent.lzx.

    For example, create a new folder and file (e.g. under the..\LOBTools\WebContent\WEB-INF\src\lzx directory).

    Extend the existing class and include new widgets suchas combo boxes, radio buttons, etc. for the new searchproperties.

  • 8/8/2019 MC docview

    32/52

    IBM Software Group

    WebSphereSupport Technical Exchange 32

    Object Definitions A Management Center object is an entity that is stored on the WebSphere

    Commerce Server, but is represented in the Management Center user interface in away that a business user can understand. A business user can create, update, anddelete Management Center objects using one of the Management Center tools.Product is an example of a Management Center object.

    Objects can be customized within the Management Center web application.

    New objects can be created

    Existing objects can be extended

    Override an objects existing validation message

    Object definition files are XML files

    Object definition files are stored in /WebContent/WEB-INF/src/lzx/commerce//objectDefinitions where tool is the name of the tool, for example,catalog

    There are primary and child objects Examples of primary objects are Catalog, Category, Product

    Examples of child object are Catalog Entry Description, Catalog Entry Attribute

    Refer to the slides in the Backup Material section for additional examples

  • 8/8/2019 MC docview

    33/52

    IBM Software Group

    WebSphereSupport Technical Exchange 33

    Object Properties Properties View

    A properties view shows all details about an object and is where abusiness user can edit an existing object, or create a new instance of

    one.

    The properties view can contain entry fields, check boxes, radiobuttons, lists, tables, pull-down sections, and tabs.

    An object's properties view should be an extension ofwcfObjectProperties.

    A properties view can contain one or more tabs to help organize theobject's details. The contents of the tabs are an extension ofwcfPropertyTabPane.

    Properties View Files are located at:/WebContent/WEB-INF/src/lzx/commerce/< tool>/propertiesViewswhere tool is the name of the tool, for example, catalog

    IBM S ft G

  • 8/8/2019 MC docview

    34/52

    IBM Software Group

    WebSphereSupport Technical Exchange 34

    List View Definitions the WarrantyScenario

    To make changes to the list view, work with files in the subdirectory:/WebContent/WEBINF/src/lzx/commerce//listViewDefinitions

    This list view is modifiedto display a newcolumn, Warranty

    Type.

    An object can containchild list definitions. Achild list is a list ofobjects that belong to

    the same parent object.A list of products withina category is anexample of a child list.

    IBM S ft G

  • 8/8/2019 MC docview

    35/52

    IBM Software Group

    WebSphereSupport Technical Exchange 35

    Object Properties Warranty ScenarioExample of new properties (inWarranty tab) for an existingobject (Product)

    The CatalogPropertyPane.lzx file wasModified to display the Warranty taband the ProductPropertiesView.lzx

    File was modified to display theWarranty Term and

    Warranty Type properties.

    IBM Software Group

  • 8/8/2019 MC docview

    36/52

    IBM Software Group

    WebSphereSupport Technical Exchange 36

    Search Definitions Warranty ScenarioChanging the search definition for aManagement Center object

    You can change the search definition for an

    object, such as defining a new listClass for thesearch result

    You can customize advanced search toinclude more properties as search conditions

    When customizing the advanced search, you

    add user interface widgets to an extension ofthe Advanced Search dialog

    All search definitions are located in thisdirectory:

    \LOBTools\WebContent\WEB-INF\src\src\lzx\commerce\\

    searchDefinition where tool is the name of thetool to customize

    IBM Software Group

  • 8/8/2019 MC docview

    37/52

    IBM Software Group

    WebSphereSupport Technical Exchange 37

    Resource Bundles A properties file is a resource bundle that contains translatable text that is displayed on the UI

    By using a resource bundle file, the text can be localized, translated into different languages,handle multiple locales at once, and be easily modified later. At a high-level, the steps to follow

    are for including a new properties file are:

    Create properties files to manage translatable text in:Dynamic Web Projects > LOBTools > Java Resources > src

    Name the folder to indicate it is used for extended properties(for example,com.mycompany.commerce.client.lobtools.properties )

    Name the new properties file with the appropriate locale settings(for example, CatalogLOB_en_US.properties)

    When adding new keys for displayable text:

    Create a new properties file Register the new properties file in the resource bundle

    Include a reference to the registered properties files in an extension file, such as../LOBTools/WebContent/WEB-INF/src/lzx/commerce/catalog/CatalogExtensionLibrary.lzx

    IBM Software Group

  • 8/8/2019 MC docview

    38/52

    IBM Software Group

    WebSphereSupport Technical Exchange 38

    Mediator JSP Files For the Warranty scenario, the mediator (or controller) JSP that

    processes the get-data request is:../LOBTools/WebContent/jsp/commerce/catalog/GetChildCatalogEntry

    ForCatalogGroup.jsp

    For the Warranty scenario, there are several serializer JSPs that build upthe XML response to the Management Center client. These are includedby the controller JSP and are located at:../LOBTools/WebContent/jsp/commerce/catalog/serialize

    The mediator JSPs are located at:../LOBTools/WebContent/jsp/commerce/

    Note that for the Warranty scenario, warranty information is added to theCatalogEntry noun UserData element so there is no need to create acustom get-data request.

    IBM Software Group

  • 8/8/2019 MC docview

    39/52

    IBM Software Group

    WebSphereSupport Technical Exchange 39

    Custom get-data RequestIn order to retrieve a custom Management Center object, you must add

    code to enable the Management Center Web application to mediatethe request (*)

    Create a directory under WebContent/jsp to store your custom files:

    For example mycompany/catalog for a catalog extension

    Create a JSP fragment file named SerializeClientObject.jspf

    Create a controller JSP page named GetClientObject.jsp

    Use jsp:directive.include to include the serialization fragment

    Update struts-extension.xml with the new action forward for the JSP

    (*) Refer to the InfoCenter topic Defining retrieval services for a custom Management Center objectfor more details

    IBM Software Group

  • 8/8/2019 MC docview

    40/52

    IBM Software Group

    WebSphereSupport Technical Exchange 40

    Custom Process RequestDefining the authoring services such as create, save, and delete for a custom

    Management Center object to the WebSphere Commerce OAGIS service consists offirst defining the URL parameter mapping to the Noun in the BOD request, thenconfiguring the Struts action to indicate the Verb and additional processinginformation.(*)

    Create a mapping XML file in WebContent/WEB-INF/config

    For example mycompany-catalog-clientobjects.xml for a catalog extension

    Specify Noun

    Include modifiable parts and UserData Create URL mapping

    Specify resource bundle that defines error messages

    Update struts-extension.xml

    Add XML file

    Create new BusinessObjectDocument Struts actions

    (*) Refer to the InfoCenter topic Defining process services for a custom Management Center object for more details

    IBM Software Group

  • 8/8/2019 MC docview

    41/52

    So t a e G oup

    WebSphereSupport Technical Exchange 41

    Tool Configuration Files Tool configuration files such as the get-data-config.xml and URL to OAGIS mapping

    files are in this directory:../LOBTools/WebContent/WEB-INF/config/com.ibm.commerce.

    The customized configuration files such as the get-data-config.xml and URL toOAGIS mapping files are in this directory:../LOBTools/WebContent/WEB-INF/config/com.ibm.commerce.-ext

    Note: For the Warranty scenario, the get-data-config.xml file is overridden to invoke the querythat will retrieve the warranty properties for the product. This file (get-data-config.xml) is locatedin the directory:../LOBTools/WebContent/WEB-INF/config/com.ibm.commerce.catalog-ext

    IBM Software Group

  • 8/8/2019 MC docview

    42/52

    p

    WebSphereSupport Technical Exchange 42

    Struts Configuration FileCustomized struts configurations take precedence and are located in this directory:

    ../LOBTools/WebContent/WEB-INF/struts-extensions.xml

    Note: The Warranty scenario (for the Management Center UI) does not require anyextensions for struts configurations.However, to display the information on the storefront, may require a new JSP and therequired modifications.

    IBM Software Group

  • 8/8/2019 MC docview

    43/52

    p

    WebSphereSupport Technical Exchange 43

    Best Practices Understand the complexity of the customizations and refer to the InfoCenter for the

    types of customizations that are currently supported

    Follow customization tutorials on InfoCenter. This will help you get familiar with

    where the code assets are located, including mediator JSPs and OpenLazlo files.

    Do not modify the files in the restricted folders.

    Always use designed extension points.

    Make use of a Nouns UserData built-in extension point by following naming

    convention for new properties prefix with x_.

    Always follow recommended deployment procedures..

    Make backup copies of all the out-of-box files you will need to change. Whenworking through the tutorials or implementing customizations for a project, the filesthat you may need to change could result in errors or crashing of the Management

    Center if implementations are not done properly. Give yourself a way to recover!

    IBM Software Group

  • 8/8/2019 MC docview

    44/52

    WebSphereSupport Technical Exchange 44

    Custom Code Directories and NamingConventions

    Keep a consistent directory structure. This is important for migrating to a laterrelease, or if you require assistance from IBM support with your

    customizations.

    Use a similar file structure for any files that you add to theManagement Center (for example, when adding a new custom tool).

    Use your own company name for the customized directory. Forexample, instead of using:WebContent/WEB-INF/src/lzx/commerce/Management_Center_tooluse:WebContent/WEB-INF/src/lzx/myCompanyName/Management_Center_tool

    The customized configuration files such as the get-data-config.xml andURL to OAGIS mapping files go in this directory:WebContent/WEB-INF/config/com.ibm.commerce.-ext

    IBM Software Group

  • 8/8/2019 MC docview

    45/52

    WebSphereSupport Technical Exchange 45

    Summary Provided an overview of the Management Center architecture

    Introduced the new UI technology (OpenLaszlo)

    Went over the building blocks of the Management Center client andthe Management Center Web application

    Positioning the Management Center within engagements

    Described the required skill set for customizations

    Presented the complexity of sample customizations

    Described how the Management Center can be extended and customized

    Presented an overview of what is required to perform thecustomizations

    Described Best Practices related to customization

    IBM Software Group

  • 8/8/2019 MC docview

    46/52

    WebSphereSupport Technical Exchange 46

    InfoCenter ReferencesFor additional information on customizing the Management Center,reference topics and tutorials in the Commerce InfoCenter:

    Under the main topic Developing, review the subtopics:

    Management Center Web Application

    Management Center Framework

    Under the main topic Tutorials, review the subtopics:Adding new search conditions in the advanced search of the CatalogManagement Tool

    Adding a new validation rule in the marketing management tool

    Adding new properties in Catalog Management tool

    IBM Software Group

  • 8/8/2019 MC docview

    47/52

    WebSphereSupport Technical Exchange 47

    Additional WebSphere Product Resources Discover the latest trends in WebSphere Technology and implementation, participate in

    technically-focused briefings, webcasts and podcasts at:http://www.ibm.com/developerworks/websphere/community/

    Learn about other upcoming webcasts, conferences and events:http://www.ibm.com/software/websphere/events_1.html

    Join the Global WebSphere User Group Community: http://www.websphere.org

    Access key product show-me demos and tutorials by visiting IBM Education Assistant:

    http://www.ibm.com/software/info/education/assistant

    View a Flash replay with step-by-step instructions for using the Electronic ServiceRequest (ESR) tool for submitting problems electronically:http://www.ibm.com/software/websphere/support/d2w.html

    Sign up to receive weekly technical My support emails:http://www.ibm.com/software/support/einfo.html

    IBM Software Group

  • 8/8/2019 MC docview

    48/52

    WebSphereSupport Technical Exchange 48

    Questions and Answers

    IBM Software Group

  • 8/8/2019 MC docview

    49/52

    WebSphereSupport Technical Exchange 49

    Backup Presentation Material

    IBM Software Group

  • 8/8/2019 MC docview

    50/52

    WebSphereSupport Technical Exchange 50

    LOBProject Directory Structure

    /WebContent/WEB-

    INF/src/lzx/commerce//listViewDefinitions

    List view definitions

    /WebContent/WEB-INF/classes/

    com/ibm/commerce//client/lobtools/properties

    Messages bundles for the tool

    /WebContent/WEB-INF/classes/extension/-or- Java Resources/src)

    Customized messages bundles

    /WebContent/WEB-INF/src/lzx/commerce//searchDefinitionsSearch definitions and related classes

    /WebContent/WEB-

    INF/config/com.ibm.commerce.

    Tools configuration files - get-data-config.xml and URL to OAGIS mapping

    files

    /WebContent/WEB-

    INF/config/com.ibm.commerce.-ext

    Customized get-data-config.xml and URL to OAGIS mapping files

    /WebContent/WEB-

    INF/src/lzx/commerce//restricted

    Open Laszlo Files that cannot be changed directly

    Customized struts configurations. Entries defined here take precedence

    Mediator JSP files that transform server objects to UI objects

    Properties view files of business objects

    Business object definitions

    Business object editor files for the tool

    Development Assets

    /WebContent/WEB-INF/struts-extensions.xml

    /WebContent/jsp/commerce/

    /WebContent/WEB-

    INF/src/lzx/commerce//objectDefinitions

    /WebContent/WEB-

    INF/src/lzx/commerce//propertiesViews

    /WebContent/WEB-INF/src/lzx/commerce/

    Folders

    IBM Software Group

  • 8/8/2019 MC docview

    51/52

    WebSphereSupport Technical Exchange 51

    Primary Objects A Primary Object describes a top-level object.

    Primary objects are defined by the class wcfPrimaryObjectDefinition which extendswcfObjectDefinition. The known subclasses define the following primary objects:

    Catalog (master and sales)

    Category (master and sales)

    Product

    SKU

    Kit

    Bundle Customer segment

    eSpot

    Content spot

    Campaign

    eMail activity

    eMail JSP template

    Web activity

    IBM Software Group

  • 8/8/2019 MC docview

    52/52

    WebSphereSupport Technical Exchange 52

    Child Objects A Child Object describes a secondary business object. Child Objects cannot exist

    without a parent object. Child Objects can be owned by Primary Objects or otherChild Objects.

    Child objects are defined by the class wcfChildObjectDefinition which extendswcfObjectDefinition. The known subclasses define the following child objects:

    Catalog entry attribute (also language sensitive)

    Attribute allowed value (also language sensitive)

    Catalog entry description

    Catalog entry extra properties

    Catalog entry inventory

    Catalog entry list price

    Catalog entry offer

    Catalog group description Defining attribute (for SKU)

    Reference object definition (define a relationship between 2 primary objects, forexample, merchandise association)