This filter has some input parameters:

• Address Type: Home, Work, etc.
• Format Template (optional) v3.0: An optional template parameter to help you format the address any way you wish. See notes below for details.

"CurrentPerson": {
    "FullName": "Ted Decker",
    "AnniversaryDate": '',
}

Home Address: {{ CurrentPerson | Address:'Home' }}

Home Address: 11624 N 31st Dr Phoenix, AZ 85029

{{ CurrentPerson | Address:'Home','[[City]], [[State]]' }}

Input:
The input to this filter can be any valid person reference - a Person object, Guid or Id.

Available Parameters

1. The segment keys, specified as a comma-delimited list (required).

Output:
This filter doesn't produce any output. It adds the person to the specified personalization segments.

Logged-In User:
Bill Marble

{% assign items = CurrentVisitor | PersonalizationItems:'Segments' %}
<p><strong>Before:</strong></p>
{% for item in items %}
    <br>{{ item.Type }} - {{ item.Key }}
{% endfor %}
<p><strong>After:</strong></p>
{{ CurrentPerson | AddSegment:'IN_SMALL_GROUP,HAS_GIVEN' }}
{% assign items = CurrentVisitor | PersonalizationItems:'Segments' %}
{% for item in items %}
    <br>{{ item.Type }} - {{ item.Key }}
{% endfor %}

<p><strong>Before:</strong></p>
    <br>Segment - ALL_MEN
<p><strong>After:</strong></p>
    <br>Segment - ALL_MEN
    <br>Segment - IN_SMALL_GROUP
    <br>Segment - HAS_GIVEN
    

It will create a new array if null or '' is used as the source array. While the examples use simple strings, you can add anything to an array - even entity objects such as a Group or Person.

"Items": [
    "one"
]

{% assign array = Items | AddToArray:'two' | AddToArray:'three' %}
<ul>
{% for item in array %}
    <li>{{ item }}</li>
{% endfor %}
</ul>

<ul>
    <li>one</li>
    <li>two</li>
    <li>three</li>
</ul>

You can pass null or '' to initialize a new dictionary.

{% assign colors = '' | AddToDictionary:'success','green' | AddToDictionary:'warning','orange' | AddToDictionary:'error','red' %}
<div style='color:{{ colors["success"]}}'>
    This request is approved.
</div>
<div style='color:{{ colors["warning"]}}'>
    This request is incomplete.
</div>
<div style='color:{{ colors["error"]}}'>
    This request is denied.
</div>

<div style='color:green'>
    This request is approved.
</div>
<div style='color:orange'>
    This request is incomplete.
</div>
<div style='color:red'>
    This request is denied.
</div>

Parameters

1. Content: The content to be stored in the chat history. This can be a plain string or a complex object like a dictionary.
2. Key (optional): This is used to uniquely identify this content in the chat history. When content is added to the chat history with a key, any existing chat history with that same key will be removed before the new content is added.

{% assign message = 'The changes you requested have been made.' %}
{% capture history %}Saved the group with IdKey {{ group.IdKey }}{% endcapture %}

{{ 'Success' | AgentToolResult:message
    | AgentToolHistoryContent:history }}

Parameters

1. Instructions: A string of text that contains the agent instructions.

{% assign data = '' | AddToDictionary:'IdKey','k28Km21ls8' %}
{% assign data = data | AddToDictionary:'Title','Decker Small Group' %}

{{ 'Success' | AgentToolResult:message
    | AgentToolInstructions:'Do not include the IdKey value when writing the response.' }}

When creating lookup tools or other tools that would return a set of data, this can be used to provide context such as "HasMoreData" or "TotalResultCount".

Parameters

1. KeyOrDictionary: A string that specifies the key of a single metadata value or a dictionary object that contains multiple keys and values.
2. Value (optional): Specifies the value when adding a single key and value pair. This can be any value type, although numbers and strings are the most common.

{% assign total = 7 %}
{% assign message = 'We found the following campuses close to you: North Side, East Side, West Side.' %}
{% assign metadata = '' AddToDictionary:'HasMoreData', 'True' %}

{{ 'Success' | AgentToolResult:message
    | AgentToolMetadata:'TotalResultCount',7
    | AgenttoolMetadata:metadata }}

Parameters

1. Text: The text that identifies what this route is.
2. Route: The route or URL. This can either be a relative URL to Rock or a full URL to an external site.
3. Secured (optional): A boolean value that determines if security to the page that matches the route will be checked before adding it to the result. The default is 'true'.

{% capture message %}The group was created with IdKey {{ group.IdKey }}.{% endcapture %}
{% capture route %}/group/{{ group.Id }}{% endcapture %}

{{ 'Success' | AgentToolResult:message
    | AgentToolReferenceRoute:'Group Detail',route,'false' }}

The input must be either the string 'Success' or 'Error' to indicate either a success or error. Any other input will result in a tool execution error. For a success message, the payload will also become the content used for the hidden chat history.

When 'Success' is used, the actual result type will be determined by the payload (if any). If there is no payload, or it is an empty list or empty dictionary, then a NoData result will be generated. Otherwise a standard Success result will be generated. This helps the language model understand that the request was successful, but intentionally generated no payload data in the response.

Parameters

1. PayloadOrMessage: For a success result this can be either a string, object or array of objects that will become the payload of the result. For an error result this is a single string or an array of strings that represent the error message(s).
2. Key (optional): This is used to uniquely identify this payload in the chat history. When content is added to the chat history with a key, any existing chat history with that same key will be removed before the new content is added.

{% assign message = 'The changes you requested have been made.' %}

{{ 'Success' | AgentToolResult:message }}

The append following filter is exclusively used by entity commands and adds the property IsFollowing to the returned data object. Details on how to create a Persisted Dataset are available in the Designing & Building Websites Using Rock guide.

An optional purpose key can be provided as a parameter in v13.4+.

<p>Entity Command Example</p>
{% person where:'Id != 1' limit:'3' iterator:'People' %}
  {% assign followedItems = People | AppendFollowing %}
  <ul>
  {% for item in followedItems %}
    <li>{{ item.FullName }} - {{ item.IsFollowing }} </li>
  {% endfor %}
  </ul>
{% endperson %}


<p>Persisted Dataset Example</p>
{% assign data = 'mydataset' | PersistedDataset | AppendFollowing %}
<ul>
{% for item in data %}
  <li>{{ item.Title }} - {{ item.IsFollowing }}</li>
{% endfor %}
</ul>

<p>Entity Command Example</p>
<ul>
    <li>Ted Decker - true</li>
    <li>Cindy Decker - false</li>
    <li>Noah Decker - false</li>
</ul>

<p>Persisted Dataset Example</p>
<ul>
    <li>Friday 3/25 - true</li>
    <li>Saturday 3/26 - false</li>
    <li>Sunday 3/27 - false</li>
</ul>

This filter is exclusively used by entity commands and adds these properties to the elements of the result set.

• IsInSegment - a flag indicating if the current person matches any of the segments associated with this entity.
• MatchingSegments - a comma-delimited list of the segments associated with this entity that are matched by the current person.

This filter has the following parameters:

1. Segment (optional): A Personalization Segment Key that can be used to restrict the output to a single segment.

<h1>Entity Command Example</h1>
{%- contentchannel where:'Name == "Messages"' -%}
    {%- assign channelId = contentchannel.Id -%}
    {%- contentchannelitem where:'ContentChannelId == {{ contentchannel.Id }}' iterator:'Items' -%}
    {%- assign segments = Items | AppendSegments:'MARRIED' | Sort:'Title' -%}
     <p>{{ CurrentPerson.NickName }}, you might be interested in these messages on the topic of Marriage:</p>
    <ul>
        {%- for item in segments -%}
            {%- if item.IsInSegment == true -%}
                <li>{{ item.Title }} [{{ item.MatchingSegments }}]</li>
            {% endif -%}
        {%- endfor -%}
    </ul>
    {%- endcontentchannelitem -%}
{%- endcontentchannel -%}

<h1>Persisted Dataset Example</h1>
{% assign matchedSegmentItems = 'MyContentChannelItemsDataset' | PersistedDataset | AppendSegments %}
<p>Recommendations for {{ CurrentPerson.NickName }}:</p>
<ul>
  {%- for item in matchedSegmentItems -%}
    <li>{{ item.Title }} - {{ item.IsInSegment }}{% if item.MatchingSegments > '' %} [{{ item.MatchingSegments }}]{% endif %}</li>
  {% endfor -%}
</ul>

<h1>Entity Command Example</h1>
<p>Ted, you might be interested in these messages on the topic of Marriage:</p>
<ul>
  <li>Extended Family [Married]</li>
  <li>How To Make Your Marriage Better Today [Married]</li>
  <li>Immediate Family [Married]</li>
  <li>The Secret That Could Cost You Your Marriage [Married]</li>
</ul>
<h1>Persisted Dataset Example</h1>

