Skip to main content

SFTP and S3 imports/exports

Installation

File storage (SFTP and S3) import/export extension is provided and maintained by Rossum.ai in the form of webhook. To start using it, follow these steps:

  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

EnvironmentWebhook URL
EU1 Irelandhttps://elis.rossum.ai/svc/scheduled-imports/api/file_storage/v1/dataset_import
EU2 Frankfurthttps://shared-eu2.rossum.app/svc/scheduled-imports/api/file_storage/v1/dataset_import
US east coasthttps://shared-us2.rossum.app/svc/scheduled-imports/api/file_storage/v1/dataset_import
Japan Tokyohttps://shared-jp.rossum.app/svc/scheduled-imports/api/file_storage/v1/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

EnvironmentWebhook URL
EU1 Irelandhttps://elis.rossum.ai/svc/scheduled-imports/api/file_storage/v1/document_import
EU2 Frankfurthttps://shared-eu2.rossum.app/svc/scheduled-imports/api/file_storage/v1/document_import
US east coasthttps://shared-us2.rossum.app/svc/scheduled-imports/api/file_storage/v1/document_import
Japan Tokyohttps://shared-jp.rossum.app/svc/scheduled-imports/api/file_storage/v1/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

EnvironmentWebhook URL
EU1 Irelandhttps://elis.rossum.ai/svc/file-storage-export/api/v1/export
EU2 Frankfurthttps://shared-eu2.rossum.app/svc/file-storage-export/api/v1/export
US east coasthttps://shared-us2.rossum.app/svc/file-storage-export/api/v1/export
Japan Tokyohttps://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

Basic usage

Work in progress

We're still working on this part and would love to hear your thoughts! Feel free to share your feedback or submit a pull request. Thank you! 🙏

Available configuration options

Available configuration options are described in the API documentation:

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.

Upload Status