Business directory administration

You can access the component settings in the backend at any time, by selecting from the main menu Components->J-BusinessDirectory. You will be presented with a list of options that will allow you to setup your business directory.

The administrator has the following features available

  • General Settings (extension settings)
  • Categories
  • Business Listings
    • Business Listings
    • Business Categories
    • Custom Attributes
    • Business Types
    • Business Messages
  • Offers
    • Offers
    • Offer Categories
    • Custom Attributes
    • Coupons
  • Events
    • Events
    • Event Categories
    • Custom Attributes
    • Event Types
  • Packages
  • Discounts
  • Orders
  • Taxes
  • Payment Processors
  • Countries
  • Reviews
    • Reviews
    • Review Questions
    • Review Criteria
    • Review Responses
    • Review Abuses
  • Reports
  • E-Mail Templates
  • Cities (displays only when limit city is set to yes in application settings)
  • Update
_images/21.png

Also in the dashboard section can be found some useful news, links and statistics. The statistics are associated with a chart (for business listings, offers, events and income). The chart depends on the dates that the user inserts.

In the following section we’ll describe in detail the above-enumerated options

General Settings

In the application settings screen a series of global settings can be set. Available settings are organized in the following sections:

  • General Settings
  • Business Details
  • SEO
  • Metadata settings
  • Frontend
  • Business Listings
  • Attribute Configuration
  • Offers
  • Events
  • Languages

General Settings

_images/22.png

General Settings

Date Format: The format of the date displayed throughout the application, front end and backend.

Time Format: The format of the time displayed throughout the application, front end and backend.

Enable cache: enable/disable cache for the search results for business listings, offers and events.

Enable RSS Feeds: You can set whether you want to activate RSS Feeds or not. If the mechanism is enabled an RSS icon will appear on business listings, offers and events list view.

Enable social sharing: You can set whether you want to activate social sharing or not. If the mechanism is enabled a button will be displayed on a business listing, offer and event view.

Enable multilingual content: enable multilingual content. A separate tab, linked to each language located in extension language folder, will appear above the principal items of the extension.

Enable CAPTCHA: enable CAPTCHA on contact form and review form

Note

When enabling CAPTCHA on J-BusinessDirectory you must enable also CAPTCHA plugin in manage plugins and set default captcha in Joomla General Configuration.

Enable Bookmarks: You can set whether you want to activate bookmarks or not. If the mechanism is enabled a new box will be also displayed in the control panel section.

Enable attachments: You can set whether you want to activate attachments or not. If the mechanism is enabled the attachments upload section will be displayed.

Enable attribute categories: When setting to yes, the custom attributes for listings, offers and events, will be linked with their main category and only those attributes that are associated with that category will be shown on their edit views and details views. If the category input field is left empty, the custom attribute will display by default for all categories selected.

Enable criteria categories: When set to yes, the review criteria will be linked with the main category of the listings. Only the criteria linked to that category will display in the review section. If the category input field is left empty, the criteria will display by default.

Maximum number of videos: You can set the maximum number of videos that can be added.

Maximum number of attachments: You can set the maximum number of attachments that can be added.

Metric: Set the metric to miles or km.

Expiration notification days: an e-mail will be sent to business owner (if the link from chapter 6 is called) before expiration with the number of days provided. E.g. If the number of days equals 5, the user will receive an expiration notice 5 days before the business listing expires.

Enable front-end ACL: enables the Access Control List on front-end. If disabled the ACL would not be activated on front-end.

Note

Before enabling the front-end ACL please make sure that permissions are correctly defined on Joomla ACL.

Choose usergroup: You can determine the usergroup of the users that are going to be registered on the directory registration page. The directory registration page will be shown after a payment plan is selected.In this way, you can have multiple user groups with different access rights.

Business user group: It sets the usergroup that will be added for the users that are going to create a new business listing.

Enable HTTPS on payment page: Allows the possibility to perform the payments on a secured page. In order for this feature to be active, you have to make sure that your site supports https protocol. If you face any issues related to https protocol please contact your hosting provider.

Business update notification: When set to yes the directory admin will receive an email each time when a change is performed on a business listing.

Maximum number of review images: You can set the maximum number of images that can be added in a review. When set to 0, the image upload will not display.

Currency

Name: the currency that will be used in the directory

Currency symbol: the currency symbol (it can be HTML code or text)

Currency display: how will the currency be displayed, name or symbol

Show currency: the position of the currency related to amount, in front or after

Amount separator: the decimal separator

Terms & Conditions

The terms & condition for directory listings. It appears when a business listing is added.

The terms & condition for reviews. It appears when a new review is added to a business listing or on an offer.

Business Details

_images/23.png

Business Details

Name: Name of the business directory. The value of the name field is used to replace the [company_name] email tag when used in the email template.

Email: E-mail used when sending e-mails.

Facebook: Facebook of the business directory.

Twitter: Twitter of the business directory.

Google+: Google+ of the business directory.

LinkedIn: LinkedIn of the business directory.

YouTube: YouTube of the business directory.

Logo: The logo used on the business directory.

Invoice Information

Name: Name of the business directory that will be applied on user invoice.