<p>Recommendations for Ted:</p>
<ul>
  <li>Of Myths and Money - true [Attender, Has Given]</li>
  <li>Of Faith and Firsts - true [Attender, Has Given]</li>
  <li>Are You Dealing With Insecurity? - false</li>
  <li>Hallelujah! - false</li>
  <li>The Secret That Could Cost You Your Marriage - true [Married]</li>
  <li>How To Make Your Marriage Better Today - true [Married]</li>
  <li>Extended Family - true [Married, Small Group]</li>
  <li>Immediate Family - true [Married]</li>
  <li>Momentum At Home - true [Small Group]</li>
  <li>Momentum At Work - false</li>
  <li>Rich Fool - false</li>
  <li>Two Debtors - false</li>
</ul>

The following inputs are available for this filter:

1. Attribute Key (optional) - The key of the attribute that represents the media element for the entity. This is only needed when working with entities.
2. Watch Window (optional) - By default all watch interactions will be considered. This parameter allows you to provide either the number of days back to look (as an integer) or the start date of the window to consider. If you want to provide this parameter you'll need to also provide an Attribute Key.

Below are notes about how to use this filter with various different types of data structures.

• Collection of Entities - In this use case you will need to provide the attribute key that contains the media element. This is most commonly used with a collection of Content Channel Items.
• Collection of Media Elements - No additional information is needed.
• Single Entity - Here again you will need to provide the attribute key that contains the media element.
• Single Media Element - No additional information is needed.
• Persisted Dataset of Multiple Media Elements - Like the AppendFollowing command you can provide the data from a persisted dataset. Your dataset does need to have a integer property called MediaId.
• Persisted Dataset of a Single Media Element - This pattern again requires that the object have a integer property called MediaId.

The output of this command will be the original dataset with the follow additional properties:

• HasWatched - Boolean value that determines if the current person has watched any portion of the media element.
• WatchLength - The percentage of the media file that the person has watched.
• WatchMap - The watch map of the person's viewing of the file. How To Read a Watch Map
• MediaId - In the case when you provided an entity or set of entities the filter will also append the media id to the return set. This allows you use this field in your Lava instead of having to load the attribute's value again from the database.
• MediaGuid - The filter will also provide the media elements Guid value in cases where you provided an entity or set of entities.
• MediaDefaultFileUrl - The default media file URL for the media element.
• MediaDefaultThumbnailUrl - The default media thumbnail URL for the media element.
• ResumePercentage - The position as a percentage between 0 and 100 that the media should resume at. If the media has been fully watched, this will be 100. This can be used to paint progress bars on the video. Server: v17.1
• ResumeLocationInSeconds - The position in seconds that the media should resume at. This is the last spot viewed in the media. If it has been fully viewed, this will be 0. Server: v17.1
• WatchInteractionGuid - The Guid of the interaction related to the previous view.
• WatchInteractionDateTime - The date time of the interaction related to the previous view.

The extra return data elements are provided so that you can wire up a media watch shortcode in a way that watch tracking and resume can be enabled without additional database calls. This shortcode requires the following parameters to be configured in this mannner: media (MediaGuid), interactionguid (WatchInteractionGuid), watchmap (WatchMap), and src (MediaDefaultFileUrl).

{% contentchannelitem where:'ContentChannelId == 5' sort:'StartDateTime desc' limit:'3' %}
    
    {% assign messagesWithWatches = contentchannelitemItems | AppendWatches:'Media',30 %}

    <ul>
    {% for item in messagesWithWatches %}
    
        <li>
            <h4>{{ item.Title }}</h4>
            <p>
                <strong>Has Watched:</strong> {{ item.HasWatched }}<br>
                <strong>Watch Length:</strong> {{ item.WatchLength }}<br>
                <strong>Watch Map:</strong> {{ item.WatchMap | ToJSON }}<br>
                <strong>Watch Interaction Guid:</strong> {{ item.WatchInteractionGuid }}<br>
                <strong>Media Id:</strong> {{ item.MediaId }}<br>
                <strong>Media Guid:</strong> {{ item.MediaGuid }}<br>
                <strong>Media Default Thumbnail URL:</strong> {{ item.MediaDefaultThumbnailUrl }}<br>
                <strong>Media Default File URL:</strong> {{ item.MediaDefaultFileUrl }}<br>
                <strong>Resume Percentage:</strong> {{ item.ResumePercentage }}<br>
                <strong>Resume Location In Seconds:</strong> {{ item.ResumeLocationInSeconds }}<br>
                
            </p>
        </li>
    {% endfor %}
    </ul>
{% endcontentchannelitem %}

<ul>
    <li>
        <h4>Of Myths and Money</h4>
        <p>
            <strong>Has Watched:</strong> true<br>
            <strong>Watch Length:</strong> 11.29<br>
            <strong>Watch Map:</strong> "71,550"<br>
            <strong>Watch Interaction Guid:</strong> 376ac970-b281-425f-860a-3f040ebae97c<br>
            <strong>Media Id:</strong> 1<br>
            <strong>Media Guid:</strong> 198a9b5a-32f0-43b0-89ac-996ef9e3d6b6<br>
            <strong>Media Default Thumbnail URL:</strong> https://rockrms.blob.core.windows.net/videos/rock-sample-video.mp4<br>
            <strong>Media Default Thumbnail URL:</strong> https://placehold.co/1920x1080<br>
            <strong>Resume Percentage:</strong> 11.29<br>
            <strong>Resume Location In Seconds:</strong> 7<br>
        </p>
    </li>
    <li>
        <h4>Of Faith and Firsts</h4>
        <p>
            <strong>Has Watched:</strong> true<br>
            <strong>Watch Length:</strong> 25.81<br>
            <strong>Watch Map:</strong> "121,200,41,260"<br>
            <strong>Media Id:</strong> 2<br>
            <strong>Media Guid:</strong> c36a0866-d172-4c6f-8ba2-a3d8c0c8b892<br>
            <strong>Media Default Thumbnail URL:</strong> https://rockrms.blob.core.windows.net/videos/rock-sample-video.mp4<br>
            <strong>Media Default Thumbnail URL:</strong> https://placehold.co/1920x1080<br>
            <strong>Resume Percentage:</strong> 58.06<br>
            <strong>Resume Location In Seconds:</strong> 36<br>
        </p>
    </li>
</ul>

You can pass null or '' to initialize a new dictionary.

{% sql %}
SELECT [Id], [Name] FROM [Campus]
{% endsql %}

{% assign items = null %}

{% for result in results %}
    {% assign item = result | AsDictionary %}
    {% assign idKey = item.Id | ToIdHash %}
    {% assign item = item | AddToDictionary:'IdKey',idKey | RemoveFromDictionary:'Id' %}
    {% assign items = items | AddToArray:item %}
{% endfor %}

<pre>{{ items | ToJSON }}</pre>

<pre>[
  {
    "Name": "Main Campus",
    "IdKey": "QN8mrQBVyn"
  },
  {
    "Name": "South-Inactive",
    "IdKey": "OX9mQWPQo8"
  }
]</pre>

Guids are used to uniquely identify items in a Rock instance, and they can be stored and retrieved in multiple text formats. This filter ensures that Guid values with different formats can be compared correctly.

If the input cannot be converted to a Guid, this filter returns an empty string.

{% assign guidString1 = '8FEDC6EE-8630-41ED-9FC5-C7157FD1EAA4' %}
{% assign guidString2 = '8FEDC6EE863041ED9FC5C7157FD1EAA4' %}
<p>Value 1: {{ guidString1 }}</p>
<p>Value 2: {{ guidString2 }}</p>
{% if guidString1 != guidString2 %}
<p>Compared as Strings, these values are different.</p>
{% endif %}
{% assign guidValue1 = '8FEDC6EE-8630-41ED-9FC5-C7157FD1EAA4' | AsGuid %}
{% assign guidValue2 = '8FEDC6EE863041ED9FC5C7157FD1EAA4' | AsGuid %}
{% if guidValue1 == guidValue2 %}
<p>Compared as Guids, these values are the same.</p>
{% endif %}

Value 1: 8FEDC6EE-8630-41ED-9FC5-C7157FD1EAA4
Value 2: 8FEDC6EE863041ED9FC5C7157FD1EAA4
Compared as Strings, these values are different.
Compared as Guids, these values are the same.

This filter is intended for binary files stored in Rock and does not encode arbitrary text values.

This filter has an optional input parameter:

• Image Resize Parameters: If the binary file is an image, this optional parameter can be used to resize and/or format the image using a collection of key/values. See notes below for details.

"CurrentPerson": {
    "FullName": "Ted Decker",
    "PhotoId": 85,
    "AnniversaryDate": '',
}

Base64Format: {{ CurrentPerson.PhotoId | Base64Encode }}<br/>
Base64Format: {{ CurrentPerson.PhotoId | Base64Encode:'h=25&w=25&mode=max&format=jpg' }}

Base64Format: /9j/4QAYRXhpZgAASUkqAAgAAAAAAAAAAAAAAP/sABFEdWNreQABAAQAAABb......KWv//Z
Base64Format: /9j/4AAQSkZJRgA...210uf/Z

If you would like an array of all the person's campus try using: {{ CurrentPerson | Campus:'All' }} This will return an array of campuses for the person.

"CurrentPerson": {
    "FullName": "Ted Decker",
    "AnniversaryDate": '',
}

{% assign personCampus = CurrentPerson | Campus %}
{{ CurrentPerson.NickName }}, your campus is {{ personCampus.Name  }}

