Top Banner
Store Finder Magento ® Extension User Manual This is the user manual of Magento ® Store Finder v1.8.3 and was last updated on 23-12-2017. To see what this extension can do, go to the Magento ® Store Finder product page . You can find the full release info and version history of this extension here.
27

Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Jul 19, 2020

Download

Documents

dariahiddleston
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store Finder Magento® Extension

User Manual

This is the user manual of Magento® Store Finder v1.8.3 and was last updated on 23-12-2017. To seewhat this extension can do, go to the Magento® Store Finder product page . You can find the fullrelease info and version history of this extension here.

Page 2: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Table of Contents

Configuring the Store Finder Extension

Managing Store Locations

Store Information

Store Location

Custom Store Attributes

Store Products

Store Meta Data

Managing Store Comments

Importing and Exporting Stores

Store Finder Front-end Examples

Page 3: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Configuring the Store Finder ExtensionTo configure the extension, navigate to System > Configuration in the top Admin Panel menu andselect Store Finder from the left side menu.

Using the config page you can modify the Store Finder general settings and the front-end display options ofthe following extension features:

Store Page Settings: each store location has a dedicated store page including address, contact details,opening hours, Google Maps location, a store description and uploaded store image. Besides that youcan add an Additional Details section with custom store attributes and a Customer Comments section tothe store page. See the chapter on managing store locations to configure the content and settings ofeach store page.Store Locations Settings: the Store Locations list page shows an overview of all your stores, including themost important visitor information and a link to the dedicated store page.Store Finder Settings: the Store Finder page includes the Google Maps based store locator withintegrated route planner.Product Page Settings: by enabling the extension’s product page integration, customers can search forstore locations directly on the product page.

It’s possible to configure the extension per store view by changing the ‘Current Configuration Scope’ at thetop left corner of the page.

To save any changes made in the Store Finder settings, click the ‘Save Config’ button in the top right cornerof the configuration page.

General Settings

In the extension’s General Settings you can:

Enable the extension for the current store view.Enable breadcrumbs to show the breadcrumbs navigation at the top of all Store Finder pages.Enter a default URL prefix and suffix for the Store Finder page and dedicated store pages, for example:https://www.example.com/stores/{urlkey}.html. The URL key can be configured for each page separately(see Store Finder Settings and Store Page Settings).Enter your personal Google Maps API key, which in some cases needs to be added in case Google MapsAPI errors are encountered in the front- and back-end Store Finder pages.

Javascript / CSS Libraries

Page 4: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

You can choose to include the Store Finder Javascript and CSS libraries. Select ‘No’ of your store themealready includes jQuery or Font Awesome.

Store Page Settings

In the Store Page Settings you can configure whether guests and/or logged in customers are allowed toreview and rate your stores in the Customer Comments section of dedicated store pages.

You can also enable the Customer Comments section for each store separately in the Store Information tab.

By enabling the store rating option, customers can rate the store when leaving a comment with up to fivestars.

Logged in customers can view their submitted reviews in the Store Locations Comments tab of their customeraccount.

Store Locations Settings

In the Store Locations Settings you can:

Configure a custom URL key for the Store Locations list page, which shows an overview of all your stores.Enter a comma-separated options list for the Store Locations page filter, which can be used to select theamount of store locations shown per page.Set a default amount of store locations shown per page, which should be a value that’s included in thefilter options. Enter ‘all’ to show all store locations on one page.Choose to show a custom store image in the list view instead of the default Google Maps location image,which can be uploaded in the Store Information tab.Optionally add a Store Locations link to your store’s top menu, header and/or footer links. Please notethat the menu item is only compatible with Magento® Community editions 1.7 and above and that theheader link will be placed in the Account dropdown menu in Magento® 1.9 and above.Enter a custom Store Locations title for the menu item and header/footer links.Add the Store Locations meta data, including page title, description and keywords.

Page 5: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store Finder Settings

In the top section of the Store Finder Settings you can:

Configure a custom URL key for the Store Finder page which includes the Google Maps based storelocator and route planner.Enter a custom Store Finder page title and description, which are shown above the store locator.Optionally add a Store Finder link to your store’s top menu, header and/or footer links. Please note thatthe menu item is only compatible with Magento® Community editions 1.7 and above and that the headerlink will be placed in the Account dropdown menu in Magento® 1.9 and above.Enter a custom Store Finder title for the optional menu item and header/footer links.Add the Store Finder page meta data, including page title, description and keywords.

Page 6: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

In the bottom section section of the Store Finder Settings you can:

Enable auto-geocoding, allowing the store locator to automatically try to detect the visitor’s location.Configure a default map location, which will be used if the visitor’s location isn’t specified or detected.Select the measurement unit for calculating map distances, which can be set to miles or kilometers.Enable radius selection, adding a maximum distance filter menu to the store locator.Enter a comma-separated options list for the radius selection filter.Set a default radius selection, which should be a value that’s included in the filter options. Leave the fieldempty use any distance.Enable the store name filter option.Select a default map zoom level which is used when the visitor’s location is specified or detected.Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all yourstore locations.Choose to mark the visitor’s location on the map and optionally upload custom marker images.Change the map theme by adding a custom JavaScript style array in the text area. You can find a largecollection of free Google Map themes on snazzymaps.com, where you can simply copy the desired themestyle and paste it into the ‘Custom map theme’ area (see custom map theme front-end examples).

Page 7: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store Finder Preview Links

The Store Finder Preview Links section shows the front-end URL(s) of your Store Finder page(s), whichare updated when saving changes made in the Store Finder Settings.

Product Page Settings

In the Product Page Settings you can optionally enable the Store Finder product page integration, enablingcustomers to find stores based on their product availability using the Store Locations and/or Store Findertab in the product details menu.

Page 8: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

If you choose to manually manage the store location inventory, you can select the available products for eachstore in the Store Products tab.

Vice versa you can also select the available store locations for each product in the Store Locations tab of theproduct view (Catalog > Manage Products ).

If you disable the ‘Select store location products’ option, all your store locations will be displayed in theproduct details menu by default.

You can separately enable the auto-geocoding function for the product page Store Finder tab, which will onlywork if this option is enabled in the Store Finder Settings as well.

Cache Settings

In the Cache Settings you can optionally enable the store locations cache.

The cache lifetime in seconds defines how long the store location data is cached before refreshing it.

If the store locations cache is enabled, you need to rebuild the Store Finder cache after editing your storelocations in order to show the changes on the front-end.

To rebuild the Store Finder cache, navigate to System > Cache Management and click ‘Flush Store FinderCache’ at the bottom of the page.

Iframe Embedding

In this section you can find the Store Finder Iframe embed code(s) which can be used on external websites.

Page 9: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s
Page 10: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Managing Store LocationsTo manage your store locations and dedicated store pages, navigate to CMS > Store Finder > ManageStore Locations in the top Admin Panel menu.

Select a store location from the grid to edit it, or create a new location by clicking the ‘Add Store Location’button in the top right corner of the page.

Use the following tabs of the store view menu to create and configure your store locations and store pages:

Store InformationStore LocationCustom Store AttributesStore ProductsStore Meta DataStore Views (for multi-store setup)

Page 11: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store InformationIn the Store Information tab you can configure the content and settings of the dedicated store page and andthe front-end display options of the Store Locations and Store Finder page as further explained below.Store Page Settings

In the top section of the Store Information tab you can:

Enter the store name, contact details and opening hours which are shown in the top section of thededicated store page (the website URL should be entered without the http:// prefix).Add a store description and upload a custom store image.Configure a custom URL key for the store page.Enable the Customer Comments section for this specific store page, or use the default configuration.Enable the store location to include it in the front-end Store Finder pages.

Front-end Display Settings

In the bottom section of the Store Information tab you can:

Choose whether the store page should be included in the Store Locations list page and Store Finderpage.Define the store’s sort order on these pages, which by default sort store locations by their ID.Choose to use the uploaded store image on the Store Locations list page instead of the default GoogleMaps image, or use the default configuration.

Page 12: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s
Page 13: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store LocationIn the Store Location tab you can configure the store’s physical location for the Store Finder page and theGoogle Maps location shown at the top of the store page.

By entering an address in the ‘Full address’ field, a dropdown menu will appear which can be used to auto-complete the store location details.

Of course you can also enter the address manually or edit the auto-completed details. The map on the rightwill automatically show the corresponding location, marked with a red place mark.

You can click and drag the map to change its focus and adjust its zoom level and map view.

Alternatively, it’s possible to change the store’s location by dragging an dropping the map’s place mark toanother position, which will automatically update the address details on the left.

Page 14: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s
Page 15: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Custom Store AttributesIf you’d like to add custom details to store pages, you can create custom store attributes which can beconfigured per store location in the Custom Store Attributes tab.

The custom store attributes will be displayed in the Additional Details section of the store page and can alsobe used as filters on the Store Finder page.

Creating Custom Store Attributes

To create and manage store attributes, navigate to CMS > Store Finder > Custom Store Attributes inthe top Admin Panel menu and click ‘Add New Attribute’ in the top right corner of the page.

Attribute Properties

In the Attribute Properties tab you can:

Enter a attribute code/name for admin reference.Define the sort order of the attribute on the front-end store page.

Page 16: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Add a description of the attribute for admin reference which is used in the Custom Store Attributes tab.Select one of following attribute input types: Text Field, Text Area, Date, Yes/No, Multiple Select orDropdown.Optionally enter a default attribute value. (For the ‘Multiple Select’ and ‘Dropdown’ input types you canconfigure the default value in the Attribute Label / Options tab.)Choose an input validation method if the selected input type is a text field.Choose to show the attribute on the Store Finder page and/or in the Additional Details section of thededicated store page. Please note that only attributes with the input type ‘Yes/No’, ‘Multiple Select’ or‘Dropdown’ can be used as store locator filters on the Store Finder page.Select the Store View(s) in which the attribute should be visible.

Attribute Label / Options

In the Manage Titles section you need to enter a label for the store attribute which will be shown on the front-end store page.

In case of multiple store views, you can enter a label for each store view separately or use the default‘Admin’ label for all store views.

If you have selected the ‘Multiple Select’ or ‘Drop-Down’ input type, you can add the attribute options in theManage Options section by clicking the ‘Add Option’ button on the right.

Same as with the attribute label, you can enter an option name for each store view separately or use the

Page 17: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

default ‘Admin’ value for all store views.

You can select one or multiple default options by ticking the ‘Is Default’ box on the right and define the sortorder of the options in the ‘Position’ field.

Page 18: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store ProductsIf you have enabled product page integration in the Product Page Settings and choose to manually managethe store location inventory, you can select the available products in this specific store location in the StoreProducts tab.

Please note that the Store Products tab will be hidden if all products are available in each store by default.

It’s also possible to select the available store locations for each product in the Store Locations tab of theproduct view (Catalog > Manage Products ).

Page 19: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store Meta DataIn the Store Meta Data tab you can enter the store page meta title, description and keywords.

Page 20: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Managing Store CommentsIf store comments are enabled in the extension’s config screen and individual Store Page Settings,submitted reviews and ratings can be managed by navigating to CMS > Store Finder > Manage StoreComments in the top Admin Panel menu.

Select a comment from the list to modify it or change its status.

You can change the status of multiple comments at once using the ‘Actions’ dropdown menu in the top rightcorner of the page.

The comment will not be shown on the front-end store page unless it has been approved by a moderator.

Using the store location link at the top of the Store Comment tab you can view the store page in the back-end.

In the Store Views tab you can choose in which store(s) the comment should be shown (in a multi-storesetup).

By default the store view is selected in which the comment has been submitted.

Page 21: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Importing and Exporting StoresTo import or export store locations in CSV format, navigate to CMS > Store Finder > Import / ExportStores in the top Admin Panel menu.

The Store Finder import and export functionality can be used to quickly create or edit multiple store locationsat once.

Export Store Locations

Click the ‘Export’ button in the Export Store Locations tab to download all existing stores to a CSV file.

Import Store Locations

Open the Import Store Locations tab to import stores from a CSV file.

Best practices for importing store locations are provided below as well as in the bottom section of the ImportStore Locations tab.

Importing New Store Locations

The easiest way to import new stores is to create one store location manually first, run an export and use theresulting CSV file as a template.

Because custom store attributes without values are not exported, it’s recommended to assign a value toeach custom attribute before running an export.

To import new store locations, simply leave the ‘entity_id’ column of the CSV template blank or completelyremove it.

Fill the other columns with the desired store data and import the saved CSV file in the Import Store Locationstab.Updating New Store Locations

To update existing store locations, run a CSV export of your stores and modify the store data wherenecessary, making sure to keep the ‘entity_id’ column intact.

Import the updated and saved CSV file in the Import Store Locations tab.Updating Specific Data Only

When importing store locations, only the values of the columns included in your CSV file are updated; the

Page 22: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

values of attributes that are not included in the CSV file are left as is.

When updating specific data only, your CSV file should at least contain the ‘entity_id’ column and one(custom) attribute column.Importing Store Images

To import store images using a CSV template:

Upload the store images to the following directory on your web server, in which [magentodir] is the rootfolder of your Magento® installation: [magentodir]/media/storelocation/import/Enter the following data in the ‘image’ column of your CSV template: /import/[filename].[ext] in which[filename] refers to the file name of the image and [ext] to the file extension.For example, when importing the following image: media/storelocation/import/myimage.jpg, thevalue entered in the CSV template would be: /import/myimage.jpg

Retrieving Geocode Locations

Based on the entered address in the CSV file, the Store Finder extension can automatically calculate the storelocation coordinates during import using the Google Geocode Location API.

These coordinates are used to define the exact map location which is shown on the front-end store page.

To auto-calculate the store location coordinates during import, check the ‘Retrieve Geocode locations’ box inthe Import Store Locations tab.

The Google API will only calculate the coordinates of the stores that have no longitude and latitude values(‘lng’ and ‘lat’ columns) in the CSV file.

The Google Geocode Location API is limited to 2000 requests per 24 hours. When importing a large storedatabase it’s therefore recommended to only check the ‘Retrieve Geocode locations’ box on the final import,so you won’t use up the Geocode API limit while testing.

Because the Google Geocode API is also limited to 5 requests per second, it might take a while to import alarge number of store locations at the same time (approx. 1000 stores per 3-4 minutes).

Page 23: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Store Finder Front-end ExamplesBelow are front-end examples of a dedicated store page, a Store Locations list page, a Store Finder page withthe Google Maps store locator and integrated route planner, the integrated Store Finder product pagetabs, and custom store locator themes.

Store Page

Example of a dedicated store page with uploaded store image, custom store attributes and customercomments.

Store Locations Overview

Page 24: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Example of Store Locations list page showing custom store images, breadcrumbs navigation and StoreLocations and Store Finder links in the top menu.

Store Finder / Locator

Example Store Finder page with Google Maps based store locator, maximum distance / radius dropdown,store name filter, filterable custom store attributes and integrated route planner. The address bar includesa auto-complete function and optional automatic Geocode detection; distances can be calculated inkilometers or miles.

Product Page Store Finder

Page 25: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s

Example of Store Locations overview integrated into the product details menu of the a product page.

Example of Store Finder page integrated into the product details menu of a product page.

Custom Map Themes

Examples of personalized store locators using custom Google Map themes and uploaded marker icons.

Page 26: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s
Page 27: Store Finder Magento Extension · Configure the maximum amount of store locations shown on the map at once. Enter ‘-1’ to show all your store locations. Choose to mark the visitor’s