• NOTE: The following codes apply to Merchant versions 2.x, 3.x, or 4.x. They do not apply to Merchant 5.x.
• e - Editing of the mmui.mv or related MIVA Merchant core files required if you are NOT using the incredibly versatile OpenUI. See the installation document for editing procedures. If using compiled Merchant, see the note about editing the mmui.mv below.
• c - Module(s) included in the Combo bundle for versions 3.x and 4.x. Save with the bundle purchase.
• o - OpenUI 2.x-4.13 or OpenUI 4.14-4.24 only. All other modules work with both the MMUI and OpenUI.
• t - OpenUI Tokens can be used to replace code at hook points in compiled Merchant versions using OpenObjects. The OpenDesigner screen lists the OpenObjects. The OpenObjects provide a template screen which can contain both the existing hook points (backward compatibility) and the ability to move output around within the OpenObject screen.
• t2 - OpenUI Tokens can be used to replace code at some hook points in compiled Merchant versions using OpenObjects.
• t3 - Uses hook points within OpenObjects in compiled Merchant versions.
• oec - Compiled version works with or without OpenUI (optional), but is enhanced if OpenUI is used. Contact me if you have a question about this.

Miva Merchant 2.0 - 4.24 Editing: Editing of the Miva Merchant standard mmui.mv can be as few as a couple lines added to hook a specific function in a module to several different editing locations within the mmui.mv file. If you are using the OpenUI, there will be no need to edit the Miva Corp supplied mmui.mv file because hooks are built into the OpenUI.
If you are running compiled Miva Merchant 4.14-4.24 and need to edit the mmui.mv, you will have to recompile the mmui.mv after editing. This requires that you have the compiler software or a developer with the Miva Merchant Developer's license edits and recompiles the mmui.mv for you. For this reason, most store owners will likely install the OpenUI to eliminate the need to edit and recompile the mmui.mv. I have not updated all of the install documents to reflect the correct path to be used when editing the mmui.mv. If the code insert includes a path with a file name ending in .mv, that should be changed to .mvc. For example
<MvDO FILE="{g.Module_Root$'modules/fulfill/couponrd.mv'}" NAME="l.ok" VALUE="{Coupon_Pass()}">
would be changed to:
<MvDO FILE="{g.Module_Root$'modules/fulfill/couponrd.mvc'}" NAME="l.ok" VALUE="{Coupon_Pass()}">

Many (but not all) of the online documents are enhanced read files. The code segments in red show the code which you will add to the applicable file if editing is required. When there is code in black, surrounded by red, it is only the red you are adding. The code shown in black is already in the file you are editing. Normally you are going to copy and paste these red segments into the file you are editing. Do not "view source" to copy the segment as the source code has been modified so that it properly displays in an htm file. For example, the < has been converted to &lt; for display purposes. Hence, copy the red segment as you see it in the displayed help file.

Important note about Miva Merchant 5.x modules. Our 5.x modules currently support the default MIVASQL database configuration in Miva Merchant 5.x. They may support MySQL if you are NOT load balancing by placing the scripts on multiple servers and the databases on a single server. As long as the scripts are on one server, the MySQL should work too. A couple highly respected web hosts have commented on this issue.

Version changes. Over time, modules are updated within the numbered version, e.g. 3.00 may get updated to 3.01. When a module is upgraded, the version number prior to the decimal changes, e.g. 3.01 gets upgraded to 4.00. Generally, updates are maintained within the corresponding Merchant version, e.g. 3.xx would be used with Merchant 3.xx. In a few rare cases, we may have created modules which can be used across several versions. You would have received the newer module initially if this was the case. For example, the PayPal module for 4.xx (uncompiled) can be used with Merchant 2.xx, 3.xx and 4.xx (uncompiled). The compiled modules can only be used in compiled Merchant (version 4.14 and newer). Merchant 5.x requires modules specifically written for 5.x. You cannot use the 4.x compiled module in a Merchant 5.x store.

