Ellucian Quercus Shopping Cart Installation Guide. Release August 28, 2015

Transcription

1 Ellucian Quercus Shopping Cart Installation Guide Release August 28, 2015

2 Document Information Document title Copyright Ellucian Quercus Shopping Cart Installation Guide Without limitation: Ellucian, Banner, Colleague, and Luminis are trademarks of the Ellucian group of companies that are registered in the U.S. and certain other countries; and Ellucian Advance, Ellucian Course Signals, Ellucian Degree Works, Ellucian PowerCampus, Ellucian Recruiter, Ellucian SmartCall, are also trademarks of the Ellucian group of companies. Other names may be trademarks of their respective owners Ellucian. Contains confidential and proprietary information of Ellucian and its subsidiaries. Use of these materials is limited to Ellucian licensees, and is subject to the terms and conditions of one or more written license agreements between Ellucian and the licensee in question. In preparing and providing this publication, Ellucian is not rendering legal, accounting, or other similar professional services. Ellucian makes no claims that an institution's use of this publication or the software for which it is provided will guarantee compliance with applicable federal or state laws, rules, or regulations. Each organization should seek legal, accounting, and other similar professional services from competent providers of the organization's own choosing. Ellucian 4375 Fair Lakes Court Fairfax, Virginia United States of America

3 Table of Contents 1 Introduction Purpose of this Document Audience for this document Shopping Cart Enabling the Shopping Cart in Ellucian Quercus Installing and Configuring the Shopping Cart JavaScript Plug-in Configure the Default Styling Change Shopping Cart Attributes Include the Shopping Cart Plug-on a Website Start plug-in after the page is loaded Placeholder to Show or Hide Cart Create Add to Cart Button...9 Ellucian Quercus Shopping Cart Installation Guide Release

4 1 Introduction 1.1 Purpose of this Document This document describes how to install the shopping cart JavaScript plug-in for Ellucian Quercus Release Audience for this document IT support staff and system administrators who are responsible for the deployment, support, and maintenance. Ellucian Quercus Shopping Cart Installation Guide Release

5 2 Shopping Cart The shopping cart is a software solution provided by Ellucian that allows organizations to provide shopping cart functionality on their websites. It enables users to purchase multiple programs in a single transaction and supports the continuing education and workforce development program and course offerings. The solution provides a checkout feature, which will redirect users to an Ellucian Quercus installation. Existing users can then enter their login credentials (or new users can create an account) and pay for the programs using a third-party payment provider. To install the shopping cart, you must: Enable the shopping cart in Ellucian Quercus Install the shopping cart JavaScript plug-in (provided by Ellucian) on a website Ellucian Quercus Shopping Cart Installation Guide Release

6 3 Enabling the Shopping Cart in Ellucian Quercus To enable the shopping cart in Ellucian Quercus you must configure the following parameters: SHOPPING_CART_IN_USE Set the value of this parameter to true. The default value is false (the shopping cart is disabled). SHOPPING_CART_ITEM_LIMIT Set the value of this parameter to the maximum number of programs that can be added to the shopping cart, which is determined by the business need. You must also configure the confirmation page and the course details in the Courses_Region content of the Control Centre. Ellucian Quercus Shopping Cart Installation Guide Release

7 4 Installing and Configuring the Shopping Cart JavaScript Plug-in The shopping cart JavaScript plug-in is developed for third-party websites from which users can purchase Ellucian Quercus courses. The plug-in is stand-alone, and its dependencies (jquery and jquery cookie libraries) are embedded (that is these resources are included with the plug-in and are only used when required). This section describes the six steps required to configure and use the plug-in on a website: Configure the default styling Change shopping cart attributes Include the shopping cart plug-in on a website Start the plug-in after the page is loaded Placeholder to show or hide the shopping cart Create the Add to Cart button 4.1 Configure the Default Styling Default styling is provided by the plug-in and can be disabled. To disable default styling set 'yes' to 'no' in the body tag: <body onload="buildcart.init( '', '', '', '', '$', '', '', 'no', '280', '60' )"> 4.2 Change Shopping Cart Attributes The following attributes are available to be set in the buildcart.init(..) function: Ellucian Quercus Shopping Cart Installation Guide Release

8 cart-name cart-is-empty-message cart-is-updated-message item-existsin-cart-message currency button-label return-to-cart-message css-style (yes or no) cart-width (in pixel) cookie-expire (in minutes) The attributes are are set in the body onload attribute as follows: <body onload="buildcart.init( '', '', '', '', '$', '', '', 'no', '280', '60' )"> 4.3 Include the Shopping Cart Plug-on a Website Include 'shopping-cart.js' before the closing </body> tag, for example: <script src="js/shopping-cart.js" type="text/javascript"></script> 4.4 Start plug-in after the page is loaded The onload function is required to start the plug-in, it needs to be added as an attribute to the <body> element. <body onload="buildcart.init( 'cart-name', 'empy-message', 'updated-message', 'exsits-message', '$', 'button-label', 'return to cart-message', 'yes', '280', '60' )> 4.5 Placeholder to Show or Hide Cart Add the following div element to the pages where the Shopping Cart control are to appear. <div id="my-cart">/cart-name placed here/</div> The plug-in attaches the Shopping Cart name and counter to the div. Ellucian Quercus Shopping Cart Installation Guide Release

9 4.6 Create Add to Cart Button This is required to add items to the Shopping Cart. The button has to be created by the Webmaster when course list is generated, or hard-coded on the page. The button needs to submit four parameters to the cart coursid, coursname, coursprice, coursdate: <input type="submit" coursdate=" " coursprice="85" coursname="new Course" coursid=" " value="add TO CART" name="add to cart" class="add-to-cart"> Example 1: Hard-coded courses and buttons Ellucian Quercus Shopping Cart Installation Guide Release

10 Example 2: Courses parsed by Ajax Once the shopping cart plug-in has been successfully installed, visitors to your website can: 1 Add programs to the shopping cart. 2 View the contents of the shopping cart and remove items from it. 3 Checkout and pay for their chosen courses (this redirects the user to an Ellucian Quercus installation). Ellucian Quercus Shopping Cart Installation Guide Release