Edit

Share via

Microsoft Entra Connect Sync: Functions Reference

  • Article

In Microsoft Entra Connect, functions are used to manipulate an attribute value during synchronization.
The Syntax of the functions is expressed using the following format:
<output type> FunctionName(<input type> <position name>, ..)

If a function is overloaded and accepts multiple syntaxes, all valid syntaxes are listed.
The functions are strongly typed and they verify that the type passed in matches the documented type.
If the type does not match, an error is thrown.

The types are expressed with the following syntax:

  • bin – Binary
  • bool – Boolean
  • dt – UTC Date/Time
  • enum – Enumeration of known constants
  • exp – Expression, which is expected to evaluate to a Boolean
  • mvbin – Multi-Valued Binary
  • mvstr – Multi-Valued String
  • mvref – Multi-Valued Reference
  • num – Numeric
  • ref – Reference
  • str – String
  • var – A variant of (almost) any other type
  • void – doesn’t return a value

The functions with the types mvbin, mvstr, and mvref can only work on multi-valued attributes. Functions with bin, str, and ref work on both single-valued and multi-valued attributes.

Functions Reference

BitAnd

Description:
The BitAnd function sets specified bits on a value.

Syntax:
num BitAnd(num value1, num value2)

  • value1, value2: numeric values that should be AND’ed together

Remarks:
This function converts both parameters to the binary representation and sets a bit to:

  • 0 - if one or both of the corresponding bits in value1 and value2 are 0
  • 1 - if both of the corresponding bits are 1.

In other words, it returns 0 in all cases except when the corresponding bits of both parameters are 1.

Example:
BitAnd(&HF, &HF7)
Returns 7 because hexadecimal "F" AND "F7" evaluate to this value.

BitOr

Description:
The BitOr function sets specified bits on a value.

Syntax:
num BitOr(num value1, num value2)

  • value1, value2: numeric values that should be OR’ed together

Remarks:
This function converts both parameters to the binary representation and sets a bit to 1 if one or both of the corresponding bits in mask and flag are 1, and to 0 if both of the corresponding bits are 0. In other words, it returns 1 in all cases except where the corresponding bits of both parameters are 0.

CBool

Description:
The CBool function returns a Boolean based on the evaluated expression

Syntax:
bool CBool(exp Expression)

Remarks:
If the expression evaluates to a non-zero value, then CBool returns True, else it returns False.

Example:
CBool([attrib1] = [attrib2])

Returns True if both attributes have the same value.

CDate

Description:
The CDate function returns a UTC DateTime from a string. DateTime is not a native attribute type in Sync but is used by some functions.

Syntax:
dt CDate(str value)

  • Value: A string with a date, time, and optionally time zone

Remarks:
The returned string is always in UTC.

Example:
CDate([employeeStartTime])
Returns a DateTime based on the employee’s start time

CDate("2013-01-10 4:00 PM -8")
Returns a DateTime representing "2013-01-11 12:00 AM"

CertExtensionOids

Description:
Returns the Oid values of all the critical extensions of a certificate object.