Address: Address of the business directory that will be applied on user invoice. 1 Telephone number: Telephone number of the business directory that will be applied on user invoice.

Email: Email of the business directory that will be applied on user invoice.

VAT identification number: VAT ID number of the business directory that will be applied on user invoice.

VAT: Value-added tax – it will be applied on user invoice.

Invoice Details: YouTube of the business directory.

SEO

_images/24.png

Enable SEO: You can set whether you want to activate SEO mechanism for companies or not. If the mechanism is enabled the business listing like will look like www.your-site.com/listing-name.

Menu item ID: Set the menu item id for search and business listing view.

Business Url Type: provides the possibility to set the business listing URL based on region or category.

Category Url Type: provides the possibility to add/remove the category keyword on category URLmake.

Add menu item alias on URL: provides the possibility to add/remove the menu item alias from URL.

Add id in URL: Add/remove the item id from URL.

Add language code to URL: provides the possibility to add/remove language code to/from URL

Metadata settings

This section allows you to enter the metadata that will be shown for each business listing page. It gives also the possibility to introduce the text that will be published on Facebook on business listing sharing.

_images/25.png

Front end settings

Frontend settings allow you to choose certain views when it comes to categories, some general settings and map results.

_images/26.png

General

Include country in address: You can set whether you want to include the country in address or not.

Address format: You can choose one from different address formats available (American style or European style).

Gallery adaptive height: You can set whether you want to activate adaptive height mode on galleries or not.

Gallery autoplay: You can set whether you want to activate auto-play mode on galleries or not.

Map

Google map key: Enter the map key from your Google API Dashboard. For more details please check Google Map is not working or location has disappeared? on FAQ Section.

Google map key-zipcode: Map key that that will have no restrictions. This key will be used for extracting the map coordinates from the zip code and it will not be available on front-end. For more details please check Google map is not working or location has disappeared?On FAQ section.

Map auto-show: You can set whether you want to show the Google Map with the markers on the search results.

Enable Google Map Clustering: You can set whether you want to activate Google Map Clustering or not.

Latitude: You can determine the latitude of the initial point that you need to be centered on the map.

Longitude: You can determine the longitude of the initial point that you need to be centered on the map.

Zoom: You can determine the zoom level that fits your needs best, it will be applied in the map.

Enable auto locate: By activating this option you will make sure that all markers will fit within the map borders.

Apply in search: By enabling this option you will activate the initial point that you determined by setting the latitude, longitude and zoom above.

Map marker: You can choose a default map marker for the listings to show on the maps. It will display only for those categories that don’t have a map marker on its own.

Categories

Categories view: Categories can be presented in 4 ways.

  1. Style 1
_images/27.png
  1. Style 2
_images/28.png
  1. Style 3
_images/29.png
  1. Style 4
_images/30.png

Show category description: Show/hide category description on search results (businesses categories, events categories and offers categories)

Maximum number of categories: You can set the maximum number of categories that can be created.

Show the total number of businesses in a category: When set to yes, it can show the number of businesses that a category has.

Business Listings

Business listings settings allow you to choose certain views when it comes to business listing and business listing search result.

General Settings

_images/31.1.png

Enable Packages: You can set whether you want to activate Packages or not. More details on the packages can be found in the packages section.

Edit form type: When setting to tabs, the business listing edit view will display on tabs. When set to one page, all the features will display in one page.

Enable Ratings: Enable/Disable ratings

Enable Review: Enable/Disable reviews

Reviews by users only: Reviews can be posted only by login users

Enable Claim Business: Enable/disable claim button

Show pending approval: This allows the possibility to show on search results the businesses that have approval status to pending approval. The business listing will be shown directly on front-end without the site admin action to validate the business listing.

Show pending review: When set to yes, the review will show on front-end business listing view, without being approved by the admin of the site on back-end

Enable Contact Business: When set to yes, it enables the contact business button

Show details only for login users: When this option is active only some basic information is displayed to non-login users. Only after a user login the full information will be shown.

Show email: Shows the business listing email on business listing details page.

Maximum number of pictures: Maximum number of pictured that can be upload on business listing page.

Maximum number of videos: Maximum number of videos that can be set on business listing page.

Maximum number of business listing: Maximum number of businesses that can be created by a user account.

Enable secondary location: Allows the possibility of entering secondary locations for a business listing.

Enable link follow: When setting to yes, it will display rel=”follow” or rel=”nofollow” depending on the package feature for the listing. When set to no, it won’t display anything, even if the “link follow” is a package feature.

Business listing details

_images/para40.png

Business listing view: Business listing information can be shown in 5 ways: Style 1, Style 2, Style 3, Style 4 and Style 5. Each view has a different layout.

  1. Style 1
_images/40.png
  1. Style 2
_images/41.png
  1. Style 3
_images/42.png
  1. Style 4
_images/43.png
  1. Style 5
_images/44.png

Show number of views: When set to yes, it shows the number of business views in business listing details, offers and events.

Social profile: It adds a social profile for the extension mentioned on business listing pages and shows the profile of the business owner from this extenions.

Enable reporting: When set to yes, it enables the Report Listing button on the business details view.

