27
http://www.vikingcoders.com Inventory Manager – version 5 This module lets you maintain control of inventory for your store’s products as well as product attributes. Inventory counts can be set manually or via an import. THESE INSTRUCTIONS ARE FOR VERSION 5 USERS, which also requires you are running version 5 of MIVA Merchant. The Concept... This module provides an interface for you to maintain true inventory counts on your store’s products. It supports the tracking of attributes and attribute combinations. It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets in order to recover inventory. Note about compatibility with other modules: This module eliminates the need for using Miva Merchant’s built-in Inventory feature. It also requires that any third-party modules that utilize product inventory features for displays has the ability to either utilize this module instead of the one by Miva Corp., or supports token usage to set conditionals based on product counts maintained by this module. This module uses tokens. A primer on tokens can be found here . This module is installed as a System Extension module. Click here for installation steps. Accessing the Module... After installing the module, click on the System Extension link in your Miva Merchant Admin, and click on the Inventory Manager link in the right-hand screen. This is where you will make all core configurations for the module. AN IMPORTANT NOTE: If your store currently runs Miva Merchant’s built-in Inventory feature, or another inventory module, you’ll want to deactivate it prior to using Inventory Manager. To deactivate Miva Merchant’s built-in feature, click on the Inventory link in your admin menu and uncheck the Track Inventory box, and click update.

Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

http://www.vikingcoders.com

Inventory Manager – version 5 This module lets you maintain control of inventory for your store’s products as well as product attributes. Inventory counts can be set manually or via an import.

THESE INSTRUCTIONS ARE FOR VERSION 5 USERS, which also requires you are running version 5 of MIVA Merchant.

The Concept... This module provides an interface for you to maintain true inventory counts on your store’s products. It supports the tracking of attributes and attribute combinations. It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets in order to recover inventory. Note about compatibility with other modules: This module eliminates the need for using Miva Merchant’s built-in Inventory feature. It also requires that any third-party modules that utilize product inventory features for displays has the ability to either utilize this module instead of the one by Miva Corp., or supports token usage to set conditionals based on product counts maintained by this module. This module uses tokens. A primer on tokens can be found here. This module is installed as a System Extension module. Click here for installation steps. Accessing the Module... After installing the module, click on the System Extension link in your Miva Merchant Admin, and click on the Inventory Manager link in the right-hand screen. This is where you will make all core configurations for the module. AN IMPORTANT NOTE: If your store currently runs Miva Merchant’s built-in Inventory feature, or another inventory module, you’ll want to deactivate it prior to using Inventory Manager. To deactivate Miva Merchant’s built-in feature, click on the Inventory link in your admin menu and uncheck the Track Inventory box, and click update.

Page 2: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Setting Options... When you first access the module’s admin, you will be presented with the Options screen. This is where you will set the core options for the module. We’ll discuss in great detail the key options that can make or break the module from functioning the way you like. Enable module? This option enables the Inventory Manager module. Left unchecked, your store will not utilize it’s features. Actively recover inventory from expired/deleted baskets? By default, Miva Merchant’s built-in inventory feature removes available inventory as items are added to the basket, and the same thing will happen with this module. However, Miva Merchant’s feature requires you delete expired baskets in your store before that inventory is replenished to products. Inventory Manager can instead replenish inventory as soon as a basket expires (which is a default of 60 minutes, yet depends on the setting you’ve made for your particular store).

Which method should you use? First, check to see what you’re store’s default “expired basket” setting is – normally it is 60 minutes, but you can check and/or adjust this by clicking your store’s link in the admin menu, then by clicking settings on the right-hand screen. Now, determine whether or not you want inventory automatically recovered from expired baskets whenever the module is accessed (such as when the product or category page loads the product), or if you want to manually recover inventory. To automatically recover, then check off the Actively recover box. You can recover manually by checking off the Recover inventory box and clicking Update.

Prevent sale of product if all tracked attributes are at levels "prevent sale"? By checking this option, you can prevent the ordering of “empty” products (a product without any required attributes). This option will prevent the sale of a product if all attributes are out of stock, but only if the attributes use the “prevent sale” option on the notification level set for them. So, if you plan to prevent the sale of any attribute out of stock, you would likely also use this option.

