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:

  1. Go to your Transactions page.
  2. Select a Transaction, which will bring you the Transaction Details page.
  3. Near the top, select the Rules Editor tab.
  4. 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 NameDescription
ADDReturns the sum of all addends.
ADDSEGMENTAdd a new instance of a segment to a segment loop.
ADDTIMEReturns a new date falling after the input date by the specified amount of time.
ANDChecks whether every supplied test value is equal to 'true'.
CONCATENATEReturns a joined string from all provided strings.
CONTAINSChecks whether a text string contains a specific character or substring.
COUNTThe reference path to the loop or segment in the current transaction to count.
CREATEDATReturns the created datetime of the transaction, in format of YYYY-MM-DDThh:mm:ssZ
DIVIDEReturns the value of the dividend divided by all divisors.
EQUALSChecks whether all values are equivalent.
EXISTSVerifies whether the specified loop, segment or element exists within the current transaction.
FIXEDRounds a number to a specified number of decimal places and converts it into text.
FORMATDATEConverts a text representation of a date/time into a new format.
GREATERChecks whether one number is greater than another.
IFConditionally executes logic depending on whether a supplied test value is equal to true or false.
IFERRORReturns value if function returns an error otherwise returns the output of function.
INCLUDESReturns boolean indicating if the element was found in the array.
INDEXRetrieves an element from an array by its index.
KEYVALUECreates a key value pair that consists of a field name string and a value string.
LENGTHReturns the number of characters in a text string.
LESSChecks whether one number is less than another.
LOOKUPReturns the value of an element contained in a segment which matches the provided lookup value.
LOOKUPDATAReturns the value of the lookup data entry associated with the provided lookup key.
LOWERCASEConverts all characters in a text string to lower case.
MULTIPLYReturns the product of all factors.
NOTInverts a true/false value.
OBJECTReturns a JSON object containing the specified key value pairs.
ORChecks whether at least one supplied test value is equal to 'true'.
REPLACEReplaces a part or parts of a text string with a different text string.
RIGHTExtract text from the right of a string.
ROUNDRounds a number to a specified number of decimal places according to standard rules.
SETSets an element value explicitly to a provided string or referenced value.
SMARTUse smart EDI functions to help transform your data in one easy step.
SPLITSplits a text string into an array of strings.
SUBSTRINGExtracts a portion of a text string.
SUBTRACTReturns the value of the minuend subtracted by all subtrahends.
SUBTRACTTIMEReturns a new date falling before the input date by the specified amount of time.
SUMReturns the sum of all fields in the transaction which match the supplied reference path.
TIMEZONENUMERICUse city, state and country to determine timezone offset for the current time.
TRIMRemoves leading and trailing whitespace from text.
TURNAROUNDLooks up the referencePath of another document based on transactionType and businessNumber.
UPPERCASEConverts all characters in a text string to upper case.