Attribute Configuration

You can set here which business listing attributes are mandatory, optional or will be not displayed on both, edit views and details views.

Apply configuration for offers: When set to yes, the attribute configuration will apply also for the offers, but only for those attributes that belong to offers.

Apply configuration for events: When set to yes, the attribute configuration will apply also for the events, but only for those attributes that belong to events.

Offers

_images/46.png

Enable Offers: You can set whether you want to activate offers or not. More details on the Offers can be found in the offers section.

Maximum number of offers: You can set the maximum number of offers that can be created.

Enable Offer Coupons: You can set whether you want to activate or not coupons functionality for offers.

Search

Default order offers: You can set the default order that the offers will display

Enable search filter offers: Enable/Disable search filter on offers page

Offer search results grid view: Offers the possibility to choose between 2 grid layouts

  1. Style 1
_images/47.png
  1. Style 2
_images/48.png

Offer search results list view

_images/49.png

Default offers view: You can choose between two layouts: grid and list.

Offer Details

Offer details view: You can determine the style of the offer details view

Events

_images/50.png

Enable Events: You can set whether you want to activate events or not. More details on the Events can be found in the events section.

Maximum number of events: You can set the maximum number of events that can be created.

Enable event subscription: When set to yes, on the event edit view will display the option to enable event joining that will enable the Join option for the actual event.

Search

Default order events: You can set the default order that the events will display on frontend

Events - Enable search filter: Enable/Disable search filter on events page

Default events view: Possibility to choose between grid or list layout

  1. List view - Style 1
_images/51.png
  1. Grid view
_images/52.png

Event search results list view: Possibility to choose the list layout

Event Details

Event details view: You can determine the style of the event details view

Languages

You can create and modify from this section the desired languages.

_images/53.png

Categories

You can define a list of categories/subcategories that will be available for owners to classify their companies, offers and events. You can filter the categories by selecting the filter type (Business, Offers and Events).

You can add, edit, delete or add a new subcategory by using the buttons available on the interface.

_images/54.png

Import from CSV

In order to add categories from an existing source, the extension provides a tool to import from a CSV (comma separated values) file.

_images/55.png

Before you start the import process you have to make sure that your file is correctly formatted. You can check if your file respects the rules bellow:

  1. CSV file values can be separated by a comma (,) or semicolon (;). They are called delimiters.
  2. Headers must be specified on the first line. Headers are case sensitive. Not all fields are mandatory.
  3. All records must be entered on one line.
  4. All lines should contain the same number of comma-separated fields. If the fields are empty you can leave it empty but add the delimiter. Each line has to have the same number of commas or semicolons.
  5. Any field may be quoted (with double quotes).
  6. Fields containing a line-break, and/or commas should be quoted. (If they are not, the file will likely be impossible to process correctly).
  7. Double quote character in a field is not allowed. You can replace double quote with single quote.

Here are the header fields:

  • name

  • subcategories

  • type - it represents the type of category. This type can be 1,2 or 3

    1. Business listing category
    2. Offer category
    3. Event category

    If type is not specified the default type will be applied which is 1 (Business listings)

  • E.g of csv file
  • category;subcategories;type
  • “Automotive & Motors”;”Automotive Tools,Tires ,Automotive Parts,Car Electronics”,1
  • “Books”;”Textbooks,Children’s Books”,1
  • “Camera & Photography”;”Photography,Camera”

Export to CSV

  • Export current categories to a CSV file. Only level 1 and level 2 categories are exported.
_images/56.png

Business Listings

  • A business listing can be created by any owner (by creating an account in frontend) or it can be added by an administrator using the functionality in the backend.
_images/57.png
  • As an administrator you can search for companies by type, state and status. For an easier management the business listing information has been grouped into several sections.

Import from CSV

  • In order to add business listings from an existing source, the extension provides a tool to import business listing from a CSV (comma separated values) file.

Important

Please setup or import category structure first.

_images/58.png
  • Before you start the import process you have to make sure that your file is correctly formatted.

You can check if your file respects the rules bellow:

  1. CSV file values can be separated by a comma (,) or semicolon (;). They are called delimiters.
  2. Headers must be specified on the first line. Headers are case sensitive. Not all fields are mandatory.
  3. All records must be entered on one line.
  4. All lines should contain the same number of comma-separated fields. If the fields are empty you can leave it empty but add the delimiter. Each line has to have the same number of commas or semicolons.
  5. Any field may be quoted (with double quotes).
  6. Fields containing a line-break, and/or commas should be quoted. (If they are not, the file will likely be impossible to process correctly).
  7. Double quote character in a field is not allowed. You can replace double quote with a single quote.

If you want to update the existing listings and not create new ones you have to check “Update existing business listings” checkbox. Please make sure the listing names are the same, otherwise they will not be updated and a new listing will be created.

