Miva, Miva Script, Miva Empresa, Miva Mia amd Miva Merchant are registered trademarks of the Miva Corporation
 
Ivo Truxa - truXoft control systems: advanced programming and custom IT solutions home / about / webdesign / Miva / automation / contact

http://mivo.truxoft.com
MIVO!
miva beyond limits

  MmUBAT Miva Merchant Order Processing Module

MIVA®  MERCHANT:  MmUBAT
Ultra Batch Report
Advanced Batch Reports / Order Browser / Stats / Mailer

by Ivo Truxa, 09/04/2001 (Change Log)

single line mode Ultra Batch report in the single line mode
  1. Feature List
  2. Screenshots
  3. MmUBAT Order Processing
  4. MmUBAT Control Elements
  5. Compatibility
  6. Installation
  7. BUY THE MODULE
  8. Support
  9. Known Limitations and Bugs
  10. FAQ
  11. Troubleshooting
  12. Wish List
  13. Change Log
  14. Useful links
  15. User Comments

top

Feature List

  • Advanced batch administration interface
  • Multiple report looks: classical, double line, single line, summary
  • Allows to search and filter patterns in any field of the order database
  • Orders may be filtered (out and in) according to the total amount - expressions and ranges may be used
  • Using the Search/Filter you can display and print out also individual invoices
  • Sorting by any column - e.g. by date or day time, first name, last name, e-mail, city, product, total amount,...
  • Page breaks for printing each order on a separate page included
  • Exports and sends batch reports to the store owner by e-mail - in multiple file formats (currently HTML, formatted text, delimited text and Excel)
  • Printing customizable Packing Slips (pick slips, gift certificates) in cooperation with the MmPSLP plugin module.
  • In cooperation with the MmHTML and/or MmHTMLc modules, you can display and print also batches of formated Merchant and Customer invoices with custom headers and footers (may include logos, texts, etc.)
  • In cooperation with the MmHTML and/or MmHTMLc modules, invoices may be greatly customized - including columns selection, colors and fonts, attributes format, thumbnails and long descriptions
  • Numerous options for different ways of displaying product attributes (with MmHTML)
  • Ordered products within each invoice may be sorted by any column (with MmHTML)
  • Additional user-defined column may be inserted in the invoice (any position) (with MmHTML). Miva variables, functions or file calls may be used to generate values for the additional column. It may contain for example a download link, price in a second currency, tracking info, etc.
  • Instant Access - Ultra Batch control header appears in the Admin front page. No neccessity to click long minutes through the left navigation menu.
  • Orders processing and deleting on multiple selected orders or whole batches with a single click!
  • Recovery (undeleting) deleted orders possible!
  • Resetting processed orders (un-processing) and processing them again possible!
  • Packing the store data from within the Ultra Batch interface!
  • Displays the date and time of the orders
  • Optionally displays all orders in the store
  • Optionally displays also deleted orders
  • Displays totals and basic statistics per batch and overall
  • Hides the Credit Card number if Admin not accessed on a Secure Server (disclosure prevention)
  • In cooperation with the MmPGP module it send batches including the CC numbers by secure PGP encrypted e-mail
  • Supports POP before SMTP - requirements at some secured mailservers (with MmHTML)
  • NEW: displaying additional fields of external modules, such as Weiland's Addendum or SB21 OrderXtra
  • NEW: (Re)sends Customer Confirmation Email (possibly including a status field in a user defined column) (with MmHTMLc)
  • NEW: Timeout prevention - long batches split automatically onto multiple pages to avoid timeouts.
  • NEW: Mall support - quick store selection for administrators of malls with multiple stores. Mall packing.
  • NEW: sequential filter - in addition to the search/hide filter mode, there is now a from mode - displaying all orders after the first matching one, using the selected order sorting.
  • NEW: delete all - ability to delete all batches in once
  • NEW: displaying of user defined column, available also for sorting and search/hide filter
  • NEW: displaying of un-batched orders, and batching them
  • NEW: PAYMENT DATA REMOVAL! You can now keep all orders and batches in your Admin, and removing just the CC information to keep your store secure.
  • NEW: moving orders from one batch to another (e.g. grouping of orders for monthly charging - subscriptions)
  • NEW: closing batches - hiding them from the standard view (re-opening possible too)
  • NEW: subtotals (with MmHTML or MmHTMLc)
  • NEW: advanced referrer tracking (original referring URL, search expression, entry time, entry page) (with MmHTML)
  • NEW: product value, tax and shipping added to displaying batch totals
  • NEW: full featured printing of shipping labels available with MmLABEL
  • NEW: time zone setting and user-defined date and time format (with MmHTML, MmHTMLc and MmPSLP)
  • NEW: search / hide by date and date ranges
  • Does not require OpenUI. Works with both OUI and MMUI.
  • No OUI hook conflicts - truXoft modules are 100% conform to the Miva Merchant API, they do not use OUI extensions and therefore never cause hook conflicts with other modules, otherwise common at OUI modules.
  • Very easy installation, plug&play, no coding, no programming experience necessary
  • Available in English and German localization (same file)

top

MmUBAT: Customer Invoices Batch MmUBAT Ultra Batch Report module is also available in a bundle together with MmHTML and MmHTMLc as a MmHTML Trio for a discounted price. Together with these modules you can customize the look of your invoices - adding HTML header and footer, including text and graphics



top

MmUBAT Screenshots

MmUBAT: Customer Invoices Batch



top

MmUBAT Order Processing

Ultra Batch in contrary to the standard batch module offers a wide spectrum of features and options for easier looking up the batched orders. Because it may be quite difficult to find a specific order in the batch, especially if there are many of them, the Ultra Batch offers several ways to simplify the task:

