Hive Automate supports a variety of string formulas. Formulas in Hive Automate are whitelisted Ruby methods, and therefore not all Ruby methods are supported. Syntax and functionality for these formulas are generally unchanged. Take note that most formulas will return an error and stop the job if it tries to operate on nulls (expressed as 'nil' in Ruby), except for .present?, .presence and .blank?.

You can refer to the syntax and sample uses of these commands by clicking the links below:

This formula checks the input string and returns true if it is an empty string or if it is null.

Input.blank?

If the input is null or an empty string, the formula will return true. For any other data, it returns false.

Evaluates a boolean value and returns true if the evaluated value is not true.

Input.is_not_true?

Takes in an input and evaluates if it is true or false.

Evaluates a boolean value and returns true if the evaluated value is true.

Input.is_true?

Takes in an input and evaluates if it is true or false.

This formula will check the input and if there is a value present, it will return true. If the input is nil, boolean false, an empty string, or an empty list, the formula will return false.

Input.present?

If the input is null, an empty string or an empty list, the formula will return false. For any other data, it returns true.

Returns the data if it exists, returns nil if it does not.

Input.presence

If the input is null or an empty string, the formula will return nil. For any other data, it returns the original input data.

Checks if the string contains a specific substring. Returns true if it does.

Input.include?(substring)

This formula check is the string contains a specific substring. Returns true if it does, otherwise, returns false. This substring is case sensitive.

This function acts in an opposite manner from .exclude?. It will return true only if the input string contains the stated keyword.

Checks if the string contains a specific substring. Returns false if it does.

Input.exclude?(substring)

This formula check is the string contains a specific substring. Returns false if it does, otherwise, returns true. This substring is case sensitive.

This function acts in an opposite manner from .include?. It will return true only if the input string does NOT contain the stated keyword.

Checks if the string contains a specific pattern. Returns true if it does.

Input.match?(pattern)

This formula check is the string contains a specific pattern. Returns true if it does, otherwise, returns false.

Checks if the string ends with a specific substring. Returns true if it does.

Input.ends_with?(substring)

This formula check is the string ends with a specific substring. Returns true if it does, otherwise, returns false.

Checks if the string starts with a specific substring. Returns true if it does.

Input.starts_with?(substring)

This formula check is the string starts with a specific substring. Returns true if it does, otherwise, returns false.

Replaces special characters in a string. Used when app does not accept non-standard characters.

Input.parameterize

This formula searches for special characters in the string and replaces them with standard characters. Used when app does not accept non-standard characters.

This formula removes the white space at the beginning of the input string.

String.lstrip

This formula removes white spaces from the beginning of a string. If the string doesn't have any white spaces before, the input string will be returned as is.

This formula removes the white space at the end of the input string.

String.rstrip

This formula removes white spaces from the end of a string. If the string doesn't have any white spaces at the end, the input string will be returned as is.

If the string is invalid byte sequence then replace invalid bytes with given replacement character, else returns self.

String.scrub(replacement string)

This formula removes the white space at the beginning and the end of the input string.

String.strip

This formula removes white spaces from both sides of a string. If the string doesn't have any white spaces before or after, the input string will be returned as is.

This formula removes html tags embedded in a string.

String.strip_tags

This formula check for html tags within the input string. It removes any html tags found and returns the string.

Aligns the string to left and pads with whitespace or pattern until string is specified length.

String.ljust(length,character)

Aligns the string to left and pads with whitespace or pattern until string is specified length.

String.rjust(length,character)

Inverts a string, reordering the characters in a backward manner. Case is preserved.

String.reverse

Replace parts of a text string. Returns a new string with the replaced characters.

String.gsub(find,replace)

This formula works like find and replace. It takes two input parameters:

Replaces the first occurrence of the first input value, with the second input value, within the string. This formula is case-sensitive - make sure to type in uppercase or lowercase before comparison if you are concerned about case sensitivity.

String.sub(find,replace)

Returns the number of characters within an input string, including the white-spaces.

String.length

Returns a partial segment of a string.

String.slice(start,end)

The formula returns a partial segment of a string. It takes in 2 parameters - the first parameter is the index that decides which part of the string to start returning from (first letter being 0 and subsequently progressing incrementally, negative numbers will be taken from the last character), the second parameter decides how many characters to return. If only the first parameter is passed in, only 1 character will be returned.

Scan the string for the pattern to retrieve and return an array

String.scan(pattern)

Replaces non-ASCII characters with an ASCII approximation, or if none exists, a replacement character which defaults to '?'.

String.transliterate

Converts the input string into sentence case, i.e. the first character of each sentence is capitalized.

String.capitalize

Converts the input string into title case, i.e. the first character of each word is capitalized.

String.titleize

Convert text to uppercase.

String.upcase

This formula searches for any lowercase character and replace it with the uppercase characters.

Convert text to lowercase.

String.downcase

This formula searches for any uppercase character and replace it with the lowercase characters.

Quicktip: Search strings better with downcase

Search formulas like (gsub or sub) uses case sensitive characters. Use the downcase formula ensure that all characters are in the same case.

Quotes a string, escaping any ' (single quote) characters

String.quote

This formula divides a string around a specified character and returns an array of strings.

String.split(char)

This formula looks for the specified character in the input string. Every time it is found, the input will be split into a new string.

Returns an array of bytes for a given string.

String.bytes

Returns the length of a given string in bytes.

Input.bytesize

Returns a substring of specified bytes instead of length. In some cases, non ASCII characters (Japanese, Chinese e.g.) may use multiple bytes.

Input.byteslice(0,4)

Converts data to a string (text) datatype.

Input.to_s

This formula returns a string representation of the input data.

Turns a number into an ordinal string used to denote the position in an ordered sequence such as 1st, 2nd, 3rd, 4th.

Input.ordinalize

Converts data to a float (number) datatype.

Input.to_f

This formula checks whether the input contains any numbers, if no numbers are found, it returns 0. If the number does not have a decimal point, .0 will be added the number.

Converts data to an integer (whole number) datatype.

Input.to_i

This formula checks whether the input contains any numbers, if no numbers are found, it returns 0. If the number has a decimal point, everything after the decimal will be omitted.

Convert alpha-3 country code or country name to alpha2 country code (first 2 initials).

Input.to_country_alpha2

Convert alpha-2 country code or country name to alpha3 country code (first 3 initials).

Input.to_country_alpha3

Convert alpha-2/3 country code or country name to ISO3166 country name.

Input.to_country_name

Formats integers/numbers to a currency-style.

Input.to_currency

Convert alpha-2/3 country code or country name to ISO4217 currency code

Input.to_currency_code

Convert alpha-3 currency code or alpha-2/3 country code or country name to ISO4217 currency name.

Input.to_currency_name

Convert alpha-3 currency code or alpha-2/3 country code or country name to ISO4217 currency symbol.

Input.to_currency_symbol

Converts string or number to a formatted phone number (user-defined).

Input.to_phone

Convert state name to code.

Input.to_state_code

Convert state code to name.

Input.to_state_name