Here are the header fields (please notice that headers changed starting with version 4.5.0):

  • name
  • alias
  • categories
  • main_subcategory
  • commercial_name
  • registration_code
  • tax_code
  • type
  • slogan
  • description
  • short_description
  • street_number
  • address
  • city
  • region
  • country
  • website
  • keywords
  • phone
  • mobile
  • email
  • fax
  • latitude
  • longitude
  • user
  • average_rating
  • views
  • website_count
  • contact_count
  • package
  • facebook
  • twitter
  • googlep
  • skype
  • linkedin
  • youtube
  • instagram
  • pinterest
  • business_hours
  • custom_tab_name
  • custom_tab_content
  • publish_only_city
  • postal_code
  • state
  • approved
  • contact_name
  • contact_email
  • contact_phone
  • contact_fax
  • logo_location
  • business_cover
  • pictures
  • E.g of csv file

name;alias;categories;main_subcategory;commercial_name;registration_code;tax_code;type;slogan; description;short_description;street_number;address;city;region;country;website;keywords;phone;mobile; email;fax;latitude;longitude;user;average_rating;views;website_count;contact_count;package;facebook; twitter;googlep;skype;linkedin;youtube;instagram;pinterest;business_hours;custom_tab_name; custom_tab_content;publish_only_city;postal_code;state;approved;contact_name;contact_email; contact_phone;contact_fax;logo_location;business_cover;pictures “Auto show”;”auto-show”;”Automotive Parts”;”Automotive Parts”;”coomercial”;”registration”;”tax code”;”Service Provider”;”We present the latest trends and technology. ”;”<p>Donec eleifend purus nulla, non vehicula nisi dictum quis.</p><br /><p>Suspendisse accumsan nunc non dictum bibendum. Sed suscipit id ipsum ut tincidunt. Vivamus condimentum diam at condimentum scelerisque. Etiam vulputate pellentesque maximus. Aliquam hendrerit enim turpis, vitae ultrices libero accumsan nec. Pellentesque placerat volutpat fermentum. Sed tempor volutpat massa a auctor.</p>”;”Donec eleifend purus nulla, non vehicula nisi dictum quis. Maecenas in odio purus. Etiam vulputate nisi eget pharetra tincidunt. Morbi et eros consectetur, ultricies ligula quis, ullamcorper neque. Donec pellentesque felis vel luctus tempus.”;”12”;”Hopkins Ave”;”Jersey City”;”New Jersey”;”United States”;”http://website”;”keywords”;”+1 444 777 9999”;”+1 555 883 9932”;”office@site.com”;”fax”;”40.7343489”;”-74.05115409999996”;”0”;”0”;”9”;”1”;”1”;”” ;”http://www.facebook.com/cmsjunkie”;”http://www.twiter.com”; “https://plus.google.com/u/0/106923098988006144375”;”http://george.bara”;”http://www.linkedin.com”; “http://youtube”;”http://instagram”;”http://pinterst”;”09:00 AM,05:00 PM,09:00 AM,05:00 PM,09:00 AM,05:00 PM,09:00 AM,05:00 PM,09:00 AM,05:00 PM,09:00 AM,02:00 PM,closed,”;”tab name”;”<p>tab content</p>”;”1”;”07306”;”1”;”2”;”Brian Lindow”;”office@site.com”;”+1 323 999 672”;”fax contact”;”/companies/33/image4-1427207844.jpg”;”/companies/33/offer-1462959590.png”;”/companies/33/image1-1427100099.jpg “

  • If business listings are not showing up on front-end please check the followings:

    1. Make sure that state fields in CSV file are set to 1
    2. Make sure that approved field is set to 2
    3. Make sure that category is not empty
    4. If packages are enabled and the package is not specified in the import list, a default value (0) will be associated. This will prevent companies to be listed in front-end. To set a default package for companies you have to go to Application settings/ General tab and set packages to no and then to yes. A select box will appear that allows you to set the default package. Set the default package and save. This will change the package only for companies that do not have a package set.

    If you want to import pictures or logos you have to place the images on {joomla}/media/com_jbusinessdirectory/pictures folder and set the relative path on images on csv file

Export to CSV

  • Export current companies to a CSV file.
_images/59.png

Business Categories

You can add/edit, delete and publish/unpublished a business category from the Manage Categories screen.

Custom Attributes

Custom attributes provide the possibility to extend the current information that is added on business listings, offers & events. You can create & add your fields according to your needs. The custom attributes will appear on additional information section for completion. Based on the custom attribute settings, it will be showed or not in the front-end on item details.

You can create and manage the custom attributes from the Custom Attributes screen. You can switch at any time between the custom attributes for different sections.

If packages are enabled, custom fields will appear on business listing edit view only if they are associated with the selected package. On front-end, the custom attributes will be shown only if the order associated with the package will be paid.

_images/60.png

The available options for custom attributes are:

  • Name – the name of the custom attribute
  • Code – the alias of the attribute
  • Mandatory – possibility to make the attribute mandatory or not
  • Show in front – possibility to display the custom attribute in the front
  • State – possibility to activate or deactivate the attribute
  • Type – possibility to determine the type of the field (and the “Option name” is related to this field to insert the option)
_images/61.png

Business types

In this section, you can define the types of business that are allowed/available on your website. The type of business will also be displayed when an owner is creating his/hers own business listing.

When accessing this option you will be presented with a list of all the available business listing types. You can edit, delete or add a business type.

_images/62.png

Business Messages

