Formula Tap Functions

Back to Index

Overview

Along with the math functions, time functions and list functions, formulas also include a handful of Tap-specific functions. These Tap functions can retrieve the value of beans, find instances of an event and even reference the value of another formula.

To understand why you might want to use these functions it might be a good idea to first take a look a look at what beans are.

Bean and Event Parameters

A typical bean function looks something like this (in context):

$$()(bean coconuts "/farm" - (time "2022-07-01") (time "2022-07-31"))

It's important to note that all of the parameters are optional. To skip any parameter use a -. The tag parameter in the example above is skipped.

To include a parameter whose name is itself quoted i.e. #"Quoted Tag" use a \ character to escape the nested quotes i.e. "#\"Quoted Tag\""

A couple notes on the Tags parameter:

  • To specify a list of Tags separate the individual Tags with spaces i.e. "very special stuff"
  • The # character is optional "#very #special #stuff" is equivalent to the above.

Reference

BEAN

(BEAN name folder tags start-date end-date)

Returns the net value of the specified Bean name filtered to the folder, tags and date parameters.

All parameters are optional.

BEAN+

(BEAN+ name folder tags start-date end-date)

Returns the incoming value of the specified Bean name filtered to the folder, tags and date parameters.

All parameters are optional.

BEAN-

(BEAN- name folder tags start-date end-date)

Returns the outgoing value of the specified Bean name filtered to the folder, tags and date parameters.

All parameters are optional.

$

($ name)

Include the computed value of a Formula with the specified name.