Helper functions in Salesforce Spiff save time and provide clarity. A helper function is interchangeable with a standard function, but uses simpler syntax so you can create logic more easily.
Required Editions
| Available in: both Salesforce Classic (not available in all orgs) and Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions |
| Available for an additional cost in: Professional Edition with Web Services API Enabled |
A helper function's name describes the output. Search or browse from the Helpers section of the function library when you're working with data filters, payout rules, or calculations in Designer.
The syntax for each helper function is only the function's name. Helper functions don't take any arguments.
| Helper Function | Description |
|---|---|
AllDates |
Returns the full date range for all your data, with no restrictions. |
AllTeams |
Returns all teams. |
AllTeamsDown |
Returns all subteams of the current team. |
AllTeamsUp |
Returns all parent teams of the current team. |
BeginningOfMonth |
Returns the first day of the month based on the current statement period's start date. The return format is YYYY-MM-DD. This helper function requires monthly statement periods. |
BeginningOfPeriod |
Returns the first day of the current statement period. The return format is YYYY-MM-DD. If your statement period cadence isn't monthly, this helper function returns the start date of the current period. |
CurrentMonth |
Returns the month number, 1 to 12, based on the current statement period's start date. For example, if the current statement period is May, this helper function returns 5. |
EndOfMonth |
Returns the last day of the month based on the current statement period's start date. This helper function requires monthly statement periods. |
EndOfPeriod |
Returns the last day of the current statement period. The return format is YYYY-MM-DD. If your statement period cadence isn't monthly, this helper function returns the last date of the current period. |
IsMonth |
Returns true if the current statement period begins in the specified month, and returns false otherwise. For example, if the statement period is January, the IsJanuary helper function returns true. |
Now |
Returns the current date and time. The return format is YYYY-MM-DDT:hour:minute:second:millsecond, plus or minus the hours and minutes away from Coordinated Universal Time (UTC). |
PlanAssignmentEffectiveAsOfDate |
Returns the Effective As Of date for a user's plan assignment. The return format is YYYY-MM-DD. |
PlanAssignmentEffectiveUntilDate |
Returns the Effective Until date for a user's plan assignment. The return format is YYYY-MM-DD. |
PlanAssignmentEndDate |
Returns the date that a rep was unassigned from a plan. The return format is YYYY-MM-DD. |
PlanAssignmentEndDate |
Returns the date that a rep was unassigned from a plan. The return format is YYYY-MM-DD. |
PlanAssignmentStartDate |
Returns the date that a rep was assigned to a plan. The return format is YYYY-MM-DD. |
StatementPeriod |
Returns the current statement period date range, |
Today |
Returns the current date. The return format is YYYY-MM-DD. |