Oracle Commerce

Skip to end of metadata
Go to start of metadata

Overview

The Gigya Module for Oracle Commerce (formerly ATG) allows you to easily integrate Gigya's Customer Identity Management platform throughout your Oracle Commerce store. With the Gigya extension, you can easily build and maintain secure and scalable registration, authentication, profile management, data analytics and third-party integrations. Increase registrations and identify customers across devices, consolidate data into rich customer profiles, and provide better service, products and experiences by integrating data into marketing and service applications.

Main Features

Customer Identity Management

The Gigya module provides two main customer identity management packages:

  1. Social Login – The Gigya Extension can be used as an external authentication system, allowing users to sign up to your site using their social networks while interacting with the standard Oracle Commerce registration. Users can register and login to your site with their social networks, which the site will manage as conventional Oracle Commerce user accounts.

  2. Registration-as-a-Service (RaaS) – An end-to-end user management system package. This platform offers a comprehensive cloud-based user registration service that supports login by social networks while allowing sites to maintain a single user database that combines social and traditional site authentication. For additional information and advanced implementation options see Registration-as-a-Service.

Mapping Customer Profile Fields and Personalization: In both cases (RaaS & Social Login) the Gigya module supports pushing data from Gigya user fields to Oracle customer profile fields. Doing so will leverage the Oracle Commerce Personalized and Optimized Experiences. Learn more in the Mapping User Fields from Gigya to Oracle Commerce section below.

Social Plugins 

The Gigya platform includes a series of plugins that integrate your site with users' social networks and create a compelling and fulfilling user experience. These plugins have a fully configurable user interface design:

  • Share – Users can easily Share posts with their social networks friends.
  • Comments – Gigya's Comments plugin enables site users to post comments and have discussions about published content on your site.
  • Loyalty – Also known as "Gamification", this is a social loyalty and rewards platform that can be easily embedded in your website, increasing site engagement and making your users' experience more enjoyable.
  • Reactions – The Reactions plugin allows users to react to content in your site and share their reaction to social networks.
  • Rating & Reviews – The R&R plugins give your customers an easy way to provide feedback on product and content across your site, and then share that feedback with friends in their social networks.

 

Customer Insights

The Gigya module supports updating Gigya’s Customer Insights (CI) with customers' purchases. Learn more in Customer Insights Integration section below.

Version and Compatibility

Gigya Module for Oracle Commerce Version 2.1 is compatible Oracle Commerce 11 (formerly ATG).

To view the current version of your Gigya Module for Oracle Commerce, go to the /com/gigya/GlobalSettings component, and look for the "version" parameter. For more information, refer to the Global Settings below.

All code samples and cartridges were built on Oracle Commerce 11 using the Oracle Commerce Reference Store (CRS). The base code should be compatible with Oracle Commerce versions 9 and 10, however has not gone through a test cycle on those versions.

Intended Audience

This document is intended for System Integrators or Oracle Commerce customers who want to accelerate the deployment of Gigya in their Oracle Commerce environment. It is assumed that the audience for this document has a fairly good technical knowledge of Oracle Commerce, Endeca Experience Manager, and Gigya.

Module Installation and Build Instructions

This section describes the flow required to install the Gigya Module for Oracle Commerce.

Prerequisites

The following prerequisites must be met to enable a successful integration.

  1. The Oracle Commerce application must be installed.
  2. Optional: Endeca Application setup is required for Endeca cartridges. Refer to Oracle Commerce documentation to create and configure the Endeca application with the Oracle Commerce web application. You may also refer to the Oracle-Endeca Integration guide.

Installation

  • Download the Gigya module: GigyaModuleForOracleCommerce-v2.1.zip. This is an Oracle Commerce source code package that includes components, JSP files, DB scripts, Properties files, and Java files implementing Gigya module for Oracle Commerce 11.0.
  • Extract the content of this package. Copy /modules/Gigya/Gigya into the Oracle Commerce installation base directory parallel to other modules.


The component is available as an Oracle Commerce module in the namespace Gigya.

  • Gigya Setup:

    1. Create an account on Gigya's website.

    2. Configure your site details in the Site settings section of the Gigya website. The Gigya Setup page provides detailed instructions and steps for setting up your site, as well as specific directions for setting up applications in Facebook, Twitter, Yahoo, LinkedIn, Google and Microsoft. Administrators can either set up applications on the social networks or have Gigya provide these applications for your site.

    3. Copy the Gigya API Key and the Secret Key from Gigya's Dashboard page:

      To view the Secret key click the Show Secret key link next to your Partner ID at the bottom of the site list.

  • The Keys must be set in the following Oracle Commerce Gigya component: /com/gigya/GlobalSettings. For more information, refer to the Global Settings section below.

  • Browse to this directory and run the build.xml as ant build. This will build your Gigya module. Once, a successful ant build is performed then the project will have working code which we can deployed.

  • Run the following SQL script to create a new column to support the Gigya implementation. This implementation used the CRS module. This is to extend the user profile to add a new property to hold the Gigya UID. This can be placed in your own custom user table or in the core table. You will have to change the provided \config\atg\userprofiling\userProfile.xml repository definition file to match the table you want to add this column to. Do not change the property name.

DDL to execute:

Repository Definition:

ALTER TABLE CRS_USER ADD GIGYA_UID VARCHAR2(200);

Repository Definition:

<item-descriptor name="user">
 <table name="crs_user" type="auxiliary" id-column-name="user_id">
 <property name="gigyaUID" column-name="GIGYA_UID" data-type="string" display-name="uid" xml-combine="append"/>
 </table>
 </item-descriptor>
  • Incorporate this module into the custom application build process so it is included, typically using the “runAssembler” command line arguments.

  • Endeca Cartridges are available in /modules/Gigya/Storefront/endeca/cartridges. Copy it to /config/cartridge_templates/

  • Run the set_template [sh|bat] from /control/ folder to set the new templates.

Next Steps

Based on your Gigya acquired package:

Customer Identity Management Integration

