Redivis Documentation
API DocumentationRedivis Home
  • Introduction
  • Redivis for open science
    • FAIR data practices
    • Open access
    • Data repository characteristics
    • Data retention policy
    • Citations
  • Guides
    • Getting started
    • Discover & access data
      • Discover datasets
      • Apply to access restricted data
      • Create a study
    • Analyze data in a workflow
      • Reshape data in transforms
      • Work with data in notebooks
      • Running ML workloads
      • Example workflows
        • Analyzing large tabular data
        • Create an image classification model
        • Fine tuning a Large Language Model (LLM)
        • No-code visualization
        • Continuous enrollment
        • Select first/last encounter
    • Export & publish your work
      • Export to other environments
      • Build your own site with Observable
    • Create & manage datasets
      • Create and populate a dataset
      • Upload tabular data as tables
      • Upload unstructured data as files
      • Cleaning tabular data
    • Administer an organization
      • Configure access systems
      • Grant access to data
      • Generate a report
      • Example tasks
        • Emailing subsets of members
    • Video guides
  • Reference
    • Your account
      • Creating an account
      • Managing logins
      • Single Sign-On (SSO)
      • Workspace
      • Studies
      • Compute credits and billing
    • Datasets
      • Documentation
      • Tables
      • Variables
      • Files
      • Creating & editing datasets
      • Uploading data
        • Tabular data
        • Geospatial data
        • Unstructured data
        • Metadata
        • Data sources
        • Programmatic uploads
      • Version control
      • Sampling
      • Exporting data
        • Download
        • Programmatic
        • Google Data Studio
        • Google Cloud Storage
        • Google BigQuery
        • Embedding tables
    • Workflows
      • Workflow concepts
      • Documentation
      • Data sources
      • Tables
      • Transforms
        • Transform concepts
        • Step: Aggregate
        • Step: Create variables
        • Step: Filter
        • Step: Join
        • Step: Limit
        • Step: Stack
        • Step: Order
        • Step: Pivot
        • Step: Rename
        • Step: Retype
        • Step: SQL query
        • Variable selection
        • Value lists
        • Optimization and errors
        • Variable creation methods
          • Common elements
          • Aggregate
          • Case (if/else)
          • Date
          • DateTime
          • Geography
          • JSON
          • Math
          • Navigation
          • Numbering
          • Other
          • Statistical
          • String
          • Time
      • Notebooks
        • Notebook concepts
        • Compute resources
        • Python notebooks
        • R notebooks
        • Stata notebooks
        • SAS notebooks
        • Using the Jupyter interface
      • Access and privacy
    • Data access
      • Access levels
      • Configuring access
      • Requesting access
      • Approving access
      • Usage rules
      • Data access in workflows
    • Organizations
      • Administrator panel
      • Members
      • Studies
      • Workflows
      • Datasets
      • Permission groups
      • Requirements
      • Reports
      • Logs
      • Billing
      • Settings and branding
        • Account
        • Public profile
        • Membership
        • Export environments
        • Advanced: DOI configuration
        • Advanced: Stata & SAS setup
        • Advanced: Data storage locations
        • Advanced: Data egress configuration
    • Institutions
      • Administrator panel
      • Organizations
      • Members
      • Datasets
      • Workflows
      • Sub-institutions
      • Reports
      • Logs
      • Settings and branding
    • Quotas and limits
    • Glossary
  • Additional Resources
    • Events and press
    • API documentation
    • Redivis Labs
    • Office hours
    • Contact us
    • More information
      • Product updates
      • Roadmap
      • System status
      • Security
      • Feature requests
      • Report a bug
Powered by GitBook
On this page
  • Overview
  • Inheritance and visibility rules

Was this helpful?

Export as PDF
  1. Reference
  2. Institutions

Sub-institutions

Last updated 1 day ago

Was this helpful?

Overview

Sub-institutions allow for additional layers of discovery and administration in an institutional context. For example, a university may exist as an institution, and then be composed of a number of, each representing a particular school (e.g.).

This allows for end users to easily search for datasets and organization across your university, while also being able to drill down and search within a particular sub-institution. Importantly, each sub-institution is an isolated administrative context, with its own administrators, organizations, and billing.

Redivis supports arbitrary levels of sub-institution nesting. For example, you could have:

  1. University (top institution)

  2. University School of Medicine (sub-institution, under "University")

  3. Surgery Department (sub-institution, under "School of Medicine")

Inheritance and visibility rules

As a rule of thumb, resources across sub-institutions will "roll up" within a discovery context, but operate independently in an administrative context.

When a user lands on the discovery page for the top-level university institution, they will be able to search across the datasets, organizations, etc. across that institution and all of its sub-institutions (recursively). In the example hierarchy above, this means datasets in the School of Medicine as well as the Surgery Department, as well as any datasets hosted directly by the top institution, would show up in search results. However, if a user navigates to the Surgery Department page, they'll only see datasets within that sub-institution.

However, when you're administering an institution, you will only see (and have access to) the resources directly under your institution. In our example above, an administrator of the University "top" institution would only see datasets within this institution's organizations, but not datasets hosted within the School of Medicine, etc.

There are two notable exceptions to the administrative isolation rules:

  1. An institution administrator can manually make themselves an administrator of a sub-institution. Such action would be visible to all other administrators in that sub-institution, and requires explicit action on the part of the "parent" institution administrator.

  2. Institutions can view high-level metrics that are aggregated across their institution and any sub-institutions. These metrics are the same as those presented on the institution admin dashboard, and show items such as total user counts, data stored, etc. These metrics cannot be filtered or otherwise broken out in any way — the common use case is to be able to see total Redivis metrics across a university.

sub-institutions