Search

Function List

Hero Platform_ provides many functions to implement your business logic. You can also build your own functions or incorporate AI models as functions.

List by Catagory

Aggregation

Aggregation functions perform a calculation on a set of values, and returns a single value.

Function name	Description
Aggregation Function	Creates groups based on unique values in a field and then can perform a selected operations on the values in the group rolls. Across global input data.
Repartition	Creates partitions for input data up to the Flow configuration settings set for max parallelism.
Unflatten	Creates groups based on unique values in a field and then can perform a selected operations on the values in the group rolls. Across partitioned input data.

Creators

The Creator type functions add new result fields without target input.

Function name	Description
ConstantBoolean	Returns a constant Boolean value.
ConstantLong	Returns a constant float value.
ConstantString	Returns a constant string value.
Multiple Constants	Returns one or more constant values.
Now	Returns the current date and time.
Rand	Returns a random number between zero and one.
RandGuassian	Generates a normal distribution of random values with a mean of zero and a standard deviation of one.
Today	Returns the current day (time at midnight)

Filter

The filter type functions test records where the conditions are met pass them on within the Flow

Function name	Description
And	Tests if all conditions are true between one or more arguments.
Contains	Tests to check if and only if this string contains the specified sequence of char values.
DoesNotContain	Tests to check if and only if this string does NOT contain the specified sequence of char values.
DoesNotEndWith	Tests if the string does NOT end with the specified suffix.
EndsWith	Tests if the string ends with the specified suffix.
Equals	Tests if two values of the same type are equal.
HasError	Tests if a specified field has an error.
HasNoError	Tests if a specified field's values do not have an error. Records that meet the conditions are passed on within the Flow.
If	If first argument is true, the result is the 2nd argument. If the first argument column is not true, the result is the 3rd argument column.
IsAfter	Tests if the argument's field dates come after another argument's field dates or a constant date.
IsBefore	Tests if the argument's field dates come before another argument's field dates or a constant date.
IsBlank	Tests if a field is white space, empty, or null.
IsEmpty	Tests if the argument's fields are empty
IsEven	Tests if the argument's fields are an even number. Fields return a true (Boolean) value for even numbers found.
IsFalse	Tests if the argument's fields are a false (Boolean) value.
IsGreaterThan	Tests if the argument's fields are greater than a constant value.
IsGreaterThanOrEqual	Tests if the argument's fields are greater than or equal to a constant value.
IsLessThan	Tests if the argument's fields are less than to a constant value.
IsLessThanOrEqual	Tests if the argument's fields are less than or equal to a constant value.
IsNotBlank	Tests if the argument's fields are not white space, empty, or null
IsNotEmpty	Tests if the argument's fields are not empty.
IsNotNull	Tests if the argument's fields are not null values.
IsNull	Tests if the argument's fields are null values.
IsOdd	Tests if the argument's fields are an odd number.
IsTrue	Tests if the argument's fields are a true (Boolean) value.
NotEquals	Test if two values of the same type are not equal.
Or	Tests if any conditions are true between one or more arguments.

Flatten

Flatten type functions identify arguments with multiple elements and separate them.

Function name	Description
BinaryDataBytesToLongFlatten	Flattens a byte array of binary data and returns each element as an individual record.
Flatten List	Flattens a list, returning each element as an individual record.
Parser	Parser is used for filling the field mapping table with detected data or from a predefined list.

Formulas

Formulas are ready made functions used to carryout specific calculations on your data.

