Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

What are Organizations? Organizations are objects that encapsulate Projects, Users, Teams and Storage in order to enforce Plansenforce Plan limits.  Organizations serve no other purpose, they are not intended for governance or access (other than project creation and data upload as part of plan enforcement), data curation or dissemination.  

...

Download: Download is defined as a request for a pre-signed URL.

LimitLimitsThe upper allowed amount of storage (in GB), or egress (in GB/Month) or projectsrestriction on data, egress, or other process, count etct.

For example, an Organization may have a limit on storage, egress, certified users, and/or other limits we may define in the future

Organization: An object to encapsulate the collection of users, project, teams and storage.  An Organization is defined by a Plan and enforces the Plan’s Limits.

Plan (Managed Plan, plans): A plan is the construct to map accounting and limits to an Organization.  All users of Synapse can create and access get a (free) Basic plan (and associated Organization). Users who wish to purchase a paid plan (Self-Managed or DCC) will need to contact Sage to create the Organization associated with the Plan.  The Plan accounts for the limits and length of the agreement, the Organization implements the Plan with Synapse.

...

Private Storage: Storage managed by Sage on behalf of the Organization in the form of an S3 bucket that contains only that Organization’s content.  Storage and Egress is limited by the Organization’s Plan.  AWS Open Data is an example of private storage.

Storage Limit: The upper allowed amount of storage (in GB) for the total amount of data in the organization.

Egress Limit: The upper limit of egress of data from within projects in the organization (measured in GB/Year).

User Classes

  1. Downloader Only - User who does not need a plan - only wishes to browse and access data.

  2. Basic Plan User (aka: Independent Researchers) - User who wants a Basic Plan for publishing content. Each Certified User account has a single Default Organization as part of a Basic Plan

  3. Multi-Plan User - User who has one Basic Plan, and a member of one or more Self-Managed Plans or DCC Plans

  4. Managed Plan Only User - A User who does not create their own Organization as part of a Basic Plan - only wishes to browse and access data and is included as an uploader on one or more plans owned by others.

  5. Legacy Plan User - User who has uploaded content into Synapse previous to the plan rollout date (##/##/2023) or is a member of a Legacy Plan.

...

PropertyName

Type

Source

Default

Definition

OrganizationID

number

Synapse

Unique Synapse ID of the Organization

PlanID

number

Plan System

Unique Synapse ID of the corresponding Plan. Each Organization MUST HAVE a corresponding Plan.

Organization name

String

User Defined

UserName&”Organization” for basic plans

Friendly Name of the Organization 

CreatedOn

datetime

Synapse

Datetime the Organization was created

CreatedBy

number

Synapse

Unique UserID of the User that created the Organization

OwnerID

number

Plan System

Plan Owner's SynID

UserID of the Synapse User who owns /manages the Organization.

StorageLimit

number

Plan System

Dependent on Plan

Total Limit of storage (in GB)  allowed in Shared & Private Storage. Null indicates unlimited. 

EgressLimit

number

Plan System

Dependent on Plan

Total Egress (GB/Time) allowed for data within the Organization’s boundaries from within Shared & Private storage.  Null indicates unlimited

Default Storage

Default storage bucket created defined at the Organization creation time (can be overridden at the project level for a project) 

CertifiedUserLimit

Number

1 for Default organization (basic plans), null for all others

Null indicates unlimited. This will be used for Legacy Basic Plans.

...

Organizations are created by the following actions:

  • When a Certified User user without a default Organization creates their first project, this creates a Basic Plan and a Default Organization - The Organization should have a default name of the username & ”org” or username & ”Organization”

  • A user with a default organization is an Organization Member, not an Organization Manager

...

Storage limits are calculated against any content in shared or private storage.  Content stored in Custom Storage is not counted against the limit. For example, take a simple organization with a Self-Managed plan (100 GB limit) with 3 projects, (Projects A, B, & C)  Project A (30GB) has its storage in shared private storage A.  Project B (40GB) has its storage in private Storage B.  Project C (700GB) has its storage in custom storage.

...

When an organization is at > = NN% of the Storage Limit, the Organization Managers MUST BE notified via Email and via a UI indicator in SWC with directions (or links to directions in help) to avoid hitting the limit.  

Egress Limits

Egress limit

Calculating Egress Used 

Egress limits are calculated against any content in shared or private storage (except that stored in AWS Open Data).  Content transferred from Custom Storage is not counted against the limit.

...

Egress MUST BE calculated for all organizations in order to report usage stats to users and stakeholders.

Synapse will ignore WILL NOT enforce egress limits from the following:

...

Can I move a project from one org to another?

Yes, if you have appropriate access to the source project and are a member of the target organizationNo.

Info

May consider this if both organizations are using the same storage and the user is a member of each and we get requests.

Can a user be a member of multiple Organizations?

...