Magento – Capture
Follow these steps to add the User Registration plugin to an existing Magento installation.
Warning: This plug in is only for the iFrame version of Capture, released before 11/1/2012. Contact your Janrain representative if you wish to deploy this plug in using the User Registration solution deployed after 11/2/2012.
- A configured, and deployed iFrame Capture solution. All account types are supported by this module, including the free Basic service level.
- A deployed Magento site. Versions supported: 1.7 and above.
- Registered and logged in to Magento connect marketplace.
1. Install the Capture Plugin ¶
- Sign into the Magento Connect marketplace, and navigate to the Janrain Capture plug in.
- Select the version of Magento being used, and click Get Extension Key button.
- Open the Magento control panel and navigate to System > Magento Connect > Magento Connect Manager. Under the Install New Extensions section, paste the Extension Key into the Magento Connect control panel and click the Install button.
- After the installation wizard is complete, return to the Admin Control Panel and sign out of your admin session. Note: You will need to do this before configuration to refresh the control panel.
2. Configure the Magento Plugin ¶
Sign in to Magento’s Admin Control Panel and navigate to the Configuration section under the System menu. Locate the Janrain section in the Configuration menu and click on Capture.
Select the Main tab. At a minimum, you need to enter the following information which is available in your Capture Dashboard, or in the case of the Capture Address, provided to you by your Janrain representative:
- Capture Client ID — The Client ID you wish to use with this site. You can locate this in the Capture Dashboard.
- Capture Client Secret — The Client Secret associated with the Client ID used in the previous entry.
- Capture Address — The Capture application domain. Note: do not add the http: prefix.
- Capture SSO Address — If you plan on using Federate SSO you will need to enter your Federate application domain here.
- CaptureUI Address — Leave this field blank. It’s only used for development purposes.
- Application ID — Leave this field blank. It’s only used for development purposes.
- Required Fields Screen — If a user authenticates without the necessary fields required by Magento, they will be prompted to enter these additional fields.
- Recover Password Screen — This is the name of the screen to be launched when users enter the site from a link in a password recovery email.
Field Options ¶
- Email Field — The name of the attribute that contains the user’s email address.
- First Name Field — The name of the attribute that contains the user’s first name.
- Last Name Field — The name of the attribute that contains the user’s last name.
- Match Users on Email — When set to “True” users who authenticate with Capture will check for existing users in Magento using the same email, and use this information instead of creating a new record.
- Enforce Email Verification — When set to “True” users will not be allowed to complete an authentication until the “emailVerified” attribute is populated on their user record.
- Server Base URL — The full URL path to your Backplane server.
- Bus Name — The bus name on which to listen for messages.
- JS Path — The full URL path to the backplane.js file you wish to use.
Layout Configuration ¶
By default the Janrain Capture extension will include its own authentication links in Magento’s main navigation. If you want to remove these links you can do so by editing the layout using your theme’s local.xml file. For details on how to create a local.xml file for your theme please visit Designing for Magento. Below is an example of a simple local.xml that removes the Capture Sign in link.
<?xml version="1.0"?> <layout version="0.1.0"> <customer_logged_out> <reference name="top.links"> <action method="removeLinkByUrl"><url helper="captureui/signinUrl"/></action> </reference> </customer_logged_out> </layout>
Any references to pages that require authentication to access will need to be removed or altered to initiate a Capture authentication flow rather than a native Magento login. Here is an example of how to remove the My Account and My Wishlist links from the main navigation when users are in an logged-out state:
<?xml version="1.0"?> <layout version="0.1.0"> <customer_logged_out> <reference name="wishlist_link"> <action method="setTemplate"><template>blank-link.phtml</template></action> </reference> <reference name="top.links"> <action method="removeLinkByUrl"><url helper="customer/getAccountUrl"/></action> </reference> </customer_logged_out> </layout>
Because there is no native helper to generate the wishlist URL, we’re taking advantage of a blank template to remove the link item contents. The My Account page is removed in the usual manner.
Field Mapping ¶
This list shows the mapping of Capture fields to Magento fields.
|Magento Field Name||Capture Field Name|