sap jam communities for hybris sample code installation guide · pdf filesap jam communities...

PUBLIC

SAP Jam Communities for hybris sample code Installation GuideDocument Version: February 2017 – 2017-04-17

SAP Jam Communities for hybris sample code Installation Guide

Content

1 Introduction and requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.1 Welcome to the SAP Jam Communities for hybris sample code Installation Guide. . . . . . . . . . . . . . . . . . 3

2 Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.1 Install SAP Jam Communities for hybris sample code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3 Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103.1 Enable SAP Jam Communities in SAP hybris pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10

Enable Communities in the hybris home page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Enable Communities in hybris product list pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Enable Communities in hybris product details pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Enable Communities in hybris search results pages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20

3.2 Configure your SAP hybris Mobile Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223.3 Configure your SAP hybris B2B site. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

4 Get support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284.1 Get help with SAP Jam Communities for hybris. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2 P U B L I CSAP Jam Communities for hybris sample code Installation Guide

Content

1 Introduction and requirements

1.1 Welcome to the SAP Jam Communities for hybris sample code Installation Guide

Introduction

SAP Jam Communities for hybris commerce is a new solution offered by SAP that is the first commerce-optimized community. SAP Jam Communities enables B2B and B2C online commerce sites to:

● Enhance product catalog information with authentic community content and peer recommendations to enhance your SAP hybris Commerce investment.

● Drive increased traffic via search-engine-optimized community content and sharing community content in social networks.

● Offer relevant, credible content to instill buying confidence and increase revenue.● Enable customers to find answers to their questions on their own time and terms.● Establish emotional relationships to create loyalty.

These objectives are met by providing the following capabilities to SAP Jam Communities for hybris commerce users:

● The ability for users to ask questions about any product (topic) listed in hybris.● The ability for users to discuss any product (topic) listed in hybris.● The ability for authorized users to write blogs—such as detailed comparisons of similar products, product

usage tips, or partial or even full tutorials on the use of the product—about any product (topic) listed in hybris.● The ability for users to contribute reviews on any product (topic) listed in hybris.● The ability for users to comment on other user's contributions.● The ability for users to like other user's contributions.● The ability for users to follow topics or specific exchanges.● The ability for users to view a summary of other user's contributions.● The ability for users to search and find user's contributions.

Version and compatibility

This document covers the SAP Jam Communities for hybris, version 1.0, which is compatible with hybris v.5.5.1 or v.5.7.

SAP Jam Communities for hybris sample code Installation GuideIntroduction and requirements P U B L I C 3

Requirements

Installation of SAP Jam Communities for hybris requires that you have administrator access to your organization's hybris v.5.5.1 or v.5.7 instance.


Introduction and requirements

2 Installation

2.1 Install SAP Jam Communities for hybris sample code

SAP Jam Communities is a cloud-based service (SaaS), however hybris e-commerce originated as an on-premises server application that has been developed to also allow it to operate as a cloud-based service. Due to its origins and continued support for operating as an on-premises service, integrating SAP Jam Communities to your hybris service requires that you download some sample code (so termed in part for legal reasons) and deploy it on your organization's hybris commerce service. This sample code connects hybris e-commerce with the SAP Jam Communities cloud solution.

To install the SAP Jam Communities for hybris sample code:

1. Log in to your hybris server as the hybris administrator and create a custom directory in your <install_location>/hybris-commerce-suite-<release_number>/hybris/bin directory.

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/bin # mkdir custom

2. Download the SAP Jam Communities for hybris sample code from https://github.com/sapjam-community/JamCommunitySampleCode and save it, or copy it, into the newly created custom directory on your hybris server:

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/bin/custom # cp <my_download_directory>/<SAPJamCommunitiesAddOnVersionnnnnn>.zip .

3. Unzip the downloaded excelsiorjsaddon_R047_telco.zip file into the <install_location>/hybris-commerce-suite-<release_number>/hybris/bin/custom folder:

# unzip <SAPJamCommunitiesAddOnVersionnnnnn>.zip .

Figure 1: The primary configuration files used in this installation

SAP Jam Communities for hybris sample code Installation GuideInstallation P U B L I C 5

http://help.sap.com/disclaimer?site=https://github.com/sapjam-community/JamCommunitySampleCode

http://help.sap.com/disclaimer?site=https://github.com/sapjam-community/JamCommunitySampleCode

4. Register SAP Jam Communities for hybris by appending the following line to the end of the <install_location>/hybris-commerce-suite-<release_number>/hybris/config/localextensions.xml file:

