Encryption

Store sensitive data, such as private API keys, user names, or passwords, as encrypted.

Syntax

Encryption(data, key, nonce, isDecrypt)

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 have 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
data The text data to encrypt or decrypt.

key

Encryption or decryption key value. This must be a valid base64 string value.

nonce

Nonce value for encryption or decryption. This must be a valid base64 string value.

isDecrypt

(Optional) Flag for encrypt or decrypt. If not specified, the function acts as an encryption function.

Return Value

encryptDecryptText value

Examples

$(Encryption("Test value", "eEcbCN7xx1SBiA0ntL2R6veyuNELZxOa4XVxEznf/sI=", "KFTwRvfSTajJoWYqbfHIfQ==", false))

Returns this value: b96TU68yA1XtqLSaf6ESDQ==

$(Encryption("b96TU68yA1XtqLSaf6ESDQ==", "eEcbCN7xx1SBiA0ntL2R6veyuNELZxOa4XVxEznf/sI=", "KFTwRvfSTajJoWYqbfHIfQ==", true))

Returns this value: Test value