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.

It uses either the source.localReference or target.localReference value from the incoming message to retrieve a binary.

Configuration

Connection string

A MongoDB connection string.

Example: mongodb://<username>:<password>@localhost:27017/<databaseName>

Here <databaseName> is the database to retrieve from.

Use TLS

Enables TLS for your mongoDB connection.

Allow Invalid Certificates

Checking this will disable certificate validation. Warning: specifying this option in a production environment makes your application insecure and potentially vulnerable to expired certificates and to foreign processes posing as valid client instances.

Certificate Authority File

One or more certificate authorities to trust when making a TLS connection. In order to access the local filesystem, the XILL4_WORKDIRS environment variable must be set to the path of the directory to be accessed.

Example: .\ca.pem

Retrieve reference

• Source: Retrieve based on the source.localReference value.
• Target: Retrieve based on the target.localReference value.

Inputs

• Name: Input

  • Description: The component takes a binary document as an input and it will look for the source.localReference and uses that to retrieve the binary from the binaries GridFS bucket since it references the _id field of the binary.

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

Outputs

• Name: Output

  • Description: The component will store a stream reference in the binary key. Other components (like the File Hasher) that accept stream references can use that to further process the stream.

  • Example:

    {
      //...incoming message
      "binary" : // containing a readable stream,
    }