HashString

Applies cryptographic hashing algorithms to text strings. This enables you to create encrypted strings you can use to create tokens for APIs and to detect data changes. By default, hashed strings are converted to hex format and use UTF-8 encoding.

Syntax

HashString(textValue, hashingAlgorithm, isBase64Result)

Enabled For

For a description of the business object categories, see Notes on "Enabled For".

Business Object Category	Yes/No
Business Rules: Before-Save Rules	Yes
Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load)	Yes1
Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load)	Yes
Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load)	Yes1
Business Rules: Editing Rules	Yes2
Business Rules: Initialization Rules	Yes
Business Rules: Read Only Rules	No
Business Rules: Required Rules	Yes2
Business Rules: Validation Rules	Yes
Client Expressions	No
Object Permissions	No
Services	No
LDAP	No
Mobile	No
Quick Actions (except UI Quick Actions)	Yes
UI Quick Actions	No
Reports	Yes
Search/Dashboard without field references	No
Search/Dashboard with field references	No
1. Not fully supported in calculation rules that have a condition of After Save or the Also Recalculate on Load option selected. It may fail if the rule's field is used in a grid, form, or saved search. 2. Except when this field appears on a form or is triggered by such a field.

Parameters

Parameter	Description
textValue	The text data to have the hashing function applied.
hashingAlgorithm	Hashing algorithm for the function, The following are supported: •MD5 •SHA1 •SHA256 •SHA512
isBase64Result	(Optional) Flag for returning result in base64 format. Default value is false.

Return Value

String hash, either in hexidecimal format or Base64 encoded.

Example

$(HashString("Test value", "MD5", false))

Returns this value:

"63e1ebd352652df46f8d00d8de6d177a"