Rules Engine

This section contains information about Orderful's Rules Engine.

To start, you should read about how to Use the Rules Engine.

Available Rules

These are the available Rules in Orderful. More information about each Rule can be found in the Orderful UI:

Go to your Transactions page.
Select a Transaction, which will bring you the Transaction Details page.
Near the top, select the Rules Editor tab.
Select the property or element that you would like to create a Rule for, or search for it using the search field at the top of the payload. Once you have selected it a prompt will appear on the right that says "A relationship rule does not exist". If you click the link in that prompt, it will open the "Add a rule" pane.

Rule Name	Description
ADD	Returns the sum of all addends.
ADDSEGMENT	Add a new instance of a segment to a segment loop. Note: If you are trading JSON, we suggest you use our new Add data feature.
ADDTIME	Returns a new date falling after the input date by the specified amount of time.
AND	Checks whether every supplied test value is equal to 'true'.
CONCATENATE	Returns a joined string from all provided strings.
CONTAINS	Checks whether a text string contains a specific character or substring.
COUNT	The reference path to the loop or segment in the current transaction to count.
CREATEDAT	Returns the created datetime of the transaction, in format of `YYYY-MM-DDThh:mm:ssZ`
DELETE	Deletes the specified element, segment, or loop.
DIVIDE	Returns the value of the dividend divided by all divisors.
EQUALS	Checks whether all values are equivalent.
EXISTS	Verifies whether the specified loop, segment or element exists within the current transaction.
FIXED	Rounds a number to a specified number of decimal places and converts it into text.
FORMATDATE	Converts a text representation of a date/time into a new format.
GREATER	Checks whether one number is greater than another.
IF	Conditionally executes logic depending on whether a supplied test value is equal to `true` or `false`.
IFERROR	Returns `value` if `function` returns an error otherwise returns the output of `function`.
INCLUDES	Returns boolean indicating if the element was found in the array.
INDEX	Retrieves an element from an array by its index.
KEYVALUE	Creates a key value pair that consists of a field name string and a value string.
LENGTH	Returns the number of characters in a text string.
LESS	Checks whether one number is less than another.
LOOKUP	Returns the value of an element contained in a segment which matches the provided lookup value.
LOOKUPV2	Returns the value of the result object that is contained in the lookup scope where the lookup element matches the lookup value.
LOOKUPDATA	Returns the value of the lookup data entry associated with the provided lookup key.
LOWERCASE	Converts all characters in a text string to lower case.
MULTIPLY	Returns the product of all factors.
NOT	Inverts a true/false value.
OBJECT	Returns a JSON object containing the specified key value pairs.
OR	Checks whether at least one supplied test value is equal to 'true'.
REPLACE	Replaces a part or parts of a text string with a different text string.
RIGHT	Extract text from the right of a string.
ROUND	Rounds a number to a specified number of decimal places according to standard rules.
SET	Sets an element value explicitly to a provided string or referenced value.
SMART	Use smart EDI functions to help transform your data in one easy step.
SPLIT	Splits a text string into an array of strings.
SUBSTRING	Extracts a portion of a text string.
SUBTRACT	Returns the value of the minuend subtracted by all subtrahends.
SUBTRACTTIME	Returns a new date falling before the input date by the specified amount of time.
SUM	Returns the sum of all fields in the transaction which match the supplied reference path.
TIMEZONENUMERIC	Use city, state and country to determine timezone offset for the current time.
TRIM	Removes leading and trailing whitespace from text.
TURNAROUND	Looks up the `referencePath` of another document based on `transactionType` and `businessNumber`.
UPPERCASE	Converts all characters in a text string to upper case.