Search Descriptions Version
 
 
This article applies to:

ML8 Mobile Commerce Plug-in Installation Instructions


Please note: This information covers the enhanced mobile functionality available with the purchase of the Mobile Commerce Plug-In. For details of the built-in mobile functionality, please see this page.

Introduction

Thank you for your purchase of the AspDotNetStorefront Mobile Platform. This guide will take you through the process of installing mobile on a default build of AspDotNetStorefront. The process will include:

1. Backing up your current site files and database
2. Copying files onto your website
3. Merging five files with already existing files on your website
4. Initializing the Mobile Platform
5. Testing both the desktop version and the new mobile version of your site.

Before You Begin

Before you begin please ensure that:

• You have a fully functioning AspDotNetStorefront site.
• You have a backup of your site files and database, and a plan and permission to restore them should you encounter a problem during the installation process

• You have file access to the root of your website (FTP or RDC are the most common)
• You have a License key for the Mobile Platform
• You have a Deploy Package for Mobile. Note: If your site has significant customizations, this package may need to be modified to work correctly.
• 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 and merging files you should expect that your website will experience outages.

After uploading additional files, merging five files, and initializing the Mobile Platform your site will have a Mobile specific look-and-feel. Mobile devices will automatically be directed to the mobile version of your site.

If you would like to view the Mobile portion of your site without a mobile device you can visit “mobilego.aspx” which will flag your computer as a mobile device. To undo this, visit “mobileleave.aspx”, or mobileclearcookie.aspx to allow device detection, which works great when using a "user agent switcher" in a non-mobile browser..

Installation

Throughout this installation guide the Mobile Platform deployment package will be referred to as source folders and files. The website files and folders will be referred to as the target files and folders. Before you begin, you will want to unzip the Mobile Platform package (source) and open its root folder alongside the root folder of your website (target).

1. Backup your files and database

IMPORTANT! BACKUP ALL FILES AND YOUR DATABASE IN CASE OF INSTALLATION ERROR. Ensure that you have a plan and permissions to restore your backups.

2. Copy Additional Files
2.1. Open the “Additional Files” folder in the source files.
2.2. Open the “App_Code” folder in both the source and target directories.

2.3. Copy “MobileXSLTExtensionBase.cs” from the source “App_Code” folder to the target “App_Code” folder.
2.4. Go up a directory in both the source and target directories.
2.5. Open both “bin” folders and copy Vortx.dll, Vortx.LicenseServer.Client.dll, and Vortx.LicenseServer.Common.dll from the source to the target.
2.6. Go up a directory in both the source and target directories. Open the skins folder under each.
2.7. Copy the skin_2 folder from the source to the target skins folder.
2.7.1. If you already have a folder named skin_2, please rename the source folder to the lowest available skin number. Note: If you rename the folder you will need to change the AppConfig “mobile.skinid” to the number you created on the skin folder after initializing the Mobile Platform (step 4.2).
2.8. Go up a directory in both the source and target directories.
2.9. Copy all the rest of the files contained in the “Additional Files” folder from the source to the target. Note: Do not copy the folders, just the files as shown below.

3. Merging Mobile Modifications

Note: Using a text merging tool makes this part of the installation process much easier. If you are familiar with WinMerge, BeyondCompare, or any other text merging tool, use it to assist merging these files.

3.1. ShowEntityPage.cs
3.1.1. Open the “Merged Files/App_Code” folder in the Mobile Platform source files alongside the App_Code of your website (target).
3.1.2. Open both “ShowEntityPage.cs” files in side-by-side text editors.
3.1.3. Find and replace the line “m_XmlPackage = m_EntityHelper.m_TblMgr.CurrentField(n, "XmlPackage").ToLowerInvariant();” with its equivalent from the source file (shown below starting with #region and ending with #endregion).

3.1.4. Close both copies of the “ShowEntityPage.cs” file and save changes to the target file.

3.2. SkinBase.cs
3.2.1. Open both “SkinBase.cs” files in side-by-side text editors. (Still in App_Code.)
3.2.2. Copy the two lines that begin with “using Vortx” from the mobile platform (source) “SkinBase.cs” file to the target “SkinBase.cs” file. (Paste just below the line “using System.Collections.Generic;”.)

3.2.3. This is what the file will look like after you have pasted the code:

3.2.4. Find the code highlighted below in the source file by searching for “#region Vortx Mobile”

3.2.5. Paste the code in the target “SkinBase.cs” as indicated by the red arrow below. Search for “CommonLogic.CookieUSInt” and paste just below the right curly bracket under that line.

3.2.6. This is what the file will look like after you have pasted the code:

3.2.7. Close both “SkinBase.cs” files and save the changes made to the target file.

3.3. driver.aspx.cs
3.3.1. Go up a directory in both the source and target directories. 3.3.2. Open the “driver.aspx.cs” files in side-by-side text editors. 3.3.3. Find the line int topicID = Topic.GetTopicID(PN); in the target file and replace it with the code int topicID = Vortx.MobileFramework.MobileHelper.GetMLTopicID(PN);

3.3.4. After copying the code your file should look like this:

3.3.5. Close both “driver.aspx.cs” files and save the changes made to the target file.

3.4. showproduct.aspx.cs
3.4.1. Open the “showproduct.aspx.cs files in side-by-side text editors.
3.4.2. Find the code highlighted below in the source file by searching for “#region Vortx”. Replace the line m_XmlPackage = DB.RSField(rs, "XmlPackage").ToLowerInvariant(); with the code beginning with “#region Vortx” and ending with “#endregion”.

3.4.3. After copying the code your file should look like this:

3.4.4. Close both “showproduct.aspx.cs” files and save the changes made to the target file.

3.5. web.config

3.5.1. Open the “web.config files in side-by-side text editors.

3.5.2. Search for “<browsercaps>” in the source file. Copy the code beginning with “<browsercaps>” and ending with “</browsercaps>” and paste it above the “<httpHandlers>” in the target file.

3.5.3. After copying the code your file should look like this:

3.5.4. Search for “<add” in the source file and copy that line into the target file just above the line “</extensions>”.

3.5.5. After copying the code your file should look like this:

3.5.6. Close both “web.config” files and save the changes to the target file.

4.1. Install License Key.
4.1.1. Login to your admin console.
4.1.2. In AppConfigs, search for Mobile.LicenseKey.
4.1.3. Insert License key in Value.
4.1.4. Reset Cache

4.2 Initialize the Mobile Platform Note that initializing the mobile platform will make changes to your database.
4.2.1 Go to http://www.[yourdomainname].com/mobilego.aspx
4.2.2. This URL will force any device to view the website in mobile mode once the mobile platform has been installed. If it does not display correctly please check that all installation steps were followed correctly.
4.2.3. Visit mobileleave.aspx to leave the mobile site and mobileclearcookie.aspx to allow device detection, which works great when using a "user agent switcher" in a non-mobile browser.

4.3. If you used a skinid other than 2, please change the AppConfig “Mobile.SkinID” to match the skin id you assigned to the Mobile Platform skin folder (in step 0).

4.4. Ensure that both the desktop version and the mobile version of your site display properly.

4.5. Review and set appropriate AppConfigs (search for “mobile”). The AppConfigs are documented in the document included with the install package titled “Mobile Platform Users Guide.doc”.

Summary

After adding and merging the mobile files and initializing mobile, your site should display differently on mobile devices and desktop devices. If for some reason the site is not working properly after deploying the Mobile Platform package, please restore the sites from the backups you made and contact support to help trouble shoot.

Support

If you have further questions or comments, please feel free to contact our help desk.