Configuration Guide

Format

The configuration is read from app/code/local/Elite/Vaf/config.ini. We use the ini configuration format.

Default Configuration

A default file is located in Vaf/config.default.ini - you should copy this file & rename to config.ini, and edit the settings as you desire. Where possible, a comment (prefixed with a semicolon ';') will appear describing a setting, within the config.ini. For a full description of a setting, please refer to this extended configuration guide.

Catalog Categories

[Category]

Controls how the extension modifies your category pages. Also see related settings homepagesearch/exclude_categories and categorychooser/ignore which are settings that control behavior related to categories on other store pages.
  • disable - Disable filtering on all category pages.

    This is if you want the vehicle search to "be seperate" from your main store, for "window shopping" style. If disable is set to true, the extension will provide the make/model/year search form and filter on all category pages by default, unless white/black listing is in effect.

    Example usage: disable = true

  • mode - Change the category mode for when user clicks through to a category page.

    Defaults to "default". Alternatively specify "group" for 'group view' on every category page.

  • whitelist - Allows you to control for which categories filtering is enabled. Should be a comma separated list of category IDs.
    blacklist - Allows you to control for which categories filtering is disabled. Should be a comma separated list of category IDs.
    For instance if only one of your categories is applicable to the make/model/year search. Works according to these rules:
    • If whitelisting is specified, and the customer is on the category specified, the they will see the filter.
    • If blacklist is specified, and the customer is on the category specified, the they will not see the filter.
    • If neither is specified, the value of "disabled" will control wether the customer will see the filter.

    Example Usage:
    whitelist = "4,3,2"; only enable the search on this category
    blacklist = "1,2,3" ; do not enable the search on this category

  • requireVehicle - Allows you to require user to select a vehicle before seeing products. Should be a comma separated list of category IDs. Optionally set to "all" to match all category IDs.
    Example Usage:
    requireVehicle = "1,2,3"
    requireVehicle = "all"
    The splash page that is shown can be edited in vaf/splash.phtml

Search Filter

[search]

[directory]

Controls behavior of the vehicle link directory module

Product

[product]

Controls how the extension modifies your products & shopping cart.
  • requireVehicleBeforeCart - Require the user to choose a vehicle before adding product to cart

    Set to true to require the user to choose a vehicle before adding product to cart. If enabled users will be presented with an intermediate page, and asked to choose their vehicle from a list of compatable vehicles before adding the product to the cart. The default behavior is for this to be turned off, unless you set it to true.*[1][2]

*[1] Will only affect categories that are enabled. Will only affect product that are in enabled categories. If product is in both a blacklisted & whitelisted category, it will be treated as if it is whitelisted.
*[2] Will only occur if the product actually has fitments mapped to it, if not there would be no possible choices and it would not make sense to show it.

My Garage

[mygarage]

Control the "My Garage" Functionality
  • show - Set to true to show the "My Garage" block.
  • collapseAfterSelection - Tuck away the search into "low profile mode" after selection is made.

    Set to true to collapse the "year/make/model" search block. If enabled, the customer will only see the search drop downs when they first hit the home page. After they select their vehicle the drop downs will be hidden in favor of the smaller footprint "my garage" with change button.

[homepagesearch]

Control how your customer uses the extension to search from the home-page.
  • mode - Change the search results display mode

    Valid values are "group", "category" or "grid".
        grid will enable a sortable native Magento grid grouping all products in one giant group.
        category will enable a category listing (See "category view").
        group will enable a javascript powered interface where products are grouped according to their location in the category tree

  • exclude_categories - Specify comma delimited category ids to exclude those category's product from being included in the homepage search. Works for group view only (see 'mode' setting above).

Category Chooser

[categorychooser]

You can allow your customer to choose from a list of "top level" categories to search in when using the vehicle search. If not used, searches will cover all categories.
  • onHomepage - Show the category chooser on the homepage

    Set to true to place a chooser on the homepage. Set to false and the customer will never see a category chooser on the homepage. If not specified, the system would default to the below option "onAllPages". If neither option is specified, there will be no category chooser on any page. If both options are specified, the value of "onHomepage" will always take presdence for the homepage.

  • onAllPages - Show category chooser on pages other than homepage

    Set to true to place the chooser on all pages. Note that if "onHomepage" (see previous option) is specified as well, it's value will take presedence on the homepage.

  • allOptionOnHomepage - Show "all" as the first option of the category chooser (for homepage)

    Set to true to have "All" as a category option on homepage. Follows same rules as onHomepage & onAllPages regarding precedence

  • allOptionOnAllPages - Show "all" as the first option of the category chooser (for all pages)

    Set to true to have "All" as a category option. Follows same rules as onHomepage & onAllPages regarding precedence

  • allCategoryOptionText - text to show for the "all categories" option

    Set to the text you want to use in place of "All" on the category chooser, if ommited or blank, "All" will be used by default.

  • ignore - Category IDs to ignore

    Ignores any category IDs listed, they will not show up in the "category chooser". List them out seperated by comma. If you do not put an ignore paramater then all categories will be listed by default.

Automotive Search Engine Optomization

[seo]

Control how the extension affects your search engine optimization (SEO).
  • htmlSitemap - Enable an HTML sitemap? Set to true or false.
  • rewriteProductName - Rewrite Product Names. If set to true the name of the vehicle will be appended to the product name. Will only affect products in whitelisted (and/or non blacklisted) categories.
  • globalRewrites - When rewritten globally, the product title will appear rewritten eveywhere [globally], including but not limited to the page's html title tag and shopping cart. If this option is not activated, you must use a snippet for each place you want the product's title to appear rewritten.
  • productNameTemplate Change how product titles are altered

    Template for changing how product titles are changed. Defaults to '_product_ for _vehicle_'

  • rewriteLevels Change how URLs are generated

    For example, if your schema is make/model/year you could set this to "make,model" to not have a page for each year. You must only omit levels off the end.

[logo]

Controls the optional logos module.
  • disable - Disable the module. Set to true or false.
  • extension - Defaults to 'PNG', set to the file extension that will become the filename suffix for your logos.
  • level - Defaults to "make", or if there is no level called "make" in your schema, your root (first) level. Specify this setting to override which level is used for the logo's filename.

Importer

[importer]

Controls the import/export module.
  • allowMissingFields - Defaults to false. If set to true, import files will be accepted with less than all the "levels". Missing levels will be treated as if they were included but every row set to "Base".
  • Y2KMode - Defaults to true, enables Y2k Mode. Converts 2 digit years to 4 digit years as per the Vehicles List Import documentation.
  • Y2KThreshold - Defaults to 25. If a two digit year is less than this number, it assumed to mean 21st century; otherwise 20th century.

Tire

[tire]

  • populateWhenSelectVehicle - Wether to preselect tire size when selecting vehicle. Set to true or false. Defaults to true.

Module Status

[modulestatus]

  • enableVafwheel true/false to turn on/off wheel module
  • enableVaftire true/false to turn on/off tire module
  • enableVafwheeladapter true/false to turn on/off wheel adapter module