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.

Filtering Online Directory

 

Optional attribute and URL filters can be used to create different versions of the widget for different purposes, further customizing your church's experience! 

  • Attribute Filtering: Set in Widget Attributes when it is added to a web page. 
  • URL Filtering: Appended to the URL when viewing the page

Attribute Filters

Optional attributes can be used to create different versions of the widget for different purposes. For example, pages can be created for Congregations and filtered for those pages. Note: Filters that are multi-select in the Finder can be filtered by multiple, comma-separated values. But filters that are single-select in the Finder (for example, Congregation ID) can only be filtered by one value.

These attributes are different (in form and function) from Contact Attributes.

Important! Filter attributes will pre-filter the widget results, so the Online Directory displayed by the widget will always be limited by these filters.
  • Congregation: Filters the results by a single Congregation
    • Attribute: congregationid
    • Valid Values: Congregation Id
congregationid="2"
  • Key Word: Filters the result using a key word. A Key Word search looks for a match in the first name, nickname, last name, mobile phone, home phone, or email address, so choose your keyword attribute filter strategically ;)
    • Attribute: keyword
    • Valid Values: should be url encoded
      • Standard a-z and 0-9 characters are all valid.
      • Other characters must be encoded.
keyword="Anderson"

URL Filters

URL Filters are applied when someone accesses the Online Directory widget. This can be used to direct users to a widget page with search values pre-selected. Users can continue to search by adding or changing parameters. The Online Directory Widget's base URL can be appended with specific filters to apply desired search criteria. Pre-filtering the URL is a convenient way to contextually limit the Online Directory. For example, you may want to provide a direct URL for filtering for each Congregation so members can only search for members of the Congregation they attend.

 /online-directory?congregationid=3
  • Congregation: Filters the results by a single Congregation Id
    • Attribute: congregationid
    • Valid Values: A single Congregation Id
/online-directory?congregationid=1
  • Key Word: Filters the result by a single keyword. A Key Word search looks for a match in the first name, nickname, last name, mobile phone, home phone, or email address, so choose your keyword attribute filter strategically ;)
    • Attribute: keyword
    • Valid Values: should be url encoded.
      • Standard a-z and 0-9 characters are all valid
      • Note: Multiple keyword filtering is not supported
      • Other characters must be encoded
/online-directory?keyword=anderson
  • Household: Filters by a Household ID
    • Attribute: householdid
    • Valid Values: A single Household ID
/online-directory?householdid=1126

Advanced URL Filters

A URL can contain multiple filters separated by an ampersand. There is no limit to the number of filters which can be included and combining filters offers a useful way to return a specific set of Opportunities. For example, you can filter by both a Congregation Id and keyword to create a filters URL to find all the Adamas at your Main Campus. 

/online-directory?congregationid=1&keyword=adama

Note: You can combine a Congregation ID URL filter and a keyword URL filter. Or you can combine a Congregation URL filter and a Household ID URL filter. But if you combine a keyword filter with a Household ID filter, the keyword will overrule the Household ID.