As an administrator, you can view and manage all the business messages (from contact business) for each business. You can view or delete them.

_images/63.png

Also the messages of the corresponding business will be displayed in the Control Panel section like below:

_images/64.png

Business Listing Details

Upgrade Package

This option appears only when packages are active and provides the status of selected package.

_images/65.png

Business Details

It contains the general information about the business:

  • Business name: The name of the business.
  • Alias: It is used for building the business listing URL. It cannot contain special characters.
  • Registration ID: The business’s registration id. This naming differs from country to country.
  • Website: The business website(if any).
  • Business Type: The business type. Types are managed in the Business Types
  • Business Slogan: Slogan of the business listing
  • Business Short Description: Short description of the business listing; will be displayed in search results for certain views.
  • Business Description: The business description.
  • Keywords: Phrase or keyword that is strictly related to business activity. These keywords will be used to identify a business.

Attachments

The business owner has the possibility to upload any files and they will be visible on business listing details page. Usually, pdf files are uploaded.

_images/67.png

Opening hours

_images/68.png

Provides the possibility of adding the working schedule for businesses and the time zone. Any values can be entered in the text fields.

E.g 12 a.m, 14:30, closed.

If the day of the week is not checked, it will mean that that day is a closed day for the listing

_images/68.1.png

Add image to represent your listing

Provides the possibility to enter a representative image for the business, usually a logo. For companies that do not have a logo, a default image will be displayed.

_images/69.png

Add cover image

The cover image is used on the business listing details page, style 5. It gives the possibility to the user to change the cover image of the business listings. If cover image is not used it can be deactivated from business listings attributes on general settings.

_images/70.png

Additional Info

In this section, the custom fields that are defined on custom attributes section are shown, only if they are associated with package chosen for the business.

Business Categories

Each company can have one or more subcategories and one main category associated with it.

Town/City to be listed under

When the limit city is active in general settings of extension the business owner has the possibility to enter the cities where the business listing is active.

_images/71.png

Business Location

_images/72.png

In order to have a better user experience, we have added an autocomplete address feature. You can enter the address in the autocomplete field and all address fields are completed automatically and also the map location is set. You can also set latitude and longitude automatically by clicking on the map.

Only publish my City and Region: If is checked only the city and region is published as address.

Activity radius: Set the activity radius of the business listing and it is used in the radius search

Business listing secondary locations

Allow the possibility to add multiple business locations. The business locations will appear on the separate section on front-end, in business listings details view.

_images/73.png

Extra tab information

The business owner has the possibility to define an extra tab on his listing profile. He can set the tab name and the tab content.

Company Contact Information

The section contains the company contact information. This information will be displayed in the frontend, when the company is displayed to visitor. The email address is not displayed.

_images/74.png

Company Contact Person

The section contains the company contact person. This information will be displayed in the frontend when the company is displayed to visitor.

_images/75.png

Company Pictures

You can upload pictures and set a description for them in this section. To upload a picture simply click the Browse button and choose the desired picture by navigating through your content. You can change their order by dragging & dropping the pictures.

_images/comPic.png

Business listing Videos

You can use set the company videos in this section. You can share any video URL from Youtube and Vimeo.

_images/video.png

Business listing Sounds

You can use set the company sounds in this section. You can share any sound from SoundCloud and BandCamp. You can find below an example from SoundCloud:

<iframe width=”100%” height=”450” scrolling=”no” frameborder=”no” src=”w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/tracks/315307209&amp;auto_play=false&amp;hide_related=false &amp;show_comments=true&amp;show_user=true&amp;show_reposts=false&amp;visual=true”></iframe>

Social Networks

Companies can connect with their clients via social networks. Facebook, Twitter, Google Plus, LinkedIn, Skype ID, Youtube and Instagram are available for setup.

Business User

Each company must have a user assigned for the company to be owned, so a user’s name must be entered in the field. If the company is created by the administrator, it should have the name of the administrator.

_images/76.png

Metadata Information

The business owner has the possibility to enter the metadata information for his listing profile.

_images/77.png

Offers

Each business owner has the possibility to define offers in order to promote the services or products they are offering. Offers will be available for customer via a menu item or through business listing details page. How to create the menu is explained in detail in the frontend setup section below.

Notice: If packages are active, the offers will be visible only if the business listing has a package that contains offer feature and the order is paid.

You can add/edit, delete and publish/unpublished an offer from the Manage Offers screen. Featured offer can be set as the offer of the day. It will be displayed through J-BusinessOffer Module.

_images/78.png

When editing/adding an offer you’ll be presented with the following Offer Details:

Subject – the name of the offer

Alias – the alias of the offer

Category – categories of the offer

Main category – this category will be used for showing the marker on the map

Short description – will be shown on search results

Description – the description of the offer

Start date – offer start date

End date – offer end date

Publish start date – the date when the offer will be available on site

Publish end date – the date until when the offer will be visible on site

Publish start time – time when the offer will be available, (associated with start date)

Publish end time– time when the offer will not be visible (associated with end date)

Show remaining time – display the remaining time of the offer

Price – the price of the offer

Price base – the base price for the unit mentioned (E.g 100g for 1$)

Price base unit

