Skip to content

Portal Transfer Module

Info

The Portal module is a no-operation transfer module. Instead of sending a file to a remote host, it consumes the data stream locally and marks the file as available for retrieval through the Data Portal. No connection is made to any external system.

How it works

  1. connect() immediately marks the module as available — no network call is made.
  2. put() reads and discards all bytes from the input stream, recording the byte count. This ensures the file is staged and available in the Data Portal for authorised users to pull.
  3. size() returns the number of bytes consumed, satisfying the transfer framework's post-upload size check.
  4. del() and get() are not supported and will throw an error if called.

Configuration options

This module has no options of its own. The portal.* namespace is used for Data User options — per-user settings configured in the Data User's Properties field that control portal behaviour such as authentication, quotas, CORS headers, branding, and operation permissions.

Typical use

Assign this module to a Dissemination host when the intention is not to push data to a remote server but to make it available for authorised users to pull via the integrated Data Portal interface. The transfer completes successfully as soon as all bytes have been consumed — no remote connection is required.