NOTE: These directions cover installation of the Smart One Page Checkout module for customers on MultiStore 9.1.0.1 and earlier.
For directions for version 9.2.0.0-9.3.1.1 please see here.
For directions for version 9.4.0.0 and later, please see here.
Introduction
Thank you for your purchase of the One Page Checkout for AspDotNetStorefront. This guide will take you through the process of installing the One Page Checkout on AspDotNetStorefront. The process will include:
1. Decrypting web.config file
2. Backing up your files
3. Modifying your web.config file
4. Deploying files to the server
5. Running deployment scripts
6. Configuring the installation
7. Testing the One Page Checkout
Before You Begin
In order to safely complete this installation on a live website you need to be able to backup your site files and database, and have a plan and permission to restore them should you encounter a problem during the installation process. Different hosting providers and environments will have different methods of backing up and restoring databases. Please work with your hosting company to discuss the backup and restore tools that are available to you.
This installation process requires a level of technical expertise. Please read through the entire installation guide and make sure you understand the installation process before you begin an installation on your live site. If there are any steps of this installation process that are unclear, please contact the help desk to request assistance.
Before you begin, please ensure that:
• Your site does not use the ComponentArt menu that ships with version 8.0.1.2 and lower of AspDotNetStorefront. The ComponentArt javascript conflicts with the ASP.NET AJAX used by the One Page Checkout. If you have a custom site design, you may not be using this feature. Contact the help desk for assistance in identifying whether or not you are using ComponentArt.
• checkoutshipping.aspx.cs file is unmodified. If you have modifications to this file, following this installation guide will overwrite those modifications. This installation will also completely overwrite the checkout1.aspx and checkout1.aspx.cs files.
• You have the ability to use a text editor to modify an xml file.
• You have file access to the root of your website (FTP or RDC are the most common means of connecting)
• You have a License key for the One Page Checkout (within 1 business day of purchase, you will receive a license key from AspDotNetStorefront)
• You do not have any customizations to your current checkout process (including transmission of order information to an order fulfillment company)
• Your site has write/modify access to the /images/ directory (as specified by the AspDotNetStorefront security best practices: http://manual.aspdotnetstorefront.com/p-475-security-best-practices.aspx)
What to Expect
While you are moving files you should expect that your website will experience outages. Immediately after uploading the deployment package your site may take longer than normal to load as the website restarts. The installation process should not exceed 30 minutes total. If this is a concern, you should consider installing first to a test site.
Installation
Throughout this installation guide the One Page Checkout deployment package will be referred to as source folders and files. The website files and folders will be referred to as the target folders and files. This install guide will assume you are using FTP to move files from the source deployment package to the target website, but the same general steps can be assumed for an RDC installation.
Decrypting the web.config file
1. Login to the admin console of your website.
2. Navigate to Configuration > Site Configuration Wizard and scroll to the bottom of the page.
3. Ensure that Encrypt the web.config is set to No.
4. If it is set to No please skip to the next section titled Backing up your files.
5. If Encrypt the web.config is set to Yes please set it to No and then hit the submit button.
6. If you see a runtime error after hitting the submit button it is most likely because the application does not have write access to your web.config file. If you run into this issue you will need to work with your hosting provider to setup write permissions on the web.config file for the ASP.NET user.
Backing up your files
7. Create a backup directory on your computer.
8. Backup the following files from the target site to your backup directory:
/checkout1.aspx
/checkout1.aspx.cs
/checkoutshipping.aspx.cs
/App_Themes/Skin_{your skinID}/images/step_6.gif
/web.config
*These are the files you will need to rollback if anything goes wrong during the installation process.
Modifying your web.config file
9. Copy the live site web.config file from your backup directory into the Web/ directory of the source folder
10. Open the opc-web.config in the Web/ directory of the source folder in a text editor.
11. Find the <appSettings> node and copy all of the <add> nodes between the opening and closing
<appSettings> nodes. See below. You will be copying 7 lines of code.
12. Open the web.config file that you copied into the Web/ directory of your source folder.
13. Find the opening <appSettings> node
14. Create a new line under the opening
<appSettings> node
15. Paste the code you copied from opc-web.config into the web.config file on the new line you just created. Save the file. Your results should look similar to the image below.
Deploying files to the server
16. Connect to your site via FTP
17. Navigate to Web/Bin/ directory on the source folder.
18. Select all of the .dll files and copy them up to the root/bin of the target site.
19. Navigate to Web/ directory on the source folder.
20. Copy the entire OPCControls/ folder from the source Web/ directory up to the root of the target site.
21. Navigate to Web/App_Themes/Skin_1/images directory on the source folder.
22. Copy step_6.gif up to the target site’s App_Themes /skin_{your skinID}/images folder.
23. Navigate to Web/ directory on the source folder.
24. Copy checkout1.aspx, checkout1.aspx.cs, checkoutshipping.aspx.cs, and your saved web.config file with the new values in place up the root of the target website.
25. Navigate to Web/App_Code directory on the source folder.
26. Copy Vortx.OnePageCheckout.Factory.cs to the {root}/App_Code folder on the target site. NOTE: Older versions of the OPC plugin may not have this file. Customers without that file should contact support for an updated version of the OPC plugin.
Running deployment scripts
1. Login to the admin console of your website (it may take longer than normal to load because uploading a modified web.config file causes the site to restart).
2. Navigate to Configuration > Advanced > Run SQL using the top menu.
3. Open the 2 .sql files in the Configuration folder in a text editor such as notepad.
4. Run those scripts against your storefront database by pasting them into the SQL Command text box on the admin console page you opened, and clicking Submit. Do each script separately.
5. Reset the cache on the website
Configuring the installation
1. While in the AspDotNetStorefront backend, navigate to Configuration > Advanced > AppConfig Parameters
2. Search for Vortx.OnePageCheckout.LicenseKey and enter the license key you received from AspDotNetStorefront
NOTE: These license keys are URL-specific and call to our license server so if you are using it on a development or staged site, we will need to set up SOPC license keys for those URLs as well.
3. Search for Vortx.OnePageCheckout.ShowEmailPreferencesOnCheckout and set it true if you would like your customers to be asked if it is okay to email them. Set it to false if you do not want the option to show.
4. If you are configuring your site for use only in the UK, change the AppConfig value for Vortx.OnePageCheckout.AddressLocale to “UK”. Otherwise, leave it set to “US”.
5. Reset the cache on the website.
Testing the one page checkout
1. Open the front end of your website in a browser.
2. Add an item to your cart and proceed to checkout.
3. Test your new checkout process.
4. You’re done!
Clean up
1. If your web.config was encrypted you can go back to the configuration wizard and re-encrypt it and set the write permission for the ASP.NET user.
2. If you were upgrading from an earlier version of the One Page Checkout module, check and see if you have an OPCRedirect.aspx file (not all will). If you do, this file should be deleted.
Editing the Smart OPC Customer Service panel
You can edit the information in the Customer Service panel by modifying the topic OPC.CustomerServicePanel (Content - Manage Topics)
Most or all other text in the Smart OPC can be edited through the appropriate
String Resource. You can also display all string resources to assist in identifying the one you want to edit using
THIS method.
MultiStore Configuration
To install the Smart One Page Checkout module on a Multi-Store site, simply set the store-specific version of the Vortx.OnePageCheckout.LicenseKey AppConfig to the value of the key you got from AspDotNetStorefront for that store. Those keys are domain-specific, each can only be used for a single domain.
1. Obtain a new license key for each store from AspDotNetStorefront.
2. In the admin console, navigate to Configuration > Advanced > AppConfig Parameters.
3. Search for Vortx.OnePageCheckout.LicenseKey.
4. Edit the AppConfig, and set the value for the store you are enabling SmartOPC on to the new key you were given:
5. Click Save.
6. Make sure that the Checkout.UseOnePageCheckout AppConfig is set to true for the store you are enabling it on.
NOTE: Smart One Page Checkout does not support: eCheck payment method at this time (MSx 9311 and earlier)
Support
If you have further questions or comments, please feel free to contact
our help desk.