Filtering Group Finder
Optional attribute and URL filters can be to used to create different versions of the widget for different purposes, further customizing your church's experience.
- Attribute filtering is set using widget attributes before adding the widget to your webpage.
- URL filtering is appended to the URL when someone views the webpage.
Attribute Filters
Optional attributes can be used to create different versions of the widget for different purposes. These attributes are related to the Group and are different (in form and function) from Contact Attributes. For example, pages can be created for Congregations or Ministries and filtered for those pages.
- Congregation: Filters the results by a Congregations using IDs.
- Attribute: congregationid
- Valid Value: Congregation Id
- Example:
congregationid="2"
- Key Word: Filters the result using key words. A Key Word search looks for a match in the Group Name, Group Description, Program Name, and/or Ministry Name, so choose keyword attributes strategically.
- Attribute: keyword
- Valid Value: This should be URL encoded.
- Standard A-Z and 0-9 characters are all valid.
- Spaces should be replaced with a plus (+).
- Other characters must be encoded.
- Example:
keyword="summer bbq"
- Ministry Filters by a Ministry ID. Default is empty.
- Attribute: ministryid
- Valid Value: Ministry ID or empty.
- Example:
ministryid="7"
- Meets Online: Filters by Meets Online field.
- Parameter: meetsonline
- Valid Value: True or False
- Example:
meetsonline="True"
- Neighborhood (Parent Group): Filters by the Parent Group. Default is empty.
- Parameter: parentgroupid
- Valid Value: Group Id or empty for unspecified. Note: The Parent Group must have Available Online set to Yes for this filter to work.
- Example:
parentgroupid="16"
- Group Focus: Filters by Group Focus. Default is empty.
- Parameter: groupfocusid
- Valid Value: Group Focus Id or empty for unspecified.
- Example:
groupfocusid="17"
- Group Type: Filters by a certain type of group.
- Attribute: grouptypeid
- Valid Value: one Group Type ID or empty for unspecified.
- Example:
grouptypeid="3"
- Life Stage: Filters by Life Stage. Default is empty.
- Parameter: lifestageid
- Valid Value: Life Stage Id or empty for unspecified.
- Example:
lifestageid="4"
- Meeting Days: Filters by one or more Meeting Day. Default is empty.
- Parameter: meetingdays
- Valid Value: 1 to 7 (1 = Sunday)
- Example:
meetingdays="1,6"
- Meeting Time: Filters by Meeting Time. Default is empty.
- Parameter: meetingtimes
- Valid Value:
- Morning
- Lunchtime
- Afternoon
- Evening
- Empty for unspecified (the default)
- Example:
meetingtimes="afternoon"
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 whitespace. An attribute's value should be wrapped in quotation marks.
Advanced Attribute Filters
Want to filter Groups by multiple Meeting days? You can do that! If the attribute is multi-select in the Widget, you can include multiple, comma separated values in the attribute filter.
URL Filters
URL Filters are applied when someone accesses the Finder widget. Use this to direct users to a widget page with search values pre-selected. Users can continue to search by adding or changing parameters.
You can append specific filters to the Group Finder Widget's base URL to apply the search criteria you want. Pre-filtering the URL is a convenient way to contextually limit groups. In the following examples, a church has defined the path for their Group Finder.
Let's say the URL where your Group Finder Widget is located is https://example-church.com/groups
.
Now, if your Small Groups are accepting new members in the fall, you may provide a pre-filtered link showing only those groups:
If you want to introduce several new classes that meet in the evening, you can provide a pre-filtered link for this time period:
Here are all the available URL filters.
- Congregation/Campus: Filters by a Congregation. The default is empty.
- Parameter: congregationId
- Valid Values: A single Congregation ID or empty for unspecified.
- Example:
?congregationid=1
- Key Word: Filters by key words. The default is empty.
- Parameter: keyword
- Valid Values:
- Empty for unspecified
- 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 than the Key Word Attribute filer, which does not require the a plus.
- Other characters must be encoded.
- Example:
?keyword="new+mothers"
- Neighborhood (Parent Group): Filters by the Parent Group. The default is empty.
- Parameter: parentgroupid
- Valid Values: A Group Id or empty for unspecified.
- Example:
?parentgroupid=16
- City or Postal Code: Filters by a city name or postal code. The default is empty.
- Parameter: citypostalcode
- Valid Values:
- Empty for unspecified
- A Postal Code (zip code)
- URL encoded City Name
- Standard A-Z and 0-9 characters are all valid.
- Spaces should be replaced with a plus (+).
- Other characters must be encoded
- The easiest way to determine encoding is by searching using the criteria and copying from the resulting URL.
- Example:
?citypostalcode=87659
- Group Focus: Filters by Group Focus. The default is empty.
- Parameter: groupfocusid
- Valid Values: one Group Focus ID.
- Example:
?groupfocusid=17
- Group Type: Filters by a certain type of group.
- Parameter: grouptypeid
- Valid Value: one Group Type ID.
- Example:
?grouptypeid=3
- Life Stage: Filters by Life Stage. The default is empty.
- Parameter: "lifestageid"
- Valid Values: Life Stage Id or empty for unspecified.
- Example:
?lifestageid=4
- Meeting Days: Filters by one or more Meeting Day. The default is empty.
- Parameter: meetingdays
- Valid Values: 1 to 7 (1 = Sunday)
- Example:
?meetingdays=1,6
- Meeting Time: Filters by Meeting Time. The default is empty.
- Parameter: meetingtimes
- Valid Values:
- Morning
- Lunchtime
- Afternoon
- Evening
- Empty for unspecified (the default)
- Example:
?meetingtimes=afternoon
- Meets Online: Filters by Meets Online field.
- Parameter: "meetsonline"
- Valid Values: True or False
- Example:
?meetsonline=true
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 Groups.
Multiple Filter Values
A single filter may contain multiple ID values separated by a comma. Employing a comma separated list of IDs can expand the set of Groups returned.
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 Groups. In this case a combination could be used.