Updates and Upgrades. Modules are updated to add minor features, fix bugs, and improve user interface within the same Miva Merchant version. Modules are upgraded when you change major Miva Merchant versions, e.g. from 4.13 (uncompiled) to 4.14 (compiled), 4.24 to 5.0, 5.0 to 5.5, 5.5 to PR7, to incorporate major API changes. We do not charge a monthly or annual service fee. Updates are sometimes free but probably incur a small fee. New numeric version licenses are sold, often at a price lower than the full price. You will need the original order number and your merchant url. Check your order email, then see the list below for location to update/upgrade.

• Same Merchant version number, e.g. 5 to 5.
  • Emporium Plus - See the module list above and click on the letter "U" to the left of the module name. If you are updating a bundle that is not listed above, you can search the "same version update" category.
  • Design Extend - You will need the previous order number and your merchant url.
  • MivaCentral - When originally bought at MivaCentral, the same version updates/upgrades can be obtained at Emporium Plus. See the module list above and click on the letter "U" to the left of the module name.
• New Merchant version number, e.g. 4 to 5. Return to the store you bought the original version at.
  • Emporium Plus - See module list above. Click the product code to the left of the module name.
  • Design Extend - Search products.
  • MivaCentral - See if upgrade price is available at this link.

Recurring charges. As you know, Miva Merchant is charging you a monthly service fee (which began a few months ago) to use their software and receive updated/upgraded versions. Rather than charge you a monthly service fee, we have opted to charge a small update price only at the time you choose to update/upgrade a specific module in a specific domain. This will be far less than a monthly service fee for each module. Do not copy newer modules into other domains you manage without purchasing the update for those other domains. That would be analogous to buying one copy of Window 7 and then copying it to all the computers in your office. Most modules are only upgraded if you are going to use the new features in the module or in conjunction with new features in the core Miva Merchant. Even with extensive changes in the API recently, less than 10% of our module inventory had been effected by those changes. Less than 6% had to be upgraded. In the past, when some Merchant versions changed, e.g. from 4.13 to 4.14 or 4.24 to 5.0, you had to upgrade every one of your 3rd party modules if you wanted to use them in the newer version. This new system represents a significant savings over the previous "upgrade all" system.

Upgrading/updating modules. The install docs are designed to help you install a module and configure the options. However, there are times when you are going to "upgrade" or "update" an existing module. The configuration options are the same whether it is an install or upgrade/update. The upgrade/update process is a bit different from an original install.

Generic instructions for updating from one version of a Merchant 5.x module to a newer version:
You make same version module updates by selecting admin > global settings > modules (or admin > modules if your version is older than 5.5). Then in the right screen input, search on the module code. I named my modules so the module code is the first part of the module name (less the .mvc). For example, toolkit.mvc would have a module code of toolkit Next, click the edit button to the right of the module listing. Check "Usage Count (Number of Stores)". It must be higher than 0 if it is other than an import or export module. It should be equal to or greater than the number of stores using it in your Miva Merchant if it is a shipping, payment, order fulfillment, utility or system extension module. If it is not, you must stop and do not update the module. We will have to figure out why it is 0 and repair that. If ok, run the file upload, making sure to check the box for overwrite. Then click the Update. DON'T FORGET TO CLICK THE UPDATE. After updating, go to the module's admin screen and make sure everything looks correct, i.e. no errors, license info, etc. The order number needs to be the order number from the original purchase of the module license for this major version number. So if you got the license for 5.x two years ago, then that is the order number to put in the input. If you later buy an update license, keep that new order number for your records but do not insert it in the module's input. If there is a license key input and it says "request license key" and the input is blank, you must click that request license key link and request the key. If a license key is required you will see a message of 240 hours remaining and it will count down until it expires. So while you don't need to get the key immediately, don't wait until the last day before it expires. Also make sure features related to the module are still working.

