\n| >=<\/td>\n | Represents greater than or equal to<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\nEvaluate a condition<\/h2>\nThis simple function is very useful for WEHOOP. It offers the possibility of comparing values and performing operations under certain conditions.<\/p>\n It is mainly used to indicate in which cases a field is mandatory or in the case of a conditional transition at the workflow level.
\nUsage<\/strong><\/p>\n\n- Subject of the form<\/li>\n
- Mandatory based on condition<\/li>\n
- Hide on condition<\/li>\n
- Initial value<\/li>\n
- Minimal value<\/li>\n
- Maximal value<\/li>\n
- Validation formula<\/li>\n<\/ul>\n
@If<\/h3>\nEvaluates a condition; if the condition is True, WEHOOP performs the action appearing immediately after that condition, and stops. If the condition is False, WEHOOP skips to the next condition and tests it, and so on. If none of the conditions is True, WEHOOP performs the else_action.
\nSyntax<\/strong>
\n@If( condition1 ; action1 ; condition2 ; action2 ; … ; condition99 ; action99 ; else_action )
\nParameters<\/strong>
\ncondition
\nExpression that returns a Boolean. If this expression returns True, action is performed. If it’s False, WEHOOP skips to the next condition, if there is one. Otherwise, WEHOOP performs else_action.
\naction
\nAn action to be performed or a value to be returned if the governing condition returns True.
\nelse_action
\nAn action to be performed or a value to be returned if none of the conditions returns True.
\nUsage<\/strong>
\nIn its simplest form, the If statement looks like this: @If( condition ; action ; else_action ).
\nYou can list up to 99 conditions and corresponding actions, followed by just one action to be performed when all the conditions are False. As soon as a condition evaluates to True, WEHOOP performs the associated action and ignores the remainder of the @If statement.
\nWEHOOP accepts the form @If( condition ), with only one condition and no action, but does not perform any action based on the condition.<\/p>\nIf you compare a field to a value (for example, Year > 1995) and the field is unavailable, the comparison is False. However, you should check for fields that may not be present with @IsUnavailable.
\nExamples<\/strong>
\nThis formula tests the single value in the CostOfGoods field. If the value is greater than or equal to 12.45, the condition is True, and the string "Over Budget" is returned. If the value is less than 12.45, the condition is False and the string "Bill of Materials OK" is returned.
\n@If(CostOfGoods>=12.45;"Over Budget";"Bill of Materials OK") <\/p>\nIn this example, if CostOfGoods is less than 12.45, the null string is returned.
\n@If(CostOfGoods>=12.45;"Over Budget";"")<\/p>\n Performing arithmetic operations<\/h2>\nThe * \/ + – operators multiply, divide, add, and subtract. Multiplication and division have precedence over addition and subtraction; otherwise, evaluation is left to right. Parentheses can be used to change the order of evaluation. The following are the arithmetic @functions.<\/p>\n @IsNumber<\/h3>\nIndique si une valeur donn\u00e9e est un nombre (ou une liste de nombres).
\nSyntaxe<\/strong>
\n@IsNumber( valeur )
\nParameters<\/strong>
\nvaleur : Any data type. Any value.
\nReturn value<\/strong>
\nReturns 1 (True) if the value is a number or a number list
\nReturns 0 (False) if the value is not a number or a number list
\nUsage<\/strong>
\nThis is a useful function for checking to see that you have assigned field data types correctly.
\nThe parameter must be a number, not a non-numeric value (for example, text) that can be converted to a number.
\nExamples<\/strong>
\nThis example returns 1.
\n@IsNumber(123)<\/p>\nThis example returns 0.
\n@IsNumber("123")<\/p>\n @Modulo<\/h3>\nReturns the remainder of a division operation.
\nSyntaxe<\/strong>
\n@Modulo( number1 ; number2 )
\nParameters<\/strong>
\nnumber1
\nNumber or number list.
\nnumber2
\nNumber or number list. If this is equal to 0, @Modulo returns @ERROR.
\nReturn value<\/strong>
\nremainder
\nNumber or number list. The remainder of number1 divided by number2. If the parameters are number lists, @Modulo returns a list that is the result of pair-wise computation on the list values. The sign of the result is always the same as the sign of the number1.
\nUsage<\/strong>
\nA common use of @Modulo is to determine whether a number is odd or even; if the result of @Modulo(number;2) is 1, the number is odd; if the result is 0, the number is even.
\nWhen using this function with a number list, the list concatenation operator takes precedence over any other operators; negative numbers must be enclosed in parentheses.
\nExamples<\/strong>
\nThis example returns 1.
\n@Modulo(4;3)<\/p>\nThis example returns 0.
\n@Modulo(4;2)<\/p>\n @Text<\/h3>\nConverts any value to a text string.
\nSyntaxe<\/strong>
\n@Text( value ; format-string )
\nParameters<\/strong>
\nvalue
\nNumber, time-date, text, list thereof, or rich text. The value you want to convert to text.<\/p>\nformat-string
\nText or text list. Optional. Up to four format-strings (see table that follows). These determine how the text is returned. If the value is already a text data type, the format-string is ignored.
\nReturn value<\/strong>
\ntextValue
\nText or text list. The value you specified, converted to text. If you used any format-strings, they are applied.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.<\/p>\nOnce a number value is converted to text, you will not be able to use the number for arithmetic calculations.
\nExamples<\/strong>
\nThis example returns 123.45.
\n@Text(123.45)<\/p>\n@Sum<\/h3>\nAdds a set of numbers or number lists.
\nSyntax<\/strong>
\n@Sum( numbers )
\nParameters<\/strong>
\nnumbers
\nNumbers or number lists. As many numbers or number lists as you want to sum.
\nReturn value<\/strong>
\nresult
\nNumber. The sum of all the numbers, including members of number lists.
\nUsage<\/strong>
\nMake sure the fields you send as parameters contain a number value — WEHOOP interprets empty number fields as the null string.
\nSince list concatenation has the highest precedence, list elements that are expressions must be in parentheses if the expression applies only to that element. For example, write @Sum(1:2:(-3):4), not @Sum(1:2:-3:4), if 3 is negative and 4 is not.
\nExamples<\/strong>
\nThis example returns 3.
\n@Sum( 1 : 2 )<\/p>\nThis example returns 11.
\n@Sum( (-1) : 2 ; (-10) : 20 )<\/p>\n @TextToNumber<\/h3>\nConverts a text string to a number, where possible.
\nSyntax<\/strong>
\n@TextToNumber( string )
\nParameters<\/strong>
\nstring
\nText or text list. The string you want to convert to a number. If the string contains both numbers and letters, it must begin with a number to be converted properly. For example, the string "12ABC" converts to 12, but "ABC12" produces an error.
\nReturn value<\/strong>
\nnumber
\nNumber or number list. The string, converted to a number.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nThis function is useful for converting a number in a text field to a number that can be used for computation in a number field.<\/p>\nYou can’t use @TextToNumber to convert special text (such as that returned by @DocChildren or @DocDescendants) to a number.
\n@TextToNumber returns an error If you try to pass anything besides a string into it.
\nExamples<\/strong>
\nThis example returns 123 as a number.
\n@TextToNumber("123")<\/p>\nThis example returns 123 and 456 as a number list.
\n@TextToNumber("123" : "456")<\/p>\n Performing string operations<\/h2>\nFormula language @functions enable you to:
\n\u2022 Convert data types
\n\u2022 Concatenate, compare, and determine length
\n\u2022 Locate and extract substrings
\n\u2022 Trim, repeat, add a new line, and change case<\/p>\n @Contains<\/h3>\nDetermines whether a substring is stored within a string.
\nSyntax<\/strong>
\n@Contains( string ; substring )
\nParameters<\/strong>
\nstring
\nText or text list. The string(s) you want to search.
\nsubstring
\nText or text list. The string(s) you want to search for in string.
\nReturn value<\/strong>
\nReturns true (1) if any substring is contained in one of the strings
\nReturns false (0) if no substrings are contained in any of the strings
\nUsage<\/strong>
\nThis function is case-sensitive.
\nIf either parameter is a list, the function returns 1 if any element of parameter 1 contains any element of parameter 2.<\/p>\nYou cannot use this function to test for substrings in a rich text field.
\nAvoid using this function to test for an exact match (that is, parameter 2 equals parameter 1). The result will be wrong if parameter 1 is not an exact match but does contain parameter 2. Use the equal operator or @IsMember, which will give the desired result and are more efficient.
\nExamples<\/strong>
\nThis example returns 1 to indicate that the substring, "Th," is contained in the string, "Hi There."
\n@Contains("Hi There";"Th")<\/p>\nThis example returns 1 to indicate that the items in one text list are contained in the other text list.
\n@Contains("Tom":"Dick":"Harry";"Harry":"Tom")<\/p>\n @Elements<\/h3>\nCalculates the number of text, number, or time-date values in a list. This function always returns a number to indicate the number of entries in the list.
\nSyntax<\/strong>
\n@Elements( list )<\/p>\nParameters
\nlist
\nText list, number list, or time-date list.
\nReturn value<\/strong>
\nnumElements
\nNumber. The number of elements in the list. If the field value is a null string, @Elements(list) returns the number 0. @Count returns 1 if the field value is a null string or not a list value.
\nUsage<\/strong>
\nYou can use @Elements in the condition statement of @For functions to set the loop count equal to the number of elements in the list:
\n@For(n := 1; n <= @Elements(list); n := n + 1;formula)
\nExamples<\/strong>
\nThis example returns 4 if the list in the SalesForce field is "Rogers":"Binney":"Harris":"Larson."
\n@Elements(SalesForce)<\/p>\nThis example returns 2.
\n@Elements("Jones":"Portsmore")<\/p>\n @IsMember<\/h3>\nIndicates if a piece of text (or a text list) is contained within another text list. The function is case-sensitive.
\nSyntax<\/strong>
\n@IsMember( textValue ; textListValue ) @IsMember( textListValue1 ; textListValue2 )
\nParameters<\/strong>
\ntextValue
\nText.
\ntextListValue
\nText list.
\ntextListValue1
\nText list.
\ntextListValue2
\nText list.
\nReturn value<\/strong>
\nReturns 1 (True) if the textValue is contained in textListValue
\nReturns 0 (False) if not
\nIf both parameters are lists, returns 1 if all elements of textListValue1 are contained in textListValue2
\nUsage<\/strong>
\nIn processing lists, @IsMember differs from a simple = test. An = returns True if the pair-wise comparison of two entities has even one member; that is, it is not empty.
\nFor further details on pair-wise operators, see the topic Operations on lists.
\n@IsMember returns True only if the first parameter is an exact match, or a subset of the second parameter which is a list.
\nExamples<\/strong>
\nThis example returns 1.
\n@IsMember("computer";"printer":"computer":"monitor")<\/p>\nThis example returns 0.
\n@IsMember("computer":"Notes";"Notes":"printer":"monitor")<\/p>\n @Left<\/h3>\nSearches a string from left to right and returns the leftmost characters of the string.
\nSyntax<\/strong>
\n@Left( stringToSearch ; numberOfChars ) @Left( stringToSearch ; subString )
\nParameters<\/strong>
\nstringToSearch
\nText or text list. The string where you want to find the leftmost characters.
\nnumberOfChars
\nNumber. The number of characters to return. If the number is 2, the first two characters of the string are returned; if the number is 5, the first five characters are returned, and so on. If the number is negative, the entire string is returned.
\nsubString
\nText. A substring of stringToSearch. @Left returns the characters to the left of subString. It finds subString by searching stringToSearch from left to right.
\nReturn value<\/strong>
\nresultString
\nText or text list. The leftmost characters in stringToSearch. The number of characters returned is determined by either numberOfChars or subString. @Left returns "" if subString is not found in stringToSearch.
\nUsage<\/strong>
\nIf the first parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns Len.
\n@Left("Lennard Wallace";3)<\/p>\nThis example returns Lennard Wal if the string in the Contact field is Lennard Wallace.
\n@Left(Contact;"la")<\/p>\n @LowerCase<\/h3>\n@LowerCase (Formula Language)
\nConverts the uppercase letters in the specified string to lowercase.
\nSyntax<\/strong>
\n@LowerCase( string )
\nParameters
\nstring
\nText or text list. The string you want to convert to lowercase.
\nReturn value<\/strong>
\nlowerCaseString
\nText or text list. The string, converted to lowercase letters.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.<\/p>\nThis function is useful when you want to search for a particular value and cannot predict whether it appears in lowercase or uppercase letters, or a combination of the two. You can also use it as an input translation formula to convert the contents of a field to lowercase.
\nExamples<\/strong>
\nThis example returns juan mendoza.
\n@LowerCase("Juan Mendoza")<\/p>\nThis example returns arm chair if the Furniture field contains "Arm Chair," "Arm chair," "arm chair," or "ARM CHAIR," or any other variation.
\n@LowerCase(Furniture)<\/p>\n @Middle<\/h3>\nReturns any substring from the middle of a string. The middle is found by scanning the string from left to right, and parameters determine where the middle begins and ends.
\nSyntax<\/strong>
\n@Middle( string ; offset ; numberchars ) @Middle( string ; offset ; endstring ) @Middle( string ; startString ; endstring ) @Middle( string ; startString ; numberchars )
\nParameters<\/strong>
\nstring
\nText or text list. Any string.
\noffset
\nNumber. A character position in string that indicates where you want the middle to begin, always counting from left to right. The middle begins one character after the offset.
\nstartString
\nText. A substring of string that indicates where you want the middle to begin, always counting from left to right. The middle begins one character after the end of startString.
\nnumberchars
\nNumber. The number of characters that you want in the middle. If numberchars is negative, the middle starts at offset or startString and continues from right to left. If numberchars is positive, the middle starts one character past the offset or startString and continues from left to right.
\nendstring
\nText. A substring of string that indicates the end of the middle. @Middle returns all the characters between offset and endstring, or between startString and endstring.
\nReturn value<\/strong>
\nmiddle
\nText or text list. The substring from the middle of string, which begins at the offset or startString you specify and ends at the endstring you specify, or after the numberchars have been reached.
\nUsage<\/strong>
\nIf the first parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns h C. The offset is positioned at the "t" (the fourth character from the left), and the count starts with the first character after the offset, moving from left to right.
\n@Middle("North Carolina";4;3)<\/p>\nThis example returns ort. The offset is positioned at the "t" (the fourth character from the left), and the count begins at the offset, moving from right to left.
\n@Middle("North Carolina";4;-3)<\/p>\n @Name<\/h3>\n@Right<\/h3>\nReturns the rightmost characters in the string. You can specify the number of rightmost characters you want returned, or you can indicate that you want all the characters following a specific substring.
\nSyntax<\/strong>
\n@Right( stringToSearch ; numberOfChars ) or @Right( stringToSearch ; subString )
\nParameters<\/strong>
\nstringToSearch
\nText or text list. The string whose rightmost characters you want to find.
\nnumberOfChars
\nNumber. The number of characters to return. If the number is 2, the last two characters of stringToSearch are returned; if the number is 5, the last five characters are returned, and so on.
\nsubString
\nText. A substring of stringToSearch. @Right returns all of the characters to the right of subString. It finds subString by searching stringToSearch from left to right.
\nReturn value<\/strong>
\nresultString
\nText or text list. The rightmost characters in stringToSearch. The number of characters returned is determined by either numberOfChars or subString. @Right returns "" if subString is not found in stringToSearch.
\nUsage<\/strong>
\nIf the first parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns "ace," the rightmost 3 characters in the string.
\n@Right("Lennard Wallace";3)<\/p>\nThis example returns "Wallace," which represents everything to the right of the first occurrence of the blank space.
\n@Right("Lennard Wallace";" ")<\/p>\n @Sort<\/h3>\nSorts a list.
\nSyntax<\/strong>
\n@Sort( list ; [ order ])
\nParameters<\/strong>
\nlist
\nText, number, or time-date list. The values to be sorted. Any alternate data types are returned unchanged.
\n[ order ]
\nKeyword. Optional. You can use the following keywords to specify the order of the sort:
\n[ASCENDING]
\n[DESCENDING]
\nReturn value<\/strong>
\nlist
\nText, number, or time-date list. The sorted values.
\nUsage<\/strong>
\nThe ascending, case-, and accent-sensitive sort sequence for the English character set is as follows: the numbers 0-9, the alphabetic characters aA-zZ, the apostrophe, the dash, and the remaining special characters. Pitch-sensitivity affects double-byte languages.
\nExamples<\/strong>
\nThis formula returns: Albany, New Boston, new york, San Francisco.
\n@Sort(@ThisValue)
\nSame as preceding.
\n@Sort(@ThisValue; [ASCENDING])<\/p>\nThis formula returns: San Francisco, New Boston, new york, and Albany.
\n@Sort(@ThisValue; [DESCENDING])<\/p>\n @Subset<\/h3>\nSearches a list from beginning to end and returns the number values you specify. If you specify a negative number, @Subset searches the list from beginning to end, but the result is ordered as from the beginning of the list.
\nSyntax<\/strong>
\n@Subset( list ; number )
\nParameters<\/strong>
\nlist
\nText list, number list, time-date list, or time-date range list. The list whose subset you want.
\nnumber
\nNumber. The number of values from list that you want. Specifying zero (0) returns the error, "The second argument to @Subset must not be zero."
\nReturn value<\/strong>
\nsubsetList
\nText list, number list, or time-date list.The list, containing the number of values you specified.
\nExamples<\/strong>
\nThis example returns New Orleans;London.
\n@Subset("New Orleans":"London":"Frankfurt":"Tokyo";2)<\/p>\nThis example returns London;Frankfurt;Tokyo.
\n@Subset("New Orleans":"London":"Frankfurt":"Tokyo";-3)<\/p>\n Performing time-date operations<\/h2>\nA time-date value consists of a year, month, day, hour, minute, and second. You can use a time-date value "as is" in a time-date field, but must convert it with @Text to use it as a string. You can convert a string to a time-date value with @TextToTime.<\/p>\n @Adjust<\/h3>\nAdjusts the specified time-date value by the number of years, months, days, hours, minutes, and\/or seconds you specify. The amount of adjustment may be positive or negative.
\nSyntax<\/strong>
\n@Adjust( dateToAdjust ; years ; months ; days ; hours ; minutes ; seconds ; [DST] )
\nParameters<\/strong>
\ndateToAdjust
\nTime-date or time-date list. The time-date value you want to increment. This should be a single date, not a range.
\nyears
\nNumber. The number of years to increment by.
\nmonths
\nNumber. The number of months to increment by.
\ndays
\nNumber. The number of days to increment by.
\nhours
\nNumber. The number of hours to increment by.
\nminutes
\nNumber. The number of minutes to increment by.
\nseconds
\nNumber. The number of seconds to increment by.
\n[DST]
\nKeyword. Optional. Specify [INLOCALTIME] to further adjust the time for daylight-saving time if the adjustment crosses the boundary and daylight-saving time is in effect. Specify [INGMT] or omit this parameter to not further adjust the time for daylight-saving time. The adjustment is such that adding or subtracting in day increments yields the same time in the new day.
\nReturn value<\/strong>
\nadjustedDate
\nTime-date. The date, incremented by the amount of time you have specified.
\nUsage<\/strong>
\nIf the first parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nYou must include all arguments except the [DST] keyword; include a zero (0) for parameters you don’t want to adjust.
\nThe arguments are applied from right to left. For instance, @Adjust([2\/2\/2006]; 0; 2; 28; 0; 0; 0) returns [5\/2\/2006], not [4\/30\/2006] as you might expect. This is because @Adjust first adds 28 days, making [3\/2\/2006], then adds two months, making [5\/2\/2006]. To first add two months, then add 28 days, use @Adjust twice, for instance: @Adjust(@Adjust([02\/02\/2006]; 0; 2; 0; 0; 0; 0); 0; 0; 28; 0; 0; 0)
\nTip<\/strong>
\nTo find the difference between two dates, subtract them. The result is returned in seconds. To adjust the result to days, divide the result by 86,400 – which is the number of seconds in a day.<\/p>\nFor example: (date2-date1)\/86400
\nThis code returns 4.
\nCalculating due dates<\/strong>
\nA typical use for @Adjust is calculating a due date from an entry date, by adjusting only one component of the time-date value, for example, the month component.
\nExamples<\/strong>
\nThis example returns 03\/20\/94. A date that is 2 years and 10 days before the supplied date.
\n@Adjust([03\/30\/96];-2;0;-10;0;0;0)<\/p>\nThis example returns 09\/1\/97 and 09\/2\/97.
\n@Adjust([06\/29\/95] : [06\/30\/95]; 2; 2; 2; 0; 0; 0)<\/p>\n This example returns the date one month from the date in the field named Date.
\n@Adjust(Date;0;1;0;0;0;0) <\/p>\n This example returns the date one month and one day from the current time-date.
\n@Adjust(@Now;0;1;1;0;0;0)
\nGiven a date, this formula calculates the beginning of the week. It takes the date stored in the dueDate field, and returns the date representing the previous Monday. For example, if dueDate is 06\/02\/95, this formula returns 05\/29\/95.
\n@Adjust( dueDate; 0; 0; – ( @Weekday( dueDate ) – 2 ); 0; 0; 0 )
\n@Adjust(@Adjust([02\/02\/2006]; 0; 2; 0; 0; 0; 0); 0; 0; 28; 0; 0; 0)<\/p>\n @Date<\/h3>\nTranslates numbers for the various components of time and date, then returns the time-date value.
\nSyntax<\/strong>
\n@Date( year ; month ; day ) @Date( year ; month ; day ; hour ; minute ; second ) @Date( time-date )
\nParameters<\/strong>
\nyear
\nNumber. The year that you want to appear in the resulting date. You must specify an entire four-digit year. (For example, use 1996, not 96).
\nmonth
\nNumber. The month that you want to appear in the resulting date. (For example, use 1 to specify January).
\nday
\nNumber. The day that you want to appear in the resulting date.
\nhour
\nNumber. The number of hours. This value will be truncated from the resulting date.
\nminute
\nNumber. The number of minutes. This value will be truncated from the resulting date.
\nsecond
\nNumber. The number of seconds. This value will be truncated from the resulting date.
\ntime-date
\nTime-date or time-date list. For a time-date value such as @Now or [10\/31\/93 12:00:00], @Date removes the time portion of the value, leaving only the date.
\nReturn value<\/strong>
\ntruncatedTimeDate
\nTime-date. The date corresponding to the parameters that you sent to @Date, minus any time components.
\nUsage<\/strong>
\nIf the parameter is a date-time list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nSpecifying invalid numbers will result in a blank date.
\nExamples<\/strong>
\nThis example returns 06\/23\/95.
\n@Date(1995; 06; 23)
\nThis example returns 06\/23\/0095.
\n@Date(95; 06; 23)
\nThis example returns 06\/23\/2095.
\n@Date(2095; 06; 23)<\/p>\n@Day<\/h3>\nExtracts the day of the month from the specified date.
\nSyntax<\/strong>
\n@Day( timeDateValue )
\nParameters<\/strong>
\ntimeDateValue
\nTime-date or time-date list. The date containing the day value that you want to extract.
\nReturn value<\/strong>
\ndayOfMonth
\nNumber or number list. The number corresponding to the day of the month indicated by timeDateValue. Returns -1 if the time-date provided contains only a time value and not a date.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns 15 if today is July 15, August 15, September 15, and so on.
\n@Day(@Now)
\nThis example returns 20 and 21 in a list.
\n@Day([11\/20\/95 8:58:12] : [11\/21\/95 8:58:12])
\nThis example returns the string "Payment received on or before the 15th" if the PaymentReceived field is filled in on or before the 15th of the month; otherwise, it returns the string "Payment received after the 15th."
\n@If(@Day(PaymentReceived)<16;"Payment received on or before the 15th";"Payment received after the 15th")<\/p>\n@Month<\/h3>\nExtracts the number of the month from the specified time-date.
\nSyntax<\/strong>
\n@Month( time-date )
\nParameters<\/strong>
\ntime-date
\nTime-date or time-date list. The value with the month that you want to extract.
\nReturn value<\/strong>
\nmonth
\nNumber or number list. The number of the month. Returns -1 if the time-date provided contains only a time value and not a date.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns 1.
\n@Month([1\/15\/88])
\nThis example returns 1 and 2 in a list.
\n@Month([1\/15\/88] : [2\/15\/88])
\nThis example returns 12 if it is December.
\n@Month(@Now)<\/p>\n@Text<\/h3>\nConverts any value to a text string.
\nSyntax<\/strong>
\n@Text( value ; format-string )
\nParameters<\/strong>
\nvalue
\nNumber, time-date, text, list thereof, or rich text. The value you want to convert to text.
\nNote
\nConversion of rich text is new with Release 6.
\nformat-string
\nText or text list. Optional. Up to four format-strings (see table that follows). These determine how the text is returned. If the value is already a text data type, the format-string is ignored.
\nReturn value
\ntextValue
\nText or text list. The value you specified, converted to text. If you used any format-strings, they are applied.
\n@Text with time-date components
\nThere are four separate categories of time-date, format-string components. You can include up to four components, but only one from each category.<\/p>\n\n\n\n| Symbol<\/th>\n | Meaning<\/th>\n<\/tr>\n | \n| D0<\/td>\n | Month, day and year<\/td>\n<\/tr>\n | \n| D1<\/td>\n | Month and day, year if it is not the current year<\/td>\n<\/tr>\n | \n| D2<\/td>\n | Month and day<\/td>\n<\/tr>\n | \n| D3<\/td>\n | Month and year<\/td>\n<\/tr>\n | \n| T0<\/td>\n | Hour, minute, and second<\/td>\n<\/tr>\n | \n| T1<\/td>\n | Hour and minute<\/td>\n<\/tr>\n | \n| Z0<\/td>\n | Always convert time to this zone<\/td>\n<\/tr>\n | \n| Z1<\/td>\n | Display zone only when it is not this zone<\/td>\n<\/tr>\n | \n| Z2<\/td>\n | Display zone always<\/td>\n<\/tr>\n | \n| S0<\/td>\n | Date only<\/td>\n<\/tr>\n | \n| S1<\/td>\n | Time only<\/td>\n<\/tr>\n | \n| S2<\/td>\n | Date and time<\/td>\n<\/tr>\n | \n| S3<\/td>\n | Date, time, Today, or Yesterday<\/td>\n<\/tr>\n | \n| Sx<\/td>\n | Use when you cannot predict the exact format of the value being passed, but you know that it is either a time, a date, or both.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n @Text with number values
\nFor number values, compose a format-string by combining any of the following components into a string.
\nSymbol
\nMeaning
\nG
\nGeneral format (significant digits only)
\nF
\nFixed format (set number of decimal places)
\nS
\nScientific format (E notation)
\nC
\nCurrency format (two decimal places)
\n,
\nPunctuated at thousands (using U.S. format)
\n%
\nPercentage format
\n()
\nParentheses around negative numbers
\nnumber
\nNumber of digits of precision
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nOnce a number value is converted to text, you will not be able to use the number for arithmetic calculations.
\nExamples<\/strong>
\nThis example returns 123.45.
\n@Text(123.45)
\nThis example returns $800.00 if the value in the Sales field is 800.
\n@Text(Sales;”C,2″)
\nThis example returns 8.00E+02.
\n@Text(800;”S”)
\nThis example returns 8.00E+02 and -6.00E+02 in a list.
\n@Text(800 : (-600);”S”)
\nThis example returns 04\/11\/93 10:43 AM.
\n@Text(@Now)
\nThis example returns 04\/11.
\n@Text(@Now;”D1S0″)
\nThis example returns 10:43:30 AM.
\n@Text(@Now;”D1S1″)
\nThis example returns 04\/93 10:43 AM.
\n@Text(@Now;”D3T1″)
\nThis example returns the rich-text Body field stripped of attachments and formatting.
\n@Text(Body)
\nTo convert a number date (in the ShipDate field) into a written date, you can use the following code. If ShipDate contains [08\/31\/2002], the result is “August 31, 2002.”
\n@If( @IsTime(ShipDate);
\n@Text(@Select(@Month(ShipDate); “January”; “February”; “March”; “April”; “May”; “June”; “July”; “August”; “September”; “October”; “November”;”December”))+ ” ” +
\n@Text(@Day(ShipDate)) + “, ” + @Text(@Year(ShipDate));
\n “No date given”)<\/p>\n@Today<\/h3>\nReturns today’s date.
\nSyntax<\/strong>
\n@Today
\nReturn value<\/strong>
\ntoday
\nTime-date. Today’s date.
\nUsage<\/strong>
\nThis function is identical to the formula @Date(@Now). It is usually used in default value formulas to automatically enter the current date.
\nUsing @Today in column or selection formulas may impact the efficiency of your application. It also causes the view refresh indicator to display constantly.
\nExamples<\/strong>
\nThis example returns 02\/19\/93 if today is February 19, 1993.
\n@Today
\nThis example sets the field named ReceivedDate to today’s date.
\nFIELD ReceivedDate:=@Today<\/p>\n@Weekday<\/h3>\nComputes the day of the week and returns a number that identifies the day.
\nSyntax<\/strong>
\n@Weekday( time-date )
\nParameters<\/strong>
\ntime-date
\nTime-date or time-date list. The date having the weekday value you want.
\nReturn value<\/strong>
\nweekdayNumber
\nNumber or number list. Weekday numbers are 1 through 7, with Sunday = 1, Monday = 2, and so on.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns 5.
\n@Weekday([9\/29\/88])
\nThis example returns 2 if the date in the response field happens to fall on a Monday.
\n@Weekday(ResponseDate)<\/p>\n@Year<\/h3>\nExtracts and returns the year from the specified time-date value.
\nSyntax<\/strong>
\n@Year( time-date )
\nParameters<\/strong>
\ntime-date
\nTime-date or time-date list. The time-date of the year you want.
\nReturn value<\/strong>
\nyear
\nNumber or number list. The year of time-date. @Year returns the year relative to the time zone in which the date was generated. Returns -1 if the time-date provided contains only a time value and not a date.
\nUsage<\/strong>
\nIf the parameter is a list, the function operates on each element of the list, and the return value is a list with the same number of elements.
\nExamples<\/strong>
\nThis example returns 1995.
\n@Year([9\/29\/95])
\nThis example returns 1995 and 2008.
\n@Year([9\/29\/95] : [9\/29\/08]<\/p>\n","protected":false},"excerpt":{"rendered":"WEHOOP uses the Formulas Language similar to Excel to perform operations, calculations and comparisons in a form that remains simple.<\/p>\n","protected":false},"author":3,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":{"footnotes":""},"ht-kb-category":[186],"ht-kb-tag":[],"class_list":["post-2728","ht_kb","type-ht_kb","status-publish","format-standard","hentry","ht_kb_category-d-guide"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/ht-kb\/2728","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/comments?post=2728"}],"version-history":[{"count":0,"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/ht-kb\/2728\/revisions"}],"wp:attachment":[{"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/media?parent=2728"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/ht-kb-category?post=2728"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/wiki.wehoop.com\/en\/wp-json\/wp\/v2\/ht-kb-tag?post=2728"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}} | |