Gigya provides two main Customer Identity Management packages:

  • Social Login – This option enables Gigya's social login, allowing users to login to your site using their social networks. User management is handled by Oracle Commerce.
  • Registration-as-a-Service – Gigya's end-to-end user management system package replacing and overriding the Oracle Commerce user management system.

The specific integration and configuration associated with each option is detailed below.

Social Login

The Gigya Module implements Social Login integration with Oracle Commerce based on the best practices and flows detailed in Gigya's Social Login implementation Guide.

Implementation details

  • After a successful execution of Social Login, the response from Gigya is available in a session scoped component /com/gigya/util/GigyaModalMonitor, that can also be accessed later from other parts of the application.
  • After a successful execution of Social Login. The response from Gigya will be available in userObj, which will have all the information about the user such as UID (Gigya’s user ID), email etc. Based on this userObj an Oracle Commerce (ATG) profile will be created.

  • Some of the key components which are used for Social Login are:

    • /atg/userprofiling/GigyaProfileFormHandler – This component extends Oracle Commerce out of the box (OOTB). ProfileFormHandler to include Gigya Specific behavior for login, logout and registration process. Some of the other methods included inside GigyaProfileFormHandler are:
      • UpdateJsonToProfile – Updates the json Object to Profile.
      • handleSocialLogin – Handles the Social/RaaS Login process
      • handleLinkAccount – Handles the Link Account process for Social Network Logins
      • updatePropertiesJSONToProfile – Update the properties from JSON object and puts into the profile
    • /com/gigya/GigyaSocialntegratorDroplet – This Droplet is responsible for getting all the user information from userObject by calling /com/gigya/GigyaService, checks for valid UID (user identification number) by calling GigyaService Component and also invokes /atg/userprofiling/GigyaProfileFormHandler to check if the Oracle Commerce user exist or not. This droplet also checks for the requiredFields for creating Oracle Commerce user profile.
    • /com/gigya/GigyaServiceImpl – This is a service component which has all the configurable attributes which are required for Gigya functionality implementation like Social Login, Sharing, Reaction and other plugins. This Component also gets the User object from Gigya API call.
    • /com/integration/gigya/droplet/GigyaGetRequiredFieldsDroplet – This component is used for getting the required fields for Oracle Commerce profile in order to prompt the user for required input when registering an account.
    • /com/integration/gigya/util/GigyaUtils – This component contains all the utility methods related to Gigya module.
    • /com/integration/gigya/util/GigyaConstants – This Component contains all the constant attributes which are used in Gigya module.

Integration Steps

Below are the steps to be followed to integrate Social Login with your implementation:

  1. Modify/Extend your Login Form Handler and Registration Form Handler to use the provided class com.gigya.integrations.gigya.GigyaProfileFormHandler
  2. Make sure the component /atg/userprofiling/GigyaProfileFormHandler is configured to point to your custom components for user security, Profile and ProfileTools. It references base OOTB classes, so if those are overridden by your implementation, the property values may need to be modified.
  3. On the login page, include the following JSP page fragment at the beginning of the page:
    /Storefront/j2ee/store.war/gigya/common/gigyaHead.jspf
    T his fragment includes basic properties to connect and configure Gigya.
  4. Add the Gigya's login UI by including the JSP page fragment below in the login section where you accept login name and password. Refer the below JSP for more details. It includes basic functionalities required to integrate Gigya with Oracle Commerce application.
    /Storefront/j2ee/store.war/gigya/social/common/header.jsp
  5. Configuration:
    • In the /com/gigya/UserManagementRaaS component – make sure that the raasEnabled attribute is set to false. Make sure that RaaS is disabled for your site on Gigya admin console as well. You may verify with your Gigya Account Manager.
    • You may configure your Social Login implementation in the /com/gigya/UserManagementSocial component. See more information below.
  6. Optional: Map User Fields from Gigya to Oracle Commerce.

Registration-as-a-Service

Registration-as-a-Service (RaaS) is Gigya's end-to-end user management system package and the Gigya Module for Oracle Commerce supports all of its features.
Note that when RaaS is applied in Oracle Commerce, it replaces and overrides the Oracle Commerce user management system.

Implementation details

Some of the key components which are used for RaaS are:

  • /atg/userprofiling/GigyaProfileFormHandler – This component extends Oracle Commerce out of the box ProfileFormHandler to include Gigya Specific behavior for login, logout and registration process. Some of the other methods included inside GigyaProfileFormHandler are:
    • UpdateJsonToProfile – Updates the JSON Object to Profile.
    • handleSocialLogin – Handles the Social/RaaS Login process
    • handleLinkAccount – Handles the Link Account process for Social Network Logins
    • updatePropertiesJSONToProfile – Update the properties from JSON object and puts into the profile
  • /com/integration/gigya/droplet/GigyaRaasIntegratorDroplet – This component contains the following methods:
    • createORLogin – Creates or Updates the user account
    • copyParamsFromRequest – Get all the account Object information from the request.
  • /com/integration/gigya/droplet/GigyaRegistrationDroplet – This Component is used for getting the registration fields from Gigya Registration Form. Also performs the methods like:
    • createUserInATG – Checks and creates user in Oracle Commerce
    • checkforErrors – Checks for any errors in userObject
    • Does the GigyaRegistration process for Gigya registration form.
  • /com/integration/gigya/util/GigyaUtils – This Component contains all the utility methods related to Gigya.
  • /com/integration/gigya/util/GigyaConstants – This Component contains all the constant attributes which are used in Gigya

Integration Steps

Below are the steps to be followed to integrate RaaS with your implementation:

Migrating User Data:

If you are already using Oracle Commerce user management you will need to migrate your Oracle Commerce user DB to RaaS. Contact your Gigya Account Manager to perform this migration.

