Magento 2 Business Directory

Customers will get a zip folder and they need to extract the zip folder contents on their system.

The extracted folder has an src folder, inside the src folder you have the app folder.

Also, you need to transfer this app folder into the Magento2 root directory on the server as shown below.

Then, run the command on the Magento2 root directory after successful installation –

php bin/magento setup: upgrade
php bin/magento setup:upgrade
php bin/Magento setup:di:compile
php bin/magento setup:static-content:deploy

You need to flush the cache from the Magento merchant panel by navigating through ->System->Cache management as shown below.

After the complete installation of the Magento 2 Business Directory module, the owner needs to navigate through Store -> Settings -> Configuration -> Webkul -> Business Directory for module configuration.

General Setting

• Enable: The owner can choose ” Yes” to enable the module else ” No“.
• Automatically directory approve: Merchant can enable or disable auto-approval of user-created directories from the admin side.  “Yes” for enabling and “No” for disabling the auto-approval.
• Admin Email-id: Forthwith store owner will enter the email id used for this module’s email transaction including the admin.
• Google Map API Key: Next the merchant will provide the API key of the google map. It will allow users to use google maps while creating their directories for the location purpose.
• Manage Records: If the admin select ” Yes” then the admin can delete the reasons even they are assigned to a report and select “No”  then the merchant cannot delete the assigned reasons.

Please Note:

The admin email id is used to send email to the admin when a user creates/claim/report a directory. The vice versa process is done for the approval of the directory from the admin.

Customers have to wait for the admin’s approval to get the created business directory if auto-approval of the business directory is not enabled. 

The owner can create subcategories under the root category of the Business Directory. Moreover, to add subcategories of the root categories navigate through Products -> Categories -> Business Directory -> Add Subcategory

Add Subcategory

After clicking “Add Subcategory“, the admin will be redirected to the subcategory setting page. The owner can add new subcategory by doing the following essential settings :

• Enable Category: The first admin will enable or disable the subcategory.
• Include in Menu: Then enable or disable to include the menu in a subcategory
• Category Name: After that, the merchant can set the name for the subcategory.

Content

• Category Image: Now the store owner can set an image for the category.
• Description: Then add a subcategory description from this field.
• Add CMS Block:  Now select the static block.

Display Settings

• Display Mode: Next the admin can set the display mode for the subcategory.
• Anchor: Furthermore store owners can make the subcategory eligible for the anchor.
• Then Use Available product listing sort by.
• After that Apply Default product listing sort by.
• In the end, Implement Layered Navigation Price Step.

Search Engine Optimization

• Meta Title – Now, enter the Meta Title
• Mera Keyword – Then, enter the Meta Title
• Meta Description – Finally, write Down the Meta Description.

Products in Category 

Now add directory from this section to the subcategory via a directory checkbox or mass selection checkbox for selecting all products at once.

Design

• Use Parent Category Settings: Further merchant has to enable it for inheriting the root category display setting or the “Business Directory” theme in the Theme field.
• Theme: If the “Use Parent Category Setting” is not enabled then the theme has to set to “Business Directory”.
• Layout: Then, select the layout.
• Layout Update XML.
• In the end, apply Design to Products.

Please Note:

Selecting the “Use Parent Category Setting” or the Theme as “Business Directory”  is necessary to view the directory in the proper manner.

If these settings are not made then the directories will appear as normal products on the front view for the users.

Schedule Design Update

Now select the beginning and end date for the schedule design update.

User Directory Management

After all the above Magento 2 Business Directory module configuration and settings, the registered user can add a directory.

Now to add the directory the user will navigate through Login(The user will first login) -> Add Directory.

Add Directory

• Directory Category: First the admin can choose the categories for the product.
• Company Name: Second the merchant will provide company name.
• Contact Person: Third name of the contact person of the company.
• Email: Then email id of the contact person.
• Street: After that Street name where the company is located.
• Postcode: Further postal code of the company.
• City: Then the city name where the company is located.

• Country: Now the country name of the company.
• Location:  Then latitude and longitude for setting the location on the map view.
• Phone: Then phone the number of the contact person.
• Fax: Also Fax number of the company.
• Website Title: Furthermore the user will give the website URL in this field.
• Business Days: After that Here the user will set the working days of the company by selecting the weekday names.

• Description: Then set Description of the company.
• Short Description: After that Set Short description of the company.
• Company Logo: In the end, The user can provide the company’s logo.

Lastly, the user will save the directory via the Save Directory button.

The registered user can see their created directories by navigating through Login(The user will first login) -> My Directory List.

• The user can edit/ delete any directory.
• Also, the user can select directories and delete the directories via the “Delete Directory‘ button.
• Filtered search for better reachability to any directory.
• Also, view the status of approval of directories from the status column.
• View the reports, claims, and contact owner count in Total Report, Total Claim, and Total Contact columns respectively. Thus the user can see the details of each by clicking on the counts.

1. Total Report Detail Page

2. Total Claim Detail Page

3. Total Contact Owner Request Detail Page

