EncodeString

Applies the selected encoding method to text to encode a string. You can choose from:

•Base 64

•Backslash CR LF

•Backslash Quote

•Double Quote

Syntax

EncodeString(textValue, encodingOption)

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
textValue	The input string to encode.
encodingOption	The encoding method for the function (one of: Base64, BackslashCRLF, BackslashQuote, DoubleQuote).

Return Value

Encoded text.

Examples

Expression	Output
$(EncodeString("\\ \"Sample \r\n text\" \\", "Base64"))	XCAiU2FtcGxlIA0KIHRleHQiIFw=
$(EncodeString("\\ \"Sample \r\n text\" \\", "BackslashCRLF"))	\ "Sample \r\n text" \
$(EncodeString("\\ \"Sample \r\n text\" \\", "BackslashQuote"))	\ \"Sample text\" \
$(EncodeString("\\ \"Sample \r\n text\" \\", "DoubleQuote"))	\""Sample text"" \