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 the appropriate webpage, replacing "example-church.com" with the base URL of your church's website.
<script id="MPWidgets" src="https://example-church.com/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 required attributes.
<mpp-online-directory></mpp-online-directory><mpp-online-directory
hideaddress="true"
hideemail="true"
hidefamilylink="true"
congregationid="10">
</mpp-online-directory>Widget Configuration
Optional Attributes
- Hide Address: If true, the map icon will be hidden on all directory cards.
- Attribute: hideaddress
- Valid Value: true or false. Default is false.
- Example:
hideaddress="true"
- Hide Email: If true, the email icon will be hidden on all directory cards.
- Attribute: hideemail
- Valid Value: true or false. Default is false.
- Example:
hideemail="true"
- Hide Family Link: If true, the family icon will be hidden on all directory cards.
- Attribute: hidefamilylink
- Valid Value: true or false. Default is false.
- Example:
hidefamilylink="true"
- Hide Birthday Icon: If true, the birthday icon will be hidden on all directory cards.
- Attribute: hidebirthdayicon
- Valid Value: true or false. Default is false.
- Example:
hidebirthdayicon="true"
Configure Your Widget
Fill out the Widget Configurator below, copy your generated widget code, and paste it into your website.
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 congregation some confused phone calls) by reviewing your records!
Accessing the Directory
- Be logged in.
- Have a Participant Type with Can Access Directory set to Yes.
- Have a Member Status with Can Access Directory set to Yes.
If one or all of these things are not true, the user sees a message that they are not currently authorized to view the directory.
Displaying 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.
- Belong to a Congregation where Available Online is set to Yes.
- Have a Contact Status of Active.
- Have Remove From Directory set to No.
- Have a Participant Type where Show in Directory is set to Yes.
- Have a Member Status where Show in Directory is set to Yes.Note: If a contact's Member Status is not set (it's null), they can still display in the Online Directory as long as all other criteria in this list is met.
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 people to update their Household information and select which information they'd like to included in the Online Directory.
- Image: The default image attached to the Contact record. If there is no attached image, a placeholder image displays.
- Name: The contact's Nickname and Last Name. If the contact doesn't have a Nickname, the First Name displays.
- Household Position: The contact's Household Position.
- Mobile Phone: The contact's mobile phone number.Note: The mobile phone number does not display if Mobile Phone Unlisted is set to Yes on the Contact record.
- Home Phone: The Household's home phone number. Note: The home phone number does not display if Home Phone Unlisted is set to Yes on the Household record.
- Birthday Icon: The month and day of the contact's Birthday. Clicking this 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 through the Online Directory widget are logged in the Platform.
- Map Icon: Click the map icon to open Google Maps and show the household's address on the map.
- Family Icon: Click the family icon to show the directory cards for other household members, if they meet the criteria for displaying in the directory.
Remove Member Status or Participant Types from your Online Directory
- Go to Lookup Values, and open either Member Statuses or Participant Types.
- Select the items you want to remove from the directory.
- From the Actions menu, select Assign.
- Select Show In Directory, and No should be selected by default.
- Click Assign.
- Click Ok to confirm.
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 drop-down filter? To make changes, go to and update the appropriate label(s). Note that you are responsible for all translations if the default is not used.
- mpp-online-directory.congregationDropdownLabel: Label on the drop-down 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".