The admin can manage the user-created business directories by approving, disapproving, deleting, and viewing directory information or by creating/managing reasons.

Navigating through Business Directories -> Directory for the directory management:

• It has informative columns of user-created directories drafted below:

1. Id: It shows the system Id for any directory.
2. Directory Name: It shows the name of the directory.
3. Owner Name: It shows the name of the owner who has created the directory.
4. Number of Report: It gives the count of the reports done on the directory.
5. Number of Claim: It gives the count of the claims of the directory.
6. Status: It shows the approval status of the directory.
7. Created At: Date and time of the creation of directory are shown in this column.

• The users can delete or update the status of the selected directories to “Enable” or “Disable” via the “Actions” drop-down.
• Use Directory selection checkboxes to select specific directories on which the admin has to take the action.
• Admin has to take the actions to select specific directories
• Use the Mass Selection checkbox to select all directories at once.
• The user can click on “View” to see directory information:

Claim

This can be navigated by Business Directory -> Directory -> View -> Directory Information – > Claim.

Contact

Navigated it through Busienss Directory -> Directory -> View -> Directory Information -> Contact.

Report

Navigated it through Busienss Directory -> Directory -> View -> Directory Information -> Report.

The admin can manage the reason by navigating through Business Directory> Reason.

• It has various informative columns of user-created directories like :
  1. Id: It displays the system Id for reasons.
  2. Reason: also It shows the name of the Reason.
  3. Status: moreover  It presents the approval status of the reason.
  4. Created At: Date and time of the creation of reason are shown in this column.
• The users can delete or update the status of the selected reason to “Enable” or “Disable” via “Actions” drop-down.
• Use Directory selection checkboxes to select specific Reasons on which the admin has to take the action.
• Use Mass Selection checkbox to select all Reasons at once.

Reason Editing

The user can click on “edit” to edit a reason.

1. The admin can edit the reason text content via “Reason“.
2. Further, edit the status of the reason from the “Status” dropdown.
3. Also, the user can delete the reason from the “Delete” button.
4. And use the “Reset” option to reset the settings of a reason.
5. Then the user can save the edited reason via the “Save Reason” button.

• “Add New Reason” button is used for adding new reasons for reporting any directory. When any user reports a directory then a reason for reporting is required, this reason is created by the admin via “Add New Reason”.

1. Reasons: Now the admin will set the reason content.
2. Status: Further The admin can enable or disable the created reason.
3. Save Reason: After setting the two fields the admin can save the Reason.

Admin needs to navigate to Dashboard>Catalog and add the products. There the admin will be able to see the option for the Business Directory in the catalog.

Once the Business DIrectory is selected it will open a new page where it will ask for certain details for creating a products as shown below.

Furthermore admin needs to scroll down and there will be another section named business directory on the same page.

Admin needs to provide all the details as shown in the above attached screenshot for the business directory comprises of address, phone number, business days, website, fax details, geolocation (latitude and longitude), and person name.

After all the above configuration settings and directory addition, any user can view the directory under Directory Category.

Any logged in or a guest user can navigate to the directories by clicking on the “Business Directory“.

• Create New Entry: First of all The user can create a new directory by clicking this button. It will redirect to the user to the Add Directory page. If the user is not logged in or registered then, it will redirect the user to sign up/login page.
• Keyword Search by category filter: Then Directory can be searched via the category search filter. The user can choose a category and search the directory by entering a keyword.
• Alphabetical and Numeric Search: Also The user can search a directory by selecting its first starting alphabet or a numeric digit.
• Advanced Search: Then the user can search by keywords of directories with much-advanced options like:

All Words

First, Searching keywords by entries that have “All Words“: Use all the words of the given keyword together to search the directory by name.

For example – If the keyword is “Human rights” then take the whole keyword “Human rights” together for searching a directory by name.

Any Words

Second, Searching keywords by entries that have “Any Words“: Take all the words of the given keyword independently to search the directory by name.

For example – If the keyword is “Human rights” then “Human” and “rights” both will get independently used for searching a directory by name.

Exact Words

Third, Searching keywords by entries that have “Exact Words“: Use all the words of the given keyword and that will exactly get used word by word to search the directory by name.

For example – If the keyword is “Human rights” then the exact word by word keyword will get used for searching.

Extended Search

Use advanced search for better and extended search options including searching by location, category, and country.

Additional Information

• Just below the business directory description, all the subcategories of the root category is displayed with their subcategories.
• Posts count shows the count of the directories enabled by the admin under a subcategory of the root category.
• Short Description View of the directories is provided with a Category filter drop-down.
• Furthermore, On clicking the title of the directory, the detail view of the directory opens with all the details of the directory including Street name, Postcode of the location, City name, Country name, Phone number of the contact person, Website URL, Business days detail, About company along with the map view of the company.
• Additionally, The user can also report/claim a directory to the admin. Any user can contact the owner of the directory.

 Claim Directory: Even the user can claim on a directory to the admin.

Report Directory: Further the user can report a directory by selecting it for a particular reason.

Note: Also the reason selected is created by the admin.

Contact Owner: Also, the user can contact the author of the directory.