In this article, you will learn:

• What is the File Storage Export extension
• What are the common use case configurations
• How to set up File Storage extension
• What are the available configuration parameters

What is the File Storage Export extension

The File Storage Export extension enables a one-way connection from Rossum to your compatible file storage system – SFTP or Amazon S3. The extension can send extracted data and the original document from a Rossum queue to a specific folder on your storage system.

How to set up File Storage Export extension

Setting up the extension takes a few simple steps.

Step 1: Prepare your file storage and the target folder

Make sure access permissions and target folder(s) are created.

Step 2: Activate your File Storage Export extension

Step 3: Specify to which queue(s) you want to add this extension.

Choose from which queue(s) we will export data and documents to your file storage. Please note you can connect one or more queues. Once in the “Rossum Store extension settings,” scroll down to “Queues” and select the queue(s).

Step 4: Configure credentials and secrets to your file storage

Credentials and secrets are used to define the type of your file storage – SFTP, Amazon S3 – and to provide the extension with data necessary to access the storage. Different credentials and secrets are needed for different types of file storage – refer to the examples below.

Credentials are defined as part of the hook configuration.

Secrets are defined and safely stored in the extension configuration screen in the Secrets section. 

You can add your secrets in the Secrets section edit component. When you click the Save Changes button on the configuration screen, your secrets are stored in the function but are not visible anymore for security reasons; instead, the  “__change_me__” string is shown.

SFTP Credentials

{
    "credentials": {
        "type": "sftp",
        "host": "",
        "port":,
        "username": ""
    }
}

SFTP Secrets

{
    "type": "sftp",
    "password": ""
}

S3 Credentials

{
    "credentials": {
        "type": "s3",
        "bucket_name": ""
    }
}

S3 Secrets

{
    "type": "s3",
    "access_key_id": "",
    "secret_access_key": ""
}

Step 5: Configure the data to export and output file naming convention

Configuration of what type of data is exported and how the files are named is done using the extension configuration JSON editor.

Common use case configurations

Exporting annotation files using document ID in the file name

In this use case, the annotation data converted to XML format are exported to your file storage’s “/upload” folder. This basic example uses document ID as part of the template for file name creation.

{
    "credentials": {# Credentials are set in a format appropriate for the target system
    },
    "export_rules": [
        {
            "path": "/upload",
            "data": [
                {
                    "type": "annotation_content",
                    "filename_template": "annotation-{document.id}.xml",
                    "format": "xml"
                }
            ]
        }
    ]
}

Exporting annotation files and document files using a complex naming convention

In this use case, the annotation data is converted to CSV format, and the original document files are exported to the “/upload” folder in your file storage. This example uses annotation ID in both filenames to pair them together. The original document file will have the original filename. The filename for annotation data will be constructed using extracted data – in this example, the document’s ID and issue data variables are referenced by their schema IDs.

{
    "credentials": {# Credentials are set in a format appropriate for the target system
    },
    "export_rules": [
        {
            "path_to_directory": "/upload",
            "export_object_configurations": [
                {
                    "type": "annotation_content",
                    "filename_template": "{annotation.id}_{document_id}_{issue_date}.csv",
                    "format": "csv"
                },
                {
                    "type": "document",
                    "filename_template": "{annotation.id}_{document.original_file_name}"
                }
            ]
        }
    ]
}

API Documentation

Please refer to the detailed documentation here. Under the subsection settings, you will find a complete description of available parameters and configuration specifics for different currently supported file storage systems.