Security Features - MmUBAT (unlike the Miva's Standard Batch) protects you from accidental disclosing of Credit Card numbers - it displays them in the Secure mode only (SSL). In cooperation with the
MmPGP module, the Ultra Batch sends you the batches with the full payment data including CC numbers via secure PGP encrypted e-mail. NOTE: you should not use the security option of deleting the payment data upon the purchase if you need to view them later in the Ultra Batch report.

Normally you should not store Credit Card numbers on the server at all to be conform with policies of CC institutes and to prevent CC theft. If you do not use any secure way to process payments, and do not use MmPGP that sends the data off the server with encrypted mail, you should remove the CC data from the server as often as possible. There is a function in Ultra Batch for removing payment data, but keeping the orders - you do not need to remove the order information.

Ultra Batch also displays totals ans some basic statistic numbers of the currently displayed batch(es)


top

MmUBAT Control Elements

There are following control elements available, in the Ultra Batch Report:

Standard controls:
Ultra Batch: Common tools
 
Mall controls:
Ultra Batch: Mall controls
 
Batch controls:
Ultra Batch: Batch controls
 
Order controls: Ultra Batch: Order controls

mmubat controls

COMMON CONTROLS - Mode / Batch Selection

Report Type selection dropdown box

  • Standard Report - each order is displayed with full details in the same way as in the classical Miva Merchant batch report. The difference is that when you print the batch, the orders are printed with page breaks - each on a new page.
  • Single lines - all orders are displayed in a tabular way, each order in a single line. You may quickly select fields (columns) that you want to hide, to make the screen even more lucid.
  • Double lines - same as above, with the difference that both shipping and billing addresses are being displayed above each other.
  • Merchant Inovices (optional, with MmHTML) orders are printed with full details using the formatting as set in the MmHTML module. Available only when MmHTML module installed and active in the store.
  • Customer Invoices (optional, with MmHTMLc) each order is displayed with full details in the same way as in the classical Miva Merchant batch report. The difference is that when you print the batch, the orders are printed with page breaks - each on a new page.
  • Packing Slips (optional, with MmPSLP) similar to Customer and Merchant invoices, but by default does not contain any prices, charges and totals (though, Packing Slips may contain them optionally too).
  • USPS Labels (optional, with MmUSPS) printing USPS Priority Mail® Shipping Lables with Delivery Tracking barcode
  • Batch totals - for the case you keep multiple batches in your store, MmUBAT can display the totals of individual batches in a tabular form.

mmubat controls


Batch selection dropdown box

  • New orders - MmUBAT shows orders of all batches on the same screen and allows you so browsing and searching through all of them in the same time.
  • All orders - MmUBAT shows all orders - new unbatched together with orders of all batches on the same screen and allows you so browsing and searching through all of them in the same time. In contrary to the mode "all batches", it does not out any separators between the batches and unlike in the batch mode the orders are sorted without regard on the batch of the order.
  • All batches - MmUBAT shows orders of all batches on the same screen and allows you so browsing and searching through all of them in the same time.
  • Individual batches - a list of available batches follows, in the dropdown box. Depending on the setting of the checkbox 'Show closed batches', only open or all batches are in the list.

mmubat controls


Type / Batch submission button

Submit changes made in the Report Type and/or the Batch selection controls. Also changes in input fields or selection boxes of all other control tool are being submited when any of the submission buttons is used.


mmubat controls

COMMON CONTROLS - Search

Search mode selection dropdown box

There are three search / filter modes available:

  • Show - displays all orders matching the search expression in the selected field
  • Hide - hides all orders matching the search expression in the selected field
  • From - displays all orders after the first matching order, using the sorting as selected in single / double line report mode.

mmubat controls


Search expression input field

Search / Filter - you can enter a pattern and display or hide only those orders matching that pattern in a field of your choice (e.g. name, address, order number, ...)

When searching / filtering the Totals field, you may use expressions to show ranges of orders. For example you can display or hide:
<55.20 - orders with the total amount below 55.20
>33.20 - orders higher than 33.20 (not including 33.20)
=98.40 - orders with the total amount equal to 98.40
8.50-14.30 - orders from 8.50 to 14.30 (including both limits)
 

When searching / filtering the Date field, you may use expressions to show / hide orders in a date range. For example you can display or hide:
03/1/2002-03/31/2002  orders in March 2002
-12/31/99  orders till end of 1999
01/01/02-  orders since beginning of 2002
03/25/02  orders on March 25th
 


mmubat controls


Search field selection dropdown box

The following fields may be used for the serach:

  • Ord.# - order number
  • Company - shipping or billing address: company
  • 1st name - shipping or billing address: first name
  • Name - shipping or billing address: last name
  • Email - shipping or billing address: e-mail
  • Phone - shipping or billing address: phone number
  • Fax - shipping or billing address: fax number
  • Street - shipping or billing address: street address
  • City - shipping or billing address: city
  • Zip - shipping or billing address: ZIP code
  • State - shipping or billing address: state
  • Country - shipping or billing address: country
  • Codes - product codes
  • Shipping - shipping method
  • Total - total amount
  • UserDef. - user defined. An additional search field may be defined through the mmubat.conf configuration file. See details in the FAQ.

mmubat controls


Search submission button

Submits the search request and any other changes made on the control panel. Note that a submitted search / filter expression remains active even after changing batch and also upon the next login to the Miva Merchant Admin!


mmubat controls


Search reset button

Removes the search filter and shows all available records.


mmubat controls


Show deleted records checkbox

Deleted Records - with this option you can view also those orders that were deleted from the database (before packing the store). Due to the way Miva Merchant handles order deletion, the DELETE buttons are disabled if the "show deleted orders" option is checked. If you deselect the checkbox, the buttons appear on the order toolbar again.


mmubat controls


Show closed batches checkbox


mmubat controls

COMMON CONTROLS - Front Page Integration


Admin front page integration button

When you click on the small blades logo, the Ultra Batch control panel is removed from the Miva Merchant Admin front page and is available only through the standard way in Store » store » Oreder Processing » batch » Run Report. Re-enabling of the ULtra Batch controls in the Admin front page is possible in the same way. Disabling and re-enabling the front page integration may be used to fix problems of some MvDO file not found error messages on the front page.

Please note that in newer UB version, the small blades logo is visible only in the standard mode. In secure mode it is a tranparent gif under the big blue X, but it is still working anyway (the mouse cursor changes to a hand when you move it over).


mmubat controls

COMMON CONTROLS - Export Options

Send button

Submits the request for exporting the batch and sending it by e-mail to the recipient. Also any other changes made on the control panel will be submitted.


mmubat controls


Export file format

Batch report export - you can select one of available file formats:
  • HTML page - the batch is sent as HTML formatted e-mail
  • HTML file - sent as a HTML file attachment
  • Plain-Text - e-mail message with space formatted plain-text file attachment
  • Delimited Text - file attachment with deilimited text. The pipe sign is used by default as the delimiter, but it may be redefined in the mmubat.conf
  • Excel File - a file attachment with an xls file. See the FAQ for more details.

The exported batch file is being sent to the store owner's e-mail address as set in the store configuration in Miva Merchant Admin. The currently displayed mode and search / hide filter is being used for for exporting and e-mailing the file. Note: Credit Card numbers are never exported and sen by insecure e-mail. Sending complete batches with CC#, from the Ultra Batch Report, is possible only if the MmPGP secure enryption module is installed in the store.


mmubat controls


Recipient's e-mail address

The store's owner address is used. It may be changed in Admin » 'store' » Owner » Email Address. You can enter multiple recipients' addresses into the field - separate them with a comma. If the MmPGP module is installed, public key selected in the MmPGP settings is used for the encryption.


mmubat controls


PGP encryption checkbox

This checkbox appears in the control panel only if the MmPGP Secure Encryption module is installed in the currently active store. When checked, all exported files are being sent securely PGP encrypted.


mmubat controls

COMMON CONTROLS - Action Buttons

Batch name input field

New (un-batched) orders may be moved to a new or to an existing batch. Batched orders may be moved to other existing batches. In this way you can group orders together. Some customers use this feature to group together subscription orders, keep the separately from other orders. With the help of the un-processing and re-processing ability of the Ultra Batch, they can be then regularly rebilled.


mmubat controls


Batching OK button

When clicked, MmUBAT verifies if a batch of the name you entered exists. If the batch exists, all selected orders are moved into it. If the batch does not exist, and you are in the New orders mode, a new batch is created and the selected orders are moved into it.


mmubat controls


Delete all batches button

When clicking this button, all batches (except of the closed ones) are being deleted. Please note that currenlty there is no undelete function for recovering deleted batches in the MmUBAT module!


mmubat controls


Print button

Browser's Print dialogue box pops up when you depress the button.


mmubat controls


Pack store button

Regular packing of the store data is a good prevention mean against corrupted databases and a better performance. When packing the store data, you verify if there are no serious problems like duplicate records and re-create all database indexes, making so sure that they are in accord with the databases. This may prevent very serious problmes that you possibly won't discover without feedback of customers.

Important note:
Data should be packed only when the store is in maintenance mode!



mmubat controls

MALL CONTROLS

In Miva Merchant installation with multiple stores, the master administrator has an additional tool bar for managing all stores from the Admin front page. Individual store owners without admin priviledges do not have this optional control.


mmubat controls

Store selection dropdown box

A list of available stores is displayed. Individual store owners without admin priviledges do not have this optional control.


mmubat controls


Pack mall OK submission button

Reload selected store with hitting this button. Individual store owners without admin priviledges do not have this optional control.



mmubat controls

BATCH CONTROLS

Select / deselect all checkbox

A checkbox left in the batch toolbar at the top of the batch listing. Checking / unchecking it, is transferred to all checboxes of individual orders on the page. Use for selecting / deselecting all orders. In all batches mode, this checbox is available only at the very first batch toolbar.


mmubat controls


Batch name display

Displays the name and the date of creation of the batch report.


mmubat controls


Send selected invoices button

Only with MmHTMLc: with this optional button you can re-send all selected customer invoices by e-mail to the shipping and/or billing e-mail addresses as dispayed on the invoice.


mmubat controls


Show selected orders button

Reloads the page, showing only orders selected with the help of checkboxes left in the order toolbar.


mmubat controls


Show all orders reset button

Reloads the page showing all orders, removing so the previous selection. Please note that filter as set with the search tool still applies.


mmubat controls


Process selected orders button

At most payment modules (but depending on their setting), activating this function, processes all selected orders through your payment gateway, charging so the customers. At other modules (e.g. the Simple CC Validation), processing the orders does not have any other effect than setting the 'processed' flag active, allowing so the payment data removal. If you do not wish to process the payments through the payment gateway, use the function mark as processed instead. Processed orders (or orders marked as porcessed) may be un-processed, it means that the processed flags are cleared and you may re-process the orders again. This feature is especially useful when you need to bill your customers recurrently. You can also group subscription orders for recurrent billing in a separate batches (with the use of Ultra Batch's feature of moving orders from one batch to another) and re-bill the entire batch in the same time with a single click.


mmubat controls


Mark selected orders processed button

To avoid processing of orders, but allow the payment data removal of that orders, you can simply use this function - it marks all selected orders as processed, without sending the captured orders to your payment gateway for real processing. There is no difference between the process and marked as processed functions at those modules that do no make any processing (e.g. the Simple CC Validation).


mmubat controls


Un-process selected orders reset button

This function works in the reverse sense of the Mark as processed function. Nothing is sent to the payment gateway, the only action is clearing the processed flags at selected orders. This is a feature not available in the standard Merchant and it allows you to re-bill customers through the payment gateway. Especially useful for subscriptions or other recurring charges. You can also group orders with similar billing to separate batches (with the batching feature) to simplify the re-billing process.


mmubat controls


Remove payment data button

Some payment modules do not require that you store the CC numbers on the server, other ones cannot work with it (e.g. the Simple CC Validation, or most modules in post-processing mode). In the case the CC numbers are stored on the server, they are saved in database in plain-text, and can be viewed by many people, and often access to them may be gained through the web too.

Actually, storing the data on the server you are violating the policies of CC institutes and in some lands it may be violating the law too. If there is no way you could use not to have to store the data on the server (such as using a payment gateway that does it for you, or using the secure MmPGP notification module for getting the data off the server), you should minimize the risk with regular cleaning of the payment database.

In standard Merchant, the only way to do it, is deleting the orders and packing the database. However, in this way you are loosing not only the payment data, but all the order information, including customer's addresses and list of the ordered products.

With this button you can remove the payment data from your server without loosing the order information. Ultra Batch lets you remove only orders that have been already processed or marked as processed.

Please note: once you remove the payment data, they are definitely removed and cannot be restored. If you need to keep the data, I recommend making a secure backup - the best way to do it from within the Ultra Batch, is installing the MmPGP encryption module, and exporting the batches securely encrypted.


mmubat controls


Delete selected orders button

With this function, you can delete all selected orders in the same time, without the necessity to delete the batch. Deleted orders may be viewed with the show deleted records option and may be undeleted as long as you do not pack the store data. Once you pack the store data (regardless if through the Ultra Batch or the standard Merchant utility), the data are definitely removed from the server and cannot be recovered.

Deleting orders allows you to remove modules that are bound with them - like shipping and payment modules. When you are in such a situation, that you need to remove some of previously installed modules, and are getting an error message that it is not possible, because the module is used by an order, deleting the order(s) would help. However, please note, that even if you can undelete the orders, the data associated with the module (shipping or payment data) is definitely lost and cannot be displayed in the Ultra Batch. Also, currently (v1.32), Ultra Batch undeletes only the customer and product data of the deleted orders. No payment and shipping data are visible after undeleting the orders, but are still present in the databases till packing the store data. Future releases of Ultra Batch will possibly undelete also these additional data.


mmubat controls


Undelete selected orders reset button

Orders deleted through Ultra Batch or through the standard Miva Merchant Order Processing, may be recovered. This function undeletes all selected orders in the same time.
Please note: currently, Ultra Batch (v1.32) undeletes only the customer and product data of the deleted orders. No payment and shipping data are visible after undeleting the orders, but are still present in the databases till packing the store data. Future releases of Ultra Batch will possibly undelete also these additional data.


mmubat controls


Delete batch button

This function removes the entire batch including all orders. Please note that currently there is no function in Ultra Batch for undeleting order batches (there are couple of problems associated with adding this functionality). Although the batches and orders included in them are present in the databases until the next packing of the store data, recovering the orders would not be easy. I recommend deleting individual orders or closing batches instead. A future version of Ultra Batch will include a function for batches undeleting or at least for recovering orders of deleted batches.


mmubat controls


Close / Restore batch button

Instead of deleting batches and loosing so the order and customer data (definitely in case of packing the store), you can hide batches from the main view, if you close them. Closed batches and associated orders are kept in the database even after store or mall packing and can be recovered with clicking this button again. You can also check the show closed batches checkbox to list all batches regardless if they are closed or not.



mmubat controls

ORDER CONTROLS

Order select checkbox

A checkbox left in the order tool bar lets you select the individual order or multiple of them and perform an action on it resp. them. In this way you can reload a page containing only the selected orders - with the show button. You can delete or undelete orders, process, mark as processed, and un-process, remove payment data from them, batch the order(s), and some other actions - the exact list of available functions is depending on your configuration and the number of Ultra Batch plug-ins. You can select or deselect all checkboxes of individual orders in the same time if you click on the most top checkbox at the first batch toolbar.

Please keep on mind that any currently active filters like the search / hide filter, or show deleted records option, remain active even after reloading the page with selected orders or a consequent removing the selection.


mmubat controls


Order info display

Order number and processing status are displayed in this place. Depending on the configuration and available Ultra Batch plug-ins, there may be also other information displayed.


mmubat controls


Edit button

Only with MmEDIT: with this optional button you can edit the order. The MmEDIT module is still under construction, not yet available for sale.


mmubat controls


Send button

Only with MmHTMLc: with this optional button you can re-send the customer invoice by e-mail to the shipping and/or billing e-mail address as dispayed on the invoice.


mmubat controls


Show button

Reloads the page, showing only this order.


mmubat controls


Process button

At most payment modules (but depending on their setting), activating this function, processes the order through your payment gateway, charging so the customer. At other modules (e.g. the Simple CC Validation), processing orders does not have any other effect than setting the 'processed' flag active, allowing so the payment data removal. If you do not wish to process the payment through the payment gateway, use the function mark as processed instead. Processed orders (or orders marked as porcessed) may be un-processed, it means that the processed flags are cleared and you may re-process the orders again. This feature is especially useful when you need to bill your customers recurrently. You can also group subscription orders for recurrent billing in a separate batches (with the use of Ultra Batch's feature of moving orders from one batch to another) and re-bill the entire batch in the same time with a single click.


mmubat controls


'Mark un- / processed' button

To avoid processing of an order, but allow the payment data removal of that order, you can simply use this function - it marks the order as processed, without sending the captured order to your payment gateway for real processing. There is no difference between the process and marked as processed functions at those modules that do no make any processing (e.g. the Simple CC Validation).


mmubat controls


Delete / Undelete button

With this button can delete the order. At deleted order the button turns into undelete and activating it brings it back to the original batch. Currently (v1.32), Ultra Batch undeletes only the customer and product data of the deleted orders. No payment and shipping data are visible after undeleting the orders, but are still present in the databases till packing the store data. Future releases of Ultra Batch will possibly undelete also these additional data.


top

Compatibility

MmUBAT was succesfully tested with following following Miva engines: MmUBAT+MmHTNL: Fully Customized Invoices

  • Miva Empresa 3.77, 3.78
  • Miva Empresa 3.91, 3.92, 3.93
and with following Miva Merchant versions:
  • Miva Merchant 2.2x, 3.xx, 4.xx
  • MMUI, OUI, any UI

Browser compatibility: a modern browser is recommended (only for the administrator, Ultra Batch has no influence on the store compatibility for visitors). On PC platforms there were no problems reported, except of very old browser versions (i.e. MSIE3), but as for Macs, currently only Netscape 7 seems to be CSS Level2 conform.


top


MmUBAT Installation

In Merchant Admin go to Modules » Add module click on the upload button, select the file on your local disk, upload and do not forget to click the Add button after you uploaded the file. When prompted enter the license key. Go to Admin » Store » your store » Order Processing, open a batch or create a new one if there is none yet, click Run Report and select the Ultra Batch Report.

NOTE: If you install MmUBAT in a new store, please note that there must be at least one order in the store for creating and running a batch report.


top

Buy it

Following resellers are currently distributing the MmUBAT:


top

Support

We offer a  limited free suport  within 30 days after the date of the purchase for modules bought directly at  truXoft Co. or at affiliated resellers as written above. The support is limited to platforms from our compatibility list below and does not include any help with installation or configuration of payment modules, or other general Miva Merchant problems.

Some questions may be answered in the FAQ or may be solved with the help of other more experienced users on the Miva Merchant User List. I am monitoring all Miva lists and, if possible, will help with related problems posted to the user groups.


top

Known Limitations and Bugs

  • With MmHTML installed, the batches are sent to the "TO" address from its settings, but the store owner's address from store settings is dispayed on the screen instead.
  • Ultra Batch times out when deleting orders and the "show deleted" option is enabled. It happens due to an unclean batch delete function in the standard Miva Merchant. I'll have to replace the routine with an own one, working also with the unfiltered database. In the meantime, please disable the checkbox before deleting orders.

top

Frequently Asked Questions

Please have a look also at the FAQ of MmHTML / MmHTMLc, MmUSPS, MmPSLP and MmEXT

INSTALLATION GENERAL QUESTIONS CUSTOMIZING INVOICES PRINTING SECURITY / CC NUMBERS EMAIL / EXPORT ADDITIONAL FIELDS


faq

INSTALLATION

Why doesn't the module appear in my store?

I guess you have forgotten to hit the Add button after uploading the file in Modules/AddModule


faq

I don't know how to install the module and can't follow these instructions

Read the Module Installation documentation at http://www.miva.com/docs/merchant/


faq

I want to add this module to another store, what do I do?

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.


faq

After installing/updating the module, I get a MvDO runtime error after logging into Admin!

Do not worry, it is nothing critical and nothing is broken! This problem happens only in some configurations, and in the MmUBAT v1.33 (and above) the problem should not appear any more. You can still use all functions of the MM Admin as before. To get rid of the message, navigate through the Admin menu to the Batch reports as usually: MM Admin » Strores » store » Order Processing » batch » Run Report » Ultra Batch Report (oh yes, long way to go :-) and then click the small blade logo to disable the front page integration. After the page reloads, click the icon again to re-enable the MmUBAT controls on the front page. If the error persists, disbale the feature totally an use only the standard way to get to the batch reports as written above. On some systems, the error may re-appear when switching from secure to normal mode. I hope to fix this issue in the v1.33.


faq

How do I update the module?

Click on the update link in the header of the module's control panel in Admin. Download the updated module from the upgrade center. In Admin Go to Modules » module name » Files, click the upload icon button right to the Module input field, check "Overwrite", locate the new file on your disk, click UPLOAD and when you are back in the big window do not forget to click the UPDATE button! Click back to the Information tab and verify if the version was updated.

Please note that if you have bought the module at other reseller than MvCool, usually you have to use the address of the reseller as the "e-mail address assotiated with the license" (for example sales@vikingcoders.com). You should have received intstructions from the reseller when purchasing the module.


faq

The information page for the module shows a zero Usage Count (number of stores using module = 0)

That is normal at batch modules. Check the built-in Standard Batch for the reference.


faq

GENERAL QUESTIONS

How many days batch up can I store without decreasing the performance?

The size of the order database practically does not decrease the performance during shopping. It only plays role in the admin. So do as big batches and as frequently as you find bearable. However, frequent batching and deleting the batches is generally better for the system, anyway.


faq

How do I sort the orders?

Switch to the single line or double line mode (1st dropdown box), select the radio button of the column you want to sort by, and click the 'set columns' button. You can then change the mode to the Standard invoices or any other - the sorting remains active until the next change.


faq

How do I get a list of e-mail addresses?

Switch to the single line or double line mode (1st dropdown box), select the radio button of the e-mail column, deselect all checkboxes except the e-mail and maybe the customer's name and click the 'set columns' button. Now you can print the list or export and send it to yourself by e-mail.


faq

Is there a way to turn off options on reports?

Yes. Go to the data directory and edit the file .../Merchant2/0000000x/mmubat.conf (the x is the number of your store). There is a number of ubat_hideNN parameters. You can disable individual buttons with seeting the parameter to 1. You can see the assignmen of number to the buttons if you look at the section MmUBAT Control Elements: go with the mouse cursor over the list of the element names and watch the browser's status line. You'll see links ending with #hlpNN. The numbers are equivalent to those in the mmubat.conf

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

How can I view unprocessed orders only?

Use the search function to hide processed orders: select "Hide" enter 1 to the search expression, select "Proc." and click OK.


faq

Is there any trick for removing payment or shipping modules without loosing all related orders?

Yes, sure. Just delete all orders (not the batches!) using that very payment / shipping method you want to remove (you can use sorting in the single/double line mode or the search/filter function to pull them out), then remove your payment module and undelete the orders back. In this way you can keep all orders, but be aware that you'll loose the payment data of that orders.


faq

There are no DELETE buttons at individual orders. Is my module broken?

No, due to the way Miva Merchant handles order deletion, the DELETE buttons have to be disabled if the "show deleted orders" option is checked. If you deselect the checkbox, the buttons appear on the order toolbar again.


faq

Should I delete or close old batches?
I was told by Miva Merchant Support in the past that I should delete old batches. Your software suggests closing them instead. Is it safe to keep batches in Miva and just close them, then pack my store, or is it better to delete them and then pack my store? If it is ok to close & then pack, how long should I keep closed batches before it affects the performance of my store.

In fact deleting orders and batches have practically no impact on the performance of the store. All the information stored in the associated databases are not looked up at all till the very last screen of the checkout process and even there the size of the database plays almost no role (the difference between a lookup of an empty and of a very huge database is just few milliseconds).

The number of batches can only influence the speed of building the navigation menu in the Admin interface. If it appears too slow to you, then closing the batches will indeed fix it. Closed batches do not appear anymore in the left menu, but are still viewable through the Ultra Batch (when the "closed batches" checkbox selected).

The reason why Miva support recommends deleting the orders is probably more the security than the performance. If your payment module stores CC numbers on the server, they could be easily stolen. In fact keeping the CC# on the server is illegal and should not be possible at all. With Ultra Batch, you have the possibility to keep the orders and delete just the CC data. The payment databases are being packed automatically after using the function, so packing the store data is not necessary to get the CC data definitively erased (but it is a good idea to pack your store data often anyway):

In this way you can keep the order data on the server for archive and statistics reasons. They do not take a lot of space.

What makes much bigger difference and is of higher importance, is deleting the baskets! Unlike the order database, the baskets databases are being opened and looked up at very single hit to your store. Experienced admins advice not to select the "recover unused order numbers" option if you want to avoid possible future corruption of databases.

The MmTICKER module takes care of deleting baskets, packing store and domain data automatically at scheduled time (by default daily).


faq

Is there some way I can display all unprocessed orders in all batches?

Yes, choose the mode all orders, select hide in the search mode, type 1 (digit one) into the search field, select Proc. in the serach fields dropdown list, and hit OK.


faq

How do I batch orders?

With the Ultra Batch, there is actually no real need to batch orders, because you can group, filter and sort them by different criteria, but if you want to batch new orders, simply enter a name of an existent or new batch into the "Move to" field and click OK. That's all.


faq

CUSTOMIZING INVOICES

How do you modify customer / merchant invoices?

Through the settings of the MmHTMLc (truXoft Customer Email), resp. the MmHTML (truxoft Merchant Email) module in the Order Fulfillment Configuration.


faq

How do you put background as in your demo in the invoice?

The simplest way is including a
<BODY BACKGROUND="http://yoursite.com/path/img.gif">
tag into the invoice header.
Note that you must not include neither the opening HTML and HEAD tags, nor the closing /BODY, /HTML tags neither in the invoice header nor in the footer. Only closing /HEAD and opening BODY tags are allowed (but not compulsory) in the invoice header.


faq

PRINTING

How do I print the batch with one order per page?

On MSIE, right-click on the main frame, select 'Print', verify that 'Only the selected frame' option is set and click OK. The printer will automatically print a single order per page, ommiting the parameter forms and the statistics. On Netscape and Opera it is very similar. If the orders are not printed correctly on separate pages, please update your browser.


faq

Why my customized colors and/or images do not print out correctly on my printer?

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.


faq

How do I change the font size on the printed invoice?

On MSIE, go to View / Text Size or define a User Style Sheet in Tools / Internet Options / Accessibility
In Netscape use Ctrl-[ and Ctrl-] and in Opera + and - keys to increase/decrease the font size.
If you have the MmHTML, MmHTMLc or MmPGP installed, you can use more precise font size and face control in their Admin interface - you can use also the px (pixels) and pt (points) units.

faq

Can I print out the batch reports directly from the admin?
I tried, but the left column keeps showing up since it is in the same screen.

Sure, this is possible. You just need to select only the selected frame in the printing properties of your browser. Alternatively, you can right-click on the frame and select 'print' from the context menu - in that case the option only the selected frame is usually default.


faq

When I print invoices the navigation menu gets printed.

When the browser printing pop-up windows opens, be sure to choose "selected frame only". You can also right-click on the batch frame and select print from the context menu - in this case only the frame gets printed automatically.


faq

How can I block the Internet Explorer page header and footer from printing?

Go to File » Page Setup and delete the Header and Footer.


faq

How do you print individual range of orders?

There are several possibilities:

  1. Check only those orders you want to print (checkbox left to the order header) and click the button SHOW selected orders. When the page reloads, print the batch.
    NOTE: in one of the previous version, the SHOW button in the batch headers is missing. If it is your case, please update at http://www.mvcool.com/upgrades.mv
    PS: if you select the checkbox left in the batch header, all orders are being selected/deselected at a time
  2. In the last version there is a new option in the search mode dropdown box - "from" (show/hide/from). Select it, type the number of the first order, select Ord# in the second dropdown box and click OK. All orders past the selected will be displayed. You can also change the sorting of the orders by other field (e.g. date, product, customer,...) if you switch to the sinlge or double line mode and click on the radio button at the column you want to use for sorting, and confirm with clicking on the 'set columns' button. Then you can switch back to the full page mode (sorting remains as selected) and use the 'from' option to start displaying from certain point
  3. With a 'search' or 'hide' option you can display or hide only orders matching the search expression in the selected field (second checkbox)
  4. Range expressions are currently possible only at the search field 'Totals'. So you can display/hide orders using expression like the following ones:
    > 55.40
    < 3000
    150.40-205.80

I may add real ranges to other fields later too, but currently it is not available.


faq

I like the batch totals. Is there a way to print them with the orders?

Yes, set the ubat_printTotals parameter in the file .../Merchant2/0000000x/mmubat.conf to 1

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

SECURITY / CC NUMBERS

Why do I not see the full Credit Card Numbers in the report?

For security reasons, to avoid its disclosure, the Ultra Batch Report displays the full CC number only if you are connected to the Miva Merchant Admin through SSL (Secure Server). Also, be aware that some payment modules do not store the CC numbers on your system at all, or only optionally (see the properties of your payment module in the Merchant Admin).

If, before using the Ultra Batch, you were used to view the payment information on a non-secure connection, then you should be aware that you were transferring the data through the web unencrypted. It is equivalent of sending them on a postcard. Better told it is much worse, since for many thousands of people it is much easier to use automated tools to capture such data flying through the web, than to ever see a postcard you sent by regular mail.

If you use secure connection for collecting the payment data from customers, you were creating a false image of security that was breached when you disclosed the data looking on them insecurely. Fortunately, Ultra Batch does not let you doing it now anymore, but if you want to avoid serious problems, never ever attempt doing so again using the standard Miva Merchant Order Processing in a non secure mode.


faq

I connect to the Admin on a Secure Server, but still do not see the CC numbers. What's wrong?

As written above, some payment modules do not store the CC numbers on your system at all, or only optionally (see the properties of your payment module in the Merchant Admin). If you are sure it does, then most probably your server does not set properly the enironment variables. See the following instructions for the fix:
A simple text file named 'sitevars' needs to be created which will contain the following line:
HTTPS=on
Once this is done, the configuration file for Miva Empresa will need to have a directive added to tell the engine where the sitevars file is located. This is accomplished by adding a line like the following to the conf file:
sitevars=/path/to/the/sitevars
Once this change is made and the new configuration is saved, the problem should be resolved.


faq

How do I remove Credit Card numbers from the batches?

Click on the CC# button in the batch header (in the processing button group). Note that the payment data will be removed only at processed and selected orders. This function remove the entire payment data from the payment database, but keeps the rest of the orders intact.


faq

Why there are no CC numbers in the exported batch sent by e-mail?

Sending CC data through plain e-mail would violate policies of CC institutes and put them in serious risk. Ultra Batch exports CC data only together with MmPGP securely encrypted.


faq

EMAIL / EXPORT

How is the email address set?

It is the store owner's e-mail address as assigned it in the store properties (Admin/Store/your store/Owner/Email Address). With the MmHTML module installed, the recipients address from its settings is used instead.


faq

Can I add send the batch also to an additional email address?

Yes. Mostly you can simply add another address separated by a comma to the store owner's address in store settings (see above). However, some mail servers refuse from Miva multiple addresses in a single field. In that case you have to edit the mmubat.conf file manually and set the address into the ubat_CC parmeter. The file may be found in the store folder of your Miva Data directory (typically ~/htsdata/Merchant2/00000001/mmubat.conf)

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

Everytime I try to generate an Excel report using the mmUBAT, I get an error. I cannot open the document?

Please verify that you have data converters installed in Excel:

  1. Go to Windows' Control Panel >> Add/Remove Programs
  2. select MS Office and click Add/Remove: the MS Office installation will start
  3. Select Add/Remove components
  4. Expand Converters and Filters >> Text Converters
  5. Click on MS Excel Converters and install it


faq

How do I change the delimiter?

Go to the data directory and edit the file .../Merchant2/0000000x/mmubat.conf. Put the delimiter of your choice into the parameter ubat_delim of the mmubat.conf file. If no value set, a pipe delimiter is used.

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

Can I export the batch to a file on the server instead of sending it by e-mail?

Yes. You have to edit the mmubat.conf file manually and set the ubat_fileExport parameter. The file may be found in the store folder of your Miva Data directory (typically ~/htsdata/Merchant2/00000001/mmubat.conf). If the parameter is set to any value except of web, the file will be exported to the non-public Miva data directory. If you put the string web into the parameter, and there is a password protected directory /mmubat/ in your public web space, the batch will be exported to a file called batch.txt, batch.htm or batch.xls in this public directory.

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.

Please note: Ultra Batch verifies if the directory is protected and will move the exported batch to the public directory if you enabled the password protection for example in the following way through a .htaccess file (assuming Apache server). Also be sure to restrict the access to the file to Secure mode. Transferring the data would expose the CC numbers or other sensible data to the public!

# Apache access file generated by truXoft MmPASS module
Options -Indexes             # deny directory listings
SSLRequireSSL                # deny non-secure access
Order deny,allow   
Deny from all                # deny to all except of allowed
Allow from yourIP_or_Domain  # allow yourself
AuthType Basic               # password protection
AuthName "Authorized access only"
# AuthUserFile should not be in the public web space!!
AuthUserFile /absolute/path/to/your/.htpasswd 
Require user yourUserName
Satisfy all                  # all criteria must be met

# deny access to conf files
<Files ~ "^.ht">
 Order allow,deny
 Deny from all
</Files>

Details about password protection and authorization on Apache may be found at Apache.org. Follow vendors instructions of other web servers like for example the MS IIS.

I also recommend immediate removing of the file after downloading. If you download the exported batches (or any other confidential data) from your server, never use plain FTP, but either SSH, SFTP, SSL, VPN, FTP over SSL or other secure equivalent!

Additionally you should be sure to disable long cgi-bin formed URL in your Miva configuration! If there is a miva binary on your system that can be used to call documents through the cgi-bin formed URLs, you are in serious danger of exposing your (and your customer's) data! Please read http://mivo.truxoft.com/art0001.htm for details.

If you put any other value than the string web into the ubat_fileExport parameter, the batch will be exported into a file called mmubat_batch.txt, mmubat_batch.htm or mmubat_batch.xls in the store directory in the Miva data dir (the one where the mmubat.conf resides).

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

Is it possible to display the exported batches on the Ultra Batch screen?

Yes. One possibility is exporting the batch to a file in the web directory as described above. Another possibility is enabling the parameter ubat_dumpExport (use any non-zero value) in the mmubat.conf (in your store data directory).

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

I need the file exported in the same way as in the standard Merchant export: each product on a new line!

Change the ubat_longExport parameter in the .../Merchant2/0000000x/mmubat.conf in the following way:
ubat_longExport=Code,Quantity

You can also use other field names: ubat_longExport=Code,Name,Weight,Price,Quantity

You can put them in any order you wish.

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq

I need a TAB delimited text file.

Use the Excel file format. It is in fact a TAB delimited text file, not in a real MS Excel format. If necessary rename the file, using a txt extension.


faq


ADDITIONAL FIELDS

How do I view additional user data such as from the Addendum or OrderXtra in the batches?

You need to have at least one of the following modules: MmHTML, MmHTMLc or MmPSLP. There is information about putting additional fields to the notifications in the MmHTML FAQ. However, this additional field can be displayed only during the checkout. The data is not available in the operating memory when viewing batches. The values have to be pulled out of the 4th party module data files - it means it must be individually coded for each 4th party module with additional fields. There are two ways:

  1. If you are a Miva coder: You create a file called xmmhtml00000001.mv (containing the code of your store) and put these three functions in it: column(), header() and footer(). You can use any Miva Script commands and functions to open the respective files and have them inserted in the respective places of the invoice - both for the notification and the batch reports
  2. If you do not want to mess with the coding, you can buy the MmEXT module for $19.95 that does it for you


faq

How do I use MmEXT without MmHTML/MmHTMLc/MmPSLP module?

Go to the data directory and edit the file .../Merchant2/0000000x/mmubat.conf. Put the expression as shown in the MmEXT installation (see the examples at the bottom), into the parameter ubat_expr of the mmubat.conf file. Choose the example that matches your configuration and edit it as needed. Do not remove any quotes from the examples. The code must be in one line without line breaks.

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.


faq


I see the additional fields in Ultra Batch, but nothing comes in the notification.

Be sure that you have followed the installation instructions correctly, and especially the part about the order of modules. You can either change the expression to display both, the MmEXT generated variables (e.g. Addendum.var1) and the form field variables used on the checkout page (e.g. g.question1). In this way, if the order of modules is wrong, the form field variables will be displayed in the notification and the MmEXT variables in the Ultra Batch reports. However, if the order of the modules is correct, the additional fields would be displayed duplicated (use just the MmEXT variables in that case).


faq


Can the Coupon Discount be displayed (and exported) in a separate column of the Single Line Mode?

Put the following function into the user-defined column (ubat_expr parameter in .../Merchant2/0000000x/mmubat.conf):

getCharge(Orders.d.id,'DISCOUNT')

where, instead of DISCOUNT you put the real order charge ID used by the discount module (as stored in the 'type' field of the ordrchrg.dbf). Keep it quoted and cased exactly as in the database.

When editing the mmubat.conf file and uploading it back to the store data directory, please be sure to be logged off the MM Admin.




top

Troubleshooting

In case of troubles, before contacting the support, please be sure to:

  1. read the FAQ
  2. check the changelog and update the module to the latest version
  3. read known limitation and bugs



top

Wish List

  • Printing shipping labels (see MmUSPS and MmLABEL)
  • Sending tracking numbers to customers (available with MmUSPS v1.10)
  • QuickBooks export
  • Undeleting batches (in addition to already present order undeleting) (available since v1.36)
  • Removing CC# from databases (available since v1.32)
  • Button for putting the store into the maintenance mode
  • Hiding / disabling certain buttons (e.g. process orders, pack store) through a configuration file (available since v1.33)
  • Adding product attributes to the flat file and Excel exports

top

Change Log


top

Some Useful Links

MmHTML - HTML Formatted Email Merchant Notification
MmPGP Secure PGP e-mail merchant notification module

top

   

Miva and some other terms used on this page are registerd trademarks of the Miva Corporation
copyright  truXoft  © 1997-2010