Skip to main content
Version: Latest (4.63.0)

Binary Retrieve

The Binary Retrieve component allows you to retrieve binaries from the Content Store.

The binaries are retrieved from the binaries.files and binaries.chunks collections.

The local reference of the binary to retrieve can be hardcoded or read from the incoming object using {{ source.localReference }} or {{ target.localReference }}.

note

This component sends a message that contains a stream reference in the binary key of the output object. Additionally, the length of the stream is included in the length key. Because stream references can only be used once, you should connect only one component to the output of this component that uses the stream reference. If you connect multiple components to the output of this component, it will only send the message to the first component that was connected.

See how it works:
Binary Retrieve Explainer

note

Also covered in the Content Store overview video:
Watch video

Configuration​

Inputs | Outputs​


Binary Retrieve
Input
Output
Error
00 0 (ilysent6u)
The component evaluates the configured reference using the incoming data and uses that value to retrieve the binary from the binaries GridFS bucket. The reference corresponds to the_id field of the binary.

  • Example: Refer to the following page : Binary document schema