Special price – the special price of the offer

Special price base- the base price for the unit mentioned (E.g 100g for 1$)

Special price base unit

Coupons number – the max number of coupons that will be generated – after the maximum number is reached the “Get this deal” button will be hidden on front-end.

Currency – select the desired currency

Associated company – the business listing that is associated with the offer

State – the status of offer (active/inactive)

Additional Info

In this section show the offers custom attributes, if the attribute is set to active.

Offer location

Allows you to set the location of an offer.

Offer pictures

You can upload multiple pictures for your offer. You can upload pictures and set a description for them in this section. To upload a picture simply click the Browse button and choose the desired picture by navigating through your content.

Offer videos

You can add multiple videos for your offer.

Offer attachments

You can upload multiple attachments for your offer. You can upload attachments and set a description for them in this section. To upload an attachment simply click the Browse button and choose the desired attachment by navigating through your content.

User

Each offer must have a user assigned for the offer to be owned, so a user’s name must be entered in the field. If the offer is created by the administrator, it should have the name of the administrator.

Metadata information

You can also determine manually the metadata information completing the fields in the “Metadata Information” section. The fields are: Meta Title, Meta Description and Meta Keywords.

Offer Categories

You can add/edit, delete and publish/unpublished an offer category from the Manage Categories screen.

Please check chapter 3.2 Categories for further details.

Custom Attributes

Please check chapter 3.3.4 Custom attributes for further details

Coupons

The coupons gives the possibility to provide some discounts only for a limited number of clients. Each time a customer requests a coupon on the offer details view on front-end, a coupon is generated with a coupon code.

For each offer the business owner has the possibility to activate coupons by setting a number of coupons higher than 0.

As an administrator you can activate the offer coupons from the General Settings. You can view and manage all the coupons generated for each offer.

Also the offer coupons of the corresponding business will be displayed in the Control Panel section:

_images/79.png

Events

Each business owner has the possibility to define events in order to promote the services or products their company is offering. Events will be available for customer via a menu item. How to create the menu is explained in detail in the frontend setup section below.

You can add/edit, delete, and publish/unpublished an event from the Manage Events screen.

_images/81.png

When editing/adding an event you’ll be presented with the following

Name - the name or the title of the event

Alias - the alias of the event

Category - categories of the event

Main category - will be used to show the marker on the map

Short description - will be shown on search results

Description - the description of the event

Type - type of the event; can be managed on manage event types

Business - the business who organize the event

State - set if the event is active or not

Currency – set the currency of the event

Price – the price of the event

Event Dates

Start date – Event start date

End date – Event end date

Show end date – Show/hide end date on event details

Start time – Event start time

Show start time– Show/hide start time on event details

End time – Event end time

Show end time– Show/hide end time on event details

Doors Open – Set the door opening time

Show doors open time - Show/hide door opening time on event details

Additional Info

In this section show the events custom attributes, if the attribute is set to active when created.

Participating Companies

On this section are shown the companies that participate on the actual event.

Event location

Allows you to set the location of an event.

Event Contact Information

Allows you to add a contact information for the event

Event pictures

You can upload multiple pictures for your event. You can upload pictures and set a description for them in this section. To upload a picture simply click the Browse button and choose the desired picture by navigating through your content.

Event videos

You can add multiple videos for your event.

User

Each event must have a user assigned for the event to be owned, so a user’s name must be entered in the field. If the event is created by the administrator, it should have the name of the administrator.

Metadata information

You can also determine manually the metadata information completing the fields in the “Metadata Information” section. The fields are: Meta Title, Meta Description and Meta Keywords.

Event Categories

You can add/edit, delete and publish/unpublished an event category from the Manage Categories screen.

_images/82.png

Event type

You can add/edit and delete an event type from the Manage Event Types screen.

_images/83.png

Packages

_images/84.png

You can define packages in order to charge for the level of information an owner wants to define for his/her own business. The level of information is given by the features presented below.

A package contains the following

Name - the name of the package. This will be displayed in the frontend

Description - the description of the package. This will be displayed in the frontend

Price - the price you are charging for a package. The price will be displayed in the frontend.

Only for admin – when set to yes, the package will not display on business plans menu item, front-end.

Package UserGroup – you can decide the usergroup you want to assign this package.

Type – you can choose between the following types:

Lifetime – the package is available for a lifetime period.

Fixed period – the package is available for a fixed period of time.

Recurring – the package is available for a fixed period of time with the possibility of recurring payments. The package is activated each time a recurring payment is performed.

Recurring with trial – similar with recurring time package but it provides also a trial period.

Maximum number of pictures - set the maximum number of pictures that is allowed

Maximum number of videos - set the maximum number of videos that is allowed

Maximum number of attachments - set the maximum number of attachments that is allowed

Maximum number of categories - set the maximum number of categories that is allowed

Time period – set the time period of package. It can be set in days, weeks, months or years.

Package Features – the features you want to assign to your package.

The features you can create packages on:

Featured business listings - the companies that will have this package associated will be displayed in top of the list

Html Descriptions - this allows business owners to use html tags in their description in order to make it more appealing

Show Business Logo - shows the business logo on front-end

