Overview
The conditional transform allows you to output different values depending on simple conditional logic. This is a convenience transform in that the same capability could be implemented via a "static" transform, but with much greater simplicity and null-safe error checking.
Other Considerations
- The two operands within the transform cannot be null; if they are, an IllegalArgumentException will be thrown.
- If you are using an "accountAttribute" transform for either of the operands within your expression, it is recommended that you wrap that transform inside of a "firstValid" transform to ensure that null values do not get passed into the expression.
- The
expression attribute must always be "eq" or the transform will throw an IllegalArgumentException.
- All attribute string values are case-sensitive, so differently cased strings (e.g., "engineering" and "Engineering") will not return as matched
Transform Structure
In addition to the standard type and name attributes required by all transforms, the conditional transform requires an expression, a positiveCondition and a negativeCondition. If the expression evaluates to false, the negative condition is returned, otherwise the positive condition is returned.
Example
{
"attributes": {
"expression": "foo eq foo",
"positiveCondition": "true",
"negativeCondition": "false"
},
"type": "conditional",
"name": "Test Conditional Transform"
}
Attributes
-
Required Attributes
- type - This must always be set to
conditional
- name - This is a required attribute for all transforms, and represents the name of the transform as it will appear in the UI's dropdowns
- expression - A comparison statement that follows the structure of
ValueA eq ValueB where ValueA and ValueB are static strings or outputs of other transforms; the eq operator is the only valid comparison
- positiveCondition - The output of the transform if the expression evaluates to true
- negativeCondition - The output of the transform if the expression evaluates to false
-
Optional Attributes
- requiresPeriodicRefresh - A
true or false value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process.
Examples
Example 1
{
"attributes": {
"expression": "$department eq Science",
"positiveCondition": "true",
"negativeCondition": "false",
"department": {
"attributes": {
"values": [
{
"attributes": {
"sourceName": "HR Source",
"attributeName": "department"
},
"type": "accountAttribute"
},
{
"attributes": {
"value": "none"
},
"type": "static"
}
]
},
"type": "firstValid"
}
},
"type": "conditional",
"name": "Test Conditional Transform"
}
This example takes the user's HR-defined department attribute and compares it to the value of "Science." If this is in fact the user's department, the transform will return "true," otherwise it will return "false."
Example 2
{
"attributes": {
"expression": "$department eq Science",
"positiveCondition": "$scienceBuilding",
"negativeCondition": "$adminBuilding",
"department": {
"attributes": {
"values": [
{
"attributes": {
"sourceName": "HR Source",
"attributeName": "department"
},
"type": "accountAttribute"
},
{
"attributes": {
"value": "none"
},
"type": "static"
}
]
},
"type": "firstValid"
},
"scienceBuilding": {
"attributes": {
"value": "Building S"
},
"type": "static"
},
"adminBuilding": {
"attributes": {
"value": "Building A"
},
"type": "static"
}
},
"type": "conditional",
"name": "Test Conditional Transform"
}
This example extends the previous one by returning the output of another Seaspray transform depending on the result of the expression. You can assign the outputs of Seaspray transforms to variables and then reference them within the positiveCondition and negativeCondition attributes.
References
