{"id":16321,"date":"2016-06-30T09:26:48","date_gmt":"2016-06-30T01:26:48","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=16321"},"modified":"2024-08-15T10:31:31","modified_gmt":"2024-08-15T02:31:31","slug":"singlevalueif","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/p2-server\/calculations\/singlevalueif\/","title":{"rendered":"SingleValueIf()"},"content":{"rendered":"\n

Format<\/span><\/h2>\n

SingleValueIf(Condition ,ValueIfTrue ,ValueIfFalse)<\/strong><\/p>\n

Returns<\/span><\/h2>\n

Returns the value of the ValueIfTrue\u00a0<\/strong>expression if\u00a0the Condition\u00a0<\/strong>expression evaluates to true. Otherwise, returns the value of the ValueIfFalse\u00a0<\/strong>expression.\u00a0<\/p>\n

See also: If()<\/a><\/p>\n

Inputs<\/span><\/h2>\n

Condition<\/strong>: The\u00a0expression to be evaluated.
\nBehaviour: Required
\nDimension:\u00a0Collection, SingleValue
\nValid\u00a0data types:\u00a0Boolean<\/p>\n

Note<\/strong>: Valid comparison operators are: ==<\/strong>, !=<\/strong>, <<\/strong>, <=<\/strong>, ><\/strong>, >=<\/strong>
\nFor a full list of operators, see Operators<\/a>.<\/p>\n

ValueIfTrue<\/strong>: The value returned if the condition evaluates to true.
\nBehaviour: Required
\nDimension: Error, Collection, SingleValue, Matrix, MultiCollection
\nValid data types: Null, Boolean, DateTime, Decimal, Integer, String, Duration, Error<\/p>\n

ValueIfFalse<\/strong>: The value returned if the condition evaluates to false.
\nBehaviour: Required\u00a0
\nDimension: Error, Collection, SingleValue, Matrix, MultiCollection
\nValid data types: Null, Boolean, DateTime, Decimal, Integer, String, Duration, Error<\/p>\n

How to format data types<\/a><\/p>\n

Common Traps<\/h2>\n

If a collection is used for the condition, it must contain only\u00a01 value. If the condition is a collection which contains 0 or more than 1 value, the function will return an error.<\/p>\n

When to Use<\/h2>\n

The SingleValueIf() function takes a single value and returns a value\u00a0which is either the true or false parameter, whereas If()<\/a> takes the individual values in the collections and compares them, returning a collection comprised of the individual evaluations.\u00a0<\/p>\n

Here are some examples which show the difference:<\/p>\n

If([1, 1, 2, 2]  \u00a0>= 2, [5, 5, 5, 5], [2, 2, 2, 2]) = \u00a0[2, 2, 5, 5]<\/strong><\/pre>\n
SingleValueIf([1] >= 2, [5, 5, 5, 5], [2, 2, 2, 2]) = \u00a0[2, 2, 2, 2]<\/strong><\/pre>\n
SingleValueIf([2] >= 2, [5, 5, 5, 5], [2, 2, 2, 2]) = \u00a0[5, 5, 5, 5]<\/strong><\/pre>\n
Note<\/strong>: The ValueIfTrue <\/em>and ValueIfFalse <\/em>parameters do not<\/em> need to be of the same type<\/strong>, so you can use this function to return different data types depending on the outcome.<\/p>\n
Examples<\/span><\/h2>\n
Expression: SingleValueIf({tagname}>=2,[5, 5, 5, 5], [2, 2, 2, 2])<\/span>
\nResult: If the value of\u00a0{tagname} is greater than or equal to 2, return [5, 5, 5, 5]. Otherwise, return [2, 2, 2, 2].
\nExample outcomes<\/em>: 
\n\u00a0 \u00a0 \u00a0Where tagname\u00a0is\u00a0[1], the function returns [2, 2, 2, 2].
\n\u00a0 \u00a0 \u00a0Where tagname\u00a0is\u00a0[], the function returns an error, because the collection contains 0 values.
\n\u00a0 \u00a0 \u00a0Where tagname\u00a0is\u00a0[1,2,3], the function returns an error, because the collection contains more than 1 value.<\/p>\n
Expression: SingleValueIf({tagname}>=0,{tagname},\"Too Low\")<\/span>
\nResult: If the value of\u00a0{tagname} is greater than or equal to zero, return the value of the tag. Otherwise, return the string \"Too Low\".
\n\u00a0<\/p>\n
Release History<\/span><\/h2>\n