SFTP and S3 imports/exports

Installation

File storage (SFTP and S3) import/export extensions are available in the Rossum store. To install them:

1. Login to your Rossum account.
2. Navigate to Extensions → Rossum Store.
3. Search one of the following extensions and "Add" them:
   1. Import Master Data From SFTP
   2. Import Master Data from S3
   3. Import Documents From SFTP
   4. Import Documents From S3
   5. Export To SFTP
   6. Export To S3

Alternatively, it is also possible to install them manually (advanced):

1. Login to your Rossum account.
2. Navigate to Extensions → My extensions.
3. Click on Create extension.
4. Fill the following fields:
   1. Name: SFTP/S3 import/export
   2. Trigger events: Scheduled for import or Export for exports
   3. Extension type: Webhook
   4. URL (see import and export endpoints below)
   5. In "Advanced settings" select Token owner (should have Admin access)
5. Click Create the webhook.

Dataset import endpoints

Environment	Webhook URL
EU1 Ireland	https://elis.task-manager.rossum-ext.app/api/v1/tasks/file-storage-dataset-import
EU2 Frankfurt	https://shared-eu2.task-manager.rossum-ext.app/api/v1/tasks/file-storage-dataset-import
US east coast	https://shared-us2.task-manager.rossum-ext.app/api/v1/tasks/file-storage-dataset-import
Japan Tokyo	https://shared-jp.task-manager.rossum-ext.app/api/v1/tasks/file-storage-dataset-import

Additional info for Rossum employees

Please visit the following restricted link to learn more: https://rossumai.atlassian.net/l/cp/PV1jzmqK

Document import endpoints

Environment	Webhook URL
EU1 Ireland	https://elis.task-manager.rossum-ext.app/api/v1/tasks/file-storage-document-import
EU2 Frankfurt	https://shared-eu2.task-manager.rossum-ext.app/api/v1/tasks/file-storage-document-import
US east coast	https://shared-us2.task-manager.rossum-ext.app/api/v1/tasks/file-storage-document-import
Japan Tokyo	https://shared-jp.task-manager.rossum-ext.app/api/v1/tasks/file-storage-document-import

Additional info for Rossum employees

Please visit the following restricted link to learn more: https://rossumai.atlassian.net/l/cp/PV1jzmqK

Export endpoints

Environment	Webhook URL
EU1 Ireland	https://elis.rossum.ai/svc/file-storage-export/api/v1/export
EU2 Frankfurt	https://shared-eu2.rossum.app/svc/file-storage-export/api/v1/export
US east coast	https://shared-us2.rossum.app/svc/file-storage-export/api/v1/export
Japan Tokyo	https://shared-jp.rossum.app/svc/file-storage-export/api/v1/export

Additional info for Rossum employees

Please visit the following restricted link to learn more: https://rossumai.atlassian.net/l/cp/S1coKmuC

Available configuration options

Common import/export configuration:

{
  "credentials": {
    // Credentials section depends on whether you are using S3 or SFTP (see below)
    // …
  },
  "import_rules": [
    {
      "dataset_name": "PURCHASE_ORDERS_EXAMPLE_v1",
      "import_methods": {
        "replace_method": {
          "path": "/datasets",
          "dynamic": false,
          "file_format": "xlsx",
          "file_match_regex": "PURCHASE_ORDERS\\.xlsx"
        }
      },
      "result_actions": {
        "failure": [
          {
            "path": "/datasets/failed_imports",
            "type": "move"
          }
        ],
        "success": [
          {
            "path": "/datasets/archive",
            "type": "move"
          }
        ]
      }
    }
  ]
}

Credentials for SFTP-related import/export are specified in the following format:

{
  "credentials": {
    "host": "sftp.example.com",
    "port": "22",
    "type": "sftp",
    "username": "example",

    // (Optional) Version of your SFTP server. Needed only exceptionally when automatic detection of
    // the version fails.
    "sftp_version": 5
  },
  "import_rules": [
    // … (see above)
  ]
}

Credentials for S3-related import/export:

{
  "credentials": {
    "host": "sftp.example.com",
    "port": "22",
    "type": "s3",
    "username": "example"
  },
  "import_rules": [
    // … (see above)
  ]
}

All available configuration options are also described in the API documentation:

• Import: Scheduled Imports - File storage
• Export: File Storage Export

Logging and observability

Extensions Logs

• URL https://[org].rossum.app/settings/extensions/logs
• The import job is not triggered directly, but using scheduler. Thus successfull record (type INFO) in the Extensions Logs does not necessary means the downstream import job was sucessfull, but it is a good start for observation

Master Data Hub

• URL: https://[org].rossum.app/svc/master-data-hub/web/management
• Directly in the MDH, there is a status screen "Upload Status", regardless of the origin of "upload".
• There is also note with the more detailed info in case of some error.