Syntax:
mvstr CertExtensionOids(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertFormat

Description:
Returns the name of the format of this X.509v3 certificate.

Syntax:
str CertFormat(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertFriendlyName

Description:
Returns the associated alias for a certificate.

Syntax:
str CertFriendlyName(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertHashString

Description:
Returns the SHA1 hash value for the X.509v3 certificate as a hexadecimal string.

Syntax:
str CertHashString(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertIssuer

Description:
Returns the name of the certificate authority that issued the X.509v3 certificate.

Syntax:
str CertIssuer(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertIssuerDN

Description:
Returns the distinguished name of the certificate issuer.

Syntax:
str CertIssuerDN(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertIssuerOid

Description:
Returns the Oid of the certificate issuer.

Syntax:
str CertIssuerOid(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertKeyAlgorithm

Description:
Returns the key algorithm information for this X.509v3 certificate as a string.

Syntax:
str CertKeyAlgorithm(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertKeyAlgorithmParams

Description:
Returns the key algorithm parameters for the X.509v3 certificate as a hexadecimal string.

Syntax:
str CertKeyAlgorithm(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertNameInfo

Description:
Returns the subject and issuer names from a certificate.

Syntax:
str CertNameInfo(binary certificateRawData, str x509NameType, bool includesIssuerName)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.
  • X509NameType: The X509NameType value for the subject.
  • includesIssuerName: true to include the issuer name; otherwise, false.

CertNotAfter

Description:
Returns the date in local time after which a certificate is no longer valid.

Syntax:
dt CertNotAfter(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertNotBefore

Description:
Returns the date in local time on which a certificate becomes valid.

Syntax:
dt CertNotBefore(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertPublicKeyOid

Description:
Returns the Oid of the public key for the X.509v3 certificate.

Syntax:
str CertKeyAlgorithm(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertPublicKeyParametersOid

Description:
Returns the Oid of the public key parameters for the X.509v3 certificate.

Syntax:
str CertPublicKeyParametersOid(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertSerialNumber

Description:
Returns the serial number of the X.509v3 certificate.

Syntax:
str CertSerialNumber(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertSignatureAlgorithmOid

Description:
Returns the Oid of the algorithm used to create the signature of a certificate.

Syntax:
str CertSignatureAlgorithmOid(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertSubject

Description:
Gets the subject distinguished name from a certificate.

Syntax:
str CertSubject(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertSubjectNameDN

Description:
Returns the subject distinguished name from a certificate.

Syntax:
str CertSubjectNameDN(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertSubjectNameOid

Description:
Returns the Oid of the subject name from a certificate.

Syntax:
str CertSubjectNameOid(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertThumbprint

Description:
Returns the thumbprint of a certificate.

Syntax:
str CertThumbprint(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CertVersion

Description:
Returns the X.509 format version of a certificate.

Syntax:
str CertThumbprint(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

CGuid

Description:
The CGuid function converts the string representation of a GUID to its binary representation.

Syntax:
bin CGuid(str GUID)

  • A String formatted in this pattern: 00001111-aaaa-2222-bbbb-3333cccc4444 or {00001111-aaaa-2222-bbbb-3333cccc4444}

Contains

Description:
The Contains function finds a string inside a multi-valued attribute

Syntax:
num Contains (mvstring attribute, str search) - case-sensitive
num Contains (mvstring attribute, str search, enum Casetype)
num Contains (mvref attribute, str search) - case-sensitive

  • attribute: the multi-valued attribute to search.
  • search: string to find in the attribute.
  • Casetype: CaseInsensitive or CaseSensitive.

Returns index in the multi-valued attribute where the string was found. 0 is returned if the string is not found.

Remarks:
For multi-valued string attributes, the search finds substrings in the values.
For reference attributes, the searched string must exactly match the value to be considered a match.

Example:
IIF(Contains([proxyAddresses],"SMTP:")>0,[proxyAddresses],Error("No primary SMTP address found."))
If the proxyAddresses attribute has a primary email address (indicated by uppercase "SMTP:"), then return the proxyAddress attribute, else return an error.

ConvertFromBase64

Description:
The ConvertFromBase64 function converts the specified base64 encoded value to a regular string.

Syntax:
str ConvertFromBase64(str source) - assumes Unicode for encoding
str ConvertFromBase64(str source, enum Encoding)

  • source: Base64 encoded string
  • Encoding: Unicode, ASCII, UTF8

Example
ConvertFromBase64("SABlAGwAbABvACAAdwBvAHIAbABkACEA")
ConvertFromBase64("SGVsbG8gd29ybGQh", UTF8)

Both examples return "Hello world!"

ConvertFromUTF8Hex

Description:
The ConvertFromUTF8Hex function converts the specified UTF8 Hex encoded value to a string.

Syntax:
str ConvertFromUTF8Hex(str source)

  • source: UTF8 2-byte encoded sting

Remarks:
The difference between this function and ConvertFromBase64([],UTF8) in that the result is friendly for the DN attribute.
This format is used by Microsoft Entra ID as DN.

Example:
ConvertFromUTF8Hex("48656C6C6F20776F726C6421")
Returns "Hello world!"

ConvertToBase64

Description:
The ConvertToBase64 function converts a string to a Unicode base64 string.
Converts the value of an array of integers to its equivalent string representation that is encoded with base-64 digits.

Syntax:
str ConvertToBase64(str source)

Example:
ConvertToBase64("Hello world!")
Returns "SABlAGwAbABvACAAdwBvAHIAbABkACEA"

ConvertToUTF8Hex

Description:
The ConvertToUTF8Hex function converts a string to a UTF8 Hex encoded value.

Syntax:
str ConvertToUTF8Hex(str source)

Remarks:
The output format of this function is used by Microsoft Entra ID as DN attribute format.

Example:
ConvertToUTF8Hex("Hello world!")
Returns 48656C6C6F20776F726C6421

Count

Description:
The Count function returns the number of elements in a multi-valued attribute

Syntax:
num Count(mvstr attribute)

CNum

Description:
The CNum function takes a string and returns a numeric data type.

Syntax:
num CNum(str value)

CRef

Description:
Converts a string to a reference attribute

Syntax:
ref CRef(str value)

Example:
CRef("CN=LC Services,CN=Microsoft,CN=lcspool01,CN=Pools,CN=RTC Service," & %Forest.LDAP%)

CStr

Description:
The CStr function converts to a string data type.

Syntax:
str CStr(num value)
str CStr(ref value)
str CStr(bool value)

  • value: Can be a numeric value, reference attribute, or Boolean.

Example:
CStr([dn])
Could return "cn=Joe,dc=contoso,dc=com"

DateAdd

Description:
Returns a Date containing a date to which a specified time interval has been added.

Syntax:
dt DateAdd(str interval, num value, dt date)

  • interval: String expression that is the interval of time you want to add. The string must have one of the following values:
    • yyyy Year
    • q Quarter
    • m Month
    • y Day of year
    • d Day
    • w Weekday
    • ww Week
    • h Hour
    • n Minute
    • s Second
  • value: The number of units you want to add. It can be positive (to get dates in the future) or negative (to get dates in the past).
  • date: DateTime representing date to which the interval is added.

Example:
DateAdd("m", 3, CDate("2001-01-01"))
Adds 3 months and returns a DateTime representing "2001-04-01".

DateFromNum

Description:
The DateFromNum function converts a value in AD’s date format to a DateTime type.

Syntax:
dt DateFromNum(num value)

Example:
DateFromNum([lastLogonTimestamp])
DateFromNum(129699324000000000)
Returns a DateTime representing 2012-01-01 23:00:00

DNComponent

Description:
The DNComponent function returns the value of a specified DN component going from left.

Syntax:
str DNComponent(ref dn, num ComponentNumber)

  • dn: the reference attribute to interpret
  • ComponentNumber: The component in the DN to return

Example:
DNComponent(CRef([dn]),1)
If dn is "cn=Joe,ou=…," it returns Joe

DNComponentRev

Description:
The DNComponentRev function returns the value of a specified DN component going from right (the end).

Syntax:
str DNComponentRev(ref dn, num ComponentNumber)
str DNComponentRev(ref dn, num ComponentNumber, enum Options)

  • dn: the reference attribute to interpret
  • ComponentNumber - The component in the DN to return
  • Options: DC – Ignore all components with "dc="

Example:
If dn is "cn=Joe,ou=Atlanta,ou=GA,ou=US, dc=contoso,dc=com" then
DNComponentRev(CRef([dn]),3)
DNComponentRev(CRef([dn]),1,"DC")
Both return US.

Error

Description:
The Error function is used to return a custom error.

Syntax:
void Error(str ErrorMessage)

Example:
IIF(IsPresent([accountName]),[accountName],Error("AccountName is required"))
If the attribute accountName is not present, throw an error on the object.

EscapeDNComponent

Description:
The EscapeDNComponent function takes one component of a DN and escapes it so it can be represented in LDAP.

Syntax:
str EscapeDNComponent(str value)

Example:
EscapeDNComponent("cn=" & [displayName]) & "," & %ForestLDAP%)
Makes sure the object can be created in an LDAP directory even if the displayName attribute has characters that must be escaped in LDAP.

FormatDateTime

Description:
The FormatDateTime function is used to format a DateTime to a string with a specified format

Syntax:
str FormatDateTime(dt value, str format)

  • value: a value in the DateTime format
  • format: a string representing the format to convert to.

Remarks:
The possible values for the format can be found here: Custom date and time formats for the FORMAT function.

Example:

FormatDateTime(CDate("12/25/2007"),"yyyy-MM-dd")
Results in "2007-12-25".

FormatDateTime(DateFromNum([pwdLastSet]),"yyyyMMddHHmmss.0Z")
Can result in "20140905081453.0Z"

Guid

Description:
The function Guid generates a new random GUID

Syntax:
str Guid()

IIF

Description:
The IIF function returns one of a set of possible values based on a specified condition.

Syntax:
var IIF(exp condition, var valueIfTrue, var valueIfFalse)

  • condition: any value or expression that can be evaluated to true or false.
  • valueIfTrue: If the condition evaluates to true, the returned value.
  • valueIfFalse: If the condition evaluates to false, the returned value.

Example:
IIF([employeeType]="Intern","t-" & [alias],[alias])
If the user is an intern, returns the alias of a user with "t-" added to the beginning of it, else returns the user’s alias as is.

InStr

Description:
The InStr function finds the first occurrence of a substring in a string

Syntax:

num InStr(str stringcheck, str stringmatch)
num InStr(str stringcheck, str stringmatch, num start)
num InStr(str stringcheck, str stringmatch, num start, enum compare)

  • stringcheck: string to be searched
  • stringmatch: string to be found
  • start: starting position to find the substring
  • compare: vbTextCompare or vbBinaryCompare

Remarks:
Returns the position where the substring was found or 0 if not found.

Example:
InStr("The quick brown fox","quick")
Evaluates to 5

InStr("repEated","e",3,vbBinaryCompare)
Evaluates to 7

InStrRev

Description:
The InStrRev function finds the last occurrence of a substring in a string

Syntax:
num InstrRev(str stringcheck, str stringmatch)
num InstrRev(str stringcheck, str stringmatch, num start)
num InstrRev(str stringcheck, str stringmatch, num start, enum compare)

  • stringcheck: string to be searched
  • stringmatch: string to be found
  • start: starting position to find the substring
  • compare: vbTextCompare or vbBinaryCompare

Remarks:
Returns the position where the substring was found or 0 if not found.

Example:
InStrRev("abbcdbbbef","bb")
Returns 7

IsBitSet

Description:
The function IsBitSet Tests if a bit is set or not

Syntax:
bool IsBitSet(num value, num flag)

  • value: a numeric value that is evaluated.flag: a numeric value that has the bit to be evaluated

Example:
IsBitSet(&HF,4)
Returns True because bit "4" is set in the hexadecimal value "F"

IsDate

Description:
If the expression can be evaluates as a DateTime type, then the IsDate function evaluates to True.

Syntax:
bool IsDate(var Expression)

Remarks:
Used to determine if CDate() can be successful.

IsCert

Description:
Returns true if the raw data can be serialized into .NET X509Certificate2 certificate object.

Syntax:
bool CertThumbprint(binary certificateRawData)

  • certificateRawData: Byte array representation of an X.509 certificate. The byte array can be binary (DER) encoded or Base64-encoded X.509 data.

IsEmpty

Description:
If the attribute is present in the CS or MV but evaluates to an empty string, then the IsEmpty function evaluates to True.

Syntax:
bool IsEmpty(var Expression)

IsGuid

Description:
If the string could be converted to a GUID, then the IsGuid function evaluated to true.

Syntax:
bool IsGuid(str GUID)

Remarks:
A GUID is defined as a string following one of these patterns: 00001111-aaaa-2222-bbbb-3333cccc4444 or {00001111-aaaa-2222-bbbb-3333cccc4444}

Used to determine if CGuid() can be successful.

Example:
IIF(IsGuid([strAttribute]),CGuid([strAttribute]),NULL)
If the StrAttribute has a GUID format, return a binary representation, otherwise return a Null.

IsNull

Description:
If the expression evaluates to Null, then the IsNull function returns true.

Syntax:
bool IsNull(var Expression)

Remarks:
For an attribute, a Null is expressed by the absence of the attribute.

Example:
IsNull([displayName])
Returns True if the attribute is not present in the CS or MV.

IsNullOrEmpty

Description:
If the expression is null or an empty string, then the IsNullOrEmpty function returns true.

Syntax:
bool IsNullOrEmpty(var Expression)

Remarks:
For an attribute, this would evaluate to True if the attribute is absent or is present but is an empty string.
The inverse of this function is named IsPresent.

Example:
IsNullOrEmpty([displayName])
Returns True if the attribute is not present or is an empty string in the CS or MV.

IsNumeric

Description:
The IsNumeric function returns a Boolean value indicating whether an expression can be evaluated as a number type.

Syntax:
bool IsNumeric(var Expression)

Remarks:
Used to determine if CNum() can be successful to parse the expression.

IsString

Description:
If the expression can be evaluated to a string type, then the IsString function evaluates to True.

Syntax:
bool IsString(var expression)

Remarks:
Used to determine if CStr() can be successful to parse the expression.

IsPresent

Description:
If the expression evaluates to a string that is not Null and is not empty, then the IsPresent function returns true.

Syntax:
bool IsPresent(var expression)

Remarks:
The inverse of this function is named IsNullOrEmpty.

Example:
Switch(IsPresent([directManager]),[directManager], IsPresent([skiplevelManager]),[skiplevelManager], IsPresent([director]),[director])

Item

Description:
The Item function returns one item from a multi-valued string/attribute.

Syntax:
var Item(mvstr attribute, num index)

  • attribute: multi-valued attribute
  • index: index to an item in the multi-valued string.

Remarks:
The Item function is useful together with the Contains function since the latter function returns the index to an item in the multi-valued attribute.

Throws an error if index is out of bounds.

Example:
Mid(Item([proxyAddresses],Contains([proxyAddresses], "SMTP:")),6)
Returns the primary email address.

ItemOrNull

Description:
The ItemOrNull function returns one item from a multi-valued string/attribute.

Syntax:
var ItemOrNull(mvstr attribute, num index)

  • attribute: multi-valued attribute
  • index: index to an item in the multi-valued string.

Remarks:
The ItemOrNull function is useful together with the Contains function since the latter function returns the index to an item in the multi-valued attribute.

If index is out of bounds, then returns a Null value.

Join

Description:
The Join function takes a multi-valued string and returns a single-valued string with specified separator inserted between each item.

Syntax:
str Join(mvstr attribute)
str Join(mvstr attribute, str Delimiter)

  • attribute: Multi-valued attribute containing strings to be joined.
  • delimiter: Any string, used to separate the substrings in the returned string. If omitted, the space character (" ") is used. If Delimiter is a zero-length string ("") or Nothing, all items in the list are concatenated with no delimiters.

Remarks
There is parity between the Join and Split functions. The Join function takes an array of strings and joins them using a delimiter string, to return a single string. The Split function takes a string and separates it at the delimiter, to return an array of strings. However, a key difference is that Join can concatenate strings with any delimiter string, Split can only separate strings using a single character delimiter.

Example:
Join([proxyAddresses],",")
Could return: "SMTP:john.doe@contoso.com,smtp:jd@contoso.com"

LCase

Description:
The LCase function converts all characters in a string to lower case.

Syntax:
str LCase(str value)

Example:
LCase("TeSt")
Returns "test".

Left

Description:
The Left function returns a specified number of characters from the left of a string.

Syntax:
str Left(str string, num NumChars)

  • string: the string to return characters from
  • NumChars: a number identifying the number of characters to return from the beginning (left) of string

Remarks:
A string containing the first numChars characters in string:

  • If numChars = 0, return empty string.
  • If numChars < 0, return input string.
  • If string is null, return empty string.

If string contains fewer characters than the number specified in numChars, a string identical to string (that is, containing all characters in parameter 1) is returned.

Example:
Left("John Doe", 3)
Returns "Joh".

Len

Description:
The Len function returns number of characters in a string.

Syntax:
num Len(str value)

Example:
Len("John Doe")
Returns 8

LTrim

Description:
The LTrim function removes leading white spaces from a string.

Syntax:
str LTrim(str value)

Example:
LTrim(" Test ")
Returns "Test "

Mid

Description:
The Mid function returns a specified number of characters from a specified position in a string.

Syntax:
str Mid(str string, num start, num NumChars)

  • string: the string to return characters from
  • start: a number identifying the starting position in string to return characters from
  • NumChars: a number identifying the number of characters to return from position in string

Remarks:
Return numChars characters starting from position start in string.
A string containing numChars characters from position start in string:

  • If numChars = 0, return empty string.
  • If numChars < 0, return input string.
  • If start > the length of string, return input string.
  • If start <= 0, return input string.
  • If string is null, return empty string.

If there are not numChar characters remaining in string from position start, as many characters as possible are returned.

Example:
Mid("John Doe", 3, 5)
Returns "hn Do".

Mid("John Doe", 6, 999)
Returns "Doe"

Now

Description:
The Now function returns a DateTime specifying the current date and time, according to your computer's system date and time.

Syntax:
dt Now()

NumFromDate

Description:
The NumFromDate function returns a date in AD’s date format.

Syntax:
num NumFromDate(dt value)

Example:
NumFromDate(CDate("2012-01-01 23:00:00"))
Returns 129699324000000000

PadLeft

Description:
The PadLeft function left-pads a string to a specified length using a provided padding character.

Syntax:
str PadLeft(str string, num length, str padCharacter)

  • string: the string to pad.
  • length: An integer representing the desired length of string.
  • padCharacter: A string consisting of a single character to use as the pad character

Remarks:

  • If the length of string is less than length, then padCharacter is repeatedly appended to the beginning (left) of string until it has a length equal to length.
  • PadCharacter can be a space character, but it cannot be a null value.
  • If the length of string is equal to or greater than length, string is returned unchanged.
  • If string has a length greater than or equal to length, a string identical to string is returned.
  • If the length of string is less than length, then a new string of the desired length is returned containing string padded with a padCharacter.
  • If string is null, the function returns an empty string.

Example:
PadLeft("User", 10, "0")
Returns "000000User".

PadRight

Description:
The PadRight function right-pads a string to a specified length using a provided padding character.

Syntax:
str PadRight(str string, num length, str padCharacter)

  • string: the string to pad.
  • length: An integer representing the desired length of string.
  • padCharacter: A string consisting of a single character to use as the pad character

Remarks:

  • If the length of string is less than length, then padCharacter is repeatedly appended to the end (right) of string until it has a length equal to length.
  • padCharacter can be a space character, but it cannot be a null value.
  • If the length of string is equal to or greater than length, string is returned unchanged.
  • If string has a length greater than or equal to length, a string identical to string is returned.
  • If the length of string is less than length, then a new string of the desired length is returned containing string padded with a padCharacter.
  • If string is null, the function returns an empty string.

Example:
PadRight("User", 10, "0")
Returns "User000000".

PCase

Description:
The PCase function converts the first character of each space delimited word in a string to upper case, and all other characters are converted to lower case.

Syntax:
String PCase(string)

Remarks:

  • This function does not currently provide proper casing to convert a word that is entirely uppercase, such as an acronym.

Example:
PCase("TEsT")
Returns "Test".

PCase(LCase("TEST"))
Returns "Test"

RandomNum

Description:
The RandomNum function returns a random number between a specified interval.

Syntax:
num RandomNum(num start, num end)

  • start: a number identifying the lower limit of the random value to generate
  • end: a number identifying the upper limit of the random value to generate

Example:
Random(100,999)
Can return 734.

RemoveDuplicates

Description:
The RemoveDuplicates function takes a multi-valued string and make sure each value is unique.

Syntax:
mvstr RemoveDuplicates(mvstr attribute)

Example:
RemoveDuplicates([proxyAddresses])
Returns a sanitized proxyAddress attribute where all duplicate values have been removed.

Replace

Description:
The Replace function replaces all occurrences of a string to another string.

Syntax:
str Replace(str string, str OldValue, str NewValue)

  • string: A string to replace values in.
  • OldValue: The string to search for and to replace.
  • NewValue: The string to replace to.

Remarks:
The function recognizes the following special monikers:

  • \n – New Line
  • \r – Carriage Return
  • \t – Tab

Example:
Replace([address],"\r\n",", ")
Replaces CRLF with a comma and space, and could lead to "One Microsoft Way, Redmond, WA, USA"

ReplaceChars

Description:
The ReplaceChars function replaces all occurrences of characters found in the ReplacePattern string.

Syntax:
str ReplaceChars(str string, str ReplacePattern)

  • string: A string to replace characters in.
  • ReplacePattern: a string containing a dictionary with characters to replace.

The format is {source1}:{target1},{source2}:{target2},{sourceN},{targetN} where source is the character to find and target the string to replace with.

Remarks:

  • The function takes each occurrence of defined sources and replaces them with the targets.
  • The source must be exactly one (Unicode) character.
  • The source cannot be empty or longer than one character (parsing error).
  • The target can have multiple characters, for example ö:oe, β:ss.
  • The target can be empty indicating that the character should be removed.
  • The source is case-sensitive and must be an exact match.
  • The , (comma) and : (colon) are reserved characters and cannot be replaced using this function.
  • Spaces and other white characters in the ReplacePattern string are ignored.

Example:
%ReplaceString% = ’:,Å:A,Ä:A,Ö:O,å:a,ä:a,ö,o

ReplaceChars("Räksmörgås",%ReplaceString%)
Returns Raksmorgas

ReplaceChars("O’Neil",%ReplaceString%)
Returns "ONeil", the single tick is defined to be removed.

Description:
The Right function returns a specified number of characters from the right (end) of a string.

Syntax:
str Right(str string, num NumChars)

  • string: the string to return characters from
  • NumChars: a number identifying the number of characters to return from the end (right) of string

Remarks:
NumChars characters are returned from the last position of string.

A string containing the last numChars characters in string:

  • If numChars = 0, return empty string.
  • If numChars < 0, return input string.
  • If string is null, return empty string.

If string contains fewer characters than the number specified in NumChars, a string identical to string is returned.

Example:
Right("John Doe", 3)
Returns "Doe".

RTrim

Description:
The RTrim function removes trailing white spaces from a string.

Syntax:
str RTrim(str value)

Example:
RTrim(" Test ")
Returns " Test".

Select

Description:
Process all values in a multi-valued attribute (or output of an expression) based on function specified.

Syntax:
mvattr Select(variable item, mvattr attribute, func function)
mvattr Select(variable item, exp expression, func function)

  • item: Represents an element in the multi-valued attribute
  • attribute: the multi-valued attribute
  • expression: an expression that returns a collection of values
  • condition: any function that can process an item in the attribute

Examples:
Select($item,[otherPhone],Replace($item,"-",""))
Return all the values in the multi-valued attribute otherPhone after hyphens (-) have been removed.

Split

Description:
The Split function takes a string separated with a delimiter and makes it a multi-valued string.

Syntax:
mvstr Split(str value, str delimiter)
mvstr Split(str value, str delimiter, num limit)

  • value: the string with a delimiter character to separate.
  • delimiter: single character to be used as the delimiter.
  • limit: maximum number of values that can return.

Example:
Split("SMTP:john.doe@contoso.com,smtp:jd@contoso.com",",")
Returns a multi-valued string with 2 elements useful for the proxyAddress attribute.

StringFromGuid

Description:
The StringFromGuid function takes a binary GUID and converts it to a string

Syntax:
str StringFromGuid(bin GUID)

StringFromSid

Description:
The StringFromSid function converts a byte array containing a security identifier to a string.

Syntax:
str StringFromSid(bin ObjectSID)

Switch

Description:
The Switch function is used to return a single value based on evaluated conditions.

Syntax:
var Switch(exp expr1, var value1[, exp expr2, var value … [, exp expr, var valueN]])

  • expr: Variant expression you want to evaluate.
  • value: Value to be returned if the corresponding expression is True.

Remarks:
The Switch function argument list consists of pairs of expressions and values. The expressions are evaluated from left to right, and the value associated with the first expression to evaluate to True is returned. If the parts aren't properly paired, a run-time error occurs.

For example, if expr1 is True, Switch returns value1. If expr-1 is False, but expr-2 is True, Switch returns value-2, and so on.

Switch returns a Nothing if:

  • None of the expressions are True.
  • The first True expression has a corresponding value that is Null.

Switch evaluates all expressions, even though it returns only one of them. For this reason, you should watch for undesirable side effects. For example, if the evaluation of any expression results in a division by zero error, an error occurs.

Value can also be the Error function, which would return a custom string.

Example:
Switch([city] = "London", "English", [city] = "Rome", "Italian", [city] = "Paris", "French", True, Error("Unknown city"))
Returns the language spoken in some major cities, otherwise returns an Error.

Trim

Description:
The Trim function removes leading and trailing white spaces from a string.

Syntax:
str Trim(str value)

Example:
Trim(" Test ")
Returns "Test".

Trim([proxyAddresses])
Removes leading and trailing spaces for each value in the proxyAddress attribute.

UCase

Description:
The UCase function converts all characters in a string to upper case.

Syntax:
str UCase(str string)

Example:
UCase("TeSt")
Returns "TEST".

Where

Description:
Returns a subset of values from a multi-valued attribute (or output of an expression) based on specific condition.

Syntax:
mvattr Where(variable item, mvattr attribute, exp condition)
mvattr Where(variable item, exp expression, exp condition)

  • item: Represents an element in the multi-valued attribute
  • attribute: the multi-valued attribute
  • condition: any expression that can be evaluated to true or false
  • expression: an expression that returns a collection of values

Example:
Where($item,[userCertificate],CertNotAfter($item)>Now())
Return the certificate values in the multi-valued attribute userCertificate which aren’t expired.

With

Description:
The With function provides a way to simplify a complex expression by using a variable to represent a subexpression which appears one or more times in the complex expression.

Syntax: With(var variable, exp subExpression, exp complexExpression)

  • variable: Represents the subexpression.
  • subExpression: subexpression represented by variable.
  • complexExpression: A complex expression.

Example:
With($unExpiredCerts,Where($item,[userCertificate],CertNotAfter($item)>Now()),IIF(Count($unExpiredCerts)>0,$unExpiredCerts,NULL))
Is functionally equivalent to:
IIF (Count(Where($item,[userCertificate],CertNotAfter($item)>Now()))>0, Where($item,[userCertificate],CertNotAfter($item)>Now()),NULL)
Which returns only unexpired certificate values in the userCertificate attribute.

Word

Description:
The Word function returns a word contained within a string, based on parameters describing the delimiters to use and the word number to return.

Syntax:
str Word(str string, num WordNumber, str delimiters)

  • string: the string to return a word from.
  • WordNumber: a number identifying which word number should return.
  • delimiters: a string representing the delimiter(s) that should be used to identify words

Remarks:
Each string of characters in string separated by the one of the characters in delimiters are identified as words:

  • If number < 1, returns empty string.
  • If string is null, returns empty string.

If string contains less than number words, or string does not contain any words identified by delimiters, an empty string is returned.

Example:
Word("The quick brown fox",3," ")
Returns "brown"

Word("This,string!has&many separators",3,",!&#")
Would return "has"

Additional Resources