Default Notification Levels This module uses notification levels that you can assign to products. Since you can create your own levels (in-stock, out-of-stock, backordered, on-hold, pre-order, etc.), you can also set default levels to be applied to all products, and individually apply unique levels to specific products. We’ll discuss this in more detail in just a bit. Title for “Insufficient Inventory” Page You can configure exactly what is displayed on the page when there is not enough inventory to fulfill an order. For example, if you have 2 in stock of a product, and the customer attempts to add 3 to the basket, a page will display explaining that there is not enough in stock to fulfill the request. The Title for this page will appear in the browser’s title bar, and the %storename% token will display the name of your store.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 3: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Template for “Insufficient Inventory” Page Here’s where you can customize what the shopper sees when there is not enough inventory available. The template can include both tokens and HTML.

Images There’s currently one image you can assign here, and it’s for the back button for when the shopper is presented with the Insufficient Inventory page. You can upload a custom graphic for this button. Path to module file This “path” option is available should you encounter problems running the module due to a non-standard setup of Miva Merchant (which would normally be done by the host). We recommend leaving this blank at first, and should you encounter problems, you can enter the direct path to the BROK_INVENTORY.mvc file on the server. Maintenance This box is only used by support staff for troubleshooting issues.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 4: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Notification Levels Many stores use just four levels of inventory: in-stock, out-of-stock, low-stock and backordered. However, you may offer pre-orders of items, or have other special level messages you’ll want to display. For example, if an item is out-of-stock and you aren’t expecting shipment for a several weeks, you may want to prevent all sales of the product. But if shipment is en-route to you, you may want to allow purchases, even though you cannot ship the item for a few days. You can control what happens to products individually when the inventory reaches a specific count. So, if you want product 1001 to display as Out of Stock and not allow purchasing, you could assign an Out of Stock level to it, yet still assign a Coming Soon level to 1002, still with an inventory count of zero, but with purchasing being allowed. When you click the Notification Levels link in the module’s admin, you will see a listing of all pre-entered levels.

Copying Existing Levels You may decide you want to build upon another level by copying that initial level. It’s a good idea to copy levels to avoid mistakes—it’s easier revert back to a level t

1. Look on the Listings page and note the ID # of the level you want to copy. 2. Click the New Levels link.

3. Enter the existing level’s ID # and click the Load button.

4. Enter a name for the new level and click Update.

Inventory Manager –Copyright 2004-2006. All Rights Reserved

This site uses a notification levelnamed “eBay” to tell the customer that the item is up for sale at their eBay store.

hat works.

Last Update 07/03/06

Page 5: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Creating/Editing Levels There are various parameters to enter when creating and editing levels. Inventory cutoff This is the inventory count a product must reach before it is considered to be at this level. For example, normally an inventory count of zero would denote that an item is out-of-stock.

Action to take You can opt to allow the customer to purchase items that are at this level, display the product but prevent purchasing, or prevent the display of the product altogether. Notification only? If you want to use this level solely to notify you that a product has reached the level, check off this box. Messages You can have both Short and Long messages for notification levels. This is useful if you want to display the words “SOLD OUT” on the category screen, but display a full explanation on the product page. Send email? You can opt to have the module send an email to someone when a product that is assigned to use this level reaches this level. Most use this to be notified when there are few or none remaining of a pro Send html? You can optionally have the email sent in HTML format. Send To Enter the email address of the person you want notified of the stock level. Send From Enter the email address you want the email sent from Email Subject Enter the subject of the notification email Email Body Enter the text of the email message. You can use HTML and tokens to customi

Inventory MCopyright 2004-2006. All Rights Reserved

Prevent Display will make the product inactive in the store.Once inventory is replenished, the product will become active again.

duct.

ze the message.

anager – Last Update 07/03/06

Page 6: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Level Examples Let’s say you have two Vendors. Vendor A is backed up in production, so you don’t want to allow purchasing of any of its products when the inventory count reaches zero. You would use an out of stock level that has a cutoff of zero, and is set to prevent purchase (or even display). Vendor B normally ships you product whenever you order, so you want a Low Stock level of say 10, so you can get an email when the stock is low and also advise customers that it’s selling out, and when the inventory reaches zero, you want to still allow purchasing because you can ship the product shortly – yet you still have to tell the customer there will be a delay. Thus you’d create a level for Coming Soon, with messages that explain the procedure. Some sites that have one-of-a-kind items may utilize eBay to auction off products, but it makes sense to market those auctions to your customers. A level named eBay could allow you to prevent sale of the product through the store, and the message could direct the customer to your eBay auction listings. In short, you can be very creative with how you work with inventory levels on a product-per-product basis.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 7: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Displaying Inventory In version 5, the display of inventory is handled via an “item” associated with the various pages. An item is basically a call to something – in this sense, the display of information. It’s not necessary to display anything to shoppers. The module will track inventory regardless of what you display on the front end of the store. Upon installation, Inventory Manager registers with the following pages:

PROD – product display CTGY – category display PLST – product list page SRCH – the search page PATR – the missing product attributes screen

It does not, however, add its items to the page templates, which means you need to place the items wherever you want the specific information to display. The item token for displaying inventory information is of the form:

<mvt:item name="BROK_INVENTORY" param="token" /> where "token" can be values: count To display the inventory count of an product, you would use something like: <mvt:item name="BROK_INVENTORY" param="count" /> available for immediate delivery long_message This displays the product’s current level’s long inventory message as you have it configured. short_message This displays the product’s current level’s long inventory message as you have it configured. level_name Displays the current inventory level name level Returns the current inventory level id (not commonly used for display to the shopper). If the current level is none, a 0 will be returned.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 8: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Conditional Displays Conditional tokens allow you to display content ONLY if a condition is met. For example, you may want to display a message only if the product’s inventory is being tracked, or if the shopper can purchase the product. In version 5 you need to set the value of a string before you can run a conditional. So an item is first required, again in this format:

<mvt:item name="BROK_INVENTORY" param="token" /> tracking This is used to determine whether or not inventory is being tracked. It sets the value of g.BROK_INVENTORY:tracking to 1 if the items inventory is being tracked, 0 otherwise. attr_display This is used to determine whether or not all attributes are out of stock. You would use this item to suppress the display of the attribute if all options are out of stock. permit_display This sets the value of g.BROK_INVENTORY:permit_display to 1 if the product's current level permits display (but not necessarily a sale), 0 otherwise. permit_sale This sets the value of g.BROK_INVENTORY:permit_sale 1 if the product's current level permits sale, 0 otherwise.

Note that if you have the "Prevent sale of product if all tracked attributes are at levels "prevent sale"?" option configured "on" and this is used in the product template it will set the variable to 0 IF all of the tracked attributes are out of stock.

So, to control the display of the "add to basket" button on the product display only if the product is allowed to be purchased, you could use the conditional:

<mvt:item name="BROK_INVENTORY" param="permit_sale" /> <mvt:if expr="g.BROK_INVENTORY:permit_sale">

<input type="text" name="Quantity" value=1 size=4> <mvt:item name="buttons" param="AddToBasket" />

</mvt:if> You simply wrap the conditional code around MIVA Merchant’s existing Add to Basket button (the gray text here calls the quantity box and the button). This change is made on the Product Page Product Display Layout.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 9: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Similarly, if you wanted to display something if the product is in stock and something different if it is not in stock you would use: <mvt:item name="BROK_INVENTORY" param="permit_sale" /> <mvt:if expr="g.BROK_INVENTORY:permit_sale">

sale okay (Add to Basket button here) <mvt:else>

sale NOT okay (you could put: <mvt:item name="BROK_INVENTORY" param="short_message" /> to display the short message)

</mvt:if> You can add this around the "add to basket" and "buy one now" buttons so that they display only if the product is in-stock and able to be purchased. These same tokens can be used in the same manner on the PROD, PLST, SRCH, and CTGY pages.

Inventory Display for Attributes and Options The ability to track and display the inventory for attributes, options, and combinations thereof, is one of the main things that differentiates Inventory Manger from MIVA Merchant's own inventory feature. Unfortunately, MIVA Merchant 5.x provides no way to automatically modify the way attributes are displayed, so you’ll need to use the Attribute Template module (named VC Attributes Templates under System Extension). The Attribute Template module provides templates which can be used to edit the format of the displayed attributes. It registers itself as the item VC_product_attributes which can be used as a direct replacement for the MIVA Merchant item product_attributes. To enable this module, you need to check off the Enabled box on the VC Attribute Templates under System Extension. To verify, enabling this feature should change the line on the Product Display page from:

<mvt:item name="product_attributes" param="product:id" /> to <mvt:item name="VC_product_attributes" param="product:id" />

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 10: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

The module's templates are identical to the attribute templates in our 4.x Template modules. The Attribute Template templates can be configured on the "System Extension Configuration" page but it also adds itself as a tab on the pages to which it is assigned and can be configured there.