Gigya Configuration:

  1. Enable RaaS – RaaS is a premium package that requires separate activation. If it is not part of your site package contact your Gigya Account Manager.
  2. Set Email to be your sites unique login identifier – Email must be the site's unique Login Identifier (an Oracle Commerce requirement), to set this log into the Gigya Admin Console, go to the Settings page for your site, select Registration-as-a-Service and then Policies or click here. Then set the Login Identifier to "Email" (for more information on this setting see here).
  3. Remove the "Create new account" link from the "Link Account" screen:

    • Log into the Gigya Admin Console and go to the Screen-sets page.
    • Locate the "Default-LinkAccounts" screen-set and click its "UI Builder" link.
    • In the UI Builder window's "Screens" list (on the left), select the "Link Account" screen.
    • Locate the "To create new account, click here" at the bottom of the screen (see sceenshot), and erase it, by clicking the "X" next to it.
    • Hit the "Save" Button
    • Repeat steps 2-5 with the "DefaultMobile-LinkAccounts" screen.

    Since Oracle Commerce requires unique email per account, this link would lead to an error, because it allows creating a second account with the same email.

  4. Optional – define list of registration required fields: the "requiredFields" attribute (refer to attribute below) defines required registration fields in Oracle Commerce. The OOTB default value of the requiredFields is " email=email ", me aning that only "email" field is required by Oracle Commerce in the registration flow. You may add required fields, but always make sure that the list of required fields are synced between Oracle Commerce and RaaS, otherwise the registration flow wouldn't work properly. "email" field must remain required in both syste m s.
    To define the required fields in the RaaS registration screens – use the UI Builder, add the fields to the registration screen (if are not yet there) and check the "required" property for the corresponding fields.

Oracle Commerce Configuration

  1. Include the following page from the module into the page(s) where you want to display the RaaS screensets:
    \Storefront\j2ee\store.war\gigya\raas\common\header.jsp
  2. Configuration:
    In the /com/gigya/UserManagementRaaS compone nt (refer to RaaS configuration options section for more details and properties definition):
    • Make sure that the raasEnabled attribute is set to true.
    • Make sure that the screen-set IDs defined in /com/gigya/UserManagementRaaS match the IDs defined in the Screen-sets page of Gigya Admin Console. Note: The predefined default screen-set IDs defined in the /com/gigya/UserManagementRaaS were updated on September 2014. If your site was defined beforehand, there may be earlier screen-set versions configured on your site, and so the mismatch will prevent loading the screen-sets in your site. You should either Upgrade to the New Screen-set Collections, or change the screen-set IDs defined in /com/gigya/UserManagementRaaS.
  3. Optional: Map User Fields from Gigya to Oracle Commerce.

Deleting/Editing Site Users

Implementations of Oracle Commerce typically does not support the deletion of users. There is no way OOTB for a user to remove themselves from the system. Oracle Commerce BCC does have a user management where deletion of user can be performed but it is not recommended as it could have downstream impacts to users. If you need to have the functionality to delete users, you will have to modify the BCC tool-set to incorporate the Gigya API calls to remove the users from the Gigya system or write your own custom page to implement those APIs for user removal. This functionality is not supplied by this module.

In addition – if admin adds/edits a user through the Oracle Commerce BCC , these changes are not synched with the Gigya storage.

Plugins Integration

To implement plugins on the site, you can either use the provided sample JSP code and incorporate it on your site. Or you can leverage the provided Endeca cartridges if using Endeca experience manager. For any page implementing a Gigya plugin, the following steps need to be performed. Detailed information for each plugin are defined below.

JSP Implementation of a Plugin:

  1. Configure the Global Settings for your site in the /com/gigya/GlobalSettings Oracle Commerce component. See Global Settings for property details
  2. Include the JSP page fragment called /Storefront/j2ee/store.war/gigya/common/gigyaHead.jspf on every page where the plugin is to be displayed.
  3. Configure the component for the plugin as defined for each specific plugin (see specific plugins below for location of the component configuration file)
  4. Include the JSP code samples from the sample store implementation located in the Storefront codebase. (see specific plugins below for location of the JSP code samples)

Endeca Cartridge Implementation of Plugin:

The Endeca cartridges available for implementing on a site are located in the module directory:
/modules/Gigya/Storefront/endeca/cartridges/.

These cartridges can be used instead of the Oracle Commerce components and sample JSP files. By default some cartridges have been leveraged based on functionality and source of page. By default Endeca cartridges are leveraged in browse and shop pages and normal views are used in checkout.

The current implementation of cartridges is based on a generic design and can be extended if needed.

Share Integration

The Share feature has two types of functionalities:

  1. Sharing of product/order via the Share Bar plugin. The following screenshot shows the Share Bar on Product Detail Page on the CRS store:
  2. Action sharing of an order, or when adding to the cart (event-triggered Share). The following screenshot shows the event-triggered Share:

Share Bar Integration Steps using JSP Code Samples

  1. Include the following page from the module into the page(s) you want to display the Share Bar Plugin:
    \Storefront\j2ee\store.war\gigya\plugins\sharebar.jsp
  2. Configure the Share Bar Plugin by modifying the \com\ gigya\plugins\Sharebar component. Refer to Share Bar plugin configuration section for more details and properties definition.

Share Action Integration Steps using JSP Code Samples

  1. The following page from the module implements the Share Action Plug-in:
    \Storefront\j2ee\store.war\CRS\browse\gadgets\pickerAddToCart.jspf
    pickerAddToCart.jspf is the file from the CRS store that implements the "Add to Cart" functionality.
    We have added the following functionality to pickerAddToCart.jspf – invoke a Share Action when a user adds a product to the cart.
    You can use the pickerAddToCart.js pf file or copy the functionality to your own pages.
  2. Configure the Share Action by modifying the \com\ gigya\plugins\ShareUI component. Refer to the Share Action plugin configuration section for more details and properties definition.

Integration Steps using Endeca Cartridges

  1. Create a Content Collection in Experience Manager of type "MainContent" and include the GigyaShareBar cartridge.
  2. Cartridge configuration can be changed in Endeca Experience Manager, as shown below:

    The cartridge configuration allows you to configure similar set of properties which are available in the regular Oracle Commerce component as described in Share Bar plugin configuration section.
  3. Use Oracle Commerce OOTB InvokeAssembler droplet in Item detail page to include GigyaShareBar plugin.
    For more information, refer to the Oracle ATG-Endeca Integration guide.