Upgrade to Merchant 5.x from 4.x or older:
The upgrade from an earlier (1.x to 4.x) version of Merchant to Merchant 5.x is significantly different. Merchant 5.x requires a fresh install even if you had been using the module in your 1-4.x store. VERY IMPORTANT: You MUST update to the latest module version for your Merchant 4.14-4.24 (compiled) store if you want to keep your previous settings. Get the most recent 4.x (compiled) module version from the store you got the original license purchase at (Emporium Plus, Design Extend, MvCool, MIVACentral). Your 4.14-4.24 store must use the standard data directory configuration in order for the 5.x module to properly find and move your old data. Also, the volume pricing, miscellaneous fee, and followon contact modules require that you export their data from the 4.x store to a flat file so the data can be imported into the 5.x store. Once you have updated your 4.x (compiled) module, you can install the 5.x module in your 5.x store. You will add the 5.x module as a new install. If your previous Merchant version is 4.13 or older, you will not be able to move your module's old data to the 5.x store. It will require re-entering the module data after the 5.x module is installed. If it is in a 4.13 or older store, you will need to uninstall the module from the older store before installing in the 5.x store if they are in the same domain.

Upgrade to Merchant 2.x, 3.x, and 4.x:
1) Start your Merchant Admin
2) Select the link "Modules"
3) Scroll down to the link that matches the name of the module you are upgrading
4) Click on that link
5) Select the image for file upload
6) Enter the path on your PC that the file is on and click the overwrite checkbox
7) Upload the file
8) Click the update button
9) Now go to the store configuration screen for the module and enter the configuration settings as discussed in the installation document for the specific module

Warning: Unassigning modules in Merchant 5.x:
There is a bug in some versions of Merchant 5 related to unassigning modules. If you unassign any multi-feature module (when one of the features is component), it will delete the module's database but not remove it from the store. That is a major MM5 bug and has been reported. You are supposed to unassign it in reverse order of install. First you MUST remove every token on every page for the module. You need to remove it from the items list from every page that it is in the items list. Then you need to remove it from the master items list. Then you can unassign it from the primary menu. If you do it out of order, you will likely get an error that the database is missing and will be stuck. You cannot just go back and do the steps you missed and all will be well. In most cases you will need to do the steps you missed, then try assigning and unassigning the module under its primary menu. You can also try going to admin:modules and searching for the module. When you click the Edit button, it will tell you how many stores it is in. If it is 0, you should be able to click the Delete button and remove the module from the store. Make sure it is only the module you are removing from the store. Since unassigning a multi-featured module is so complex, you probably should think twice before unassigning a module. Ask yourself, why are you unassigning? Is there something not working? If that is the reason, request support from the vendor before unassigning.

Missing component module and missing database errors in Merchant 5.x:
If you get a missing component module or missing database error, there are steps you can take to remedy the situation. See the info doc on this subject.

Online Support: In addition to the install docs, the module product pages often have screen shots from admin and merchant which provide visual help on how the module is setup and functions. If AFTER reading and implementing the install notes and reviewing the product page, you have a problem, please use our Support System to contact us. Don't forget to include your order number (not license key) and full Merchant url. If a module does not do what the product page or usage doc says it does, contact us to see if we can get it working as advertised. If you need it to do something that was not covered in the product page, we may be able to add the feature. There may be a charge to add a new feature. If it does not work in your store, e.g. conflicts with another module, we can issue a refund or credit at our discretion. If you bought a module to do a certain task and Miva adds that capability to the core product, that is not a reason for requesting a refund. Generally, refunds are limited to the first 72 hours after purchase. Direct emails may go unanswered or there may be long delays before an email in one of our mailboxes is discovered. DO NOT EMAIL DIRECTLY. Please use the Support System . If you have a serious error (e.g. store is down), you can inactivate a module under admin > global settings > modules while waiting for support by unchecking the Active box and clicking Update.

Copyright © 1996-2011 William Weiland. All Rights Reserved.
Inquiries | Privacy | Site Map | Master List