Attributes Main Template The Attributes main template contains the HTML that will be used to replace the %attributes% token in the Product Main Template. To permit the display of the attributes in some other fashion than the standard vertical listing, the Attributes main template contains a token, %rows% which represents where the actual listing of the attributes will be displayed. The %rows% token will be replaced by as many instances of the Attributes row template as it takes to display all of the attributes.

Attribute Row Template The Attributes Row Template, in turn, lets you arrange multiple attributes in a single row. For example, if you wanted to lay attributes out in rows across, you could code it like:

<tr><td valign="top"> <table> %attribute|01|% </table> </td><td valign="top"> <table> %attribute|02|% </table> </td></tr>

In this example, the row template wouand one attribute on the second). Each instance of an attribute in the rowrepresents the position of the token in right.

The Modified Standard templaexample of the display of the a Because of the way Merchant the templates are displayed, theach TYPE of attribute. Whenthe type of attribute and selecttypes.

Copyright 2004-2006. All Rights Reserved

Individual attributes arecontained in the red box.

The Attributes Main Template controls this entire area.

The Attribute Row Template controls everything inside the green box.

ld be run twice (to put two attributes on the first row across,

is represented by the token: %attribute|xx|% where xx that row. They should be numbered consecutively left to

te which comes pre-installed with the module includes an ttributes in rows 2 across.

handles attributes and to provide for better control over how is module provides for separate template to be used for

the module replaces the %attribute|xx|% token it first checks s the appropriate token from the actual available attribute

Inventory Manager – Last Update 07/03/06

Page 11: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Radio Attributes… This is the attribute that is used for the "radio" type attribute. Its template is different from the other attribute types, and it contains three core template areas:

• Radio Attribute Template • Radio Option Row Template • Radio Option Template

Radio Attribute Template This area controls the attribute prompt and the available options. Thus, the only tokens used in this area are %prompt% and %options% for the standard layout. If you want to use a three across style (see below), you need to replace the %options% token with %rows%. Radio Option Row Template You can display options in a single list (like default Miva Merchant) or use table cells to span them across the page in rows/columns. For example, if you wanted to display the options three across, you can do something like this:

<tr><td valign="top">

%option|01|% </td><td valign="top"> %option|02|% </td><td valign="top"> %option|03|% </td></tr>

Just make sure to number the options consecutiv Radio Option Template This template will use two tokens: %fields% (whi(the text the shopper sees for the option).

Select Attribute Template This is a simple template, because all you need to disdrop-down menu. Checkbox Attribute Template Another simple template, %fields% controls the checsees. Text Attribute Template %prompt% is the text the shopper sees, while %field Memo Attribute Template This is for the text area attribute. %prompt% is the teinput box.

Copyright 2004-2006. All Rights Reserved

In order to display options in columns, you need to replace the %options% token in the Radio Attr. Template with%rows%.

ely (01, 02, 03, etc.).

ch is the selection button) and %prompt%

play is %prompt% and %fields% - for the

kbox and %prompt% is the text the shopper

s% is the input box.

xt the shopper sees, while %fields% is the

Inventory Manager – Last Update 07/03/06

Page 12: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

The item tags from the Inventory Manager are used in the Attribute Template fields in the exact same manner as in Merchant's own template fields. In addition, the Attribute Template is able to process the Merchant <mvt:if and <mvt:else tokens so they can be used in template fields as well. Note that how the Inventory Manager assesses the item depends on where it is used. If the item is placed in the "Product Display Layout" of the "Edit Page:Product Display" page (the page that controls the display of the PROD screen) then it will check to see if the product’s inventory is being tracked and determine the inventory level of that product. If it is used in the "VC Attribute Templates" module in the "Attributes main template" (or in any of the template fields for "option less" attributes such as the checkbox attribute) it will check for the inventory of the main attribute (it will check to see if tracking is enabled on that attribute w/out options). If you use it in the template fields for individual options (as in the radio option example) it will check for tracking based on that option. So the item:

<mvt:item name="BROK_INVENTORY" param="short_message" />

placed in the "Product Display Layout" field will display the "short message" associated with the notification level of the product itself. The same token placed in the "VC Attribute Templates" module will display the short message for the tracked attributes (if any). If you’re not using other modules to handle the display of store pages, this module can display inventory on product and category, and other pages, based on your selections.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 13: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Assigning Levels & Inventory to Products Inventory counts and levels can be assigned to products either manually, or via an import module (which is included with this module’s zip file). If you plan to import counts and levels, we recommend you first work with a few products manually so you can understand how this module works.

When you edit a product in your Miva Merchant admin, you’ll find a new tab called Inventory Manager. Clicking it will bring up the Counts screen, and this is where you will enter the current inventory count, and assign notification levels that product can use. Here’s a breakdown of what you will see on this screen:

The Product Code Noted here as Item AC3001 Count (in open baskets) The inventory count, followed by the count that is currently being held in open (not expired) shopping baskets. Current Level The current level of the product (determined by the count and the notification levels assigned to the product). Levels The notification levels assigned to the product. These are entered by the numbered ID, followed by a comma. IE: 1,2,3, Simple This is a handy feature when you don’t want to track a product’s inventory, but want to simply use an assigned level. For example, if a product will be out of stock indefinitely, you may want to assign the out of stock level and check off the Simple box. This will remove the “count” feature for the product. The same logic can be used for products which will always be in stock. Tracking The tracking tab will let you check off that the product is tracked by the Inventory Manager module. Left unchecked, the product will not be tracked at all, and thus no levels or anything else will ever be assigned to the product nor displayed in the store.

To change the inventory count, enter it’s count and check off the UPDATE COUNT box at the top of the screen (otherwise no changes will be made). To add and change levels, enter them as explained OR click the GO box and check off the appropriate levels and hit select.

NOTE: If you don’t assign any levels, no action will be taken in the store based on the counts. The module will merely track the inventory on the backend.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 14: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Tracking Product Attributes Many users opt to use this module because of its ability to track attributes. However, it’s key that you pay close attention to this section, because there are things this module cannot do, and grand things that it can. First, and foremost, this module cannot (under any circumstance) track attributes and options that are assigned to products using Miva Merchant’s Attribute Templates feature UNLESS you opt to COPY the attribute. This means you cannot automatically update options for a mass of products. However, you can track attributes in which you use the Copy function, enter manually, or import with a third-party module – so long as you are not using auto-updatable Attribute Templates. You can track Select and Radio Attributes, which means you can track clothing sizes and colors, and other key options. After assigning the attribute and options to the product, click the Inventory Manager tab (in the product) and then click the Tracking link. You’ll see your options listed, and each can be tracked separately. To track the attributes/options, uncheck the actual product box, and then check off the attributes OR options you want to track.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 15: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Tracking Combinations In our example, we have a shirt, that comes in three sizes, three colors, and there’s an option patch the customer can have applied. The problem is, we don’t have a separate inventory count for each size and each color, but rather a combination count—we only have three Size Smalls in Red, but 12 Size Larges in the same color. So, we need to be able to track the combination, and Inventory Manager can do it! You can track an entire Product, one or more of it’s Attributes, or one or more of it’s Options, but not all. Try checking off various boxes on products with attributes for further understanding. Thus, two track the options of an attribute, check off the options and click Update. When you return to the Counts tab, you’ll see that you are now able to set inventory counts and notification levels to each individual option. If we check off the SM, MED, L, RED, and Green boxes, we’ll get what we need – combination tracking:

We know have 6 separately tracked combinations, one for each color in each size. Now, we are offering the special patch using a checkbox attribute—you can track these on a Yes or No (chances are they’d only be tracked on the Yes option). However, we don’t care what shirt is ordered, because each patch is sewn on when it’s ordered. If we simply check off the Yes and No boxes for that attribute, we’ll wind up with 12 combinations: Red, Small, With Patch Red, Small, No Patch And so on. But since the patches are not already attached, we want to track them on their own. So we check off Yes only, and then check off the option to Treat attributes without options as separately tracked items. Our result will be the six tracked items (as shown above), plus ONE more – simply for the patch, which stands on its own.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 16: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Working with Insufficient Inventory If a shopper tries to purchase a higher quantity of a product than your settings allow, he/she will be prompted with a page that explains the problem. You can customize this page, calling in the product information, notification level, long or short message – even the special note. This is done on the main settings screen for the Insufficient Inventory template. %back|#|%

Replaced with a JavaScript "back" button using the image uploaded/configured for image # in the "images" section of the module's admin

%todaysdate%

Today's date. Formatted mm/dd/yyyy

%time%

Current time. Formatted hh:mm:ss

%storelink%

Link to the store front

%storename%

Store's name

%storeowner%

Store's owner

%storeemail%

Store owner's email address

%storecompany%

Store owner's company

%storeaddress%

Store owner's address

%storecity%

Store owner's city

%storestate%

Store owner's state

%storezip%

Store owner's zip

%storephone%

Store owner's phone number

%storefax%

Store owner's fax

%storecountry%

Store owner's country

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 17: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

%prodname%

Product's name

%prodcode%

Product's code

%prodweight%

Product's weight

%prodprice%

Product's price

%proddesc%

Product's description

%prodimage%

The product’s large image

%prodthumb%

Thumbnail image

%prodimageL%

The large image linked to the product page

%prodthumbL%

Thumbnail image linked to product page

%prodnameL%

Name linked to product page

%prodcodeL%

Code linked to product page

%prodtoken|xx|%

If your product description is separated into sections by the pipe character, |, this will display the xxth section. In the description: a toy train|nice train, the text "a toy train" would be section 1 (%prodtoken|001|%)and "nice train" would be section two (%prodtoken|02|%)

%prodtoken^|xx|%

If your product description is separated into sections by the carat character, ^, this will display the xxth section. In the description: a toy train^nice train, the text "a toy train" would be section 1 (%prodtoken^|001|%)and "nice train" would be section two (%prodtoken^|02|%)

%proddesc|xxx|%

Returns the first xxx characters of the product description (xxx has to be three digits, eg. 005 will return the first 5 characters). If the xxxth character is not a space (or tab) character, the string will be shortened until the last character is a space so that the displayed text will not end with a truncated word

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 18: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

%attribute_string%

The "attribute" string for the tracked item, as displayed on the product's "Inventory Manager" tab

%ouiimage#%

Display the OUI alternate images (where # is 1-3). The width and height, if specified will be used

%product|field|%

Displays the specific field from the Products database. Eg. %product|name|% will display the value in Produts.d.name

%inv_count%

The item's inventory count

%inv_note%

The item's inventory note

%level_name%

The name of the item's current "notification level"

%level_number%

The id# of the item's current "notification level"

%short_message%

The "short message" of the item's current "notification level"

%long_message%

The "short message" of the item's current "notification level"

%action%

The "action" of the item's current "notification level"

%try_count%

The inventory count which would have resulted if the "add to basket" had been successful

%new_count%

The inventory count which resulted from the reduction of inventory (if any)

%var|expression|%

Evaluates the "expression" which can include Miva script operators

%begin_if|variable|%....%end_if%

Displays the contents between the two tokens if the "expression" evaluates to "true" (i.e. Non-zero)

%begin_notif|variable|%....%end_notif%

Displays the contents between the two tokens if the "expression" evaluates to "false" (i.e. Zero)

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 19: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Importing & Exporting Inventory If you have a lot of products, you’ll probably want to import your store’s inventory. Included in the zip file you received were an import and export module, allowing you to quickly update and work with current inventory settings. To install these modules, click the arrow next to Modules in the Admin Menu, upload each, and add them to the domain. No further steps are necessary.

Before importing, we recommend you export your inventory (as wproducts manually), so you can have a better grasp on the forma

Exporting Inventory 1. In your Admin Menu, click the arrow next

to your store’s Utilities link. 2. Click the arrow next to Export Data.

3. Click the Export for Inventory Manager

link. Here, you can configure the following: Export File: This is the file name to which the inventory data will be exported, as well as the path. By default this is set to the uploads directory (which is in the mivadata/Merc Fields Template: You can use tokens to tell the module which fields to export. Eacdelimiter (we recommend the PIPE delimiter – the | above the enused:

%prodcode%

the product's code

%prodid%

the product's id

%attr_codes%

the "attribute string" used to identify the trackform [attribute code1]=option code,[attribute tracking the inventory of 2 attributes, size an2 colors, blue and green, you would get 4 itesame product id (and code) but the attribute [size]=large,[color]=blue [size]=large,[color]=green [size]=small,[color]=blue [size]=small,[color]=green

%attr_ids%

this is the "attribute string" as described for %and option codes the attribute id and option i

Copyright 2004-2006. All Rights Reserved

StoneEdge Order Manager Users: Order Manager now synchs with Inventory Manager. Refer to your OrderManager Documentation and Online Support Area for more information. Support for this functionality is provided by StoneEdge.com.

e recommended you work with a few t for the import file.

hantX/00000001/ directory.

h field needs to be separated by a ter key). The following tokens can be

ed attributes, if any. This format is in the code2]=option code, etc. So if you were d color with 2 sizes, large and small, and ms in the export file. All would have the string would vary with each:

attr_codes% but instead of the attribute d are used instead

Inventory Manager – Last Update 07/03/06

Page 20: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

%note% the note that you can configure for each tracked item

%count%

the actual inventory count for that item

%levelnow%

the current inventory level (this will the ID of the notification level)

%levels%

the notification levels assigned to this item (a string of the level ids, eg. 1,2,3)

%simple%

set to 1 if the "simple" mode for this item is set on, 0 otherwise

Export Filter: You can add a filter to control the contents of the exported file. You can use tokens to represent the various order and item data.

%prodid%

the product's id

%attr_ids%

this is the "attribute string" as described for %attr_codes% but instead of the attribute and option codes the attribute id and option id are used instead

%note%

the note that you can configure for each tracked item

%count%

the actual inventory count for that item

%levelnow%

the current inventory level (this will the ID of the notification level)

%levels%

the notification levels assigned to this item (a string of the level ids, eg. 1,2,3)

%simple%

set to 1 if the "simple" mode for this item is set on, 0 otherwise

Why would you use a filter? Let’s say you wanted to export all products that are using the default out of stock level – you could use the filter: ('2' CIN %levelnow%). When running filters, you put the value you’re searching for in single quotes, and enclose the entire filter in parenthesis. Here’s a list of possible filters: For example, to filter the configuration data for a particular product (by id) you could use the filter: (%prodid% EQ '1') – this example filters the data for a particular product (here, the product with an ID of 1). ('2' CIN %levelnow%) – filters according to the level ID of the product (in our example, we’re filtering on the level ID of 2). ((%count% GT '0') AND (%count% LT '10')) - this will return all tracked items with an inventory count

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 21: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

greater than 0, but less than 10. You could also use: GT greater than LT less than EQ equal to NE not equal to GE greater than or equal to LE less than or equal to The filter can also contain the logical operators: NOT AND OR As well as the string operators: $ IN/CIN EIN/ECIN SUBSTR Storage: This is a storage field. Any contents of the Export Filter or Fields Template fields are copied here when you do an export. This allows you to use old filters or templates by simply copying them from this area and pasting them into the appropriate place.

Obtaining the Exported File After exporting your inventory, you’ll need to FTP to the server and browse your mivadata (or htsdata) directory, then into the MerchantX/00000001/ and any subdirectory you setup in the Export File path. Download the file in ASCII mode.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 22: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Formatting the Import File

To import inventory, you’ll need to work with a flat file (you can use Microsoft Excel or Access, and save the file as a delimited file for uploading). The first step is understanding how the file needs to be formatted (which is why we recommended you work with a few products manually and then export the file). Here’s the file we obtained on the test shirt product we worked with ear test|16|1,2,5,|[Patch]=0 test|8|1,2,5,|[SIZE]=SM,[Color]=RED test|7|1,2,5,|[SIZE]=SM,[Color]=Green test|9|1,2,5,|[SIZE]=MED,[Color]=RED test|24|1,2,5,|[SIZE]=MED,[Color]=Green test|13|1,2,5,|[SIZE]=L,[Color]=RED test|16|1,2,5,|[SIZE]=L,[Color]=Green It can get a little confusing looking at it with all the PIPE delimiters, so lespreadsheet.

Because we’re tracking options, the product codes may repeat (the cou Now that you have an idea, here’s what fields can be used for importing Field

What to enter

Product Code

The Product’s Code

Product ID

Can be used in place of product code

Inventory Count

The current inventory – if it’s an unsigned numbe(just the number) it will be applied as a positive amount. Use parenthesis to denote a negative amount, i.e. (2) for -2.

InvCopyright 2004-2006. All Rights Reserved

Cool… If you previously used Miva Merchant’s Inventory Feature,you can quickly import your stock product count settings using the Import Module.

lier:

ts break it up into an Excel

nt is applied to individual options).

inventory.

Required? Yes, if not using Product ID Yes, if not using Product Code

r Yes

entory Manager – Last Update 07/03/06

Page 23: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Attribute / Option Code

Enter in the format of [AttributeCode]=OptionCode

Yes, if tracking Options.

Attribute / Option ID

Enter in the format of [AttributeID]=OptionID

Only if tracking options by ID rather than Code. Replaces above needs.

Separately?

Put a 0 for No and a 1 for Yes – this is to tell Inventory manager whether or not you want to track Attributes without Options (such as checkboxes) as separately tracked items.

Only when necessary.

Levels

Separate by coma: 1,2,3

Only if needing to assign levels.

Note

Enter note as you want it to display.

No, optional.

Simple?

Enter a 0 for No and a 1 for Yes. This tells Inventory Manager whether or not to track inventory in simple mode.

Only when necessary.

Delete

You can delete tracking for attributes by using a 1. If you want to change tracking for attributes, you must first import the product with a 1 to delete the tracking.

Only if you want to delete tracking or change tracking for attributes.

Example:

rocket|0|(8)|[fuel]=liquid|contact NASA for reordering|1,2,3|0|0| ship|0|8||no attributes to track|1,2|0|0| train|1|8||contact NASA for reordering|1,2,3|0|0| In this example, for the first item we are increasing the product's inventory by 10, for the second product, we are setting the inventory to -8, for the third we are setting the inventory count to 8, and that we are deleting tracking for the "train". The order in which you enter your fields doesn’t matter, so long as they are each aligned with each other.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 24: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Importing Inventory from a Flat File To import the inventory, you need to use the Inventory Manager import module, which was included with the module zip file you received.

1. In your Admin Menu, click the arrow next to your store’s Utilities link.

2. Click the arrow next to import.

3. Click the Import for Inventory Manager link.

4. To upload your inventory file, click the Upload button and browse for the file.

5. Set the Delimiter you used for the file.

6. Click Next.

7. e, attribute

string, etc.). Pay attention to the options of Keeping, Updating, or Replacing data.

8. Click Next.

e back-ups are overwritten ith every import so if you make a mistake catch it before you import again.

take ed or ordered. However, note that

notification emails will NOT be sent when using the import feature.

Use the pull-down menus to align your data with the appropriate fields (product cod

Before the data is imported, the module makes a back-up of the data configuration files so they can be restored if you later decide that the data was incorrect. However, note that thw Following the import, the module will determine the "current notification level" of the new count and will the appropriate action, such as keeping products from being display

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 25: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Importing from Miva Merchant’s Inventory Feature The import module for Inventory Manager will let you import product inventory counts. It also gives you the option to overwrite any existing counts you’ve already setup via Inventory Manager.

Restoring Inventory If you make a mistake on importing, you can revert to the last backup of your inventory data. The module will store only one backup, so if you need to restore the prior counts, you must do so BEFORE importing another file of inventory counts.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 26: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Troubleshooting Inventory Manager The bulk of issues that occur with Inventory Manager can be attributed to a misunderstanding of the module’s usage, or functionality, or calling in the module’s functionality when using other modules to handle displays of store pages. Should you encounter problems, we ask you first visit the Knowledge Base for this module, as many questions answered are common ones. If you are unable to find the answer, you may submit at a support ticket at our help desk.

Installing Inventory Manager

1. In the Miva Merchant Admin Menu, click the Add link next to Modules. 2. Use the upload button to upload the BROK_INVENTORY5.mvc module file to the store.

3. Once uploaded, click the Add button.

4. Click the next to your store’s link.

5. Click the System Extension link.

6. In the right-hand screen, check off the box next to Inventory Manager and click Update.

7. At the top of the screen, click the Inventory Manager link.

8. Enter your license key and agree to the terms.

9. Click Update.

Follow the same steps to install VC Attribute Templates, or the Import and Export modules files (which get installed under Utilities). Follow steps 1-4 to install each of these module files. No store assignments or license verifications will be necessary once the core module file is installed.

Updating/Upgrading Inventory Manager From time to time updates may be made to fix issues or add more features. To see if there are updates available for this module, you can click the upgrades link in the module’s admin at any time. If one is available, you can download the file and follow the instructions on updating the module.

Obtaining Support Standard support for this module is offered free of charge via the Support Desk. Standard support covers initial installation issues, confliction issues and standard usage of the module. Some issues may be considered advanced, such as requests that require custom coding or configuration. Services are offered for this type of support or work. Please inquire.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved

Page 27: Inventory Manager – version 5 - Viking Coders · 2006. 7. 17. · It also utilizes Miva Merchant basket timeout feature, so you don’t have to rely on deleting expired baskets

Before contacting support, please double-check your settings against this document, and visit the Module’s FAQ section.

Inventory Manager – Last Update 07/03/06 Copyright 2004-2006. All Rights Reserved