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 filePath key when the binary stream is not available in the object.

Configuration

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

Example: .\ca.pem

Inputs

The component will look on the incoming message for the binary key. If there is no binary key, the component will look for filePath key. At least one of the two is required.

The binary key must contain a stream reference. The filePath 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 filePath, the _id and filename will be generated by hashing the file path (using SHA512) or 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:

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

Outputs

The output contains the value key which refers to the incoming message and the result key which contains the localReference, referencing the stored binary _id field in the Content Store.

Example:

{
  "value": {
    "filePath":"C://Users/xillio/Downloads/test-file.json"
  },
  "result": {
    "localReference": "6232dea643dbbf33e0906e85"
  }
}