Frequently Asked Questions
<< Main Category < Parent Category
How do I setup an OpenToken?
SYMPTOMS
Several of our modules offer OpenTokens for advanced users. OpenTokens are a feature of OpenUI that allow third-party modules to be used in specific parts of Miva Merchant, such as headers and footers. OpenTokens are also used extensively within templating systems, such as OpenUI Supermod Templates, Category and Product Page Templates, and OpenDesigner.
SOLUTION
To use a module's OpenTokens, you must first register that module with OpenUI. To do so, log into Miva Merchant admin and click the blue triangle next to Stores. Then click the name of your store. On the right side (assuming you have OpenUI installed and active) you will see a link that reads "Tokens". (It may have the OpenUI logo or stoplight image next to it.) Click this link.
Before you register a module, you will need to know the module code. You can find this by looking at the module under the Modules section of Miva Merchant admin.
Once you have the module code, to register it, click the round button in the blue bar that has the image of a piece of paper on it, surrounded by yellow. (In many browsers, if you place your mouse over this button, the words "New Module Token" will appear.) Scroll down to the new blank row. In the first box, enter the module code. You may enter any text you like in the second box, so long as it is unique from all other rows; we recommend simply reusing the module code. Whatever you enter in the second box will become part of your token. Once you have filled in these two boxes, click the update button.
Each entry in this list has a "Click Here" link that will display instructions for using that module's tokens. To use a module's tokens in a specific area of Miva Merchant admin (for instance, the global header), first make sure the textarea begins with the 5 characters %OUI%. Then enter the module's tokens wherever you want the output to be displayed.
For example, our Icon Manager module offers a token to display the icons defined for the product screen. To display the output of this token, you would enter the following text into the appropriate location:
%module|NBICONMGR|showicons_prod%
The second part of the token, NBICONMGR, is the token name you used when registering the module under Tokens in Miva Merchant admin. If you used a different token name, change the token string as needed to match that entry.
|
