Magento 2 Business Directory

Customers will get a zip folder and they have to extract the contents of this zip folder on their system. The extracted folder has an src folder, inside the src folder you have the app folder. You need to transfer this app folder into the Magento2 root directory on the server as shown below.

After the successful installation, you have to run the command on Magento2 root directory-“php bin/magento setup:upgrade”

After the successful installation, you have to run these commands in the Magento2 root directory:

First command – php bin/magento setup:upgrade

Second Command – php bin/magento setup:di:compile

Third Command – php bin/magento setup:static-content:deploy

After moving the app folder you have to flush the cache from Magento admin panel by navigating through->System->Cache management as shown below.

After the complete installation of Magento 2 Business Directory module, the admin will configure the module. the module can be configured by navigating through Store -> Settings -> Configuration -> Webkul -> Business Directory.

• Select Root Category: The admin will select root directory for the Business Directories. The root category named as “Business Directory” is selected for root category of Business Directories.
• Automatically directory approve: Auto approval of the user created directories from the admin side can be enabled or disabled by the admin. “Yes” for enabling and “No” for disabling the auto approval.
• Admin Email-id: Here the admin will enter the email id used for this module’s email transaction including the admin.

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 approval of directory from the admin.

The admin can create sub categories under the root category of Business Directory. The sub categories of the root categories can be added by navigating through Products -> Categories -> Business Directory -> Add Subcategory.

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

• Enable Category: The admin can enable or disable the subcategory.
• Include in Menu: Enable or disable can be done for including menu in sub category.
• Category Name: The admin can set name for the subcategory.
• Category Image: Here the admin can set image for the category.
• Description:  Subcategory description can be added from this field.
• Display Mode: The admin cans set the display mode for the subcategory.
• Anchor: Here admin can make the sub category eligible for the anchor.
• Products in Category: In this section, the directory can be added to the sub category via directory check box or mass selection check box for selecting all products at once.
• Use Parent Category Setting: The admin has to select this check box for inheriting root category display setting or the “Business Directory” theme in the Theme filed.
• Theme: If the “Use Parent Category Setting” check box is not selected then the theme has to set to “Business Directory”.

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.

After all the above admin configuration and settings, the registered user can add a directory. To add the directory the user will navigate through Login(The user will first log in) -> Add Directory.

• Directory Category: Here the admin can choose the categories for the product.
• Company Name: The admin will provide company name.
• Contact Person: Name of the contact person of the company.
• Email: Email id of the contact person.
• Street: Street name where the company is located.
• Postcode: Postal code of the company.
• City: City name where the company is located.
• Country: Country name of the company.
• Location: Latitude and Longitude for setting the location on the map view.
• Phone: Phone number of the contact person.
• Fax: Fax number of the company.
• Website Title: The user will give website URL in this field.
• Business Days: Here the user will set the working days of the company by selecting the week day names.
• Description: Set Description of the company.
• Short Description: Set Short description of the company.
• Company Logo: The user can provide company’s logo.

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

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

• The user can edit/ delete any directory.
• Filtered search for better reachability to any directory.
• Status of approval of directories can be seen in the Status column.
• Reports, claims, and contact owner count can be seen in Total Report, Total Claim, and Total Contact columns respectively. The user can see the details of each by clicking on the counts.

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

Directory management can be done by navigating through Business Directories -> Directory.

• It has various informative columns of user created directories like :

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 creation of directory are shown in this column.

• The user can delete or update the status of the selected directories to Enable or Disable via “Actions” drop down.
• Directory selection check boxes can be used to select specific directories on which the admin has to take the action.
• Mass Selection checkbox can be used to select all directories at once.
• The user can click on “View” to see directory information. The following information is :

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

Contact: This can be navigated by Busienss Directory -> Directory -> View -> Directory Information -> Contact.

Report: This can be navigated by Busienss Directory -> Directory -> View -> Directory Information -> Report.

Directory management can be done by navigating through Business Directories -> Directory.

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

1. The admin can edit the reason text content via “Reason“.
2. Status of the reason can be edited via “Status” drop down.
3. The user can delete the reason from the “Delete” button.
4. “Rest” can be used to reset the settings of a reason.
5. The user can save the edited reason via “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: Here the admin will set the reason content.
2. Status: The admin can enable or disable the created reason.
3. Save Reason: After setting the two fields the admin can save the Reason.

After all the above configuration setting 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: The user can create a new directory by clicking this button. The user will be redirected to Add Directory page. If the user is not logged in or registered then, the user will be redirected to sign up/login page.
• Keyword Search by category filter: Directory can be searched via category search filter. The user can choose a category and search the directory by entering a keyword.
• Alphabetical and Numeric Search: The user can search a directory by selecting its first starting alphabet or numeric digit.
• Advance Search: The user can search by keywords of directories with much-advanced options like:

1. Searching keywords by entries that have “All Words“: All the words of the given keyword will be used together to search the directory by name. For example- If the keyword is “Human rights” then the whole keyword “Human rights” together will be used for searching a directory by name.
2. Searching keywords by entries that have “Any Words“: All the word of the given keyword will be used independently to search the directory by name. For example- If the keyword is “Human rights” then “Human” and “rights” both will be independently used for searching a directory by name.
3. Searching keywords by entries that have “Exact Words“: All the word of the given keyword will be used exactly word by word to search the directory by name. For example- If the keyword is “Human rights” then exact word by word keyword will be used for searching.

• Extended Search: The advance search can be extended for better search options including searching by location, category, and country.

• Just below the business directory description, all the subcategories of the root category is displayed with their sub categories. Posts count shows the count of the directories enabled by admin under a sub category of the root category.
• Short Description View of the directories is provided with Category filter drop-down.
• 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.
• The user can also report/claim a directory to the admin. Any user can contact the owner of the directory.

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

•  Report Directory: The user can report a directory by selecting it for a particular reason.

Please Note: The reason selected are created by admin.

• Contact Owner: The user can contact the author of the directory.