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 Event Finder

 


Widgets offer endless customization options! Filters can be applied to the Event Finder in two ways:

  • 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 or Ministries and filtered for those pages. Adding filters via attributes presents a limited version of the Widget. Users cannot see or change the applied filters but can layer on other filters to further narrow results. For example, pages can be created for Congregations or Ministries 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 related to the Event and are different (in form and function) from Contact Attributes
 
Note: Filter attributes will pre-filter the widget results. That means events displayed by the widget will always be limited by these filters.
  • Congregation/Campus: Filters the results by a Congregation.
    • Attribute: congregationid
    • Valid Values: Congregation Id
congregationid="1"
  • Key Word: Filters the result using keywords. Key Word search looks for a match in the Event Title Name, Event Description, Program Name, and/or Ministry Name, so choose your key word attribute strategically!
    • Attribute: keyword
    • Valid Values: Any keywords
keyword="mission to mars"
  • Month: Filters by a Month.
    • Attribute: monthid
    • Valid Values: 1 to 12 (1 = January)
monthid="12"
  • Ministry: Filters by a Ministry.
    • Attribute: ministryid
    • Valid Values: Ministry ID (or empty, the default)
ministryid="16"
  • Sign-up Type: Filters by type of registration available. The default is empty.
    • Attribute: signuptype
    • Valid Values: "1" for Open Registration, "2" for Open Volunteer Opportunities, or empty for unspecified. "0" will display all events.
signuptype="2"
  • Featured: Filters by showing only Featured Events. The default is empty.
    • Attribute: isfeatured
    • Valid Values: "true" (or empty)
isfeatured="true"
  • Program: Filters by a Program. The default is empty.
    • Attribute: programid
    • Valid Values: Program ID (or empty)
programid="16"
  • Limit Occurrences: Limits the number of occurrences people see for a series of events. The default is empty.
    • Attribute: reduceseriesto
    • Valid Values: Any number greater than or equal to 1. There is no limit to the number of events you want to show.
reduceseriesto="3"

All attributes must be included before the opening Widget tag is closed. Attributes may be listed in any order and should be separated by a space (or other whitespaces). Each attribute's value should be wrapped in quotation marks. For example, this Event Finder defines the resource path, congregations, and ministries.

<mpp-event-finder target="https://{church domain}/events" congregationid="7" ministryid="8"></mpp-event-finder>

URL Filters

Search parameters are appended to the URL when accessing the widget page. Using URL filtering, users can see and change all filters in the User Interface. If you need to lock down aspects of the widget so users can not change them, see Finder Widget Setup.  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.

  • Congregation/Campus: Filters by a Congregation ID.
    • Parameter: "congregationId"
    • Valid Values: A single Congregation ID or empty for unspecified.
?congregationId=1
  • Key Word: Filters by key words.
    • Parameter: "keyword"
    • Valid Values
      • Empty for unspecified (the default value)
      • Url encoded keywords
      • Standard a-z and 0-9 characters are all valid.
      • Spaces should be replaced with a plus (+). Note: The is different from the Key Word Attribute filer, which does not require the plus.
      • Other characters must be encoded
      • The easiest way to determine to encode is by searching using the criteria and copying from the resulting URL.
?keyword=mission+to+mars
  • Month: Filters by one month.
    • Parameter: "monthId"
    • Valid Values: Any single Month between "1" and "12"
?monthId=12
  • Ministry: Filters by a Ministry ID.
    • Parameter: "ministryId"
    • Valid Values: A single Ministry ID
?ministryId=16
  • Sign-up Type: Filters by Sign-Up Type. The default is empty.
    • Parameter: "signUpType"
    • Valid Values: "1" for Open Registration or "2" for Open Volunteer Opportunities, or empty for unspecified.
?signUpType=2
  • Featured: Filters to show featured events. The default is empty.
    • Parameter: "isFeatured"
    • Valid Values: "True" for featured or empty for unspecified.
?isFeatured=true
  • Program: Filters by a Program ID.
    • Parameter: "programid"
    • Valid Values: A single Program ID or empty for unspecified.
?programId=1
  • Limit Occurrences: Limits the number of occurrences people see for a series of events. The default is empty.
    • Attribute: "reduceseriesto"
    • Valid Values: Any number greater than or equal to 1. There is no limit to the number of events you want to show.
?reduceseriesto=3

Note: The first parameter is appended with a question mark (?). Additional parameters follow with ampersands (&).

?eventId=&programId=&congregationId=&keyword=&monthId=&ministryId=&signUpType=2

Advanced Url Filters

Multiple Filters
A URL may contain multiple filters separated by an ampersand. There is no limit to the number of filters which may be included and combining filters offers a useful way to return a specific set of Events. 

/events?congregationid=5&ministryid=16

Multiple Keywords
Urls cannot contain spaces, but %20 or + may be used instead. This is useful when filtering by two sequential keywords. Perhaps both "adult" and "community" would individually return too many Events. In this case, a combination could be used.

/events?keyword=adult+community