Function name	Description
And	Returns results where all conditions are true between one or more arguments.
AsBoolean	Converts a character sequence to a Boolean.
AsDate	Converts a character sequence to a date using specified date format.
AsDouble	Converts a character sequence to a double value.
AsLong	Converts a character sequence to a float value.
AuthorityUrlExtractor	Returns the authority sections of a URL as string.
Average	Returns the average element of the given collection. All elements in the collection must extend the Number class.
Base64Encoder	Encodes a binary or string using Base64 encoding.
Base64ToBinaryDecoder	Decodes a string or binary value to a binary value using Base64 decoding and returns the value in a new column.
Base64ToStringDecoder	Decodes a string value to a string value using Base64 decoding and returns the value in a new column.
Capitalize	Capitalizes string changing the first letter to title case. No other letters are changed.
Ceiling	Returns the smallest (closest to negative infinity) double value that is greater than or equal to the argument and is equal to a mathematical integer.
Compare	Compares two strings lexicographically and returns an integer -1, 0, or 1 depending on the results.
Concat	Concatenates two or more items to one string item using a joiner string.
ConcatListItems	Concatenates the items in a list using a joiner.
Contains	Checks if the argument's string value contain the specified sequence of characters.
Convert SVG to Image	Returns a PNG (portable graphics format) value in string format from an SVG (vector graphic) value in string format in a new column.
Cosmos DB Data Manipulation	The function performs document manipulation against a Cosmos database.
Divide	Returns the quotient of numeric values.
DoesNotContain	Checks if the string argument's values do not contain the specified sequence of characters.
DoesNotEndWith	Checks if the argument's string value ends with the specified suffix.
Download By URL	Downloads specified content from a URL string value and returns the content in a new column.
EmailMainContent	Removes quotation mark characters from a string value and returns as a string value in a new column.
EML to PDF	Returns the EML file (binary) as a PDF file (binary).
EndsWith	Checks if the argument's string value ends with the specified suffix.
Equals	Checks if two values of the same type are equal.
ErrorMessage	Converts error messages found in a field into strings.
Even	Rounds a number up to the nearest even integer.
ExcelToText	Creates a list containing text representing the rows, columns, and cells of an Excel file (binary data type).
FilenameUrlExtractor	Returns the file name of the URL specified as string value in a new column.
Floor	Returns the largest (closest to positive infinity) double value that is less than or equal to the argument and is equal to a mathematical integer.
FormatBoolean	Converts Boolean values into specified character sequences and returns the value in a new column.
FormatDate	Returns a character sequence for an input Date based on the provide date/time format.
FormatNumber	Converts a number to a character sequence using the specified format and returns the value in a new column.
GetTimeDifference	Returns the time difference between two dates as a tuple which has the following fields: YEARS, DAYS, MONTHS. Additionally Hours and Seconds fields represent total time/units.
HasError	Checks if the specified field's values contain an error and returns a Boolean response.
HasNoError	Checks if the specified field's values do not contain an error and returns a Boolean in response.
HostUrlExtractor	Returns the host name of the URL provided as string. The value is returned in new column.
Hour	Returns the hour from from the specified date.
If	If first argument is true the result is the second argument; otherwise, the result is the third argument.
Image to PDF	Generates a PDF from a JPG, JPEG, TIF, TIFF, GIF, BMP, or PNG file.
IpToNumber	Returns an integer representing an IPv4 address regardless of whether the supplied argument is an IPv4 address or not.
IsAfter	Checks if the argument's field dates come after another argument's field dates or a constant date.
IsBefore	Checks if the argument's field dates come before another argument's field dates or a constant date.
isBlank	Checks if a CharSequence is whitespace, empty (""), or null.
IsEmpty	Checks if an argument's list construct has no elements.
IsEven	Checks the argument's fields for even number values.
IsGreaterThan	Checks if an argument's value is greater than the specified number.
IsGreaterThanOrEqual	Checks if an argument's value is greater than or equal to a specified number.
IsLessThan	Checks if an argument's value is less than the specified number.
IsLessThanOrEqual	Checks if an argument's value is less than or equal to a specified number.
IsNotBlank	Checks if a CharSequence is not whitespace, empty (""), or null.
IsNotEmpty	Checks if an argument's list construct has elements.
IsNotNull	Checks if the argument's value is not null.
IsNull	Checks if the argument's value is null.
IsOdd	Checks the argument's fields for odd number values.
Knowledge Graph	Compare any input string against a Knowledge Graph field.
Left	Returns a given number of characters from the left side of a supplied text string.
List	Returns list of values.
ListElement	Returns an element from a list construct selected by position.
Lower	Converts all of the characters in input string to lower case.
MSToDate	Converts an integer representing a timestamp in milliseconds from January 1, 1970, 00:00:00 GMT to its corresponding date.
Matches	Return true if a string matches a regular expression.
Merge PDFs	Merges binary and binary(list) data with PDF content resulting in one PDF file that keeps the order of input fields.
MicrosoftGraphDeleteEmail	Deletes email using a Microsoft Graph connection.
MicrosoftGraphMarkEmailAsRead	Marks email as read using a Microsoft Graph connection.
MicrosoftGraphMoveEmailToFolder	Moves email to another folder using a Microsoft Graph connection.
Midnight	Returns the given date with a time of midnight (12:00:00 am).
Millisecond	Truncates a date to only display the milliseconds associate with the date.
Minimum	Returns minimum of arguments.
Minus	Returns the difference of numeric values.
Minute	Returns the minute from from the specified argument's date value.
Mod	Returns the modulo result of dividing two numeric values.
Month	Returns only the month of a date represented by a serial number.
Move File	Retrieve files from a file system folder via an SSH Connection and moves them to a new folder.
Mround	Returns a number rounded to the desired multiple
Multiply	Multiplies the arguments.
Negate	Returns the logical compliment of a numeric value.
Ngram	Returns sub sequences of N characters of a given text.
Not	Returns the opposite Boolean value.
NotEquals	Checks if two values of the same type are not equal.
NumberToIp	Converts number to internet standard dot notation.
Odd	Rounds a number up to the nearest odd integer.
Or	Returns true if any argument is true.
ParamUrlExtractor	Gets a value addressed by a param of the URL provided as string.
ParamsUrlExtractor	Gets the values addressed by a param of the URL provided as list.
PathUrlExtractor	Extracts the path part of the URL provided as string.
PDF Extract Image	Extracts all images out of PDF files.
PDF Extract Text	Extracts embedded text from a PDF document.
PDF Fill Template	Fills the PDF template and saves it as a binary.
PDF To Image	Converts PDF pages to an image.
PDF With Xfa To Text	Extracts embedded text from a PDF with an XFA form architecture.
Plus	Adds its arguments (or concats string values).
Power	Returns the result of a number raised to a power.
Proper	Capitalizes the first letter in each word of a text value.
RandBetween	Returns a random number between the numbers that you specify.
RegExtract	Extracts text from a field that matches the pattern of the regular expression entered.
ReplaceAll	Replaces each sub-string of this string that matches the given regular expression with the given replacement.
ReplaceFirst	Replaces the first substring of a string that matches the given regular expression with the given replacement.
ReplaceWithArgument	Replaces specified text from base string with the input argument.
Right	Returns the rightmost characters from a text value.
Round	Rounds a number to a specified number of digits.
RoundDouble	Rounds a double number to the nearest long value.
RoundDown	Rounds a number down, toward zero.
RoundTime	Rounds down a number to the specified number of decimal digits.
RoundUp	Rounds a number up, away from zero.
Second	Returns the second from from the specified argument's date value.
Shift Time Zone	Converts a date from given timezone to destination timezone.
Size	Returns the size (number of elements) of a list.
SplitExtract	Splits an input string based on an argument and returns the token based on the token number argument specified.
SplitPDF	Splits a multi-page PDF into a list of PDFs consisting of all of the individual pages of the original PDF.
Split PDF At Pages	Returns a list of PDF documents separated by pages as configured. (list[binary])
SQL Data Manipulation	Performs data manipulation in databases with INSERT, UPDATE and DELETE commands.
StringToBinaryData	Converts a string to binary data.
TokenizeList	Returns a list of strings based on a regular expression.
Trim	Removes spaces from text.
Tuple to field	Takes elements from a tuple value and use them downstream in the Flow as single values.
Upper	Converts text to uppercase characters.
UrlDecode	Returns a decoded a URL that was encoded with the UrlEncode function.
UrlEncode	Returns a string in which all non-alphanumeric characters except -_. have been replaced with a percent (%) sign followed by two hex digits and spaces encoded as plus (+) signs.
Weekday	Returns an integer between (1-7) corresponding to the day of the week of the date.
Year	Returns the year corresponding to a date. The year is returned as an integer, ranging from 1900-9999.

