Rules editor: Difference between revisions

Jump to navigation Jump to search
Line 308: Line 308:
! Function name || Description || Variable data types || Argument data types
! Function name || Description || Variable data types || Argument data types
|-
|-
| AddDays || Returns DateTime argument plus X days  || DateTime  || Arg1: DateTime; Arg2: Number  
| AddDays   || Returns DateTime argument plus X days  || DateTime  || Arg1: DateTime; Arg2: Number  
|-
|-
| AddHours || Returns DateTime argument plus X hours  || DateTime  || Arg1: DateTime; Arg2: Number  
| AddHours   || Returns DateTime argument plus X hours  || DateTime  || Arg1: DateTime; Arg2: Number  
|-
|-
| AddItem || Adds argument to end of list.  || StringList  || Arg1: Number, Boolean, String, DateTime  
| AddItem   || Adds argument to end of list.  || StringList  || Arg1: Number, Boolean, String, DateTime  
|-
|-
| Addition || Returns addition of arguments  || Number  || Arg1: Number;  Arg2: Number  
| Addition   || Returns addition of arguments  || Number  || Arg1: Number;  Arg2: Number  
|-
|-
| AddMinutes || Returns DateTime argument plus X minutes  || DateTime  || Arg1: DateTime; Arg2: Number  
| AddMinutes || Returns DateTime argument plus X minutes  || DateTime  || Arg1: DateTime; Arg2: Number  
|-
|-
| AddMonths  || Returns DateTime argument plus X months  || DateTime  || Arg1: DateTime; Arg2: Number  
| AddMonths  || Returns DateTime argument plus X months  || DateTime  || Arg1: DateTime; Arg2: Number  
|-
|-
| AddParty || Adds a party to an activity  || Activity Entity  ||  User
| AddParty   || Adds a party to an activity  || Activity Entity  ||  User
|-
|-
| AddPrefix  || Adds argument value as prefix to variable  || Text  || Text, Number, Boolean, Date  
| AddPrefix  || Adds argument value as prefix to variable  || Text  || Text, Number, Boolean, Date  
|-
|-
| AddSufix || Adds argument value as suffix to variable  || Text  || Text, Number, Boolean, Date  
| AddSufix   || Adds argument value as suffix to variable  || Text  || Text, Number, Boolean, Date  
|-
|-
| AddWeeks || Returns DateTime argument plus X weeks  || DateTime  || Arg1: DateTime; Arg2: Number  
| AddWeeks   || Returns DateTime argument plus X weeks  || DateTime  || Arg1: DateTime; Arg2: Number  
|-
|-
| AddYear || Returns DateTime argument plus X years  || DateTime  || Arg1: DateTime; Arg2: Number  
| AddYear   || Returns DateTime argument plus X years  || DateTime  || Arg1: DateTime; Arg2: Number  
|-
|-
| Assign || Assigns value to variable  || Text, Number, Boolean, Date  || Variable data type, all types for text variable  
| Assign     || Assigns value to variable  || Text, Number, Boolean, Date  || Variable data type, all types for text variable  
|-
|-
| AssignNew || Creates a new instance of an object in the variable
| AssignNew || Creates a new instance of an object in the variable
|-
|-
| Clear || Assigns null or empty value to variable  || Text, Number, Boolean, Date  ||   
| Clear     || Assigns null or empty value to variable  || Text, Number, Boolean, Date  ||   
|-
|-
| ClearItems || Removes all items from list variable  || StringList  ||  
| ClearItems || Removes all items from list variable  || StringList  ||  
|-
|-
| Concat || Returns concatenated string from two arguments  || Text  || 2 args: Text, Number, Boolean, Date  
| Concat     || Returns concatenated string from two arguments  || Text  || 2 args: Text, Number, Boolean, Date  
|-
|-
| Concat3 || Returns concatenated string from three arguments  || Text  || 3 args: Text, Number, Boolean, Date  
| Concat3   || Returns concatenated string from three arguments  || Text  || 3 args: Text, Number, Boolean, Date  
|-
|-
| Convert || Converts value from string  || Number, Boolean, Date  || String value  
| Convert   || Converts value from string  || Number, Boolean, Date  || String value  
|-
|-
| Delete   || Deletes the record || Entity ||  
| Delete     || Deletes the record || Entity ||  
|-
|-
| Difference || Returns difference between first and second arguments  || Number  || Arg1: Number; Arg2: Number  
| Difference || Returns difference between first and second arguments  || Number  || Arg1: Number; Arg2: Number
|-
| Division  || Returns division of arguments  || Number  || Arg1: Number; Arg2: Number  
|-
|-
| Element At ||  
| Element At ||  
|-
|-
| Exponentiation  || Returns the nth exponent of a given number || Number || Arg1: Number; Arg2: Number
| ExecuteJS || [[Execute JavaScript from rules]] || Boolean, String, Number, Money, DateTime, StringList, Entity, Lookup || Arg1: name of the IFrame form tab that links to the script; Arg2: name of the JavaScript function
|-
| Division  || Returns division of arguments  || Number  || Arg1: Number; Arg2: Number
|-
|-
| ExecuteJS || [[Execute JavaScript from rules]] || Boolean, String, Number, Money, DateTime, StringList, Entity, Lookup || Arg1: name of the IFrame form tab that links to the script; Arg2: name of the JavaScript function
| Exponentiation || Returns the nth exponent of a given number || Number || Arg1: Number; Arg2: Number
|-
|-
| Format  || Returns formatted string from StringList ([[Formatting strings in rules|How to use?]]) || Text  || Arg1: Text; Arg2: StringList  
| Format  || Returns formatted string from StringList ([[Formatting strings in rules|How to use?]]) || Text  || Arg1: Text; Arg2: StringList  

Navigation menu