View this page in the latest version of Appian.

a!customFieldSum() Function

Function

a!customFieldSum( value )

Used to create a real-time custom record field, this function returns a sum of values. You can calculate the sum of record fields, related record fields, or literal values of type Number (Integer) or Number (Decimal).

Parameters

Keyword	Type	Description
`value`	Any Type	An array containing any combination of record fields, related record fields, or literal values to be summed. You must have at least two values in the array.

Usage considerations

Where to use this function

The a!customFieldSum() function can only be used to create a custom record field that evaluates in real time. This means you can reference related record fields, constants, and other supported functions in your calculations.

To create a custom record field that evaluates in real-time:

In your record type, go to Data Model.
Click NEW CUSTOM RECORD FIELD.
From SELECT A TEMPLATE, choose Write Your Own Expression.
Choose Real-time evaluation.
Click NEXT.
Enter an expression using any Custom Field function.

Note: Custom record fields that evaluate in real-time must use at least one Custom Field function.
Click NEXT.
Enter a Name for your custom record field.
Click CREATE.
Click SAVE CHANGES. The new custom record field appears in your list of fields.

Use with other Custom Field functions

You can use the a!customFieldSum() function in conjunction with other Custom Field functions, like a!customFieldSubtract(), a!customFieldDivide(), or a!customFieldMultiply() to create the calculations you need.

See the Real-time evaluation recipes for an example.

Example

Let's say you want calculate each employee's total salary, which includes their base salary, restricted stock units (RSU), and an annual bonus that is only applied if they qualify.

On the Employee record type, you could create a custom record field that evaluates in real-time so you can add the baseSalary field, the related record field rsuDollarAmount, and the related record field annualBonus. However, the annualBonus field will only be included in the calculation when the constant cons!DISCRETIONARY_BONUS is true.

a!customFieldSum(
  value: {
     recordType!Employee.fields.baseSalary,
     recordType!Employee.relationships.employeeLevel.fields.rsuDollarAmount,
     /* If the constant is true, then add a discretionary bonus */
     if(cons!DISCRETIONARY_BONUS, 
        recordType!Employee.relationships.employeeLevel.fields.annualBonus,
        0
     )
   }
)
Copy

Supported functions

You can use any of the following supported functions in the value parameter of a!customFieldSum(). However, you must reference at least one record field, related record field, or another Custom Field function in the value parameter.

Note: When you use a supported function in a Custom Field function, you can only pass static values or constants containing static values into the supported function; you cannot pass record field references.

Search:

Function	Description
Array
a!flatten()	Converts an array that contains other arrays into an array of single items.
a!update()	Inserts new values or replaces existing values at the specified index or field name and returns the resulting updated data.
append()	Appends a value or values to the given array, and returns the resulting array.
index()	Returns the data[index] if it is valid or else returns the default value.
insert()	Inserts a value into the given array and returns the resulting array.
joinarray()	Concatenates the elements of an array together into one string and inserts a string separator between each element.
ldrop()	Drops a given number of values from the left side of an array and returns the resulting array.
length()	This function returns the number of elements in an array.
rdrop()	Drops a given number of values from the right side of an array, and returns the resulting array.
remove()	Removes the value at a given index from an array, and returns the resulting array.
reverse()	Returns an array in reverse order.
updatearray()	Inserts new values or modifies existing values at the specified index of a given array, and returns the resulting array.
where()	Returns the indexes where the values in the input array are true.
wherecontains()	Receives one or more values and returns an array of indexes that indicate the position of the values within the array.
contains()	Checks whether an array contains the value.
difference()	Returns the values in array1 and not in array2.
intersection()	Returns only those elements that appear in all of the given arrays.
symmetricdifference()	Returns the values from two integer arrays that are not in both arrays.
union()	Returns all unique elements from the given arrays.
Base Conversion
bin2dec()	Converts a Binary number as text to a Decimal number.
bin2hex()	Converts a Binary number as text to a Hex number as text.
bin2oct()	Converts a Binary number as text to an Octal number as text.
dec2bin()	Converts a Decimal number to a Binary number as text.
dec2hex()	Converts a Decimal number to a Hex number as text.
dec2oct()	Converts a Decimal number to an Octal number as text.
hex2bin()	Converts a Hex number as text to a Binary number as text.
hex2dec()	Converts a Hex number as text to a Decimal number.
hex2oct()	Converts a Hex number as text to an Octal number as text.
oct2bin()	Converts an Octal number as text to a Binary number as text.
oct2dec()	Converts an Octal number as text to a Decimal number.
oct2hex()	Converts an Octal number as text to a Hex number as text.
Conversion
displayvalue()	Tries to match a value in a given array with a value at the same index in a replacement array and returns either the value at the same index or a default value if the value is not found.
externalize()	Converts the given value to a string representation so that it can be saved externally.
toboolean()	Converts a value to Boolean.
todate()	Converts a value to Date with Timezone.
todatetime()	Converts a value to Date and Time with Timezone.
todecimal()	Converts a value to Decimal (double-precision floating-point number).
toemailaddress()	Converts a value to email address.
tointeger()	Converts a value to Integer.
tointervalds()	Converts a value to Interval (Day to Second).
tostring()	Converts a value to Text.
totime()	Converts a value to Time.
touniformstring()	Converts a value or list to text, preserving the original scalar or array structure.
cast()	Converts a value from its existing type to the specified type.
Date and Time
a!addDateTime()	Adds the specified increments of time to the startDateTime and returns a date and time value. You can select a process calendar to ensure the return value falls within the specified working days and time.
calisworkday()	This returns whether or not the given Date and Time is a work day, according to the calendar defined for the system.
calisworktime()	This returns whether or not the given Date and Time is within working hours, according to the calendars defined for the system.
calworkdays()	This returns the actual number of work days between two Date and Times (both inclusive), according to the calendar defined for the system.
calworkhours()	This returns the actual number of work hours between two given Date and Times (both inclusive), according to the calendar defined for the system.
date()	Converts text into data accepted by the date data type and functions that require date parameters.
datetime()	Converts the given Date and Time into a serial number that holds the Date and Time data type.
datevalue()	Converts a value to a date.
day()	Returns the day of the month from the date specified.
dayofyear()	Returns the day number within the year.
days360()	Returns the number of days between two dates, based on a 360-day calendar.
daysinmonth()	Returns the number of days in the given month in the given year.
edate()	Returns the date that is the number of months before or after the given starting date.
eomonth()	Returns the date for the last day of the month that is the number of months before or after the given starting date.
gmt()	Subtracts a time zone offset from a given Date and Time.
hour()	Returns the hour from the time specified.
intervalds()	Converts the given time components into an equivalent time duration, an interval expressing days to seconds. This value is treated as a duration (Joe ran the marathon in 3 hours and 23 minutes), not a point in time.
isleapyear()	Returns a Boolean value for whether the given year is a leap year.
lastndays()	Returns a Boolean value for whether the given date is within the last given number of days.
local()	This is a Date and Time addition function, adding time zone offset to given Date and Time.
milli()	This function returns the millisecond portion of a timestamp or the decimal number that represents 1 millisecond in days.
minute()	Returns the minute from the time specified.
month()	Returns the month from the specified date.
networkdays()	Returns the number of working days between two specified dates.
now()	Returns the current Date and Time as a serial number.
second()	Returns the seconds from the specified time.
a!subtractDateTime()	Subtracts the specified increments of time from the startDateTime and returns a date and time value. You can select a process calendar to ensure the return value falls within the specified working days and time.
time()	Converts the given time into an equivalent time value.
timevalue()	Converts the given time into an equivalent interval.
timezone()	Returns the default offset in minutes from GMT, which is generally the process initiator's time zone.
timezoneid()	Returns the time zone ID for the current context.
today()	Returns the current day in GMT.
weekday()	Returns the day of the week of the specified date.
weeknum()	Returns the week number within the year for the given date using a given methodology.
workday()	Returns the date the given number of workdays before or after the given date.
year()	Returns the year for the date specified.
yearfrac()	Determine the fraction of the year.
Informational
a!defaultValue()	Returns a default value when the specified value is null or empty. When there are multiple default parameters, each parameter is evaluated in order and the first non-null and non-empty default will be returned. `Null`, `""`, and `{}` are all considered null or empty values.
a!keys()	Returns the keys of the provided map, dictionary, CDT, or record.
a!listType()	Returns the list type number for a given type number.
error()	Raises an error with the given message, used for invalidating execution.This function never returns a value.
infinity()	Represents a constant number that stands for positive infinity or a negative infinity if you negate the value.
isinfinite()	Tests given numbers against positive and negative infinity, returning `true` if the number is infinite, `false` if the number is not infinite.
isnegativeinfinity()	Tests given numbers against negative infinity, returning true if number is negative infinity, false if number is not negative infinity.
a!isNotNullOrEmpty()	Returns `false` if the value is null, an empty string, or an empty list. Otherwise returns `true`.
isnull()	Returns true if value is null, false otherwise.
a!isNullOrEmpty()	Returns `true` if the value is null, an empty string, or an empty list. Otherwise returns `false`.
ispositiveinfinity()	Tests given numbers against positive infinity, returning `true` if the numbers are positive infinity, false if the numbers are not positive infinity.
nan()	Constant number representing Not A Number, generally used for comparison to the result of mathematical operations with invalid inputs. This is equivalent to a decimal (floating point) null, but nan() is provided for more explicit usage in mathematical expressions.
null()	Returns a null value.
runtimetypeof()	Returns the numerical representation of an Appian system data type when used during process execution.
typename()	Returns the type name of a given type number.
typeof()	Returns the type number of a given value.
Logical
and()	Returns `true` if all inputs are `true`; returns `false` if at least one input is false.
choose()	Evaluates the `choice` argument at the given `index` and returns the result.
false()	Returns the Boolean value `false`.
if()	Returns `valueIfTrue` if `condition` returns `true`; returns `valueIfFalse` otherwise.
not()	Converts `true` into `false`, and `false` into `true`.
or()	Returns `true` if any inputs are `true`; returns `false` if all inputs are `false`.
true()	Returns the Boolean value `true`.
Looping
a!forEach()	Evaluates an expression for each item in a list and returns a new array of the results.
all()	Calls a rule or function that returns either true or false for each item in list, asks the question, "Do all items in this list yield true for this rule/function?", and returns true if all items in list evaluates to true.
any()	Calls a rule or function that returns either true or false for each item in list by asking the question, "Do any items in this list yield true for this rule/function?" with the intent to discover if any item(s) yield true.
apply()	Calls a rule or function for each item in a list, and provides any contexts specified.
filter()	Calls a predicate for each item in a list and returns any items for which the returned value is true.
merge()	Takes a variable number of lists and merges them into a single list (or a list of lists) that is the size of the largest list provided.
none()	Calls a rule or function that returns either true or false for each item in list by asking the question, "Do all items in this list yield false for this rule/function?" with the intent to discover if no items will yield true.
reduce()	Calls a rule or function for each item in a list, passing the result of each call to the next one, and returns the value of the last computation.
reject()	Calls a predicate for each item in a list, rejects any items for which the returned value is true, and returns all remaining items.
Mathematical
abs()	Returns the absolute value(s) of the specified number(s).
ceiling()	Rounds the number up to the nearest multiple of the specified significance.
combin()	Calculates the number of unique ways to choose m elements from a pool of n elements.
a!distanceBetween()	Returns the distance between the two locations (in meters) specified by the start and end coordinates. The distance is calculated by tracing a line between the two locations that follows the curvature of the Earth, and measuring the length of the resulting arc.
e()	Returns the value of e.
enumerate()	Returns a list of integer numbers from 0 through n-1.
even()	Rounds positive numbers up to nearest even integer and negative numbers down to the nearest even integer.
exp()	Returns e raised to the specified power.
fact()	The factorial of specified number.
factdouble()	The double factorial of specified number (mathematically n!!).
floor()	Rounds the number down to the nearest multiple of the specified significance.
int()	Rounds the specified number down to the nearest integer.
ln()	Returns the natural logarithm of the specified number, which is the power that e must be raised to in order to equal the specified number.
log()	Returns the logarithm of the number using the specified base, which is the power that base must be raised to, to equal the number.
mod()	Returns the remainder of dividend when divided by the divisor.
mround()	Rounds the number to the specified multiple.
multinomial()	Adds the specified integers and divides the factorial of the sum by the factorial of the individual numbers.
odd()	Rounds positive numbers up to nearest odd integer and negative numbers down to the nearest odd integer.
pi()	Returns the value of pi.
power()	Returns the base number raised to the specified exponent.
product()	Returns the product of the specified numbers.
quotient()	Returns the quotient when numerator is divided by the denominator, and drops the remainder.
rand()	Returns a random number between 0 and 1 based on an even probability distribution, which is seeded by the transaction time.
round()	Rounds off the number to the specified number of digits.
rounddown()	Rounds the number down to the specified digit.
roundup()	Rounds the number up to the specified digit.
sign()	Returns the number divided by its absolute value, which is 1 if the number is positive and -1 if the number is negative.
sqrt()	Returns the square root(s) of the specified number(s).
sqrtpi()	Multiplies the number by pi, then returns the square root of the product.
sum()	Returns the sum of the specified numbers.
sumsq()	Squares each number and then returns the sum of the squares.
trunc()	Truncates a decimal number to the specified number of places after the decimal point.
Scripting
offsetFromGMT()	Returns the offset (in minutes) from GMT of the given date and timezone.
property()	This function extracts a bean's property under a given key name (the `nameOfProperty` parameter).
System
a!jsonPath()	Finds information in a JSON string. JSONPath is used to navigate through elements and attributes in a JSON string.
a!map()	Creates a map of values (Any Type) with each value stored at the corresponding string key. Values stored in maps are not wrapped in variants.
Text
char()	Converts a number into its Unicode character equivalent.
charat()	Returns the character at given index within specified string.
clean()	Returns the specified text, minus any characters not considered printable. Printable characters are the 95 printable ASCII characters plus three special characters: BACKSPACE (0x08), TAB (0x09), and NEWLINE (0x0a).
cleanwith()	Returns the specified text, minus any characters not in the list of valid characters.
code()	Converts the text into Unicode integers.
concat()	Concatenates the specified strings into one string, without a separator.
exact()	Compares two given text strings in a case-sensitive manner, returning true only if they are exactly the same.
extract()	Returns the value (or values, if the text contains multiple delimited values) between the delimiters from the given text.
extractanswers()	Returns an array of strings that respond to the questions provided.
find()	Searches the text for a particular substring, returning the positional index of the first character of the first match.
fixed()	Rounds the specified number off to a certain number of decimals and returns it as text, with optional commas.
a!formatPhoneNumber()	Returns a formatted phone number based on the outputFormat parameter. The countryCode parameter, or any country code provided in the phone number, will verify that the phone number is valid. If the phone number does not match any provided country code, the phone number will be returned as invalid and unformatted.
initials()	Returns only the uppercase characters from within the given text.
insertkey()	Returns the provided text, wrapped with the specified delimiters.
insertkeyval()	Returns the provided key-value pairs, wrapped with the specified delimiters.
insertquestions()	Returns an array of questions with a ==EOQ== at the end, returning a single string that can be parsed with `extractanswers()` function after it has been filled in by a user.
a!isPhoneNumber()	Returns true if the phoneNumber parameter contains a valid phone number, otherwise returns false. A phone number is considered valid if its area code is valid, the length is appropriate based upon the value of the countryCode parameter, and the number after the area code is not all zeroes. This function supports countries and area codes for international numbers.
keyval()	Returns the value(s) associated with the given key(s).
left()	Returns a specified number of characters from the text, starting from the first character.
leftb()	Returns a specified number of bytes from the text, starting from the first byte.
len()	Returns the length in characters of the text.
lenb()	Returns the length in bytes of the text.
like()	Tests whether a string of text is like a given pattern.
lower()	Converts all characters in the text into lowercase (Unicode case folding).
mid()	Returns a substring from the middle of the specified text.
midb()	Returns a substring from the middle of the specified text.
padleft()	Pads text with spaces on the left so that it is a certain length.
padright()	Pads text with spaces on the right so that it is a certain length.
proper()	Converts each character in the text into proper case, meaning it will capitalize the first first letter of every word and convert the rest into lowercase.
replace()	Replaces a piece of the specified text with new text.
replaceb()	Replaces a piece of the specified text with new text.
rept()	Concatenates the text to itself a specified number of times and returns the result.
resource()	Retrieves a string of translated text appropriate for the current user, according to their language preference, by matching a given key with text.
right()	Returns a specified number of characters from the text, starting from the last character.
search()	Searches the text for the given, case insensitive substring. Returns the one-based positional index of the first character of the first match. Returns zero if the substring is not found.
searchb()	Searches the text for a particular substring, returning the positional index of the first byte of the first match.
soundex()	Returns the soundex code, used to render similar sounding names via phonetic similarities into identical four (4) character codes.
split()	Splits text into a list of text elements, delimited by the text specified in the separator.
strip()	Returns the provided text, minus any characters considered printable. Printable characters are the 95 printable ASCII characters plus three special characters: BACKSPACE (0x08), TAB (0x09), and NEWLINE (0x0a).
stripHtml()	Changes the provided HTML string into a plain text string by converting `<br>`, `<p>`, and `<div>` to line breaks, stripping all other tags, and converting escaped characters into their display values.
stripwith()	The function returns the provided text, minus any characters on the list of invalid characters.
substitute()	Substitutes a specific part of a string with another string.
toHtml()	Converts a string in plain text to the HTML equivalent that displays appropriately in an HTML page, by replacing reserved characters with their escaped counterparts.
trim()	Removes all unnecessary spaces from the text.
upper()	Converts all letters in the text into uppercase.
value()	Converts text representing a number into an actual number or datetime.
Trigonometry
acos()	Returns the arccosine(s) of the specified number(s) in radians.
acosh()	Returns the hyperbolic arccosine(s) of the specified number(s) in radians.
asin()	Returns the arcsine(s) of the specified number(s) in radians.
asinh()	Returns the hyperbolic arcsine(s) of the specified number(s) in radians.
atan()	Returns the arctangent(s) of the specified number(s) in radians.
atanh()	Returns the hyperbolic arctangent(s) of the specified number(s) in radians.
cos()	Returns the cosine(s) of the specified number(s).
cosh()	Returns the hyperbolic cosine(s) of the specified number(s).
degrees()	Converts the measure(s) of the specified angle(s) from radians to degrees.
radians()	Converts the measure of the specified angle from degrees to radians.
sin()	Returns the sine(s) of the specified number(s).
sinh()	Returns the hyperbolic sine(s) of the specified number(s).
tan()	Returns the tangent(s) of the specified number(s).
tanh()	Returns the hyperbolic tangent(s) of the specified number(s).

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Incompatible
Sync-Time Custom Record Fields	Incompatible
Real-Time Custom Record Fields	Compatible	Can only be used to create a custom record field that evaluates in real time. It cannot be used anywhere else in your application.
Process Reports	Incompatible	Cannot be used to configure a process report.
Process Events	Incompatible	Cannot be used to configure a process event node, such as a start event or timer event.

Feedback

Was this page helpful?

a!customFieldSum() Function

FunctionCopy link to clipboard

ParametersCopy link to clipboard

Usage considerationsCopy link to clipboard

Where to use this functionCopy link to clipboard

Use with other Custom Field functionsCopy link to clipboard

ExampleCopy link to clipboard

Supported functionsCopy link to clipboard

Feature compatibilityCopy link to clipboard

FeedbackCopy link to clipboard