Base64 Encode

Introduction

This valve encodes item properties using base 64. The encoded value can replace the source value or replace/create a new named property.

Note that items only support string properties, meaning that this valve will base 64 encode the binary value of a (string) property. A real binary value (like a PDF document or an image) must be base 64 encoded before added to an item.

Note

This valve is a part of the item iteration API meaning that it operates on the current item set. For more information on item iteration, see Item.

Configuration

Note

Valve name: Base64Encode

Caution

The properties of this valve has changed to better reflect how the valve actually works.

value (previously called src) must be an expression expanding to the value to encode (or a static value).

name (previously called dest) must be the name of the property to set with the resulting base64 value.

Properties

Name	Description	Default value	Mandatory	Expanded
name	Name of target item property to receive the base 64 encoded value. (compat: dest).
value	Value to encode. (compat: src).
url_safe	Flag turning on URL safe encoding.	false
replace	Flag to turn off replace of target property. When turned off, value will be added to already existing properties (creating a multi-valued property).	true

Example

{
  "name" : "Base64Encode",
  "config" : {
    "name" : "b64",
    "value" : "${item.plain}",
    "url_safe": true
  }
}