Ted, your campus is Main Campus.

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{% assign children = CurrentPerson | Children %}

<ul>
{% for child in children %}
    <li>{{ child.FullName }}</li>
{% endfor %}
</ul>

<ul>
    <li>Noah Decker</li>
    <li>Alex Decker</li>
</ul>

{% assign childrenYoungToOld = Person | Children | Sort:'Age' %}
{% assign childrenOldToYoung = Person | Children | Sort:'Age', 'desc' %}

This filter accepts a set of entity identifiers, either as a comma-delimited list of values, an array, or an entity collection.

Parameters

1. EntityType: The Id, IdKey, Guid or Name of the Entity Type that identifies the type of the entities supplied in the filter input. This parameter is ignored if the input is an entity collection.
2. ExpireInMinutes (optional): The number of minutes after which the EntitySet is considered to be expired. If not specified, expiry is set to 20 minutes.
3. EntitySetPurposeValueId (optional): The identifier of a value from the Defined Type "Entity Set Purpose" that specifies the intended use of the EntitySet.
4. Note (optional): Additional information that describes the content of the EntitySet.
5. ParentEntitySetId (optional): Specifies a parent relationship between this EntitySet and an existing set.

Output

This filter returns a new EntitySet object.

{% person where:'LastName == "Miller" && FirstName ^= "T"' select:'Id' limit:4 %}
    {% assign personIdList = personItems %}
{% endperson %} 

{% assign entityTypeId = 15 %}

//- 578 is the "Person Merge Request" EntitySet Purpose
{% assign entitySet = personIdList | CreateEntitySet:entityTypeId,5,578,'Please merge.','' %}
Entity Set (Id={{ entitySet.Id }}) was created with {{ personIdList | Size }} people.

Entity Set (Id=1) was created with 2 people.

Definitions

• token (string): If you'd like to provide the token to use in the short code you can provide it here. Leave this blank ('') to use a random code.
• siteId (int): The id of the site to use for the shorting. By default the first site found with the 'Enabled for Shortening' set to true will be used. Pass in 0 if you'd like to force the default site.
• overwrite (bool): This determines what to do if the token you provided already exists. By default it will not overwrite an existing shortcode. If you provided a token, it exists and overwrite is set to false, a new random token will be returned. When set to true then the existing token will be used.
• randomLength (int): If using a random code, this determines how long it should be.
• categoryId (int): The ID of the category to assign this short link to. Useful for organizing and filtering links.
• isPinned (bool): Whether this link should be pinned to the top of the list. Use true to pin or false to leave it unpinned.

"ConnectionOpportunity": {
    "Url": "http://www.rocksolidchurchdemo.com/greeters"
}

Your personalized link is:
{{ ConnectionOpportunity | Attribute:'Url' | CreateShortLink }}

Your personalized link is:
http://www.rocksolidchurchdemo.com/HSGFTSF

Value formatting elements include:

• sd - Returns the culture's standard shortened date format (m/d/yyyy in the US)
• d - Day of the month 1 - 31.
• dd - Two digit day of the month 01 - 31.
• ddd - Abbreviated day of the week (Mon, Tue, etc.)
• dddd - Full day of the week (Monday, Tuesday, etc.)
• M - The month, from 1 through 12
• MM - The month, from 01 through 12
• MMM - The abbreviated name of the month (Jan, Feb, etc.)
• MMMM - The full name of the month
• yy - The year, from 00 to 99
• yyyy - The year as a four-digit number

• st - Returns the culture's standard shortened time format (h:mm am/pm in the US)
• h - The hour, using a 12-hour clock from 1 to 12
• hh - The hour, using a 12-hour clock from 01 to 12
• H - The hour, using a 24-hour clock from 0 to 23
• HH - The hour, using a 24-hour clock from 00 to 23
• m - The minute, from 0 through 59
• mm - The minute, from 00 through 59
• s - The second, from 0 through 59
• ss - The second, from 00 through 59
• tt - The AM/PM designator

For even more options see the Microsoft .Net Custom Date and Time Formatting Reference Guide.

"Person": {
    "FirstVisit": "2/13/2011 8am"
}

Ted's first visit was on {{ Person | Attribute:'FirstVisit' | Date:'dddd, MMMM d, yyyy' }}.

Ted's first visit was on Sunday, February 13, 2011.

By default this filter assumes the amount you pass in is in days. You can also pass in other intervals as a second parameter like:

{{ 'Now' | DateAdd:-12,'h' }}

This would subtract 12 hours from the current date/time.

• y - Years v8.0
• M - Months v8.0
• w - Weeks v8.0
• d - Days
• h - Hours
• m - Minutes
• s - Seconds

Adding weeks is simply a shorthand for adding by 7 days at a time.

"CurrentPerson": {
    "FirstVisit": "2/14/2011"
}

Your first visit was {{ CurrentPerson | Attribute:'FirstVisit' }}. Two weeks later would be {{ CurrentPerson | Attribute:'FirstVisit' | DateAdd:14 }}.

Your first visit was 2/14/2011. Two weeks later would be 2/28/2011.

Valid units are:

• Y - Years
• M - Months
• w - Weeks v17.0
• d - Days
• h - Hours
• m - Minutes
• s - Seconds

"Person": {
    "FirstVisit": "2/14/2011",
    "SecondVisit": "3/18/2011"
}

It was {{ Person.FirstVisit | DateDiff:Person.SecondVisit,'d' }}
days between {{ Person.NickName }} first and second visit.

It was 32 days between Ted's first and second visit.

This filter has some optional input parameters:

