Quantcast
Understanding RedMystic component configuration PDF  | Print |  E-mail
FAQ Answers
Written by Garry McGillivary   

The RedMystic configuration options are designed to provide you control over how the component, feeds, rankings and sitemaps are rendered.

 

RedMystic Section - core setting of the component

REDMYSTIC_ENABLED: Enables/disables the component. No RedMystic operations or communications happen with this disabled. Most of the time you can leave this enabled; best for fully automatic operations.

REDMYSTIC_USER: this is the user name you specify when registering at www.RedMystic.com.

REDMYSTIC_PASSWORD: this is the password you specify when registering at www.RedMystic.com

REDMYSTIC_SITEKEY: this is the SiteKey code you retrieve by logging into www.RedMystic.com under 'Your Sites'. If you haven't already done so, click on 'add url', add your site url and retrieve the Site Key. Copy/paste that into the RedMystic component configuration on your site.

ROOT_SITE_URL: this will be the url of your site. It should only be necessary to change this if you are doing redirects or something special with .htaccess.

SECURE_CONNECTION: this is how information gets transferred to RedMystic server, including your Google credentials, so best leave this set to secure. However some hosting companies will block secure communications so this setting provides both secure and unsecure communication.

LOG_ENABLED: this will enable logging of server pings and product upload events. Useful in the unlikely event you need to debug an issue. Leave this 'on'. Events can be seen under the Event Log tab in the component backend.

MIN_RELOAD_INTERVAL: defaults to 'once a day', which means you can update products and it will not send updates for every product but will send after 24 hours from last upload. The default should be ok for most requirements.

MAX_RELOAD_INTERVAL: default is seven days, which means there will be an upload after seven days even if there have been no product updates. Set this to whatever frequency you desire, although the default seven days should suffice for most of us..

SHOW_STARTUP: This is the initial starter configuration screens designed to help the first time user. By default it will be set to "No" once you walk through the setup wizard for the first time.

UPLOAD_FILENAME: default is prods.zip. You can leave as-is or, if you already have a feed name specified at Google Base,  you can change it to anything you want as long as it is .zip. If your existing feed is not .zip you must define a new feed file name at Google Base. Either way, the 'Upload Filename' name in RedMystic component must match exactly the feed name at Google Base.

DIAGNOSTICS_ENABLED: this is a special diagnostic mode that aids us in debugging any issues that may arise. You would normally leave this off (default).

OPTIMIZED_IMAGES_ENABLED: this enables higher quality images to be transferred in the dimensions Google and Redmystic prefer.

MEMORY_LIMIT: this default setting will work most sites. For the occasional site that has a substantial number of products you may have to increase this number.

NEWS_FEED_CACHE: the number of hours to keep the news feed cache. Default is 24 hours, which is fine for most. Examples of feeds are teh News sections, FAQ etc

STATS_INTERVAL: In days, how often to refresh your site's RedMystic statistics. Requires the RedMystic core module for automation. *** Google statistics can be found at the merchant center.

ZIP_COMPRESSION_METHOD: two zip utilities are available to compress feeds files. For most the default will be fine. If you have large number of products ZipArchive is much more effecient but is not available on all systems. JArchive is more general purpose and should work just fine for most. JArchive is the default.

FEED_CHUNK_SIZE: Feeds are divided into fragments to reduce server load, memory consumption and time-out conditions. This setting dictates the size of each fragment. This setting is especially useful for large product sites on shared hosting environments where resources are scarce and time-outs are easily hit within a minute or two.

 

Google Section - connection information

GOOGLE_ENABLED: this sets whether you wish to feed to Google Merchant Center/Base or not.

GOOGLE_USER: this is your FTP account User Name at Google Merchant Center/Base, which you are responsible to setup. RedMystic transfers your product information to Google Merchant Center/Base via FTP and needs your login user name to make that transfer.

GOOGLE_PASS: this is your FTP account password at Google Merchant Center/Base. RedMystic needs that to make the transfer. You are responsible to setup the FTP account at Google Base.

GOOGLE_SITE_VERIFICATION_ENABLED: Enables you to post your Google site verification. If enabled and the core module is published then the Google site verification code will be added correctly to your site. *** Google will verify your home page so make sure ot publish the module there also. The verification code will be available where ever the module is published.

 

Virtuemart Section - setting to instruct the component on how to customize your feed

