Mapping Rule Built-ins for Single-Valued Fields - RapidIdentity Platform Documentation

RapidIdentity Platform Documentation

Solution
Application
Content Type
Technical Documentation
Utilities & Services
ft:locale
en-US

Mapping rule built-ins work similarly to methods in object-oriented programming. Consider the following simple mapping:

let idautoPersonBirthdate = dob

This mapping works when the source format matches the target format. When the source provides dob values such as 10/31/2002 (October 31, 2002) and RapidIdentity expects 2002-10-31, a built-in converts the value:

let idautoPersonBirthdate = dob.convertDateFrom("MM/dd/yyyy")
This rule populates idautoPersonBirthdate by taking the source dob field and reformatting it into RapidIdentity's standard date format using the descriptor MM/dd/yyyy.
Built-in NameArgumentsOutputsExample
calculateGradYear(Optional) Cut-off month for school year rollover. The default is 6 for June.Projected graduation year based on the input grade, in CEDS formatgrade.calculateGradYear()
containsTextThe substring to look fortrue if the field contains the substring, false otherwiseif (@ou.containsText("OU=Students,")) "staff"
convertDateFromInput date pattern (Java DateTimeFormatter)Converts a date string to RapidIdentity standard format (yyyy-MM-dd)dob.convertDateFrom("MM/dd/yyyy")
convertDateTimeFromInput date and time pattern (Java DateTimeFormatter)Converts a date and time string to RapidIdentity standard format (yyyyMMddhhmmssZ)termTimestamp.convertDateTimeFrom("MM/dd/yyyy hh:mm")
convertDateToOutput date pattern (Java DateTimeFormatter)Converts a RapidIdentity standardized date (yyyy-MM-dd) to the specified formatidautoPersonBirthdate.convertDateTo("M/d/yyyy")
convertDateTimeToOutput date and time pattern (Java DateTimeFormatter)Converts a RapidIdentity standardized date and time to the specified formatidautoPersonEndDate.convertDateTimeTo("MM/dd/yyyy")
convertDateInput date pattern, output date patternDate string in the output format specifieddob.convertDate("M/d/yyyy", "MMddyyyy")
convertDateTimeInput date and time pattern, output date and time patternDate and time string in the output format specifiedtermTimestamp.convertDateTime("MM/dd/yyyy hh:mm", "MMddyyyy hh:mm")
endsWithThe suffix to look fortrue if the field ends with the suffix, false otherwiseif (jobTitle.endsWith("Teacher")) "teacher"
getWordIndex of word; (optional) delimiter stringWord at the index in the delimited input, or an empty string if out of boundsfirstNames.getWord(0); mail.getWord(0, "@")
isEmptyNonetrue if the field is emptygivenName.isEmpty()
isNotEmptyNonetrue if the field is not emptygivenName.isNotEmpty()
lengthNoneThe length of the inputfirstNames.length
lowercaseNoneInput with all characters lowercaseemail.lowercase()
replaceString to replace, replacement string; (optional) true for case-insensitiveInput with the replacement appliedusername.replace("@identityautomation.com", "")
startsWithThe prefix to look fortrue if the field starts with the prefix, false otherwiseif (jobTitle.startsWith("IT")) "admin"
stripDiacriticalsNoneInput with no diacriticalsgivenName.stripDiacriticals()
stripQualifiersNoneInput with no generational qualifiers or titles after a commafullName.stripQualifiers()
stripSpacesNoneInput with all negative space removed (spaces, tabs, and newlines)lastName.stripSpaces()
stripSpecialCharactersNoneInput with no special charactersgivenName.stripSpecialCharacters()
substringstartIndex (inclusive); (optional) endIndex (exclusive)Substring from startIndex to endIndex. Use take or takeLast if indices can be out of bounds.studentId.substring(1)
takeLength of prefix to extractPrefix of the input. Safe even if the input is shorter than the specified length.username.take(20)
takeLastLength of suffix to extractSuffix of the input. Safe even if the input is shorter than the specified length.studentId.takeLast(10)
titleCaseNoneInput with all words in title casedisplayName.titleCase()
uppercaseNoneInput with all characters uppercaseusername.uppercase()