Website address – shows the website on front-end

Image Upload - owners are given the possibility to upload images for their companies

Videos - owners are given the possibility to present videos to their customers

Google Map - the company will be able to display a map location of their own. This map will be available in the frontend when viewing the company’s details.

Contact Form - this feature is used to provide the business potential customers with a way to contact the business listing

Business Offers - the business owner will be able to create and share offers with their customers

Business Events - business events will be shown on front-end.

Social Networks - owners are given the possibility to connect with their customers via social networks. Current available: Facebook, Twitter, Google+, LinkedIn, Skype, Youtube and Instagram.

Phone - shows the phone on front-end

Custom tab - a section where the user can create extra tabs if the tabs style is selected in General Settings.

Attachments - owners are given the possibility to present attachments to their customers

Opening hours - owners are given the possibility to display business opening hours

Related Companies - owners are given the possibility to display the related companies

Secondary locations - owners are given the possibility to display the secondary locations

Sounds - owners are given the possibility to present sounds to their customers

Link follow - owners are given the possibility to make the follow or nofollow for the website links.

Based on the above presented features you can create multiple packages for the business owners to select from.

Discounts

The discounts section gives the possibility to generate/define multiple discounts for end users. When an order is paid in front end a discount section appears where the discount coupons can be entered.

The discount contains the following parameters.

_images/86.png

Name – the name of the discount

Start date – starting date of coupon availability

End date – end date of coupon availability

Package – the packages for which the discount are available

Coupon code – the code of the coupon – that will be entered on front-end discount section

Uses per coupon – defines how many times a coupon can be used

Amount – amount of the coupon. It can be set to a fixed amount or a percent.

State – the state of the coupon, active or inactive.

Generate Discounts

The extension provides also a way to generate coupons though generate coupon section.

You have to enter the number of coupons to be generated and completed the coupon parameters. The generated coupon can be also exported to a csv format by clicking export to csv button from the extension menu.

Orders

This section will give you an overview of all the orders made on your business directory website.

_images/87.png

You can edit/delete orders from the orders list.

_images/88.png

When editing an order you can change information like

Amount – the amount of the order

Payment date – the payment date

Transaction Id – the transaction ID

State – The order status, Paid or Unpaid

Start date – the start date of the order

Start trial date - the start date of the trial

Important notice - Start date represent the date when the package will be active. If one business buys a new package and there is already a paid package active, the start date of the new package will be set to expiration date of the previous package.

Taxes

_images/taxes.png _images/tax_details.png

The admin can fill in the tax name, fill in the amount and decide whether to set it in value or percentage and a tax description. They display when the user pays the order on the front-end control panel section and they are added to the package price. After the payment is done, taxes show on invoice details view.

The taxes can be created only from the admin site, on Taxes section.

Payment Processors

Payment processors provide the means for you to collect payments from you customers. We provide integration with several payment gateways and it will present in the next chapters.

PayPal payment processor

You can collect payments via PayPal. All you need to do is have a PayPal merchant or business account and set the processor as follows.

_images/89.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • PayPal email – set the PayPal merchant email associated with your PayPal account. This account is where the payments are collected.

PayPal Subscriptions payment processor

You can collect payments via PayPal Subscriptions mechanism. All you need to do is have a PayPal merchant or business account and set the processor as follows.

_images/90.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • PayPal email – set the PayPal merchant email associated with your PayPal account. This account is where the payments are collected.

The subscription mechanism works in the following way. 1. The site admin has to create packages with a defined period of time and desired features. 2. The business owner creates a business listings and associate it with a package. If the package is paid an order is generated and the user can pay for it with existing payment methods. 3. When the payment is made with subscription method a subscription is created for the user with the subscription period equal to package period.

Stripe Subscriptions payment processor

The extension will provide the possibility to receive payments using Stripe payment gateway. After you install the extension a new payment option will be enabled on your payment processors section. In order to setup the payment processor you have to complete the following steps

Configure the processor details

You will have to fill in the configuration parameters and make sure that the payment processor is enabled.

Name – the name of the processor that will be displayed on front-end

Type – the type of the processor. This is currently used for coding purposes

_images/91.png

Timeout – time allocated until a pending payment will expire

Mode – the mode the processor is in: Live or Test

Status – set whether the processor is active or disabled.

Secret key - provided by Stripe (check the image on the right)

Transaction key - provided by Stripe (published key)

Setup the processor details

The payment works in the following way.

1. The site admin has to create packages with a defined period of time and desired features on directory extension.

2. The site admin will create payment plans on stripe account dashboard with the exact name of the plans that have been created on directory extension.

_images/92.png
  1. Setup the webhook for notifying the site when the amount for the subscription is being charged from customer account. The webhook link can be found bellow. You just have to replace yoursite.com with your domain name http://yoursite.com/index.php?option=com_jbusinessdirectory&task=payment.processResponse&processor=stripeSubscriptions

Important

Please notice that if the webhook is not set the renewal of the package will not be done.

CardSave payment processor

You can collect payments via CardSave.

_images/96.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • Merchant Id – will be provided by CardSave
  • Preshared Key – will be provided by CardSave
  • Password – will be set on CardSave platform