<extension name="excelsiorjsaddon"/>

5. Install the SAP Jam Communities add-on to your yacceleratorstorefront (your b2c storefront) and yb2bacceleratorstorefront (your b2b storefront, beginning in 5.7), by navigating to the platform directory and running the ant command shown below:

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/bin/platform # ant addoninstall -Daddonnames="excelsiorjsaddon" -DaddonStorefront.yacceleratorstorefront="yacceleratorstorefront" -DaddonStorefront.yb2bacceleratorstorefront="yb2bacceleratorstorefront"

NoteThe last segment of the preceding ant command, "-DaddonStorefront.yb2bacceleratorstorefront="yb2bacceleratorstorefront", is not required if you are running SAP hybris 5.7.

6. Configure your user-mapping information by doing the following:1. Register a user in your SAP Jam Communities tenant as described in section 2.11 Configure Permissions

in the SAP Jam Communities for hybris Administration Guide and copy the user's username and password.

2. Add an OAuth Configuration in your SAP Jam Communities tenant as described in section 2.14 Configure an OAuth client in the SAP Jam Communities for hybris Administration Guide and copy the App ID and the Secret ID.

3. Navigate to the excelsiorjsaddon directory, overwrite the project.properties file with the project.properties.template file, as shown below:

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/config/excelsiorjsaddon # cp project.properties.template project.propertiescommunity.${communityNetwork}.certificate= ${certificate}community.${communityNetwork}.privateKey= ${privateKey} community.${communityNetwork}.issuer= ${issuer}

4. Edit the new project.properties file as shown below:

# Configure which product will show up in the hybris homepage component: ${hybrisSite}.homepage.component.productCode=${productCode}#hybris website <-> community network mapping${hybrisSite}.community.network=${communityNetwork}#config network paramscommunity.${communityNetwork}.url=${communityUrl}community.${communityNetwork}.token.username=${communityUsername}community.${communityNetwork}.token.password=${communityPassword}community.${communityNetwork}.application.id=${communityApplicationId} community.${communityNetwork}.secret.id=${communitySecretId}

In the above example, set the following values in the network params section using the information that you gathered in steps a. and b.:○ ${communityUsername} = The username of the user that you added in the Permissions section of

the SAP Communities Admin console.


Installation

http://help.sap.com/businessobject/product_guides/Jam14/en/SAP_Jam_Communities_for_hybris_Administration_Guide.pdf

http://help.sap.com/businessobject/product_guides/Jam14/en/SAP_Jam_Communities_for_hybris_Administration_Guide.pdf

○ ${communityPassword} = The password of the user that you added in the Permissions section of the SAP Communities Admin console.

○ ${communityApplicationId} = The App ID that you copied from the entry for SAP hybris configured in the OAuth Configuration section of the SAP Communities Admin console.

○ ${communitySecretId} = The Secret ID that you copied from the entry for SAP hybris configured in the OAuth Configuration section of the SAP Communities Admin console.

For example:

electronics.homepage.component.productCode=1978440 electronics.community.network=camerascommunity.cameras.url=https://cameras.community-demo.sapjam.comcommunity.cameras.token.username=hybrisaccessusercommunity.cameras.token.password=c0mmun1t1&sR0ck$community.cameras.application.id=9ff0eca5cf3b9f3e209ed780f6a627e22db3b2077e5abc34addd440903cf2cf3 community.cameras.secret.id=02b5e03b994f130c0f496e9c1d745c618d53b2d18dcd5df4cd10cc8cb3ad28ef

7. Compile hybris by running the following command on the hybris server, as the hybris admin user:

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/bin/platform # ant clean all

8. Update the hybris system addon information by configuring the impex files for both your B2B and B2C sites:○ To edit the B2C storefront:

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/bin/custom/excelsiorjsaddon/resources/impex vi ./projectdataExcelsior-b2c.impex

○ To edit the B2B storefront:

# cd <install_location>/hybris-commerce-suite-<release_number>/hybris/bin/custom/excelsiorjsaddon/resources/impex vi ./projectdataExcelsior-b2b.impex

NoteFor an SAP hybris 5.7 installation, please copy resources/versions/5.7/impex/projectdataExcelsior-b2b.impex to resources/impex/ as the B2B acceleratorstorefront has been changed in SAP hybris 5.7.

