In this article, you will learn:

• What is the Document import from File Storage to Rossum
• What are the common use case configurations
• How to set up the extension
• What are the available configuration parameters

What is the Document import from File Storage to Rossum extension

This service enables the automatic import of documents from your file storage, like SFTP or Amazon S3, to a Rossum queue for processing. It regularly connects to your file storage, downloads available files from a specified location, and imports them into a Rossum queue. The following article will guide you through the process of how to set up and utilize this service.

How to set up the Document import from File Storage to Rossum extension

Setting up the extension takes just a few simple steps.

Step 1: Prepare your file storage and the source folder (where documents will be located)

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

Step 2: Activate your Document Import from File Storage to the Rossum extension

Step 3: Setup the schedule

Define the frequency of your document import job. The schedule definition uses crontab expressions. You can evaluate your expression here.

Here are some examples of commonly used schedules:

• Once per day: “0 0 * * *”
• Twice per day (every 12 hours): “0 */12 * * *”
• Each hour: “0 * * * *”

See this page for more examples.

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: Define rules for dataset import

Each rule configures the source folder from where the documents will be imported, what files are valid for importing, and which queue the files will be imported into.

{
    "import_rules": [
        {
            "queue_id": 0,
            "path": "",
            "file_match_regex": ""
        }
    ]
}

Configuration example

Import document into Rossum queue

The configuration below imports PDF documents from an /inbound folder on your File Storage server and places them into the queue with ID 123. Successfully imported documents are then moved to the folder /archive. Failed imports are moved to /failed_imports folder instead.

{
    "credentials": { # Credentials are set in a format appropriate for the source system
    },
    "import_rules": [
        {
            "queue_id": 123,
            "path": "/inbound",
            "file_match_regex": ".+\\.pdf",
            "result_actions": {
                "success": {
                    "type": "move",
                    "path": "/archive"
                },
                "failure": {
                    "type": "move",
                    "path": "/failed_imports"
                }
            }
        }
    ]
}

API Documentation

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