DESCRIPTION_FIELD: You can use either the Virtuemart long description (default) or the VM short description. Set this whichever way you prefer.

APPLY_PRODUCT_DISCOUNTS: If set to 'yes' RedMystic will upload discounted prices. Note: this is nothing to do with Virtumart coupons. Those discounts are not transferred.

APPLY_VAT: used for countries that require a Value Added Tax, notably Europe. VAT options include "AddToPrice" where VAT will be applied directly to the price of the product, "SeparateField" adds a separate VAT field to your feed for.

INCLUDE_OUT_OF_STOCK: if this is set to "Yes" then products will be included regardless of their virtuemart stock setting. Setting to "No" will only include products with stock greater than zero.

PRODUCT_CONDITION: allows you to globally set your products condition - new, used or refurbished. Not everyone sells "new".

SHOPPER_GROUP: allows you to define the shopper group for pricing, including any discounts. The default is "default shopper".

SHIPPING_METHOD: allows you to provide shipping details for your products. Fixed shipping costs are meant for static shipping costs per product. Dynamic will be calculated at RedMystic based on the customers GEO location.

INCLUDE_MEDIA_LIBRARY_IMAGES: if enabled additional images from you product media library will be sent.

INCLUDE_MANUFACTURER: will include the manufacturer with your product feed if set to 'yes'.

INCLUDE_UNIVERSAL_PRODUCT_ID: enabling this setting will direct redmystic to look at your product descriptions for special tags that include universal product codes. More detailed information can be found here

INCLUDE_PRODUCTS_ZERO_PRICE: if you have products with no pricing (e.g. Call for a quote) you can select whether to include or exclude those products.

PRODUCT_TITLE_LOGIC: having meaningful, keyword rich product titles can be the difference in obtaining click throughs. This option allows you to customize how product titles will created for your feed to redmystic and google (Note: This will not adjust your virtuemart product titles. Only the feed).

INCLUDE_CONDITION_OVERRIDE: you can also individually set product condition for each of your products. If enabled redmystic will check your product descriptions for special html tags in the form of : <div class="RM_CONDITION_OVERRIDE">PRODUCT_CONDITION</div>  where PRODUCT_CONDITIONwill be one of the following - NEW, USED or REFURBISHED. All other products will be set to the global setting of PRODUCT_CONDITION

CUSTOM_XML: an advanced setting that provides you the capability of adding static custom xml to each product. This is meant for advanced users with deep understanding of xml and the redmystic/google feed specification. 

PARENT_CHILD_PRODUCT_LOGIC:  If you used parent child products then this setting will direct redmystic to either include parents products only, children products only or both. This is useful if your child products inherit pricing and descriptions from your parent products.

 

Rank Section - Ranks are used to help you promote your site.

RANK_REDMYSTIC_ENABLED: direct the component to pull your Redmystic rank. More information about Redmystic rank can be found here

RANK_GOOGLE_ENABLED: direct the component to retrieve your Google pagerank.

RANK_ALEXA_ENABLED: direct the component to retrieve your Alexa traffic rank

 

Sitemap Section - sitemaps help the major search engine find your products

SITEMAP_ENABLED: you need to enable this whether you want to send a stiemap to Google or use as html sitemap on your site. Leave disbled if you want neither.

SITEMAP_PRODUCT_PRIORITY: this is a neat feature that will enable an increased priority of your best selling products in the sitemap sent to search engines.

SITEMAP_ADD_TO_ROBOTS_DOT_TEXT: this will automatically write your sitemap location into the Robots text file so all search engines can find it. Your Robots.txt file must be writeable to use this feature.

SITEMAP_YAHOO_ENABLED: tells RedMystic to send the sitemap to Yahoo for you.

SITEMAP_YAHOOAPIKEY: Yahoo requires your API key in order to send them the sitemap. You will need to set that up at Yahoo. It is a code that looks something like this: 3fbdcfe0672cb7d9. If you have already installed the Yahoo html file in your root you will find it there.

SITEMAP_GOOGLE_ENABLED, SITEMAP_BING_ENABLED, SITEMAP_ASK_ENABLED and SITEMAP_MOREOVER_ENABLED settings will send the sitemap automatically to these major search engines if set to "yes".

 

 

Last Updated on Sunday, 30 May 2010 21:27