• The number of occurrences to display (optional): The default is 1. A text value of 'All' can also be used to return all the occurrences (up to one year's worth).
• enddatetime: (optional) v7.0 if 'enddatetime' is provided, the EndTime property of the iCal's occurrence is returned instead of the StartTime.

"EventItemCampuses": {
    [
        { 
            "ContactEmail": "jenny@rocksolidchurchdemo.com",
            "EventItemSchedules": [
                { 
                    "Schedule": {
                        ... ,
                        "iCalendarContent": "BEGIN:VCALENDAR VERSION:2.0 PRODID:-//ddaysof...",
                        ... ,
                    }
                }
            ]
        }
    ]
}

{% assign upcomingDates =  EventItemSchedules | Select:'Schedule' | Select:'iCalendarContent' | DatesFromICal:2 %}

<ul>
{% for date in upcomingDates %}
    <li>{{ date }}</li>
{% endfor %}
</ul>

{% assign upcomingEndDates =  EventItemSchedules | Select:'Schedule' | Select:'iCalendarContent' | DatesFromICal:2,'enddatetime' %}

<ul>
{% for endDate in upcomingEndDates %}
    <li>{{ endDate }}</li>
{% endfor %}
</ul>

<ul>
    <li>7/15/2015 7:00:00 PM</li>
    <li>7/16/2015 7:00:00 PM</li>
</ul>

<ul>
    <li>7/15/2015 8:00:00 PM</li>
    <li>7/16/2015 8:00:00 PM</li>
</ul>

Valid return values are:

• X days ago
• yesterday
• today
• tomorrow
• in x days

"Person": {
    "FirstVisit": "2/14/2015",
}

Visited {{ Person.FirstVisit | DaysFromNow }}.

Visited 14 days ago.

There are several options on how to provide the month/year combination to check for. Valid methods include:

• {{ 'now' | DaysInMonth }} - Get the days in the current month/year.
• {{ '2/1/2017' | DaysInMonth }} - Get the days in the date provided.
• {{ '' | DaysInMonth:'02','2016' }} - Get the days based on the month/year provided.

None

There are {{ 'now' | DaysInMonth }} days in the current month.

There are 31 days in the current month.

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{{ CurrentPerson | DeleteUserPreference:'block-id-12-last-run-date' }}

none

This works much like the Uniq filter, but it can be used on more complex objects. An optional parameter can be specified that will be used as the property name of the object when determining the uniqueness.

"Items": [
    {
        "Person": {
            "Id": 1,
            "FirstName": "Ted",
            "LastName": "Decker"
        },
        "GroupId": 3
    },
    {
        "Person": {
            "Id": 2,
            "FirstName": "Cindy",
            "LastName": "Decker"
        },
        "GroupId": 4
    },
    {
        "Person": {
            "Id": 1,
            "FirstName": "Ted",
            "LastName": "Decker"
        },
        "GroupId": 4
    },
]

{% assign array = Items | Distinct:'Person.Id' %}
<ul>
{% for item in array %}
    <li>{{ item.Person.FirstName }}</li>
{% endfor %}
</ul>

<ul>
    <li>Ted</li>
    <li>Cindy</li>
</ul>

When you request the object for an attribute, you will get back a cached version of that entity if one is available. One example of this is a Campus attribute. This provides significant speed boosts to Rock and your Lava as it doesn't have to hit the database to load it. Occasionally, though, you might need an actual entity object rather than the cached object. This filter will let you take that cached object and get back a real database entity.

{% assign cached = Workflow | Attribute:'TargetCampus','Object' %}
{% assign campus = cached | EntityFromCachedObject %}
{{ campus.Location.FormattedAddress }}

3120 W Cholla St Phoenix, AZ 85029-4113

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{{ CurrentPerson | FamilySalutation }}

Ted & Cindy Decker

The filter is used in conjunction with either a Persisted Dataset or an entity command. Details on how to create a Persisted Dataset are available in the Designing & Building Websites Using Rock guide.

<p>Entity Command Example</p>
{%- person where:'Id != 1' limit:'3' iterator:'People' -%}
  {%- assign followedItems = People | AppendFollowing | FilterFollowed -%}
<ul>
  {%- for item in followedItems -%}
    <li>{{ item.FullName }} - {{ item.IsFollowing }} </li>
  {%- endfor -%}
</ul>
{%- endperson -%}

<p>Persisted Dataset Example</p>
{%- assign data = 'mydataset' | PersistedDataset | AppendFollowing | FilterFollowed -%}
<ul>
{%- for item in data -%}
  <li>{{ item.Title }} - {{ item.IsFollowing }}</li>
{%- endfor -%}
</ul>

<p>Entity Command Example</p>
<ul>
    <li>Ted Decker - true</li>
</ul>

<p>Persisted Dataset Example</p>
<ul>
    <li>Friday 3/25 - true</li>
</ul>

The filter is used in conjunction with either a Persisted Dataset or an entity command. Details on how to create a Persisted Dataset are available in the Designing & Building Websites Using Rock guide.

<p>Entity Command Example</p>
{%- person where:'Id != 1' limit:'3' iterator:'People' -%}
  {%- assign followedItems = People | AppendFollowing | FilterUnfollowed -%}
<ul>
  {%- for item in followedItems -%}
    <li>{{ item.FullName }} - {{ item.IsFollowing }} </li>
  {%- endfor -%}
</ul>
{%- endperson -%}

<p>Persisted Dataset Example</p>
{%- assign data = 'mydataset' | PersistedDataset | AppendFollowing | FilterUnfollowed-%}
<ul>
{%- for item in data -%}
  <li>{{ item.Title }} - {{ item.IsFollowing }}</li>
{%- endfor -%}
</ul>

<ul>
    <li>Cindy Decker - false</li>
    <li>Noah Decker - false</li>
</ul>

<p>Persisted Dataset Example</p>
<ul>
    <li>Saturday 3/26 - false</li>
    <li>Sunday 3/27 - false</li>
</ul>

Takes a pattern or short code and formats the number accordingly. You can find a list of short codes at the .Net documentation site. You can also use patters like '#,##0.00' to format a number to have commas and two decimal places.

"Values": {
    "LastGift": "1200.23"
}

Ted's last gift was for 
{{ 'Global' | Attribute:'CurrencySymbol' }}{{ Values.LastGift | Format:'#,##0.00' }}.

Ted's last gift was for $1,200.23.

If the true parameter is provided, then the data is returned as a human readable string. Otherwise a byte array of the raw data is returned. Why might I need this filter? Base 64 encoding is sometimes returned from API calls and usually must be decoded before it can be used.

"Object": {
    "Id": 23,
    "Data": "VGVkIERlY2tlcg=="
}

{{ Object.Data | FromBase64:true }}

Ted Decker

This filter works by passing in either an integer or Guid of the cached item you'd like - or 'All' to retrieve all cached items of a given type v12.0 - along with the cache object type. Supported types are:

• DefinedValue
• DefinedType
• Campus
• Category
• GroupType
• Page
• Block
• BlockType
• EventCalendar
• Attribute
• NoteType
• ContentChannel
• EntityType
• ContentChannelItem (v20+)

"CurrentPerson": {
    "CampusId": "2"
}

<h4>Current Person's Campus</h4>

{% assign campus = CurrentPerson.PrimaryCampusId | FromCache:'Campus' %}

Current Person's Campus Is: {{ campus.Name }}

{% assign allCampuses = 'All' | FromCache:'Campus' %}

<h4>All Campuses</h4>

<ul>
{% for c in allCampuses %}
    <li>{{ c.Name }} </li>
{% endfor %}
</ul>

<h4>Current Person's Campus</h4>

Current Person's Campus Is: West-side Campus

<h4>All Campuses</h4>

<ul>
    <li>Main Campus</li>
    <li>West-side Campus</li>
</ul>

This filter accepts an IdHash string generated by the ToIdHash filter. If the IdHash cannot be converted to a valid integer Id, this filter returns an empty value.

//- Get the IdHash for Ted Decker.
{% person where:'LastName == "Decker" && NickName =="Ted"' %}
...
   {% assign idHash = person.IdKey %}
...
{% endperson %}
Ted's IdHash is: {{ idHash }}.<br>
//- Pass the IdHash to the FromIdHash filter to get the person's Id.
{% assign personFromHash = idHash | FromIdHash | PersonById %}
Hello {{ personFromHash.NickName }}!

Ted's IdHash is: 5R6B5VmEYw.<br>
Hello Ted!

Parameters include:

• Group type id to filter on
• The group role id to filter on

"CurrentPerson": {
    ...
}

{% assign areaLeaders = CurrentPerson | GeofencingGroupMembers:'24','44'   %}

<ul>
{% for leader in areaLeaders %}
    <li>{{ leader.FullName }}</li>
{% endfor %}
</ul>

<ul>
    <li>Pete Foster</li>
    <li>Ted Decker</li>
</ul>

Parameters include:

• Group type id to filter on

"CurrentPerson": {
    ...
}

{% assign areas = CurrentPerson | GeofencingGroups:'24'  %}

<ul>
{% for area in areas %}
    <li>{{ area.Name }}</li>
{% endfor %}
</ul>

<ul>
    <li>Area A</li>
    <li>Area B</li>
</ul>

You can pass in either a full person object or just a person id.

"CurrentPerson": {
    ...
}

Your person alternate id is: 
{{ CurrentPerson | GetPersonAlternateId }}.

Your person alternate id is: 18bf456-f2fc443.

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{{ CurrentPerson | GetUserPreference:'block-id-12-last-run-date' }}

4/6/2016

This filter has a couple of input parameters:

• Group Id: The Id of the specific group you are interested in.
• Group Member Status (optional): You can also pass in a specific group member status you're looking for ('Active', 'Inactive' or 'Pending'). The default if none is provided is 'Active'. You can also pass in 'All' if you want all statuses.

This filter returns group member records. Keep in mind you could get multiple records for a specific individual as it's possible they are in the same group more than once with different roles.

"CurrentPerson": {
    ...
}

{% assign groupMembers = CurrentPerson | Group:'29','All' %}

<ul>
{% for groupMember in groupMembers %}
    <li>{{ groupMember.Group.Name }} - {{ groupMember.GroupRole.Name }} ( {{ groupMember.GroupMemberStatus }} )</li>
{% endfor %}
</ul>

<ul>
    <li>General Group 1 - Leader ( Active )</li>
    <li>General Group 1 - Member ( Inactive )</li>
</ul>

The returned data is a dictionary. Each distinct property tree value is represented as a key in the dictionary with all associated original objects as values of that key. As such, when iterating through the result you need to use the PropertyToKeyValue filter to get the key and the array of values.

"Members": [
    {
        "GroupRole": {
            "Name": "Member"
        },
        "Person": {
            "FirstName": "Alex"
        }
    },
    {
        "GroupRole": {
            "Name": "Leader"
        },
        "Person": {
            "FirstName": "Ted"
        }
    },
    {
        "GroupRole": {
            "Name": "Member"
        },
        "Person": {
            "FirstName": "Cindy"
        }
    }
]

{% assign groupedMembers = Members | GroupBy:'GroupRole.Name' %}
<ul>
{% for group in groupedMembers %}
    {% assign parts = group | PropertyToKeyValue %}
    <li>{{ parts.Key }}</li>
    <ul>
        {% for member in parts.Value %}
            <li>{{ member.Person.FirstName }}</li>
        {% endfor %}
    </ul>
{% endfor %}
</ul>

<ul>
    <li>Leader</li>
    <ul>
        <li>Ted</li>
    </ul>
    <li>Member</li>
    <ul>
        <li>Alex</li>
        <li>Cindy</li>
    </ul>
</ul>

This filter has a couple of input parameters:

• Group Type: The group type that should be used as a filter. Returned groups must be of this type.
• Group Member Status (optional): You can also pass in a specific group member status you're looking for ('Active', 'Inactive' or 'Pending'). The default if none is provided is 'Active'. You can also pass in 'All' if you want all statuses.
• Group Status (optional): By default the filter will only include active groups. Pass the string 'All' to include inactive groups as well. v9.2

This filter returns group member records. See the example below for how to access common properties.

"CurrentPerson": {
    ...
}

{% assign groupMembers = CurrentPerson | Groups:'29','All' %}

<ul>
{% for groupMember in groupMembers %}
    <li>{{ groupMember.Group.Name }} ( {{ groupMember.GroupMemberStatus }} )</li>
{% endfor %}
</ul>

<ul>
    <li>General Group 1 ( Active )</li>
    <li>General Group 2 ( Inactive )</li>
</ul>

This filter accepts a single Guid value, a comma-delimited list of values, or an array. If the input consists of multiple values, the output is an array of corresponding Id values in the same order as the input values.

This filter has the following parameters:

1. EntityType (required): The Id, Guid or Name of the Entity Type that matches the type of entity identified by the input Guid.

{% assign personGuid = '8fedc6ee-8630-41ed-9fc5-c7157fd1eaa4' %}
{% assign personEntityTypeId = '72657ed8-d16e-492e-ac12-144c5e7567e7' | GuidToId:'EntityType' %}
{% assign personId = personGuid | GuidToId:personEntityTypeId %}
Ted Decker's record can be identified by Guid '{{ personGuid }}' or Id '{{ personId }}'.

Ted Decker's record can be identified by Guid '8fedc6ee-8630-41ed-9fc5-c7157fd1eaa4' or Id '1'.

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{% assign headOfHouse = CurrentPerson | HeadOfHousehold %}
{{ headOfHouse.FullName }}

Ted Decker

Pass the secret key for the message as a parameter to the filter.

{% assign my_secret_string = 'RockIsAwesome!' | HmacSha1:'secret_key' %}
My encoded string is: {{ my_secret_string }}

My encoded string is: 17dbf467d8f49e9f541c7af8adf26c8422bdb342

Pass the secret key for the message as a parameter to the filter.

{% assign my_secret_string = 'RockIsAwesome!' | HmacSha256:'secret_key' %}
My encoded string is: {{ my_secret_string }}

My encoded string is: 3518d7aa4ad81041e14033f2bbfa317e8f2f5aa26d6f48f719783aeaebe481ae

This filter works by passing in either an integer or Guid of the image for which you want to create a URL. There are two input parameters:

• Fallback URL (optional): The URL to be returned if the integer ID or Guid input is not defined.
• Root URL (optional): This parameter is multipurpose:
  • If the parameter is not passed (is null), or a value of false is passed, the image URL will be returned without prepending Rock's root application URL.
  • If a value of true or 'rootUrl' is passed, the returned image URL will include Rock's root application URL, meaning it will be the complete URL to the image.

None

{% contentchannelitem id:'1' %}
    <img src="{{ contentchannelitem | Attribute:'Image','RawValue' | ImageUrl }}" />
    
    <img src="{{ contentchannelitem | Attribute:'Image','RawValue' | ImageUrl:'https://via.placeholder.com/150', true }}" />
{% endcontentchannelitem %}

<img src="{{ item | Attribute:'Image','RawValue' | ImageUrl:'https://via.placeholder.com/150' }}" />

<img src="/GetImage.ashx?Guid=0241ED2F-B527-424C-917C-1142A398711F">

<img src="http://www.rocksolidchurchdemo.com/GetImage.ashx?Guid=0241ED2F-B527-424C-917C-1142A398711F">

<img src="https://via.placeholder.com/150">

This filter will accept input in the following formats:

• String (that can be parsed into a date)
• Date
• DateTime
• DateTimeOffset

The filter will attempt to parse each parameter (input, start of range, end of range) into a valid DateTime and check if the input falls within the range (inclusive). A boolean value will be returned.

"Items": [
    { 
        "Id": 1, 
        "Title": "Easter Devotional",
        "FeaturedDates": "4/10/2022 to 4/20/2022" 
    },
    { 
        "Id": 2, 
        "Title": "Christmas Devotional",
        "FeaturedDates": "12/20/2022 to 12/31/2022" 
    },
]

{% assign today = '2022-04-17 07:00' | Date:'yyyy-MM-dd HH:mm' %}
{% for i in Items %}
    {% assign startDate = i.FeaturedDates | Split:' to ' | First %}
    {% assign endDate = i.FeaturedDates | Split:' to ' | Last %}
    {% if i.FeaturedDates != '' %}
        {% assign isFeatured = today | IsDateBetween:startDate,endDate %}
        {% if isFeatured %}
            {{i.Title}}
        {% endif %}
    {% endif %}
{% endfor %}

Easter Devotional

Has optional parameters to provide a purpose key (v13.4) and specify a different the person to test against instead of the current person.

{% assign group = 56 | GroupById %}
{% assign followed = group | IsFollowed %}
{% if followed == true %}
  <p>You are following the group {{ group.Name }}.</p>
{% else %}
  <p>You are not currently following the group {{ group.Name }}.</p>
{% endif %}

<p>You are following the group Serving Teams.</p>

This filter operates on the given entity object or entity Id and has a single parameter:

• Data View Id: The Id of the specific data view you want to check.

"CurrentPerson": {
    ...
}

"Group" {
    "Id": 111,
    "Name" : "Decker Group"
    ...
}

{% assign inDataView = CurrentPerson.Id | IsInDataView:'1337' %}
{% if inDataView %}
   That person is in the 1337 data view.
{% endif %}

{% assign inDataView = Group | IsInDataView:'230' %}
{% if inDataView %}
   The '{{Group.Name}}' is in the 230 data view.
{% endif %}

That person is in the 1337 data view.

The 'Decker Group' is in the 230 data view.

This filter operates on the given person object and has a single parameter:

• Group Id: The Id of the specific security role you are interested in.

If the given group Id is not a security role, it will return false but also log an exception.

"CurrentPerson": {
    ...
}

{% assign isInRole = CurrentPerson | IsInSecurityRole:18 %}
{% if isInRole == true %}
  <p>{{ CurrentPerson.FullName }} is in that Role.</p>
{% else %}
  <p>{{ CurrentPerson.FullName }} is not in that Role.</p>
{% endif %}

<p>Alisha Marble is in that Role.</p>

StartDateTime

"CurrentPerson": {
    ...
}

{% assign lastAttended = CurrentPerson | LastAttendedGroupOfType:'25' %}

{{ CurrentPerson.NickName }} last attended the group '{{ lastAttended.Occurrence.Group.Name }}' on {{ lastAttended.StartDateTime | Date:'dddd, MMMM d, yyyy' }}.

Ted last attended the group 'Alisha Marble’s Group' on Wednesday, May 13, 2015.

An example use case for this filter is showing the Gravatar image associated with the poster of a comment:

"Person": {
    "Email": "hi@example.com"
}

<img src="https://www.gravatar.com/avatar/{{ Person.Email | Trim | Downcase | Md5 }}" />

<img src="https://www.gravatar.com/avatar/767fc9c115a1b989744c755db47feb60">

This filter converts meters to miles and accepts the following parameter:

• Precision (optional): The number of decimal places to convert to (default is 1).

7,623 meters is: {{ 7623 | MetersToMiles:2 }} miles

7,623 meters is: 4.74 miles

Converts miles to meters.

2.4 miles is {{ 2.4 | MilesToMeters }} meters

2.4 miles is 3862 meters

This filter accepts the following parameters:

• Result Count (optional): The maximum number of campuses to return. If this parameter is not specified, the default value is 1.

{% assign campus = CurrentPerson | NearestCampus %}
The nearest campus to {{ CurrentPerson.NickName }} is: {{ campus.Name }}.

{% assign campusList = CurrentPerson | NearestCampus:2 %}
The two nearest campuses to {{ CurrentPerson.NickName }} are: {{ campusList | Select:'Name' | Join:', ' }}.

The nearest campus to Ted is: Main Campus.
The two nearest campuses to Ted are: Main Campus, North Campus.

This filter accepts the following parameters:

• Group Type Id: The group type to filter by.
• Max Results (optional): The maximum number of results to return. Defaults to 10.
• Travel Mode (optional): The filter can append the travel distance and travel time if you provide a mode of travel (drive, walk or bicycle). This requires that you have provided a Google Maps API key and that key has permissions to use the Routes API.
• Consider Closest Location (optional): Determines what to do if a group has more than one location. When set to true, the default, only the group's closest location will be returned. When false, all of the groups locations will be considered. This will have the effect of putting the group into the collection more than once.
• Max Distance (optional): The maximum distance to consider, in meters (1 mile ≈ 1,609.34 meters) .

The filter returns a collection of items with the following properties:

• StraightLineDistanceInMeters: The distance between the person and the group, in meters.
• Group: The group.
• Location: The group's location.

Note: If a group has multiple locations, each location will be evaluated independently. As a result, the same group may appear in the list more than once.

{% assign closeGroups = CurrentPerson | NearestGroups:25,5,'drive' %}

<ul>
{% for result in closeGroups %}
    <li>
        <strong>{{ result.Group.Name }}</strong>
        <br>{{ result.Location.Latitude }}, {{ result.Location.Longitude }}
        <br>{{ result.Location.Street1 }}
        <br>Distance: {{ result.StraightLineDistanceInMeters }}
        <br>Travel Time In Minutes: {{ result.TravelTimeInMinutes }}
        <br>Travel Distance In Meters: {{ result.TravelDistanceInMeters }}
    </li>
{% endfor %}
</ul>

<ul>

    <li>
        <strong>Gilbert Group</strong>
        <br>33.58622, -112.135094
        <br>11022 N 35th Dr
        <br>Distance: 2342 
        <br>Travel Time In Minutes: 5
        <br>Travel Distance In Meters: 2567
    </li>

    ...
</ul>

This filter has plenty of options to help make retrieving notes simple. First you can pass the filter either a full entity (any type) or an integer that represents the entity id.

You must pass in either an integer that represents a note type id or a comma delimited string of note type ids.

Optional parameters include:

• Sort Order: string ('asc' or 'desc'). If no option is provided 'desc' is assumed.
• Count: an integer of how many items you'd like returned.

Security is checked on the notes based on the currently logged in user.

"CurrentPerson": {
    ...
}

{% assign notes = CurrentPerson | Notes:'4,5','asc',2 %}

Notes
{% for note in notes %}
    <p>{{ note.Text }} </p>
{% endfor %}

Notes
<p>Note one.</p>
<p>Note two.</p> 

Objects in Lava give you access to almost any kind of record stored in Rock's database. Objects always have properties, and the most common way of getting a property value is using "dot notation", where you have the object or variable, followed by a dot and the property name. Properties can even be nested objects themselves, so you can chain them together to get what you need.

"Person": {
  "FullName": "Ted Decker",
  "Email": "ted@rocksolidchurchdemo.com",
  "GivingId": "G84",
  ...
}

{{ Person.GivingId }}

G84

You can sort by multiple keys, for example you can sort by LastName and then by FirstName at once. Each key to sort by is separated by a comma (,) character. Each sorted property can change the default order from ascending (default) to descending by appending a space and desc to the property name.

For example, if you specify the order by property of FirstName desc then the collection will be sorted by FirstName and the results will be returned in descending order.

"Members": [
    {
        "GroupRole": {
            "Name": "Member",
            "IsLeader": false
        },
        "Person": {
            "FirstName": "Alex"
        }
    },
    {
        "GroupRole": {
            "Name": "Leader",
            "IsLeader": true
        },
        "Person": {
            "FirstName": "Ted"
        }
    },
    {
        "GroupRole": {
            "Name": "Member",
            "IsLeader": false
        },
        "Person": {
            "FirstName": "Cindy"
        }
    }
]

{% assign members = Members | OrderBy:'GroupRole.IsLeader desc,Person.FirstName' %}
<ul>
{% for member in members %}
    <li>{{ member.Person.FirstName }} - {{ member.GroupRole.Name }}</li>
{% endfor %}
</ul>

<ul>
    <li>Ted - Leader</li>
    <li>Alex - Member</li>
    <li>Cindy - Member</li>
</ul>

Be very careful on how you configure this filter. You always want to provide a way to get back to this page, without it redirecting, so that you can edit your lava. Below are two strategies for doing this.

If your lava is inside of an HTML block you can use that block's 'CurrentPersonCanEdit' merge field to stop the redirect if the current user has edit access to the block. An example of this usage is below.

{% if CurrentPersonCanEdit %}
    <p class="alert alert-warning">If you could not edit you would be redirected to: <a href="http://www.rockrms.com">http://www.rockrms.com</a>.</p>
{% else %}
    {{ 'http://www.rockrms.com' | PageRedirect }}
{% endif %}

Another strategy to allow the editing of the lava content is to add ?Redirect=false to the query string. If the lava filter sees this in the page's address it will not perform the redirect. Instead it will display the link that it would have redirected to.

"Event": {
    "ExternalUrl": "http://www.rockrms.com",
}

{{ Event.ExternalUrl | PageRedirect }}

The current page request will be redirected to the address provided. 

The identifier can either be a Page Id, a Page Guid or a full page route (as shown in the example) which contains <PageGuid>,<RouteGuid>. You can optionally pass in a string of parameters to use when generating the URL. The parameters should be separated by ^. Each parameter should consist of a key and value separated by an =. You may also pass in a dictionary object that contains the parameters.

{{ 'Global' | Attribute:'WorkflowEntryPage','RawValue' | PageRoute:'WorkflowTypeId=10^WorkflowId=324' }}

/WorkflowEntry/10/324

Details on how to create a Persisted Dataset are available in the Designing & Building Websites Using Rock guide.

{% assign data = 'mydataset' | PersistedDataset %}
<ul>
{% for item in data %}
  <li>{{ item.Title }}</li>
{% endfor %}
</ul>

<ul>
    <li>Friday 3/25</li>
    <li>Saturday 3/26</li>
    <li>Sunday 3/27</li>
</ul>

The token that is created identifies a person and a corresponding action. It requires a corresponding block that understands how to decode these tokens using specific action names provided when the token was created.

This filter has one required input parameter:

1. Action: The name of an action that the corresponding block knows how to decode.

Here is the list of blocks that can decode these tokens:

• Assessment Blocks (Conflict Profile, DISC, EQ Inventory, Gifts Assessment, Motivators)
• Email Preference Entry
• Group Schedule Confirmation
• Photo Opt Out
• RSVP Response
• GetCommunication.ashx (communication viewer)

"Person": {
    ...
}

Your token is: 
{{ Person | PersonActionIdentifier: 'photo-opt-out' }}

Your token is: EAAAAEgOBBKHKHzZ7vg2Jl6mSJ!2fQsI6lz3QhqRsjoYp4EgKpdSkvE2gR2nG4yq6l6TJTKBVyJWQudZ!2sdfsfdfsOaj5yGsWNkk!3d

The input to this filter can be any valid person reference - a Person object, Guid or Id.

Available parameters:

1. The item types, specified as a comma-delimited list (optional;Segments|RequestFilters):
   • Segments = the personalization segments associated with this person.
   • RequestFilters = the request filters associated with the current page request.
   If this parameter is not specified, all item types are returned.

Output: A collection of personalization items with the following properties:

1. ID - the unique identifier of the personalization item
2. Type - the type of personalization item, either "Segment" or "Request Filter".
3. Key - the unique key that identifies the personalization item.
4. Name - the friendly name of the item.

URL:
http://rock.rocksolidchurchdemo.com?parameter1=true&parameter2=true


Logged-In User:
Ted Decker

{% assign items = CurrentVisitor | PersonalizationItems:'Segments,RequestFilters' %}
{% for item in items %}
    {{ item.Type }} - {{ item.Key }}
{% endfor %}

Segment - AllMen
Segment - InSmallGroup
Segment - NotYetBaptized
Request Filter - ViewingFromCollegeCampusIP
Request Filter - QUERY_2

The filter uses a generated PersonActionIdentifier and the corresponding action to retrieve the details of the person for which the token was generated.

This filter has one required input parameter:

1. Action: The name of the action used when creating the token.

"PersonActionIdentifier": "EAAAAEgOBBKHKHzZ7vg2Jl6mSJ!2fQsI6lz3QhqRsjoYp4EgKpdSkvE2gR2nG4yq6l6TJTKBVyJWQudZ!2sdfsfdfsOaj5yGsWNkk!3d"

{% assign person = PersonActionIdentifier | PersonByPersonActionIdentifier: 'photo-opt-out' %}
Welcome {{ person.NickName }}

Welcome Bill

This filter has optional input parameters:

1. Minutes (optional; defaults to 30 mins): The number of minutes that the token is good for.
2. Max Usage (optional; defaults to 1) : The number of times the token can be used.
3. PageId (optional) : In rare cases you may want the token to only be good for a specific page. NOTE: The page Id must exist otherwise it will not generate a token.

{{ 'https://rocksolidchurchdemo.com' | PersonImpersonationToken }}

https://rocksolidchurchdemo.com?rckipid=EAAAAEgOfZ6BLzZ7vg2Jl6mSJ!2fQsI6lz3QhqRsjoYp4EgKpdSkvE2gR2nG4yq6l6TJTKBVyJWQudZ!2bgxOaj5yGsWNkk!3d

This filter has optional input parameters:

1. Minutes (optional; defaults to the value of the Person Token Expire Minutes Global Attribute): The number of minutes that the token is good for.
2. Max Usage (optional; defaults to the value of the Person Token Usage Limit Global Attribute) : The number of times the token can be used.
3. PageId (optional) : In rare cases you may want the token to only be good for a specific page. A page route cannot be used here. NOTE: The page Id must exist otherwise it will not generate a token.

This is generally used in connection with the page parameter 'rckipid'.
Example:
?rckipid={{ Person | PersonTokenCreate }}

"Person": {
    ...
}

Your token is: 
{{ Person | PersonTokenCreate }}

Your token is: EAAAAEgOfZ6BLzZ7vg2Jl6mSJ!2fQsI6lz3QhqRsjoYp4EgKpdSkvE2gR2nG4yq6l6TJTKBVyJWQudZ!2bgxOaj5yGsWNkk!3d

{% assign token =  Person | PersonTokenCreate:43200,3,1543 %}

{% assign token =  Person | PersonTokenCreate:43200,null,1543 %}

This filter has optional input parameters:

1. Increment Usage (default false) : This would determine if the usage counter should be incremented by the reading of the token.
2. Page Id : In rare cases tokens are only good on specific pages. In these cases you'll need to provide the page id to use for the check.

{
    ... normally tokens would be read from the query string
}

{% assign token = 'Global' | PageParameter:'rckipid' %}
{% assign person = token | PersonTokenRead %}
{{ person.FullName }}

Ted Decker

{% assign person = token | PersonTokenRead:false,1543 %}

This filter has some input parameters:

• Phone Type: The name of the phone type you want to fetch (such as Home, Mobile, Work as defined by the Phone Type Defined Value).
• Show Country Code (optional): By default the number's country code is not output but if you include an additional true parameter the country code will be shown.

"CurrentPerson": {
    "FullName": "Ted Decker"
    "PhoneNumbers":  [
        {
            Number - 6235555551
            NumberFormatted - (623) 555-5551
            NumberType - Home
        },
        {
            Number - 6235555552
            NumberFormatted - (623) 555-5552
            NumberType - Mobile
        },
        {
            Number - 6235555553
            NumberFormatted - (623) 555-5553
            NumberType - Work
        }
    ]
}

Mobile Number: {{ CurrentPerson | PhoneNumber:'Mobile' }}

Mobile Number: (623) 555-5552

{{ CurrentPerson | PhoneNumber:'Home', true }}

Turns 'tree' to 'trees', but also is smart enough to turn 'man' to 'men', 'goose' to 'geese', etc. Yeah, it’s like magic!

"Workflow": {
    "WorkTerm": "Request"
}

There are many {{ Workflow.WorkTerm | Pluralize | Downcase }} in the system.

There are many requests in the system.

The random number is non-inclusive of the input value, meaning if you pass in 100 then you get a random number in the range of 0-99.

<p>The lottery number is {{ 100 | RandomNumber }}.</p>

<p>The lottery number is 83.</p>

This filter has the following format:

{{ 'cookieName' | ReadCookie }}

Definitions

• cookieName (string): A name that uniquely identifies the cookie. This should be the same as the name that used to set the cookie with the WriteCookie filter.

You recently told us that your favorite cookie is {{ 'FavoriteCookie' | ReadCookie }}
and your favorite color is {{ 'FavoriteColor' | ReadCookie }}.

You recently told us that your favorite cookie is choc-chip
and your favorite color is green.

There are two optional parameters for 'words per minute' and 'seconds per image'.

{{ Item.Content | ReadTime:275 }} <- words per min (default to 275)
{{ Item.Content | ReadTime:275,12 }} <- seconds per image (default to 12)

The read time calculation uses 12 seconds (or the provided value), and subtracts a second for each subsequent image, with each additional image adding a minimum of 3 seconds to the read time.

Results are formatted "1 hr 23 mins" for longer than one hour, "23 mins" for less than an hour, and "30 secs" for less than one minute.

"Item": {
    "Content": "The quick brown fox jumps over the lazy dog."
}

{{ Item.Content | ReadTime }}

2 secs

The first parameter is the regular expression to match against. The second parameter is the replacement string value. An optional third parameter contains any regular expression flags to use. Back-references can be used, as in the second example, but are slightly different than normal regular expression syntax. Normally you would use \1 to indicate the first capture group however .NET uses $1 to indicate the same.

Available parameters:

1. the regular expression
2. the replacement string
3. flags (optional):
   • i = Do comparison in a case-insensitive manner.
   • m = Multiline mode. ^ and $ will match the beginning and end of lines instead of the beginning and end of the entire input.

"Message": "Hello Ted, how are you?"

{{ 'The Rock is awesome.' | RegExReplace:'the rock','Rock','i' }}
{% capture expression %}[Hh]ello (\w+){% endcapture %}
{{ Message | RegExReplace: expression,'Greetings $1' }}

Rock is awesome.
Greetings Ted, how are you?

This filter operates on the given structured content and renders it as HTML:

• Content: String saved using the StructuredContentEditor control. The string is saved with metadata which this filter uses to render it as HTML.
• User Values (optional): If there are corresponding user values to include in the rendered output, those can be included (introduced v16.7).

"StructuredContent": {
    ""time"":1676039688279,
    ""blocks"":[
       {
          ""id"":""a2FYCrj8NG"",
          ""type"":""header"",
          ""data"":{
             ""text"":""Things I love."",
             ""level"":2
          }
       },
       {
          ""id"":""egdM-bpIfg"",
          ""type"":""list"",
          ""data"":{
             ""style"":""ordered"",
             ""items"":[
                {
                   ""content"":""Reading a good book."",
                   ""items"":[
                      
                   ]
                },
                {
                   ""content"":""Helping others."",
                   ""items"":[
                      
                   ]
                },
                {
                   ""content"":""Seeing other people laugh."",
                   ""items"":[
                      
                   ]
                }
             ]
          }
       }
    ],
    ""version"":""2.22.1""
 }

{{ StructuredContent | RenderStructuredContentAsHtml }}

<h2>Things I love.</h2>
<ol>
    <li>Reading a good book.</li>
    <li>Helping others.</li>
    <li>Seeing other people laugh.</li>
</ol>

The five supported settings are shown in the example.

Application Directory: {{ 'ApplicationDirectory' | RockInstanceConfig }}
Physical Directory: {{ 'PhysicalDirectory' | RockInstanceConfig }}
Machine Name: {{ 'MachineName' | RockInstanceConfig }}
Is Clustered: {{ 'IsClustered' | RockInstanceConfig }}
System Date/Time: {{ 'SystemDateTime' | RockInstanceConfig | Date:'yyyy-MM-dd HH:mm:ss' }}

Application Directory: D:\inetpub\wwwroot\Rock\bin
Physical Directory: D:\inetpub\wwwroot\Rock\bin
Machine Name: MYROCKSERVER
Is Clustered: false
System Date/Time: 2020-11-17 10:30:01

This can be useful when taking Lava from an Attribute Value that needs to be processed before displaying to an individual. The Lava executes in the same security context as the existing Lava. So if you have Entity Commands enabled in your parent Lava, then the child Lava you execute will also be able to run Entity Commands.

{
    "Value": "{% assign test = 'Hello World' %}{{ test }}"
}

<p>
    {{ Value }}
</p>
<p>
    {{ Value | RunLava }}
</p>

<p>
    {% assign test = 'Hello World' %}{{ test }}
</p>
<p>
    Hello World
</p>

To modify the URL of the current page, specify "Current" as the input string.

Available parameters:

1. the URL parameter name. If the parameter exists in the page route, the route will be modified - if not, the parameter will be added to the query string.
2. the parameter value. To remove an existing parameter, specify an empty string.
3. the format of the output URL (optional):
   • absolute = A complete URL, including scheme and host name.
   • relative = A URL that is expressed relative to the current Rock host server.

Example 1:
{{ 'https://rocksolidchurchdemo.com/reporting/reports/12' | SetUrlParameter:'ReportId','155' }}

Example 2:
{{ 'https://rocksolidchurchdemo.com/reporting/reports' | SetUrlParameter:'CategoryId','101' }}

Example 1:<br>
https://rocksolidchurchdemo.com/reporting/reports/155
<hr>
Example 2:<br>
https://rocksolidchurchdemo.com/reporting/reports?CategoryId=101

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{{ CurrentPerson | SetUserPreference:'block-id-12-last-run-date', '4/6/2016' }}

none

Turns 'trees' to 'tree', but also is smart enough to turn 'women' to 'woman', 'geese' to 'goose', etc.

"Workflow": {
    "ConnectionStatusType": "Members"
}

Ted is a {{ Workflow.ConnectionStatusType | Singularize | Downcase }}.

Ted is a member.

This filter has the following input parameters:

1. Pattern: The string to use as the separator when splitting the input.
2. Remove Empty (optional; default true)v13.0: By default, standard Liquid removes empty entries from the array, but passing 'false' to this optional setting can override that behavior.
3. Maximum (number; optional)v14.1: This option will split the string into a maximum number of substrings.

"Person": {
    "Email": "ted@rocksolidchurchdemo.com"
}

"Item": {
    "Title": "Topic: Man vs 10:00"
}

// Simple example
{% assign emailParts = CurrentPerson.Email | Split:'@' %}
Your email domain is: {{ emailParts[1] }}.

// Split with Maximum option
{% assign stringParts = item.Title | Split:':', 2 %}
The first part is: {{ stringParts[0] }}
The second part is: {{ stringParts[1] }}

// Split with Remove Empty false and Maximum option
{% assign itemsList = "A,B,,D,E,F,G" | Split:',', false, 4 %}
The first part is: {{ itemsList[0] }}
The second part is: {{ itemsList[1] }}
The third part is: {{ itemsList[2] }}
The fourth part is: {{ itemsList[3] }}

Your email domain is: rocksolidchurchdemo.com.

The first part is: Topic
The second part is: Man vs 10:00

The first part is: A
The second part is: B
The third part is:
The fourth part is: D,E,F,G
The fifth part is:

This Lava filter takes either a Person object or an integer that represents a PersonId.

"CurrentPerson": {
    ...
}

{% assign spouse = CurrentPerson | Spouse %}
{{ spouse.FullName }}

Cindy Decker

This filter supports the following optional parameters:

• Step Program (optional): A step program identifier used to filter the steps. This value can be an Id or Guid (or 'all'), and returned steps must be related to this program.
• Step Status (optional): A step status identifier used to filter the steps. This value can be an Id, Guid, or Name (or 'all'), and returned steps must have this status.
• Step Type (optional): A step type identifier used to filter the steps. This value can be an Id or Guid (or 'all'), and returned steps must be related to this step type.

This filter returns step records. See the example below for how to access common properties.

"CurrentPerson": {
    ...
}

{% assign steps = CurrentPerson | Steps: '1','Complete' %}

<ul>
{% for step in steps %}
    <li>{{ step.StepType.Name }} ( {{ step.StepStatus.Name }} )</li>
{% endfor %}
</ul>

<ul>
    <li>Baptism ( Complete )</li>
    <li>Starting Point Class ( Complete )</li>
    <li>Small Group ( Complete )</li>
</ul>

Keep in mind that Rock considers Sunday to be the last day of the week. This makes sense when calculating church metrics. The 'Now' keyword can be used in place of a date for the current date.

"CurrentPerson": {
    "FirstVisit": "2/14/2011"
}

You first visited on the week of {{ CurrentPerson | Attribute:'FirstVisit' | SundayDate }}.

You first visited on the week of 2/20/2011.

When provided a text value, the string is encoded using UTF-8 before being converted to Base64. If a byte collection is provided, the raw bytes are encoded directly.

If you need to encode a binary file stored in Rock (such as a BinaryFile), use the Base64Encode filter instead.

"CurrentPerson": {
    "FullName": "Ted Decker",
    "AnniversaryDate": '',
}

"BinaryData": [0, 1, 2, 3, 255]

ToBase64: {{ CurrentPerson.FullName | ToBase64 }}<br/>
ToBase64: {{ BinaryData | ToBase64 }}<br/>

ToBase64: VGVkIERlY2tlcg==
ToBase64: AAECA/8=

This filter accepts either a Rock entity object or an integer Id value.

{% person id:'5' %}
   {{ person.NickName }}'s IdHash is '{{ person | ToIdHash }}' and Id is {{ person.Id }}.
{% endperson %}

Ted's IdHash is '5R6B5VmEYw' and Id is 5.

This filter supports the following parameters:

1. the string to remove (optional). If not specified, blank spaces will be removed. v14

<h1>Example 1:</h1>
<p>-{{ '  Ted Decker  ' | Trim }}-</p>
<hr>
<h1>Example 2:</h1>
<i>{{ '/*/*/*/Ted Decker//*/*/*' | Trim:'/*' }}</i>

<h1>Example 1</h1>
<p>-Ted Decker-</p>
<hr>
<h1>Example 2</h1>
<p>/Ted Decker/</p>

This filter supports the following parameters:

1. the string to remove (optional). If not specified, blank spaces will be removed.

<h1>Example 1:</h1>
<p>-{{ '  Ted Decker  ' | TrimEnd }}-</p>
<hr>
<h1>Example 2:</h1>
<i>{{ '/*/*/*/Ted Decker//*/*/*' | TrimEnd:'/*' }}</i>

<h1>Example 1</h1>
<p>-  Ted Decker-</p>
<hr>
<h1>Example 2</h1>
<p>/*/*/*/Ted Decker/</p>

This filter supports the following parameters:

1. the string to remove (optional). If not specified, blank spaces will be removed.

<h1>Example 1:</h1>
<p>-{{ '  Ted Decker  ' | TrimStart }}-</p>
<hr>
<h1>Example 2:</h1>
<i>{{ '/*/*/*/Ted Decker//*/*/*' | TrimStart:'/*' }}</i>

<h1>Example 1</h1>
<p>-Ted Decker   -</p>
<hr>
<h1>Example 2</h1>
<p>/Ted Decker//*/*/*</p>

• The input value is ignored.
• The generated string takes the format of "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", where each "x" can be 0-9 or A-F.

{{ '' | UniqueIdentifier }}

E9206998-3Fb5-4ED1-A372-C593A79C7DD1

This triggers a persisted dataset to update by running its Lava template.

• Delay Processing Until Complete (optional, default: false): Determines whether the filter should wait until persistence is complete. In most cases, you won't need to wait—but for certain use cases, it might be necessary.

{{ 'DataSetKey' | UpdatePersistedDataset }}

This filter has the following format:

{{ 'content' | UploadBinaryFile:'binaryFileTypeId','filename','mimeType','format',isTemporary,'binaryFileId' }}

Definitions

• binaryFileTypeId (string): The identifier of the binary file type to use when storing the file data. This may be an integer id, encrypted id, or unique identifier.
• filename (string): The name of the file.
• mimeType (string, optional): The MIME type that will be used to identify the type of file, such as 'application/pdf'. If not provided then 'application/octet-stream' will be used by default.
• format (string, optional): The type of input being passed to the filter. This can be either 'base64' or 'raw'. If not provided then 'raw' will be used by default. If 'base64' is specified then the string will be decoded from base64 and be stored as binary data.
• isTemporary (bool, optional): The file will be marked for permanent storage by default, if you instead want to make the file temporary then pass 'true' without quotes here.
• binaryFileId (string, optional): If specified, then an existing binary file will be updated instead of a new file being created. This may be an integer id, encrypted id, or unique identifier.

{% assign content = 'Hello Rock Community' %}
{% assign file = content | UploadBinaryFile:'3', 'hello.txt', 'text/plain' %}
<a href="/GetFile.ashx?Guid={{ file.Guid }}">Download</a>

<a href="/GetFile.ashx?Guid=48a414ab-23b8-4700-9dda-00c156adb360">Download</a>

This filter has a couple of input parameters:

• Key: The property name on the collection item that should be evaluated.
• Value: The value that will be compared against the property specified by the key.
• Comparison (optional): Determines how the value comparison should be performed.
  • equal – Returns items where the value matches exactly. This is the default if no comparison is provided.
  • notequal – Returns items where the value does not match. v12.3
  • contains – Returns items where the property contains the specified value. v19.0

"CurrentPerson": {
    "FullName": "Ted Decker"
    "PhoneNumbers":  [
        {
            Number - 6235555551
            NumberFormatted - (623) 555-5551
            NumberTypeValueId - 12
        },
        {
            Number - 6235555552
            NumberFormatted - (623) 555-5552
            NumberTypeValueId - 13
        },
        {
            Number - 6235555553
            NumberFormatted - (623) 555-5553
            NumberTypeValueId - 136
        }
    ]
}

Example 1:
{{ CurrentPerson.NickName }}'s work phone is: {{ CurrentPerson.PhoneNumbers | Where:'NumberTypeValueId', 136 | Select:'NumberFormatted' }}.

Example 2 (v12.3 and above):
{{ CurrentPerson.NickName }}'s other contact numbers are: {{ CurrentPerson.PhoneNumbers | Where:'NumberTypeValueId', 136, 'notequal' | Select:'NumberFormatted' | Join:', ' }}.

Ted's work phone is: (623) 555-5553.
Ted's other contact numbers are: (623) 555-5551, (623) 555-5552.

The key two parameters are 'success text' and 'fallback text'. If the input is not null or an empty string the 'success text' will be appended to the input. If it is null or empty then the 'fall back' text will be used instead.

As of v7.4 there is an optional third parameter to control the append order. By default the success text will be prepended at the beginning of the input. You can override that by passing in the text 'append' to the filter.

{{ CurrentPerson.NickName | WithFallback:', are', 'Are', 'append' }} you interested in baptism?

"CurrentPerson": {
    "NickName": "Ted",
    ...
}

{{ CurrentPerson.NickName | WithFallback:', are', 'Are', 'append' }} you interested in baptism?

Ted, are you interested in baptism?
- or if {{ CurrentPerson }} was null -
Are you intersted in baptism?

This filter has the following format:

{{ 'cookieName' | WriteCookie:'value','expiryInMinutes' }}

Definitions

• cookieName (string): A name that uniquely identifies the cookie. The name is required and is used to retrieve the cookie in subsequent requests.
• value (string): The value to be stored in the cookie.
• expiryInMinutes (int, optional): Setting an expiry value cause the cookie to be deleted after the specified number of minutes has elapsed. If you do not specify an expiry time, the cookie will be available until it is overwritten, deleted by the user, or the session expires.

{{ 'FavouriteCookie' | WriteCookie:'choc-chip','5' }}
{{ 'FavouriteColor' | WriteCookie:'green' }}

(none)
<p>
This filter modifies the response sent back to the user by including the specified cookie with an expiration time of 5 minutes.
It does not produce any output.
</p>

This filter has optional input parameters:

1. Size (optional): Specifies the width and height of the image in pixels. If not specified it will default to 395 which is good for a 300 dpi Zebra printer but possibly not for a 203 dpi printer. If using a 203 dpi printer try using a number like 150 or so.
2. Brightness (optional) v5.0: Specifies the brightness adjustment (0 to 1.99 fully white).
3. Contrast (optional) v5.0: Specifies the contrast adjustment (0 to 1.99).
4. Filename (optional): The filename that should be used when sending photo contents to the printer.
5. Rotate Degree (optional): The degree of rotation to apply to the photo. Valid values are 90, 180 or 270. v8.4

This filter will insert the image data into a property called "LOGO.PNG". You will still need to write additional ZPL code to specify the placement of the LOGO.PNG property onto the label.

"Person": {
    ...
}

^FD{{ Person | ZebraPhoto:'397',1.0,1.0,'LOGO',90 }}^FS

^FD^FS~DYR:LOGO,P,P,12246,,89504E470A50C317A8C32490DF5A6...90A9CD5B34A9B0FA2A842E095F5CE082^FD^FS