MmHTML MIVA MERCHANT MODULE INSTALATION STEPS --------------------------------------------------------------------------- Contents ----------- A) LEGAL NOTES / LICENSE AGREEMENT B) INSTALLATION C) REFERRER TRACKING D) TROUBLESHOOTING E) SECURITY NOTES To activate this module it you must install the module using the Miva Merchant admin system, and then assign it to the particular store, just as you would any other Miva Merchant Module. This Module has been written for Miva Merchant versions 2.x, 3.x and 4.x LEGAL NOTES / LICENSE AGREEMENT =============================== BY INSTALLING THIS SOFTWARE YOU AGREE TO THE FOLLOWING LICENSE: Definitions: (i) "YOU" and "LICENSEE" refers to the person, entity or organization which is using the software and source code known as "Miva Merchant HTML e-mail notification module (truXoft MmHTML)", and any successor or assignee of same. (ii) "truXoft MmHTML " (hereinafter "MmHTML") is the application and source code which accompanies this License, and which allows sending of HTML formatted merchant notification e-mail, and which requires the use of Miva Script and the Miva Merchant application. 1. This license is for the downloading and use of MmHTML and any permitted modifications of MmHTML source code. By downloading, acquiring and using MmHTML, YOU expressly agree to abide by this License. 2. This license is between LICENSEE and truXoft. Licensee acknowledges that truXoft is and has granted this license in reliance upon representations made by Licensee and Licensee warranties the truthfulness and accuracy of such representations. Any breach of this warranty of truthfulness and accuracy shall constitute a breach of this License. truXoft has the sole and unqualified right to refuse to license any person or entity for any reason, except for reasons which are specifically prohibited by state and national laws and statutes. 3. LICENSEE is granted a non-exclusive license to use MmHTML in conjunction with one Miva Merchant Store for each MmHTML Store licence purchased. License to use MmHTML with more than one Domain, must be separately purchased from truXoft and are specifically not granted in this License. 4. MmHTML contains valuable proprietary rights of truXoft. There is no transfer to LICENSEE of any title to or ownership of MmHTML or any copyright, trade name, trade secret, source code, or other proprietary rights relating to MmHTML, regardless of the form that MmHTML exists in. Licensee may not violate these rights, and Licensee must take all appropriate steps to protect truXoft's rights. truXoft may at any time replace, modify, alter, improve, enhance, or change MmHTML without prior notice. 5. Any license, right, or permission to use MmHTML is automatically revoked if LICENSEE breaches any term or condition of this License. Licensee agrees that in the event of a breach of this License, and upon the demand thereof by truXoft, Licensee will immediately return any physical copies of MmHTML to truXoft, will cease any further use of MmHTML, will remove the original and any modified or altered MmHTML source code from his/her/its computers and drives, will cease his/her/its use of MmHTML, and will cease any claimed breach of this License. Licensee agrees that monetary damages alone is not an adequate and just relief resulting from any breach of this License, that a court MmHTML prohibiting any further breach of this License is necessary to prevent further damages, and that Licensee will not oppose any reasonable request for a temporary restraining MmHTML, preliminary injunction, or other relief sought by truXoft in the event of a breach of this License. truXoft shall not be required to notify Licensee of any breach, nor make any demand or claim against Licensee resulting from any such breach, or for a demand to stop any use or distribution in violation of the terms of this License, and Licensee agrees that any breach of this License and damages resulting therefrom shall relate back to the first and earliest breach thereof. Failure of truXoft to enforce its rights pursuant to this License shall not constitute a waiver of such rights, and shall not prejudice truXoft in any later enforcement of its rights or rights to seek damages therefrom. 6. truXoft WILL NOT BE LIABLE FOR (A) ANY BUG, ERROR, OMMISSION, DEFECT, DEFICIENCY, OR NONCONFORMITY IN SEK; (B) IMPLIED MERCHANTIBILITY OF FITNESS FOR A PARTICULAR PURPOSE; (C) IMPLIED WARRANTY RELATING TO COURSE OF DEALING, OR USAGE OF TRADE OR ANY OTHER IMPLIED WARRANTY WHATSOEVER; (D) CLAIM OF INFRINGEMENT; (E) CLAIM IN TORT, WHETHER OR NOT ARISING IN WHOLE OR PART FROM truXoft'S FAULT, NEGLIGENCE, STRICT LIABILITY, OR PRODUCT LIABILITY, OR (F) CLAIM FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES, OR LOSS OF DATA, REVENUE, DEVELOPERS GOODWILL, OR USE. IN NO CASE SHALL truXoft'S LIABILITY EXCEED THE PRICE THAT DEVELOPER PAID FOR MmHTML. 7. This License Agreement shall be governed by the laws of the State of Colorado, USA. If any provision of this License is found void, invalid, or unenforceable, it will not affect the validity of the balance of this License, which shall remain valid and enforceable according to its terms. In the event any party is required to seek judicial enforcement regarding any terms of this License, or to seek a judicial interpretation regarding any terms of this License, the party deemed by the court to be the prevailing party shall be entitled to, in addition to its costs and damages, reasonable attorney's fees and costs as determined by the court. 8. LICENSEE acknowledges that MmHTML may be subject to United States export controls, pursuant to the Export Administrations Regulations, 15 C.F.R. Parts 768-799. Licensee shall comply strictly with all requirements of the Export Administration Regulations regarding use of MmHTML. 9. This License Agreement constitutes the entire and sole agreement between developer and truXoft, and is agreed to and entered into on the date YOU download or implement MmHTML, whichever date is earlier. INSTALLATION STEPS SUMMARY: =========================== Please visit http://mivo.truxoft.com/mmhtml.htm#inst for up-to-date installation information 1) Install Module 2) Assign to Store 3) Set store and module parameters 4) Create a Test Order Brief installation instruction follow. If you are unfamiliar with installing Modules check out the Miva documentation at: http://www.miva.com/docs/merchant/ 1) Save the file module somewhere on your PC / Mac. 2) Launch the Miva Merchant Admin System, usually at http://www.yourdomain.com/Merchant2/admin.mv 3) Enter the administrator username and password 4) Click on the Blue Expander Triangle beside the word "Modules" to open this menu tree 5) Click on Add Module 6) Click on the upload file icon to the right of the text field 7) A popup window will appear. Click BROWSE and find the Module you have just saved on your local drive. 8) Click OPEN 9) Click UPLOAD 10) Click ADD. Miva Merchant has now installed this module, but it is not yet assigned to a store 11) Click on the blue Expander triangle to the left of the store name to open its menu tree. 12) Click on 'Order Fulfillment Configuration' 13) Check the 'truXoft Merchant Email' and click the Update button 15) Click on the 'truXoft Merchant Email' tab, verify and modify parameters and customize the header and footer of the notification e-mail if needed 16) Click the Update button to save the changes (even if you made no changes at all!) 17) Make a test order to verify if the HTML notification works well. REFERRER TRACKING: ================== Setting your website for referrer tracking is not mandatory, but it greatly enhances the tracking possibilities and collects a lot of data that may be then reviewed and analyzed and give you a better idea from where your sales originate. If you want to track visitors original referrer URLs, you have to upload the attached "refer.mv" file into your web root and to place the following code into each of your static documents and also in the Merchant's global header: (one line!) Please be _absolutely_ sure that the absolute path to the "blank.gif" is correct and change it accordingly if the path to the file is different! Please replace the "https://www.yourdomain.com/ with the real domain name _exactly_ as it appears on the checkout page! Especially watch also for the presence or non-presence of the "www" in front of the domain name on your checkout screen and use the identical form here. The logging is based on cookies and browser send different cookies for URLs with and without the "www" (or anything else on its place). Also please open the "refer.mv" file and verify the path. On some servers, Merchant is not placed in the /Merchant2/ directory, but rather in /store/, /shop/ or similar. If any of the paths is not correct, referrer tracking fails to work without any warning. If succesfully installed, there will be created a file called "mmhtmlref.dbf" and one or more indexes ("mmhtmlref.mvx","mmhtmlrefc.mvx") at the first visit of a visitor on any page of your website that contains the above described IMG tag. Never delete these files unless you want to reset the database! Referer Troubleshooting: ------------------------ If the referrer script works, and you have activated the "User Tracking" option, in the Merchant notification you'll see three aditional lines: "Referrer URL", "Entry URL" and "Entry time". If it does not work, there will be only the "Referrer" and typically it will contain the Merchant URL on your own site. In that case verify the following: 1) There are no JavaScript errors on the entry page 2) When testing, you have entered the website through a link on an external website, such as a search engine 3) The URL of the refer.mv script in the JavaScript snippet is correct - you can esily test it so that you copy and past the URL to your browser. You should get a blank page with no error and no text at all. Also be sure that it uses exactly the same domain name and protocol as your Merchant's checkout page. Typically it is a secure URL starting with https:. 4) Be sure the path in the refer.mv (I mean inside of the file) is correct. If you call the refer.mv directly from your browser using exactly the same URL as in your JavaScript (see above) and you get an error message simialr to the following one, then the path is wrong: »'/Merchant2/modules/fulfill/mmhtml.mv': No such file or directory« I do not know what the right path on your system is - it depends very much on the configuration of your server and on the Miva Merchant version. That's the reason I officially do not offer free support for this extra feature. The right path may be often as simple as just removing the leading slash: -- Merchant2/modules/fulfill/mmhtml.mv or it may contain the MM version: -- Merchant2/4.12/modules/fulfill/mmhtml.mv or -- /Merchant2/4.12/modules/fulfill/mmhtml.mv or it may contain some other prefix: -- naturalreflections/Merchant2/4.12/modules/fulfill/mmhtml.mv or -- /naturalreflections/Merchant2/4.12/modules/fulfill/mmhtml.mv or may be in another directory: -- store/modules/fulfill/mmhtml.mv or -- /store/modules/fulfill/mmhtml.mv 5) Verify that the URL blank.gif is correct, especially if you use relative URL - it may be different on static pages and other in the Global Header! Copy and past the URL into your browser to verify if it works! 6) Verify if a file mmhtmlref.dbf (and associated *.mvx index files) were created. You may try to delete the between individual tests to reset the stored values 7) When having troubles with MSIE6, be sure to be accepting cookies from 3rd parties (see the Internet Option / Privacy settings). Better yet, you should have correctly set the P3P policies on your server. Please review the discussion on the Miva Merchant User list for details: http://www.miva.com/~archive/mru/index.mv?control=digest&msid=id78116 http://www.miva.com/~archive/mru/index.mv?control=digest&msid=id78120 8) Be absolutely sure that your secure site sends cookies and that they can be successfully accepted by browsers. You have to open your cookie container and look for the cookie associated with your secure domain. If it is not there, the referrer tracking can't work. Especially MSIE6 is a problematic browser that does not accept cookies from websites without proper P3P policies. Please see http://mivo.truxoft.com/mmfaq.htm#Q007 for further details. 9) If the checkout pages use the long (and insecure) cgi-bin formed URLs, you have to replace the 2nd question mark with a plus sign: (one line) IMPORTANT NOTE: help with the installation of the Referrer Tracking feature and with setting up the "Additional Expressions / Fields" option, is not included in the free support. All customers asking for assistance on these features will be required to pay the installation fee of $50 in advance. Setting up or fixing of P3P policies in _not_ included in the setup fee. TROUBLESHOOTING =============== Please visit http://mivo.truxoft.com/mmhtml.htm#trouble and http://mivo.truxoft.com/mmhtml.htm#faq for up-to-date troubleshooting information Q) I have installed the module but nothing happens. A) Make sure that you have assigned it to your store as well as installing it with "Add Module" Q) I don't know how to install the module and can't follow these instructions A) Read the Module Installation documentation at http://www.miva.com/docs/merchant/ Q) I want to add this module to another store, what do I do? A) This module requires one license per use. You won't need to repeat the installation, but you will need a different license key to assign it to your new store. Q) Why my customized colors and/or images do not print out on my printer? A) If you use Outlook, verify that MSIE is set to print the background: in MS Internet Explorer's menu, go to Tools/Internet Options/Advanced/Printing and be sure to have checked the 'Print background colors and images' option. With other mailers / browsers it should be similar.