Rating & Reviews Integration

The Gigya Rating & Reviews plugins gives your customers an easy way to provide feedback on products and content across your site, and then share that feedback with friends in their social networks. We suggest placing the Rating & Reviews plugins on product detail page. The Rating & Reviews platform includes two plugins:

The Rating Plugin:

The Reviews Plugin:

The Reviews plugin is actually the Comments plugin in a 'Rating & Reviews' operation mode.

Before integrating the Rating & Reviews plugins in your Oracle Commerce store, make sure sure that Ratings and Reviews are part of your Gigya package and enabled for your site. In addition make sure to Set up a new Comment category on Gigya admin console

Integration Steps using JSP Code Samples

  1. Configure the Rating plugin by modifying the \com\ gigya\plugins\ RatingsReviews component.
    Make sure to set the following attributes:
    – Set the enabled attribute to "true".
    – Set the containerId attribute with the ID of an element on the page in which you want to display the Ratings plugin.
    – Set the categoryID attribute wit h the identifier of the Comments Category you have set-up for your site on Gigya's admin console. Refer to the Rating & Reviews Plugins configuration section for more details and properties definition.
  2. Configure the Review (Comments) plugin by modifying the /com/gigya/plugins/ Comments component.
    Make sure to set the following attributes:
    – Set the enabled attribute to "true".
    – Set the containerId attribute with the ID of an element on the page in which you want to display the Reviews plugin.
    – Set the categoryID attribute wit h the identifier of the Comments Category you have set-up for your site on Gigya's admin console (same ID as in the Ratings plugin above). Refer to the Comments Plugin configuration section for more details and properties definition.
  3. Include the following page from the module into the page(s) you want to display the Rating & Reviews plugin s:

\Storefront\j2ee\store.war\gigya\plugins\ reviewbar.jsp

Integration Steps using Endeca Cartridges

Create a Content Collection in Experience Manager of type "MainContent" and include the RatingAndReview cartridge. Cartridge configuration can be changed in Endeca Experience Manager, as shown below:

Cartridge configuration allows you to configure similar set of properties which are available in the regular Oracle Commerce component as described in the Rating & Reviews Plugins configuration section and the Comments Plugin configuration section. Use Oracle Commerce OOTB InvokeAssembler droplet in Item detail page to include RatingAndReview plugin. Refer to the Oracle ATG-Endeca Integration guide.

Comments Integration

The Gigya Comments plugin enables site users to post comments and have discussions about published content on the site, and then share that feedback with friends in their social networks.

Before integrating the Comments plugin in your Oracle Commerce store, make sure sure that Comments feature is part of your Gigya package and enabled for your site. In addition make sure to Set up a new Comment category on Gigya admin console.

Integration Steps using JSP Code Samples

Configure the Comments plugin by modifying the /com/gigya/plugins/ Comments component.
make sure to set the following attributes:
– Set the enabled attribute to "true".
– Set the containerId attribute with the ID of a <div> element on the page in which you want to display the Comments plugin.
– Set the categoryID attribute wit h the identifier of the Comments Category you have set-up for your site on Gigya's admin console. Refer to the Comments Plugin section for more details and properties definition. Include the following page from the module into the page(s) you want to display the Rating & Reviews plugins:
\Storefront\j2ee\store.war\gigya\plugins\ reviewbar.jsp

Integration Steps using Endeca Cartridges

Create a Content Collection in Experience Manager of type "MainContent" and include the RatingAndReview cartridge. Cartridge configuration can be changed in Endeca Experience Manager, as shown below:

Cartridge configuration allows you to configure similar set of properties which are available in the regular Oracle Commerce component as described in Comments Plugin configuration section. Use Oracle Commerce OOTB InvokeAssembler droplet in Item detail page to include RatingAndReview plugin. Refer to the Oracle ATG-Endeca Integration guide.

Gamification Integration

Gigya Loyalty - Gamification and User Behavior (also referred to as Game Mechanics or GM) is a social loyalty and rewards platform that you can embed in your website, increasing site engagement and making your users' experience more enjoyable. We suggest for the best user experience that the Gamification plugins be integrated into the user profile page.

Before integrating the Gamification plugins in your Oracle Commerce store, make sure sure that Gamification feature is part of your Gigya package and enabled for your site. In addition make sure to Setting up Your GM Console.

Integration Steps using JSP Code Samples

Configure the Gamification plugins by modifying the /com/gigya/plugins/Gamification component.
make sure to set the following attributes:
– Set the enabled attribute to "true".
– Set the userStatusId, challengeStatusId, achievmentsId, leaderboardId attributes with the IDs of the respective elements on the page in which you want to display the Gamification plugins. Refer to the Gamification plugins configuration section for more details and properties definition. Include the following page from the module into the page(s) you want to display the Gamification plugins:
\Storefront\j2ee\store.war\gigya\plugins\ gamification.jsp

Reactions Bar Integration

The Gigya Reactions plugin enables users to share their reactions to your products with their social networks. This plugin displays a set of buttons that are fully configurable. We suggest placing the Reactions plugin prominently below the products. The following is a screen shot illustration of the reaction plugin with retail domain in context:

Integration Steps using JSP Code Samples

Configure the Reactions Bar Plugin by modifying the \com\ gigya\plugins\Reactionbar component. Refer to Reaction Bar plugin configuration section for more details and properties definition. Include the following page from the module into the page(s) you want to display the Reactions Bar Plug-in:
\Storefront\j2ee\store.war\gigya\plugins\reactions.jsp

Integration Steps using Endeca Cartridges

Create a Content Collection in Experience Manager of type "MainContent" and include the ReactionBar cartridge. Cartridge configuration can be changed in Endeca Experience Manager, as shown below:



Cartridge configuration allows you to configure similar set of properties which are available in the regular Oracle Commerce component as described in Reaction Bar plugin configuration section. Use Oracle Commerce OOTB InvokeAssembler droplet in Item detail page to include the Reaction Bar plugin. Refer to the Oracle ATG-Endeca Integration guide.

