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>

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 integre) 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.
• 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.
• 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>
                
            </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>
        </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>
        </p>
    </li>
</ul>

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",
    "AnniversaryDate": '',
}

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

Base64Format: /2wBDAQQEBAUFBQoGBgoWDwwPFhYW...
Base64Format: /9j/4AAQSkZJRgABAQEAY....

There are several overrides you can pass:

{{ 'url' | CreateShortLink:token,siteId,overwrite,randomLength }}

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.

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

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

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

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

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>

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 (v16.1)

"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>
//- Use the IdHash to retrieve a Person entity.
{% assign personFromHash = idHash | FromIdHash | PersonById %}
Hello {{ personFromHash.NickName }}!

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

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">

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.

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

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 the 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>

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.

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.

"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 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.

• 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 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>