Lookup

TheLookup function type is used to retrieve data based off a specified column key.

Function name	Description
Fetch Salesforce Content	Retrieves binary data of a ContentDocument in Salesforce and returns the value in a new column.
File Lookup	Retrieves queried data from a file system Connection and returns the results as binary data in a new column.
MongoDB Aggregation Lookup	Retrieves queried aggregated data from a MongoDB Connection based on a key column from your Input in your Flow.
MongoDB Find Lookup	Retrieves queried data from a MongoDB Connection based on a key column from your Input in your Flow.
Rest DELETE	Executes Rest DELETE request on a REST connection in Hero Platform_.
Rest GET	Executes Rest GET request on a REST connection in Hero Platform_.
Rest HEAD	Executes Rest HEAD request on a REST connection in Hero Platform_.
Rest POST	Executes Rest POST request on a REST connection in Hero Platform_.
Rest PUT	Executes Rest PUT request on a REST connection in Hero Platform_.
Salesforce Lookup	Retrieves queried data from a Salesforce Connection based on a key column from your Input in your Flow.
SQL Lookup	Retrieves queried data from a SQL Connection based on a key column from your Input in your Flow.
Swagger Lookup	Returns result of executing Rest request on a connection to Swagger.

Documents

The Documents function type lists functions created in the Document Studio.

Function name	Description
Multiple OCR functions	Adds multiple OCR templates to a Flow

Procedure

Procedure functions miscellaneous tasks within a Flow.

Function name	Description
ErrorHandler (Beta)	Either fails (stops) a Flow with errors or can filter out unnecessary records that contain errors. Flows that filter out errored records are added to a log that can be accessed by users.
Propagation Delay	Adds a delay in processing data.
WriteLogs	The function writes a log message to the common log file and Flow execution log file that can be downloaded on the Run Details page.

General Function Information

Nested Tuples

If the Input in a Flow has a tuple input field type, functions have the ability to use a value from that tuple’s nested tuple values.

Variable syntax:

${<nested field>.<field name>}

Learn more about resolving nested variables on Variable Resolution.