Make the following changes:1. Change the catalog in the first line (for example, to "electronics, apparel-uk, powertools" or whatever is

appropriate for your site, for example:

$contentCatalog=electronicsContentCatalog

2. Change all the instances of the $community_site, the $community_slug, and the $hybris_prodCode properties, for example:

$community_site=https://xxx.demo.sapjam.com $community_slug=cameras $hybris_prodCode=1934793


NoteFor a new installation, you could leave these last three values empty (no value). If you are updating to the new SAP Communities release, you can keep your previous settings or change them to empty values. These values will overwrite the values set in the project.properties file.

9. Update your SAP hybris system by doing the following1. Start hybris.2. Log in to the hybris admin account.

3. Select the Platform Update tab.The Platform Update tab displays.

4. Select the following options:○ Update running system○ Clear the hMC configuration from the database○ Localize types

Figure 2: Update your SAP hybris system5. Click Update.


Installation

10. Stuff.

Figure 3: Description11. Configure SAP JAM Community Add-on Components.

https://hybrisserver:9002/cmscockpit/login.zul

Figure 4: Description


3 Configuration

3.1 Enable SAP Jam Communities in SAP hybris pages

Once you have installed the SAP Jam Communities code example for SAP hybris, you must enable SAP Jam Communities in every SAP hybris page. The pages in this section describe the steps required to do this.

3.1.1 Enable Communities in the hybris home page

You must enable SAP Jam Communities in your SAP hybris home page(s).

To configure the SAP hybris home page to use SAP Jam Communities

NoteThese steps are only required if you want SAP Jam Communities comments from customers to be enabled in your SAP hybris home page(s).

1. Log in to your SAP hybris service at https://<your_hybris_server>:<port_number>/cmscockpit/login.zul as the cmsmanager user.

2. In the SAP Hybis Menu WCMS Page View page, double-click Homepage.

NoteThis procedure must be repeated for both the staged and online home pages of every website in your SAP hybris system to which you want to add SAP Jam Communities commenting capabilities.


Configuration

Figure 5: Homepage selection

The SAP hybris Homepage configuration page displays.3. In the SAP hybris Homepage configuration page, go to the Section Slot to which you want to add SAP Jam

Communities commenting and click the add icon, "+".

Figure 6: Add icon

The Create/Add New Component - Search dialog box displays.4. In the Create/Add New Component - Search dialog box, click the Search icon, enable the Excelsior HomePage

Paragraph Component option, and click Done.

SAP Jam Communities for hybris sample code Installation GuideConfiguration P U B L I C 11

Figure 7: Enable the "Excelsior Home Page Component"

5. Open the SAP Hybis Home WCMS Components page.[Why am I accessing this page? What am I trying to do here?]

Figure 8: Description6. [How do I open this dialog box? I am guessing that it is from the previous page, but what control opens this

dialog box? Or is this a segment of the page? If so, it does not show in the previous screen capture, so where is this form located?]Specify the Product Code.


Configuration

[Where do I get the product code from? Or am I copying the product code from this dialog box for use in some other form?]


3.1.2 Enable Communities in hybris product list pages

You must enable SAP Jam Communities in each SAP hybris product list page.

To configure the SAP hybris product list pages to use SAP Jam Communities

NoteThese steps are only required if you want SAP Jam Communities comments from customers to be enabled in your SAP hybris product list pages.


2. In the SAP Hybis Menu WCMS Page View page, double-click Product List.

NoteThis procedure must be repeated for both the staged and online product list pages of every website in your SAP hybris system to which you want to add SAP Jam Communities commenting capabilities to the product list pages.


Figure 10: Description3. Go to Product List Slot for Product List section, click the lock icon to unlock the page template, and click the

add icon, "+".


A Create/Add New Component - Select desired type dialog box displays.4. In the Create/Add New Component - Select desired type dialog box, select either Excelsior Product Grid

Component or Excelsior Product List Component.You should choose the page layout type that is used as the default for your product list pages.


Configuration

Figure 12: The 'Create/Add New Component - Select desired type' dialog box

The Create/Add New Component - Search dialog box displays.5. In the Create/Add New Component - Search dialog box, click Search, enable the Excelsior Product List

Component option, and click Done.

Figure 13: The Create/Add New Component - Search dialog box6. Remove the previous product list or grid component.


Figure 14: Remove the previous product list

3.1.3 Enable Communities in hybris product details pages

You must enable SAP Jam Communities in each SAP hybris product details page.

To configure the SAP hybris product details pages to use SAP Jam Communities

NoteThese steps are required in every SAP hybris product details page in which you want SAP Jam Communities commenting from customers to be enabled.


2. In the SAP Hybis Menu WCMS Page View page, double-click Product Details.

NoteThis procedure must be repeated for both the staged and online product details pages of every website in your SAP hybris system to which you want to add SAP Jam Communities commenting capabilities to the product details pages.

3. In Default Section2 for Product Details, click the add icon, "+".


Configuration


The Create/Add New Component - Select desired type dialog box displays.4. In the Create/Add New Component - Select desired type dialog box, select Excelsior Q&A Component.

Figure 16: The Create/Add New Component - Select desired type dialog box

The Create/Add New Component - Please select an option dialog box displays.5. In the Create/Add New Component - Please select an option dialog box, select Select an existing reference.


Figure 17: The Create/Add New Component - Please select an option dialog box

The Create/Add New Component - Search dialog box displays.6. In the Create/Add New Component - Search dialog box, click the Search icon, enable the Excelsior QA

Paragraph Compontent option, and click Done.

Figure 18: The Create/Add New Component - Search dialog box

You are returned to the SAP Hybis Menu WCMS Page View Product Details page.7. In the Tabs area of the Up Selling section, click the lock icon to unlock the tabs.


Configuration

Figure 19: The SAP Hybis Menu WCMS Page View Product Details page

A confirmation dialog box displays.8. In the Unlock Page Template confirmation dialog box, click OK.

Figure 20: The Unlock Page Template confirmation dialog box

The Create/Add New Component - Select desired type dialog box displays.9. In the Create/Add New Component - Select desired type dialog box, select one or more of the "Excelsior"

components that you want included in this product detail page.


Figure 21: The Create/Add New Component - Select desired type dialog box

3.1.4 Enable Communities in hybris search results pages

You must enable SAP Jam Communities in your SAP hybris search results page.

To configure the SAP hybris search results pages to use SAP Jam Communities

NoteThese steps are only required if you want SAP Jam Communities comments from customers to be enabled in your SAP hybris search results pages.


2. In the SAP Hybis Menu WCMS Page View page, double-click Search Results Page.

NoteThis procedure must be repeated for both the staged and online search results pages of every website in your SAP hybris system to which you want to add SAP Jam Communities commenting capabilities to the search results pages.


Configuration

Figure 22: The SAP Hybis Menu WCMS Page View page

The SAP hybris Search Results configuration page displays.3. In the SAP hybris Search Results configuration page, in the Search Result List Slot for Search List, click the

lock icon to unlock the slot, and then click the add icon, "+".

Figure 23: The SAP hybris Search Results configuration page

The Create/Add New Component - Search dialog box displays.4. In the Create/Add New Component - Search dialog box, click the Search icon, enable the Excelsior Search

Result List Component option, and click Done.


Figure 24: The Create/Add New Component - Search dialog box

You are returned to the SAP hybris Search Results configuration page.5. Delete the old Search Result List Page by clicking on the trash can icon, and then click the lock icon for the

Search Result List Slot for Search List to lock that component.

Figure 25: Delete the old Search Result List Page

3.2 Configure your SAP hybris Mobile Components

Configuring SAP hybris mobile components is very similar to configuring access to SAP Jam Communities in the SAP hybris desktop page components.

Similar to the procedures in the previous sections for enabling SAP Jam Communities in SAP hybris pages, each page in which you want to enable customer commenting and contributions requires that you enable it in the SAP hybris CMS cockpit. This section will only demonstrate enabling SAP Jam Communities in an SAP hybris product details page, however.


Configuration

To enable SAP Jam Communities in the SAP hybris product details pages mobile component


2. In the SAP Hybis Menu WCMS Page View page, in the top bar of the page, select Mobile from the second-from-the-right drop-down menu.


The mobile components display in the WCMS Page View content pane.

NoteYou need to enable SAP Jam Communities in every SAP hybris mobile content page, just as you did for the desktop pages in the preceding sections.

3. As an example procedure, in the WCMS Page View content pane, double-click Mobile Product Details.



The Mobile Product Details configuration page displays.4. In the Mobile Product Details configuration page, in the Default Section2 for Mobile Product Details section,

enable Excelsior QA Paragraph Component, and click the lock icon in the Mobile Tabs section to unlock it.

Figure 28: Description5. [There must be some further steps here, but I have no information on what is being done or what the steps are

to do it.]


Configuration

To enable "responsive UI" behavior in SAP hybris mobile components

1. Edit the $HYBRIS_HOME/hybris/bin/ext-template/yacceleratorstorefront/project.properties file by appending the following line:

add commerceservices.default.desktop.ui.experience=responsive

2. Edit the $HYBRIS_HOME/hybris/bin/custom/excelsiorjsaddon/project.properties file by change the value of "responsive" from "off" to "on":

responsive=on

3. Run "ant clean all" and restart the server:

# cd $HYBRIS_HOME/hybris/bin/platform # ant clean all # ./hybrisserver.sh

[The rest of this does not appear to make much sense, probably as I didn't get this right in the Installation section.]server restart automatically

4. Reinitialize system5. re-update system (follow install addon, step 6)6. re-config component (follow Config components in above)

3.3 Configure your SAP hybris B2B site

In addition to configuring your e-commerce (B2C) site, as has been the focus of all of the preceding Configuration sections so far, you must also configure your business-to-business (B2B) site to use SAP Jam Communities.

To configure your SAP hybris B2B site to use SAP Jam Communities


2. In the SAP Hybis Menu WCMS Page View page, select the online segment of your Configure B2B Site.



In the WCMS Page View content pane, the B2B components display.

3. In the SAP Hybis Menu WCMS Page View page, double-click Homepage.

NoteThis procedure must be repeated for both the staged and online home pages of every website in your SAP hybris system to which you want to add SAP Jam Communities commenting capabilities.

The B2B Homepage configuration page displays.4. In the B2B components configuration page, select Default Section5 for Homepage.



Configuration

NoteFor SAP hybris 5.7, in the Homepage configuration page, choose "Section 5" instead of "Section 3".

5. [There must be several more steps here, but as I have no indication of what is being done, nor the steps required to do it, I cannot do much more.]


4 Get support

4.1 Get help with SAP Jam Communities for hybris

To file a SAP Jam Communities for SAP Hybris support request, please see: https://support.sap.com .

Customer support for SAP Jam Communities is provided by LOD-COM.


Get support

http://help.sap.com/disclaimer?site=https://support.sap.com

Important Disclaimers and Legal Information

Coding SamplesAny software coding and/or code lines / strings ("Code") included in this documentation are only examples and are not intended to be used in a productive system environment. The Code is only intended to better explain and visualize the syntax and phrasing rules of certain coding. SAP does not warrant the correctness and completeness of the Code given herein, and SAP shall not be liable for errors or damages caused by the usage of the Code, unless damages were caused by SAP intentionally or by SAP's gross negligence.

AccessibilityThe information contained in the SAP documentation represents SAP's current view of accessibility criteria as of the date of publication; it is in no way intended to be a binding guideline on how to ensure accessibility of software products. SAP in particular disclaims any liability in relation to this document. This disclaimer, however, does not apply in cases of willful misconduct or gross negligence of SAP. Furthermore, this document does not result in any direct or indirect contractual obligations of SAP.

Gender-Neutral LanguageAs far as possible, SAP documentation is gender neutral. Depending on the context, the reader is addressed directly with "you", or a gender-neutral noun (such as "sales person" or "working days") is used. If when referring to members of both sexes, however, the third-person singular cannot be avoided or a gender-neutral noun does not exist, SAP reserves the right to use the masculine form of the noun and pronoun. This is to ensure that the documentation remains comprehensible.

Internet HyperlinksThe SAP documentation may contain hyperlinks to the Internet. These hyperlinks are intended to serve as a hint about where to find related information. SAP does not warrant the availability and correctness of this related information or the ability of this information to serve a particular purpose. SAP shall not be liable for any damages caused by the use of related information unless damages have been caused by SAP's gross negligence or willful misconduct. All links are categorized for transparency (see: http://help.sap.com/disclaimer).

SAP Jam Communities for hybris sample code Installation GuideImportant Disclaimers and Legal Information P U B L I C 29

http://help.sap.com/disclaimer/

go.sap.com/registration/contact.html

© 2017 SAP SE or an SAP affiliate company. All rights reserved.No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP SE or an SAP affiliate company. The information contained herein may be changed without prior notice.Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary.These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE (or an SAP affiliate company) in Germany and other countries. All other product and service names mentioned are the trademarks of their respective companies.Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional trademark information and notices.

https://go.sap.com/registration/contact.html

https://go.sap.com/registration/contact.html

http://www.sap.com/corporate-en/legal/copyright/index.epx

http://www.sap.com/corporate-en/legal/copyright/index.epx

sap jam communities for hybris sample code installation guide · pdf filesap jam communities...

Documents