Purpose of Module
The Quick Order module allows you to place a "quick order" form on your site. Customers can then quickly order any item by entering the product code and either pressing the enter key or clicking a submit button.
When a product code is entered but does not exist in your store, a custom error page is presented. The error page can show the form again for usability purposes, and can also be configured to display any products who partially match the product code entered by the shopper.
How to Install
- Installing the Module
- Unzip nbquickorder.zip to your hard drive
- Log into your Miva admin utility
- Expand the navigation tree next to Modules
- Click the link "Add Module"
- Click the "Upload File" graphic
- Click the "Browse" button
- Browse to the location where you stored the files from nbquickorder.zip
- Select nbquickorder.mv(c)
- Click the "Upload" button
- When the graphic has been uploaded, the small "Upload File" window will disappear, leaving you with the main Miva admin screen visible
- Click the "Add" button on the main Miva admin screen
- Associating the Module with a Store
- Log into your Miva admin utility
- Expand the navigation tree next to Stores
- Expand the navigation tree next to the store with which you wish to associate this module
- Click the link "System Extension Configuration"
- In the assigned module list, you should see an entry for "NetBlazon's Quick Order"
- Check the checkbox next to this module and click Update
Administrator Interface
Version 4.2 introduces a new templated interface for Quick Order. The main template contains the text and HTML of the page on which the quick order form will be displayed. It uses the following tokens:
- %beginform%: Opens the form, including the form tag and hidden input fields
- %endform%: Closes the form
- %prodcode%: Displays the text entry field for the product code
- %quantity%: Displays the text entry field for the quantity
- %button%: Displays the submit button
The next two fields on the admin screen control the size of the product code and quantity textboxes. Enter a numeric value into these fields.
The form tag attributes setting is optional. It can be used to insert additional attributes (for example, to use the onsubmit() handler to run a JavaScript validation function) into the opening form tag.
The next dropdown determines what screen the shopper is taken to after submitting the form with a successful product code. When a shopper submits a product code that is not found, they will instead be taken to the error page, described below.
To configure the submit button, first choose whether you want the button to be a standard gray HTML button, and image, or omitted completely. If omitted, most browsers will allow the form to be submitted when the shopper presses their "Enter" key. In the field labelled "Button Text", enter the text that should appear on the button if the HTML button style is selected. If the image button style is selected, this text will be used as the "alt" text of the button. Finally, if the button is set to the image style, specify or upload the image to be used.
The checkbox labelled "Use Missing Attributes Screen?" will determine how your store behaves if a customer enters a product code that has attributes. If this box is checked, then the shopper will be taken to the Missing Attributes screen (often an exact copy of the product screen). If this box is unchecked, then the product will be added to the basket with no attributes or options. This behavior is the same regardless of whether the product's attributes are required or optional.
The remaining fields deal with the error page that is displayed if the shopper enters a product code that is not found. The Error Page Title is shown in the browser window, having been printed out in the <title> section of the HTML page. The checkbox determines whether the category tree will be displayed on the error page or not. The Error Page Template is the text and HTML that defines how the error page looks. To print the Quick Order form again on the error page, use the token %nbquickorder%. The error page can also show products that partially match the code entered by the shopper. To display these partial matches, use the token %matches% and configure the next box labelled "Matching Products Template".
The Matching Products Template will be displayed once for each product that contains the product code entered by the shopper. This field accepts OpenTokens but also has the following built-in tokens:
- %code%: Product code
- %name%: Product name
- %price%: Product price, unformatted
- %price-formatted%: Product price, formatted by the store's currency module