Introduction
The Account Directory & Member Search allows for shopping cart users to search for accounts in the database using specific criteria. The admin can dictate certain requirements to be included in the search results and which result fields Accounts are able to opt-out of displaying. Individual account holders can define which of the opt-out enabled fields they want to show, or if they want to be shown in results at all.
Getting Started
There is a new admin setup page for Account Directory. You can access it by navigating from the admin side to Settings > Setup > Account Directory.
Account Directory must be enabled in order for it to be available for your cart users. You can leave the setting disabled until you have finished setting up all your preferred settings.
Search Results
The Search Results section is the area in which you want to pick what account information you want to be returned when a user does a search. The Show column is where you choose which items to display. The Optout column is used to select which items you want to allow users to opt out of showing up in a search result.
(Returned search results example from cart side)
Type of Address to Display
This drop down is used to select which type of address you would like to be displayed in the search results. You may have users who have a brick and mortar location as well as a billing location and you want the physical location shown instead of the billing address. This is where you make that choice.
Allow Accounts to Opt-out of Directory
This option controls how a cart user will be able to adjust their settings in the account communication settings page on the shopping cart side.
There are three options to choose from:
- Do not allow to opt out - Setting this option means that a user can not opt out of being displayed in the search results. There will be no Account Directory Search option listed in the account notification settings page on the cart side at all. The user can still opt out of individual fields if the fields are set to allow opt out.
- Default opted out - Setting this option means that all users are automatically opted out of any search results but have the option of checking the "Show my account information in search results" checkbox listed under the Account Directory Search section on the account notification settings page on the cart side.
- Default opted in - Setting this option means that all users are automatically opted in any search results and have the option of unchecking the "Show my account information in search results" checkbox listed under the Account Directory Search section on the account notification settings page on the cart side.
Filters
You can limit the accounts that are returned based on membership levels. You can also choose how many of those membership levels need to be met before being shown.
Display
You can customize the account directory display title that shows up on the shopping cart side.
(Shopping cart account directory search display title)
Search Controls
The Search Controls are what you want to allow the cart user to search for. For example if you only want them to be able to search by First Name, Last Name then you would just check those boxes.
In this example below I have chosen to let them search for all these options.
(Search controls view on the cart side)
Sorting
Sorting allows you to choose how you want the returned search results to sort. In this example we have last name ascending and first name ascending. All results returned will now be sorted in this order.
Access
Account directory access is where you set up permissions for who has access to view any results from the account directory.
There are six options to choose from:
- Public - anyone can search and view results
- Authenticated Account - A user must be logged into their account regardless of role in the system
- Authenticated Staff - Only users who are logged into their account and has a role of staff member can search and view results
- Authenticated Coordinator - Only users who are logged into their account and has a role of coordinator can search and view results
- Authenticated Staff or Coordinator - Only users who are logged into their account and has a role of staff OR coordinator can search and view results.
- Authenticated Admin (Impersonate) - If you are an admin and impersonate an account you will have the ability to search and view results regardless the accounts actual role.
Account Menu
There is also a new Account Directory menu that you can add to your shopping cart menu structure. To do this navigate to Settings > Setup > Menus
Under the Shopping Cart section do a search for Account Menu. Check the Account Directory option and click the Add to Menu button.
You can edit the settings individually on this menu option as well.
Shopping Cart Help & Layout
There is a shopping cart help and layout page for the account directory that can be set to display Header and Footer text. Please see Shopping Cart Help & Layout for details and setup.
Shopping Cart User Notification Settings
Your cart users can select which items they want to opt out of if you have given them the choice in the settings to do so. They would do this on the account communication settings page once they have logged in. They would need to scroll down towards the bottom of the page to the Account Directory Search section and make their selections. Items that you have set up to be opted out of will be able to have the check mark removed. Items that are grayed out shows what will be returned in a search and that is not available to be opt out of. So in the example below a user could opt out of showing their city and state/province but can not opt out of profile image, first name, last name, email, phone, company or membership levels. They do have the option of being completely left out of the directory search all together as noted by the ability to uncheck the "Show my account information in search results" option.
06/2019