Activity Feed Integration

The Activity Feed plugin has been deprecated. If you are using the Activity Feed in your implementation, disable/remove it to avoid errors.

 

Follow Bar Integration

Gigya has deprecated the Follow Bar add-on. If you are using the Follow Bar in any of your sites, please remove it to avoid errors.

Note that disabling the Follow Bar in the Oracle admin console will only disable it until the next server restart.

To remove the Follow Bar permanently, do the following:

  1. After logging in via the admin console, navigate to /com/gigya/plugins/FollowBar and change the enabled flag to false.
  2. Navigate to /Gigya/Gigya/config/com/gigya/plugins/FollowBar.properties and change the enabled value to false.
  3. Run a build.


Customer Insights Integration

Gigya’s Customer Insights (CI) is a powerful social media analytical tool, which uses social data stored by Gigya to generate insights into your users' demographics, interests, social behavior, influence and revenue-generating activity.The Gigya module supports updating CI with customers' purchases. We implement an onPurchase event which notifies Gigya of every purchase on your site. The purchases data will show under the Revenue Activity tab.

Integration Steps: CI is a premium service requiring activation. If it is not part of your site package contact your Gigya Account Manager or fill in a support form on our site.

If CI is not part of your Gigya package, the " On Purchaseevent" method will return an "Unauthorized_partner" error with message: "Counters is disabled". Site admin can enable/disable the onPurchase event feature through the module configuration component /com/gigya/GlobalSettings. make sure to enable the feature. Refer to the Global Settings section for more details. The following page from the module implements the onPurchase event: \Storefront\j2ee\store.war\gigya\plugins\purchaseEvent.jsp

Call the purchaseEvent.jsp inside \Storefront\j2ee\store.war\ \CRS\browse\gadgets\pickerAddToCart.jspf for invoking onPurchase event during Purchase.

Gigya Module Configuration

The Gigya module has several configuration files for controlling various parameters for the overall implementation as well as specific configurations for Customer Identity Management and Social Plugins. Below are the Oracle Commerce (ATG) components and definitions of the properties that can be configured.All the attributes can be co nfigured through the Oracle Commerce Dynamo Administration Console, but should be set in your source code.

Global Settings

The component /com/gigya/GlobalSettings is the main component which is responsible for storing the basic configurations of the Gigya integration on your Oracle Commerce site.
Some of the attributes in these settings (such as Gigya API key and enabledProviders) are parallel to those in the global conf object. Moreover, it is possible to manually set any Global Conf object field through the additionalParameters attribute.

The following specifies the attributes in GlobalSettings (note the required parameters):

FieldDefaultDescription
version2.0(Non editable) The current version number of the Gigya module.
apiKey(no default)
Require
Paste the Gigya API Key for your site domain that was generated for you on the Gigya console. For more information refer to the Gigya Setup section above.
secretKey(no default)
Required
Paste the Gigya Secret Key that was generated for you on the Gigya console. For more information refer to the Gigya Setup section above.
siteName(no default)
Required
A valid domain should be entered in the form of "mysite.com". No need to include the “http://” protocol.
languageenGigya supports localization. The default language is English (en). You may change the language by assigning this attribute with an alternative language code. Refer to the language support page for the list of supported languages and codes.
enabledProviders*The default * setting specifies all availa ble social networks. Otherwise type a com ma-separated list of socia l netw orks that you want to include. The list of supported providers:
facebook, twitter, yahoo, messenger, googleplus, linkedin, aol, foursquare, instagramrenren, qq, sina, vkontakte, blogger, wordpress, paypal, paypaloauth, amazon, netlog, orangefrance, mixi, yahoojapan, odnoklassnikispiceworks, livedoor, vznet, wechat, xing, line.
dataCenterUSThe location of the data center associated with your Gigya account. The options are "US" (default), "EU", or "AU".
shortURLnever
Using this parameter you may determine whether to use Gigya's URL shortening service for URLs passed in the status parameter. The optional values for this parameter are:
  • 'always' (default): always try to shorten URLs. Where providers permit, URLs are shortened based on the Data Center you are using:
    • fw.to for users of the US data center.
    • shr.gs for users of the European data center.
    • vst.to for users of the Australian data center.
    • socli.ru for users of the Russian data center.
    • s.gigya-api.cn for users of the Chinese data center.
  • 'whenRequired': URLs longer than 139 characters are shortened in accordance with provider preferences.
  • 'never' - never shorten URLs. Where providers permit, URLs are left untouched.

To determine your data center see Finding Your Data Center.


URL shortening requirements vary between providers and depend on the particular type of action and its content. URL shortening is available for the following providers:

