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
|-
|-
| Assign || Assigns value to variable || Text, Number, Boolean, Date  || Variable data type, all types for text variable
| AddDays || Returns DateTime argument plus X days  || 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
|-
|-
| Clear || Assigns null or empty value to variable || Text, Number, Boolean, Date ||   
| Addition || Returns addition of arguments || Number  || Arg1: Number; Arg2: Number
|-
|-
| Convert || Converts value from string || Number, Boolean, Date || String value
| AddMinutes || Returns DateTime argument plus X minutes || DateTime || Arg1: DateTime; Arg2: Number
|-
|-
| Negate || Returns negated value of argument  || Boolean || Boolean
| AddMonths || Returns DateTime argument plus X months || DateTime || Arg1: DateTime; Arg2: Number
|-
|-
| AddSufix || Adds argument value as suffix to variable || Text || Text, Number, Boolean, Date
| 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  
|-
|-
| Concat || Returns concatenated string from two arguments || Text  || 2 args: Text, Number, Boolean, Date  
| AddSufix || Adds argument value as suffix to variable || Text  || Text, Number, Boolean, Date  
|-
|-
| Concat3 || Returns concatenated string from three arguments || Text || 3 args: Text, Number, Boolean, Date
| AddWeeks || Returns DateTime argument plus X weeks || DateTime || Arg1: DateTime; Arg2: Number  
|-
|-
| Substring || Returns a sub-string || Text || Arg1: Text; Arg2 and Arg3: Number
| AddYear || Returns DateTime argument plus X years || DateTime || Arg1: DateTime; Arg2: Number  
|-
|-
| Format || Returns formatted string from StringList ([[Formatting strings in rules|How to use?]]) || Text  || Arg1: Text; Arg2: StringList
| Assign || Assigns value to variable  || Text, Number, Boolean, Date || Variable data type, all types for text variable
|-
|-
| Addition  || Returns addition of arguments  || Number  || Arg1: Number;  Arg2: Number
| AssignNew || Creates a new instance of an object in the variable
|-
|-
| Difference || Returns difference between first and second arguments || Number  || Arg1: Number; Arg2: Number
| Clear || Assigns null or empty value to variable || Text, Number, Boolean, Date ||
|-
|-
| Multiplication || Returns product of arguments || Number || Arg1: Number; Arg2: Number
| ClearItems || Removes all items from list variable || StringList ||  
|-
|-
| Division || Returns division of arguments  || Number || Arg1: Number; Arg2: Number  
| Concat || Returns concatenated string from two arguments  || Text || 2 args: Text, Number, Boolean, Date
|-
|-
| N-th Root || Returns the nth root of a given number || Number || Arg1: Number; Arg2: Number
| Concat3 || Returns concatenated string from three arguments  || Text || 3 args: Text, Number, Boolean, Date
|-
|-
| Exponentiation || Returns the nth exponent of a given number || Number  || Arg1: Number; Arg2: Number
| Convert || Converts value from string  || Number, Boolean, Date || String value
|-
|-
| Logarithm  || Returns the logarithm to the base n of a given number || Number  || Arg1: Number; Arg2: Number
| Delete    || Deletes the record || Entity ||  
|-
|-
| TimeDifference || Returns difference between first and second argument || Number  || Arg1: Date Time; Arg2: Date Time; Arg3: unit of time
| Difference || Returns difference between first and second arguments || Number  || Arg1: Number; Arg2: Number
|-
|-
| GetUnixTime || Converts datetime into unix time || Number || Arg1: Date Time
| Element At ||  
|-
|-
| Get Date Part || Return a portion of a date time field || DateTime
| Exponentiation  || Returns the nth exponent of a given number || Number  || Arg1: Number; Arg2: Number
|-
|-
| LengthOf || Return the length of a string || Number || Arg1: String
| Division  || Returns division of arguments  || Number || Arg1: Number; Arg2: Number
|-
|-
| IndexOf || Returns the first occurrence of a specified substring within a string || Number || Arg 1: String; Arg 2: substring
| 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
|-
|-
| SetNow || Assigns current time to variable  || DateTime ||
| Format || Returns formatted string from StringList ([[Formatting strings in rules|How to use?]]) || Text || Arg1: Text; Arg2: StringList
|-
|-
| SetToday  || Assigns current day to variable  || DateTime || 
| Get Date Part || Return a portion of a date time field || DateTime  
|-
|-
| SetTomorrow || Assigns tomorrow to variable || DateTime ||
| GetItem || Returns item at specified index. || StringList || Number
|-
|-
| AddMinutes  || Returns DateTime argument plus X minutes  || DateTime  || Arg1: DateTime; Arg2: Number
| GetUnixTime || Converts datetime into unix time || Number || Arg1: Date Time
|-
|-
| AddHours  || Returns DateTime argument plus X hours  || DateTime  || Arg1: DateTime; Arg2: Number
| IndexOf || Returns the first occurrence of a specified substring within a string || Number || Arg 1: String; Arg 2: substring
|-
|-
| AddDays || Returns DateTime argument plus X days  || DateTime || Arg1: DateTime; Arg2: Number  
| InsertItem || Adds argument to specified index. Index starts at 0. || StringList || Arg1: Number, Boolean, String, DateTime; Arg2: Number  
|-
|-
| AddWeeks  || Returns DateTime argument plus X weeks  || DateTime  || Arg1: DateTime; Arg2: Number
| LengthOf || Return the length of a string || Number || Arg1: String
|-
|-
| AddMonths  || Returns DateTime argument plus X months  || DateTime  || Arg1: DateTime; Arg2: Number
| LoadAggregate || Allows you to use Fetch XML aggregation functions || || Arg1: entity; Arg2: field; Arg3: aggregation function
|-
|-
| AddYear || Returns DateTime argument plus X years  || DateTime || Arg1: DateTime; Arg2: Number  
| Logarithm || Returns the logarithm to the base n of a given number || Number || Arg1: Number; Arg2: Number
|-
|-
| AddItem || Adds argument to end of list. || StringList || Arg1: Number, Boolean, String, DateTime
| Multiplication || Returns product of arguments || Number || Arg1: Number; Arg2: Number
|-
|-
| InsertItem || Adds argument to specified index. Index starts at 0. || StringList || Arg1: Number, Boolean, String, DateTime; Arg2: Number
| Negate || Returns negated value of argument || Boolean || Boolean  
|-
|-
| GetItem || Returns item at specified index.  || StringList || Number  
| N-th Root || Returns the nth root of a given number || Number || Arg1: Number; Arg2: Number
|-
|-
| RemoveItem  || Removes item at specified index  || StringList  || Number  
| RemoveItem  || Removes item at specified index  || StringList  || Number  
|-
| ClearItems  || Removes all items from list variable  || StringList  ||
|-
| LoadAggregate || Allows you to use Fetch XML aggregation functions || || Arg1: entity; Arg2: field; Arg3: aggregation function
|-
| Element At ||
|-
| AddParty  || Adds a party to an activity  || Activity Entity  ||  User
|-
|-
| RemoveParty  || Removes a party from an activity  || Activity Entity  ||  User
| RemoveParty  || Removes a party from an activity  || Activity Entity  ||  User
Line 392: Line 388:
| SaveAfter || (OnSave, OnExecute rule only) Saves an entity record that you created or changed in rules || Entity || Arg1: Other entity that must be saved first
| SaveAfter || (OnSave, OnExecute rule only) Saves an entity record that you created or changed in rules || Entity || Arg1: Other entity that must be saved first
|-
|-
| AssignNew || Creates a new instance of an object in the variable
| SetNow  || Assigns current time to variable || DateTime  || 
|-
| SetToday  || Assigns current day to variable  || DateTime  || 
|-
| SetTomorrow  || Assigns tomorrow to variable  || DateTime  || 
|-
|-
| Delete    || Deletes the record || Entity ||  
| Substring  || Returns a sub-string  || Text  || Arg1: Text; Arg2 and Arg3: 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
| TimeDifference  || Returns difference between first and second argument  || Number || Arg1: Date Time; Arg2: Date Time; Arg3: unit of time
|}
|}


Navigation menu