Attribute mappings

Attribute Substitution
Use ${attributeName} in the DN expression.

Source Event:   { eventID: uid=jsmith,ou=Sales,o=SuperCompany, firstName: John, lastName: Smith }
DN Expression: cn=${firstName} ${lastName},ou=People,o=MyOrg
Result: cn=John Smith,ou=People,o=MyOrg

Function Substitution
The result of a function call on the attributes of a source event can be used with the function substitution notation:
${functionName(attributeName1,attributeName2, …}

Source Event:   { eventID: uid=jsmith,ou=Sales,o=SuperCompany, firstName: John, lastName: Smith }
DN Expression: cn=${uppercase(firstName)},ou=People,o=MyOrg
Result: cn=JOHN,ou=People,o=MyOrg

RDN Substitution
Insert portions (one or more RDN components) of the source event DN using the following formats are supported:
${rdn[index]}
${rdn[startIndex:endIndex]}
${rdn[startIndex:]}
${rdn[:endIndex}]
${rdn_value[index]}
${rdn_value[startIndex:endIndex]}
${rdn_value[startIndex:]}
${rdn_value[:endIndex]}

Source Event:   { eventID: uid=jsmith,ou=Sales,o=SuperCompany, firstName: John, lastName: Doe }
DN Expression: ${rdn[1]},ou=People,o=MyOrg
Result: uid=jsmith,ou=People,o=MyOrg

Source Event:  { eventID: uid=jsmith,ou=Sales,o=SuperCompany, firstName: John, lastName: Doe }
DN Expression: ${rdn[-1]},ou=People,o=MyOrg
Result: o=SuperCompany,ou=People,o=MyOrg

Source Event:   { eventID: uid=jsmith,ou=Sales,c=USA,o=SuperCompany, firstName: John, lastName: Doe }
DN Expression: ${rdn[2:3]},ou=People,o=MyOrg
Result: ou=Sales,c=USA,ou=People,o=MyOrg

Source Event:   { eventID: uid=jsmith,ou=Sales,c=USA,o=SuperCompany, firstName: John, lastName: Doe }
DN Expression: ${rdn[2:]},ou=People,o=MyOrg
Result: ou=Sales,c=USA,o=SuperCompany,ou=People,o=MyOrg

Source Event:  { eventID: uid=jsmith,ou=Sales,c=USA,o=SuperCompany, firstName: John, lastName: Doe }
DN Expression: ${rdn[:2]},ou=People,o=MyOrg
Result: uid=jsmith,ou=Sales,ou=People,o=MyOrg

Source Event:   { eventID: uid=jsmith,ou=Sales,o=SuperCompany, firstName: John, lastName: Doe }
DN Expression: displayName=${rdn_value[1]},ou=People,o=MyOr`

buildExpression

Creates a string containing variables that will be replaced with their value at runtime. This is the function to use if you want to concatenate input values.
Example: buildExpression("%givenName%@radiantlogic.com") --> [email protected]
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

concat

Concatenates the specified values into one value.
Example:
concat("one", "two", "three")` --> "one two three"
concat("Hello ", firstName, lastName) --> "Hello John Smith"

decodeBase64

Decodes each value of the attribute in base64.

decodeBase64WithoutPrefix

Decodes each value of the attribute in base64 without the {base64binary} prefix.

encodeBase64

Encodes each value of the attribute in base64.

escapeRdnValue

Escapes the characters in each value according to the rules specified in RFC 2253.
Example: escapeRdnValue("Novato,CA") --> "Novato,CA"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

filterMatchingRegex

Filters a list of value(s) keeping only the value(s) that match the given regular expression.
Examples: filterMatchingRegex("Novato", "N.") --> "Novato"
filterMatchingRegex("Chicago", "N.") --> [no value because Chicago does not match regex]

filterNotMatchingRegex

Filters a list of value(s) keeping only the value(s) that do NOT match the given regular expression.
Examples: filterNotMatchingRegex("Novato", "N.") --> [no value because Novato matches the regex]
filterNotMatchingRegex("Chicago", "N.") --> "Chicago"

filterOutEmpty

Removes any empty/blank/null value(s) from the list of value(s).

getParentDN

For each value, extracts the parent DN. This function assumes that each value is a DN.
Examples: getParentDN("uid=Jack, ou=Sales, ou=Company, o=vds", 0) --> "ou=Sales, ou=Company, o=vds"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

getRDN

For each value, extracts the RDN at the given index (index 0 is the deepest RDN). This function assumes that each value is a DN.
Examples: getRDN("uid=Jack, ou=Sales, ou=Company, o=vds", 0) --> "uid=Jack"
getRDN("uid=Jack, ou=Sales, ou=Company, o=vds", 2) --> "ou=Company"
getRDN("uid=Jack, ou=Sales, ou=Company, o=vds", 6) --> ""
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

getRDNValue

For each value, extracts the RDN value at the given index (index 0 is the deepest RDN). This function assumes that each value is a DN.
Example: getRDNValue("uid=Jack, ou=Sales, ou=Company, o=vds",0) --> "Jack"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

Head

Extracts a substring from each value considering the length of the substring from the beginning of the string.
Examples: head("Hello", 3) --> "Hel"
head("Hello",-3) --> ""
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

lookupAttribute

lookupAttribute(String dataSourceID, String baseDn, String filter, int scope, String attrName, int sizeLimit)
Returns the value(s) of a single attribute by performing an LDAP search.
Example: lookupAttribute("VDS", "o=companydirectory", "(uid=me)", 2, "mail", 1)
The lookup performs a sub-tree search against the VDS data source to find the mail attribute for user with uid=me.
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

lowercase

Converts each value to lowercase.
Examples: lowercase("Jack LogiC") --> "jack logic"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

remapDN

There are 3 different ways to use the remap function:
remapDN(originalDNattribute,dnTemplate) –Re-maps the original DN attribute based on a template. DN template is a representation of pattern to apply and it may contain a placeholder of %rdn and/or %dn. %rdn is the rdn value of the original DN. %dn is the value of original DN.
Example: remapDN(memberOf,"cn=%rdn,dc=my_groups") - %rdn is replaced with the rdn value extracted from the memberof attribute.
Example: remapDN(uniqueMember,"%dn,dc=my_users") adds a suffix of "dc=my_users" to the original dn.
remapDN(originalDNattribute,oldSuffix,newSuffix) – Changes the old suffix in the originalDNattribute to the newSuffix.
Example: remapDN(uniqueMember,"o=mycompany","dc=mycomp")
If a uniqueMember value was "uid=lcallahan,o=mycompany", the computed attribute value would be "uid=lcallahan,dc=mycorp".
remapDN(attr2remap,dataSourceID,externalBaseDN,scope,externalIdAttr) – Extracts the RDN value from the attr2remap attribute and does a lookup in a data source where externaldAttr=attr2remap.
Example: remapDN("uniqueMember","vds","o=proxy",1,"samAccountName")
If a uniqueMember value was "uid=lcallahan,o=mycompany", and the DN resulting from the lookup where sAMAccountName=lcallahan (in the vds data source, one level below o=proxy), was cn=lcallahan,dc=addomain1,dc=com, the computed attribute value would be "cn=lcallahan,dc=addomain1,dc=com".
Note: This is not compatible with other functions meaning you cannot take the result of this function and pass it as a parameter to another function.
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

replaceAll

Replaces all matches of the search string with a replacement string for each value. Ignore regex.
Examples: replaceAll("Value to modify. Other value.", "Value", "Variable") --> "Variable to modify. Other value."
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

replaceAllRegex

Replaces all matches of the search string with a replacement string for each value. Regex sensible.
Examples: replaceAllRegex("Value to modify. Other value from values.", "[vV]alue", "Variable") --> "Variable to modify. Other Variable from Variables."
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

replaceDnSuffix

For each DN value, replaces the given suffix with the given replacement value. This function expects that each value is a DN.
Examples: replaceDnSuffix("uid=1,ou=test,o=radiant", "o=radiant", "o=rli") --> "uid=1,ou=test,o=rli"
replaceDnSuffix("uid=1,dc=test,dc=com", "dc=test,dc=com", "dc=rli,dc=net") --> "uid=1,dc=rli,dc=net"

replaceFirst

Replaces the first match of the search string with a replacement string for each value. Ignore Regex.
Examples: replaceFirst("Value to modify. Other value from values.", "value", "variable") --> "Value to modify. Other variablefrom values."
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

replaceFirstRegex

Replaces the first match of the search string with a replacement string for each value. Regex sensible.
Examples: replaceFirstRegex("Value to modify. Other value from values.", "[vV]alue", "Variable") --> "Variable to modify. Other value from values."
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

replaceFromDictionary

Replaces the value(s) if a matching key-value pair is found in the given dictionary file. Some sample dictionary files are located here: {RLI_HOME}/ontology/normalization
Configuration: Select the input value (either a source attribute or local variable) and then select the dictionary file that contains the mapping. You can select from one of the default dictionary files, or select the New button to create your own. If you choose an existing dictionary file, you can select the Edit button to modify the contents. You can enter a default value to use in cases where there is no matching value found in the dictionary.
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

Substring

Extracts a substring from each value.
Examples: substring("Hello", 1) --> "ello"
substring("Hello", -2) --> "lo"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

substringAfter

Extracts a substring from each value. It retrieves the part after the first occurrence of the separator.
Examples: substringAfter("[email protected]", "@") --> "radiantlogic.com"
substringAfter("Radiant Logic", "i") --> "ant Logic"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

substringAfterLast

Extracts a substring from each value. It retrieves the part after the last occurrence of the separator.
Examples: substringAfterLast("[email protected]", "radiant") --> "logic.com"
substringAfterLast("Radiant Logic", "a") --> "nt Logic"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

substringBefore

Extracts a substring from each value. It retrieves the part before the first occurrence of the separator.
Examples: substringBefore("[email protected]", "@") --> "Jack"
substringBefore("Radiant Logic", "i") --> "Rad"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

substringBeforeLast

Extracts a substring from each value. It retrieves the part before the last occurrence of the separator.
Examples: substringBeforeLast("[email protected]", "radiant") --> "radiantL@"
substringBeforeLast("Radiant Logic", "i") --> "Radiant Log"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

substringLength

Extracts a substring from each value considering the start position and the length of the substring.
Examples: substringLength("Hello", 1, 4) --> "ello"
substringLength("Hello",-3, 3) --> "llo"
substringLength("Hello",-3, -2) --> "He"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

substringStartEnd

Extracts a substring from each value considering the start and end positions.
Examples: substringStartEnd("Hello", 1, 4) --> "ell"
substringStartEnd("Hello",-3, -1) --> "ll"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

Tail

Extracts a substring from each value considering the length of the substring from the end of the string.
Examples: tail("Hello", 3) --> "llo"
tail("Hello",-3) --> ""
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

Trim

Removes any leading and trailing whitespace from each value.
Examples: trim(" value ") --> "value"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.

Uppercase

Converts each value to uppercase.
Examples: uppercase("Jack Logic") --> "JACK LOGIC"
For every value passed to this function, there is a check to see if the value starts with String {base64binary}, indicating that the value is base64 encoded. If the value(s) are base64 encoded, they are first decoded, then the function is applied to them, and finally the result is re-encoded in base64 and returned.