Binary Store

The Binary Store component allows you to store binaries in the Content Store.

The component will take a stream reference in the binary key of the incoming object and use it to store the binary into a Mongo database. It's also possible to use a file path reference in the path key when the binary stream is not available in the object.

Configuration

General

Connection string

A MongoDB connection string.

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

Here <databaseName> is the database to store the binary.

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_WORKDIR environment variable must be set to the path of the directory to be accessed.

Example: .\ca.pem

Data

File path

The path of the file to write to DB, can be a variable.

Example 1: C:/Migration Data/new.xlsx

Example 2: %path%

The component also supports writing files to a cloud storage.

Example 3: <cloud-storage>://Migration Data/new.xlsx

Payload

The content of the file to write.

note

The Payload input field uses HandleBars. For more information, please read HandleBars

note

If the input is an object containing the path or payload keys, these values will override the Path and Payload in the configuration, even if the incoming object contains only one of the keys.

Inputs | Outputs

Binary Store

Input

Output

Error

00 0 (ilywtl968)

The component will look on the incoming message for the binary key. If there is no binary key, the component will look for path key. If both are not present, the component will look for the payload key. If none of the keys are present in the incoming message, one of the component settings File Path or Payload is required. If both a file path and a payload are provided, the file path takes priority.

The binary key must contain a stream reference. The path key must contain a path to the file on the local system. In order to access the local filesystem, the XILL4_WORKDIRS environment variable must be set to the path of the directory to be accessed.

When using the binary key, an _id field must be specified in the incoming message. This will be used as the _id and the filename in the Content Store. When using path or payload, the _id and filename will be generated by hashing the file path or the payload (using SHA512). You can specify the _id field in the incoming message to override the generated _id.

Example: Using a stream

{ 
    "_id": "6232dea643dbbf33e0906e85",
    "binary": // containing a readable stream 
}

Example: Using a file from the local file system:

{ "path": "C://Users/xillio/Downloads/test-file.json" }

Example: Using a payload

{ "payload": "test payload" }