Your Knowledge Base has moved to the new Help Center.  Check out the release notes for details. And don't forget to update your bookmarks and in-house documentation before May 28.

Configuring Online Directory

 

Quick Start

Want to get your Online Directory in the hands of your church ASAP? See the Quick Start Guide to get the Online Directory Widget up and running.

If the shared script hasn't been added to your website, add it to your desired webpage. Be sure to replace "{your platform domain}" in the following code with your church's base MP URL.

<script id="MPWidgets" src="https://{your platform domain}/widgets/dist/MPWidgets.js"></script>

Create a webpage on your website that will display your Online Directory Widget or identify the page on your website where it will be displayed.

Add the Online Directory Widget to your church website by placing this snippet of code in the body of your chosen webpage, modifying the attributes discussed below.

<mpp-online-directory></mpp-online-directory>
<mpp-online-directory
     hideaddress="true"
     hideemail="true"
     hidefamilylink="true"
     congregationid="10">
</mpp-online-directory>
Tip: While not mandatory, this snippet would typically be placed inside a <div> element with the class "container."

Widget Configuration

Optional attributes may be included to make your Online Directory Widget work for YOUR church
  • Hide Address: If true, the map icon will be hidden on all directory cards.
    • Attribute: hideaddress
    • Valid Values: True or False. Default is False.
hideaddress="true"
  • Hide Email: If true, the email icon will be hidden on all directory cards.
    • Attribute: hideemail
    • Valid Values True or False. Default is False.
hideemail="true"
  • Hide Family Link: If true, the family icon will be hidden on all directory cards.
    • Attribute: hidefamilylink
    • Valid Values: True or False. Default is False.
hidefamilylink="true"
  • Hide Birthday Icon: If true, the birthday icon and info will be hidden on all directory cards.
    • Attribute: hidebirthdayicon
    • Valid Values: True or False. Default is False.
hidebirthdayicon="true"
Configure Your Widget!

Simply fill out the Widget Configurator below, copy your generated Widget, and paste it into your website. 

Update Configuration Parameters

Setting Name
My Value
Description

Preview & Copy

Platform Configuration

The way your Contact, Participant, Household, and Congregation records are configured in the Platform determines whether they display in the Online Directory. Set yourself up for success (and save your church some confused phone calls) by reviewing your records.

Accessing the Directory

To access the Online Directory, Users must:

  • Be logged in.
  • Have a Participant Type with Can Access Directory set to True.
  • Have a Member Status with Can Access Directory set to True

Note: If one or all of these things are not true, the User will see a message that they are not currently authorized to view the directory.

Appearing in the Directory

Contacts returned in the search results are sorted by Display Name, Date of Birth, City, and then State. They are sorted by family first and then by date of birth, with the oldest listed first.

To appear in the Online Directory, the Contact must:

  • Have a Contact Status of Active.
  • Remove From Directory must be set to False.
  • Have a Participant Type where Show in Directory is set to True.
  • Have a Member Status where Show in Directory is set to True.
  • Belong to a Congregation where Available Online is set to True.
Removing People from the Directory

Want to remove certain individuals from your Online Directory? You can select those Contact records then Mass Assign the "Remove From Directory" field to "Yes".

Want to remove certain Member Statuses or Participant Types from your Online Directory? For example, you may not want records marked as "Former Member" or "Guest" to display in the directory. Here's how to do that:

  1. Go to Lookup Values, and open either Member Statuses or Participant Types.
  2. Select the items you want to remove from the directory.
  3. Click Actions, and select Assign.
  4. Select "Show In Directory", and "No" should be selected by default.
  5. Click Assign, and click Ok to confirm.

Once those statuses and types are set to "No", the associated members and participants no longer display in your directory.

Directory Cards

Each Contact in the directory displays on a Directory Card that shows their basic Contact information. This is a good time to ask Contacts to update their Household information and select which information they'd want to included in an Online Directory. Note: If any Contact information is missing, it and the associated icon will not display.

  • Image: The default image attached to the Contact record. If there is no attached image, a placeholder image will be displayed.
  • Name: The Contact's Nickname and Last Name. If the Contact doesn't have a Nickname, the First Name will be displayed.
  • Household Position: The Contact's Household Position.
  • Mobile Phone: The Contact's mobile phone number. NoteThe mobile phone number will not be shown if Mobile Phone Unlisted is set to True on the Contact record.
  • Home Phone: The Household's home phone number. NoteThe home phone number will not be shown if Mobile Phone Unlisted is set to True on the Household record.
  • Birthday Icon: The month and day of the Contact's Birthday. Tapping downloads an iCal/iCS file.
  • Email Icon: Tapping the email icon opens a simple email modal, allowing the authenticated user to send a message to the Contact's email address. Note: Emails sent via the Online Directory Widget are logged in the Platform.
  • Map Icon: Tapping the map icon will open Google Maps and display the Household's address on the map.
  • Family Icon: Tapping the family icon will show the directory cards for other Household members, if they meet the criteria for appearing in the directory.

Customization

You can customize the Online Directory Widget to be consistent with your branding, look, and feel!

CSS: All Widgets accept the Custom CSS attribute. Include it before the opening Widget tag is closed and customize backgrounds, button colors, and more!

Application Labels: Want to change "Campus" to "Location" or "Parish" in the dropdown filter? You can do that! Navigate to System Setup > Application Labels and update the label to fit your context (note that churches are responsible for all translations if the default is not used).

  • mpp-online-directory.congregationDropdownLabel - Label on the dropdown menu. Default is "Campus".
  • mpp-online-directory.viewMoreLabel - Instructions to prompt a User to refine their search. Default is "To see additional results, please refine your search filters above".