AgileApps Support Wiki Pre Release

Difference between revisions of "Formula Functions"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Β 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
Formula functions are logical and programmatic functions, used with [[fields]] and [[operators]] to build [[Formula Expressions]] in any of the following platform elements:
==About the Formula Functions==
:* [[Formula Fields]]
Formula functions are logical and programmatic functions that can be included anywhere that aΒ  [[Formula Expression]] is defined.
:*[[Validations]]
:*Formulas in [[Computed Fields]]
:*Policy triggering criteria in Action-Based [[Data Policies]]
:*[[Data_Policy#Add_Actions_to_a_Data_Policy|Update Record Action in Data Policies]].


The reference information for each Formula Function includes:
== Conventions ==
:* Format (syntax) of the Function
Β 
:* Argument(s)
The following conventions are used in these functions:
:* Description(s)
Β 
:* Return Value
:{| border="1" cellpadding="5" cellspacing="0"
:* Examples
!Element
!Description
|-
|'[[string]]'
|Strings must be enclosed with single quotes
|-
|'[[dString]]'
|Date strings must be enclosed with single quotes
|-
|int||An integer,for example, a number representing the number of days (or months or years)
|-
|[[value]]||An argument in date- and date/time-related Formula Functions, which defines a unit of time
|-
|[ ,optional]
|Optional values are shown in brackets, as [ ,option1, option2]
|}


== Date Functions ==
== Date Functions ==
Line 17: Line 28:
See [[Date]] for details about these Day, Date and Time-related formula functions:
See [[Date]] for details about these Day, Date and Time-related formula functions:


{| border="0" cellpadding="5" cellspacing="0" width="50%"
:{| border="0" cellpadding="5" cellspacing="0" width="50%"
|-valign="top"
|-valign="top"
|
|
Line 65: Line 76:
See [[Logical]] for details about functions resulting in TRUE/FALSE (YES/NO, 1/0):
See [[Logical]] for details about functions resulting in TRUE/FALSE (YES/NO, 1/0):


{| border="0" cellpadding="5" cellspacing="0" width="50%"
:{| border="0" cellpadding="5" cellspacing="0" width="50%"
|-valign="top"
|-valign="top"
|
|
[[AND]]<br>
[[AND]]<br>
Β 
[[OR]]
|
[[IF]]<br>
[[IF]]<br>
Β 
[[NOT]]
|
[[ISCHANGED]]<br>
[[ISCHANGED]]<br>
|
[[ISNEW]]<br>
[[ISNEW]]
Β 
[[ISNULL]]<br>
[[ISNULL]]<br>
|
[[ISBLANK]]
[[NOT]]<br>
Β 
[[OR]]<br>


|}
|}
Line 88: Line 96:
See [[Math]] for details about mathematical functions:
See [[Math]] for details about mathematical functions:


{| border="0" cellpadding="5" cellspacing="0" width="50%"
:{| border="0" cellpadding="5" cellspacing="0" width="50%"
|-valign="top"
|-valign="top"
|
|
Line 122: Line 130:
See [[Text]] for details about text-related formula functions:
See [[Text]] for details about text-related formula functions:


{| border="0" cellpadding="5" cellspacing="0" width="50%"
:{| border="0" cellpadding="5" cellspacing="0" width="50%"
|-valign="top"
|-valign="top"
|
|
Line 151: Line 159:
[[VALUE]]<br>
[[VALUE]]<br>
|}
|}
<!--
Β 
== Aggregate Functions ==
== Aggregate Functions ==
{{:Aggregate Functions}}
The [[Aggregate Functions]] are not available in every context, because of their potential impact on performance. They let you select a collection of records in an arbitrary object and perform a summary calculation on those records.


-->
{| border="0" cellpadding="5" cellspacing="0" width="50%"
==Uncategorized Functions==
|-valign="top"
| [[Aggregate Functions#MAX|MAXIMUM]] <br> [[Aggregate Functions#MIN|MINIMUM]]
| [[Aggregate Functions#SUM|SUM]]Β  Β  <br> [[Aggregate Functions#AVG|AVG]]
| [[Aggregate Functions#COUNT|COUNT]]
|}


{| border="0" cellpadding="5" cellspacing="0" width="50%"
==Miscellaneous Functions==
Β 
:{| border="0" cellpadding="5" cellspacing="0" width="50%"
|-valign="top"
|-valign="top"
|
|
Line 164: Line 178:
|
|
[[PRIORVALUE]]
[[PRIORVALUE]]
|}
== Conventions ==
The following conventions are used in this document:
{| border="1" cellpadding="5" cellspacing="0"
!Element
!Description
|-
|[[string]]
|Strings must be enclosed with single quotes
|-
|[[dString]]
|Date strings must be enclosed with single quotes
|-
|int||An integer,for example, a number representing the number of days (or months or years)
|-
|[[value]]||An argument in date- and date/time-related Formula Functions, which defines a unit of time
|-
|[&nbsp;,optional]
|Optional values are shown in brackets, as [ ,option1, option2]
|}
|}

Latest revision as of 11:49, 7 May 2018

About the Formula Functions

Formula functions are logical and programmatic functions that can be included anywhere that a Formula Expression is defined.

Conventions

The following conventions are used in these functions:

Element Description
'string' Strings must be enclosed with single quotes
'dString' Date strings must be enclosed with single quotes
int An integer,for example, a number representing the number of days (or months or years)
value An argument in date- and date/time-related Formula Functions, which defines a unit of time
[ ,optional] Optional values are shown in brackets, as [ ,option1, option2]

Date Functions

See Date for details about these Day, Date and Time-related formula functions:

DATE

DATEADD

DATECOMP

DATEPART

DATESUB

DATEVALUE

DAY

HOUR

MINUTE

MONTH

NOW

NULLDATE

NULLTIME

SECOND

TIME

TIMEPART

TIMEVALUE

TODAY

WEEKDAY

YEAR

Logical Functions

See Logical for details about functions resulting in TRUE/FALSE (YES/NO, 1/0):

AND
OR

IF
NOT

ISCHANGED
ISNEW
ISNULL
ISBLANK

Math Functions

See Math for details about mathematical functions:

ABS

CEIL

EXP

FLOOR

LN

LOG

MAX

MIN

MOD

POW

ROUND

SQRT

Text Functions

See Text for details about text-related formula functions:

CONCAT

CONTAINS

ENDSWITH

FIND

LEN

LOWER

REPLACE

STARTSWITH

SUBSTRING

TEXT

TRIM

UPPER

VALUE

Aggregate Functions

The Aggregate Functions are not available in every context, because of their potential impact on performance. They let you select a collection of records in an arbitrary object and perform a summary calculation on those records.

MAXIMUM
MINIMUM
SUM
AVG
COUNT

Miscellaneous Functions

LOOKUP

PRIORVALUE