Drive

Purpose

A storage location for non-expiring transfers.

Details

The Drive allows users to create folder structures and store transfers permanently, which means that transfers do not time out automatically but can be deleted manually. Access rights are managed on the top-level folders (Drive Root Folders) and inherited by their child folders. Transfers can be uploaded directly into a folder or copied from sent or received transfers into a folder. Drive transfers can also be re-sent as ad-hoc transfers.

Structure

The Drive is structured into four general areas:

• Personal Area - accessible only by the personal user
• Team Area - accessable by authenticated users with granted access rights to drive root folders
• Public Area - read access by unauthenticated users, write access by authenticated users with granted access rights to drive root folders
• Server area - read access by authenticated users of the same admin unit, write access by authenticated users with granted access rights to drive root folders

Drive Root Folders

Each area can have multiple drive root folders with the exception of Personal Area which only has one fixed Drive Root Folder, called My Drive. Each Drive Root folder has it's own configuration options:

• Owner
• Access Rights
• Notification Settings
• Quota

Subfolders

Each Drive Root Folder can have subfolders. Subfolders can also have other subfolders. Subfolders mainly serve the purpose to structure the data.

Configuration

• Scope: user
• Privileges: multiple privileges define how users may use the drive
• Default: Dependent on templates used to create user

Privileges

The usage of the drive is restricted/allowed on multiple levels. Access of the Drive areas is controlled via user rights:

• To access the Personal area a regular user must have the user right My Drive.
• To create a Drive Root Folder in the Team Area a regular user must have the user right can create root folder.
• To create a Drive Root Folder in the Public Area or in the Server Area the user must have the user right Administrator.

Please check user rights here

Access of Drive Root Folders in all Areas except the Personal Area are controlled by Drive Folder rights:

• To browse a Drive root folder and download transfers a user needs read access to that Drive Root Folder.
• To create/rename/delete subdirectories in a Drive Root Folder a user needs write access to that Drive Root Folder.
• To upload/delete transfers in a Drive Root Folder a user needs write access to that Drive Root Folder.
• To modify a Drive Root Folder's access rights a user needs to be owner of that Drive Root Folder
• To delete a Drive Root Folder, rename it or change it's quota a user needs to be owner of that Drive Root Folder

Notification settings

every user having access to a Drive Root Folder can personally decide if and when to be notified of changes in this Drive Root folder. The notification is sent out via e-mail including all changes that have taken place after the last notification interval. Available intervalls are hourly, daily and weekly.

Quota

The Drive is covered by a quota system. There are multiple quotas. Whichever is hit first, limits additional uploads.

• The Personal area is covered by the user right Size of My Drive.
• A Drive Root Folder may have it's own quota. This is optional.
• If a contract exists, the contract's drive quota is applied to the sum of all transfers residing in Drive Root Folders owned by users of that contract.

Specific implementation details worth noticing

• There is only one Drive Root folder in the Personal Area called My Drive. This folder is auto-created and cannot be modified or deleted.

Web browser consideration

When using access-token based authentication on the web-browser platform, it is recommended to request the access token as a cookie (API, with cookie=true). As a result, the web browser will automatically send the cookie when making the download-request. This authenticates the GET request without having to insert a Authorization header.

Dependencies

none

Conflicts

none