ProviderNote
FacebookN/A
TwitterN/A
LinkedInShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
MicrosoftNot for share. (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used).
DeliciousShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
WhatsAppOnly on mobile.
RedditN/A
GooglePlusN/A
Google BookmarksN/A
VKontakteN/A
nk.plN/A
XingN/A
TuentiN/A
HatenaN/A
PinterestShortened URL is posted to the social network but traffic reports show abbreviated URL (e.g., http://developers.gigya.com/display/GD/showShareBarUI+JS is abbreviated to developers.gigya.com).
BaiduN/A
FriendFeedN/A
TumblrN/A
SinaN/A
mixiN/A

When Gigya's URL shortening service is active, Gigya tracks all the traffic coming from the distributed URLs. In such case, 'Referred Traffic' reports will be available to you.

 

sessionExpiration0This parameter defines the time in seconds that Gigya should keep the login session valid for the user. The default value is 0, which means that the session ends when the browser closes. For the session to be valid forever, the value should be set to "-2".
purchaseEventEnabledtrueThe onPurchase event feature is used to track customer purchases and notify Gigya. You can enable/disable purchases notifications by assigning this attribute with 'true' or 'false' value.
connectWithoutLoginBehavior (Deprecated)loginExistingUser

For users not logged into the site, this field determines login requirements for performing a Gigya social action (for example, sharing, reacting, or commenting).Always login – before proceeding with the Gigya social action, users are first directed to site login.Login existing user (Default) – social actions are allowed with no requirement to log into the site. Behind the scenes, the following happens when such users successfully access one or more social networks:

  • Registered site users are automatically logged into the site.
  • Other users are logged into the site as temporary users.
additionalParameters(no default)This attribute enables you to specify configuration options beyond those available in the fields above. You may enter par ameters in the following format: “key1: value1 ,key2:value2,...keyN:valueN”. For the list of available configuration options, refer to the Global Conf page.
Note: the parameters defined using additionalParameters override existing configurations, and m ust be used carefully. For example: if you set additionalParameters=lang:'zh-hk' this would override the language attribute specified above.

Mapping User Fields from Gigya to Oracle Commerce

The Gigya module supports pushing data from Gigya user fields to Oracle Commerce (ATG) customer profile fields.

Once mapped, the Oracle Commerce fields will be populated and updated from the corresponding Gigya fields each time the user registers/logs-in.The /com/gigya/GigyaService component is responsible for mapping Gigya user fields with Oracle Commerce customer fields. If your system is configured to work with Registration-as-a-Service then the mapping will be between the Gigya Profile fields and Oracle Commerce profile fields.

Otherwise (your system is configured to work with Social Login) the mapping will be between the Gigya User fields and Oracle Commerce profile fields. The following table specifies the attributes in GigyaService:

FieldDefaultDescription
fieldMappingfirstName=firstName,
lastName=lastName,
email=email,
login=email,
gender=gender,
postalCode=zip
This attribute defines the mapping between Gigya User/Profile fields and Oracle Commerce (ATG) profile fields. The format is: ATG-field1=Gigya-field1, ATG-field2=Gigya-field2 ,...
For example (also the default value): astName=lastName, postalCode=zip, email=email, gender=gender, login=email, firstName=firstName
Gigya fields: if your system is configured to work with RaaS, the Gigya fields will be taken from the Profile object (e.g. profile.zip), otherwise the Gigya fields are taken from the User object (e.g. user.zip)
customPropertyMapping(no default)This attribute defines the mapping between RaaS custom data fields (see "data" in the response of accounts.getAccountInfo ) and Oracle Commerce profile fields.
The format is: ATG-field1=Gigya-field1, ATG-field2=Gigya-field2 ,...
requiredFieldsemail=emailThis defines which user fields should be required from the user by Oracle Commerce in the registration process.If implementing Social Login (RaaS disabled) – the fields that are defined in this attribute will be automatically required from the user in the registration process. If the user will not provide one or more of these fields the registration process will fail.If implementing RaaS (RaaS enabled) – make sure to add the required fields (the fields that are defined in this attribute) to the RaaS registration screens using the UI Builder. By default Oracle Commerce requires only the ‘email’ field.

Social Login

The component /com/gigya/UserManagementSocial contains the configuration settings for the Social Login feature. The following table specifies the attributes in UserManagementSocial:

FieldDefaultDescription
enableProviders*A comma delimited list of login providers that should be displayed on the Social Login plugin. The default * setting specifies all supported providers. For example, if you would like the plugin to show only the icons of Facebook and Twitter, define: enabledProviders:"facebook,twitter". The list of supported providers:
facebook, twitter, yahoo, messenger, googleplus, linkedin, aol, foursquare, instagramrenren, qq, sina, vkontakte, blogger, wordpress, paypal, paypaloauth, amazon, netlog, orangefrance, mixi, yahoojapan, odnoklassnikispiceworks, livedoor, vznet, wechat, xing, line.
redirectURLHome/index.jspSet this parameter with a URL to which to redirect the user when they log-in to the site using their social identity. By default, the user will be redirected to the home page. I f this attribute remains empty – the page from which login process started will be refreshed.
redirectURLShipping/checkout/shipping.jspSet this parameter with a URL to which to redirect the user when they log-in to the site during checkout using their social identity. By default, the user will be redirected to the Shipping Page. If this attribute remains empty – the page from which login process started will be refreshed.
buttonStylefullLogoColoredThis parameter enables selecting one of the pre-defined design styles for the network buttons on the Social Login plugin. Currently Gigya offers the following design styles:
  • standard
  • fullLogo
  • fullLogoColored (default)
  • signInWith
sHeight180Determines the height of Social Login Plugin.
sWidth310Determines the width of Social Login Plugin.
showTermsLinkfalseDetermines whether to shows or hide the “Terms” link that opens the Gigya’s Legal Notices page.
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above. You may enter par ameters in the following format: “key1: value1 ,key2:value2,...keyN:valueN”. For the list of available configuration options, refer to the socialize.showLoginUI page.
Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.

Registration-as-a-Service

The component /com/gigya/ UserManagementRaaS contains the configuration settings for the Registration-as-a-Service (RaaS) fearure.The following table specifies the attributes in UserManagementRaaS.

Make sure that the screen-set IDs defined in your integration's settings match the screen-set IDs defined for your site in the Screen-Sets page in the Gigya console.

  • If your Gigya RaaS was set up in the Gigya Console after 10/26/2015, it is using new default screen-set names, which do not match the screen-set names used by this integration out-of-the-box. To set up your integration to use the correct screen-sets names, go to your integration settings and select Registration-as-a-Service settings. In the screen-set IDs table, copy the ID of every Web Screen-Set into the matching Mobile Screen-Set. For example, in the integration's default settings, the Registration/Login screen-sets are set to Default-RegistrationLogin and DefaultMobile-RegistrationLogin, for web and mobile, respectively. They should both say Default-RegistrationLogin.
  • If your site was set up in the Gigya console before September 2014, it will be using older screen-set names.

See Default Screen-Sets for more information.

FieldDefaultDescription
raasEnabledfalseSet to true to enable RaaS; set to false to disable RaaS and activate Social Login instead. Learn more in Customer Identity Management Integration section.
registrationScreensetDefault-Registration Login

The name of a web-ready screen-set that managers user login and registration.

profileUpdateScreensetDefault-ProfileUpdate

Name of a web screen-set containing the screens used in entering user profile details.

registrationScreensetMobileDefaultMobile-RegistrationLogin

Name of a mobile screen-set containing the screens used in managing user login and registration.

profileUpdateScreensetMobileDefaultMobile-ProfileUpdate

Name of a mobile screen-set containing the screens used in entering user profile details.

redirectURLHomeNo valueThis attribute defines where the users will be redirected to once they have successfully logged in to the site.
You can enter any URL, or leave the field empty. By default, if this attribute is empty – the page from which login process started will reload after the user logs in.

Share Bar plugin

The component /com/gigya/plugins/ Sharebar contains the configuration settings for the Share Bar plugin (see installation instructions under Share Integration).The following table specifies the attributes in Sharebar:

FieldDefaultDescription
enabledfalseEnable/Disable the plugin. Set this attribute with true value, to show the Share Bar on the respective pages.
containerId(no default)An ID of a <div> element on the page in which you want to display the plugin.
shareButtonsshare, email, twitter-tweet, google-plusone, facebook-likeAn array of ShareButton objects or a comma-separated list of providers, representing the buttons to display in the share bar. When passing a comma-separated list, the plugin behaves as if an array of ShareButton objects was passed, where the only value in each object is th e prov id er name. You may find the complete list of valid provider and more info in socialize.showShareBarUI – shareButtons parameter.
layouthorizontalSets the arrangement of buttons in the bar. May be horizontal (default) or vertical.
showCountsrightThis attribute determines if and where to display the share counts in relation to the share button. The options are:'right' (default)'top''none'
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above. You may enter parameters in the following format: “key1:value1,key2:value2,...keyN:valueN”. For the list of available configuration options, refer to the socialize.showShareBarUI page.
Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.

Share Action plugin

The component /com/gigya/plugins/ ShareUI contains the configuration settings for the Share plugin (see installation instructions under Share Integration). The following table specifies the attributes in ShareUI:

FieldDefaultDescription
enabledfalseEnable/Disable the plugin. Set this attribute with true value, to show the Share on the respective pages.
enabledProvidersfacebook,twitter, linkedin,myspace, yahooA comma delimited list of providers that should be displayed on this plugin, when in multiple selection mode (in Simple Share mode, the providers that are displayed are listed in moreEnabledProviders ). Valid provider names include: 'facebook', 'twitter', 'linkedin', 'qq', 'renren', 'sina', 'vknotakte'*.
For example, if y ou would like this plugin to show only the icons of Facebook and Twitter, define: enabledProviders: "facebook,twitter".
Note: the Share plugin may show up to six social network buttons on its main screen (more social destinations may be shown in the "More" screen).
moreEnabledProviders*
(all providers)
Using this parameter you may define which destination sites buttons will be displayed on the "More" screen, and also determine the order. In Simple Share mode, these are the providers that are displayed (not the enabledProviders ). Each parameter is set with a comma separated string of destination names. Valid destinations for the "More" screen include:
amazon, aolmail, baidu, bitly, blinklist, boxnet, currenttv, delicious, diigo, douban, dropjack, evernote, facebook, fark, faves, formspring, friendfeed, gmail, googlebookmarks, googleplus, hatena, kaboodle, linkagogo, linkedin, microsoft, mixi, mixx, myaol, netlog, newsvine, nkpl, odnoklassniki, pinterest, plaxo, qq, reddit, renren, segnalo, sina, skimbit, spiceworks, stumbleupon, technorati, tuenti, tumblr, twitter, viadeo, vkontakte, whatsapp, xing, yardbarker (Note: messenger has been replaced by microsoft, however, for backward compatibility, either can be used). 
To learn more about this feature, read about Adding More Destinations. Note: In addition to the above automatic destinations, Gigya supports 150 more destinations. These destinations should be explicitly requested. Contact us by filling in a support form on our site. Check out the list of additional destinations here.
showAlwaysSharefalseThis attribute determines whether to show an "Always share" checkbox at the bottom of the Share Plugin. If the user checks this checkbox and presses "Publish", Gigya will turn on an automatic share for this user. To learn more about this feature, read the Automatic Sharing guide.
showNeverSharetrueThis attribute determines whether to show a "Never share" link at the bottom of the Share plugin. If the user clicks this link, the Share plugin will close and Gigya will never prompt the Share plugin when this user repeats the same type of action. To learn more about this feature, read the Automatic Sharing guide.
scopeboth

Deprecated

privacyprivateDeprecated
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above. You may enter parameters in the following format: “key1:value1,key2:value2,...keyN:valueN”. For the list of available configuration options, refer to the socialize.showShareUI page.
Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.

Rating & Reviews Plugins

The component /com/gigya/plugins/ RatingsReviews contains the configuration settings for the Rating & Reviews plugins.The following table specifies the attributes in RatingsReviews:

FieldDefaultDescription
enabledfalseEnable/Disable the plugin. Set this attribute with true value, to show the R&R on the respective pages.
containerId(no default)An ID of a <div> element on the page in which you want to display the plugin.
categoryID(no default)The identifier of the Comments Category with which this plugin is associated.
Before embedding a Comments plugin in your site, you are required to Setting up a new Comment category on Gigya's website. When creating a new comment category, define a 'Category Name', and make sure to select 'Operation mode: Rating & Reviews'. Copy the ' Category N a me' you have defined as the value of this attribute.
scopeboth

Deprecated

privacyprivateDeprecated
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above. You may enter parameters in the following format: “key1:value1,key2:value2,...keyN:valueN”. For the list of available configuration options, refer to the comments.showCommentsUI page.
Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.

Comments Plugin

The component /com/gigya/plugins/ Comments contains the configuration settings for the Comments plugin.The following table specifies the attributes in Comments:

FieldDefaultDescription
enabledfalseEnable/Disable the plugin. Set this attribute with true value, to show the Comments on the respective pages.
containerId(no default)An ID of a <div> element on the page in which you want to display the plugin.
categoryID(no default)The identifier of the Comments Category with which this plugin is associated.
Before embedding a Comments plugin in your site, you are required to Setting up a new Comment category on Gigya's website. When creating a new comment category, define a 'Category Name'. Copy the ' Category N a me' you have defined as the value of this attribute.
privacyprivate

Deprecated

scopebothDeprecated
version2Gigya offers a new improved version of the comments plugin. Set version=2 (default) to use the new plugin.
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above.
You may enter parameters in the following format: “key1:value1,key2:value2,...keyN:valueN”.
For the list of available configuration options, refer to the comments.showCommentsUI page.
Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.

Gamification plugins

The component /com/gigya/plugins/Gamification contains the configuration settings for the Gamification (GM) plugins.The following table specifies the attributes in Gamification:

FieldDefaultDescription
enabledfalseEnable/Disable the plugins. Set this attribute with true value, to show the Loyalty plugins on the respective pages.
gameNotificationfalseEnable/Disable the Notifications plugin. Set this attribute with true value, to enable the Notifications plugin. The plugin is displayed as a popup window on the right hand corner of the page, and appears whenever the user unlocks a new level of any of the active challenges.
userStatusId(no default)An ID of an element on the page in which you want to display the User Status GM plugin
challengeStatusId(no default)An ID of an element on the page in which you want to display the Challenge Status GM plugin
achievmentsId(no default)An ID of an element on the page in which you want to display the Achievements GM plugin
leaderboardId(no default)An ID of an element on the page in which you want to display the Leaderboard GM plugin
period7 daysThe period for which to display the Leaderboard plugin. The valid values for this parameter are:'all' – displays the all-time highest ranking users for the specific challenge'7days' (default) – displays the highest ranking users from the past seven days for the specific challenge
totalCount12The total number of users to display in the Leaderboard plugin. The default value is 12, the maximum is 36.
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above.
You may enter parameters in the following format: “key1:value1,key2:value2,...keyN:valueN”.
For the list of available configuration options, refer to the GM plugins pages:gm.showAchievementsUI gm.showChallengeStatusUI gm.showLeaderboardUI gm.showUserStatusUI Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.

Reaction Bar plugin

The component /com/gigya/plugins/ Reactionbar contains the configuration settings for the Reactions Bar plugin.The following table specifies the attributes in Reactionbar:

FieldDefaultDescription
enabledfalseEnable/Disable the plugin. Set this attribute with true value, to show the Reactions on the respective pages.
containerId(no default)An ID of a <div> element on the page in which you want to display the plugin.
enabledProvidersfacebook,twitter,
linkedin,myspace,
yahoo
The list of providers that will be displayed on the Mini Share popup, that enables the user to share his reaction to social networks.
reactionsA set of default buttons (see description)

An array of Reaction objects, representing the buttons to display in the reactions bar. No more than ten reaction buttons can be displayed. As a default for this attribute, we provide the following set of default buttons, as an example for you edit:

[{
 text: 'Inspiring',
 ID: 'inspiring',
 iconImgUp: 'https://cdns.gigya.com/gs/i/reactions/icons/Inspiring_Icon_Up.png',
 tooltip: 'This is inspiring',
 feedMessage: 'Inspiring!',
 headerText: 'You think this is inspiring'
},{
 text: 'Innovative',
 ID: 'innovative',
 iconImgUp: 'https://cdns.gigya.com/gs/i/reactions/icons/Innovative_Icon_Up.png',
 tooltip: 'This is innovative',
 feedMessage: 'This is innovative',
 headerText: 'You think this is Innovative'
},{
 text: 'LOL',
 ID: 'lol',
 iconImgUp: 'https://cdns.gigya.com/gs/i/reactions/icons/LOL_Icon_Up.png',
 tooltip: 'LOL',
 feedMessage: 'LOL!',
 headerText: 'You LOL'
},{
 text: 'Amazing',
 ID: 'amazing',
 iconImgUp: 'https://cdns.gigya.com/gs/i/reactions/icons/Amazing_Icon_Up.png',
 tooltip: 'This is amazing',
 feedMessage: 'This is amazing!',
 headerText: 'You think this is Amazing'
},{
 text: 'Geeky',
 ID: 'geeky',
 iconImgUp: 'https://cdns.gigya.com/gs/i/reactions/icons/Geeky_Icon_Up.png',
 tooltip: 'This is geeky',
 feedMessage: 'This is geeky!',
 headerText: 'You think this is Geeky'
}]

The default buttons appear as follows:

layouthorizontalSets the arrangement of the buttons in the bar. May be horizontal (default) or vertical.
multipleReactionstrueThis attribute determines whether the user is permitted to click on multiple reaction buttons on the same reaction bar, or click on one reaction button only. If set to false, the user is allowed to click only one button, after which all other buttons are disabled. The default value is 'true' (allowing multiple reactions).
countTypenumberThis parameter determines the type of the counter. The options are:'number' (default) – the number of times the reaction was clicked'percentage' – the percentage of users who clicked on the specific reaction button out of the total clicked on all reaction buttons in the reaction bar.
showCountsrightThis attribute determines if and where to display the share counts in relation to the reaction button. The options are:'none' (default)'top''right'
scopebothDeprecated
privacyprivateDeprecated
additionalParameters This attribute enables you to specify configuration options beyond those available in the fields above. You may enter parameters in the following format: “key1:value1,key2:value2,...keyN:valueN”. For the list of available configuration options, refer to the socialize.showReactionsBarUI page.
Note: the parameters defined using additionalParameters override existing configurations, and must be used carefully.


Troubleshooting

General

  • The server clock must be set to GMT+0, otherwise errors and unexpected behaviors may occur. We recommend using NTP daemon to ensure that the server time is accurate.
  • Gigya screen-sets must entirely replace any login, registration etc. screen provided by the CMS. The CMS registration, login and edit profile screens should not be rendered at all. Otherwise, the Gigya screen is placed inside the CMS screen and both will behave unexpectedly. 
  • After changing the value of the application key, you should re-enter the application secret.

 

 

Save