Buckaroo payment processor

You can collect payments via Buckaroo.

_images/97.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • Secret Key – provided by Buckaroo
  • Merchant Id – provided by Buckaroo

Cash payment processor

The payment with this type of processor will be set automatically to done.

_images/98.png

2Checkout payment processor

_images/99.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • Account number – provided by 2checkout
  • Secret word – the secret word that is set on 2checkout platform

Authorize.net payment processor

_images/100.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • Transaction key – provided by authorize.net
  • Api login id – provided by authorize.net

EWay payment processor

_images/101.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • User name – set on Eway platform
  • Customer Id – provided by Eway

Bank Transfer (Wire Transfer) payment processor

You can collect payments via Bank Transfer.

_images/102.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled

PayFast payment processor

_images/103.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes. Please leave it to payfast.
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled
  • Merchant Id – provided by payfast.co.za
  • Merchant Key – provided by payfast.co.za

ROBOKASSA payment processor

_images/robokassa.png
  • Name – the name of the processor that will be displayed on front-end
  • Type – the type of the processor. This is currently used for coding purposes. Please leave it to payfast.
  • Timeout – time allocated until a pending payment will expire
  • Mode – the mode the processor is in: Live or Test
  • Status – set whether the processor is active or disabled

Countries

The countries section allows you to manage the countries that will be used on directory. The counties will be available when filling in an address. The country information will be also be shown when there will be a search done after a specific country.

_images/104.png

Reviews

Reviews

As an administrator you can view and manage all the reviews made for a business listing. You can publish/unpublished a review by clicking on the checkbox associated with each review in the State column.

_images/106.png

You can also edit and delete any reviews you find inappropriate in terms of language or content.

Review Criteria

As an administrator you can create and manage all the criteria made. On the existing criteria you can do operations like delete, edit and order.

_images/108.png

Review Responses

As an administrator you can view and manage all the review responses made for each review. You can publish/unpublished a response by clicking on the checkbox associated with each response in the State column.

_images/109.png

You can also edit and delete any responses you find inappropriate in terms of language or content.

Review Questions

As an administrator you can add review questions. You can publish/unpublished a review question by clicking on the checkbox associated with each review question.

_images/107.png
There are three types of review questions:
  • Text
  • Yes/No questions
  • Rating

Review Abuses

As an administrator you can view and manage all the review abuses made for each review. You can publish/unpublished an abuse by clicking on the checkbox associated with each abuse in the State column.

_images/110.png

Reports

The report section provides the possibility of defining multiple reports.

_images/111.png

One can create a new report by clicking on new button and filling the fields, selecting the report type and the custom business listing fields.

_images/112.png

E-mail Templates

The email templates section allows you, as an administrator, to define the emails that are sent to you and your customers.

The email templates are:

  1. Order email – template used for order e-mail for all payment methods except bank transfer. Email sent when a customer completes the payment for a package
  2. Payment Details E-mail – template used for order e-mail only for bank transfer
  3. Review email – email sent out to a business owner when his/hers company received a review
  4. Review Response Email – email sent out to the poster of a review when the company replies to the review posted
  5. Email Response Claim – template for positive claim response
  6. Negative Response Claim E-mail – template for negative claim response
  7. Positive Response Claim E-mail – template for positive claim response
  8. Contact email – template for contact business owner
  9. Report Abuse E-Mail – template for report abuse
  10. Expiration notification e-mail – email sent to business owner to notify that the business listing is about to expire
  11. Approve e-mail – template sent to business owner to notify that the listing has been approved
  12. Listing Creation Notification – notification that will be sent to business owner when a business listing is created
  13. New business listing notification e-mail – email sent to admin when a new business listing is added
  14. Business Listing Approval – email sent to business owner after approval
  15. Request Quote Email – email sent to business owner with a quote request from a user
  16. Offer Creation – confirmation email sent to business owner for offer creation
  17. Offer Approval – email sent to business owner after offer approval
  18. Offer Expiration Notification – email received by site admin and business owner with notification of expiring offers
  19. Event Creation Notification – confirmation email sent to business owner for event creation
  20. Event Approval Notification – email sent to business owner after event approval
  21. Event Expiration Notification - email received by site admin and business owner with notification of expiring events
  22. Business Update Notification – email received by site admin to notify if a change has been performed on business listings
  23. Offer Contact Email – email received when the offer is contacted
  24. Event Contact Email - email received when the event is contacted
  25. Report Abuse Offer Review - Template for report abuse to offers
  26. Offer Review Email – email sent out to a business owner when his/hers offer received a review
  27. Offer Review Response Email - email sent out to the poster of a review when the offer replies to the review posted.
  28. Report Notification – email received by site admin with a report notification from a user
_images/113.png

For a template the following need to be defined:

Name- the name of the template

Type - the type of email – you can find more details about types in previous section.

Send to admin (on bcc)– provide the possibility for the site admin to receive the current email type. Some of email types are received by the admin by default and the setting will be ignored.

Subject – subject of the email

Email content: will be defined using an editor which holds a series of email tags. When selecting a tag this will be automatically inserted in the email’s content.

_images/114.png